/usr/share/perl5/Dancer2/FileUtils.pm is in libdancer2-perl 0.204002+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 | package Dancer2::FileUtils;
# ABSTRACT: File utility helpers
$Dancer2::FileUtils::VERSION = '0.204002';
use strict;
use warnings;
use File::Basename ();
use File::Spec;
use Carp;
use Exporter 'import';
our @EXPORT_OK = qw(
dirname open_file path read_file_content read_glob_content
path_or_empty set_file_mode normalize_path escape_filename
);
sub path {
my @parts = @_;
my $path = File::Spec->catfile(@parts);
return normalize_path($path);
}
sub path_or_empty {
my @parts = @_;
my $path = path(@parts);
# return empty if it doesn't exist
return -e $path ? $path : '';
}
sub dirname { File::Basename::dirname(@_) }
sub set_file_mode {
my $fh = shift;
my $charset = 'utf-8';
binmode $fh, ":encoding($charset)";
return $fh;
}
sub open_file {
my ( $mode, $filename ) = @_;
open my $fh, $mode, $filename
or croak "Can't open '$filename' using mode '$mode': $!";
return set_file_mode($fh);
}
sub read_file_content {
my $file = shift or return;
my $fh = open_file( '<', $file );
return wantarray
? read_glob_content($fh)
: scalar read_glob_content($fh);
}
sub read_glob_content {
my $fh = shift;
my @content = <$fh>;
close $fh;
return wantarray ? @content : join '', @content;
}
sub normalize_path {
# this is a revised version of what is described in
# http://www.linuxjournal.com/content/normalizing-path-names-bash
# by Mitch Frazier
my $path = shift or return;
my $seqregex = qr{
[^/]* # anything without a slash
/\.\.(/|\z) # that is accompanied by two dots as such
}x;
$path =~ s{/\./}{/}g;
while ( $path =~ s{$seqregex}{} ) {}
#see https://rt.cpan.org/Public/Bug/Display.html?id=80077
$path =~ s{^//}{/};
return $path;
}
sub escape_filename {
my $filename = shift or return;
# based on escaping used in CHI::Driver. Our use-case is one-way,
# so we allow utf8 chars to be escaped, but NEVER do the inverse
# operation.
$filename =~ s/([^A-Za-z0-9_\=\-\~])/sprintf("+%02x", ord($1))/ge;
return $filename;
}
1;
__END__
=pod
=encoding UTF-8
=head1 NAME
Dancer2::FileUtils - File utility helpers
=head1 VERSION
version 0.204002
=head1 SYNOPSIS
use Dancer2::FileUtils qw/dirname path path_or_empty/;
# for 'path/to/file'
my $dir = dirname($path); # returns 'path/to'
my $path = path($path); # returns '/abs/path/to/file'
my $path = path_or_empty($path); # returns '' if file doesn't exist
use Dancer2::FileUtils qw/path read_file_content/;
my $content = read_file_content( path( 'folder', 'folder', 'file' ) );
my @content = read_file_content( path( 'folder', 'folder', 'file' ) );
use Dancer2::FileUtils qw/read_glob_content set_file_mode/;
open my $fh, '<', $file or die "$!\n";
set_file_mode($fh);
my @content = read_glob_content($fh);
my $content = read_glob_content($fh);
use Dancer2::FileUtils qw/open_file/;
my $fh = open_file('<', $file) or die $message;
use Dancer2::FileUtils 'set_file_mode';
set_file_mode($fh);
=head1 DESCRIPTION
Dancer2::FileUtils includes a few file related utilities that Dancer2
uses internally. Developers may use it instead of writing their own
file reading subroutines or using additional modules.
=head1 FUNCTIONS
=head2 my $path = path( 'folder', 'folder', 'filename');
Provides comfortable path resolution, internally using L<File::Spec>. 'path'
does not verify paths, it just normalizes the path.
=head2 my $path = path_or_empty('folder, 'folder','filename');
Like path, but returns '' if path doesn't exist.
=head2 dirname
use Dancer2::FileUtils 'dirname';
my $dir = dirname($path);
Exposes L<File::Basename>'s I<dirname>, to allow fetching a directory name from
a path. On most OS, returns all but last level of file path. See
L<File::Basename> for details.
=head2 set_file_mode($fh);
use Dancer2::FileUtils 'set_file_mode';
set_file_mode($fh);
Applies charset setting from Dancer2's configuration. Defaults to utf-8 if no
charset setting.
=head2 my $fh = open_file('<', $file) or die $message;
use Dancer2::FileUtils 'open_file';
my $fh = open_file('<', $file) or die $message;
Calls open and returns a filehandle. Takes in account the 'charset' setting
from Dancer2's configuration to open the file in the proper encoding (or
defaults to utf-8 if setting not present).
=head2 my $content = read_file_content($file);
use Dancer2::FileUtils 'read_file_content';
my @content = read_file_content($file);
my $content = read_file_content($file);
Returns either the content of a file (whose filename is the input), or I<undef>
if the file could not be opened.
In array context it returns each line (as defined by $/) as a separate element;
in scalar context returns the entire contents of the file.
=head2 my $content = read_glob_content($fh);
use Dancer2::FileUtils 'read_glob_content';
open my $fh, '<', $file or die "$!\n";
binmode $fh, ':encoding(utf-8)';
my @content = read_glob_content($fh);
my $content = read_glob_content($fh);
Similar to I<read_file_content>, only it accepts a file handle. It is
assumed that the appropriate PerlIO layers are applied to the file handle.
Returns the content and B<closes the file handle>.
=head2 my $norm_path=normalize_path ($path);
=head2 my $escaped_filename = escape_filename( $filename );
Escapes characters in a filename that may alter a path when concatenated.
use Dancer2::FileUtils 'escape_filename';
my $safe = escape_filename( "a/../b.txt" ); # a+2f+2e+2e+2fb+2etxt
=head1 EXPORT
Nothing by default. You can provide a list of subroutines to import.
=head1 AUTHOR
Dancer Core Developers
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2016 by Alexis Sukrieh.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut
|