+# 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 Cwd;
our $SCHEMA_VERSION=1;
-my $dbfile=".id3fs";
+my $dbfile=".id3fs"; # default
sub new
{
$self->{me}=shift;
$self->{verbose}=shift;
my $init=shift;
- my $dbpath=shift;
$self->{base}=shift;
- my $fallbackdir=shift;
-
- $dbpath=$self->find_db($init, $dbpath, $fallbackdir);
- return undef unless($dbpath);
+ $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=$dbpath";
- my ($user, $pass)=("", "");
- if($self->{postgres})
- {
- $connectstr="dbi:Pg:dbname=id3fs";
- $user="ianb";
- $pass="foo";
- }
- my $exists=-f $dbpath;
- $self->{dbh}=DBI->connect($connectstr, $user, $pass,
+ my $connectstr="dbi:SQLite:dbname=$self->{dbpath}";
+ my $exists=-f $self->{dbpath};
+ $self->{dbh}=DBI->connect($connectstr, undef, undef,
{ AutoCommit=>1 } );
unless(defined($self->{dbh}))
{
return $self;
}
+# search parent directories for db
sub find_db
{
- my($self, $init, $dbpath, $fallbackdir)=@_;
- my $file=undef;
+ # class method
+ shift if(ref($_[0]) eq "ID3FS::DB");
+
+ my($me, $init, @dirs)=@_;
my $base=undef;
- if(defined($dbpath))
+ for my $dir (@dirs)
{
- $file=$dbpath;
- }
- if(defined ($self->{base}))
- {
- $file="$self->{base}/$dbfile" unless defined($file);
- $base=$self->{base};
- }
- elsif(defined($fallbackdir) && -d $fallbackdir)
- {
- my $path=Cwd::abs_path($fallbackdir);
+ my $path=Cwd::abs_path($dir);
do
{
- $file="$path/$dbfile";
$base=$path;
$path=~s/(.*)\/.*/$1/;
}
- while(! -f $file && length($path) && -d $path);
- if(! -f $file)
+ while(! -f "$base/$dbfile" && length($path) && -d $path);
+ if(-f "$base/$dbfile")
{
- $file="$fallbackdir/$dbfile";
- $base=$fallbackdir;
+ return $base;
}
}
- if(!-f $file && !$init)
+ if(!-f "$base/$dbfile")
{
- print "$self->{me}: db not found at $file\n";
- return undef;
+ unless($init)
+ {
+ print "$me: db not found at $base/$dbfile\n";
+ return undef;
+ }
+ $base=$dirs[0];
+
}
- $self->{base}=$base;
- return $file;
+ return $base;
}
sub base_dir { return shift->{base}; }
{
$self->{dbh}->do($cmd);
}
- if($self->{postgres})
- {
- $self->cmd("CREATE SEQUENCE seq");
- }
- else
- {
- my %indexes=( "idx_files_id" => "files (id)",
- "idx_fxt_both" => "files_x_tags (files_id, tags_id)",
- "idx_fxt_files" => "files_x_tags (files_id)",
- "idx_fxt_tags" => "files_x_tags (tags_id)",
- "idx_tags_id" => "tags (id)",
- "idx_tags_name" => "tags (name)");
- for my $index (keys %indexes)
- {
- $self->{dbh}->do("CREATE INDEX $index ON " . $indexes{$index});
- }
- }
$self->cmd("INSERT INTO id3fs (schema_version, last_update) VALUES (?, ?)",
$SCHEMA_VERSION, time());
}
return $newval;
}
-sub id
+sub bare_tags
{
- my($self, $type, $val)=@_;
- my $sql="SELECT id FROM $type WHERE name=?";
- my ($id)=$self->cmd_onerow($sql, $val);
- return($id);
+ 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
sub relativise
{
- my($self, $path, $name, $mountpoint, $id3fs_path)=@_;
- $id3fs_path=~s/(.*)\/.*/$1/;
+ my($self, $path, $name, $mountpoint, $querypath)=@_;
my $rpath="$self->{absbase}/$path";
- my $vpath="$mountpoint/$id3fs_path";
+ my $vpath=$mountpoint . $querypath;
my @path=split(/\//,$rpath);
my @rel=split(/\//,$vpath);
- #absolute paths have empty first element due to leading /
+ # 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 "");
- if($path[0] ne $rel[0])
- {
- #no path in common, return absolute
- print "FAIL: NO PATHS IN COMMON\n";
- return $name;
- }
# f: /home/foo/bar/baz.mp3
# r: /home/ianb/music/albums
while(@path && @rel && ($path[0] eq $rel[0]))
{
shift(@path);
shift(@rel);
-# print "POP ";
}
-# print "\n";
my $upcount=scalar(@rel);
my $result="../" x $upcount;
$result .= join("/",@path);
sub add
{
my($self,$path)=@_;
- my $relpath=$path;
- $relpath =~ s/^\Q$self->{base}\E\/?//;
+ my $relpath=Cwd::abs_path($path);
+ $relpath =~ s/^\Q$self->{absbase}\E\/?//;
my($filepart,$pathpart);
if($relpath !~ /\//)
{
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))
+# if($self->{verbose} && !defined($album)) FIXME
+ if(!defined($album))
{
print "$self->{me}: $path: no album tag defined\n";
}
{ "artists_id" => $artist_id,
"albums_id" => $albums_id,
"paths_id" => $path_id });
- for my $tag (@tags)
+ if(@tags)
{
- $self->add_tag($file_id, @$tag);
+ for my $tag (@tags)
+ {
+ $self->add_tag($file_id, @$tag);
+ }
+ }
+ else
+ {
+ $self->add_tag($file_id, "UNTAGGED");
}
- $year="UNKNOWN" unless($self->ok($year));
+ $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, "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
sub add_to_table
{
my($self, $table, $name, $extradata)=@_;
- my $id=$self->lookup_id($table, $name);
+ 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 (";
- $sql .= "id, " if($self->{postgres});
my @fields=qw(name);
if(defined($extradata))
{
}
$sql .= join(", ", @fields);
$sql .=") VALUES (";
- $sql .=") nextval('seq'), " if($self->{postgres});
$sql .= join(", ", map { "?"; } @fields);
$sql .= ");";
$id=$self->cmd_id($sql, $name, map { $extradata->{$_} || ""; } sort keys %$extradata);
sub files_in
{
my ($self, $dir)=@_;
- $dir=~s/^$self->{base}\/?//;
my $sql=("SELECT files.name FROM files\n" .
"INNER JOIN paths ON files.paths_id=paths.id\n" .
"WHERE paths.name=?\n");
- my $files=$self->cmd_rows($sql, $dir);
- return(map { $_->[0]; } @$files);
+ 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 ORDER BY name\n");
+ my $sql=("SELECT name, id FROM paths\n");
my $pathsref=$self->cmd_rows($sql);
my @ids=();
for my $pathpair (@$pathsref)
return unless(@ids);
my $sql=("DELETE FROM files WHERE paths_id IN (\n\t" .
join(', ', map { "\"$_\""; } @ids). "\n\t)");
- print "SQL: \n", $sql, "\n";
$self->cmd($sql);
}
VACUUM
EOT
- print "SQL: $sql\n";
+# print "SQL: $sql\n";
my @sql=split(/\n\n/, $sql);
$self->cmd($_) for (@sql);
}
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)=@_;
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)=@_;
sub last_insert_id
{
my $self=shift;
- if($self->{postgres})
- {
- return $self->{dbh}->last_insert_id(undef, undef, undef, undef,
- { sequence => "seq" });
- }
- else
- {
- return $self->{dbh}->last_insert_id("","","","");
- }
+ 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)=@_;
- my($id)=$self->cmd_onerow("SELECT id FROM $table where name=?", $name);
+ 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;
}
);
CREATE TABLE paths (
- id INTEGER PRIMARY KEY,
- name text
+ id INTEGER,
+ name text,
+ PRIMARY KEY(id ASC)
);
CREATE TABLE artists (
- id INTEGER PRIMARY KEY,
- name text
+ id INTEGER,
+ name text,
+ PRIMARY KEY(id ASC)
);
CREATE TABLE albums (
- id INTEGER PRIMARY KEY,
- name text
+ id INTEGER,
+ name text,
+ PRIMARY KEY(id ASC)
);
CREATE TABLE files (
- id INTEGER PRIMARY KEY,
+ 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,
+ id INTEGER,
parents_id INTEGER,
- name text
+ name text,
+ PRIMARY KEY(id ASC)
);
CREATE TABLE files_x_tags (
FOREIGN KEY(tags_id) REFERENCES tags(id) ON DELETE CASCADE ON UPDATE CASCADE
);
+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)