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
|
#-*- perl -*-
#
# Copyright (C) 2001 Ken'ichi Fukamachi
# All rights reserved. This program is free software; you can
# redistribute it and/or modify it under the same terms as Perl itself.
#
# $Id$
# $File$
#
package File::Utils;
use strict;
use vars qw(@ISA @EXPORT @EXPORT_OK $ErrorString);
use Carp;
require Exporter;
@ISA = qw(Exporter);
@EXPORT_OK = qw(mkdirhier touch search_program copy);
=head1 NAME
File::Utils - utilities to handle files
=head1 SYNOPSIS
use File::Utils qw(mkdiehier);
mkdirhier($dir, $mode);
=head1 DESCRIPTION
this module provides utility functions to handle files,
for example,
C<mkdirhier>,
C<touch>,
C<search_program>
and
C<copy>.
=head1 METHODS
=cut
# Descriptions: return the error
# Arguments: none
# Side Effects: none
# Return Value: error message
sub error { return $ErrorString;}
# Descriptions: remove the error message buffer
# Arguments: none
# Side Effects: undef $ErrorString buffer
# Return Value: none
sub error_clear { undef $ErrorString;}
=head2 C<mkdiehier($dir, $mode)>
make a directory C<$dir> by the mode C<$mode> recursively.
=cut
# Descriptions: "mkdir -p" or "mkdirhier"
# Arguments: directory [file_mode]
# Side Effects: set $ErrorString
# Return Value: succeeded to create directory or not
sub mkdirhier
{
my ($dir, $mode) = @_;
error_clear();
# XXX $mode (e.g. 0755) should be a numeric not a string
eval qq{
use File::Path;
mkpath(\$dir, 0, $mode);
};
$ErrorString = $@;
return ($@ ? undef : 1);
}
=head2 C<touch($file, $mode)>
create a file which is size zero if the file not exists.
=cut
# Descriptions: touch: create file if file not exists
# Arguments: file file_mode
# Side Effects: none
# Return Value: 1 if succeed, 0 if not
sub touch
{
my ($file, $mode) = @_;
my ($ok) = 0;
error_clear();
if ( -f $file) {
return 1;
}
else {
my $fh = new IO::File $file, "a";
if (defined $fh) {
$fh->autoflush(1);
close($fh);
}
$ok++ if -f $file;
return 0 unless -f $file;
};
if (defined $mode) {
chmod $mode, $file && $ok++;
}
return $ok;
}
=head2 C<search_program($file [, $path_list ])>
search C<$file>.
C<$path_list> is the hash array.
It searches it among C<$path_list> if specified.
The default search path list is
('/usr/bin', '/bin', '/sbin', ' /usr/local/bin',
'/usr/gnu/bin', '/usr/pkg/bin')
=cut
# Descriptions: file $file executable
# Arguments: file [path_list]
# The "path_list" is an ARRAY_REFERENCE.
# For example,
# search_program('md5');
# search_program('md5', [ '/bin', '/sbin' ]);
# Side Effects: none
# Return Value: pathname if found, undef if not
sub search_program
{
my ($file, $path_list) = @_;
my $default_path_list = [
'/usr/bin',
'/bin',
'/sbin',
'/usr/local/bin',
'/usr/gnu/bin',
'/usr/pkg/bin'
];
$path_list ||= $default_path_list;
use File::Spec;
my $path;
for $path (@$path_list) {
my $prog = File::Spec->catfile($path, $file);
if (-x $prog) {
return $prog;
}
}
return wantarray ? () : undef;
}
=head2 C<copy($src, $dst)>
copy C<$src> to C<$dst> in the atomic way.
This routine uses C<IO::File::Atomic> module.
=cut
# wrappers for delegation :-)
sub copy
{
my ($src, $dst) = @_;
my $pkg = 'IO::File::Atomic';
eval qq{ require $pkg; $pkg->import();};
unless ($@) {
$pkg->new->copy($src, $dst);
}
else {
undef;
}
}
=head1 AUTHOR
Ken'ichi Fukamachi
=head1 COPYRIGHT
Copyright (C) 2001 Ken'ichi Fukamachi
All rights reserved. This program is free software; you can
redistribute it and/or modify it under the same terms as Perl itself.
=head1 HISTORY
File::Utils appeared in fml5 mailing list driver package.
See C<http://www.fml.org/> for more details.
=cut
1;
|
