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