lib/ID3FS/Fuse.pm

   1 # id3fs - a FUSE-based filesystem for browsing audio metadata
   2 # Copyright (C) 2010  Ian Beckwith <ianb@erislabs.net>
   3 #
   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.
   8 #
   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.
  13 #
  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/>.
  16
  17 package ID3FS::Fuse;
  18
  19 use strict;
  20 use warnings;
  21 use ID3FS::Path;
  22 use Fuse;
  23 use Cwd;
  24 use POSIX qw(EINVAL EROFS ENOENT EOPNOTSUPP S_IRUSR S_IRGRP S_IROTH S_IXUSR S_IXGRP S_IXOTH);
  25
  26 our ($TYPE_DIR, $TYPE_SYMLINK)=(0040, 0120);
  27 our $DEFAULT_MAXTAGDEPTH = 10;
  28
  29 sub new
  30 {
  31     my $proto=shift;
  32     my $class=ref($proto) || $proto;
  33     my $self={};
  34     bless($self,$class);
  35
  36     $self->{db}=shift;
  37     $self->{source}=shift;
  38     $self->{mountpoint}=Cwd::abs_path(shift);
  39     $self->{verbose}=shift;
  40     $self->{tagdepth}=shift;
  41     $self->{tagdepth}=$DEFAULT_MAXTAGDEPTH unless($self->{tagdepth});
  42     $self->{perms} = S_IRUSR() | S_IXUSR() | S_IRGRP() | S_IXGRP() | S_IROTH() | S_IXOTH();
  43
  44     return $self;
  45 }
  46
  47 sub run
  48 {
  49     my($self)=@_;
  50     Fuse::main(
  51         mountpoint  => $self->{mountpoint},
  52         threaded    => 0,
  53         debug       => ($self->{verbose} > 1),
  54         mountopts   => "allow_other,ro",
  55         getattr     => sub { $self->getattr(@_); },
  56         readlink    => sub { $self->readlink(@_); },
  57         getdir      => sub { $self->getdir(@_); },
  58
  59         # Not used
  60 #       mknod       => sub { $self->mknod(@_);       },
  61 #       mkdir       => sub { $self->mkdir(@_);       },
  62 #       unlink      => sub { $self->unlink(@_);      },
  63 #       rmdir       => sub { $self->rmdir(@_);       },
  64 #       symlink     => sub { $self->symlink(@_);     },
  65 #       rename      => sub { $self->rename(@_);      },
  66 #       link        => sub { $self->link(@_);        },
  67 #       chmod       => sub { $self->chmod(@_);       },
  68 #       chown       => sub { $self->chown(@_);       },
  69 #       truncate    => sub { $self->truncate(@_);    },
  70 #       utime       => sub { $self->utime(@_);       },
  71 #       open        => sub { $self->open(@_);        },
  72 #       read        => sub { $self->read(@_);        },
  73 #       write       => sub { $self->write(@_);       },
  74 #       statfs      => sub { $self->statfs(@_);      },
  75 #       release     => sub { $self->release(@_);     },
  76 #       fsync       => sub { $self->fsync(@_);       },
  77 #       setxattr    => sub { $self->setxattr(@_);    },
  78 #       getxattr    => sub { $self->getxattr(@_);    },
  79 #       listxattr   => sub { $self->listxattr(@_);   },
  80 #       removexattr => sub { $self->removexattr(@_); },
  81         );
  82 }
  83
  84 sub getattr
  85 {
  86     my($self, $filename)=@_;
  87 #    print "**GETATTR: $filename\n";
  88     my $path=ID3FS::Path->new($self->{db}, $filename, $self->{verbose}, $self->{tagdepth});
  89     my $last_update=$self->{db}->last_update();
  90     return(-ENOENT()) unless($path->isvalid());
  91     my($dev,$ino,$nlink)=(0,0,1);
  92     my $uid=$<;
  93     my $gid=(split(/ /, $( ))[0];
  94     my($rdev,$size)=(0,1);
  95     my($atime,$mtime,$ctime)=($last_update) x 3;
  96     my($blksize,$blocks)=(512,1);
  97     my $mode=$self->mode( $path->isdir() ? $TYPE_DIR : $TYPE_SYMLINK );
  98     return($dev, $ino, $mode, $nlink, $uid, $gid, $rdev, $size,
  99            $atime, $mtime, $ctime, $blksize, $blocks);
 100 }
 101
 102 sub mode
 103 {
 104     my($self, $type)=@_;
 105     return(($type << 9) | $self->{perms});
 106 }
 107
 108 sub readlink
 109 {
 110     my($self,$filename)=@_;
 111 #    print "**READLINK: $filename\n";
 112     my $path=ID3FS::Path->new($self->{db}, $filename, $self->{verbose}, $self->{tagdepth});
 113     return(-EINVAL()) unless($path->isfile());
 114     return $path->dest($self->{mountpoint});
 115 }
 116
 117 sub getdir
 118 {
 119     my($self, $filename)=@_;
 120 #    print "**GETDIR: $filename\n";
 121     my $path=ID3FS::Path->new($self->{db}, $filename, $self->{verbose}, $self->{tagdepth});
 122     return(-ENOENT()) unless($path->isvalid());
 123     return(-ENOTDIR()) unless($path->isdir());
 124     my @dents=();
 125     my($dirs, $files)=$path->dirents();
 126     push(@dents, @$dirs);
 127     push(@dents, @$files);
 128     if(@dents)
 129     {
 130         return( (".", "..", @dents, 0) );
 131     }
 132     return(0);
 133 }
 134
 135 # unused stubs
 136 sub mknod       { print "FUSE: mknod\n";       return -EROFS();      }
 137 sub mkdir       { print "FUSE: mkdir\n";       return -EROFS();      }
 138 sub unlink      { print "FUSE: unlink\n";      return -EROFS();      }
 139 sub rmdir       { print "FUSE: rmdir\n";       return -EROFS();      }
 140 sub symlink     { print "FUSE: symlink\n";     return -EROFS();      }
 141 sub rename      { print "FUSE: rename\n";      return -EROFS();      }
 142 sub link        { print "FUSE: link\n";        return -EROFS();      }
 143 sub chmod       { print "FUSE: chmod\n";       return -EROFS();      }
 144 sub chown       { print "FUSE: chown\n";       return -EROFS();      }
 145 sub truncate    { print "FUSE: truncate\n";    return -EROFS();      }
 146 sub utime       { print "FUSE: utime\n";       return -EINVAL();     }
 147 sub open        { print "FUSE: open\n";        return -EINVAL();     }
 148 sub read        { print "FUSE: read\n";        return -EINVAL();     }
 149 sub write       { print "FUSE: write\n";       return -EROFS();      }
 150 sub statfs      { print "FUSE: statfs\n";      return -EINVAL();     }
 151 sub release     { print "FUSE: release\n";     return 0;             }
 152 sub fsync       { print "FUSE: fsync\n";       return 0;             }
 153 sub setxattr    { print "FUSE: setxattr\n";    return -EOPNOTSUPP(); }
 154 sub getxattr    { print "FUSE: getxattr\n";    return -EOPNOTSUPP(); }
 155 sub listxattr   { print "FUSE: listxattr\n";   return -EOPNOTSUPP(); }
 156 sub removexattr { print "FUSE: removexattr\n"; return -EOPNOTSUPP(); }
 157
 158 1;