2 * This file is part of DisOrder.
3 * Copyright (C) 2004, 2005, 2007, 2008 Richard Kettlewell
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 /** @file server/dump.c
19 * @brief Dump and restore database contents
21 #include "disorder-server.h"
23 static const struct option options[] = {
24 { "help", no_argument, 0, 'h' },
25 { "version", no_argument, 0, 'V' },
26 { "config", required_argument, 0, 'c' },
27 { "dump", no_argument, 0, 'd' },
28 { "undump", no_argument, 0, 'u' },
29 { "debug", no_argument, 0, 'D' },
30 { "recover", no_argument, 0, 'r' },
31 { "recover-fatal", no_argument, 0, 'R' },
32 { "recompute-aliases", no_argument, 0, 'a' },
33 { "remove-pathless", no_argument, 0, 'P' },
37 /* display usage message and terminate */
38 static void help(void) {
40 " disorder-dump [OPTIONS] --dump|--undump PATH\n"
41 " disorder-dump [OPTIONS] --recompute-aliases\n"
43 " --help, -h Display usage message\n"
44 " --version, -V Display version number\n"
45 " --config PATH, -c PATH Set configuration file\n"
46 " --dump, -d Dump state to PATH\n"
47 " --undump, -u Restore state from PATH\n"
48 " --recover, -r Run database recovery\n"
49 " --recompute-aliases, -a Recompute aliases\n"
50 " --remove-pathless, -P Remove pathless tracks\n"
51 " --debug Debug mode\n");
56 /** @brief Dump one record
57 * @param s Output stream
58 * @param tag Tag for error messages
59 * @param letter Prefix leter for dumped record
60 * @param dbname Database name
61 * @param db Database handle
62 * @param tid Transaction handle
63 * @return 0 or @c DB_LOCK_DEADLOCK
65 static int dump_one(struct sink *s,
75 /* dump the preferences */
76 cursor = trackdb_opencursor(db, tid);
77 err = cursor->c_get(cursor, prepare_data(&k), prepare_data(&d),
80 if(sink_writec(s, letter) < 0
81 || urlencode(s, k.data, k.size)
82 || sink_writec(s, '\n') < 0
83 || urlencode(s, d.data, d.size)
84 || sink_writec(s, '\n') < 0)
85 disorder_fatal(errno, "error writing to %s", tag);
86 err = cursor->c_get(cursor, prepare_data(&k), prepare_data(&d),
90 case DB_LOCK_DEADLOCK:
91 trackdb_closecursor(cursor);
94 return trackdb_closecursor(cursor);
96 assert(!"cannot happen");
98 disorder_fatal(0, "error reading %s: %s", dbname, db_strerror(err));
107 { 'P', "prefs.db", &trackdb_prefsdb },
108 { 'G', "global.db", &trackdb_globaldb },
109 { 'U', "users.db", &trackdb_usersdb },
110 { 'W', "schedule.db", &trackdb_scheduledb },
111 { 'L', "playlists.db", &trackdb_playlistsdb },
112 /* avoid 'T' and 'S' for now */
114 #define NDBTABLE (sizeof dbtable / sizeof *dbtable)
116 /* dump prefs to FP, return nonzero on error */
117 static void do_dump(FILE *fp, const char *tag) {
119 struct sink *s = sink_stdio(tag, fp);
122 tid = trackdb_begin_transaction();
123 if(fseek(fp, 0, SEEK_SET) < 0)
124 disorder_fatal(errno, "error calling fseek");
126 disorder_fatal(errno, "error calling fflush");
127 if(ftruncate(fileno(fp), 0) < 0)
128 disorder_fatal(errno, "error calling ftruncate");
129 if(fprintf(fp, "V0") < 0)
130 disorder_fatal(errno, "error writing to %s", tag);
131 for(size_t n = 0; n < NDBTABLE; ++n)
133 dbtable[n].letter, dbtable[n].dbname, *dbtable[n].db,
137 if(fputs("E\n", fp) < 0)
138 disorder_fatal(errno, "error writing to %s", tag);
141 disorder_info("aborting transaction and retrying dump");
142 trackdb_abort_transaction(tid);
144 trackdb_commit_transaction(tid);
145 if(fflush(fp) < 0) disorder_fatal(errno, "error writing to %s", tag);
146 /* caller might not be paranoid so we are paranoid on their behalf */
147 if(fsync(fileno(fp)) < 0) disorder_fatal(errno, "error syncing %s", tag);
150 /* delete all aliases prefs, return 0 or DB_LOCK_DEADLOCK */
151 static int remove_aliases(DB_TXN *tid, int remove_pathless) {
158 disorder_info("removing aliases");
159 cursor = trackdb_opencursor(trackdb_tracksdb, tid);
160 if((err = cursor->c_get(cursor, prepare_data(&k), prepare_data(&d),
161 DB_FIRST)) == DB_LOCK_DEADLOCK) {
162 disorder_error(0, "cursor->c_get: %s", db_strerror(err));
166 data = kvp_urldecode(d.data, d.size);
167 alias = !!kvp_get(data, "_alias_for");
168 pathless = !kvp_get(data, "_path");
169 if(pathless && !remove_pathless)
170 disorder_info("no _path for %s", utf82mb(xstrndup(k.data, k.size)));
171 if(alias || (remove_pathless && pathless)) {
172 switch(err = cursor->c_del(cursor, 0)) {
174 case DB_LOCK_DEADLOCK:
175 disorder_error(0, "cursor->c_get: %s", db_strerror(err));
178 disorder_fatal(0, "cursor->c_del: %s", db_strerror(err));
181 err = cursor->c_get(cursor, prepare_data(&k), prepare_data(&d), DB_NEXT);
183 if(err == DB_LOCK_DEADLOCK) {
184 disorder_error(0, "cursor operation: %s", db_strerror(err));
187 if(err != DB_NOTFOUND)
188 disorder_fatal(0, "cursor->c_get: %s", db_strerror(err));
191 if(trackdb_closecursor(cursor) && !err) err = DB_LOCK_DEADLOCK;
195 /* truncate (i.e. empty) a database, return 0 or DB_LOCK_DEADLOCK */
196 static int truncdb(DB_TXN *tid, DB *db) {
200 switch(err = db->truncate(db, tid, &count, 0)) {
202 case DB_LOCK_DEADLOCK:
203 disorder_error(0, "db->truncate: %s", db_strerror(err));
206 disorder_fatal(0, "db->truncate: %s", db_strerror(err));
211 /* read a DBT from FP, return 0 on success or -1 on input error */
212 static int undump_dbt(FILE *fp, const char *tag, DBT *dbt) {
216 if(inputline(tag, fp, &s, '\n')) return -1;
218 if(urldecode(sink_dynstr(&d), s, strlen(s)))
219 disorder_fatal(0, "invalid URL-encoded data in %s", tag);
225 /* undump from FP, return 0 or DB_LOCK_DEADLOCK */
226 static int undump_from_fp(DB_TXN *tid, FILE *fp, const char *tag) {
229 disorder_info("undumping");
230 if(fseek(fp, 0, SEEK_SET) < 0)
231 disorder_fatal(errno, "error calling fseek on %s", tag);
232 if((err = truncdb(tid, trackdb_prefsdb))) return err;
233 if((err = truncdb(tid, trackdb_globaldb))) return err;
234 if((err = truncdb(tid, trackdb_searchdb))) return err;
235 if((err = truncdb(tid, trackdb_tagsdb))) return err;
236 if((err = truncdb(tid, trackdb_usersdb))) return err;
237 if((err = truncdb(tid, trackdb_scheduledb))) return err;
239 while(!ferror(fp) && !feof(fp)) {
240 for(size_t n = 0; n < NDBTABLE; ++n) {
241 if(dbtable[n].letter == c) {
242 DB *db = *dbtable[n].db;
243 const char *dbname = dbtable[n].dbname;
246 if(undump_dbt(fp, tag, prepare_data(&k))
247 || undump_dbt(fp, tag, prepare_data(&d)))
249 switch(err = db->put(db, tid, &k, &d, 0)) {
252 case DB_LOCK_DEADLOCK:
253 disorder_error(0, "error updating %s: %s", dbname, db_strerror(err));
256 disorder_fatal(0, "error updating %s: %s", dbname, db_strerror(err));
266 disorder_fatal(0, "unknown version '%c'", c);
273 if(c >= 32 && c <= 126)
274 disorder_fatal(0, "unexpected character '%c'", c);
276 disorder_fatal(0, "unexpected character 0x%02X", c);
282 disorder_fatal(errno, "error reading %s", tag);
284 disorder_fatal(0, "unexpected EOF reading %s", tag);
288 /* recompute aliases and search database from prefs, return 0 or
289 * DB_LOCK_DEADLOCK */
290 static int recompute_aliases(DB_TXN *tid) {
295 const char *path, *track;
297 disorder_info("recomputing aliases");
298 cursor = trackdb_opencursor(trackdb_tracksdb, tid);
299 if((err = cursor->c_get(cursor, prepare_data(&k), prepare_data(&d),
300 DB_FIRST)) == DB_LOCK_DEADLOCK) goto done;
302 data = kvp_urldecode(d.data, d.size);
303 track = xstrndup(k.data, k.size);
304 if(!kvp_get(data, "_alias_for")) {
305 if(!(path = kvp_get(data, "_path")))
306 disorder_error(0, "%s is not an alias but has no path", utf82mb(track));
308 if((err = trackdb_notice_tid(track, path, tid)) == DB_LOCK_DEADLOCK)
311 err = cursor->c_get(cursor, prepare_data(&k), prepare_data(&d),
320 case DB_LOCK_DEADLOCK:
323 disorder_fatal(0, "cursor->c_get: %s", db_strerror(err));
326 if(trackdb_closecursor(cursor) && !err) err = DB_LOCK_DEADLOCK;
330 /* restore prefs from FP */
331 static void do_undump(FILE *fp, const char *tag, int remove_pathless) {
335 tid = trackdb_begin_transaction();
336 if(remove_aliases(tid, remove_pathless)
337 || undump_from_fp(tid, fp, tag)
338 || recompute_aliases(tid)) goto fail;
341 disorder_info("aborting transaction and retrying undump");
342 trackdb_abort_transaction(tid);
344 disorder_info("committing undump");
345 trackdb_commit_transaction(tid);
348 /* just recompute alisaes */
349 static void do_recompute(int remove_pathless) {
353 tid = trackdb_begin_transaction();
354 if(remove_aliases(tid, remove_pathless)
355 || recompute_aliases(tid)) goto fail;
358 disorder_info("aborting transaction and retrying recomputation");
359 trackdb_abort_transaction(tid);
361 disorder_info("committing recomputed aliases");
362 trackdb_commit_transaction(tid);
365 int main(int argc, char **argv) {
366 int n, dump = 0, undump = 0, recover = TRACKDB_NO_RECOVER, recompute = 0;
367 int remove_pathless = 0, fd;
373 while((n = getopt_long(argc, argv, "hVc:dDurRaP", options, 0)) >= 0) {
376 case 'V': version("disorder-dump");
377 case 'c': configfile = optarg; break;
378 case 'd': dump = 1; break;
379 case 'u': undump = 1; break;
380 case 'D': debugging = 1; break;
381 case 'r': recover = TRACKDB_NORMAL_RECOVER;
382 case 'R': recover = TRACKDB_FATAL_RECOVER;
383 case 'a': recompute = 1; break;
384 case 'P': remove_pathless = 1; break;
385 default: disorder_fatal(0, "invalid option");
388 if(dump + undump + recompute != 1)
389 disorder_fatal(0, "choose exactly one of --dump, --undump or --recompute-aliases");
392 disorder_fatal(0, "--recompute-aliases does not take a filename");
396 disorder_fatal(0, "missing dump file name");
397 if(optind + 1 < argc)
398 disorder_fatal(0, "specify only a dump file name");
401 if(config_read(0, NULL))
402 disorder_fatal(0, "cannot read configuration");
403 trackdb_init(recover|TRACKDB_MAY_CREATE);
404 trackdb_open(TRACKDB_NO_UPGRADE);
406 /* We write to a temporary file and rename into place. We make
407 * sure the permissions are tight from the start. */
408 byte_xasprintf(&tmp, "%s.%lx.tmp", path, (unsigned long)getpid());
409 if((fd = open(tmp, O_CREAT|O_TRUNC|O_WRONLY, 0600)) < 0)
410 disorder_fatal(errno, "error opening %s", tmp);
411 if(!(fp = fdopen(fd, "w")))
412 disorder_fatal(errno, "fdopen on %s", tmp);
414 if(fclose(fp) < 0) disorder_fatal(errno, "error closing %s", tmp);
415 if(rename(tmp, path) < 0)
416 disorder_fatal(errno, "error renaming %s to %s", tmp, path);
418 /* the databases or logfiles might end up with wrong permissions
419 * if new ones are created */
421 disorder_info("you might need to chown database files");
422 if(!(fp = fopen(path, "r")))
423 disorder_fatal(errno, "error opening %s", path);
424 do_undump(fp, path, remove_pathless);
426 } else if(recompute) {
427 do_recompute(remove_pathless);
430 trackdb_deinit(NULL);