| 1 |
/*************************************************************************** |
/* SPDX-License-Identifier: GPL-3.0-or-later */ |
| 2 |
section_list.h - description |
/* |
| 3 |
------------------- |
* section_list |
| 4 |
Copyright : (C) 2004-2025 by Leaflet |
* - data models and basic operations of section and article |
| 5 |
Email : leaflet@leafok.com |
* |
| 6 |
***************************************************************************/ |
* Copyright (C) 2004-2026 Leaflet <leaflet@leafok.com> |
| 7 |
|
*/ |
|
/*************************************************************************** |
|
|
* * |
|
|
* This program is free software; you can redistribute it and/or modify * |
|
|
* it under the terms of the GNU General Public License as published by * |
|
|
* the Free Software Foundation; either version 3 of the License, or * |
|
|
* (at your option) any later version. * |
|
|
* * |
|
|
***************************************************************************/ |
|
| 8 |
|
|
| 9 |
#ifndef _SECTION_LIST_H_ |
#ifndef _SECTION_LIST_H_ |
| 10 |
#define _SECTION_LIST_H_ |
#define _SECTION_LIST_H_ |
| 11 |
|
|
| 12 |
#include "bbs.h" |
#include "bbs.h" |
| 13 |
#include "common.h" |
#include "common.h" |
| 14 |
|
#include "menu.h" |
| 15 |
#include <time.h> |
#include <time.h> |
| 16 |
|
|
| 17 |
#define BBS_article_title_max_len 80 |
#ifdef HAVE_SYSTEM_V |
| 18 |
#define BBS_article_limit_per_section 50000 |
#include <sys/sem.h> |
| 19 |
#define BBS_article_limit_per_page 20 |
#else |
| 20 |
|
#include <semaphore.h> |
| 21 |
|
#endif |
| 22 |
|
|
| 23 |
#define BBS_ontop_article_limit_per_section 10 |
enum section_list_constant_t |
| 24 |
|
{ |
| 25 |
|
BBS_article_title_max_len = 160, |
| 26 |
|
BBS_article_limit_per_section = 50000, |
| 27 |
|
BBS_article_limit_per_page = 20, |
| 28 |
|
|
| 29 |
|
BBS_ontop_article_limit_per_section = 10, |
| 30 |
|
|
| 31 |
#define ARTICLE_PER_BLOCK 1000 |
BBS_article_count_per_block = 1000, |
| 32 |
|
}; |
| 33 |
|
|
| 34 |
struct article_t |
struct article_t |
| 35 |
{ |
{ |
| 75 |
int32_t last_page_visible_article_count; |
int32_t last_page_visible_article_count; |
| 76 |
ARTICLE *p_ontop_articles[BBS_ontop_article_limit_per_section]; |
ARTICLE *p_ontop_articles[BBS_ontop_article_limit_per_section]; |
| 77 |
int32_t ontop_article_count; |
int32_t ontop_article_count; |
| 78 |
|
MENU_SET ex_menu_set; |
| 79 |
|
time_t ex_menu_tm; |
| 80 |
}; |
}; |
| 81 |
typedef struct section_list_t SECTION_LIST; |
typedef struct section_list_t SECTION_LIST; |
| 82 |
|
|
| 83 |
// article_block_count * ARTICLE_PER_BLOCK should be |
struct section_list_pool_t |
| 84 |
|
{ |
| 85 |
|
size_t shm_size; |
| 86 |
|
SECTION_LIST sections[BBS_max_section]; |
| 87 |
|
int section_count; |
| 88 |
|
#ifndef HAVE_SYSTEM_V |
| 89 |
|
sem_t sem[BBS_max_section + 1]; |
| 90 |
|
uint16_t read_lock_count[BBS_max_section + 1]; |
| 91 |
|
uint16_t write_lock_count[BBS_max_section + 1]; |
| 92 |
|
#else |
| 93 |
|
int semid; |
| 94 |
|
#endif |
| 95 |
|
TRIE_NODE *p_trie_dict_section_by_name; |
| 96 |
|
TRIE_NODE *p_trie_dict_section_by_sid; |
| 97 |
|
}; |
| 98 |
|
typedef struct section_list_pool_t SECTION_LIST_POOL; |
| 99 |
|
|
| 100 |
|
extern SECTION_LIST_POOL *p_section_list_pool; |
| 101 |
|
|
| 102 |
|
// article_block_count * BBS_article_count_per_block should be |
| 103 |
// no less than BBS_article_limit_per_section * BBS_max_section, |
// no less than BBS_article_limit_per_section * BBS_max_section, |
| 104 |
// in order to allocate enough memory for blocks |
// in order to allocate enough memory for blocks |
| 105 |
extern int article_block_init(const char *filename, int block_count); |
extern int article_block_init(const char *filename, int block_count); |
| 125 |
extern int detach_section_list_shm(void); |
extern int detach_section_list_shm(void); |
| 126 |
|
|
| 127 |
extern SECTION_LIST *section_list_create(int32_t sid, const char *sname, const char *stitle, const char *master_list); |
extern SECTION_LIST *section_list_create(int32_t sid, const char *sname, const char *stitle, const char *master_list); |
| 128 |
|
extern int section_list_update(SECTION_LIST *p_section, const char *sname, const char *stitle, const char *master_list); |
| 129 |
extern void section_list_reset_articles(SECTION_LIST *p_section); |
extern void section_list_reset_articles(SECTION_LIST *p_section); |
| 130 |
extern SECTION_LIST *section_list_find_by_name(const char *sname); |
extern SECTION_LIST *section_list_find_by_name(const char *sname); |
| 131 |
extern SECTION_LIST *section_list_find_by_sid(int32_t sid); |
extern SECTION_LIST *section_list_find_by_sid(int32_t sid); |
| 132 |
extern int get_section_index(SECTION_LIST *p_section); |
extern int get_section_index(SECTION_LIST *p_section); |
| 133 |
|
|
| 134 |
|
// sname could be NULL, or pointer to char[] in size >= sizeof(SECTION_LIST.sname) |
| 135 |
|
// stitle could be NULL, or pointer to char[] in size >= sizeof(SECTION_LIST.stitle) |
| 136 |
|
// master_list could be NULL, or pointer to char[] in size >= sizeof(SECTION_LIST.master_list) |
| 137 |
|
extern int get_section_info(SECTION_LIST *p_section, char *sname, char *stitle, char *master_list); |
| 138 |
|
|
| 139 |
extern int section_list_append_article(SECTION_LIST *p_section, const ARTICLE *p_article_src); |
extern int section_list_append_article(SECTION_LIST *p_section, const ARTICLE *p_article_src); |
| 140 |
extern int section_list_set_article_visible(SECTION_LIST *p_section, int32_t aid, int8_t visible); |
extern int section_list_set_article_visible(SECTION_LIST *p_section, int32_t aid, int8_t visible); |
| 141 |
|
extern int section_list_set_article_excerption(SECTION_LIST *p_section, int32_t aid, int8_t excerption); |
| 142 |
|
|
| 143 |
extern int section_list_update_article_ontop(SECTION_LIST *p_section, ARTICLE *p_article); |
extern int section_list_update_article_ontop(SECTION_LIST *p_section, ARTICLE *p_article); |
| 144 |
extern int section_list_page_count_with_ontop(SECTION_LIST *p_section); |
extern int section_list_page_count_with_ontop(SECTION_LIST *p_section); |