lbbs/include/section_list.h

/* SPDX-License-Identifier: GPL-3.0-or-later */
/*
 * section_list
 *   - data models and basic operations of section and article
 *
 * Copyright (C) 2004-2025  Leaflet <leaflet@leafok.com>
 */

#ifndef _SECTION_LIST_H_
#define _SECTION_LIST_H_

#include "bbs.h"
#include "common.h"
#include "menu.h"
#include <time.h>

#define BBS_article_title_max_len 160
#define BBS_article_limit_per_section 50000
#define BBS_article_limit_per_page 20

#define BBS_ontop_article_limit_per_section 10

#define ARTICLE_PER_BLOCK 1000

struct article_t
{
        int32_t aid;
        int32_t tid;
        int32_t sid;
        int32_t cid;
        int32_t uid;
        struct article_t *p_prior;               // prior article
        struct article_t *p_next;                // next article
        struct article_t *p_topic_prior; // same topic
        struct article_t *p_topic_next;  // same topic
        int8_t visible;
        int8_t excerption;
        int8_t ontop;
        int8_t lock;
        int8_t transship;
        char username[BBS_username_max_len + 1];
        char nickname[BBS_nickname_max_len + 1];
        char title[BBS_article_title_max_len + 1];
        time_t sub_dt;
};
typedef struct article_t ARTICLE;

struct section_list_t
{
        int32_t sid;
        int32_t class_id;
        int8_t enable;
        char sname[BBS_section_name_max_len + 1];
        char stitle[BBS_section_title_max_len + 1];
        char master_list[(BBS_username_max_len + 1) * 3 + 1];
        int read_user_level;
        int write_user_level;
        int32_t article_count;
        int32_t topic_count;
        int32_t visible_article_count;
        int32_t visible_topic_count;
        ARTICLE *p_article_head;
        ARTICLE *p_article_tail;
        ARTICLE *p_page_first_article[BBS_article_limit_per_section / BBS_article_limit_per_page];
        int32_t page_count;
        int32_t last_page_visible_article_count;
        ARTICLE *p_ontop_articles[BBS_ontop_article_limit_per_section];
        int32_t ontop_article_count;
        MENU_SET ex_menu_set;
        time_t ex_menu_tm;
};
typedef struct section_list_t SECTION_LIST;

struct section_list_pool_t
{
        int shmid;
        SECTION_LIST sections[BBS_max_section];
        int section_count;
        int semid;
        TRIE_NODE *p_trie_dict_section_by_name;
        TRIE_NODE *p_trie_dict_section_by_sid;
};
typedef struct section_list_pool_t SECTION_LIST_POOL;

extern SECTION_LIST_POOL *p_section_list_pool;

// article_block_count * ARTICLE_PER_BLOCK should be
// no less than BBS_article_limit_per_section * BBS_max_section,
// in order to allocate enough memory for blocks
extern int article_block_init(const char *filename, int block_count);
extern void article_block_cleanup(void);

extern int set_article_block_shm_readonly(void);
extern int detach_article_block_shm(void);

extern int article_block_reset(void);

extern ARTICLE *article_block_find_by_aid(int32_t aid);
extern ARTICLE *article_block_find_by_index(int index);

extern int32_t article_block_last_aid(void);
extern int article_block_article_count(void);

extern int article_count_of_topic(int32_t aid);

extern int section_list_init(const char *filename);
extern void section_list_cleanup(void);

extern int set_section_list_shm_readonly(void);
extern int detach_section_list_shm(void);

extern SECTION_LIST *section_list_create(int32_t sid, const char *sname, const char *stitle, const char *master_list);
extern int section_list_update(SECTION_LIST *p_section, const char *sname, const char *stitle, const char *master_list);
extern void section_list_reset_articles(SECTION_LIST *p_section);
extern SECTION_LIST *section_list_find_by_name(const char *sname);
extern SECTION_LIST *section_list_find_by_sid(int32_t sid);
extern int get_section_index(SECTION_LIST *p_section);

// sname could be NULL, or pointer to char[] in size >= sizeof(SECTION_LIST.sname)
// stitle could be NULL, or pointer to char[] in size >= sizeof(SECTION_LIST.stitle)
// master_list could be NULL, or pointer to char[] in size >= sizeof(SECTION_LIST.master_list)
extern int get_section_info(SECTION_LIST *p_section, char *sname, char *stitle, char *master_list);

extern int section_list_append_article(SECTION_LIST *p_section, const ARTICLE *p_article_src);
extern int section_list_set_article_visible(SECTION_LIST *p_section, int32_t aid, int8_t visible);

extern int section_list_update_article_ontop(SECTION_LIST *p_section, ARTICLE *p_article);
extern int section_list_page_count_with_ontop(SECTION_LIST *p_section);
extern int section_list_page_article_count_with_ontop(SECTION_LIST *p_section, int32_t page_id);

// *p_page, *p_offset will be set as page / offset of the article with aid in *p_section (including both visible and invisible articles)
// *pp_next will be set as pointer to the next article of the article with aid
// *pp_next will be set as head article of the section if the article with aid locates at the tail of the section
extern ARTICLE *section_list_find_article_with_offset(SECTION_LIST *p_section, int32_t aid, int32_t *p_page, int32_t *p_offset, ARTICLE **pp_next);

extern int section_list_calculate_page(SECTION_LIST *p_section, int32_t start_aid);
extern int section_list_move_topic(SECTION_LIST *p_section_src, SECTION_LIST *p_section_dest, int32_t aid);

extern int section_list_try_rd_lock(SECTION_LIST *p_section, int wait_sec);
extern int section_list_try_rw_lock(SECTION_LIST *p_section, int wait_sec);
extern int section_list_rd_unlock(SECTION_LIST *p_section);
extern int section_list_rw_unlock(SECTION_LIST *p_section);
extern int section_list_rd_lock(SECTION_LIST *p_section);
extern int section_list_rw_lock(SECTION_LIST *p_section);

#endif //_SECTION_LIST_H_
1	sysadm	1.32	/* SPDX-License-Identifier: GPL-3.0-or-later */
2			/*
3			* section_list
4			* - data models and basic operations of section and article
5			*
6	sysadm	1.33	* Copyright (C) 2004-2025 Leaflet <leaflet@leafok.com>
7	sysadm	1.32	*/
8	sysadm	1.1
9	sysadm	1.19	#ifndef _SECTION_LIST_H_
10			#define _SECTION_LIST_H_
11
12	sysadm	1.22	#include "bbs.h"
13	sysadm	1.1	#include "common.h"
14	sysadm	1.24	#include "menu.h"
15	sysadm	1.15	#include <time.h>
16	sysadm	1.1
17	sysadm	1.25	#define BBS_article_title_max_len 160
18	sysadm	1.5	#define BBS_article_limit_per_section 50000
19			#define BBS_article_limit_per_page 20
20	sysadm	1.1
21	sysadm	1.23	#define BBS_ontop_article_limit_per_section 10
22
23	sysadm	1.5	#define ARTICLE_PER_BLOCK 1000
24	sysadm	1.1
25			struct article_t
26			{
27			int32_t aid;
28			int32_t tid;
29	sysadm	1.10	int32_t sid;
30	sysadm	1.1	int32_t cid;
31			int32_t uid;
32	sysadm	1.5	struct article_t *p_prior; // prior article
33			struct article_t *p_next; // next article
34			struct article_t *p_topic_prior; // same topic
35			struct article_t *p_topic_next; // same topic
36	sysadm	1.1	int8_t visible;
37			int8_t excerption;
38			int8_t ontop;
39			int8_t lock;
40	sysadm	1.18	int8_t transship;
41	sysadm	1.1	char username[BBS_username_max_len + 1];
42			char nickname[BBS_nickname_max_len + 1];
43			char title[BBS_article_title_max_len + 1];
44	sysadm	1.15	time_t sub_dt;
45	sysadm	1.1	};
46			typedef struct article_t ARTICLE;
47
48	sysadm	1.5	struct section_list_t
49	sysadm	1.1	{
50			int32_t sid;
51	sysadm	1.13	int32_t class_id;
52			int8_t enable;
53	sysadm	1.1	char sname[BBS_section_name_max_len + 1];
54			char stitle[BBS_section_title_max_len + 1];
55	sysadm	1.20	char master_list[(BBS_username_max_len + 1) * 3 + 1];
56	sysadm	1.13	int read_user_level;
57			int write_user_level;
58	sysadm	1.1	int32_t article_count;
59	sysadm	1.6	int32_t topic_count;
60			int32_t visible_article_count;
61			int32_t visible_topic_count;
62	sysadm	1.4	ARTICLE *p_article_head;
63			ARTICLE *p_article_tail;
64	sysadm	1.5	ARTICLE *p_page_first_article[BBS_article_limit_per_section / BBS_article_limit_per_page];
65			int32_t page_count;
66	sysadm	1.6	int32_t last_page_visible_article_count;
67	sysadm	1.23	ARTICLE *p_ontop_articles[BBS_ontop_article_limit_per_section];
68			int32_t ontop_article_count;
69	sysadm	1.24	MENU_SET ex_menu_set;
70			time_t ex_menu_tm;
71	sysadm	1.1	};
72	sysadm	1.5	typedef struct section_list_t SECTION_LIST;
73	sysadm	1.1
74	sysadm	1.26	struct section_list_pool_t
75			{
76			int shmid;
77			SECTION_LIST sections[BBS_max_section];
78			int section_count;
79			int semid;
80			TRIE_NODE *p_trie_dict_section_by_name;
81			TRIE_NODE *p_trie_dict_section_by_sid;
82			};
83			typedef struct section_list_pool_t SECTION_LIST_POOL;
84
85			extern SECTION_LIST_POOL *p_section_list_pool;
86
87	sysadm	1.5	// article_block_count * ARTICLE_PER_BLOCK should be
88			// no less than BBS_article_limit_per_section * BBS_max_section,
89			// in order to allocate enough memory for blocks
90			extern int article_block_init(const char *filename, int block_count);
91			extern void article_block_cleanup(void);
92	sysadm	1.16
93			extern int set_article_block_shm_readonly(void);
94			extern int detach_article_block_shm(void);
95
96	sysadm	1.5	extern int article_block_reset(void);
97
98			extern ARTICLE *article_block_find_by_aid(int32_t aid);
99			extern ARTICLE *article_block_find_by_index(int index);
100
101	sysadm	1.15	extern int32_t article_block_last_aid(void);
102	sysadm	1.17	extern int article_block_article_count(void);
103	sysadm	1.15
104	sysadm	1.10	extern int article_count_of_topic(int32_t aid);
105
106	sysadm	1.12	extern int section_list_init(const char *filename);
107			extern void section_list_cleanup(void);
108	sysadm	1.9
109	sysadm	1.16	extern int set_section_list_shm_readonly(void);
110			extern int detach_section_list_shm(void);
111
112	sysadm	1.21	extern SECTION_LIST section_list_create(int32_t sid, const char sname, const char stitle, const char master_list);
113	sysadm	1.29	extern int section_list_update(SECTION_LIST p_section, const char sname, const char stitle, const char master_list);
114	sysadm	1.5	extern void section_list_reset_articles(SECTION_LIST *p_section);
115	sysadm	1.28	extern SECTION_LIST section_list_find_by_name(const char sname);
116			extern SECTION_LIST *section_list_find_by_sid(int32_t sid);
117	sysadm	1.11	extern int get_section_index(SECTION_LIST *p_section);
118	sysadm	1.31
119			// sname could be NULL, or pointer to char[] in size >= sizeof(SECTION_LIST.sname)
120			// stitle could be NULL, or pointer to char[] in size >= sizeof(SECTION_LIST.stitle)
121			// master_list could be NULL, or pointer to char[] in size >= sizeof(SECTION_LIST.master_list)
122	sysadm	1.30	extern int get_section_info(SECTION_LIST p_section, char sname, char stitle, char master_list);
123	sysadm	1.1
124	sysadm	1.5	extern int section_list_append_article(SECTION_LIST p_section, const ARTICLE p_article_src);
125			extern int section_list_set_article_visible(SECTION_LIST *p_section, int32_t aid, int8_t visible);
126	sysadm	1.7
127	sysadm	1.23	extern int section_list_update_article_ontop(SECTION_LIST p_section, ARTICLE p_article);
128			extern int section_list_page_count_with_ontop(SECTION_LIST *p_section);
129			extern int section_list_page_article_count_with_ontop(SECTION_LIST *p_section, int32_t page_id);
130
131	sysadm	1.7	// p_page, p_offset will be set as page / offset of the article with aid in *p_section (including both visible and invisible articles)
132			// *pp_next will be set as pointer to the next article of the article with aid
133			// *pp_next will be set as head article of the section if the article with aid locates at the tail of the section
134	sysadm	1.8	extern ARTICLE section_list_find_article_with_offset(SECTION_LIST p_section, int32_t aid, int32_t p_page, int32_t p_offset, ARTICLE **pp_next);
135	sysadm	1.7
136	sysadm	1.6	extern int section_list_calculate_page(SECTION_LIST *p_section, int32_t start_aid);
137	sysadm	1.7	extern int section_list_move_topic(SECTION_LIST p_section_src, SECTION_LIST p_section_dest, int32_t aid);
138	sysadm	1.11
139			extern int section_list_try_rd_lock(SECTION_LIST *p_section, int wait_sec);
140			extern int section_list_try_rw_lock(SECTION_LIST *p_section, int wait_sec);
141			extern int section_list_rd_unlock(SECTION_LIST *p_section);
142			extern int section_list_rw_unlock(SECTION_LIST *p_section);
143	sysadm	1.14	extern int section_list_rd_lock(SECTION_LIST *p_section);
144			extern int section_list_rw_lock(SECTION_LIST *p_section);
145	sysadm	1.19
146			#endif //_SECTION_LIST_H_
webmaster@leafok.com	ViewVC Help
Powered by ViewVC 1.3.0-beta1