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/>.
21 use ID3FS::Path::Node;
23 our ($STATE_INVALID, $STATE_ROOT, $STATE_TAG, $STATE_BOOLEAN,
24 $STATE_ALBUMS, $STATE_TRACKLIST, $STATE_FILE, $STATE_ALL)=(0..7);
27 our %priorities=( "OR" => 0, "AND" => 1, "NOT" => 2 );
29 our $PATH_ALLTRACKS= "TRACKS";
30 our $PATH_NOARTIST = "NOARTIST";
31 our $PATH_NOALBUM = "NOALBUM";
33 our $ENABLE_FILTER = 1;
38 my $class=ref($proto) || $proto;
45 $self->{verbose}=shift;
46 $self->{maxtagdepth}=shift;
47 $self->{curtagdepth}=0;
48 $self->{path} =~ s/\/\//\//g; # drop doubled slashes
51 # print "STATE: ", $self->state(), "\n";
58 if(($self->state() == $STATE_FILE) ||
59 ($self->state() == $STATE_INVALID))
69 return($self->state() == $STATE_FILE);
75 return($self->state() != $STATE_INVALID);
80 my($self, $mountpoint)=@_;
81 if($self->state() == $STATE_FILE)
83 return $self->filename($mountpoint);
85 return "ERROR"; #should never happen?
93 my $state=$self->state();
94 # print "DIRENTS: STATE: $state\n";
95 # print "DIRENTS: FILE: $self->{path}\n";
96 if($state==$STATE_ALL)
98 @dents=($self->filter($PATH_ALLTRACKS, $PATH_NOARTIST), $self->artists());
100 elsif($state==$STATE_TAG)
102 my $tail=$self->tail();
103 if($self->is($TYPE_TAG, $tail) && $self->{db}->tag_has_values($tail->id()))
105 @dents=$self->tags();
109 if($self->{maxtagdepth} && ($self->{curtagdepth} < $self->{maxtagdepth}))
113 push(@dents, $self->filter($PATH_ALLTRACKS, $PATH_NOARTIST), $self->artists());
116 elsif($state==$STATE_BOOLEAN)
118 my $parent=$self->tail();
119 unless($self->is($TYPE_BOOL, $parent) && $parent->{name} eq "NOT")
123 push(@dents,$self->tags());
125 elsif($state==$STATE_ROOT)
127 @dents=(qw(ALL NOT), $self->tags());
129 elsif($state==$STATE_ALBUMS)
131 @dents=$self->filter($PATH_ALLTRACKS, $PATH_NOALBUM, $self->albums());
133 elsif($state==$STATE_TRACKLIST)
135 @fents=$self->tracks();
139 print "id3fsd: INTERNAL ERROR: DIRENTS: UNHANDLED STATE: $state\n";
141 return(\@dents, \@fents);
144 # State Machine Of Doom
148 $self->state($STATE_ROOT);
149 return if($self->{path} eq "/");
150 @{$self->{components}}=split(/\//, $self->{path});
151 shift @{$self->{components}}; # drop empty field before leading /
152 # print "PATH: $self->{path}\n";
153 my @parts=@{$self->{components}};
155 $self->{elements}=[];
159 while(defined(my $name=shift @parts))
161 # print "NAME: $name\n";
162 my $state=$self->state();
163 if($state==$STATE_INVALID)
165 # print "SM: INVALID: $name\n";
168 elsif($state==$STATE_ROOT)
170 # print "SM: ROOT: $name\n";
174 $self->state($STATE_ALL);
176 elsif($name eq "NOT")
179 push(@{$self->{elements}}, ID3FS::Path::Node->new($self->{db}, $TYPE_BOOL, $name));
180 $self->state($STATE_BOOLEAN);
184 $tag=ID3FS::Path::Node->new($self->{db}, $TYPE_TAG, $name);
187 push(@{$self->{elements}}, $tag);
189 $self->state($STATE_TAG);
193 $self->state($STATE_INVALID);
197 elsif($state==$STATE_TAG)
199 my $tag=$self->tail();
200 # print "SM: TAG/TAGVAL($state): $name\n";
201 if($self->is($TYPE_TAG, $tag) && $self->{db}->tag_has_values($tag->id()))
203 # print "Parsing: parent: $tag->id()\n";
204 my $tagval=ID3FS::Path::Node->new($self->{db}, $TYPE_TAG, $name, $tag->id());
208 push(@{$self->{elements}}, $tagval);
212 $self->state($STATE_INVALID);
215 elsif($name eq $PATH_ALLTRACKS)
217 $self->state($STATE_TRACKLIST);
219 elsif($name eq $PATH_NOARTIST)
221 $self->state($STATE_TRACKLIST);
223 elsif($name eq "AND")
225 $self->state($STATE_BOOLEAN);
226 push(@{$self->{elements}}, ID3FS::Path::Node->new($self->{db}, $TYPE_BOOL, $name));
230 $self->state($STATE_BOOLEAN);
231 push(@{$self->{elements}}, ID3FS::Path::Node->new($self->{db}, $TYPE_BOOL, $name));
235 my $artist=ID3FS::Path::Node->new($self->{db}, $TYPE_ARTIST, $name);
238 push(@{$self->{elements}}, $artist);
239 $self->state($STATE_ALBUMS);
243 $self->state($STATE_INVALID);
247 elsif($state==$STATE_BOOLEAN)
249 # print "SM: BOOLEAN: $name\n";
250 my $parent=$self->tail();
252 if($self->is($TYPE_BOOL, $parent) &&
253 $parent->{name} eq "NOT")
257 if($allownot && $name eq "NOT")
259 $self->state($STATE_BOOLEAN);
260 push(@{$self->{elements}}, ID3FS::Path::Node->new($self->{db}, $TYPE_BOOL, $name));
264 my $tag=ID3FS::Path::Node->new($self->{db}, $TYPE_TAG, $name);
267 push(@{$self->{elements}}, $tag);
269 $self->state($STATE_TAG);
273 $self->state($STATE_INVALID);
277 elsif($state==$STATE_ALBUMS)
279 # print "SM: ALBUM: $name\n";
280 if($name eq $PATH_ALLTRACKS)
282 $self->state($STATE_TRACKLIST);
284 elsif($name eq $PATH_NOALBUM)
286 $self->state($STATE_TRACKLIST);
290 my $album=ID3FS::Path::Node->new($self->{db}, $TYPE_ALBUM, $name);
293 push(@{$self->{elements}}, $album);
294 $self->state($STATE_TRACKLIST);
298 $self->state($STATE_INVALID);
302 elsif($state==$STATE_TRACKLIST)
304 # print "SM: TRACKLIST: $name\n";
305 my $track=ID3FS::Path::Node->new($self->{db}, $TYPE_FILE, $name);
308 push(@{$self->{elements}}, $track);
309 $self->state($STATE_FILE);
313 $self->state($STATE_INVALID);
316 elsif($state==$STATE_FILE)
318 # print "SM: FILE: $name\n";
319 # Can't have anything after a filename
320 $self->state($STATE_INVALID);
322 elsif($state==$STATE_ALL)
324 if($name eq $PATH_ALLTRACKS)
326 $self->state($STATE_TRACKLIST);
328 elsif($name eq $PATH_NOARTIST)
330 $self->state($STATE_TRACKLIST);
334 my $artist=ID3FS::Path::Node->new($self->{db}, $TYPE_ARTIST, $name);
337 push(@{$self->{elements}}, $artist);
338 $self->state($STATE_ALBUMS);
342 $self->state($STATE_INVALID);
348 print "SM: ERROR: UNKNOWN STATE: $self->{state}\n";
349 $self->state($STATE_INVALID);
353 my @elements=@{$self->{elements}};
354 # remove trailing boolean
355 while(@elements && $self->is($TYPE_BOOL, $elements[$#elements]))
359 # print "\nELEMENTS: ", join(' ', map { $_->name(); } @elements), "\n";
360 my @joins=$self->number_joins(@elements);
361 # @joins=qw(INNER) unless(@joins);
362 $self->{joins}=\@joins;
363 # print "AFTER: ", join(' ', map { $_->name() . "(" . $_->{table} . ")"; } @elements), "\n";
364 # print "JOINS: ", join(', ', @joins), "\n";
365 # sort elements by precedence
366 @elements=$self->sort_elements(@elements);
367 $self->{tagtree}=$self->elements_to_tree(\@elements);
372 my($self, @elements)=@_;
376 return () unless(@elements);
377 while(my $thing=shift @elements)
379 if($thing->type() == $TYPE_BOOL)
381 my $op=$thing->name();
385 push(@joins, "INNER");
389 unless($lastop && $lastop eq "AND")
391 push(@joins, "LEFT");
397 if($lastop && $lastop eq "NOT")
400 push(@joins, "INNER");
407 # skip tags with values
408 if(@elements && $elements[0]->type() == $TYPE_TAG)
410 $thing=shift(@elements);
412 $thing->table($table);
420 my($self, $newstate)=@_;
421 if(defined($newstate))
423 $self->{state}=$newstate;
424 $self->{curtagdepth}++ if($newstate == $STATE_TAG);
426 return $self->{state};
429 # link up precedence-sorted list into a binary tree
432 my($self, $elements)=@_;
433 return undef unless(@$elements);
434 my ($left, $right, $op)=(undef, undef, undef);
435 my $thing=pop @$elements;
436 if($self->is($TYPE_BOOL, $thing))
438 $right=$self->elements_to_tree($elements);
439 if($thing->{name} ne "NOT")
441 $left=$self->elements_to_tree($elements);
444 $thing->right($right);
449 # Dijkstra's shunting-yard algorithm
452 my ($self, @input)=@_;
455 while(my $thing = shift @input)
457 if($self->is($TYPE_TAG, $thing))
459 # Handle tag values by dropping parent
460 if(@input && $self->is($TYPE_TAG, $input[0]))
464 push(@output, $thing);
466 elsif($self->is($TYPE_BOOL, $thing))
469 ($priorities{$thing->{name}} <= $priorities{$opstack[$#opstack]->{name}}))
471 push(@output, pop(@opstack));
473 push(@opstack, $thing);
478 push(@output, pop(@opstack));
486 return() unless(defined($self->{tagtree}));
487 return($self->{tagtree}->used_tags());
493 my $tail=$self->tail();
494 if($self->is($TYPE_TAG, $tail))
496 return($self->{db}->tag_has_values($tail->id()));
503 my $tail=$self->tail();
504 if($self->is($TYPE_TAG, $tail))
511 sub trailing_tag_parent
514 my $tail=$self->tail();
515 if($self->is($TYPE_TAG, $tail))
517 return($tail->{parents_id});
525 return($self->{elements}->[$#{$self->{elements}}]);
530 my($self, $type, $thing)=@_;
531 return 0 unless($thing);
532 return 0 unless($thing->type());
533 return 1 if($type == $thing->type());
537 # the one before last
541 return($self->{elements}->[($#{$self->{elements}}) - 1]);
544 ######################################################################
549 if(!$self->{tagtree}) # / or /NOT
551 my $sql="SELECT DISTINCT name FROM tags WHERE parents_id='';";
552 return($self->{db}->cmd_firstcol($sql));
554 my $hasvals=$self->expecting_values();
555 my $sql="SELECT tags.name FROM ";
556 if($self->want_all_tags())
558 $sql .= "files_x_tags\n";
563 $self->tags_subselect() .
565 "INNER JOIN files_x_tags ON subselect.files_id=files_x_tags.files_id\n");
567 $sql .= "INNER JOIN tags ON files_x_tags.tags_id=tags.id\n";
569 my $id=$self->trailing_tag_id();
571 my $parentclause= "tags.parents_id='";
572 $parentclause .= $id if($hasvals);
573 $parentclause .= "'";
574 push(@andclauses, $parentclause);
576 my @used=$self->used_tags();
579 push(@andclauses, "tags.id NOT IN (" . join(', ', @used) . ")");
583 $sql .= "WHERE " . join(' AND ', @andclauses) . "\n";
586 $sql .= "GROUP BY tags.name;";
587 print "SQL(TAGS): $sql\n" if($self->{verbose});
588 my @tagnames=$self->{db}->cmd_firstcol($sql);
589 print("SUBNAMES: ", join(', ', @tagnames), "\n") if($self->{verbose});
596 if(!@{$self->{elements}}) # /ALL
598 my $sql="SELECT DISTINCT name FROM artists WHERE name!='';";
599 return($self->{db}->cmd_firstcol($sql));
601 my $sql=$self->sql_start("artists.name");
602 $sql .= ("INNER JOIN artists ON files.artists_id=artists.id\n" .
603 "WHERE artists.name != ''\n" .
604 "GROUP BY artists.name;");
605 print "SQL(ARTISTS): $sql\n" if($self->{verbose});
606 my @tagnames=$self->{db}->cmd_firstcol($sql);
607 print("ARTISTS: ", join(', ', @tagnames), "\n") if($self->{verbose});
614 my $tail=$self->tail();
615 if($self->is($TYPE_ARTIST, $tail))
617 return $self->artist_albums($tail->id());
619 my $sql=$self->sql_start("albums.name");
620 $sql .= ("INNER JOIN albums ON files.albums_id=albums.id\n" .
621 "WHERE albums.name != ''\n" .
622 "GROUP BY albums.name;");
623 print "SQL(ALBUMS): \n$sql\n" if($self->{verbose});
624 my @names=$self->{db}->cmd_firstcol($sql);
625 print("ALBUMS: ", join(', ', @names), "\n") if($self->{verbose});
631 my($self, $artist_id)=@_;
632 my $sql=$self->sql_start("albums.name");
633 $sql .= ("INNER JOIN albums ON albums.id=files.albums_id\n" .
634 "INNER JOIN artists ON artists.id=files.artists_id\n" .
635 "WHERE artists.id=? and albums.name <> ''\n" .
636 "GROUP BY albums.name\n");
637 print "ARTIST_ALBUMS SQL: $sql\n" if($self->{verbose});
638 my @albums=$self->{db}->cmd_firstcol($sql, $artist_id);
639 print("ALBUMS: ", join(', ', @albums), "\n") if($self->{verbose});
645 my($self, $artist_id)=@_;
646 my $sql=$self->sql_start("files.name");
647 $sql .= ("INNER JOIN artists ON artists.id=files.artists_id\n" .
648 "INNER JOIN albums ON albums.id=files.albums_id\n" .
649 "WHERE artists.id=? AND albums.name=''\n" .
650 "GROUP BY files.name\n");
651 print "ARTIST_TRACKS SQL: $sql\n" if($self->{verbose});
652 my @names=$self->{db}->cmd_firstcol($sql, $artist_id);
653 print("ARTISTTRACKS: ", join(', ', @names), "\n") if($self->{verbose});
659 my($self, $artist_id, $album_id)=@_;
660 my $sql=("SELECT files.name FROM files\n" .
661 "INNER JOIN albums ON albums.id=files.albums_id\n" .
662 "INNER JOIN artists ON artists.id=files.artists_id\n" .
663 "WHERE artists.id=? AND albums.id=?\n" .
664 "GROUP BY files.name\n");
665 print "ALBUM_TRACKS SQL($artist_id, $album_id): $sql\n" if($self->{verbose});
666 my @names=$self->{db}->cmd_firstcol($sql, $artist_id, $album_id);
667 print("TRACKS: ", join(', ', @names), "\n") if($self->{verbose});
674 my $tail=$self->tail();
675 if($self->is($TYPE_ARTIST, $tail))
677 return $self->artist_tracks($tail->id());
679 elsif($self->is($TYPE_ALBUM, $tail))
682 my $artist=$self->tail_parent();
683 if($self->is($TYPE_ARTIST, $artist))
685 # should always happen
686 $artist_id=$artist->id();
688 return $self->album_tracks($artist_id, $tail->id());
690 my $sql=$self->sql_start("files.name");
691 $sql .= "INNER JOIN artists ON files.artists_id=artists.id\n";
692 if($self->{components}->[$#{$self->{components}}] eq $PATH_NOARTIST)
694 $sql .= "WHERE artists.name =''\n";
696 $sql .= "GROUP BY files.name;";
697 print "TRACKS SQL($self->{path}): $sql\n" if($self->{verbose});
698 my @names=$self->{db}->cmd_firstcol($sql);
699 print("TRACKS: ", join(', ', @names), "\n") if($self->{verbose});
705 my($self, $mountpoint)=@_;
706 my $tail=$self->tail();
707 if($self->is($TYPE_FILE, $tail))
710 my $sql=("SELECT paths.name, files.name FROM files\n" .
711 "INNER JOIN paths ON files.paths_id=paths.id\n" .
712 "WHERE files.id=?\n" .
713 "GROUP BY paths.name, files.name");
714 print "FILENAME SQL: $sql\n" if($self->{verbose});
715 my ($path, $name)=$self->{db}->cmd_onerow($sql, $id);
716 return($self->{db}->relativise($path, $name, $mountpoint, $self->{path}));
718 # should never happen
725 my $hasvals=$self->expecting_values();
726 my $tree=$self->{tagtree};
728 # print Dumper $tree;
729 my ($sqlclause, @joins)=$tree->to_sql($hasvals) if($tree);
730 my $sql="\tSELECT fxt1.files_id FROM tags t1";
733 @joins=@{$self->{joins}};
734 for(my $i=0; $i <= $#joins; $i++)
738 my $inner=("\t$join JOIN files_x_tags fxt$cnt ON " .
739 "t${cnt}.id=fxt${cnt}.tags_id");
742 push(@crosses, "CROSS JOIN tags t$cnt");
743 $inner .= " AND fxt1.files_id=fxt${cnt}.files_id";
745 push(@inners, $inner);
747 $sql .= ("\n\t" . join(" ", @crosses)) if(@crosses);
748 $sql .= ("\n" . join("\n", @inners)) if(@inners);
749 $sql .= "\n\tWHERE $sqlclause" if($sqlclause);
750 $sql .= "\n\tGROUP BY fxt1.files_id\n";
756 my($self, $tables)=@_;
757 my $sql="SELECT $tables FROM ";
765 $self->tags_subselect() .
767 "INNER JOIN files ON subselect.files_id=files.id\n");
772 # we just filter $ALLTRACKS, $NOARTIST and $NOALBUM
773 # filtering tags properly requires up to four levels of recursion
774 # (tag/tagval/AND/NOT) and is too slow
778 return(@dirs) unless($ENABLE_FILTER);
779 my $base=$self->{path};
783 push(@outdirs, $dir) unless($self->empty("$base/$dir"));
791 my $path=ID3FS::Path->new($self->{db}, $dir, $self->{verbose},
792 ($self->{maxtagdepth} - $self->{curtagdepth}));
793 return 1 unless($path->isvalid());
794 my($subdirs,$subfiles)=$path->dirents();
795 return 0 if(@$subfiles || @$subdirs);
799 # if path is .../OR/ or .../OR/NOT or .../AND/NOT
803 my $tail=$self->tail();
804 return 0 unless($tail);
805 my $parent=$self->tail_parent();
806 my $parent_valid = ($parent && $parent->type() == $TYPE_BOOL);
807 if($tail->type() == $TYPE_BOOL)
809 return 1 if($tail->name() eq "OR");
810 return 0 unless($tail->name() eq "NOT");
811 return 0 unless($parent_valid);
812 return 1 if($parent->name() eq "OR");
813 return 1 if($parent->name() eq "AND");
815 elsif($tail->type() == $TYPE_TAG)
817 return 0 unless($parent_valid);
818 return 1 if($parent->name() eq "NOT");