/[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.6 by sysadm, Thu May 22 11:10:19 2025 UTC Revision 1.34 by sysadm, Wed Nov 5 03:01:14 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  #define BBS_article_title_max_len 80  enum section_list_constant_t
18  #define BBS_article_limit_per_section 50000  {
19  #define BBS_article_limit_per_page 20          BBS_article_title_max_len = 160,
20            BBS_article_limit_per_section = 50000,
21            BBS_article_limit_per_page = 20,
22    
23            BBS_ontop_article_limit_per_section = 10,
24    
25  #define ARTICLE_PER_BLOCK 1000          BBS_article_count_per_block = 1000,
26    };
27    
28  struct article_t  struct article_t
29  {  {
30          int32_t aid;          int32_t aid;
31          int32_t tid;          int32_t tid;
32            int32_t sid;
33          int32_t cid;          int32_t cid;
34          int32_t uid;          int32_t uid;
35          struct article_t *p_prior;               // prior article          struct article_t *p_prior;               // prior article
# Line 37  struct article_t Line 40  struct article_t
40          int8_t excerption;          int8_t excerption;
41          int8_t ontop;          int8_t ontop;
42          int8_t lock;          int8_t lock;
43            int8_t transship;
44          char username[BBS_username_max_len + 1];          char username[BBS_username_max_len + 1];
45          char nickname[BBS_nickname_max_len + 1];          char nickname[BBS_nickname_max_len + 1];
46          char title[BBS_article_title_max_len + 1];          char title[BBS_article_title_max_len + 1];
47            time_t sub_dt;
48  };  };
49  typedef struct article_t ARTICLE;  typedef struct article_t ARTICLE;
50    
51  struct section_list_t  struct section_list_t
52  {  {
53          int32_t sid;          int32_t sid;
54            int32_t class_id;
55            int8_t enable;
56          char sname[BBS_section_name_max_len + 1];          char sname[BBS_section_name_max_len + 1];
57          char stitle[BBS_section_title_max_len + 1];          char stitle[BBS_section_title_max_len + 1];
58          char master_name[BBS_username_max_len + 1];          char master_list[(BBS_username_max_len + 1) * 3 + 1];
59            int read_user_level;
60            int write_user_level;
61          int32_t article_count;          int32_t article_count;
62          int32_t topic_count;          int32_t topic_count;
63          int32_t visible_article_count;          int32_t visible_article_count;
# Line 58  struct section_list_t Line 67  struct section_list_t
67          ARTICLE *p_page_first_article[BBS_article_limit_per_section / BBS_article_limit_per_page];          ARTICLE *p_page_first_article[BBS_article_limit_per_section / BBS_article_limit_per_page];
68          int32_t page_count;          int32_t page_count;
69          int32_t last_page_visible_article_count;          int32_t last_page_visible_article_count;
70            ARTICLE *p_ontop_articles[BBS_ontop_article_limit_per_section];
71            int32_t ontop_article_count;
72            MENU_SET ex_menu_set;
73            time_t ex_menu_tm;
74  };  };
75  typedef struct section_list_t SECTION_LIST;  typedef struct section_list_t SECTION_LIST;
76    
77  // article_block_count * ARTICLE_PER_BLOCK should be  struct section_list_pool_t
78    {
79            int shmid;
80            SECTION_LIST sections[BBS_max_section];
81            int section_count;
82            int semid;
83            TRIE_NODE *p_trie_dict_section_by_name;
84            TRIE_NODE *p_trie_dict_section_by_sid;
85    };
86    typedef struct section_list_pool_t SECTION_LIST_POOL;
87    
88    extern SECTION_LIST_POOL *p_section_list_pool;
89    
90    // article_block_count * BBS_article_count_per_block should be
91  // no less than BBS_article_limit_per_section * BBS_max_section,  // no less than BBS_article_limit_per_section * BBS_max_section,
92  // in order to allocate enough memory for blocks  // in order to allocate enough memory for blocks
93  extern int article_block_init(const char *filename, int block_count);  extern int article_block_init(const char *filename, int block_count);
94  extern void article_block_cleanup(void);  extern void article_block_cleanup(void);
95    
96    extern int set_article_block_shm_readonly(void);
97    extern int detach_article_block_shm(void);
98    
99  extern int article_block_reset(void);  extern int article_block_reset(void);
100    
101  extern ARTICLE *article_block_find_by_aid(int32_t aid);  extern ARTICLE *article_block_find_by_aid(int32_t aid);
102  extern ARTICLE *article_block_find_by_index(int index);  extern ARTICLE *article_block_find_by_index(int index);
103    
104  extern SECTION_LIST *section_list_create(const char *sname, const char *stitle, const char *master_name);  extern int32_t article_block_last_aid(void);
105  extern void section_list_reset_articles(SECTION_LIST *p_section);  extern int article_block_article_count(void);
106    
107    extern int article_count_of_topic(int32_t aid);
108    
109    extern int section_list_init(const char *filename);
110  extern void section_list_cleanup(void);  extern void section_list_cleanup(void);
111    
112    extern int set_section_list_shm_readonly(void);
113    extern int detach_section_list_shm(void);
114    
115    extern SECTION_LIST *section_list_create(int32_t sid, const char *sname, const char *stitle, const char *master_list);
116    extern int section_list_update(SECTION_LIST *p_section, const char *sname, const char *stitle, const char *master_list);
117    extern void section_list_reset_articles(SECTION_LIST *p_section);
118  extern SECTION_LIST *section_list_find_by_name(const char *sname);  extern SECTION_LIST *section_list_find_by_name(const char *sname);
119    extern SECTION_LIST *section_list_find_by_sid(int32_t sid);
120    extern int get_section_index(SECTION_LIST *p_section);
121    
122    // sname could be NULL, or pointer to char[] in size >= sizeof(SECTION_LIST.sname)
123    // stitle could be NULL, or pointer to char[] in size >= sizeof(SECTION_LIST.stitle)
124    // master_list could be NULL, or pointer to char[] in size >= sizeof(SECTION_LIST.master_list)
125    extern int get_section_info(SECTION_LIST *p_section, char *sname, char *stitle, char *master_list);
126    
127  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);
128  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);
129  extern ARTICLE * section_list_find_article_with_offset(SECTION_LIST *p_section, int32_t aid, int32_t *p_page, int32_t *p_offset);  
130    extern int section_list_update_article_ontop(SECTION_LIST *p_section, ARTICLE *p_article);
131    extern int section_list_page_count_with_ontop(SECTION_LIST *p_section);
132    extern int section_list_page_article_count_with_ontop(SECTION_LIST *p_section, int32_t page_id);
133    
134    // *p_page, *p_offset will be set as page / offset of the article with aid in *p_section (including both visible and invisible articles)
135    // *pp_next will be set as pointer to the next article of the article with aid
136    // *pp_next will be set as head article of the section if the article with aid locates at the tail of the section
137    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);
138    
139  extern int section_list_calculate_page(SECTION_LIST *p_section, int32_t start_aid);  extern int section_list_calculate_page(SECTION_LIST *p_section, int32_t start_aid);
140    extern int section_list_move_topic(SECTION_LIST *p_section_src, SECTION_LIST *p_section_dest, int32_t aid);
141    
142    extern int section_list_try_rd_lock(SECTION_LIST *p_section, int wait_sec);
143    extern int section_list_try_rw_lock(SECTION_LIST *p_section, int wait_sec);
144    extern int section_list_rd_unlock(SECTION_LIST *p_section);
145    extern int section_list_rw_unlock(SECTION_LIST *p_section);
146    extern int section_list_rd_lock(SECTION_LIST *p_section);
147    extern int section_list_rw_lock(SECTION_LIST *p_section);
148    
149    #endif //_SECTION_LIST_H_

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