+# id3fs - a FUSE-based filesystem for browsing audio metadata
+# Copyright (C) 2010 Ian Beckwith <ianb@erislabs.net>
+#
+# 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 3 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, see <http://www.gnu.org/licenses/>.
+
package ID3FS::DB;
use strict;
use warnings;
use DBI;
+use ID3FS::AudioFile;
+use Cwd;
our $SCHEMA_VERSION=1;
-
-my $dbfile=".id3fs";
+my $dbfile=".id3fs"; # default
sub new
{
my $self={};
bless($self,$class);
- my($dir, $init, $me)=@_;
- $self->{dbpath}="$dir/$dbfile";
- $self->{me}=$me;
+ $self->{me}=shift;
+ $self->{verbose}=shift;
+ my $init=shift;
+ $self->{base}=shift;
+ $self->{dbpath}=shift || ($self->{base} . "/" . $dbfile);
+ $self->{dbpath}=Cwd::abs_path($self->{dbpath});
+ $self->{absbase}=Cwd::abs_path($self->{base});
+ my $connectstr="dbi:SQLite:dbname=$self->{dbpath}";
my $exists=-f $self->{dbpath};
- die("$me: $self->{dbpath}: not found. use --init to create.\n") if(!$exists && !$init);
- die("$me: --init used but $self->{dbpath} exists.\n") if($exists && $init);
-
- $self->{dbh}=DBI->connect("dbi:SQLite:dbname=$self->{dbpath}","","",
+ $self->{dbh}=DBI->connect($connectstr, undef, undef,
{ AutoCommit=>1 } );
unless(defined($self->{dbh}))
{
- die("$me: DB Error: " . $DBI::errstr . "\n");
+ die("$self->{me}: DB Error: " . $DBI::errstr . "\n");
}
- if($init)
+ if($exists)
{
- $self->create();
+ $self->checkschema();
}
else
{
- $self->checkschema();
+ $self->create();
}
-
+ $self->enable_foreign_keys();
return $self;
}
+# search parent directories for db
+sub find_db
+{
+ # class method
+ shift if(ref($_[0]) eq "ID3FS::DB");
+
+ my($me, $init, @dirs)=@_;
+ my $base=undef;
+ for my $dir (@dirs)
+ {
+ my $path=Cwd::abs_path($dir);
+ do
+ {
+ $base=$path;
+ $path=~s/(.*)\/.*/$1/;
+ }
+ while(! -f "$base/$dbfile" && length($path) && -d $path);
+ if(-f "$base/$dbfile")
+ {
+ return $base;
+ }
+ }
+ if(!-f "$base/$dbfile")
+ {
+ unless($init)
+ {
+ print "$me: db not found at $base/$dbfile\n";
+ return undef;
+ }
+ $base=$dirs[0];
+
+ }
+ return $base;
+}
+
+sub base_dir { return shift->{base}; }
+
sub create
{
my($self,$name)=@_;
{
$self->{dbh}->do($cmd);
}
- $self->cmd("INSERT INTO id3fs (schema_version) VALUES (?)", $SCHEMA_VERSION);
+ $self->cmd("INSERT INTO id3fs (schema_version, last_update) VALUES (?, ?)",
+ $SCHEMA_VERSION, time());
}
sub checkschema
}
}
+sub analyze
+{
+ my $self=shift;
+ $self->cmd("ANALYZE");
+}
+
+sub enable_foreign_keys
+{
+ my $self=shift;
+ $self->cmd("PRAGMA foreign_keys = ON");
+}
+
+sub last_update
+{
+ my($self, $newval)=@_;
+ if(defined($newval))
+ {
+ $self->cmd("UPDATE id3fs SET last_update=?", $newval);
+ }
+ else
+ {
+ ($newval)=$self->cmd_onerow("SELECT last_update from id3fs");
+ }
+ return $newval;
+}
+
+sub bare_tags
+{
+ my($self)=@_;
+ my $sql=("SELECT t1.name FROM tags t1\n" .
+ "LEFT JOIN tags t2 on t1.id=t2.parents_id\n" .
+ "WHERE t1.parents_id='' AND t2.id IS NULL\n" .
+ "GROUP BY t1.name\n");
+ my @names=$self->cmd_firstcol($sql);
+ return (@names);
+}
+
+sub tags_with_values
+{
+ my($self)=@_;
+ my $sql=("SELECT p.name, t.name FROM tags t\n" .
+ "INNER JOIN tags p ON t.parents_id=p.id\n" .
+ "GROUP BY p.name, t.name\n");
+ my $result=$self->cmd_rows($sql);
+ my $tags={};
+ for my $pair (@$result)
+ {
+ push(@{$tags->{$pair->[0]}}, $pair->[1]);
+ }
+ return $tags;
+}
+
+sub tag_has_values
+{
+ my($self, $id)=@_;
+ my $sql=("SELECT COUNT(*) FROM tags\n\t" .
+ "WHERE tags.parents_id=?\n");
+ my ($rows)=$self->cmd_onerow($sql, $id);
+ return $rows;
+}
+
+sub relativise
+{
+ my($self, $path, $name, $mountpoint, $querypath)=@_;
+ my $rpath="$self->{absbase}/$path";
+ my $vpath=$mountpoint . $querypath;
+ my @path=split(/\//,$rpath);
+ my @rel=split(/\//,$vpath);
+ # drop filename from rel
+ pop @rel;
+ # absolute paths have empty first element due to leading /
+ shift(@path) if($path[0] eq "");
+ shift(@rel) if($rel[0] eq "");
+ # f: /home/foo/bar/baz.mp3
+ # r: /home/ianb/music/albums
+ while(@path && @rel && ($path[0] eq $rel[0]))
+ {
+ shift(@path);
+ shift(@rel);
+ }
+ my $upcount=scalar(@rel);
+ my $result="../" x $upcount;
+ $result .= join("/",@path);
+ $result .= "/$name";
+ return $result;
+}
+
+sub add
+{
+ my($self,$path)=@_;
+ my $relpath=Cwd::abs_path($path);
+ $relpath =~ s/^\Q$self->{absbase}\E\/?//;
+ my($filepart,$pathpart);
+ if($relpath !~ /\//)
+ {
+ $pathpart='';
+ $filepart=$relpath;
+ }
+ else
+ {
+ ($pathpart, $filepart) = ($relpath =~ /(.*)\/(.*)/);
+ }
+ my $file=ID3FS::AudioFile->new($path, $self->{me});
+ return unless(defined($file));
+ my $artist=$file->artist();
+ my $album=$file->album();
+ my $v1genre=$file->v1genre();
+ my $year=$file->year();
+ my $audiotype=$file->audiotype();
+ my @tags=$file->tags();
+ my $haspic=$file->haspic();
+ my $channels=$file->channels();
+ my $bitrate=$file->bitrate();
+ my $samplerate=$file->samplerate();
+
+ $artist=undef unless($self->ok($artist));
+ print "$self->{me}: $path: no artist tag defined\n" unless(defined($artist));
+ my $artist_id=$self->add_to_table("artists", $artist);
+ my $path_id=$self->add_to_table("paths", $pathpart);
+ $album=undef unless($self->ok($album));
+# if($self->{verbose} && !defined($album)) FIXME
+ if(!defined($album))
+ {
+ print "$self->{me}: $path: no album tag defined\n";
+ }
+
+ my $albums_id=$self->add_to_table("albums", $album);
+ my $file_id=$self->add_to_table("files", $filepart,
+ { "artists_id" => $artist_id,
+ "albums_id" => $albums_id,
+ "paths_id" => $path_id });
+ if(@tags)
+ {
+ for my $tag (@tags)
+ {
+ $self->add_tag($file_id, @$tag);
+ }
+ }
+ else
+ {
+ $self->add_tag($file_id, "UNTAGGED");
+ }
+
+ $year="UNKNOWN" if(!$self->ok($year) || $year =~ /^0+$/);
+ $year+=1900 if($year=~/^\d\d$/);
+ $self->add_tag($file_id, "year", $year);
+ if($year=~/^(\d\d\d)\d$/)
+ {
+ $self->add_tag($file_id, "decade", "${1}0s");
+ }
+ else
+ {
+ $self->add_tag($file_id, "decade", "UNKNOWN");
+ }
+
+ if($self->ok($v1genre))
+ {
+ $self->add_tag($file_id, "v1genre", $v1genre);
+ }
+
+ if($haspic)
+ {
+ $self->add_tag($file_id, "haspic", undef);
+ }
+
+ if($self->ok($audiotype))
+ {
+ $self->add_tag($file_id, "audiotype", $audiotype);
+ }
+ else
+ {
+ # should never happen
+ $self->add_tag($file_id, "audiotype", "UNKNOWN");
+ }
+
+ if($self->ok($channels))
+ {
+ if ($channels eq "2") { $channels="stereo"; }
+ elsif ($channels eq "1") { $channels="mono"; }
+ elsif ($channels eq "0") { $channels="UNKNOWN"; }
+ $self->add_tag($file_id, "channels", $channels);
+ }
+
+ if($self->ok($bitrate))
+ {
+ $bitrate="UNKNOWN" if($bitrate=~/^0+$/);
+ $self->add_tag($file_id, "bitrate", $bitrate);
+ }
+
+ if($self->ok($samplerate))
+ {
+ $samplerate="UNKNOWN" if($samplerate=~/^0+$/);
+ $self->add_tag($file_id, "samplerate", $samplerate);
+ }
+
+}
+
+sub add_tag
+{
+ my($self, $file_id, $tag, $value)=@_;
+ my $tag_id=$self->add_to_table("tags", $tag,
+ { "parents_id" => undef });
+ $self->add_relation("files_x_tags",
+ { "files_id" => $file_id,
+ "tags_id" => $tag_id });
+ if(defined($value) && length($value))
+ {
+ my $val_id=$self->add_to_table("tags", $value,
+ { "parents_id" => $tag_id });
+ $self->add_relation("files_x_tags",
+ { "files_id" => $file_id,
+ "tags_id" => $val_id });
+ }
+}
+
+sub add_to_table
+{
+ my($self, $table, $name, $extradata)=@_;
+ my $parent=undef;
+ if($extradata && $extradata->{parents_id})
+ {
+ $parent=$extradata->{parents_id};
+ }
+ my $id=$self->lookup_id($table, $name, $parent);
+ unless(defined($id))
+ {
+ my $sql="INSERT INTO $table (";
+ my @fields=qw(name);
+ if(defined($extradata))
+ {
+ push(@fields, sort keys(%$extradata));
+ }
+ $sql .= join(", ", @fields);
+ $sql .=") VALUES (";
+ $sql .= join(", ", map { "?"; } @fields);
+ $sql .= ");";
+ $id=$self->cmd_id($sql, $name, map { $extradata->{$_} || ""; } sort keys %$extradata);
+ }
+ return $id;
+}
+
+sub add_relation
+{
+ my ($self, $relname, $fields)=@_;
+ return if($self->relation_exists($relname, $fields));
+ my $sql="INSERT INTO $relname (";
+ $sql .= join(", ", sort keys(%$fields));
+ $sql .= ") VALUES (";
+ $sql .= join(", ", map { "?"; } sort keys(%$fields));
+ $sql .= ");";
+ $self->cmd($sql, map { $fields->{$_}; } sort keys(%$fields));
+}
+
+sub files_in
+{
+ my ($self, $dir)=@_;
+ my $sql=("SELECT files.name FROM files\n" .
+ "INNER JOIN paths ON files.paths_id=paths.id\n" .
+ "WHERE paths.name=?\n");
+ return($self->cmd_firstcol($sql, $dir));
+}
+
+sub unindex
+{
+ my($self, $path, $file)=@_;
+ my $sql=("DELETE FROM files WHERE id IN (" .
+ "\tSELECT files.id FROM files\n" .
+ "\tINNER JOIN paths ON paths.id=files.paths_id\n" .
+ "\tWHERE paths.name=? and files.name=? )\n");
+ $self->cmd_rows($sql, $path, $file);
+}
+
+
+sub prune_directories
+{
+ my($self)=@_;
+ my $sql=("SELECT name, id FROM paths\n");
+ my $pathsref=$self->cmd_rows($sql);
+ my @ids=();
+ for my $pathpair (@$pathsref)
+ {
+ my($path, $id)=@$pathpair;
+ my $fullpath="$self->{absbase}/$path";
+ unless(-d $fullpath)
+ {
+ push(@ids, $id)
+ }
+ }
+ $self->prune_paths(@ids);
+ return scalar(@ids);
+}
+
+sub prune_paths
+{
+ my($self, @ids)=@_;
+ return unless(@ids);
+ my $sql=("DELETE FROM files WHERE paths_id IN (\n\t" .
+ join(', ', map { "\"$_\""; } @ids). "\n\t)");
+ $self->cmd($sql);
+}
+
+sub remove_unused
+{
+ my($self)=@_;
+ my $sql=<<'EOT';
+ DELETE FROM artists WHERE id IN (
+ SELECT artists.id FROM artists
+ LEFT JOIN files ON files.artists_id=artists.id
+ WHERE files.id IS NULL);
+
+ DELETE FROM albums WHERE id IN (
+ SELECT albums.id FROM albums
+ LEFT JOIN files ON files.albums_id=albums.id
+ WHERE files.id IS NULL);
+
+ DELETE FROM paths WHERE id IN (
+ SELECT paths.id FROM paths
+ LEFT JOIN files ON files.paths_id=paths.id
+ WHERE files.id IS NULL);
+
+ DELETE FROM files_x_tags WHERE files_id IN (
+ SELECT files_x_tags.files_id FROM files_x_tags
+ LEFT JOIN files ON files.id=files_x_tags.files_id
+ WHERE files.id IS NULL);
+
+ DELETE FROM tags WHERE id IN (
+ SELECT tags.id FROM tags
+ LEFT JOIN files_x_tags ON files_x_tags.tags_id=tags.id
+ WHERE files_x_tags.files_id IS NULL);
+
+ VACUUM
+EOT
+# print "SQL: $sql\n";
+ my @sql=split(/\n\n/, $sql);
+ $self->cmd($_) for (@sql);
+}
+
+sub relation_exists
+{
+ my ($self, $relname, $fields)=@_;
+ my $sql="SELECT count(1) FROM $relname WHERE ";
+ my @exprs=();
+ my @vals=();
+ for my $field (keys %$fields)
+ {
+ push(@exprs,$field);
+ push(@vals,$fields->{$field});
+ }
+ $sql .= join(' AND ', map { "$_=?"; } @exprs);
+ my ($ret)=$self->cmd_onerow($sql, @vals);
+ return $ret;
+}
+
+sub ok
+{
+ my($self, $thing)=@_;
+ return(defined($thing) && length($thing) && $thing =~ /\S+/);
+}
+
+# actually call the database
sub cmd_sth
{
my($self, $sql, @params)=@_;
return $sth;
}
+# pass cmd to db, ignore response
sub cmd
{
my ($self, @args)=@_;
$self->cmd_sth(@args);
}
+# return one row
sub cmd_onerow
{
my ($self, @args)=@_;
return($sth->fetchrow_array());
}
+# returns all rows
+sub cmd_rows
+{
+ my ($self, @args)=@_;
+ my $sth=$self->cmd_sth(@args);
+ return $sth->fetchall_arrayref();
+}
+
+# returns just the first column
+sub cmd_firstcol
+{
+ my ($self, @args)=@_;
+ return(map { $_->[0] } @{$self->cmd_rows(@args)});
+}
+
+# runs cmd, returns id of last insert
+sub cmd_id
+{
+ my ($self, @args)=@_;
+ $self->cmd_sth(@args);
+ return($self->last_insert_id());
+}
+
+sub last_insert_id
+{
+ my $self=shift;
+ return $self->{dbh}->last_insert_id("","","","");
+}
+
+# lookup id of $name in $table, also matching on $parent if needed
+sub lookup_id
+{
+ my($self, $table, $name, $parent)=@_;
+ my $sql="SELECT id FROM $table where name=?";
+ my @args=($name);
+ if($parent)
+ {
+ $sql .= " AND parents_id=?";
+ push(@args, $parent);
+ }
+ my($id)=$self->cmd_onerow($sql, @args);
+ return $id;
+}
+
__DATA__
CREATE TABLE id3fs (
- schema_version
+ schema_version INTEGER,
+ last_update
+);
+
+CREATE TABLE paths (
+ id INTEGER,
+ name text,
+ PRIMARY KEY(id ASC)
+);
+
+CREATE TABLE artists (
+ id INTEGER,
+ name text,
+ PRIMARY KEY(id ASC)
+);
+
+CREATE TABLE albums (
+ id INTEGER,
+ name text,
+ PRIMARY KEY(id ASC)
);
CREATE TABLE files (
- id INTEGER PRIMARY KEY,
- path
+ id INTEGER,
+ name text,
+ artists_id,
+ albums_id,
+ paths_id,
+ PRIMARY KEY(id ASC),
+ FOREIGN KEY(artists_id) REFERENCES artists(id) ON DELETE CASCADE ON UPDATE CASCADE,
+ FOREIGN KEY(albums_id) REFERENCES albums(id) ON DELETE CASCADE ON UPDATE CASCADE,
+ FOREIGN KEY(paths_id) REFERENCES paths(id) ON DELETE CASCADE ON UPDATE CASCADE
);
CREATE TABLE tags (
- id INTEGER PRIMARY KEY,
- name
+ id INTEGER,
+ parents_id INTEGER,
+ name text,
+ PRIMARY KEY(id ASC)
);
-CREATE TABLE tags_x_files (
- files_id,
- tags_id
+CREATE TABLE files_x_tags (
+ files_id INTEGER,
+ tags_id INTEGER,
+ FOREIGN KEY(files_id) REFERENCES files(id) ON DELETE CASCADE ON UPDATE CASCADE,
+ FOREIGN KEY(tags_id) REFERENCES tags(id) ON DELETE CASCADE ON UPDATE CASCADE
);
-CREATE TABLE v1genres (
- id,
- name
-);
+CREATE INDEX idx_fxt_both ON files_x_tags (files_id, tags_id)
+
+CREATE INDEX idx_fxt_tags ON files_x_tags (tags_id)
+
+CREATE INDEX idx_files_id_name ON files (id, name)
+
+CREATE INDEX idx_files_name_id ON files (name, id)
+
+CREATE INDEX idx_tags_id_parent_name ON tags (id, parents_id, name)
+
+CREATE INDEX idx_tags_parent_id_name ON tags (parents_id, id, name)
+
+CREATE INDEX idx_tags_name ON tags (name)