PostgreSQL Source Code: src/backend/tsearch/ts_utils.c Source File

PostgreSQL Source Code git master
ts_utils.c
Go to the documentation of this file.
1/*-------------------------------------------------------------------------
2 *
3 * ts_utils.c
4 * various support functions
5 *
6 * Portions Copyright (c) 1996-2025, PostgreSQL Global Development Group
7 *
8 *
9 * IDENTIFICATION
10 * src/backend/tsearch/ts_utils.c
11 *
12 *-------------------------------------------------------------------------
13 */
14
15#include "postgres.h"
16
17#include <ctype.h>
18
19#include "catalog/pg_collation_d.h"
20#include "miscadmin.h"
21#include "tsearch/ts_locale.h"
22#include "tsearch/ts_public.h"
23
24
25/*
26 * Given the base name and extension of a tsearch config file, return
27 * its full path name. The base name is assumed to be user-supplied,
28 * and is checked to prevent pathname attacks. The extension is assumed
29 * to be safe.
30 *
31 * The result is a palloc'd string.
32 */
33char *
34 get_tsearch_config_filename(const char *basename,
35 const char *extension)
36{
37 char sharepath[MAXPGPATH];
38 char *result;
39
40 /*
41 * We limit the basename to contain a-z, 0-9, and underscores. This may
42 * be overly restrictive, but we don't want to allow access to anything
43 * outside the tsearch_data directory, so for instance '/' *must* be
44 * rejected, and on some platforms '\' and ':' are risky as well. Allowing
45 * uppercase might result in incompatible behavior between case-sensitive
46 * and case-insensitive filesystems, and non-ASCII characters create other
47 * interesting risks, so on the whole a tight policy seems best.
48 */
49 if (strspn(basename, "abcdefghijklmnopqrstuvwxyz0123456789_") != strlen(basename))
50 ereport(ERROR,
51 (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
52 errmsg("invalid text search configuration file name \"%s\"",
53 basename)));
54
55 get_share_path(my_exec_path, sharepath);
56 result = palloc(MAXPGPATH);
57 snprintf(result, MAXPGPATH, "%s/tsearch_data/%s.%s",
58 sharepath, basename, extension);
59
60 return result;
61}
62
63/*
64 * Reads a stop-word file. Each word is run through 'wordop'
65 * function, if given. wordop may either modify the input in-place,
66 * or palloc a new version.
67 */
68void
69 readstoplist(const char *fname, StopList *s, char *(*wordop) (const char *, size_t, Oid))
70{
71 char **stop = NULL;
72
73 s->len = 0;
74 if (fname && *fname)
75 {
76 char *filename = get_tsearch_config_filename(fname, "stop");
77 tsearch_readline_state trst;
78 char *line;
79 int reallen = 0;
80
81 if (!tsearch_readline_begin(&trst, filename))
82 ereport(ERROR,
83 (errcode(ERRCODE_CONFIG_FILE_ERROR),
84 errmsg("could not open stop-word file \"%s\": %m",
85 filename)));
86
87 while ((line = tsearch_readline(&trst)) != NULL)
88 {
89 char *pbuf = line;
90
91 /* Trim trailing space */
92 while (*pbuf && !isspace((unsigned char) *pbuf))
93 pbuf += pg_mblen(pbuf);
94 *pbuf = '0円';
95
96 /* Skip empty lines */
97 if (*line == '0円')
98 {
99 pfree(line);
100 continue;
101 }
102
103 if (s->len >= reallen)
104 {
105 if (reallen == 0)
106 {
107 reallen = 64;
108 stop = (char **) palloc(sizeof(char *) * reallen);
109 }
110 else
111 {
112 reallen *= 2;
113 stop = (char **) repalloc(stop, sizeof(char *) * reallen);
114 }
115 }
116
117 if (wordop)
118 {
119 stop[s->len] = wordop(line, strlen(line), DEFAULT_COLLATION_OID);
120 if (stop[s->len] != line)
121 pfree(line);
122 }
123 else
124 stop[s->len] = line;
125
126 (s->len)++;
127 }
128
129 tsearch_readline_end(&trst);
130 pfree(filename);
131 }
132
133 s->stop = stop;
134
135 /* Sort to allow binary searching */
136 if (s->stop && s->len > 0)
137 qsort(s->stop, s->len, sizeof(char *), pg_qsort_strcmp);
138}
139
140bool
141 searchstoplist(StopList *s, char *key)
142{
143 return (s->stop && s->len > 0 &&
144 bsearch(&key, s->stop, s->len,
145 sizeof(char *), pg_qsort_strcmp));
146}
int errcode(int sqlerrcode)
Definition: elog.c:854
int errmsg(const char *fmt,...)
Definition: elog.c:1071
#define ERROR
Definition: elog.h:39
#define ereport(elevel,...)
Definition: elog.h:150
char my_exec_path[MAXPGPATH]
Definition: globals.c:81
int pg_mblen(const char *mbstr)
Definition: mbutils.c:1024
void * repalloc(void *pointer, Size size)
Definition: mcxt.c:1610
void pfree(void *pointer)
Definition: mcxt.c:1594
void * palloc(Size size)
Definition: mcxt.c:1365
#define MAXPGPATH
static char * filename
Definition: pg_dumpall.c:120
void get_share_path(const char *my_exec_path, char *ret_path)
Definition: path.c:902
int pg_qsort_strcmp(const void *a, const void *b)
Definition: qsort.c:19
#define snprintf
Definition: port.h:239
#define qsort(a, b, c, d)
Definition: port.h:479
unsigned int Oid
Definition: postgres_ext.h:32
int len
Definition: ts_public.h:102
char ** stop
Definition: ts_public.h:103
Definition: ts_locale.h:25
bool tsearch_readline_begin(tsearch_readline_state *stp, const char *filename)
Definition: ts_locale.c:89
char * tsearch_readline(tsearch_readline_state *stp)
Definition: ts_locale.c:112
void tsearch_readline_end(tsearch_readline_state *stp)
Definition: ts_locale.c:157
void readstoplist(const char *fname, StopList *s, char *(*wordop)(const char *, size_t, Oid))
Definition: ts_utils.c:69
bool searchstoplist(StopList *s, char *key)
Definition: ts_utils.c:141
char * get_tsearch_config_filename(const char *basename, const char *extension)
Definition: ts_utils.c:34

AltStyle によって変換されたページ (->オリジナル) /