2 * This file is part of DisOrder
3 * Copyright (C) 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 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * 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, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
20 #include "disorder-server.h"
22 static DB_TXN
*global_tid
;
26 #define BADKEY_DELETE 2
28 /** @brief Bad key behavior */
29 static int badkey
= BADKEY_WARN
;
31 static long aliases_removed
, keys_normalized
, values_normalized
, renoticed
;
32 static long keys_already_ok
, values_already_ok
;
34 static const struct option options
[] = {
35 { "help", no_argument
, 0, 'h' },
36 { "version", no_argument
, 0, 'V' },
37 { "config", required_argument
, 0, 'c' },
38 { "debug", no_argument
, 0, 'd' },
39 { "no-debug", no_argument
, 0, 'D' },
40 { "delete-bad-keys", no_argument
, 0, 'x' },
41 { "fail-bad-keys", no_argument
, 0, 'X' },
42 { "syslog", no_argument
, 0, 's' },
43 { "no-syslog", no_argument
, 0, 'S' },
47 /* display usage message and terminate */
48 static void help(void) {
50 " disorder-dbupgrade [OPTIONS]\n"
52 " --help, -h Display usage message\n"
53 " --version, -V Display version number\n"
54 " --config PATH, -c PATH Set configuration file\n"
55 " --debug, -d Turn on debugging\n"
56 " --[no-]syslog Force logging\n"
57 " --delete-bad-keys, -x Delete unconvertible keys\n"
58 " --fail-bad-keys, -X Fail if bad keys are found\n"
60 "Database upgrader for DisOrder. Not intended to be run\n"
66 /** @brief Visit each key in a database and call @p callback
67 * @return 0 or DB_LOCK_DEADLOCK
69 * @p global_tid must be set. @p callback should return 0 or DB_LOCK_DEADLOCK.
71 static int scan_core(const char *name
, DB
*db
,
72 int (*callback
)(const char *name
, DB
*db
, DBC
*c
,
75 DBC
*c
= trackdb_opencursor(db
, global_tid
);
79 values_normalized
= 0;
84 values_already_ok
= 0;
85 memset(k
, 0, sizeof k
);
86 memset(d
, 0, sizeof d
);
87 while((err
= c
->c_get(c
, k
, d
, DB_NEXT
)) == 0) {
88 if((err
= callback(name
, db
, c
, k
, d
)))
92 info("scanning %s, %ld so far", name
, count
);
94 if(err
&& err
!= DB_NOTFOUND
&& err
!= DB_LOCK_DEADLOCK
)
95 fatal(0, "%s: error scanning database: %s", name
, db_strerror(err
));
96 r
= (err
== DB_LOCK_DEADLOCK ? err
: 0);
97 if((err
= c
->c_close(c
)))
98 fatal(0, "%s: error closing cursor: %s", name
, db_strerror(err
));
99 info("%s: %ld entries scanned", name
, count
);
100 if(values_normalized
|| values_already_ok
)
101 info("%s: %ld values converted, %ld already ok", name
,
102 values_normalized
, values_already_ok
);
103 if(keys_normalized
|| keys_already_ok
)
104 info("%s: %ld keys converted, %ld already OK", name
,
105 keys_normalized
, keys_already_ok
);
107 info("%s: %ld aliases removed", name
, aliases_removed
);
109 info("%s: %ld tracks re-noticed", name
, renoticed
);
113 /** @brief Visit each key in a database and call @p callback
115 * Everything happens inside the @p global_tid tranasction. @p callback
116 * should return 0 or DB_LOCK_DEADLOCK.
118 static void scandb(const char *name
, DB
*db
,
119 int (*callback
)(const char *name
, DB
*db
, DBC
*c
,
121 info("scanning %s", name
);
123 global_tid
= trackdb_begin_transaction();
124 if(scan_core(name
, db
, callback
)) {
125 trackdb_abort_transaction(global_tid
);
127 error(0, "detected deadlock, restarting scan");
130 trackdb_commit_transaction(global_tid
);
137 /** @brief Truncate database @p db */
138 static void truncate_database(const char *name
, DB
*db
) {
143 err
= db
->truncate(db
, 0, &count
, DB_AUTO_COMMIT
);
144 } while(err
== DB_LOCK_DEADLOCK
);
146 fatal(0, "error truncating %s: %s", name
, db_strerror(err
));
151 static int normalize_keys(const char *name
, DB
*db
, DBC
*c
,
157 /* Find the normalized form of the key */
158 knfc
= utf8_compose_canon(k
->data
, k
->size
, &nknfc
);
162 error(0, "%s: invalid key: %.*s", name
,
163 (int)k
->size
, (const char *)k
->data
);
166 error(0, "%s: deleting invalid key: %.*s", name
,
167 (int)k
->size
, (const char *)k
->data
);
168 if((err
= c
->c_del(c
, 0))) {
169 if(err
!= DB_LOCK_DEADLOCK
)
170 fatal(0, "%s: error removing denormalized key: %s",
171 name
, db_strerror(err
));
176 fatal(0, "%s: invalid key: %.*s", name
,
177 (int)k
->size
, (const char *)k
->data
);
181 /* If the key is already in NFC then do nothing */
182 if(nknfc
== k
->size
&& !memcmp(k
->data
, knfc
, nknfc
)) {
186 /* To rename the key we must delete the old one and insert a new one */
187 if((err
= c
->c_del(c
, 0))) {
188 if(err
!= DB_LOCK_DEADLOCK
)
189 fatal(0, "%s: error removing denormalized key: %s",
190 name
, db_strerror(err
));
195 if((err
= db
->put(db
, global_tid
, k
, d
, DB_NOOVERWRITE
))) {
196 if(err
!= DB_LOCK_DEADLOCK
)
197 fatal(0, "%s: error storing normalized key: %s", name
, db_strerror(err
));
204 static int normalize_values(const char *name
, DB
*db
,
205 DBC
attribute((unused
)) *c
,
211 /* Find the normalized form of the value */
212 dnfc
= utf8_compose_canon(d
->data
, d
->size
, &ndnfc
);
214 fatal(0, "%s: cannot convert data to NFC: %.*s", name
,
215 (int)d
->size
, (const char *)d
->data
);
216 /* If the key is already in NFC then do nothing */
217 if(ndnfc
== d
->size
&& !memcmp(d
->data
, dnfc
, ndnfc
)) {
223 if((err
= db
->put(db
, global_tid
, k
, d
, 0))) {
224 if(err
!= DB_LOCK_DEADLOCK
)
225 fatal(0, "%s: error storing normalized data: %s", name
, db_strerror(err
));
232 static int renotice(const char *name
, DB
attribute((unused
)) *db
,
233 DBC
attribute((unused
)) *c
,
235 const struct kvp
*const t
= kvp_urldecode(d
->data
, d
->size
);
236 const char *const track
= xstrndup(k
->data
, k
->size
);
237 const char *const path
= kvp_get(t
, "_path");
241 /* If an alias sorts later than the actual filename then it'll appear
243 if(kvp_get(t
, "_alias_for"))
245 fatal(0, "%s: no '_path' for %.*s", name
,
246 (int)k
->size
, (const char *)k
->data
);
248 switch(err
= trackdb_notice_tid(track
, path
, global_tid
)) {
252 case DB_LOCK_DEADLOCK
:
255 fatal(0, "%s: unexpected return from trackdb_notice_tid: %s",
256 name
, db_strerror(err
));
260 static int remove_aliases_normalize_keys(const char *name
, DB
*db
, DBC
*c
,
262 const struct kvp
*const t
= kvp_urldecode(d
->data
, d
->size
);
265 if(kvp_get(t
, "_alias_for")) {
266 /* This is an alias. We remove all the alias entries. */
267 if((err
= c
->c_del(c
, 0))) {
268 if(err
!= DB_LOCK_DEADLOCK
)
269 fatal(0, "%s: error removing alias: %s", name
, db_strerror(err
));
274 } else if(!kvp_get(t
, "_path"))
275 error(0, "%s: %.*s has neither _alias_for nor _path", name
,
276 (int)k
->size
, (const char *)k
->data
);
277 return normalize_keys(name
, db
, c
, k
, d
);
280 /** @brief Upgrade the database to the current version
282 * This function is supposed to be idempotent, so if it is interrupted
283 * half way through it is safe to restart.
285 static void upgrade(void) {
288 info("upgrading database to dbversion %ld", config
->dbversion
);
289 /* Normalize keys and values as required. We will also remove aliases as
290 * they will be regenerated when we re-noticed the tracks. */
291 info("renormalizing keys");
292 scandb("tracks.db", trackdb_tracksdb
, remove_aliases_normalize_keys
);
293 scandb("prefs.db", trackdb_prefsdb
, normalize_keys
);
294 scandb("global.db", trackdb_globaldb
, normalize_keys
);
295 scandb("noticed.db", trackdb_noticeddb
, normalize_values
);
296 /* search.db and tags.db we will rebuild */
297 info("regenerating search database and aliases");
298 truncate_database("search.db", trackdb_searchdb
);
299 truncate_database("tags.db", trackdb_tagsdb
);
300 /* Regenerate the search database and aliases */
301 scandb("tracks.db", trackdb_tracksdb
, renotice
);
302 /* Finally update the database version */
303 snprintf(buf
, sizeof buf
, "%ld", config
->dbversion
);
304 trackdb_set_global("_dbversion", buf
, 0);
305 info("completed database upgrade");
308 int main(int argc
, char **argv
) {
309 int n
, logsyslog
= !isatty(2);
313 if(!setlocale(LC_CTYPE
, "")) fatal(errno
, "error calling setlocale");
314 while((n
= getopt_long(argc
, argv
, "hVc:dDSsxX", options
, 0)) >= 0) {
317 case 'V': version("disorder-dbupgrade");
318 case 'c': configfile
= optarg
; break;
319 case 'd': debugging
= 1; break;
320 case 'D': debugging
= 0; break;
321 case 'S': logsyslog
= 0; break;
322 case 's': logsyslog
= 1; break;
323 case 'x': badkey
= BADKEY_DELETE
; break;
324 case 'X': badkey
= BADKEY_FAIL
; break;
325 default: fatal(0, "invalid option");
328 /* If stderr is a TTY then log there, otherwise to syslog. */
330 openlog(progname
, LOG_PID
, LOG_DAEMON
);
331 log_default
= &log_syslog
;
333 if(config_read(0)) fatal(0, "cannot read configuration");
334 /* Open the database */
335 trackdb_init(TRACKDB_NO_RECOVER
);
336 trackdb_open(TRACKDB_OPEN_FOR_UPGRADE
);