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 by Leaflet <leaflet@leafok.com>
 */

#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>

#define ARTICLE_HEADER_MAX_LEN 4096
#define ARTICLE_CONTENT_MAX_LEN 1024 * 1024 * 4 // 4MB
#define ARTICLE_FOOTER_MAX_LEN 4096
#define 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;
        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 http://%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", p_article->aid, header_len, cache.line_offsets[header_line_cnt]);
#endif
                header_len = (size_t)cache.line_offsets[header_line_cnt];
        }

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

        cache.line_total = header_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);

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