/[LeafOK_CVS]/lbbs/include/section_list.h
ViewVC logotype

Diff of /lbbs/include/section_list.h

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.1 by sysadm, Wed May 21 04:07:42 2025 UTC Revision 1.40 by sysadm, Wed Nov 26 02:04:02 2025 UTC
# Line 1  Line 1 
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-2025  Leaflet <leaflet@leafok.com>
7     */
8  /***************************************************************************  
9   *                                                                         *  #ifndef _SECTION_LIST_H_
10   *   This program is free software; you can redistribute it and/or modify  *  #define _SECTION_LIST_H_
  *   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.                                   *  
  *                                                                         *  
  ***************************************************************************/  
11    
 #include "common.h"  
12  #include "bbs.h"  #include "bbs.h"
13    #include "common.h"
14    #include "menu.h"
15    #include <time.h>
16    
17    #ifdef HAVE_SYSTEM_V
18    #include <sys/sem.h>
19    #else
20    #include <semaphore.h>
21    #endif
22    
23  #define BBS_article_title_max_len 80  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  // Limit of articles (including those marked as deleted) per section = BBS_article_limit_per_block * BBS_article_block_limit_per_section          BBS_article_count_per_block = 1000,
32  #define BBS_article_limit_per_block 1000  };
 #define BBS_article_block_limit_per_section 50  
33    
34  struct article_t  struct article_t
35  {  {
36          int32_t aid;          int32_t aid;
37          int32_t tid;          int32_t tid;
38            int32_t sid;
39          int32_t cid;          int32_t cid;
40          int32_t uid;          int32_t uid;
41          int32_t prior_aid;          struct article_t *p_prior;               // prior article
42          int32_t next_aid;          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          int8_t visible;          int8_t visible;
46          int8_t excerption;          int8_t excerption;
47          int8_t ontop;          int8_t ontop;
48          int8_t lock;          int8_t lock;
49            int8_t transship;
50          char username[BBS_username_max_len + 1];          char username[BBS_username_max_len + 1];
51          char nickname[BBS_nickname_max_len + 1];          char nickname[BBS_nickname_max_len + 1];
52          char title[BBS_article_title_max_len + 1];          char title[BBS_article_title_max_len + 1];
53            time_t sub_dt;
54  };  };
55  typedef struct article_t ARTICLE;  typedef struct article_t ARTICLE;
56    
57  struct article_block_t  struct section_list_t
 {  
         ARTICLE articles[BBS_article_limit_per_block];  
         int32_t article_count;  
         struct article_block_t *p_next_block;  
 };  
 typedef struct article_block_t ARTICLE_BLOCK;  
   
 struct section_data_t  
58  {  {
59          int32_t sid;          int32_t sid;
60            int32_t class_id;
61            int8_t enable;
62          char sname[BBS_section_name_max_len + 1];          char sname[BBS_section_name_max_len + 1];
63          char stitle[BBS_section_title_max_len + 1];          char stitle[BBS_section_title_max_len + 1];
64          char master_name[BBS_username_max_len + 1];          char master_list[(BBS_username_max_len + 1) * 3 + 1];
65          ARTICLE_BLOCK *p_head_block;          int read_user_level;
66          ARTICLE_BLOCK *p_tail_block;          int write_user_level;
         ARTICLE_BLOCK *p_block[BBS_article_block_limit_per_section];  
         int32_t block_count;  
         int32_t block_head_aid[BBS_article_block_limit_per_section];  
67          int32_t article_count;          int32_t article_count;
68          int32_t delete_count;          int32_t topic_count;
69            int32_t visible_article_count;
70            int32_t visible_topic_count;
71            ARTICLE *p_article_head;
72            ARTICLE *p_article_tail;
73            ARTICLE *p_page_first_article[BBS_article_limit_per_section / BBS_article_limit_per_page];
74            int32_t page_count;
75            int32_t last_page_visible_article_count;
76            ARTICLE *p_ontop_articles[BBS_ontop_article_limit_per_section];
77            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;
82    
83    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_data_t SECTION_DATA;  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,
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    
108    extern int set_article_block_shm_readonly(void);
109    extern int detach_article_block_shm(void);
110    
111    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    extern int32_t article_block_last_aid(void);
117    extern int article_block_article_count(void);
118    
119    extern int article_count_of_topic(int32_t aid);
120    
121    extern int section_list_init(const char *filename);
122    extern void section_list_cleanup(void);
123    
124    extern int set_section_list_shm_readonly(void);
125    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);
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);
130    extern SECTION_LIST *section_list_find_by_name(const char *sname);
131    extern SECTION_LIST *section_list_find_by_sid(int32_t sid);
132    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);
140    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);
144    extern int section_list_page_count_with_ontop(SECTION_LIST *p_section);
145    extern int section_list_page_article_count_with_ontop(SECTION_LIST *p_section, int32_t page_id);
146    
147    // *p_page, *p_offset will be set as page / offset of the article with aid in *p_section (including both visible and invisible articles)
148    // *pp_next will be set as pointer to the next article of the article with aid
149    // *pp_next will be set as head article of the section if the article with aid locates at the tail of the section
150    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);
151    
152    extern int section_list_calculate_page(SECTION_LIST *p_section, int32_t start_aid);
153    extern int section_list_move_topic(SECTION_LIST *p_section_src, SECTION_LIST *p_section_dest, int32_t aid);
154    
155  extern int section_data_pool_init(const char *filename, int article_block_count);  extern int section_list_try_rd_lock(SECTION_LIST *p_section, int wait_sec);
156  extern void section_data_pool_cleanup(void);  extern int section_list_try_rw_lock(SECTION_LIST *p_section, int wait_sec);
157    extern int section_list_rd_unlock(SECTION_LIST *p_section);
158    extern int section_list_rw_unlock(SECTION_LIST *p_section);
159    extern int section_list_rd_lock(SECTION_LIST *p_section);
160    extern int section_list_rw_lock(SECTION_LIST *p_section);
161    
162  extern SECTION_DATA *section_data_create(const char *sname, const char *stitle, const char *master_name);  #endif //_SECTION_LIST_H_
 extern int section_data_free_block(SECTION_DATA *p_section);  
 extern SECTION_DATA *section_data_find_by_name(const char *sname);  
   
 extern int section_data_append_article(SECTION_DATA *p_section, const ARTICLE *p_article);  
 extern ARTICLE *section_data_search_article(SECTION_DATA *p_section, int32_t aid);  
 extern int section_data_mark_del_article(SECTION_DATA *p_section, int32_t aid);  

Legend:
Removed lines/characters  
Changed lines/characters
  Added lines/characters
webmaster@leafok.com
 ViewVC Help
Powered by ViewVC 1.3.0-beta1