summaryrefslogtreecommitdiff
path: root/fml/lib/FML/Command/FileUtils.pm
blob: f4b46e79c3c112b385408a6841830352854822bd (plain)
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
#-*- perl -*-
#
#  Copyright (C) 2002 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.3 2002/04/07 12:13:03 fukachan Exp $
#

package FML::Command::FileUtils;
use strict;
use vars qw(@ISA @EXPORT @EXPORT_OK $AUTOLOAD);
use Carp;
use FML::Log qw(Log LogWarn LogError);


=head1 NAME

FML::Command::FileUtils - utilities to handle files

=head1 SYNOPSIS

=head1 DESCRIPTION

=head1 METHODS

=cut


# Descriptions: standard 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;
    my $safe = new FML::Restriction::Base;
    $me->{ _basic_variable } = $safe->basic_variable();

    return bless $me, $type;
}


# Descriptions: remove files
#    Arguments: OBJ($self) ... varargs ...
# Side Effects: remove files
# Return Value: same as remove()
sub delete
{
    my ($self, @p) = @_;
    $self->remove(@p);
}


# Descriptions: remove files
#    Arguments: OBJ($self) HASH_REF($curproc) HASH_REF($command_args)
#               HASH_REF($du_args)
# Side Effects: none
# Return Value: none
sub remove
{
    my ($self, $curproc, $command_args, $du_args) = @_;
    my $config   = $curproc->{ config };
    my $argv     = $du_args->{ options };
    my $is_error = 0;

    # regexp
    my $basic_variable = $self->{ _basic_variable };
    my $file_regexp    = $basic_variable->{ file };
    my $ml_home_dir    = $config->{ ml_home_dir };

    # chdir $ml_home_dir firstly. return ASAP if failed.
    chdir $ml_home_dir || croak("cannot chdir \$ml_home_dir");

    for my $file (@$argv) {
	# If $file is a safe pattern, o.k. Try to remove it!
	if ($file =~ /^$file_regexp$/) {
	    if (-f $file) {
		unlink $file;

		if (-f $file) {
		    LogError("fail to remove $file");
		    $is_error++;
		}
		else {
		    Log("remove $file");
		    $curproc->reply_message_nl("command.remove_file",
					       "removed $file",
					       { _arg_file => $file } );
		}
	    }
	    else {
		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 {
	    LogError("<$file> is insecure");
	    $curproc->reply_message_nl('command.insecure',
				       "insecure input");
	    croak("remove: insecure argument");
	}
    }

    if ($is_error) {
	croak("remove: something fail.");
    }
}


=head1 AUTHOR

Ken'ichi Fukamachi

=head1 COPYRIGHT

Copyright (C) 2002 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 appeared in fml5 mailing list driver package.
See C<http://www.fml.org/> for more details.

=cut


1;