/
dbfactory.cc
469 lines (415 loc) · 12.5 KB
/
dbfactory.cc
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
/** @file dbfactory.cc
* @brief Database factories for non-remote databases.
*/
/* Copyright 2002,2003,2004,2005,2006,2007,2008,2009,2011,2012 Olly Betts
* Copyright 2008 Lemur Consulting Ltd
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as
* published by the Free Software Foundation; either version 2 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
* USA
*/
#include <config.h>
#include "xapian/dbfactory.h"
#include "xapian/database.h"
#include "xapian/error.h"
#include "xapian/version.h" // For XAPIAN_HAS_XXX_BACKEND.
#include "debuglog.h"
#include "filetests.h"
#include "fileutils.h"
#include "str.h"
#include "safeerrno.h"
#ifdef XAPIAN_HAS_BRASS_BACKEND
# include "brass/brass_database.h"
#endif
#ifdef XAPIAN_HAS_CHERT_BACKEND
# include "chert/chert_database.h"
#endif
#ifdef XAPIAN_HAS_INMEMORY_BACKEND
# include "inmemory/inmemory_database.h"
#endif
#include <fstream>
#include <string>
using namespace std;
namespace Xapian {
#ifdef XAPIAN_HAS_BRASS_BACKEND
Database
Brass::open(const string &dir) {
LOGCALL_STATIC(API, Database, "Brass::open", dir);
RETURN(Database(new BrassDatabase(dir)));
}
WritableDatabase
Brass::open(const string &dir, int action, int block_size) {
LOGCALL_STATIC(API, WritableDatabase, "Brass::open", dir | action | block_size);
RETURN(WritableDatabase(new BrassWritableDatabase(dir, action, block_size)));
}
#endif
#ifdef XAPIAN_HAS_CHERT_BACKEND
Database
Chert::open(const string &dir) {
LOGCALL_STATIC(API, Database, "Chert::open", dir);
return Database(new ChertDatabase(dir));
}
WritableDatabase
Chert::open(const string &dir, int action, int block_size) {
LOGCALL_STATIC(API, WritableDatabase, "Chert::open", dir | action | block_size);
return WritableDatabase(new ChertWritableDatabase(dir, action, block_size));
}
#endif
#ifdef XAPIAN_HAS_INMEMORY_BACKEND
WritableDatabase
InMemory::open() {
LOGCALL_STATIC(API, Database, "InMemory::open", NO_ARGS);
return WritableDatabase(new InMemoryDatabase);
}
#endif
static void
open_stub(Database &db, const string &file)
{
// A stub database is a text file with one or more lines of this format:
// <dbtype> <serialised db object>
//
// Lines which start with a "#" character are ignored.
//
// Any paths specified in stub database files which are relative will be
// considered to be relative to the directory containing the stub database.
ifstream stub(file.c_str());
if (!stub) {
string msg = "Couldn't open stub database file: ";
msg += file;
throw Xapian::DatabaseOpeningError(msg, errno);
}
string line;
unsigned int line_no = 0;
while (getline(stub, line)) {
++line_no;
if (line.empty() || line[0] == '#')
continue;
string::size_type space = line.find(' ');
if (space == string::npos) space = line.size();
string type(line, 0, space);
line.erase(0, space + 1);
if (type == "auto") {
resolve_relative_path(line, file);
db.add_database(Database(line));
continue;
}
#ifdef XAPIAN_HAS_CHERT_BACKEND
if (type == "chert") {
resolve_relative_path(line, file);
db.add_database(Chert::open(line));
continue;
}
#endif
#ifdef XAPIAN_HAS_BRASS_BACKEND
if (type == "brass") {
resolve_relative_path(line, file);
db.add_database(Brass::open(line));
continue;
}
#endif
#ifdef XAPIAN_HAS_REMOTE_BACKEND
if (type == "remote") {
string::size_type colon = line.find(':');
if (colon == 0) {
// prog
// FIXME: timeouts
// Is it a security risk?
space = line.find(' ');
string args;
if (space != string::npos) {
args.assign(line, space + 1, string::npos);
line.assign(line, 1, space - 1);
} else {
line.erase(0, 1);
}
db.add_database(Remote::open(line, args));
} else if (colon != string::npos) {
// tcp
// FIXME: timeouts
unsigned int port = atoi(line.c_str() + colon + 1);
line.erase(colon);
db.add_database(Remote::open(line, port));
}
continue;
}
#endif
#ifdef XAPIAN_HAS_INMEMORY_BACKEND
if (type == "inmemory" && line.empty()) {
db.add_database(InMemory::open());
continue;
}
#endif
if (type == "flint") {
throw FeatureUnavailableError("Flint backend no longer supported");
}
// Don't include the line itself - that might help an attacker
// by revealing part of a sensitive file's contents if they can
// arrange for it to be read as a stub database via infelicities in
// an application which uses Xapian. The line number is enough
// information to identify the problem line.
throw DatabaseOpeningError(file + ':' + str(line_no) + ": Bad line");
}
// Allowing a stub database with no databases listed allows things like
// a "search all databases" feature to be implemented by generating a
// stub database file without having to special case there not being any
// databases yet.
//
// 1.0.x throws DatabaseOpeningError here, but with a "Bad line" message
// with the line number just past the end of the file, which is a bit odd.
}
static void
open_stub(WritableDatabase &db, const string &file, int action)
{
// A stub database is a text file with one or more lines of this format:
// <dbtype> <serialised db object>
//
// Lines which start with a "#" character, and lines which have no spaces
// in them, are ignored.
//
// Any paths specified in stub database files which are relative will be
// considered to be relative to the directory containing the stub database.
ifstream stub(file.c_str());
if (!stub) {
string msg = "Couldn't open stub database file: ";
msg += file;
throw Xapian::DatabaseOpeningError(msg, errno);
}
string line;
unsigned int line_no = 0;
while (true) {
if (db.internal.size() > 1) {
throw DatabaseOpeningError(file + ": Can't open a stub database listing multiple databases as a WritableDatabase");
}
if (!getline(stub, line)) break;
++line_no;
if (line.empty() || line[0] == '#')
continue;
string::size_type space = line.find(' ');
if (space == string::npos) space = line.size();
string type(line, 0, space);
line.erase(0, space + 1);
if (type == "auto") {
resolve_relative_path(line, file);
db.add_database(WritableDatabase(line, action));
continue;
}
#ifdef XAPIAN_HAS_CHERT_BACKEND
if (type == "chert") {
resolve_relative_path(line, file);
db.add_database(Chert::open(line, action));
continue;
}
#endif
#ifdef XAPIAN_HAS_BRASS_BACKEND
if (type == "brass") {
resolve_relative_path(line, file);
db.add_database(Brass::open(line, action));
continue;
}
#endif
#ifdef XAPIAN_HAS_REMOTE_BACKEND
if (type == "remote") {
string::size_type colon = line.find(':');
if (colon == 0) {
// prog
// FIXME: timeouts
// Is it a security risk?
space = line.find(' ');
string args;
if (space != string::npos) {
args.assign(line, space + 1, string::npos);
line.assign(line, 1, space - 1);
} else {
line.erase(0, 1);
}
db.add_database(Remote::open_writable(line, args));
} else if (colon != string::npos) {
// tcp
// FIXME: timeouts
unsigned int port = atoi(line.c_str() + colon + 1);
line.erase(colon);
db.add_database(Remote::open_writable(line, port));
}
continue;
}
#endif
#ifdef XAPIAN_HAS_INMEMORY_BACKEND
if (type == "inmemory" && line.empty()) {
db.add_database(InMemory::open());
continue;
}
#endif
if (type == "flint") {
throw FeatureUnavailableError("Flint backend no longer supported");
}
// Don't include the line itself - that might help an attacker
// by revealing part of a sensitive file's contents if they can
// arrange for it to be read as a stub database via infelicities in
// an application which uses Xapian. The line number is enough
// information to identify the problem line.
throw DatabaseOpeningError(file + ':' + str(line_no) + ": Bad line");
}
if (db.internal.empty()) {
throw DatabaseOpeningError(file + ": No databases listed");
}
}
Database
Auto::open_stub(const string &file)
{
LOGCALL_STATIC(API, Database, "Auto::open_stub", file);
Database db;
open_stub(db, file);
RETURN(db);
}
WritableDatabase
Auto::open_stub(const string &file, int action)
{
LOGCALL_STATIC(API, WritableDatabase, "Auto::open_stub", file | action);
WritableDatabase db;
open_stub(db, file, action);
RETURN(db);
}
Database::Database(const string &path)
{
LOGCALL_CTOR(API, "Database", path);
struct stat statbuf;
if (stat(path.c_str(), &statbuf) == -1) {
throw DatabaseOpeningError("Couldn't stat '" + path + "'", errno);
}
if (S_ISREG(statbuf.st_mode)) {
// The path is a file, so assume it is a stub database file.
open_stub(*this, path);
return;
}
if (rare(!S_ISDIR(statbuf.st_mode))) {
throw DatabaseOpeningError("Not a regular file or directory: '" + path + "'");
}
#ifdef XAPIAN_HAS_CHERT_BACKEND
if (file_exists(path + "/iamchert")) {
internal.push_back(new ChertDatabase(path));
return;
}
#endif
#ifdef XAPIAN_HAS_BRASS_BACKEND
if (file_exists(path + "/iambrass")) {
internal.push_back(new BrassDatabase(path));
return;
}
#endif
// Check for "stub directories".
string stub_file = path;
stub_file += "/XAPIANDB";
if (rare(!file_exists(stub_file))) {
if (file_exists(path + "/iamflint")) {
throw FeatureUnavailableError("Flint backend no longer supported");
}
throw DatabaseOpeningError("Couldn't detect type of database");
}
open_stub(*this, stub_file);
}
#if defined XAPIAN_HAS_CHERT_BACKEND || \
defined XAPIAN_HAS_BRASS_BACKEND
#define HAVE_DISK_BACKEND
#endif
WritableDatabase::WritableDatabase(const std::string &path, int action)
: Database()
{
LOGCALL_CTOR(API, "WritableDatabase", path | action);
#ifdef HAVE_DISK_BACKEND
enum {
#ifdef XAPIAN_HAS_CHERT_BACKEND
CHERT,
#endif
#ifdef XAPIAN_HAS_BRASS_BACKEND
BRASS,
#endif
UNSET
} type = UNSET;
#endif
struct stat statbuf;
if (stat(path.c_str(), &statbuf) == -1) {
// ENOENT probably just means that we need to create the directory.
if (errno != ENOENT)
throw DatabaseOpeningError("Couldn't stat '" + path + "'", errno);
} else {
// File or directory already exists.
if (S_ISREG(statbuf.st_mode)) {
// The path is a file, so assume it is a stub database file.
open_stub(*this, path, action);
return;
}
if (rare(!S_ISDIR(statbuf.st_mode))) {
throw DatabaseOpeningError("Not a regular file or directory: '" + path + "'");
}
if (file_exists(path + "/iamchert")) {
// Existing chert DB.
#ifdef XAPIAN_HAS_CHERT_BACKEND
type = CHERT;
#else
throw FeatureUnavailableError("Chert backend disabled");
#endif
} else if (file_exists(path + "/iambrass")) {
// Existing brass DB.
#ifdef XAPIAN_HAS_BRASS_BACKEND
type = BRASS;
#else
throw FeatureUnavailableError("Brass backend disabled");
#endif
} else if (file_exists(path + "/iamflint")) {
// Existing flint DB.
throw FeatureUnavailableError("Flint backend no longer supported");
} else {
// Check for "stub directories".
string stub_file = path;
stub_file += "/XAPIANDB";
if (usual(file_exists(stub_file))) {
open_stub(*this, stub_file, action);
return;
}
}
}
#ifdef HAVE_DISK_BACKEND
switch (type) {
case UNSET: {
#ifdef XAPIAN_HAS_BRASS_BACKEND
// If only brass is enabled, there's no point checking the
// environmental variable.
# if defined XAPIAN_HAS_CHERT_BACKEND
// If $XAPIAN_PREFER_BRASS is set to a non-empty value, prefer brass
// if there's no existing database.
const char *p = getenv("XAPIAN_PREFER_BRASS");
if (p && *p)
goto brass;
#endif
#endif
}
// Fall through to first enabled case, so order the remaining cases
// by preference.
#ifdef XAPIAN_HAS_CHERT_BACKEND
case CHERT:
internal.push_back(new ChertWritableDatabase(path, action, 8192));
break;
#endif
#ifdef XAPIAN_HAS_BRASS_BACKEND
case BRASS:
brass:
internal.push_back(new BrassWritableDatabase(path, action, 8192));
break;
#endif
}
#else
throw FeatureUnavailableError("No disk-based writable backend is enabled");
#endif
}
}