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     $dbpath=$self->find_db($init, $dbpath, $fallbackdir);
  27     return undef unless($dbpath);
  28     $self->{absbase}=Cwd::abs_path($self->{base});
  29
  30     my $connectstr="dbi:SQLite:dbname=$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 $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, $id3fs_path)=@_;
 211     $id3fs_path=~s/(.*)\/.*/$1/;
 212     my $rpath="$self->{absbase}/$path";
 213     my $vpath="$mountpoint/$id3fs_path";
 214     my @path=split(/\//,$rpath);
 215     my @rel=split(/\//,$vpath);
 216     #absolute paths have empty first element due to leading /
 217     shift(@path) if($path[0] eq "");
 218     shift(@rel)  if($rel[0]  eq "");
 219     if($path[0] ne $rel[0])
 220     {
 221         #no path in common, return absolute
 222         print "FAIL: NO PATHS IN COMMON\n";
 223         return $name;
 224     }
 225     # f: /home/foo/bar/baz.mp3
 226     # r: /home/ianb/music/albums
 227     while(@path && @rel && ($path[0] eq $rel[0]))
 228     {
 229         shift(@path);
 230         shift(@rel);
 231 #       print "POP ";
 232     }
 233 #    print "\n";
 234     my $upcount=scalar(@rel);
 235     my $result="../" x $upcount;
 236     $result .= join("/",@path);
 237     $result .= "/$name";
 238     return $result;
 239 }
 240
 241 sub add
 242 {
 243     my($self,$path)=@_;
 244     my $relpath=Cwd::abs_path($path);
 245     $relpath =~ s/^\Q$self->{absbase}\E\/?//;
 246     my($filepart,$pathpart);
 247     if($relpath !~ /\//)
 248     {
 249         $pathpart='';
 250         $filepart=$relpath;
 251     }
 252     else
 253     {
 254         ($pathpart, $filepart) = ($relpath =~ /(.*)\/(.*)/);
 255     }
 256     my $file=ID3FS::AudioFile->new($path, $self->{me});
 257     return unless(defined($file));
 258     my $artist=$file->artist();
 259     my $album=$file->album();
 260     my $v1genre=$file->v1genre();
 261     my $year=$file->year();
 262     my $audiotype=$file->audiotype();
 263     my @tags=$file->tags();
 264     my $haspic=$file->haspic();
 265
 266     $artist=undef unless($self->ok($artist));
 267     print "$self->{me}: $path: no artist tag defined\n" unless(defined($artist));
 268     my $artist_id=$self->add_to_table("artists",  $artist);
 269     my $path_id=$self->add_to_table("paths", $pathpart);
 270     $album=undef unless($self->ok($album));
 271     if($self->{verbose} && !defined($album))
 272     {
 273         print "$self->{me}: $path: no album tag defined\n";
 274     }
 275
 276     my $albums_id=$self->add_to_table("albums", $album);
 277     my $file_id=$self->add_to_table("files", $filepart,
 278                                     { "artists_id" => $artist_id,
 279                                       "albums_id"  => $albums_id,
 280                                       "paths_id"   => $path_id });
 281     for my $tag (@tags)
 282     {
 283         $self->add_tag($file_id, @$tag);
 284     }
 285
 286     $year="UNKNOWN" unless($self->ok($year));
 287     $self->add_tag($file_id, "year", $year);
 288     if($year=~/^(\d\d\d)\d$/)
 289     {
 290         $self->add_tag($file_id, "decade", "${1}0s");
 291     }
 292     else
 293     {
 294         $self->add_tag($file_id, "decade", "UNKNOWN");
 295     }
 296
 297     if($self->ok($v1genre))
 298     {
 299         $self->add_tag($file_id, "v1genre", $v1genre);
 300     }
 301
 302     if($haspic)
 303     {
 304         $self->add_tag($file_id, "haspic", undef);
 305     }
 306 }
 307
 308 sub add_tag
 309 {
 310     my($self, $file_id, $tag, $value)=@_;
 311     my $tag_id=$self->add_to_table("tags",  $tag,
 312                                    { "parents_id" => undef });
 313     $self->add_relation("files_x_tags",
 314                         { "files_id" => $file_id,
 315                           "tags_id"  => $tag_id });
 316     if(defined($value) && length($value))
 317     {
 318         my $val_id=$self->add_to_table("tags",  $value,
 319                                        { "parents_id" => $tag_id });
 320         $self->add_relation("files_x_tags",
 321                             { "files_id" => $file_id,
 322                               "tags_id"  => $val_id });
 323     }
 324 }
 325
 326 sub add_to_table
 327 {
 328     my($self, $table, $name, $extradata)=@_;
 329     my $parent=undef;
 330     if($extradata && $extradata->{parents_id})
 331     {
 332         $parent=$extradata->{parents_id};
 333     }
 334     my $id=$self->lookup_id($table, $name, $parent);
 335     unless(defined($id))
 336     {
 337         my $sql="INSERT INTO $table (";
 338         $sql .= "id, " if($self->{postgres});
 339         my @fields=qw(name);
 340         if(defined($extradata))
 341         {
 342             push(@fields, sort keys(%$extradata));
 343         }
 344         $sql .= join(", ", @fields);
 345         $sql .=") VALUES (";
 346         $sql .=") nextval('seq'), " if($self->{postgres});
 347         $sql .= join(", ", map { "?"; } @fields);
 348         $sql .= ");";
 349         $id=$self->cmd_id($sql, $name, map { $extradata->{$_} || ""; } sort keys %$extradata);
 350     }
 351     return $id;
 352 }
 353
 354 sub add_relation
 355 {
 356     my ($self, $relname, $fields)=@_;
 357     return if($self->relation_exists($relname, $fields));
 358     my $sql="INSERT INTO $relname (";
 359     $sql .= join(", ", sort keys(%$fields));
 360     $sql .= ") VALUES (";
 361     $sql .= join(", ", map { "?"; } sort keys(%$fields));
 362     $sql .= ");";
 363     $self->cmd($sql, map { $fields->{$_}; } sort keys(%$fields));
 364 }
 365
 366 sub files_in
 367 {
 368     my ($self, $dir)=@_;
 369     my $sql=("SELECT files.name FROM files\n" .
 370              "INNER JOIN paths ON files.paths_id=paths.id\n" .
 371              "WHERE paths.name=?\n");
 372 #    print "files_in: SQL: $sql\n";
 373     return($self->cmd_firstcol($sql, $dir));
 374 }
 375
 376 sub unindex
 377 {
 378     my($self, $path, $file)=@_;
 379     my $sql=("DELETE FROM files WHERE id IN (" .
 380              "\tSELECT files.id FROM files\n" .
 381              "\tINNER JOIN paths ON paths.id=files.paths_id\n" .
 382              "\tWHERE paths.name=? and files.name=? )\n");
 383     $self->cmd_rows($sql, $path, $file);
 384 }
 385
 386
 387 sub prune_directories
 388 {
 389     my($self)=@_;
 390     my $sql=("SELECT name, id FROM paths ORDER BY name\n");
 391     my $pathsref=$self->cmd_rows($sql);
 392     my @ids=();
 393     for my $pathpair (@$pathsref)
 394     {
 395         my($path, $id)=@$pathpair;
 396         my $fullpath="$self->{absbase}/$path";
 397         unless(-d $fullpath)
 398         {
 399             push(@ids, $id)
 400         }
 401     }
 402     $self->prune_paths(@ids);
 403     return scalar(@ids);
 404 }
 405
 406 sub prune_paths
 407 {
 408     my($self, @ids)=@_;
 409     return unless(@ids);
 410     my $sql=("DELETE FROM files WHERE paths_id IN (\n\t" .
 411              join(', ', map { "\"$_\""; } @ids). "\n\t)");
 412 #    print "SQL: \n", $sql, "\n";
 413     $self->cmd($sql);
 414 }
 415
 416 sub remove_unused
 417 {
 418     my($self)=@_;
 419     my $sql=<<'EOT';
 420    DELETE FROM artists WHERE id IN (
 421        SELECT artists.id FROM artists
 422        LEFT JOIN files ON files.artists_id=artists.id
 423        WHERE files.id IS NULL);
 424
 425    DELETE FROM albums WHERE id IN (
 426        SELECT albums.id FROM albums
 427        LEFT JOIN files ON files.albums_id=albums.id
 428        WHERE files.id IS NULL);
 429
 430    DELETE FROM paths WHERE id IN (
 431        SELECT paths.id FROM paths
 432        LEFT JOIN files ON files.paths_id=paths.id
 433        WHERE files.id IS NULL);
 434
 435    DELETE FROM files_x_tags WHERE files_id IN (
 436        SELECT files_x_tags.files_id FROM files_x_tags
 437        LEFT JOIN files ON files.id=files_x_tags.files_id
 438        WHERE files.id IS NULL);
 439
 440    DELETE FROM tags WHERE id IN (
 441        SELECT tags.id FROM tags
 442        LEFT JOIN files_x_tags ON files_x_tags.tags_id=tags.id
 443        WHERE files_x_tags.files_id IS NULL);
 444
 445     VACUUM
 446 EOT
 447 #    print "SQL: $sql\n";
 448     my @sql=split(/\n\n/, $sql);
 449     $self->cmd($_) for (@sql);
 450 }
 451
 452 sub relation_exists
 453 {
 454     my ($self, $relname, $fields)=@_;
 455     my $sql="SELECT count(1) FROM $relname WHERE ";
 456     my @exprs=();
 457     my @vals=();
 458     for my $field (keys %$fields)
 459     {
 460         push(@exprs,$field);
 461         push(@vals,$fields->{$field});
 462     }
 463     $sql .= join(' AND ', map { "$_=?"; } @exprs);
 464     my ($ret)=$self->cmd_onerow($sql, @vals);
 465     return $ret;
 466 }
 467
 468 sub ok
 469 {
 470     my($self, $thing)=@_;
 471     return(defined($thing) && length($thing) && $thing =~ /\S+/);
 472 }
 473
 474 sub cmd_sth
 475 {
 476     my($self, $sql, @params)=@_;
 477     my $sth=$self->{dbh}->prepare($sql);
 478     my $idx=1;
 479     for my $param (@params)
 480     {
 481         $param="" unless(defined($param));
 482         $sth->bind_param($idx++, $param);
 483     }
 484     $sth->execute();
 485     return $sth;
 486 }
 487
 488 sub cmd
 489 {
 490     my ($self, @args)=@_;
 491     # don't care about retcode
 492     $self->cmd_sth(@args);
 493 }
 494
 495 sub cmd_onerow
 496 {
 497     my ($self, @args)=@_;
 498     my $sth=$self->cmd_sth(@args);
 499     return($sth->fetchrow_array());
 500 }
 501
 502 sub cmd_rows
 503 {
 504     my ($self, @args)=@_;
 505     my $sth=$self->cmd_sth(@args);
 506     return $sth->fetchall_arrayref();
 507 }
 508
 509 sub cmd_firstcol
 510 {
 511     my ($self, @args)=@_;
 512     return(map { $_->[0] } @{$self->cmd_rows(@args)});
 513 }
 514
 515 sub cmd_id
 516 {
 517     my ($self, @args)=@_;
 518     $self->cmd_sth(@args);
 519     return($self->last_insert_id());
 520 }
 521
 522 sub last_insert_id
 523 {
 524     my $self=shift;
 525     if($self->{postgres})
 526     {
 527         return $self->{dbh}->last_insert_id(undef, undef, undef, undef,
 528                                             { sequence => "seq" });
 529     }
 530     else
 531     {
 532         return $self->{dbh}->last_insert_id("","","","");
 533     }
 534 }
 535
 536 sub lookup_id
 537 {
 538     my($self, $table, $name, $parent)=@_;
 539     my $sql="SELECT id FROM $table where name=?";
 540     my @args=($name);
 541     if($parent)
 542     {
 543         $sql .= " AND parents_id=?";
 544         push(@args, $parent);
 545     }
 546     my($id)=$self->cmd_onerow($sql, @args);
 547     return $id;
 548 }
 549
 550 __DATA__
 551
 552 CREATE TABLE id3fs (
 553     schema_version INTEGER,
 554     last_update
 555 );
 556
 557 CREATE TABLE paths (
 558     id INTEGER,
 559     name text,
 560     PRIMARY KEY(id DESC)
 561 );
 562
 563 CREATE TABLE artists (
 564     id INTEGER,
 565     name text,
 566     PRIMARY KEY(id DESC)
 567 );
 568
 569 CREATE TABLE albums (
 570     id INTEGER,
 571     name text,
 572     PRIMARY KEY(id DESC)
 573 );
 574
 575 CREATE TABLE files (
 576     id INTEGER,
 577     name text,
 578     artists_id,
 579     albums_id,
 580     paths_id,
 581     PRIMARY KEY(id DESC),
 582     FOREIGN KEY(artists_id) REFERENCES artists(id) ON DELETE CASCADE ON UPDATE CASCADE,
 583     FOREIGN KEY(albums_id)  REFERENCES albums(id)  ON DELETE CASCADE ON UPDATE CASCADE,
 584     FOREIGN KEY(paths_id)   REFERENCES paths(id)   ON DELETE CASCADE ON UPDATE CASCADE
 585 );
 586
 587 CREATE TABLE tags (
 588     id INTEGER,
 589     parents_id INTEGER,
 590     name text,
 591     PRIMARY KEY(id DESC)
 592 );
 593
 594 CREATE TABLE files_x_tags (
 595     files_id INTEGER,
 596     tags_id INTEGER,
 597     FOREIGN KEY(files_id) REFERENCES files(id) ON DELETE CASCADE ON UPDATE CASCADE,
 598     FOREIGN KEY(tags_id)  REFERENCES tags(id)  ON DELETE CASCADE ON UPDATE CASCADE
 599 );
 600