| 1 | # | ||
| 2 | # This file is part of Config-Model | ||
| 3 | # | ||
| 4 | # This software is Copyright (c) 2005-2022 by Dominique Dumont. | ||
| 5 | # | ||
| 6 | # This is free software, licensed under: | ||
| 7 | # | ||
| 8 | # The GNU Lesser General Public License, Version 2.1, February 1999 | ||
| 9 | # | ||
| 10 | package Config::Model::FuseUI 2.169; | ||
| 11 | |||
| 12 | # there's no Singleton with Mouse | ||
| 13 | use Mouse; | ||
| 14 | use v5.20; | ||
| 15 | use feature qw/postderef signatures/; | ||
| 16 | no warnings qw/experimental::postderef experimental::signatures/; | ||
| 17 | |||
| 18 | |||
| 19 | use Filesys::Fuse3 qw(fuse_get_context); | ||
| 20 | use Fcntl ':mode'; | ||
| 21 | use POSIX qw(ENOENT EISDIR EINVAL O_TRUNC O_CREAT O_APPEND); | ||
| 22 | use Log::Log4perl qw(get_logger :levels); | ||
| 23 | use English qw( -no_match_vars ); | ||
| 24 | |||
| 25 | has model => ( is => 'rw', isa => 'Config::Model' ); | ||
| 26 | has root => ( is => 'ro', isa => 'Config::Model::Node', required => 1 ); | ||
| 27 | has mountpoint => ( is => 'ro', isa => 'Str', required => 1 ); | ||
| 28 | |||
| 29 | my $logger = get_logger("FuseUI"); | ||
| 30 | |||
| 31 | has dir_char_mockup => ( is => 'ro', isa => 'Str', default => '<slash>' ); | ||
| 32 | |||
| 33 | our $fuseui; | ||
| 34 | my $dir_char_mockup; | ||
| 35 | |||
| 36 | sub BUILD ($self, $) { | ||
| 37 | croak( __PACKAGE__, " singleton constructed twice" ) | ||
| 38 | if defined $fuseui and $fuseui ne $self; | ||
| 39 | $fuseui = $self; # store singleton object in global variable | ||
| 40 | $dir_char_mockup = $self->dir_char_mockup; | ||
| 41 | return; | ||
| 42 | } | ||
| 43 | |||
| 44 | # nodes, list and hashes are directories | ||
| 45 | ## no critic (Subroutines::ProhibitBuiltinHomonyms) | ||
| 46 | sub readdir ($name, $, $) { | ||
| 47 | $logger->trace("FuseUI readdir called with $name"); | ||
| 48 | |||
| 49 | my $obj = get_object($name); | ||
| 50 | return -EINVAL() unless ( ref $obj and $obj->can('children') ); | ||
| 51 | |||
| 52 | my @c = ( '..', '.', $obj->children ); | ||
| 53 | for (@c) { s(/)($dir_char_mockup)g }; | ||
| 54 | $logger->debug( "FuseUI readdir return @c , wantarray is " . ( wantarray ? 1 : 0 ) ); | ||
| 55 | return ( @c, 0 ); | ||
| 56 | } | ||
| 57 | |||
| 58 | sub fetch_as_line ($obj) { | ||
| 59 | my $v = $obj->fetch( check => 'no' ); | ||
| 60 | $v = '' unless defined $v; | ||
| 61 | |||
| 62 | # let's append a \n so that returned files always have a line ending | ||
| 63 | $v .= "\n" unless $v =~ /\n$/; | ||
| 64 | |||
| 65 | return $v; | ||
| 66 | } | ||
| 67 | |||
| 68 | sub get_object ($name) { | ||
| 69 | return _get_object( $name, 0 ); | ||
| 70 | } | ||
| 71 | |||
| 72 | sub get_or_create_object { | ||
| 73 | my $name = shift; | ||
| 74 | return _get_object( $name, 1 ); | ||
| 75 | } | ||
| 76 | |||
| 77 | sub _get_object ($name, $autoadd) { | ||
| 78 | my $obj = $fuseui->root->get( | ||
| 79 | path => $name, | ||
| 80 | check => 'skip', | ||
| 81 | get_obj => 1, | ||
| 82 | autoadd => $autoadd, | ||
| 83 | dir_char_mockup => $dir_char_mockup | ||
| 84 | ); | ||
| 85 | $logger->debug( "FuseUI _get_object on $name returns ", | ||
| 86 | ( defined $obj ? $obj->name : '<undef>' ) ); | ||
| 87 | return $obj; | ||
| 88 | } | ||
| 89 | |||
| 90 | sub getattr ($name) { | ||
| 91 | $logger->trace("FuseUI getattr called with $name"); | ||
| 92 | my $obj = get_object($name); | ||
| 93 | |||
| 94 | return -&ENOENT() unless ref $obj; | ||
| 95 | |||
| 96 | my $type = $obj->get_type; | ||
| 97 | |||
| 98 | # return -ENOENT() unless exists($files{$file}); | ||
| 99 | |||
| 100 | my $size; | ||
| 101 | if ( $type eq 'leaf' or $type eq 'check_list' ) { | ||
| 102 | $size = length( fetch_as_line($obj) ); | ||
| 103 | } | ||
| 104 | else { | ||
| 105 | # fuseui_obj->children does not return the right data in scalar context | ||
| 106 | my @c = $obj->children; | ||
| 107 | $size = @c; | ||
| 108 | } | ||
| 109 | |||
| 110 | my $mode; | ||
| 111 | if ( $type eq 'leaf' or $type eq 'check_list' ) { | ||
| 112 | $mode = S_IFREG | oct(644); | ||
| 113 | } | ||
| 114 | else { | ||
| 115 | $mode = S_IFDIR | oct(755); | ||
| 116 | } | ||
| 117 | |||
| 118 | my ( $dev, $ino, $rdev, $blocks, $gid, $uid, $nlink, $blksize ) = | ||
| 119 | ( 0, 0, 0, 1, $EGID, $EUID, 1, 1024 ); | ||
| 120 | my ( $atime, $ctime, $mtime ); | ||
| 121 | $atime = $ctime = $mtime = time; | ||
| 122 | |||
| 123 | # 2 possible types of return values: | ||
| 124 | #return -ENOENT(); # or any other error you care to | ||
| 125 | #print(join(",",($dev,$ino,$modes,$nlink,$uid,$gid,$rdev,$size,$atime,$mtime,$ctime,$blksize,$blocks)),"\n"); | ||
| 126 | my @r = ( | ||
| 127 | $dev, $ino, $mode, $nlink, $uid, $gid, $rdev, | ||
| 128 | $size, $atime, $mtime, $ctime, $blksize, $blocks | ||
| 129 | ); | ||
| 130 | |||
| 131 | $logger->trace( "FuseUI getattr returns '" . join( "','", @r ) . "'" ); | ||
| 132 | |||
| 133 | return @r; | ||
| 134 | } | ||
| 135 | |||
| 136 | ## no critic (Subroutines::ProhibitBuiltinHomonyms) | ||
| 137 | sub open ($name, $flags, $info) { | ||
| 138 | $logger->trace("FuseUI open called on $name"); | ||
| 139 | my $obj = $fuseui->root->get( path => $name, check => 'skip', get_obj => 1 ); | ||
| 140 | return -ENOENT() unless defined $obj; | ||
| 141 | |||
| 142 | my $type = $obj->get_type; | ||
| 143 | return -EISDIR() unless ( $type eq 'leaf' or $type eq 'check_list' ); | ||
| 144 | |||
| 145 | if ($flags & O_TRUNC) { | ||
| 146 | # must be able to clear a mandatory value | ||
| 147 | $obj->clear(check => 'no'); | ||
| 148 | |||
| 149 | $logger->debug("FuseUI open with truncate on $name ok"); | ||
| 150 | return 0; | ||
| 151 | } | ||
| 152 | |||
| 153 | $logger->debug("FuseUI open on $name ok"); | ||
| 154 | return 0; | ||
| 155 | } | ||
| 156 | |||
| 157 | ## no critic (Subroutines::ProhibitBuiltinHomonyms) | ||
| 158 | sub read ($name, $buf, $off, $) { | ||
| 159 | # return an error numeric, or binary/text string. (note: 0 means EOF, "0" will | ||
| 160 | # give a byte (ascii "0") to the reading program) | ||
| 161 | |||
| 162 | $logger->trace("FuseUI read called on $name"); | ||
| 163 | my $obj = get_or_create_object($name); | ||
| 164 | my $type = $obj->get_type; | ||
| 165 | |||
| 166 | return -ENOENT() unless defined $obj; | ||
| 167 | return -EISDIR() unless ( $type eq 'leaf' or $type eq 'check_list' ); | ||
| 168 | my $v = fetch_as_line($obj); | ||
| 169 | |||
| 170 | return -EINVAL() if $off > length($v); | ||
| 171 | return 0 if $off == length($v); | ||
| 172 | my $ret = substr( $v, $off, $buf ); | ||
| 173 | $logger->debug("FuseUI read returns '$ret'"); | ||
| 174 | return "$ret"; | ||
| 175 | } | ||
| 176 | |||
| 177 | ## no critic (Subroutines::ProhibitBuiltinHomonyms) | ||
| 178 | sub truncate ($name, $off) { | ||
| 179 | $logger->trace("FuseUI truncate called on $name with length $off"); | ||
| 180 | my $obj = get_or_create_object($name); | ||
| 181 | my $type = $obj->get_type; | ||
| 182 | |||
| 183 | return -ENOENT() unless defined $obj; | ||
| 184 | return -EISDIR() unless ( $type eq 'leaf' or $type eq 'check_list' ); | ||
| 185 | |||
| 186 | my $v = substr fetch_as_line($obj), 0, $off; | ||
| 187 | |||
| 188 | $logger->trace( "FuseUI truncate stores '$v' of length ", length($v) ); | ||
| 189 | |||
| 190 | # store the value without any check. Check will be done in write() | ||
| 191 | # the second parameter will trigger a notif_change. | ||
| 192 | $obj->_store_value( $v, 1 ); | ||
| 193 | return 0; | ||
| 194 | } | ||
| 195 | |||
| 196 | ## no critic (Subroutines::ProhibitBuiltinHomonyms) | ||
| 197 | sub write ($name, $buf, $off, $) { | ||
| 198 | if ( $logger->is_trace ) { | ||
| 199 | my $str = $buf; | ||
| 200 | $str =~ s/\n/\\n/g; | ||
| 201 | $logger->trace("FuseUI write called on $name with '$str' offset $off"); | ||
| 202 | } | ||
| 203 | |||
| 204 | my $obj = get_or_create_object($name); | ||
| 205 | my $type = $obj->get_type; | ||
| 206 | |||
| 207 | return -ENOENT() unless defined $obj; | ||
| 208 | return -EISDIR() unless ( $type eq 'leaf' or $type eq 'check_list' ); | ||
| 209 | |||
| 210 | my $v = fetch_as_line($obj); | ||
| 211 | $logger->debug("FuseUI write starts with '$v'"); | ||
| 212 | |||
| 213 | # replace or insert buffer | ||
| 214 | substr $v, $off, length($buf), $buf; | ||
| 215 | chomp $v unless ( $type eq 'leaf' and $obj->value_type eq 'string' ); | ||
| 216 | $logger->debug("FuseUI write stores '$v'"); | ||
| 217 | $obj->store( value => $v, check => 'skip', say_dont_warn => 1 ); | ||
| 218 | |||
| 219 | return length($buf); | ||
| 220 | } | ||
| 221 | |||
| 222 | ## no critic (Subroutines::ProhibitBuiltinHomonyms) | ||
| 223 | sub mkdir ($name, $mode) { | ||
| 224 | # return an error numeric, or binary/text string. (note: 0 means EOF, "0" will | ||
| 225 | # give a byte (ascii "0") to the reading program) | ||
| 226 | |||
| 227 | $logger->trace("FuseUI mkdir called on $name with mode $mode"); | ||
| 228 | my $obj = get_or_create_object($name); | ||
| 229 | return -ENOENT() unless defined $obj; | ||
| 230 | |||
| 231 | my $type = $obj->container_type; | ||
| 232 | return -ENOENT() unless ( $type eq 'list' or $type eq 'hash' ); | ||
| 233 | |||
| 234 | return 0; | ||
| 235 | } | ||
| 236 | |||
| 237 | ## no critic (Subroutines::ProhibitBuiltinHomonyms) | ||
| 238 | sub rmdir ($name) { | ||
| 239 | # return an error numeric, or binary/text string. (note: 0 means EOF, "0" will | ||
| 240 | # give a byte (ascii "0") to the reading program) | ||
| 241 | |||
| 242 | $logger->trace("FuseUI rmdir called on $name"); | ||
| 243 | my $obj = get_object($name); | ||
| 244 | return -ENOENT() unless defined $obj; | ||
| 245 | |||
| 246 | my $type = $obj->get_type; | ||
| 247 | return -ENOENT() if ( $type eq 'leaf' or $type eq 'check_list' ); | ||
| 248 | |||
| 249 | my $ct = $obj->container_type; | ||
| 250 | my $elt_name = $obj->element_name; | ||
| 251 | my $parent = $obj->parent; | ||
| 252 | |||
| 253 | if ( $ct eq 'list' or $ct eq 'hash' ) { | ||
| 254 | my $idx = $obj->index_value; | ||
| 255 | $logger->debug("FuseUI rmdir actually deletes $idx"); | ||
| 256 | $parent->fetch_element($elt_name)->delete($idx); | ||
| 257 | } | ||
| 258 | |||
| 259 | # ignore deletion request for other "non deletable" elements | ||
| 260 | |||
| 261 | return 0; | ||
| 262 | } | ||
| 263 | |||
| 264 | ## no critic (Subroutines::ProhibitBuiltinHomonyms) | ||
| 265 | sub unlink ($name) { | ||
| 266 | $logger->debug("FuseUI unlink called on $name"); | ||
| 267 | my $obj = get_object($name); | ||
| 268 | my $type = $obj->get_type; | ||
| 269 | |||
| 270 | return -ENOENT() unless defined $obj; | ||
| 271 | return -EISDIR() unless ( $type eq 'leaf' or $type eq 'check_list' ); | ||
| 272 | |||
| 273 | my $ct = $obj->container_type; | ||
| 274 | my $elt_name = $obj->element_name; | ||
| 275 | my $parent = $obj->parent; | ||
| 276 | |||
| 277 | if ( $ct eq 'list' or $ct eq 'hash' ) { | ||
| 278 | my $idx = $obj->index_value; | ||
| 279 | $logger->debug("FuseUI unlink actually deletes $idx"); | ||
| 280 | $parent->fetch_element($elt_name)->delete($name); | ||
| 281 | } | ||
| 282 | |||
| 283 | # ignore deletion request for other "non deletable" elements | ||
| 284 | |||
| 285 | return 0; | ||
| 286 | } | ||
| 287 | |||
| 288 | sub statfs { return 255, 1, 1, 1, 1, 2 } | ||
| 289 | |||
| 290 | my @methods = map { ( $_ => __PACKAGE__ . "::$_" ) } | ||
| 291 | qw/getattr readdir open read write statfs truncate unlink mkdir rmdir/; | ||
| 292 | |||
| 293 | # FIXME: flush release | ||
| 294 | # maybe also: readlink mknod symlink rename link chmod chown utime | ||
| 295 | |||
| 296 | sub run_loop { | ||
| 297 | my ( $self, %args ) = @_; | ||
| 298 | my $debug = $args{debug} || 0; | ||
| 299 | |||
| 300 | Filesys::Fuse3::main( | ||
| 301 | mountpoint => $self->mountpoint, | ||
| 302 | @methods, | ||
| 303 | debug => $debug || 0, | ||
| 304 | threaded => 0, | ||
| 305 | ); | ||
| 306 | return; | ||
| 307 | } | ||
| 308 | |||
| 309 | 1; | ||
| 310 | |||
| 311 | # ABSTRACT: Fuse virtual file interface for Config::Model | ||
| 312 | |||
| 313 | __END__ |