lbbs/src/article_cache.c

/* SPDX-License-Identifier: GPL-3.0-or-later */
/*
 * article_cache
 *   - convert article content from DB to local cache with LML conversion and line offset index
 *
 * Copyright (C) 2004-2025  Leaflet <leaflet@leafok.com>
 */

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include "article_cache.h"
#include "lml.h"
#include "log.h"
#include <errno.h>
#include <fcntl.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <time.h>
#include <unistd.h>
#include <sys/mman.h>
#include <sys/stat.h>

enum _article_cache_constant_t
{
        ARTICLE_HEADER_MAX_LEN = 4096,
        ARTICLE_FOOTER_MAX_LEN = 4096,
        SUB_DT_MAX_LEN = 50,
};

static const char *BBS_article_footer_color[] = {
        "\033[31m",
        "\033[32m",
        "\033[33m",
        "\033[34m",
        "\033[35m",
        "\033[36m",
        "\033[37m",
};
static const int BBS_article_footer_color_count = 7;

static char *content_f; // static buffer in large size

inline static int article_cache_path(char *file_path, size_t buf_len, const char *cache_dir, const ARTICLE *p_article)
{
        if (file_path == NULL || cache_dir == NULL || p_article == NULL)
        {
                log_error("NULL pointer error\n");
                return -1;
        }

        snprintf(file_path, buf_len, "%s%d", cache_dir, p_article->cid);

        return 0;
}

int article_cache_generate(const char *cache_dir, const ARTICLE *p_article, const SECTION_LIST *p_section,
                                                   const char *content, const char *sub_ip, int overwrite)
{
        char data_file[FILE_PATH_LEN];
        int fd;
        ARTICLE_CACHE cache;
        struct tm tm_sub_dt;
        char str_sub_dt[SUB_DT_MAX_LEN + 1];
        char header[ARTICLE_HEADER_MAX_LEN];
        size_t header_len;
        long header_line_cnt;
        size_t body_len;
        long body_line_cnt;
        char footer[ARTICLE_FOOTER_MAX_LEN];
        size_t footer_len;
        long footer_line_cnt;
        long i;

        if (cache_dir == NULL || p_article == NULL || content == NULL)
        {
                log_error("NULL pointer error\n");
                return -1;
        }

        if (content_f == NULL && (content_f = malloc(ARTICLE_CONTENT_MAX_LEN)) == NULL)
        {
                log_error("malloc(content_f) error: OOM\n");
                return -1;
        }

        if (article_cache_path(data_file, sizeof(data_file), cache_dir, p_article) < 0)
        {
                log_error("article_cache_path(dir=%s, cid=%d) error\n", cache_dir, p_article->cid);
                return -1;
        }

        if (!overwrite)
        {
                if ((fd = open(data_file, O_RDONLY)) != -1) // check data file
                {
                        close(fd);
                        return 0;
                }
        }

        if ((fd = open(data_file, O_WRONLY | O_CREAT | O_TRUNC, 0640)) == -1)
        {
                log_error("open(%s) error (%d)\n", data_file, errno);
                return -2;
        }

        memset(&cache, 0, sizeof(cache));

        // Generate article header / footer
        localtime_r(&(p_article->sub_dt), &tm_sub_dt);
        strftime(str_sub_dt, sizeof(str_sub_dt), "%c %Z", &tm_sub_dt);

        snprintf(header, sizeof(header), "发布者: %s (%s), 版块: %s (%s)\n标  题: %s\n发布于: %s (%s)\n\n",
                         p_article->username, p_article->nickname, p_section->sname, p_section->stitle, p_article->title, BBS_name, str_sub_dt);

        snprintf(footer, sizeof(footer),
                         "\n--\n%s※ 来源: %s https://%s [FROM: %s]\033[m\n\n",
                         BBS_article_footer_color[p_article->aid % BBS_article_footer_color_count],
                         BBS_name, BBS_server, sub_ip);

        header_len = strnlen(header, sizeof(header));
        footer_len = strnlen(footer, sizeof(footer));

        header_line_cnt = split_data_lines(header, SCREEN_COLS, cache.line_offsets,
                                                                           MAX_SPLIT_FILE_LINES, 1, NULL);

        if (header_len != cache.line_offsets[header_line_cnt])
        {
#ifdef _DEBUG
                log_error("Header of article(aid=%d) is truncated from %ld to %ld\n, body_line=%ld, body_line_limit=%ld",
                                  p_article->aid, header_len, cache.line_offsets[header_line_cnt],
                                  header_line_cnt, MAX_SPLIT_FILE_LINES);
#endif
                header_len = (size_t)cache.line_offsets[header_line_cnt];
        }

        // Apply LML render to content body
        body_len = (size_t)lml_render(content, content_f, ARTICLE_CONTENT_MAX_LEN, SCREEN_COLS, 0);
        cache.data_len = header_len + body_len;

        body_line_cnt = split_data_lines(content_f, SCREEN_COLS + 1, &(cache.line_offsets[header_line_cnt]),
                                                                         MAX_SPLIT_FILE_LINES - header_line_cnt, 1, NULL);
        cache.line_total = header_line_cnt + body_line_cnt;

        if (body_len != (size_t)cache.line_offsets[cache.line_total])
        {
#ifdef _DEBUG
                log_error("Body of article(aid=%d) is truncated from %ld to %ld, body_line=%ld, body_line_limit=%ld\n",
                                  p_article->aid, body_len, cache.line_offsets[cache.line_total],
                                  body_line_cnt, MAX_SPLIT_FILE_LINES - header_line_cnt);
#endif
                cache.data_len = header_len + (size_t)(cache.line_offsets[cache.line_total]);
        }

        for (i = header_line_cnt; i <= cache.line_total; i++)
        {
                cache.line_offsets[i] += (long)header_len;
        }

        footer_line_cnt = split_data_lines(footer, SCREEN_COLS, &(cache.line_offsets[cache.line_total]),
                                                                           MAX_SPLIT_FILE_LINES - cache.line_total, 1, NULL);

        if (footer_len != cache.line_offsets[cache.line_total + footer_line_cnt])
        {
#ifdef _DEBUG
                log_error("Footer of article(aid=%d) is truncated from %ld to %ld, footer_line=%ld, footer_line_limit=%ld\n",
                                  p_article->aid, footer_len, cache.line_offsets[cache.line_total + footer_line_cnt],
                                  footer_line_cnt, MAX_SPLIT_FILE_LINES - cache.line_total);
#endif
                footer_len = (size_t)(cache.line_offsets[cache.line_total + footer_line_cnt]);
        }

        for (i = 0; i <= footer_line_cnt; i++)
        {
                cache.line_offsets[cache.line_total + i] += (long)cache.data_len;
        }

        cache.data_len += footer_len;
        cache.line_total += footer_line_cnt;
        cache.mmap_len = sizeof(cache) - sizeof(long) * (MAX_SPLIT_FILE_LINES - (size_t)(cache.line_total) - 1) + cache.data_len;

        if (write(fd, &cache, cache.mmap_len - cache.data_len) == -1)
        {
                log_error("write(%s, cache) error (%d)\n", data_file, errno);
                close(fd);
                return -3;
        }
        if (write(fd, header, header_len) == -1)
        {
                log_error("write(%s, header) error (%d)\n", data_file, errno);
                close(fd);
                return -3;
        }
        if (write(fd, content_f, cache.data_len - header_len - footer_len) == -1)
        {
                log_error("write(%s, content) error (%d)\n", data_file, errno);
                close(fd);
                return -3;
        }
        if (write(fd, footer, footer_len) == -1)
        {
                log_error("write(%s, footer) error (%d)\n", data_file, errno);
                close(fd);
                return -3;
        }

        if (close(fd) == -1)
        {
                log_error("close(%s) error (%d)\n", data_file, errno);
                return -2;
        }

        return 0;
}

void article_cache_cleanup(void)
{
        if (content_f)
        {
                free(content_f);
                content_f = NULL;
        }
}

int article_cache_load(ARTICLE_CACHE *p_cache, const char *cache_dir, const ARTICLE *p_article)
{
        char data_file[FILE_PATH_LEN];
        int fd;
        struct stat sb;
        void *p_mmap;
        size_t mmap_len;

        if (p_cache == NULL || cache_dir == NULL || p_article == NULL)
        {
                log_error("NULL pointer error\n");
                return -1;
        }

        if (article_cache_path(data_file, sizeof(data_file), cache_dir, p_article) < 0)
        {
                log_error("article_cache_path(dir=%s, cid=%d) error\n", cache_dir, p_article->cid);
                return -1;
        }

        if ((fd = open(data_file, O_RDONLY)) == -1)
        {
                log_error("open(%s) error (%d)\n", data_file, errno);
                return -2;
        }

        if (fstat(fd, &sb) < 0)
        {
                log_error("fstat(fd) error (%d)\n", errno);
                return -2;
        }

        mmap_len = (size_t)sb.st_size;

        p_mmap = mmap(NULL, mmap_len, PROT_READ, MAP_SHARED, fd, 0L);
        if (p_mmap == MAP_FAILED)
        {
                log_error("mmap(%s) error (%d)\n", data_file, errno);
                return -2;
        }

        if (close(fd) == -1)
        {
                log_error("close(%s) error (%d)\n", data_file, errno);
                return -2;
        }

        if (((ARTICLE_CACHE *)p_mmap)->mmap_len != mmap_len)
        {
                log_error("Inconsistent mmap len of article (cid=%d), %ld != %ld\n", p_article->cid, p_cache->mmap_len, mmap_len);
                return -3;
        }

        memset(p_cache, 0, sizeof(*p_cache));
        memcpy((void *)p_cache, p_mmap, (size_t)(((ARTICLE_CACHE *)p_mmap)->mmap_len - ((ARTICLE_CACHE *)p_mmap)->data_len));

        p_cache->p_mmap = p_mmap;
        p_cache->p_data = (char *)p_mmap + (p_cache->mmap_len - p_cache->data_len);

        return 0;
}

int article_cache_unload(ARTICLE_CACHE *p_cache)
{
        if (p_cache == NULL || p_cache->p_mmap == NULL)
        {
                log_error("NULL pointer error\n");
                return -1;
        }

        if (munmap(p_cache->p_mmap, p_cache->mmap_len) < 0)
        {
                log_error("munmap() error (%d)\n", errno);
                return -2;
        }

        p_cache->p_mmap = NULL;
        p_cache->p_data = NULL;

        return 0;
}
1	sysadm	1.33	/* SPDX-License-Identifier: GPL-3.0-or-later */
2			/*
3			* article_cache
4			* - convert article content from DB to local cache with LML conversion and line offset index
5			*
6	sysadm	1.34	* Copyright (C) 2004-2025 Leaflet <leaflet@leafok.com>
7	sysadm	1.33	*/
8	sysadm	1.1
9	sysadm	1.36	#ifdef HAVE_CONFIG_H
10			#include "config.h"
11			#endif
12
13	sysadm	1.1	#include "article_cache.h"
14	sysadm	1.21	#include "lml.h"
15	sysadm	1.2	#include "log.h"
16			#include <errno.h>
17	sysadm	1.21	#include <fcntl.h>
18	sysadm	1.2	#include <stdio.h>
19			#include <stdlib.h>
20	sysadm	1.21	#include <string.h>
21			#include <time.h>
22	sysadm	1.2	#include <unistd.h>
23			#include <sys/mman.h>
24			#include <sys/stat.h>
25	sysadm	1.1
26	sysadm	1.35	enum _article_cache_constant_t
27			{
28			ARTICLE_HEADER_MAX_LEN = 4096,
29			ARTICLE_FOOTER_MAX_LEN = 4096,
30			SUB_DT_MAX_LEN = 50,
31			};
32	sysadm	1.2
33	sysadm	1.7	static const char *BBS_article_footer_color[] = {
34			"\033[31m",
35			"\033[32m",
36			"\033[33m",
37			"\033[34m",
38			"\033[35m",
39			"\033[36m",
40			"\033[37m",
41			};
42			static const int BBS_article_footer_color_count = 7;
43
44	sysadm	1.22	static char *content_f; // static buffer in large size
45
46	sysadm	1.2	inline static int article_cache_path(char file_path, size_t buf_len, const char cache_dir, const ARTICLE *p_article)
47			{
48			if (file_path == NULL \|\| cache_dir == NULL \|\| p_article == NULL)
49			{
50	sysadm	1.27	log_error("NULL pointer error\n");
51	sysadm	1.2	return -1;
52			}
53
54			snprintf(file_path, buf_len, "%s%d", cache_dir, p_article->cid);
55
56			return 0;
57			}
58
59	sysadm	1.5	int article_cache_generate(const char cache_dir, const ARTICLE p_article, const SECTION_LIST *p_section,
60			const char content, const char sub_ip, int overwrite)
61	sysadm	1.1	{
62	sysadm	1.2	char data_file[FILE_PATH_LEN];
63			int fd;
64			ARTICLE_CACHE cache;
65	sysadm	1.3	struct tm tm_sub_dt;
66	sysadm	1.5	char str_sub_dt[SUB_DT_MAX_LEN + 1];
67	sysadm	1.3	char header[ARTICLE_HEADER_MAX_LEN];
68			size_t header_len;
69			long header_line_cnt;
70	sysadm	1.37	size_t body_len;
71			long body_line_cnt;
72	sysadm	1.5	char footer[ARTICLE_FOOTER_MAX_LEN];
73			size_t footer_len;
74			long footer_line_cnt;
75	sysadm	1.3	long i;
76	sysadm	1.2
77			if (cache_dir == NULL \|\| p_article == NULL \|\| content == NULL)
78			{
79	sysadm	1.27	log_error("NULL pointer error\n");
80	sysadm	1.2	return -1;
81			}
82
83	sysadm	1.16	if (content_f == NULL && (content_f = malloc(ARTICLE_CONTENT_MAX_LEN)) == NULL)
84			{
85			log_error("malloc(content_f) error: OOM\n");
86			return -1;
87			}
88
89	sysadm	1.2	if (article_cache_path(data_file, sizeof(data_file), cache_dir, p_article) < 0)
90			{
91			log_error("article_cache_path(dir=%s, cid=%d) error\n", cache_dir, p_article->cid);
92			return -1;
93			}
94
95			if (!overwrite)
96			{
97			if ((fd = open(data_file, O_RDONLY)) != -1) // check data file
98			{
99			close(fd);
100			return 0;
101			}
102			}
103
104			if ((fd = open(data_file, O_WRONLY \| O_CREAT \| O_TRUNC, 0640)) == -1)
105			{
106			log_error("open(%s) error (%d)\n", data_file, errno);
107			return -2;
108			}
109
110	sysadm	1.18	memset(&cache, 0, sizeof(cache));
111	sysadm	1.3
112	sysadm	1.5	// Generate article header / footer
113	sysadm	1.3	localtime_r(&(p_article->sub_dt), &tm_sub_dt);
114	sysadm	1.32	strftime(str_sub_dt, sizeof(str_sub_dt), "%c %Z", &tm_sub_dt);
115	sysadm	1.3
116	sysadm	1.24	snprintf(header, sizeof(header), "发布者: %s (%s), 版块: %s (%s)\n标题: %s\n发布于: %s (%s)\n\n",
117	sysadm	1.3	p_article->username, p_article->nickname, p_section->sname, p_section->stitle, p_article->title, BBS_name, str_sub_dt);
118
119	sysadm	1.5	snprintf(footer, sizeof(footer),
120	sysadm	1.38	"\n--\n%s※ 来源: %s https://%s [FROM: %s]\033[m\n\n",
121	sysadm	1.7	BBS_article_footer_color[p_article->aid % BBS_article_footer_color_count],
122	sysadm	1.5	BBS_name, BBS_server, sub_ip);
123
124	sysadm	1.3	header_len = strnlen(header, sizeof(header));
125	sysadm	1.5	footer_len = strnlen(footer, sizeof(footer));
126
127	sysadm	1.37	header_line_cnt = split_data_lines(header, SCREEN_COLS, cache.line_offsets,
128			MAX_SPLIT_FILE_LINES, 1, NULL);
129	sysadm	1.10
130			if (header_len != cache.line_offsets[header_line_cnt])
131			{
132	sysadm	1.20	#ifdef _DEBUG
133	sysadm	1.37	log_error("Header of article(aid=%d) is truncated from %ld to %ld\n, body_line=%ld, body_line_limit=%ld",
134			p_article->aid, header_len, cache.line_offsets[header_line_cnt],
135			header_line_cnt, MAX_SPLIT_FILE_LINES);
136	sysadm	1.20	#endif
137	sysadm	1.10	header_len = (size_t)cache.line_offsets[header_line_cnt];
138			}
139
140	sysadm	1.12	// Apply LML render to content body
141	sysadm	1.37	body_len = (size_t)lml_render(content, content_f, ARTICLE_CONTENT_MAX_LEN, SCREEN_COLS, 0);
142			cache.data_len = header_len + body_len;
143	sysadm	1.12
144	sysadm	1.37	body_line_cnt = split_data_lines(content_f, SCREEN_COLS + 1, &(cache.line_offsets[header_line_cnt]),
145			MAX_SPLIT_FILE_LINES - header_line_cnt, 1, NULL);
146			cache.line_total = header_line_cnt + body_line_cnt;
147	sysadm	1.11
148	sysadm	1.37	if (body_len != (size_t)cache.line_offsets[cache.line_total])
149	sysadm	1.10	{
150	sysadm	1.20	#ifdef _DEBUG
151	sysadm	1.37	log_error("Body of article(aid=%d) is truncated from %ld to %ld, body_line=%ld, body_line_limit=%ld\n",
152			p_article->aid, body_len, cache.line_offsets[cache.line_total],
153			body_line_cnt, MAX_SPLIT_FILE_LINES - header_line_cnt);
154	sysadm	1.20	#endif
155	sysadm	1.10	cache.data_len = header_len + (size_t)(cache.line_offsets[cache.line_total]);
156			}
157
158	sysadm	1.3	for (i = header_line_cnt; i <= cache.line_total; i++)
159			{
160			cache.line_offsets[i] += (long)header_len;
161	sysadm	1.2	}
162
163	sysadm	1.37	footer_line_cnt = split_data_lines(footer, SCREEN_COLS, &(cache.line_offsets[cache.line_total]),
164			MAX_SPLIT_FILE_LINES - cache.line_total, 1, NULL);
165	sysadm	1.5
166	sysadm	1.10	if (footer_len != cache.line_offsets[cache.line_total + footer_line_cnt])
167			{
168	sysadm	1.20	#ifdef _DEBUG
169	sysadm	1.37	log_error("Footer of article(aid=%d) is truncated from %ld to %ld, footer_line=%ld, footer_line_limit=%ld\n",
170			p_article->aid, footer_len, cache.line_offsets[cache.line_total + footer_line_cnt],
171			footer_line_cnt, MAX_SPLIT_FILE_LINES - cache.line_total);
172	sysadm	1.20	#endif
173	sysadm	1.10	footer_len = (size_t)(cache.line_offsets[cache.line_total + footer_line_cnt]);
174			}
175
176	sysadm	1.5	for (i = 0; i <= footer_line_cnt; i++)
177			{
178			cache.line_offsets[cache.line_total + i] += (long)cache.data_len;
179			}
180
181			cache.data_len += footer_len;
182			cache.line_total += footer_line_cnt;
183	sysadm	1.8	cache.mmap_len = sizeof(cache) - sizeof(long) * (MAX_SPLIT_FILE_LINES - (size_t)(cache.line_total) - 1) + cache.data_len;
184	sysadm	1.5
185	sysadm	1.8	if (write(fd, &cache, cache.mmap_len - cache.data_len) == -1)
186	sysadm	1.2	{
187			log_error("write(%s, cache) error (%d)\n", data_file, errno);
188			close(fd);
189			return -3;
190			}
191	sysadm	1.3	if (write(fd, header, header_len) == -1)
192			{
193			log_error("write(%s, header) error (%d)\n", data_file, errno);
194			close(fd);
195			return -3;
196			}
197	sysadm	1.12	if (write(fd, content_f, cache.data_len - header_len - footer_len) == -1)
198	sysadm	1.2	{
199	sysadm	1.3	log_error("write(%s, content) error (%d)\n", data_file, errno);
200	sysadm	1.2	close(fd);
201			return -3;
202			}
203	sysadm	1.5	if (write(fd, footer, footer_len) == -1)
204			{
205			log_error("write(%s, footer) error (%d)\n", data_file, errno);
206			close(fd);
207			return -3;
208			}
209	sysadm	1.2
210			if (close(fd) == -1)
211			{
212			log_error("close(%s) error (%d)\n", data_file, errno);
213			return -2;
214			}
215
216	sysadm	1.1	return 0;
217			}
218
219	sysadm	1.22	void article_cache_cleanup(void)
220			{
221			if (content_f)
222			{
223			free(content_f);
224			content_f = NULL;
225			}
226			}
227
228	sysadm	1.1	int article_cache_load(ARTICLE_CACHE p_cache, const char cache_dir, const ARTICLE *p_article)
229			{
230	sysadm	1.2	char data_file[FILE_PATH_LEN];
231			int fd;
232	sysadm	1.4	struct stat sb;
233			void *p_mmap;
234			size_t mmap_len;
235	sysadm	1.2
236			if (p_cache == NULL \|\| cache_dir == NULL \|\| p_article == NULL)
237			{
238	sysadm	1.27	log_error("NULL pointer error\n");
239	sysadm	1.2	return -1;
240			}
241
242			if (article_cache_path(data_file, sizeof(data_file), cache_dir, p_article) < 0)
243			{
244			log_error("article_cache_path(dir=%s, cid=%d) error\n", cache_dir, p_article->cid);
245			return -1;
246			}
247
248			if ((fd = open(data_file, O_RDONLY)) == -1)
249			{
250			log_error("open(%s) error (%d)\n", data_file, errno);
251			return -2;
252			}
253
254	sysadm	1.4	if (fstat(fd, &sb) < 0)
255	sysadm	1.2	{
256	sysadm	1.4	log_error("fstat(fd) error (%d)\n", errno);
257			return -2;
258	sysadm	1.2	}
259
260	sysadm	1.4	mmap_len = (size_t)sb.st_size;
261	sysadm	1.2
262	sysadm	1.4	p_mmap = mmap(NULL, mmap_len, PROT_READ, MAP_SHARED, fd, 0L);
263			if (p_mmap == MAP_FAILED)
264	sysadm	1.2	{
265	sysadm	1.4	log_error("mmap(%s) error (%d)\n", data_file, errno);
266			return -2;
267	sysadm	1.2	}
268
269			if (close(fd) == -1)
270			{
271			log_error("close(%s) error (%d)\n", data_file, errno);
272			return -2;
273			}
274
275	sysadm	1.8	if (((ARTICLE_CACHE *)p_mmap)->mmap_len != mmap_len)
276	sysadm	1.4	{
277	sysadm	1.8	log_error("Inconsistent mmap len of article (cid=%d), %ld != %ld\n", p_article->cid, p_cache->mmap_len, mmap_len);
278	sysadm	1.4	return -3;
279			}
280
281	sysadm	1.18	memset(p_cache, 0, sizeof(*p_cache));
282	sysadm	1.8	memcpy((void )p_cache, p_mmap, (size_t)(((ARTICLE_CACHE )p_mmap)->mmap_len - ((ARTICLE_CACHE *)p_mmap)->data_len));
283
284	sysadm	1.4	p_cache->p_mmap = p_mmap;
285	sysadm	1.28	p_cache->p_data = (char *)p_mmap + (p_cache->mmap_len - p_cache->data_len);
286	sysadm	1.4
287	sysadm	1.1	return 0;
288			}
289
290			int article_cache_unload(ARTICLE_CACHE *p_cache)
291			{
292	sysadm	1.4	if (p_cache == NULL \|\| p_cache->p_mmap == NULL)
293	sysadm	1.2	{
294	sysadm	1.27	log_error("NULL pointer error\n");
295	sysadm	1.2	return -1;
296			}
297
298	sysadm	1.8	if (munmap(p_cache->p_mmap, p_cache->mmap_len) < 0)
299	sysadm	1.4	{
300			log_error("munmap() error (%d)\n", errno);
301			return -2;
302			}
303
304			p_cache->p_mmap = NULL;
305	sysadm	1.2	p_cache->p_data = NULL;
306
307	sysadm	1.1	return 0;
308			}
webmaster@leafok.com	ViewVC Help
Powered by ViewVC 1.3.0-beta1