lib/ID3FS/DB.pm

   1 package ID3FS::DB;
   2
   3 use strict;
   4 use warnings;
   5 use DBI;
   6 use ID3FS::AudioFile;
   7 use Cwd;
   8
   9 our $SCHEMA_VERSION=1;
  10 my $dbfile=".id3fs";
  11
  12 sub new
  13 {
  14     my $proto=shift;
  15     my $class=ref($proto) || $proto;
  16     my $self={};
  17     bless($self,$class);
  18
  19     $self->{me}=shift;
  20     $self->{verbose}=shift;
  21     my $init=shift;
  22     my $dbpath=shift;
  23     $self->{base}=shift;
  24     my $fallbackdir=shift;
  25
  26     $self->{dbpath}=$self->find_db($init, $dbpath, $fallbackdir);
  27     return undef unless($self->{dbpath});
  28     $self->{absbase}=Cwd::abs_path($self->{base});
  29
  30     my $connectstr="dbi:SQLite:dbname=$self->{dbpath}";
  31     my ($user, $pass)=("", "");
  32     if($self->{postgres})
  33     {
  34         $connectstr="dbi:Pg:dbname=id3fs";
  35         $user="ianb";
  36         $pass="foo";
  37     }
  38     my $exists=-f $self->{dbpath};
  39     $self->{dbh}=DBI->connect($connectstr, $user, $pass,
  40                               { AutoCommit=>1 } );
  41     unless(defined($self->{dbh}))
  42     {
  43         die("$self->{me}: DB Error: " . $DBI::errstr . "\n");
  44     }
  45
  46     if($exists)
  47     {
  48         $self->checkschema();
  49     }
  50     else
  51     {
  52         $self->create();
  53     }
  54     $self->enable_foreign_keys();
  55     return $self;
  56 }
  57
  58 sub find_db
  59 {
  60     my($self, $init, $dbpath, $fallbackdir)=@_;
  61     my $file=undef;
  62     my $base=undef;
  63     if(defined($dbpath))
  64     {
  65         $file=$dbpath;
  66     }
  67     if(defined ($self->{base}))
  68     {
  69         $file="$self->{base}/$dbfile" unless defined($file);
  70         $base=$self->{base};
  71     }
  72     elsif(defined($fallbackdir) && -d $fallbackdir)
  73     {
  74         my $path=Cwd::abs_path($fallbackdir);
  75         do
  76         {
  77             $file="$path/$dbfile";
  78             $base=$path;
  79             $path=~s/(.*)\/.*/$1/;
  80         }
  81         while(! -f $file && length($path) && -d $path);
  82         if(! -f $file)
  83         {
  84             $file="$fallbackdir/$dbfile";
  85             $base=$fallbackdir;
  86         }
  87     }
  88     else
  89     {
  90         print "$self->{me}: $fallbackdir: not a directory\n";
  91         return undef;
  92     }
  93     if(!-f $file && !$init)
  94     {
  95         print "$self->{me}: db not found at $file\n";
  96         return undef;
  97     }
  98     $self->{base}=$base;
  99     return $file;
 100 }
 101
 102 sub base_dir { return shift->{base}; }
 103
 104 sub create
 105 {
 106     my($self,$name)=@_;
 107     my @schema=split(/\n\n/,join("", <DATA>));
 108     close(DATA);
 109     for my $cmd (@schema)
 110     {
 111         $self->{dbh}->do($cmd);
 112     }
 113     if($self->{postgres})
 114     {
 115         $self->cmd("CREATE SEQUENCE seq");
 116     }
 117     else
 118     {
 119         my %indexes=( "idx_files_id"  => "files (id)",
 120                       "idx_fxt_both"  => "files_x_tags (files_id, tags_id)",
 121                       "idx_fxt_files" => "files_x_tags (files_id)",
 122                       "idx_fxt_tags"  => "files_x_tags (tags_id)",
 123                       "idx_tags_id"   => "tags (id)",
 124                       "idx_tags_name" => "tags (name)");
 125         for my $index (keys %indexes)
 126         {
 127             $self->{dbh}->do("CREATE INDEX $index ON " . $indexes{$index});
 128         }
 129     }
 130     $self->cmd("INSERT INTO id3fs (schema_version, last_update) VALUES (?, ?)",
 131                $SCHEMA_VERSION, time());
 132 }
 133
 134 sub checkschema
 135 {
 136     my $self=shift;
 137     my ($version)=$self->cmd_onerow("SELECT schema_version from id3fs");
 138     if(!defined($version) || $version != $SCHEMA_VERSION)
 139     {
 140         die("$self->{me}: id3fs database version " .
 141             defined($version) ? $version : '""' .
 142             "not known, current version is $SCHEMA_VERSION.\n");
 143     }
 144 }
 145
 146 sub analyze
 147 {
 148     my $self=shift;
 149     $self->cmd("ANALYZE");
 150 }
 151
 152 sub enable_foreign_keys
 153 {
 154     my $self=shift;
 155     $self->cmd("PRAGMA foreign_keys = ON");
 156 }
 157
 158 sub last_update
 159 {
 160     my($self, $newval)=@_;
 161     if(defined($newval))
 162     {
 163         $self->cmd("UPDATE id3fs SET last_update=?", $newval);
 164     }
 165     else
 166     {
 167         ($newval)=$self->cmd_onerow("SELECT last_update from id3fs");
 168     }
 169     return $newval;
 170 }
 171
 172 sub bare_tags
 173 {
 174     my($self)=@_;
 175     my $sql=("SELECT tags.name FROM tags\n" .
 176              "WHERE tags.parents_id=''\n" .
 177              "GROUP BY tags.name\n");
 178     my @names=$self->cmd_firstcol($sql);
 179     return (@names);
 180 }
 181
 182 sub tags_with_values
 183 {
 184     # FIXME: only shows one level of tag depth
 185     my($self)=@_;
 186     my $sql=("SELECT p.name, t.name  FROM tags t\n" .
 187              "INNER JOIN tags p ON t.parents_id=p.id\n" .
 188              "GROUP BY p.name, t.name\n");
 189 #    print "SQL: $sql\n";
 190     my $result=$self->cmd_rows($sql);
 191     my $tags={};
 192     for my $pair (@$result)
 193     {
 194         push(@{$tags->{$pair->[0]}}, $pair->[1]);
 195     }
 196     return $tags;
 197 }
 198
 199 sub tag_has_values
 200 {
 201     my($self, $id)=@_;
 202     my $sql=("SELECT COUNT(*) FROM tags\n\t" .
 203              "WHERE tags.parents_id=?\n");
 204     my ($rows)=$self->cmd_onerow($sql, $id);
 205     return $rows;
 206 }
 207
 208 sub relativise
 209 {
 210     my($self, $path, $name, $mountpoint)=@_;
 211     my $id3fs_path=$self->{dbpath};
 212     $id3fs_path=~s/(.*)\/.*/$1/;
 213     my $rpath="$self->{absbase}/$path";
 214     my $vpath="$mountpoint/$id3fs_path";
 215     my @path=split(/\//,$rpath);
 216     my @rel=split(/\//,$vpath);
 217     #absolute paths have empty first element due to leading /
 218     shift(@path) if($path[0] eq "");
 219     shift(@rel)  if($rel[0]  eq "");
 220     if($path[0] ne $rel[0])
 221     {
 222         #no path in common, return absolute
 223         print "FAIL: NO PATHS IN COMMON\n";
 224         return $name;
 225     }
 226     # f: /home/foo/bar/baz.mp3
 227     # r: /home/ianb/music/albums
 228     while(@path && @rel && ($path[0] eq $rel[0]))
 229     {
 230         shift(@path);
 231         shift(@rel);
 232 #       print "POP ";
 233     }
 234 #    print "\n";
 235     my $upcount=scalar(@rel);
 236     my $result="../" x $upcount;
 237     $result .= join("/",@path);
 238     $result .= "/$name";
 239     return $result;
 240 }
 241
 242 sub add
 243 {
 244     my($self,$path)=@_;
 245     my $relpath=Cwd::abs_path($path);
 246     $relpath =~ s/^\Q$self->{absbase}\E\/?//;
 247     my($filepart,$pathpart);
 248     if($relpath !~ /\//)
 249     {
 250         $pathpart='';
 251         $filepart=$relpath;
 252     }
 253     else
 254     {
 255         ($pathpart, $filepart) = ($relpath =~ /(.*)\/(.*)/);
 256     }
 257     my $file=ID3FS::AudioFile->new($path, $self->{me});
 258     return unless(defined($file));
 259     my $artist=$file->artist();
 260     my $album=$file->album();
 261     my $v1genre=$file->v1genre();
 262     my $year=$file->year();
 263     my $audiotype=$file->audiotype();
 264     my @tags=$file->tags();
 265     my $haspic=$file->haspic();
 266
 267     $artist=undef unless($self->ok($artist));
 268     print "$self->{me}: $path: no artist tag defined\n" unless(defined($artist));
 269     my $artist_id=$self->add_to_table("artists",  $artist);
 270     my $path_id=$self->add_to_table("paths", $pathpart);
 271     $album=undef unless($self->ok($album));
 272     if($self->{verbose} && !defined($album))
 273     {
 274         print "$self->{me}: $path: no album tag defined\n";
 275     }
 276
 277     my $albums_id=$self->add_to_table("albums", $album);
 278     my $file_id=$self->add_to_table("files", $filepart,
 279                                     { "artists_id" => $artist_id,
 280                                       "albums_id"  => $albums_id,
 281                                       "paths_id"   => $path_id });
 282     for my $tag (@tags)
 283     {
 284         $self->add_tag($file_id, @$tag);
 285     }
 286
 287     $year="UNKNOWN" unless($self->ok($year));
 288     $self->add_tag($file_id, "year", $year);
 289     if($year=~/^(\d\d\d)\d$/)
 290     {
 291         $self->add_tag($file_id, "decade", "${1}0s");
 292     }
 293     else
 294     {
 295         $self->add_tag($file_id, "decade", "UNKNOWN");
 296     }
 297
 298     if($self->ok($v1genre))
 299     {
 300         $self->add_tag($file_id, "v1genre", $v1genre);
 301     }
 302
 303     if($haspic)
 304     {
 305         $self->add_tag($file_id, "haspic", undef);
 306     }
 307 }
 308
 309 sub add_tag
 310 {
 311     my($self, $file_id, $tag, $value)=@_;
 312     my $tag_id=$self->add_to_table("tags",  $tag,
 313                                    { "parents_id" => undef });
 314     $self->add_relation("files_x_tags",
 315                         { "files_id" => $file_id,
 316                           "tags_id"  => $tag_id });
 317     if(defined($value) && length($value))
 318     {
 319         my $val_id=$self->add_to_table("tags",  $value,
 320                                        { "parents_id" => $tag_id });
 321         $self->add_relation("files_x_tags",
 322                             { "files_id" => $file_id,
 323                               "tags_id"  => $val_id });
 324     }
 325 }
 326
 327 sub add_to_table
 328 {
 329     my($self, $table, $name, $extradata)=@_;
 330     my $parent=undef;
 331     if($extradata && $extradata->{parents_id})
 332     {
 333         $parent=$extradata->{parents_id};
 334     }
 335     my $id=$self->lookup_id($table, $name, $parent);
 336     unless(defined($id))
 337     {
 338         my $sql="INSERT INTO $table (";
 339         $sql .= "id, " if($self->{postgres});
 340         my @fields=qw(name);
 341         if(defined($extradata))
 342         {
 343             push(@fields, sort keys(%$extradata));
 344         }
 345         $sql .= join(", ", @fields);
 346         $sql .=") VALUES (";
 347         $sql .=") nextval('seq'), " if($self->{postgres});
 348         $sql .= join(", ", map { "?"; } @fields);
 349         $sql .= ");";
 350         $id=$self->cmd_id($sql, $name, map { $extradata->{$_} || ""; } sort keys %$extradata);
 351     }
 352     return $id;
 353 }
 354
 355 sub add_relation
 356 {
 357     my ($self, $relname, $fields)=@_;
 358     return if($self->relation_exists($relname, $fields));
 359     my $sql="INSERT INTO $relname (";
 360     $sql .= join(", ", sort keys(%$fields));
 361     $sql .= ") VALUES (";
 362     $sql .= join(", ", map { "?"; } sort keys(%$fields));
 363     $sql .= ");";
 364     $self->cmd($sql, map { $fields->{$_}; } sort keys(%$fields));
 365 }
 366
 367 sub files_in
 368 {
 369     my ($self, $dir)=@_;
 370     my $sql=("SELECT files.name FROM files\n" .
 371              "INNER JOIN paths ON files.paths_id=paths.id\n" .
 372              "WHERE paths.name=?\n");
 373 #    print "files_in: SQL: $sql\n";
 374     return($self->cmd_firstcol($sql, $dir));
 375 }
 376
 377 sub unindex
 378 {
 379     my($self, $path, $file)=@_;
 380     my $sql=("DELETE FROM files WHERE id IN (" .
 381              "\tSELECT files.id FROM files\n" .
 382              "\tINNER JOIN paths ON paths.id=files.paths_id\n" .
 383              "\tWHERE paths.name=? and files.name=? )\n");
 384     $self->cmd_rows($sql, $path, $file);
 385 }
 386
 387
 388 sub prune_directories
 389 {
 390     my($self)=@_;
 391     my $sql=("SELECT name, id FROM paths ORDER BY name\n");
 392     my $pathsref=$self->cmd_rows($sql);
 393     my @ids=();
 394     for my $pathpair (@$pathsref)
 395     {
 396         my($path, $id)=@$pathpair;
 397         my $fullpath="$self->{absbase}/$path";
 398         unless(-d $fullpath)
 399         {
 400             push(@ids, $id)
 401         }
 402     }
 403     $self->prune_paths(@ids);
 404     return scalar(@ids);
 405 }
 406
 407 sub prune_paths
 408 {
 409     my($self, @ids)=@_;
 410     return unless(@ids);
 411     my $sql=("DELETE FROM files WHERE paths_id IN (\n\t" .
 412              join(', ', map { "\"$_\""; } @ids). "\n\t)");
 413 #    print "SQL: \n", $sql, "\n";
 414     $self->cmd($sql);
 415 }
 416
 417 sub remove_unused
 418 {
 419     my($self)=@_;
 420     my $sql=<<'EOT';
 421    DELETE FROM artists WHERE id IN (
 422        SELECT artists.id FROM artists
 423        LEFT JOIN files ON files.artists_id=artists.id
 424        WHERE files.id IS NULL);
 425
 426    DELETE FROM albums WHERE id IN (
 427        SELECT albums.id FROM albums
 428        LEFT JOIN files ON files.albums_id=albums.id
 429        WHERE files.id IS NULL);
 430
 431    DELETE FROM paths WHERE id IN (
 432        SELECT paths.id FROM paths
 433        LEFT JOIN files ON files.paths_id=paths.id
 434        WHERE files.id IS NULL);
 435
 436    DELETE FROM files_x_tags WHERE files_id IN (
 437        SELECT files_x_tags.files_id FROM files_x_tags
 438        LEFT JOIN files ON files.id=files_x_tags.files_id
 439        WHERE files.id IS NULL);
 440
 441    DELETE FROM tags WHERE id IN (
 442        SELECT tags.id FROM tags
 443        LEFT JOIN files_x_tags ON files_x_tags.tags_id=tags.id
 444        WHERE files_x_tags.files_id IS NULL);
 445
 446     VACUUM
 447 EOT
 448 #    print "SQL: $sql\n";
 449     my @sql=split(/\n\n/, $sql);
 450     $self->cmd($_) for (@sql);
 451 }
 452
 453 sub relation_exists
 454 {
 455     my ($self, $relname, $fields)=@_;
 456     my $sql="SELECT count(1) FROM $relname WHERE ";
 457     my @exprs=();
 458     my @vals=();
 459     for my $field (keys %$fields)
 460     {
 461         push(@exprs,$field);
 462         push(@vals,$fields->{$field});
 463     }
 464     $sql .= join(' AND ', map { "$_=?"; } @exprs);
 465     my ($ret)=$self->cmd_onerow($sql, @vals);
 466     return $ret;
 467 }
 468
 469 sub ok
 470 {
 471     my($self, $thing)=@_;
 472     return(defined($thing) && length($thing) && $thing =~ /\S+/);
 473 }
 474
 475 sub cmd_sth
 476 {
 477     my($self, $sql, @params)=@_;
 478     my $sth=$self->{dbh}->prepare($sql);
 479     my $idx=1;
 480     for my $param (@params)
 481     {
 482         $param="" unless(defined($param));
 483         $sth->bind_param($idx++, $param);
 484     }
 485     $sth->execute();
 486     return $sth;
 487 }
 488
 489 sub cmd
 490 {
 491     my ($self, @args)=@_;
 492     # don't care about retcode
 493     $self->cmd_sth(@args);
 494 }
 495
 496 sub cmd_onerow
 497 {
 498     my ($self, @args)=@_;
 499     my $sth=$self->cmd_sth(@args);
 500     return($sth->fetchrow_array());
 501 }
 502
 503 sub cmd_rows
 504 {
 505     my ($self, @args)=@_;
 506     my $sth=$self->cmd_sth(@args);
 507     return $sth->fetchall_arrayref();
 508 }
 509
 510 sub cmd_firstcol
 511 {
 512     my ($self, @args)=@_;
 513     return(map { $_->[0] } @{$self->cmd_rows(@args)});
 514 }
 515
 516 sub cmd_id
 517 {
 518     my ($self, @args)=@_;
 519     $self->cmd_sth(@args);
 520     return($self->last_insert_id());
 521 }
 522
 523 sub last_insert_id
 524 {
 525     my $self=shift;
 526     if($self->{postgres})
 527     {
 528         return $self->{dbh}->last_insert_id(undef, undef, undef, undef,
 529                                             { sequence => "seq" });
 530     }
 531     else
 532     {
 533         return $self->{dbh}->last_insert_id("","","","");
 534     }
 535 }
 536
 537 sub lookup_id
 538 {
 539     my($self, $table, $name, $parent)=@_;
 540     my $sql="SELECT id FROM $table where name=?";
 541     my @args=($name);
 542     if($parent)
 543     {
 544         $sql .= " AND parents_id=?";
 545         push(@args, $parent);
 546     }
 547     my($id)=$self->cmd_onerow($sql, @args);
 548     return $id;
 549 }
 550
 551 __DATA__
 552
 553 CREATE TABLE id3fs (
 554     schema_version INTEGER,
 555     last_update
 556 );
 557
 558 CREATE TABLE paths (
 559     id INTEGER,
 560     name text,
 561     PRIMARY KEY(id DESC)
 562 );
 563
 564 CREATE TABLE artists (
 565     id INTEGER,
 566     name text,
 567     PRIMARY KEY(id DESC)
 568 );
 569
 570 CREATE TABLE albums (
 571     id INTEGER,
 572     name text,
 573     PRIMARY KEY(id DESC)
 574 );
 575
 576 CREATE TABLE files (
 577     id INTEGER,
 578     name text,
 579     artists_id,
 580     albums_id,
 581     paths_id,
 582     PRIMARY KEY(id DESC),
 583     FOREIGN KEY(artists_id) REFERENCES artists(id) ON DELETE CASCADE ON UPDATE CASCADE,
 584     FOREIGN KEY(albums_id)  REFERENCES albums(id)  ON DELETE CASCADE ON UPDATE CASCADE,
 585     FOREIGN KEY(paths_id)   REFERENCES paths(id)   ON DELETE CASCADE ON UPDATE CASCADE
 586 );
 587
 588 CREATE TABLE tags (
 589     id INTEGER,
 590     parents_id INTEGER,
 591     name text,
 592     PRIMARY KEY(id DESC)
 593 );
 594
 595 CREATE TABLE files_x_tags (
 596     files_id INTEGER,
 597     tags_id INTEGER,
 598     FOREIGN KEY(files_id) REFERENCES files(id) ON DELETE CASCADE ON UPDATE CASCADE,
 599     FOREIGN KEY(tags_id)  REFERENCES tags(id)  ON DELETE CASCADE ON UPDATE CASCADE
 600 );
 601