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
|
#-*- perl -*-
#
# Copyright (C) 2002,2003,2004,2005,2006 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.
#
# $FML: FileUtils.pm,v 1.20 2006/03/05 09:50:42 fukachan Exp $
#
package FML::Command::FileUtils;
use strict;
use vars qw(@ISA @EXPORT @EXPORT_OK $AUTOLOAD);
use Carp;
=head1 NAME
FML::Command::FileUtils - utilities to handle files.
=head1 SYNOPSIS
use FML::Command::FileUtils;
my $obj = new FML::Command::FileUtils;
$obj->remove($curproc, $command_context, $du_args);
=head1 DESCRIPTION
This class provides file operation functions.
remove(), same as delete() method can be used to remove files under
$ml_home_dir.
=head1 METHODS
=head2 new()
constructor.
=cut
# Descriptions: constructor
# Arguments: OBJ($self)
# Side Effects: none
# Return Value: OBJ
sub new
{
my ($self) = @_;
my ($type) = ref($self) || $self;
my $me = {};
use FML::Restriction::Base;
$me->{ _safe } = new FML::Restriction::Base;
return bless $me, $type;
}
=head2 delete($curproc, $command_context, $du_aregs)
same as remove() below.
=head2 remove($curproc, $command_context, $du_aregs)
remove files specified in $du_args->{ options }
if the file exsits and the file name matches the safe file regexp
defined in FML::Restriction class.
=cut
# Descriptions: remove files.
# Arguments: OBJ($self) VARARGS(@var_args)
# Side Effects: remove files
# Return Value: same as remove()
sub delete
{
my ($self, @var_args) = @_;
$self->remove(@var_args);
}
# Descriptions: remove files.
# Arguments: OBJ($self)
# OBJ($curproc) OBJ($command_context) HASH_REF($du_args)
# Side Effects: none
# Return Value: none
sub remove
{
my ($self, $curproc, $command_context, $du_args) = @_;
my $config = $curproc->config();
my $is_error = 0;
# chdir $ml_home_dir firstly. return ASAP if failed.
my $ml_home_dir = $config->{ ml_home_dir };
chdir $ml_home_dir || croak("cannot chdir \$ml_home_dir");
# validate file and remove it if ok.
my $argv = $du_args->{ options };
my $safe = $self->{ _safe }; # regexp allowed here for file
for my $file (@$argv) {
# If $file is a safe pattern, o.k. Try to remove it!
if ($safe->regexp_match('file', $file)) {
if (-f $file) {
unlink $file;
if (-f $file) {
$curproc->logerror("fail to remove $file");
$is_error++;
}
else {
$curproc->log("remove $file");
$curproc->reply_message_nl("command.remove_file",
"removed $file",
{ _arg_file => $file } );
}
}
else {
$curproc->logwarn("no such file $file");
$curproc->reply_message_nl("command.no_such_file",
"no such file $file",
{ _arg_file => $file } );
$is_error++;
}
}
# $file filename is unsafe. stop.
else {
$curproc->logerror("<$file> is insecure");
$curproc->reply_message_nl('command.insecure',
"insecure input");
croak("remove: insecure argument");
}
}
if ($is_error) {
croak("remove: something fail.");
}
}
=head1 CODING STYLE
See C<http://www.fml.org/software/FNF/> on fml coding style guide.
=head1 AUTHOR
Ken'ichi Fukamachi
=head1 COPYRIGHT
Copyright (C) 2002,2003,2004,2005,2006 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
FML::Command::FileUtils first appeared in fml8 mailing list driver package.
See C<http://www.fml.org/> for more details.
=cut
1;
|
