chiark / gitweb /
update CHANGES.html
[disorder] / server / rescan.c
CommitLineData
460b9539 1/*
2 * This file is part of DisOrder
4363757e 3 * Copyright (C) 2005-2008 Richard Kettlewell
460b9539 4 *
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.
9 *
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.
14 *
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
18 * USA
19 */
20
05b75f8d 21#include "disorder-server.h"
460b9539 22
807d2644 23static time_t last_report;
460b9539 24static DB_TXN *global_tid;
25
26static const struct option options[] = {
27 { "help", no_argument, 0, 'h' },
28 { "version", no_argument, 0, 'V' },
29 { "config", required_argument, 0, 'c' },
30 { "debug", no_argument, 0, 'd' },
31 { "no-debug", no_argument, 0, 'D' },
0ca6d097
RK
32 { "syslog", no_argument, 0, 's' },
33 { "no-syslog", no_argument, 0, 'S' },
ffac51d7
RK
34 { "check", no_argument, 0, 'K' },
35 { "no-check", no_argument, 0, 'C' },
460b9539 36 { 0, 0, 0, 0 }
37};
38
39/* display usage message and terminate */
40static void help(void) {
41 xprintf("Usage:\n"
42 " disorder-rescan [OPTIONS] [PATH...]\n"
43 "Options:\n"
44 " --help, -h Display usage message\n"
45 " --version, -V Display version number\n"
46 " --config PATH, -c PATH Set configuration file\n"
47 " --debug, -d Turn on debugging\n"
ffac51d7
RK
48 " --[no-]syslog Enable/disable logging to syslog\n"
49 " --[no-]check Enable/disable track length check\n"
460b9539 50 "\n"
51 "Rescanner for DisOrder. Not intended to be run\n"
52 "directly.\n");
53 xfclose(stdout);
54 exit(0);
55}
56
460b9539 57static volatile sig_atomic_t signalled;
58
59static void signal_handler(int sig) {
60 if(sig == 0) _exit(-1); /* "Cannot happen" */
61 signalled = sig;
62}
63
64static int aborted(void) {
65 return signalled || getppid() == 1;
66}
67
68/* Exit if our parent has gone away or we have been told to stop. */
69static void checkabort(void) {
70 if(getppid() == 1) {
71 info("parent has terminated");
72 trackdb_abort_transaction(global_tid);
73 exit(0);
74 }
75 if(signalled) {
76 info("received signal %d", signalled);
77 trackdb_abort_transaction(global_tid);
78 exit(0);
79 }
80}
81
82/* rescan a collection */
83static void rescan_collection(const struct collection *c) {
84 pid_t pid, r;
85 int p[2], n, w;
86 FILE *fp = 0;
87 char *path, *track;
88 long ntracks = 0, nnew = 0;
89
90 checkabort();
91 info("rescanning %s with %s", c->root, c->module);
92 /* plugin runs in a subprocess */
93 xpipe(p);
94 if(!(pid = xfork())) {
95 exitfn = _exit;
96 xclose(p[0]);
97 xdup2(p[1], 1);
98 xclose(p[1]);
99 scan(c->module, c->root);
100 if(fflush(stdout) < 0)
101 fatal(errno, "error writing to scanner pipe");
102 _exit(0);
103 }
104 xclose(p[1]);
105 if(!(fp = fdopen(p[0], "r")))
106 fatal(errno, "error calling fdopen");
107 /* read tracks from the plugin */
108 while(!inputline("rescanner", fp, &path, 0)) {
109 checkabort();
110 /* actually we can cope relatively well within the server, but they'll go
111 * wrong in track listings */
112 if(strchr(path, '\n')) {
113 error(0, "cannot cope with tracks with newlines in the name");
114 continue;
115 }
116 if(!(track = any2utf8(c->encoding, path))) {
117 error(0, "cannot convert track path to UTF-8: %s", path);
118 continue;
119 }
8818b7fc
RK
120 if(config->dbversion > 1) {
121 /* We use NFC track names */
122 if(!(track = utf8_compose_canon(track, strlen(track), 0))) {
123 error(0, "cannot convert track path to NFC: %s", path);
124 continue;
125 }
f9635e06 126 }
460b9539 127 D(("track %s", track));
128 /* only tracks with a known player are admitted */
129 for(n = 0; (n < config->player.n
130 && fnmatch(config->player.s[n].s[0], track, 0) != 0); ++n)
131 ;
132 if(n < config->player.n) {
133 nnew += !!trackdb_notice(track, path);
134 ++ntracks;
807d2644 135 if(ntracks % 100 == 0 && time(0) > last_report + 10) {
e4ba53fd 136 info("rescanning %s, %ld tracks so far", c->root, ntracks);
807d2644
RK
137 time(&last_report);
138 }
460b9539 139 }
140 }
141 /* tidy up */
142 if(ferror(fp)) {
143 error(errno, "error reading from scanner pipe");
144 goto done;
145 }
146 xfclose(fp);
147 fp = 0;
148 while((r = waitpid(pid, &w, 0)) == -1 && errno == EINTR)
149 ;
150 if(r < 0) fatal(errno, "error calling waitpid");
151 pid = 0;
152 if(w) {
153 error(0, "scanner subprocess: %s", wstat(w));
154 goto done;
155 }
156 info("rescanned %s, %ld tracks, %ld new", c->root, ntracks, nnew);
157done:
158 if(fp)
159 xfclose(fp);
160 if(pid)
161 while((r = waitpid(pid, &w, 0)) == -1 && errno == EINTR)
162 ;
163}
164
165struct recheck_state {
166 const struct collection *c;
d1694464 167 long nobsolete, nnocollection, nlength;
ffac51d7
RK
168 struct recheck_track *tracks;
169};
170
171struct recheck_track {
172 struct recheck_track *next;
173 const char *track;
460b9539 174};
175
176/* called for each non-alias track */
ffac51d7
RK
177static int recheck_list_callback(const char *track,
178 struct kvp attribute((unused)) *data,
bea6f6d5 179 struct kvp attribute((unused)) *prefs,
ffac51d7
RK
180 void *u,
181 DB_TXN attribute((unused)) *tid) {
460b9539 182 struct recheck_state *cs = u;
ffac51d7
RK
183 struct recheck_track *t = xmalloc(sizeof *t);
184
185 t->next = cs->tracks;
186 t->track = track;
187 cs->tracks = t;
188 return 0;
189}
190
191static int recheck_track_tid(struct recheck_state *cs,
192 const struct recheck_track *t,
193 DB_TXN *tid) {
460b9539 194 const struct collection *c = cs->c;
ffac51d7 195 const char *path;
460b9539 196 char buffer[20];
62dc3748
RK
197 int err, n;
198 long length;
ffac51d7 199 struct kvp *data;
460b9539 200
ffac51d7
RK
201 if((err = trackdb_getdata(trackdb_tracksdb, t->track, &data, tid)))
202 return err;
203 path = kvp_get(data, "_path");
204 D(("rechecking %s", t->track));
d1694464 205 /* if we're not checking a specific collection, find the right collection */
206 if(!c) {
ffac51d7
RK
207 if(!(c = find_track_collection(t->track))) {
208 D(("obsoleting %s", t->track));
209 if((err = trackdb_obsolete(t->track, tid)))
210 return err;
d1694464 211 ++cs->nnocollection;
212 return 0;
213 }
214 }
460b9539 215 /* see if the track has evaporated */
216 if(check(c->module, c->root, path) == 0) {
ffac51d7
RK
217 D(("obsoleting %s", t->track));
218 if((err = trackdb_obsolete(t->track, tid)))
219 return err;
460b9539 220 ++cs->nobsolete;
221 return 0;
222 }
223 /* make sure we know the length */
224 if(!kvp_get(data, "_length")) {
ffac51d7 225 D(("recalculating length of %s", t->track));
62dc3748 226 for(n = 0; n < config->tracklength.n; ++n)
ffac51d7 227 if(fnmatch(config->tracklength.s[n].s[0], t->track, 0) == 0)
62dc3748
RK
228 break;
229 if(n >= config->tracklength.n)
ffac51d7 230 error(0, "no tracklength plugin found for %s", t->track);
62dc3748 231 else {
ffac51d7 232 length = tracklength(config->tracklength.s[n].s[1], t->track, path);
62dc3748
RK
233 if(length > 0) {
234 byte_snprintf(buffer, sizeof buffer, "%ld", length);
235 kvp_set(&data, "_length", buffer);
ffac51d7 236 if((err = trackdb_putdata(trackdb_tracksdb, t->track, data, tid, 0)))
62dc3748
RK
237 return err;
238 ++cs->nlength;
239 }
460b9539 240 }
241 }
242 return 0;
243}
244
ffac51d7
RK
245static int recheck_track(struct recheck_state *cs,
246 const struct recheck_track *t) {
247 int e;
248
249 WITH_TRANSACTION(recheck_track_tid(cs, t, tid));
250 return e;
251}
252
460b9539 253/* recheck a collection */
254static void recheck_collection(const struct collection *c) {
255 struct recheck_state cs;
ffac51d7
RK
256 const struct recheck_track *t;
257 long nrc;
460b9539 258
d1694464 259 if(c)
260 info("rechecking %s", c->root);
261 else
262 info("rechecking all tracks");
ffac51d7
RK
263 /* Doing the checking inside a transaction locks up the server for much too
264 * long (because it spends lots of time thinking about each track). So we
265 * pull the full track list into memory and work from that.
266 *
267 * 100,000 tracks at, say, 80 bytes per track name, gives 8MB, which is quite
268 * reasonable.
269 */
460b9539 270 for(;;) {
271 checkabort();
ffac51d7 272 info("getting track list");
460b9539 273 global_tid = trackdb_begin_transaction();
274 memset(&cs, 0, sizeof cs);
275 cs.c = c;
ffac51d7 276 if(trackdb_scan(c ? c->root : 0, recheck_list_callback, &cs, global_tid))
d1694464 277 goto fail;
460b9539 278 break;
279 fail:
280 /* Maybe we need to shut down */
281 checkabort();
282 /* Abort the transaction and try again in a bit. */
283 trackdb_abort_transaction(global_tid);
284 global_tid = 0;
285 /* Let anything else that is going on get out of the way. */
286 sleep(10);
287 checkabort();
d1694464 288 if(c)
289 info("resuming recheck of %s", c->root);
290 else
291 info("resuming global recheck");
460b9539 292 }
293 trackdb_commit_transaction(global_tid);
294 global_tid = 0;
ffac51d7
RK
295 nrc = 0;
296 for(t = cs.tracks; t; t = t->next) {
297 if(aborted())
298 return;
299 recheck_track(&cs, t);
300 ++nrc;
807d2644 301 if(nrc % 100 == 0 && time(0) > last_report + 10) {
ffac51d7
RK
302 if(c)
303 info("rechecking %s, %ld tracks so far", c->root, nrc);
304 else
305 info("rechecking all tracks, %ld tracks so far", nrc);
807d2644 306 time(&last_report);
ffac51d7
RK
307 }
308 }
d1694464 309 if(c)
310 info("rechecked %s, %ld obsoleted, %ld lengths calculated",
311 c->root, cs.nobsolete, cs.nlength);
312 else
313 info("rechecked all tracks, %ld no collection, %ld obsoleted, %ld lengths calculated",
314 cs.nnocollection, cs.nobsolete, cs.nlength);
460b9539 315}
316
317/* rescan/recheck a collection by name */
318static void do_directory(const char *s,
319 void (*fn)(const struct collection *c)) {
320 int n;
321
322 for(n = 0; (n < config->collection.n
323 && strcmp(config->collection.s[n].root, s)); ++n)
324 ;
325 if(n < config->collection.n)
326 fn(&config->collection.s[n]);
327 else
328 error(0, "no collection has root '%s'", s);
329}
330
331/* rescan/recheck all collections */
332static void do_all(void (*fn)(const struct collection *c)) {
333 int n;
334
335 for(n = 0; n < config->collection.n; ++n)
336 fn(&config->collection.s[n]);
6aba3f6c
RK
337 /* TODO: we need to tidy up tracks from collections now removed. We could do
338 * this two ways: either remember collections we think there are and spot
339 * their disappearance, or iterate over all tracks and gc any that don't fit
340 * into some collection.
341 *
342 * Having a way to rename collections would be rather convenient too but
343 * that's another kettle of monkeys.
344 */
460b9539 345}
346
2a10b70b
RK
347/** @brief Expire noticed.db */
348static void expire_noticed(void) {
1e64e9fb
RK
349 time_t now;
350
351 time(&now);
352 trackdb_expire_noticed(now - config->noticed_history * 86400);
2a10b70b
RK
353}
354
460b9539 355int main(int argc, char **argv) {
0ca6d097 356 int n, logsyslog = !isatty(2);
460b9539 357 struct sigaction sa;
ffac51d7 358 int do_check = 1;
460b9539 359
360 set_progname(argv);
320598d4 361 mem_init();
460b9539 362 if(!setlocale(LC_CTYPE, "")) fatal(errno, "error calling setlocale");
ffac51d7 363 while((n = getopt_long(argc, argv, "hVc:dDSsKC", options, 0)) >= 0) {
460b9539 364 switch(n) {
365 case 'h': help();
3fbdc96d 366 case 'V': version("disorder-rescan");
460b9539 367 case 'c': configfile = optarg; break;
368 case 'd': debugging = 1; break;
369 case 'D': debugging = 0; break;
0ca6d097
RK
370 case 'S': logsyslog = 0; break;
371 case 's': logsyslog = 1; break;
ffac51d7
RK
372 case 'K': do_check = 1; break;
373 case 'C': do_check = 0; break;
460b9539 374 default: fatal(0, "invalid option");
375 }
376 }
5464a25a 377 if(logsyslog) {
460b9539 378 openlog(progname, LOG_PID, LOG_DAEMON);
379 log_default = &log_syslog;
380 }
c00fce3a 381 if(config_read(0)) fatal(0, "cannot read configuration");
460b9539 382 xnice(config->nice_rescan);
383 sa.sa_handler = signal_handler;
384 sa.sa_flags = SA_RESTART;
385 sigemptyset(&sa.sa_mask);
386 xsigaction(SIGTERM, &sa, 0);
387 xsigaction(SIGINT, &sa, 0);
388 info("started");
d25c4615
RK
389 trackdb_init(TRACKDB_NO_RECOVER);
390 trackdb_open(TRACKDB_NO_UPGRADE);
460b9539 391 if(optind == argc) {
d1694464 392 /* Rescan all collections */
460b9539 393 do_all(rescan_collection);
d1694464 394 /* Check that every track still exists */
ffac51d7
RK
395 if(do_check)
396 recheck_collection(0);
2a10b70b
RK
397 /* Expire noticed.db */
398 expire_noticed();
460b9539 399 }
400 else {
d1694464 401 /* Rescan specified collections */
460b9539 402 for(n = optind; n < argc; ++n)
403 do_directory(argv[n], rescan_collection);
d1694464 404 /* Check specified collections for tracks that have gone */
ffac51d7
RK
405 if(do_check)
406 for(n = optind; n < argc; ++n)
407 do_directory(argv[n], recheck_collection);
460b9539 408 }
409 trackdb_close();
410 trackdb_deinit();
411 info("completed");
412 return 0;
413}
414
415/*
416Local Variables:
417c-basic-offset:2
418comment-column:40
419fill-column:79
420indent-tabs-mode:nil
421End:
422*/