summaryrefslogtreecommitdiff
path: root/fml/lib/FML/Merge/FML4/Config.pm
blob: 0c3ef965e1390445a07656f288c14eb9e678e3d6 (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
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
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
#-*- perl -*-
#
#  Copyright (C) 2004 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: Config.pm,v 1.5 2004/07/23 13:16:41 fukachan Exp $
#

package FML::Merge::FML4::Config;
use strict;
use vars qw(@ISA @EXPORT @EXPORT_OK $AUTOLOAD);
use Carp;


=head1 NAME

FML::Merge::FML4::Config - what files we need to merge.

=head1 SYNOPSIS

=head1 DESCRIPTION

=head1 METHODS

=head2 new()

constructor.

=cut


# Descriptions: constructor.
#    Arguments: OBJ($self) OBJ($curproc) HASH_REF($config)
# Side Effects: none
# Return Value: OBJ
sub new
{
    my ($self, $curproc, $config) = @_;
    my ($type) = ref($self) || $self;
    my $me     = {};
    return bless $me, $type;
}


# target files to back up.
my $ml_home_dir_backup_target_files = {

    #
    # main configuration files
    #
    'cf' => {
	'backup_mode' => 'move',
    },

    'config.ph' => {
	'backup_mode' => 'copy',
    },


    #
    # system
    #
    'aliases' => {
	'backup_mode' => 'move',
    },

    'crontab' => {
	'backup_mode' => 'move',
    },

    'fmlwrapper.c' => {
	'backup_mode' => 'move',
    },

    'fmlwrapper.h' => {
	'backup_mode' => 'move',
    },


    #
    # message files
    #
    'confirm' => {
	'backup_mode' => 'move',
    },

    'deny' => {
	'backup_mode' => 'move',
    },

    'guide' => {
	'backup_mode' => 'copy',
    },

    'help' => {
	'backup_mode' => 'move',
    },

    'help-admin' => {
	'backup_mode' => 'move',
    },

    'objective' => {
	'backup_mode' => 'move',
    },

    'welcome' => {
	'backup_mode' => 'move',
    },


    #
    # include*
    #
    'include' => {
	'backup_mode' => 'copy',
	'type'        => 'include',
    },

    'include-ctl' => {
	'backup_mode' => 'copy',
	'type'        => 'include',
    },

    'include-mead' => {
	'backup_mode' => 'copy',
	'type'        => 'include',
    },


    #
    # list files
    #

    # member list files
    'actives' => {
	'backup_mode' => 'move',
	'type'        => 'list',
    },

    'members' => {
	'backup_mode' => 'copy',
	'type'        => 'list',
    },

    # admin member list files
    'members-admin' => {
	'backup_mode' => 'copy',
	'type'        => 'list',
    },

    # moderators
    'moderators' => {
	'backup_mode' => 'copy',
	'type'        => 'list',
    },


    #
    # password files
    #
    'etc/passwd' => {
	'backup_mode' => 'move',
	'type'        => 'list',
    },


    #
    # log et.al.
    #
    'summary' => {
	'backup_mode' => 'copy',
	'continue'    => 'yes',
    },

    'seq' => {
	'backup_mode' => 'copy',
	'continue'    => 'yes',
    },

    'log' => {
	'backup_mode' => 'copy',
	'continue'    => 'yes',
    },


    #
    # misc
    #
    'Makefile' => {
	'backup_mode' => 'move',
    },
};


# Descriptions: return list of files to back up.
#    Arguments: OBJ($self)
# Side Effects: none
# Return Value: ARRAY_REF
sub get_old_config_files
{
    my ($self)  = @_;

    my (@files) = keys %$ml_home_dir_backup_target_files;
    return \@files
}


# Descriptions: return list of include* files.
#    Arguments: OBJ($self)
# Side Effects: none
# Return Value: ARRAY_REF
sub get_old_include_files
{
    my ($self)  = @_;
    my (@files) = ();

    for my $f (keys %$ml_home_dir_backup_target_files) {
	my $type = $ml_home_dir_backup_target_files->{ $f }->{ type } || '';
	if ($type eq 'include') {
	    push(@files, $f);
	}
    }

    return \@files
}


# Descriptions: return list of list* files.
#    Arguments: OBJ($self)
# Side Effects: none
# Return Value: ARRAY_REF
sub get_old_list_files
{
    my ($self)  = @_;
    my (@files) = ();

    for my $f (keys %$ml_home_dir_backup_target_files) {
	my $type = $ml_home_dir_backup_target_files->{ $f }->{ type } || '';
	if ($type eq 'list') {
	    push(@files, $f);
	}
    }

    return \@files
}


# Descriptions: return list of files we use continuously.
#    Arguments: OBJ($self)
# Side Effects: none
# Return Value: ARRAY_REF
sub get_continuous_use_files
{
    my ($self)  = @_;
    my (@files) = ();

    for my $f (keys %$ml_home_dir_backup_target_files) {
	my $cnt = $ml_home_dir_backup_target_files->{ $f }->{ continue } || '';
	if ($cnt eq 'yes') {
	    push(@files, $f);
	}
    }

    return \@files
}


# Descriptions: check if we should backup this $file.
#    Arguments: OBJ($self) STR($file)
# Side Effects: none
# Return Value: STR
sub backup_mode
{
    my ($self, $file) = @_;

    if (defined $ml_home_dir_backup_target_files->{$file}->{backup_mode}) {
	my $mode = $ml_home_dir_backup_target_files->{$file}->{backup_mode};
	return $mode;
    }
    else {
	return 'unknown';
    }
}


#
# debug
#
if ($0 eq __FILE__) {
   for my $f (keys %$ml_home_dir_backup_target_files) {
	print $f, "\n";
   }
}


=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) 2004 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::Merge::FML4::Config appeared in fml8 mailing list driver package.
See C<http://www.fml.org/> for more details.

=cut


1;