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>

#ifdef HAVE_SYSTEM_V
#include <sys/sem.h>
#else
#include <semaphore.h>
#endif

enum section_list_constant_t
{
        BBS_article_title_max_len = 160,
        BBS_article_limit_per_section = 50000,
        BBS_article_limit_per_page = 20,

        BBS_ontop_article_limit_per_section = 10,

        BBS_article_count_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
{
        size_t shm_size;
        SECTION_LIST sections[BBS_max_section];
        int section_count;
#ifndef HAVE_SYSTEM_V
        sem_t sem[BBS_max_section + 1];
        uint16_t read_lock_count[BBS_max_section + 1];
        uint16_t write_lock_count[BBS_max_section + 1];
#else
        int semid;
#endif
        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 * BBS_article_count_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.38	#ifdef HAVE_SYSTEM_V
18			#include <sys/sem.h>
19			#else
20			#include <semaphore.h>
21			#endif
22
23	sysadm	1.34	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	sysadm	1.1
29	sysadm	1.34	BBS_ontop_article_limit_per_section = 10,
30	sysadm	1.23
31	sysadm	1.34	BBS_article_count_per_block = 1000,
32			};
33	sysadm	1.1
34			struct article_t
35			{
36			int32_t aid;
37			int32_t tid;
38	sysadm	1.10	int32_t sid;
39	sysadm	1.1	int32_t cid;
40			int32_t uid;
41	sysadm	1.5	struct article_t *p_prior; // prior article
42			struct article_t *p_next; // next article
43			struct article_t *p_topic_prior; // same topic
44			struct article_t *p_topic_next; // same topic
45	sysadm	1.1	int8_t visible;
46			int8_t excerption;
47			int8_t ontop;
48			int8_t lock;
49	sysadm	1.18	int8_t transship;
50	sysadm	1.1	char username[BBS_username_max_len + 1];
51			char nickname[BBS_nickname_max_len + 1];
52			char title[BBS_article_title_max_len + 1];
53	sysadm	1.15	time_t sub_dt;
54	sysadm	1.1	};
55			typedef struct article_t ARTICLE;
56
57	sysadm	1.5	struct section_list_t
58	sysadm	1.1	{
59			int32_t sid;
60	sysadm	1.13	int32_t class_id;
61			int8_t enable;
62	sysadm	1.1	char sname[BBS_section_name_max_len + 1];
63			char stitle[BBS_section_title_max_len + 1];
64	sysadm	1.20	char master_list[(BBS_username_max_len + 1) * 3 + 1];
65	sysadm	1.13	int read_user_level;
66			int write_user_level;
67	sysadm	1.1	int32_t article_count;
68	sysadm	1.6	int32_t topic_count;
69			int32_t visible_article_count;
70			int32_t visible_topic_count;
71	sysadm	1.4	ARTICLE *p_article_head;
72			ARTICLE *p_article_tail;
73	sysadm	1.5	ARTICLE *p_page_first_article[BBS_article_limit_per_section / BBS_article_limit_per_page];
74			int32_t page_count;
75	sysadm	1.6	int32_t last_page_visible_article_count;
76	sysadm	1.23	ARTICLE *p_ontop_articles[BBS_ontop_article_limit_per_section];
77			int32_t ontop_article_count;
78	sysadm	1.24	MENU_SET ex_menu_set;
79			time_t ex_menu_tm;
80	sysadm	1.1	};
81	sysadm	1.5	typedef struct section_list_t SECTION_LIST;
82	sysadm	1.1
83	sysadm	1.26	struct section_list_pool_t
84			{
85	sysadm	1.37	size_t shm_size;
86	sysadm	1.26	SECTION_LIST sections[BBS_max_section];
87			int section_count;
88	sysadm	1.38	#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	sysadm	1.26	int semid;
94	sysadm	1.38	#endif
95	sysadm	1.26	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	sysadm	1.34	// article_block_count * BBS_article_count_per_block should be
103	sysadm	1.5	// no less than BBS_article_limit_per_section * BBS_max_section,
104			// in order to allocate enough memory for blocks
105			extern int article_block_init(const char *filename, int block_count);
106			extern void article_block_cleanup(void);
107	sysadm	1.16
108			extern int set_article_block_shm_readonly(void);
109			extern int detach_article_block_shm(void);
110
111	sysadm	1.5	extern int article_block_reset(void);
112
113			extern ARTICLE *article_block_find_by_aid(int32_t aid);
114			extern ARTICLE *article_block_find_by_index(int index);
115
116	sysadm	1.15	extern int32_t article_block_last_aid(void);
117	sysadm	1.17	extern int article_block_article_count(void);
118	sysadm	1.15
119	sysadm	1.10	extern int article_count_of_topic(int32_t aid);
120
121	sysadm	1.12	extern int section_list_init(const char *filename);
122			extern void section_list_cleanup(void);
123	sysadm	1.9
124	sysadm	1.16	extern int set_section_list_shm_readonly(void);
125			extern int detach_section_list_shm(void);
126
127	sysadm	1.21	extern SECTION_LIST section_list_create(int32_t sid, const char sname, const char stitle, const char master_list);
128	sysadm	1.29	extern int section_list_update(SECTION_LIST p_section, const char sname, const char stitle, const char master_list);
129	sysadm	1.5	extern void section_list_reset_articles(SECTION_LIST *p_section);
130	sysadm	1.28	extern SECTION_LIST section_list_find_by_name(const char sname);
131			extern SECTION_LIST *section_list_find_by_sid(int32_t sid);
132	sysadm	1.11	extern int get_section_index(SECTION_LIST *p_section);
133	sysadm	1.31
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	sysadm	1.30	extern int get_section_info(SECTION_LIST p_section, char sname, char stitle, char master_list);
138	sysadm	1.1
139	sysadm	1.5	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);
141	sysadm	1.7
142	sysadm	1.23	extern int section_list_update_article_ontop(SECTION_LIST p_section, ARTICLE p_article);
143			extern int section_list_page_count_with_ontop(SECTION_LIST *p_section);
144			extern int section_list_page_article_count_with_ontop(SECTION_LIST *p_section, int32_t page_id);
145
146	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)
147			// *pp_next will be set as pointer to the next article of the article with aid
148			// *pp_next will be set as head article of the section if the article with aid locates at the tail of the section
149	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);
150	sysadm	1.7
151	sysadm	1.6	extern int section_list_calculate_page(SECTION_LIST *p_section, int32_t start_aid);
152	sysadm	1.7	extern int section_list_move_topic(SECTION_LIST p_section_src, SECTION_LIST p_section_dest, int32_t aid);
153	sysadm	1.11
154			extern int section_list_try_rd_lock(SECTION_LIST *p_section, int wait_sec);
155			extern int section_list_try_rw_lock(SECTION_LIST *p_section, int wait_sec);
156			extern int section_list_rd_unlock(SECTION_LIST *p_section);
157			extern int section_list_rw_unlock(SECTION_LIST *p_section);
158	sysadm	1.14	extern int section_list_rd_lock(SECTION_LIST *p_section);
159			extern int section_list_rw_lock(SECTION_LIST *p_section);
160	sysadm	1.19
161			#endif //_SECTION_LIST_H_
webmaster@leafok.com	ViewVC Help
Powered by ViewVC 1.3.0-beta1