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_TAGVAL,
24 $STATE_BOOLEAN, $STATE_ALBUMS, $STATE_TRACKLIST,
25 $STATE_FILE, $STATE_ALL)=(0..8);
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 || $state==$STATE_TAGVAL)
102 my $tail=$self->tail();
103 if($state==$STATE_TAG && $self->is($TYPE_TAG, $tail) &&
104 $self->{db}->tag_has_values($self->tail()->id()))
106 @dents=$self->tags();
110 if($self->{maxtagdepth} && ($self->{curtagdepth} < $self->{maxtagdepth}))
114 push(@dents, $self->filter($PATH_ALLTRACKS, $PATH_NOARTIST), $self->artists());
117 elsif($state==$STATE_BOOLEAN)
119 my $parent=$self->tail();
120 unless($self->is($TYPE_BOOL, $parent) &&
121 $parent->{name} eq "NOT")
125 push(@dents,$self->tags());
127 elsif($state==$STATE_ROOT)
129 @dents=(qw(ALL NOT), $self->tags());
131 elsif($state==$STATE_ALBUMS)
133 @dents=$self->filter($PATH_ALLTRACKS, $PATH_NOALBUM, $self->albums());
135 elsif($state==$STATE_TRACKLIST)
137 @fents=$self->tracks();
141 print "DIRENTS: UNHANDLED STATE: $state\n";
143 return(\@dents, \@fents);
146 # State Machine Of Doom
150 @{$self->{components}}=split(/\//, $self->{path});
151 shift @{$self->{components}}; # drop empty field before leading /
152 # print "PATH: $self->{path}\n";
153 $self->state($STATE_ROOT);
154 return if($self->{path} eq "/");
155 my @parts=@{$self->{components}};
157 $self->{elements}=[];
161 while(defined(my $name=shift @parts))
163 # print "NAME: $name\n";
164 my $state=$self->state();
165 if($state==$STATE_INVALID)
167 # print "SM: INVALID: $name\n";
170 elsif($state==$STATE_ROOT)
172 # print "SM: ROOT: $name\n";
176 $self->state($STATE_ALL);
178 elsif($name eq "NOT")
181 push(@{$self->{elements}}, ID3FS::Path::Node->new($self->{db}, $TYPE_BOOL, $name));
182 $self->state($STATE_BOOLEAN);
186 $tag=ID3FS::Path::Node->new($self->{db}, $TYPE_TAG, $name);
189 push(@{$self->{elements}}, $tag);
191 $self->state($STATE_TAG);
195 $self->state($STATE_INVALID);
199 elsif($state==$STATE_TAG || $state==$STATE_TAGVAL)
201 my $tag=$self->tail();
202 # print "SM: TAG/TAGVAL($state): $name\n";
203 if($state==$STATE_TAG && $self->is($TYPE_TAG, $tag) &&
204 $self->{db}->tag_has_values($tag->id()))
206 # print "Parsing: parent: $tag->id()\n";
207 my $tagval=ID3FS::Path::Node->new($self->{db}, $TYPE_TAG, $name, $tag->id());
210 $self->state($STATE_TAGVAL);
212 push(@{$self->{elements}}, $tagval);
216 $self->state($STATE_INVALID);
219 elsif($name eq $PATH_ALLTRACKS)
221 $self->state($STATE_TRACKLIST);
223 elsif($name eq $PATH_NOARTIST)
225 $self->state($STATE_TRACKLIST);
227 elsif($name eq "AND")
229 $self->state($STATE_BOOLEAN);
230 push(@{$self->{elements}}, ID3FS::Path::Node->new($self->{db}, $TYPE_BOOL, $name));
234 $self->state($STATE_BOOLEAN);
235 push(@{$self->{elements}}, ID3FS::Path::Node->new($self->{db}, $TYPE_BOOL, $name));
239 my $artist=ID3FS::Path::Node->new($self->{db}, $TYPE_ARTIST, $name);
242 push(@{$self->{elements}}, $artist);
243 $self->state($STATE_ALBUMS);
247 $self->state($STATE_INVALID);
251 elsif($state==$STATE_BOOLEAN)
253 # print "SM: BOOLEAN: $name\n";
254 my $parent=$self->tail();
256 if($self->is($TYPE_BOOL, $parent) &&
257 $parent->{name} eq "NOT")
261 if($allownot && $name eq "NOT")
263 $self->state($STATE_BOOLEAN);
264 push(@{$self->{elements}}, ID3FS::Path::Node->new($self->{db}, $TYPE_BOOL, $name));
268 my $tag=ID3FS::Path::Node->new($self->{db}, $TYPE_TAG, $name);
271 push(@{$self->{elements}}, $tag);
273 $self->state($STATE_TAG);
277 $self->state($STATE_INVALID);
281 elsif($state==$STATE_ALBUMS)
283 # print "SM: ALBUM: $name\n";
284 if($name eq $PATH_ALLTRACKS)
286 $self->state($STATE_TRACKLIST);
288 elsif($name eq $PATH_NOALBUM)
290 $self->state($STATE_TRACKLIST);
294 my $album=ID3FS::Path::Node->new($self->{db}, $TYPE_ALBUM, $name);
297 push(@{$self->{elements}}, $album);
298 $self->state($STATE_TRACKLIST);
302 $self->state($STATE_INVALID);
306 elsif($state==$STATE_TRACKLIST)
308 # print "SM: TRACKLIST: $name\n";
309 my $track=ID3FS::Path::Node->new($self->{db}, $TYPE_FILE, $name);
312 push(@{$self->{elements}}, $track);
313 $self->state($STATE_FILE);
317 $self->state($STATE_INVALID);
320 elsif($state==$STATE_FILE)
322 # print "SM: FILE: $name\n";
323 # Can't have anything after a filename
324 $self->state($STATE_INVALID);
326 elsif($state==$STATE_ALL)
328 if($name eq $PATH_ALLTRACKS)
330 $self->state($STATE_TRACKLIST);
332 elsif($name eq $PATH_NOARTIST)
334 $self->state($STATE_TRACKLIST);
338 my $artist=ID3FS::Path::Node->new($self->{db}, $TYPE_ARTIST, $name);
341 push(@{$self->{elements}}, $artist);
342 $self->state($STATE_ALBUMS);
346 $self->state($STATE_INVALID);
352 print "SM: ERROR: UNKNOWN STATE: $self->{state}\n";
353 $self->state($STATE_INVALID);
357 # remove trailing boolean
358 my @elements=@{$self->{elements}};
359 while(@elements && $self->is($TYPE_BOOL, $elements[$#elements]))
363 # sort elements by precedence
364 @elements=$self->sort_elements(@elements);
365 $self->{tagtree}=$self->elements_to_tree(\@elements);
370 # print Dumper $self->{tagtree};
371 # my ($conditions, @joins)=$self->{tagtree}->to_sql();
372 # print "CONDITIONS(", scalar(@joins), "): ", $conditions, "\n";
378 my($self, $newstate)=@_;
379 if(defined($newstate))
381 $self->{state}=$newstate;
382 $self->{curtagdepth}++ if($newstate == $STATE_TAG);
384 return $self->{state};
389 my($self, $elements)=@_;
390 return undef unless(@$elements);
391 my ($left, $right, $op)=(undef, undef, undef);
392 my $thing=pop @$elements;
393 if($self->is($TYPE_BOOL, $thing))
395 $right=$self->elements_to_tree($elements);
396 if($thing->{name} ne "NOT")
398 $left=$self->elements_to_tree($elements);
401 $thing->right($right);
406 # Dijkstra's shunting-yard algorithm
409 my ($self, @input)=@_;
412 # print "INPUT: ", join(', ', map { $_->{name}; } @input), "\n";
413 while(my $thing = shift @input)
415 if($self->is($TYPE_TAG, $thing))
417 # Handle tag values by dropping parent
418 if(@input && $self->is($TYPE_TAG, $input[0]))
422 push(@output, $thing);
424 elsif($self->is($TYPE_BOOL, $thing))
428 ($priorities{$thing->{name}} <= $priorities{$opstack[$#opstack]->{name}}))
430 push(@output, pop(@opstack));
432 push(@opstack, $thing);
437 push(@output, pop(@opstack));
439 # print "STACK: ", join(', ', map { $_->{name}; } @output), "\n";
446 return() unless(defined($self->{tagtree}));
447 return($self->{tagtree}->used_tags());
453 my $tail=$self->tail();
454 if($self->is($TYPE_TAG, $tail))
456 return($self->{db}->tag_has_values($tail->id()));
463 my $tail=$self->tail();
464 if($self->is($TYPE_TAG, $tail))
471 sub trailing_tag_parent
474 my $tail=$self->tail();
475 if($self->is($TYPE_TAG, $tail))
477 return($tail->{parents_id});
485 return($self->{elements}->[$#{$self->{elements}}]);
490 my($self, $type, $thing)=@_;
491 return 0 unless($thing);
492 return 0 unless($thing->type());
493 return 1 if($type == $thing->type());
497 # the one before last
501 return($self->{elements}->[($#{$self->{elements}}) - 1]);
504 ######################################################################
509 if(!$self->{tagtree}) # / or /NOT
511 my $sql="SELECT DISTINCT name FROM tags WHERE parents_id='';";
512 return($self->{db}->cmd_firstcol($sql));
514 my $hasvals=$self->expecting_values();
515 my $parent=$self->trailing_tag_parent();
516 # print "THASVALS: $hasvals\n";
517 # print "TPARENT: ", (defined($parent)? $parent : "NO"), "\n";
519 my $sql="SELECT tags.name FROM ";
522 $sql .= "files_x_tags\n";
527 $self->tags_subselect() .
529 "INNER JOIN files_x_tags ON subselect.files_id=files_x_tags.files_id\n");
531 $sql .= "INNER JOIN tags ON files_x_tags.tags_id=tags.id\n";
533 my $id=$self->trailing_tag_id();
535 my $parentclause= "tags.parents_id='";
538 $parentclause .= $id;
542 $parentclause .= $parent;
544 $parentclause .= "'";
545 push(@andclauses, $parentclause);
547 my @used=$self->used_tags();
550 push(@andclauses, "tags.id NOT IN (" . join(', ', @used) . ")");
554 $sql .= "WHERE " . join(' AND ', @andclauses) . "\n";
557 $sql .= "GROUP BY tags.name;";
558 print "SQL(TAGS): $sql\n" if($self->{verbose});
559 my @tagnames=$self->{db}->cmd_firstcol($sql);
560 print("SUBNAMES: ", join(', ', @tagnames), "\n") if($self->{verbose});
567 if(!@{$self->{elements}}) # /ALL
569 my $sql="SELECT DISTINCT name FROM artists WHERE name!='';";
570 return($self->{db}->cmd_firstcol($sql));
573 my $sql=$self->sql_start("artists.name");
574 $sql .= ("INNER JOIN artists ON files.artists_id=artists.id\n" .
575 "WHERE artists.name != ''\n" .
576 "GROUP BY artists.name;");
577 print "SQL(ARTISTS): $sql\n" if($self->{verbose});
578 my @tagnames=$self->{db}->cmd_firstcol($sql);
579 print("ARTISTS: ", join(', ', @tagnames), "\n") if($self->{verbose});
587 my $tail=$self->tail();
588 if($self->is($TYPE_ARTIST, $tail))
590 return $self->artist_albums($tail->id());
592 my $sql=$self->sql_start("albums.name");
593 $sql .= ("INNER JOIN albums ON files.albums_id=albums.id\n" .
594 "WHERE albums.name != ''\n" .
595 "GROUP BY albums.name;");
596 print "SQL(ALBUMS): \n$sql\n" if($self->{verbose});
597 my @names=$self->{db}->cmd_firstcol($sql);
598 print("ALBUMS: ", join(', ', @names), "\n") if($self->{verbose});
604 my($self, $artist_id)=@_;
605 my $sql=$self->sql_start("albums.name");
606 $sql .= ("INNER JOIN albums ON albums.id=files.albums_id\n" .
607 "INNER JOIN artists ON artists.id=files.artists_id\n" .
608 "WHERE artists.id=? and albums.name <> ''\n" .
609 "GROUP BY albums.name\n");
610 print "ARTIST_ALBUMS SQL: $sql\n" if($self->{verbose});
611 my @albums=$self->{db}->cmd_firstcol($sql, $artist_id);
612 print("ALBUMS: ", join(', ', @albums), "\n") if($self->{verbose});
618 my($self, $artist_id)=@_;
619 my $sql=$self->sql_start("files.name");
620 $sql .= ("INNER JOIN artists ON artists.id=files.artists_id\n" .
621 "INNER JOIN albums ON albums.id=files.albums_id\n" .
622 "WHERE artists.id=? AND albums.name=''\n" .
623 "GROUP BY files.name\n");
624 print "ARTIST_TRACKS SQL: $sql\n" if($self->{verbose});
625 my @names=$self->{db}->cmd_firstcol($sql, $artist_id);
626 print("ARTISTTRACKS: ", join(', ', @names), "\n") if($self->{verbose});
632 my($self, $artist_id, $album_id)=@_;
633 my $sql=("SELECT files.name FROM files\n" .
634 "INNER JOIN albums ON albums.id=files.albums_id\n" .
635 "INNER JOIN artists ON artists.id=files.artists_id\n" .
636 "WHERE artists.id=? AND albums.id=?\n" .
637 "GROUP BY files.name\n");
638 print "ALBUM_TRACKS SQL($artist_id, $album_id): $sql\n" if($self->{verbose});
639 my @names=$self->{db}->cmd_firstcol($sql, $artist_id, $album_id);
640 print("TRACKS: ", join(', ', @names), "\n") if($self->{verbose});
647 my $tail=$self->tail();
648 if($self->is($TYPE_ARTIST, $tail))
650 return $self->artist_tracks($tail->id());
652 elsif($self->is($TYPE_ALBUM, $tail))
655 my $artist=$self->tail_parent();
656 if($self->is($TYPE_ARTIST, $artist))
658 # should always happen
659 $artist_id=$artist->id();
661 return $self->album_tracks($artist_id, $tail->id());
663 my $sql=$self->sql_start("files.name");
664 $sql .= "INNER JOIN artists ON files.artists_id=artists.id\n";
665 if($self->{components}->[$#{$self->{components}}] eq $PATH_NOARTIST)
667 $sql .= "WHERE artists.name =''\n";
669 $sql .= "GROUP BY files.name;";
670 print "TRACKS SQL($self->{path}): $sql\n" if($self->{verbose});
671 my @names=$self->{db}->cmd_firstcol($sql);
672 print("TRACKS: ", join(', ', @names), "\n") if($self->{verbose});
678 my($self, $mountpoint)=@_;
679 my $tail=$self->tail();
680 if($self->is($TYPE_FILE, $tail))
683 my $sql=("SELECT paths.name, files.name FROM files\n" .
684 "INNER JOIN paths ON files.paths_id=paths.id\n" .
685 "WHERE files.id=?\n" .
686 "GROUP BY paths.name, files.name");
687 print "FILENAME SQL: $sql\n" if($self->{verbose});
688 my ($path, $name)=$self->{db}->cmd_onerow($sql, $id);
689 my $id3fs_path=join('/', map { $_->{name}; } @{$self->{elements}});
690 return($self->{db}->relativise($path, $name, $mountpoint, $self->{path}));
692 # should never happen
699 my $hasvals=$self->expecting_values();
700 my $tree=$self->{tagtree};
701 my $parent=$self->trailing_tag_parent();
706 $tag=$self->trailing_tag_id();
707 # print "Trailing id: $tag\n";
709 my ($sqlclause, @joins)=(undef, ());
710 ($sqlclause, @joins) = $tree->to_sql($hasvals) if($tree);
711 # print "SQL(" . scalar(@joins) ."): $sqlclause\n";
712 my $sql="\tSELECT fxt1.files_id FROM tags t1";
715 # $joinsneeded++ if($tag);
716 for(my $i=0; $i <= $#joins; $i++)
720 my $inner=("\t$join JOIN files_x_tags fxt$cnt ON " .
721 "t${cnt}.id=fxt${cnt}.tags_id");
724 push(@crosses, "CROSS JOIN tags t$cnt");
725 $inner .= " AND fxt1.files_id=fxt${cnt}.files_id";
727 push(@inners, $inner);
729 $sql .= ("\n\t" . join(" ", @crosses)) if(@crosses);
730 $sql .= ("\n" . join("\n", @inners)) if(@inners);
731 $sql .= "\n\tWHERE $sqlclause" if($sqlclause);
734 # $sql .= " AND t${joinsneeded}.parents_id='$tag'";
736 $sql .= "\n\tGROUP BY fxt1.files_id\n";
742 my($self, $tables)=@_;
743 my $sql="SELECT $tables FROM ";
751 $self->tags_subselect() .
753 "INNER JOIN files ON subselect.files_id=files.id\n");
758 # we just filter $ALLTRACKS, $NOARTIST and $NOALBUM
759 # filtering tags properly requires up to four levels of recursion
760 # (tag/tagval/AND/NOT) and is too slow
764 return(@dirs) unless($ENABLE_FILTER);
765 my $base=$self->{path};
769 # print "\nFILTER (",$self->state(), "): $base / $dir\n";
770 if($self->empty("$base/$dir"))
772 # print "empty: $base / $dir\n";
776 # print "non-empty, accepting: $base / $dir\n";
777 push(@outdirs, $dir);
786 my $path=ID3FS::Path->new($self->{db}, $dir, $self->{verbose},
787 ($self->{maxtagdepth} - $self->{curtagdepth}));
788 return 1 unless($path->isvalid());
789 my($subdirs,$subfiles)=$path->dirents();
790 return 0 if(@$subfiles || @$subdirs);
794 # if path is .../OR/ or .../OR/NOT
798 my $tail=$self->tail();
799 return 0 unless($tail);
800 return 0 unless($tail->type() == $TYPE_BOOL);
801 return 1 if($tail->name() eq "OR");
802 return 0 unless($tail->name() eq "NOT");
803 my $parent=$self->tail_parent();
804 return 0 unless($parent);
805 return 0 unless($parent->type() == $TYPE_BOOL);
806 return 1 if($parent->name() eq "OR");