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
|
package Demeter::File::Windows;
use Moose::Role;
use Fcntl qw(:flock);
use File::Basename;
use Text::Unidecode;
use Win32::Unicode::File qw(file_type copyW);
sub readable {
my ($self, $file) = @_;
my $exists = file_type(e=>$file);
return "$file does not exist" if (not $exists);
my $isfile = file_type(f=>$file);
return "$file is not a file" if (not $isfile);
#return "$file is locked" if $self->locked($file);
return 0;
};
sub locked {
my ($self, $file) = @_;
my $rc = open(my $HANDLE, $file);
$rc = flock($HANDLE, LOCK_EX|LOCK_NB);
close($HANDLE);
return !$rc;
};
sub is_unicode {
my ($self, $file) = @_;
##if ($self->readable($file) and (not -r $file)) {
## ## likely indicator of a problematic unicode file name
if ($file =~ m{[^[:ascii:]]}) { # see http://perldoc.perl.org/perlrecharclass.html#POSIX-Character-Classes
return 1;
};
return 0;
};
sub unicopy {
my ($self, $file) = @_;
my $target = File::Spec->catfile(Demeter->stash_folder, unidecode(basename($file)));
copyW($file, $target);
return $target;
};
1;
=head1 NAME
Demeter::File::Windows - Utility methods for interacting with files on Windows systems
=head1 VERSION
This documentation refers to Demeter version 0.9.26.
=head1 DESCRIPTION
This module contains a number of methods for interacting with files on
Windows systems. There seems to be some confusion surrounding
encoding when using Wx::FileDialog to get the name of a file with
non-US-ASCII characters in its path and/or name. This module provides
tools Athena and Artemis can use to manage such files.
=head1 METHODS
=over 4
=item C<readable>
Return true if a file can be read.
=item C<locked>
Return true if a file is locked.
=item C<unicopy>
Safely copy a file to the stash folder, unidecoding basename. Returns
the safe, fully ASCII file path+name.
=back
=head1 DEPENDENCIES
The dependencies of the Demeter system are listed in the
F<Build.PL> file.
This module uses F<Win32::Unicode::File> and F<Text::Unidecode>.
=head1 BUGS AND LIMITATIONS
Please report problems to the Ifeffit Mailing List
(L<http://cars9.uchicago.edu/mailman/listinfo/ifeffit/>)
Patches are welcome.
=head1 AUTHOR
The euclid method was swiped from Math::Numbers by David Moreno Garza
and is Copyright (C) 2007 and is licensed like Perl itself.
Bruce Ravel (L<http://bruceravel.github.io/home>)
L<http://bruceravel.github.io/demeter/>
=head1 LICENCE AND COPYRIGHT
Copyright (c) 2006-2019 Bruce Ravel (L<http://bruceravel.github.io/home>). All rights reserved.
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself. See L<perlgpl>.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
=cut
|