lib/ID3FS/Path.pm

   1 package ID3FS::Path;
   2
   3 use strict;
   4 use warnings;
   5 use ID3FS::PathElement::Artist;
   6 use ID3FS::PathElement::Album;
   7 use ID3FS::PathElement::Boolean;
   8 use ID3FS::PathElement::File;
   9 use ID3FS::PathElement::Tag;
  10 use ID3FS::PathElement::Tagval;
  11 use ID3FS::Path::Node;
  12
  13 our ($STATE_INVALID, $STATE_ROOT, $STATE_TAG, $STATE_TAGVAL,
  14      $STATE_BOOLEAN, $STATE_ALBUMS, $STATE_TRACKLIST,
  15      $STATE_FILE)=(0..7);
  16
  17 our %priorities=( "OR" => 0, "AND" => 1, "NOT" => 2 );
  18
  19 sub new
  20 {
  21     my $proto=shift;
  22     my $class=ref($proto) || $proto;
  23     my $self={};
  24     bless($self,$class);
  25
  26     $self->{elements}=[];
  27     $self->{db}=shift;
  28     $self->{path}=shift;
  29     $self->parse();
  30 #    print "STATE: ", $self->state(), "\n";
  31     return $self;
  32 }
  33
  34 sub isdir
  35 {
  36     my($self)=@_;
  37     if(($self->state() == $STATE_FILE) ||
  38        ($self->state() == $STATE_INVALID))
  39     {
  40         return 0;
  41     }
  42     return 1;
  43 }
  44
  45 sub isfile
  46 {
  47     my($self)=@_;
  48     return 1 if($self->state() == $STATE_FILE);
  49     return 0;
  50 }
  51
  52 sub isvalid
  53 {
  54     my($self)=@_;
  55     return($self->state() != $STATE_INVALID);
  56 }
  57
  58 sub dest
  59 {
  60     my($self, $mountpoint)=@_;
  61     if($self->state() == $STATE_FILE)
  62     {
  63         return $self->{db}->filename($mountpoint, $self);
  64     }
  65     return "ERROR"; #should never happen?
  66 }
  67
  68 sub dirents
  69 {
  70     my($self)=@_;
  71     my @dents=();
  72     my $state=$self->state();
  73 #    print "DIRENTS: STATE: $state\n";
  74 #    print "DIRENTS: FILE: $self->{path}\n";
  75     if($state==$STATE_TAG || $state==$STATE_TAGVAL)
  76     {
  77         my $tag=$self->{elements}->[$#{$self->{elements}}];
  78         if($state==$STATE_TAG &&
  79            defined($tag) &&
  80            ref($tag) eq "ID3FS::PathElement::Tag" &&
  81            $self->{db}->tag_has_values($tag->{id}))
  82         {
  83             @dents=$self->{db}->tags($self);
  84         }
  85         else
  86         {
  87             @dents=(qw(AND OR TRACKS NOARTIST),
  88                     $self->{db}->artists($self));
  89         }
  90     }
  91     elsif($state==$STATE_BOOLEAN)
  92     {
  93         my $parent=$self->{elements}->[$#{$self->{elements}}];
  94         unless(defined($parent) &&
  95                ref($parent) eq "ID3FS::PathElement::Boolean" &&
  96                $parent->{name} eq "NOT")
  97         {
  98             push(@dents, "NOT");
  99         }
 100         push(@dents, $self->{db}->tags($self));
 101     }
 102     elsif($state==$STATE_ROOT)
 103     {
 104         @dents=(qw(ALL NOT), $self->{db}->tags($self));
 105     }
 106     elsif($state==$STATE_ALBUMS)
 107     {
 108         @dents=(qw(TRACKS NOALBUM),$self->{db}->albums($self));
 109     }
 110     elsif($state==$STATE_TRACKLIST)
 111     {
 112         @dents=$self->{db}->tracks($self);
 113     }
 114     else
 115     {
 116         print "DIRENTS: UNHANDLED STATE: $state\n";
 117     }
 118     return(@dents);
 119 }
 120
 121 sub parse
 122 {
 123     my($self)=@_;
 124     @{$self->{components}}=split(/\//, $self->{path});
 125     shift @{$self->{components}}; # drop empty field before leading /
 126 #    print "PATH: $self->{path}\n";
 127     $self->state($STATE_ROOT);
 128     return if($self->{path} eq "/");
 129     my @parts=@{$self->{components}};
 130     my($tag, $tagval);
 131     $self->{elements}=[];
 132     while(my $name=shift @parts)
 133     {
 134 #       print "NAME: $name\n";
 135         my $state=$self->state();
 136         if($state==$STATE_INVALID)
 137         {
 138 #           print "SM: INVALID: $name\n";
 139             return;
 140         }
 141         elsif($state==$STATE_ROOT)
 142         {
 143 #           print "SM: ROOT: $name\n";
 144             if($name eq "ALL")
 145             {
 146                 $self->state($STATE_TAG);
 147             }
 148             elsif($name eq "NOT")
 149             {
 150                 push(@{$self->{elements}}, ID3FS::PathElement::Boolean->new($self->{db}, $name));
 151                 $self->state($STATE_BOOLEAN);
 152             }
 153             else
 154             {
 155                 $tag=ID3FS::PathElement::Tag->new($self->{db}, $name);
 156                 if($tag)
 157                 {
 158                     push(@{$self->{elements}}, $tag);
 159                     $self->state($STATE_TAG);
 160                 }
 161                 else
 162                 {
 163                     $self->state($STATE_INVALID);
 164                 }
 165             }
 166         }
 167         elsif($state==$STATE_TAG || $state==$STATE_TAGVAL)
 168         {
 169 #           print "SM: TAG/TAGVAL($state): $name\n";
 170             my $tag=$self->{elements}->[$#{$self->{elements}}];
 171             if($state==$STATE_TAG &&
 172                defined($tag) &&
 173                ref($tag) eq "ID3FS::PathElement::Tag" &&
 174                $self->{db}->tag_has_values($tag->{id}))
 175             {
 176 #               print "Parsing: parent: $tag->{id}\n";
 177                 my $tagval=ID3FS::PathElement::Tag->new($self->{db}, $name, $tag->{id});
 178                 if(defined($tagval))
 179                 {
 180                     $self->state($STATE_TAGVAL);
 181                     # stay in tag state
 182                     push(@{$self->{elements}}, $tagval);
 183                 }
 184                 else
 185                 {
 186                     $self->state($STATE_INVALID);
 187                 }
 188             }
 189             elsif($name eq "TRACKS")
 190             {
 191                 $self->state($STATE_TRACKLIST);
 192             }
 193             elsif($name eq "NOARTIST")
 194             {
 195                 $self->state($STATE_TRACKLIST);
 196             }
 197             elsif($name eq "AND")
 198             {
 199                 $self->state($STATE_BOOLEAN);
 200                 push(@{$self->{elements}}, ID3FS::PathElement::Boolean->new($self->{db}, $name));
 201             }
 202             elsif($name eq "OR")
 203             {
 204                 $self->state($STATE_BOOLEAN);
 205                 push(@{$self->{elements}}, ID3FS::PathElement::Boolean->new($self->{db}, $name));
 206             }
 207             else
 208             {
 209                 my $artist=ID3FS::PathElement::Artist->new($self->{db}, $name);
 210                 if($artist)
 211                 {
 212                     push(@{$self->{elements}}, $artist);
 213                     $self->state($STATE_ALBUMS);
 214                 }
 215                 else
 216                 {
 217                     $self->state($STATE_INVALID);
 218                 }
 219             }
 220         }
 221         elsif($state==$STATE_BOOLEAN)
 222         {
 223 #           print "SM: BOOLEAN: $name\n";
 224             my $parent=$self->{elements}->[$#{$self->{elements}}];
 225             my $allownot=1;
 226             if(defined($parent) &&
 227                ref($parent) eq "ID3FS::PathElement::Boolean" &&
 228                $parent->{name} eq "NOT")
 229             {
 230                 $allownot=0;
 231             }
 232             if($allownot && $name eq "NOT")
 233             {
 234                 $self->state($STATE_BOOLEAN);
 235                 push(@{$self->{elements}}, ID3FS::PathElement::Boolean->new($self->{db}, $name));
 236             }
 237             else
 238             {
 239                 my $tag=ID3FS::PathElement::Tag->new($self->{db}, $name);
 240                 if($tag)
 241                 {
 242                     push(@{$self->{elements}}, $tag);
 243                     $self->state($STATE_TAG);
 244                 }
 245                 else
 246                 {
 247                     $self->state($STATE_INVALID);
 248                 }
 249             }
 250         }
 251         elsif($state==$STATE_ALBUMS)
 252         {
 253 #           print "SM: ALBUM: $name\n";
 254             if($name eq "TRACKS")
 255             {
 256                 $self->state($STATE_TRACKLIST);
 257             }
 258             elsif($name eq "NOALBUM")
 259             {
 260                 $self->state($STATE_TRACKLIST);
 261             }
 262             else
 263             {
 264                 my $album=ID3FS::PathElement::Album->new($self->{db}, $name);
 265                 if($album)
 266                 {
 267                     push(@{$self->{elements}}, $album);
 268                     $self->state($STATE_TRACKLIST);
 269                 }
 270                 else
 271                 {
 272                     $self->state($STATE_INVALID);
 273                 }
 274             }
 275         }
 276         elsif($state==$STATE_TRACKLIST)
 277         {
 278 #           print "SM: TRACKLIST: $name\n";
 279             my $track=ID3FS::PathElement::File->new($self->{db}, $name);
 280             if($track)
 281             {
 282                 push(@{$self->{elements}}, $track);
 283                 $self->state($STATE_FILE);
 284             }
 285             else
 286             {
 287                 $self->state($STATE_INVALID);
 288             }
 289         }
 290         elsif($state==$STATE_FILE)
 291         {
 292 #           print "SM: FILE: $name\n";
 293             # Can't have anything after a filename
 294             $self->state($STATE_INVALID);
 295         }
 296         else
 297         {
 298             print "SM: ERROR: UNKNOWN STATE: $self->{state}\n";
 299             $self->state($STATE_INVALID);
 300         }
 301     }
 302     # remove trailing boolean
 303     if(@{$self->{elements}} &&
 304        ref($self->{elements}->[$#{$self->{elements}}]) eq "ID3FS::PathElement::Boolean")
 305     {
 306         $self->{lastop}=pop @{$self->{elements}};
 307     }
 308     # sort elements by precedence
 309     @{$self->{elements}}=$self->sort_elements(@{$self->{elements}});
 310     $self->{tagtree}=$self->elements_to_tree([ @{$self->{elements}} ]);
 311     if($self->{tagtree})
 312     {
 313         ($self->{sqlconditions},
 314          $self->{andsneeded}) = $self->{tagtree}->to_sql();
 315 #       print("SQL CONDITION(", $self->{andsneeded}, "): ",
 316 #             $self->{sqlconditions}, "\n");
 317 #       use Data::Dumper;
 318 #       print Dumper $self->{tagtree};
 319     }
 320 }
 321
 322 sub state
 323 {
 324     my($self, $newstate)=@_;
 325     $self->{state}=$newstate if(defined($newstate));
 326     return $self->{state};
 327 }
 328
 329 sub elements_to_tree
 330 {
 331     my($self, $elements)=@_;
 332     return undef unless(@$elements);
 333     my ($left, $right, $op)=(undef, undef, undef);
 334     my $thing=pop @$elements;
 335     if(ref($thing) eq "ID3FS::PathElement::Boolean")
 336     {
 337         my $op=$thing;
 338         $right=$self->elements_to_tree($elements);
 339         if($op->{name} ne "NOT")
 340         {
 341             $left=$self->elements_to_tree($elements);
 342         }
 343         return ID3FS::Path::Node->new($left, $op, $right);
 344     }
 345     else
 346     {
 347         return ID3FS::Path::Node->new($thing);
 348     }
 349 }
 350
 351 # Dijkstra's shunting-yard algorithm
 352 sub sort_elements
 353 {
 354     my ($self, @input)=@_;
 355     my @opstack=();
 356     my @output=();
 357 #    print "INPUT: ", join(', ', map { $_->{name}; } @input), "\n";
 358     while(my $thing = shift @input)
 359     {
 360         if(ref($thing) eq "ID3FS::PathElement::Tag")
 361         {
 362 #           print "Pushing $thing->{name} to output\n";
 363             push(@output, $thing);
 364 #           print "OPSTACK: ", join(', ', map { $_->{name}; } @opstack), "\n";
 365 #           print "OUTPUT: ", join(', ', map { $_->{name}; } @output), "\n";
 366         }
 367         elsif(ref($thing) eq "ID3FS::PathElement::Boolean")
 368         {
 369 #           print "BOOL: $thing->{name}\n";
 370             # bool
 371 #           print "thing: $thing->{name}: $priorities{$thing->{name}} ";
 372             if(@opstack)
 373             {
 374 #               print("topop: ", $opstack[$#opstack]->{name},
 375 #                     ": ", $priorities{$opstack[$#opstack]->{name}}, "\n");
 376             }
 377             while(@opstack &&
 378                   ($priorities{$thing->{name}} <= $priorities{$opstack[$#opstack]->{name}}))
 379             {
 380 #               print "Pushing ", $opstack[$#opstack]->{name}, " from opstack to output\n";
 381                 push(@output, pop(@opstack));
 382 #               print "OPSTACK: ", join(', ', map { $_->{name}; } @opstack), "\n";
 383 #               print "OUTPUT: ", join(', ', map { $_->{name}; } @output), "\n";
 384             }
 385 #           print "Pushing $thing->{name} to opstack\n";
 386             push(@opstack, $thing);
 387 #           print "OPSTACK: ", join(', ', map { $_->{name}; } @opstack), "\n";
 388 #           print "OUTPUT: ", join(', ', map { $_->{name}; } @output), "\n";
 389         }
 390     }
 391     while(@opstack)
 392     {
 393         push(@output, pop(@opstack));
 394     }
 395 #    print "STACK: ", join(', ', map { $_->{name}; } @output), "\n";
 396     return @output;
 397 }
 398
 399 sub used_tags
 400 {
 401     my($self)=@_;
 402     print "TAGTREE UNDEF\n" unless(defined($self->{tagtree}));
 403     return undef unless(defined($self->{tagtree}));
 404     return($self->{tagtree}->used_tags());
 405 }
 406
 407 sub tag_has_values
 408 {
 409     my($self)=@_;
 410     my $tail=$self->{elements}->[$#{$self->{elements}}];
 411     if($tail && ref($tail) eq "ID3FS::PathElement::Tag")
 412     {
 413         return($self->{db}->tag_has_values($tail->{id}));
 414     }
 415 }
 416
 417 sub trailing_tag_id
 418 {
 419     my($self)=@_;
 420     my $tail=$self->{elements}->[$#{$self->{elements}}];
 421     if($tail && ref($tail) eq "ID3FS::PathElement::Tag")
 422     {
 423         return($tail->{id});
 424     }
 425     return undef;
 426 }
 427
 428 1;