1 # id3fs - a FUSE-based filesystem for browsing audio metadata
2 # Copyright (C) 2010 Ian Beckwith <ianb@erislabs.net>
4 # This program is free software: you can redistribute it and/or modify
5 # it under the terms of the GNU General Public License as published by
6 # the Free Software Foundation, either version 3 of the License, or
7 # (at your option) any later version.
9 # This program is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 # GNU General Public License for more details.
14 # You should have received a copy of the GNU General Public License
15 # along with this program. If not, see <http://www.gnu.org/licenses/>.
25 our $SCHEMA_VERSION=1;
26 my $dbfile=".id3fs"; # default
31 my $class=ref($proto) || $proto;
36 $self->{verbose}=shift;
39 $self->{dbpath}=shift || ($self->{base} . "/" . $dbfile);
40 $self->{dbpath}=Cwd::abs_path($self->{dbpath});
41 $self->{absbase}=Cwd::abs_path($self->{base});
43 my $connectstr="dbi:SQLite:dbname=$self->{dbpath}";
44 my $exists=-f $self->{dbpath};
45 $self->{dbh}=DBI->connect($connectstr, undef, undef,
47 unless(defined($self->{dbh}))
49 die("$self->{me}: DB Error: " . $DBI::errstr . "\n");
60 $self->enable_foreign_keys();
64 # search parent directories for db
68 shift if(ref($_[0]) eq "ID3FS::DB");
70 my($me, $init, @dirs)=@_;
74 my $path=Cwd::abs_path($dir);
78 $path=~s/(.*)\/.*/$1/;
80 while(! -f "$base/$dbfile" && length($path) && -d $path);
81 if(-f "$base/$dbfile")
86 if(!-f "$base/$dbfile")
90 print "$me: db not found at $base/$dbfile\n";
99 sub base_dir { return shift->{base}; }
104 my @schema=split(/\n\n/,join("", <DATA>));
106 for my $cmd (@schema)
108 $self->{dbh}->do($cmd);
110 $self->cmd("INSERT INTO id3fs (schema_version, last_update) VALUES (?, ?)",
111 $SCHEMA_VERSION, time());
117 my ($version)=$self->cmd_onerow("SELECT schema_version from id3fs");
118 if(!defined($version) || $version != $SCHEMA_VERSION)
120 die("$self->{me}: id3fs database version " .
121 defined($version) ? $version : '""' .
122 "not known, current version is $SCHEMA_VERSION.\n");
129 $self->cmd("ANALYZE");
132 sub enable_foreign_keys
135 $self->cmd("PRAGMA foreign_keys = ON");
140 my($self, $newval)=@_;
143 $self->cmd("UPDATE id3fs SET last_update=?", $newval);
147 ($newval)=$self->cmd_onerow("SELECT last_update from id3fs");
155 my $sql=("SELECT t1.name FROM tags t1\n" .
156 "LEFT JOIN tags t2 on t1.id=t2.parents_id\n" .
157 "WHERE t1.parents_id='' AND t2.id IS NULL\n" .
158 "GROUP BY t1.name\n");
159 my @names=$self->cmd_firstcol($sql);
166 my $sql=("SELECT p.name, t.name FROM tags t\n" .
167 "INNER JOIN tags p ON t.parents_id=p.id\n" .
168 "GROUP BY p.name, t.name\n");
169 my $result=$self->cmd_rows($sql);
171 for my $pair (@$result)
173 push(@{$tags->{$pair->[0]}}, $pair->[1]);
181 my $sql=("SELECT COUNT(*) FROM tags\n\t" .
182 "WHERE tags.parents_id=?\n");
183 my ($rows)=$self->cmd_onerow($sql, $id);
189 my($self, $path, $name, $mountpoint, $querypath)=@_;
190 my $rpath="$self->{absbase}/$path";
191 my $vpath=$mountpoint . $querypath;
192 my @path=split(/\//,$rpath);
193 my @rel=split(/\//,$vpath);
194 # drop filename from rel
196 # absolute paths have empty first element due to leading /
197 shift(@path) if($path[0] eq "");
198 shift(@rel) if($rel[0] eq "");
199 # f: /home/foo/bar/baz.mp3
200 # r: /home/ianb/music/albums
201 while(@path && @rel && ($path[0] eq $rel[0]))
206 my $upcount=scalar(@rel);
207 my $result="../" x $upcount;
208 $result .= join("/",@path);
216 my $relpath=Cwd::abs_path($path);
217 $relpath =~ s/^\Q$self->{absbase}\E\/?//;
218 my($filepart,$pathpart);
226 ($pathpart, $filepart) = ($relpath =~ /(.*)\/(.*)/);
228 my $file=ID3FS::AudioFile->new($path, $self->{me});
229 return unless(defined($file));
230 my $artist=$file->artist();
231 my $album=$file->album();
232 my $v1genre=$file->v1genre();
233 my $year=$file->year();
234 my $audiotype=$file->audiotype();
235 my @tags=$file->tags();
236 my $haspic=$file->haspic();
237 my $channels=$file->channels();
238 my $bitrate=$file->bitrate();
239 my $samplerate=$file->samplerate();
241 $artist=undef unless($self->ok($artist));
242 print "$self->{me}: $path: no artist tag defined\n" unless(defined($artist));
243 my $artist_id=$self->add_to_table("artists", $artist);
244 my $path_id=$self->add_to_table("paths", $pathpart);
245 $album=undef unless($self->ok($album));
246 # if($self->{verbose} && !defined($album)) FIXME
249 print "$self->{me}: $path: no album tag defined\n";
252 my $albums_id=$self->add_to_table("albums", $album);
253 my $file_id=$self->add_to_table("files", $filepart,
254 { "artists_id" => $artist_id,
255 "albums_id" => $albums_id,
256 "paths_id" => $path_id });
261 $self->add_tag($file_id, @$tag);
266 $self->add_tag($file_id, "UNTAGGED");
269 $year="UNKNOWN" if(!$self->ok($year) || $year =~ /^0+$/);
270 $year+=1900 if($year=~/^\d\d$/);
271 $self->add_tag($file_id, "year", $year);
272 if($year=~/^(\d\d\d)\d$/)
274 $self->add_tag($file_id, "decade", "${1}0s");
278 $self->add_tag($file_id, "decade", "UNKNOWN");
281 if($self->ok($v1genre))
283 $self->add_tag($file_id, "v1genre", $v1genre);
288 $self->add_tag($file_id, "haspic", undef);
291 if($self->ok($audiotype))
293 $self->add_tag($file_id, "audiotype", $audiotype);
297 # should never happen
298 $self->add_tag($file_id, "audiotype", "UNKNOWN");
301 if($self->ok($channels))
303 if ($channels eq "2") { $channels="stereo"; }
304 elsif ($channels eq "1") { $channels="mono"; }
305 elsif ($channels eq "0") { $channels="UNKNOWN"; }
306 $self->add_tag($file_id, "channels", $channels);
309 if($self->ok($bitrate))
311 $bitrate="UNKNOWN" if($bitrate=~/^0+$/);
312 $self->add_tag($file_id, "bitrate", $bitrate);
315 if($self->ok($samplerate))
317 $samplerate="UNKNOWN" if($samplerate=~/^0+$/);
318 $self->add_tag($file_id, "samplerate", $samplerate);
325 my($self, $file_id, $tag, $value)=@_;
326 my $tag_id=$self->add_to_table("tags", $tag,
327 { "parents_id" => undef });
328 $self->add_relation("files_x_tags",
329 { "files_id" => $file_id,
330 "tags_id" => $tag_id });
331 if(defined($value) && length($value))
333 my $val_id=$self->add_to_table("tags", $value,
334 { "parents_id" => $tag_id });
335 $self->add_relation("files_x_tags",
336 { "files_id" => $file_id,
337 "tags_id" => $val_id });
343 my($self, $table, $name, $extradata)=@_;
345 if($extradata && $extradata->{parents_id})
347 $parent=$extradata->{parents_id};
349 my $id=$self->lookup_id($table, $name, $parent);
352 my $sql="INSERT INTO $table (";
354 if(defined($extradata))
356 push(@fields, sort keys(%$extradata));
358 $sql .= join(", ", @fields);
360 $sql .= join(", ", map { "?"; } @fields);
362 $id=$self->cmd_id($sql, $name, map { $extradata->{$_} || ""; } sort keys %$extradata);
369 my ($self, $relname, $fields)=@_;
370 return if($self->relation_exists($relname, $fields));
371 my $sql="INSERT INTO $relname (";
372 $sql .= join(", ", sort keys(%$fields));
373 $sql .= ") VALUES (";
374 $sql .= join(", ", map { "?"; } sort keys(%$fields));
376 $self->cmd($sql, map { $fields->{$_}; } sort keys(%$fields));
382 my $sql=("SELECT files.name FROM files\n" .
383 "INNER JOIN paths ON files.paths_id=paths.id\n" .
384 "WHERE paths.name=?\n");
385 return($self->cmd_firstcol($sql, $dir));
390 my($self, $path, $file)=@_;
391 my $sql=("DELETE FROM files WHERE id IN (" .
392 "\tSELECT files.id FROM files\n" .
393 "\tINNER JOIN paths ON paths.id=files.paths_id\n" .
394 "\tWHERE paths.name=? and files.name=? )\n");
395 $self->cmd_rows($sql, $path, $file);
399 sub prune_directories
402 my $sql=("SELECT name, id FROM paths\n");
403 my $pathsref=$self->cmd_rows($sql);
405 for my $pathpair (@$pathsref)
407 my($path, $id)=@$pathpair;
408 my $fullpath="$self->{absbase}/$path";
414 $self->prune_paths(@ids);
422 my $sql=("DELETE FROM files WHERE paths_id IN (\n\t" .
423 join(', ', map { "\"$_\""; } @ids). "\n\t)");
431 DELETE FROM artists WHERE id IN (
432 SELECT artists.id FROM artists
433 LEFT JOIN files ON files.artists_id=artists.id
434 WHERE files.id IS NULL);
436 DELETE FROM albums WHERE id IN (
437 SELECT albums.id FROM albums
438 LEFT JOIN files ON files.albums_id=albums.id
439 WHERE files.id IS NULL);
441 DELETE FROM paths WHERE id IN (
442 SELECT paths.id FROM paths
443 LEFT JOIN files ON files.paths_id=paths.id
444 WHERE files.id IS NULL);
446 DELETE FROM files_x_tags WHERE files_id IN (
447 SELECT files_x_tags.files_id FROM files_x_tags
448 LEFT JOIN files ON files.id=files_x_tags.files_id
449 WHERE files.id IS NULL);
451 DELETE FROM tags WHERE id IN (
452 SELECT tags.id FROM tags
453 LEFT JOIN files_x_tags ON files_x_tags.tags_id=tags.id
454 WHERE files_x_tags.files_id IS NULL);
458 # print "SQL: $sql\n";
459 my @sql=split(/\n\n/, $sql);
460 $self->cmd($_) for (@sql);
465 my ($self, $relname, $fields)=@_;
466 my $sql="SELECT count(1) FROM $relname WHERE ";
469 for my $field (keys %$fields)
472 push(@vals,$fields->{$field});
474 $sql .= join(' AND ', map { "$_=?"; } @exprs);
475 my ($ret)=$self->cmd_onerow($sql, @vals);
481 my($self, $thing)=@_;
482 return(defined($thing) && length($thing) && $thing =~ /\S+/);
485 # actually call the database
488 my($self, $sql, @params)=@_;
489 my $sth=$self->{dbh}->prepare($sql);
491 for my $param (@params)
493 $param="" unless(defined($param));
494 $sth->bind_param($idx++, $param);
500 # pass cmd to db, ignore response
503 my ($self, @args)=@_;
504 # don't care about retcode
505 $self->cmd_sth(@args);
511 my ($self, @args)=@_;
512 my $sth=$self->cmd_sth(@args);
513 return($sth->fetchrow_array());
519 my ($self, @args)=@_;
520 my $sth=$self->cmd_sth(@args);
521 return $sth->fetchall_arrayref();
524 # returns just the first column
527 my ($self, @args)=@_;
528 return(map { $_->[0] } @{$self->cmd_rows(@args)});
531 # runs cmd, returns id of last insert
534 my ($self, @args)=@_;
535 $self->cmd_sth(@args);
536 return($self->last_insert_id());
542 return $self->{dbh}->last_insert_id("","","","");
545 # lookup id of $name in $table, also matching on $parent if needed
548 my($self, $table, $name, $parent)=@_;
549 my $sql="SELECT id FROM $table where name=?";
553 $sql .= " AND parents_id=?";
554 push(@args, $parent);
556 my($id)=$self->cmd_onerow($sql, @args);
563 schema_version INTEGER,
573 CREATE TABLE artists (
579 CREATE TABLE albums (
592 FOREIGN KEY(artists_id) REFERENCES artists(id) ON DELETE CASCADE ON UPDATE CASCADE,
593 FOREIGN KEY(albums_id) REFERENCES albums(id) ON DELETE CASCADE ON UPDATE CASCADE,
594 FOREIGN KEY(paths_id) REFERENCES paths(id) ON DELETE CASCADE ON UPDATE CASCADE
604 CREATE TABLE files_x_tags (
607 FOREIGN KEY(files_id) REFERENCES files(id) ON DELETE CASCADE ON UPDATE CASCADE,
608 FOREIGN KEY(tags_id) REFERENCES tags(id) ON DELETE CASCADE ON UPDATE CASCADE
611 CREATE INDEX idx_fxt_both ON files_x_tags (files_id, tags_id)
613 CREATE INDEX idx_fxt_tags ON files_x_tags (tags_id)
615 CREATE INDEX idx_files_id_name ON files (id, name)
617 CREATE INDEX idx_files_name_id ON files (name, id)
619 CREATE INDEX idx_tags_id_parent_name ON tags (id, parents_id, name)
621 CREATE INDEX idx_tags_parent_id_name ON tags (parents_id, id, name)
623 CREATE INDEX idx_tags_name ON tags (name)