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
|
#-*- perl -*-
#
# Copyright (C) 2001,2002,2003,2004,2005,2006,2008 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: Flow.pm,v 1.34 2008/08/24 08:18:33 fukachan Exp $
#
package FML::Process::Flow;
use strict;
use vars qw(@ISA @EXPORT @EXPORT_OK $AUTOLOAD);
use Carp;
=head1 NAME
FML::Process::Flow - the process flow.
=head1 SYNOPSIS
use FML::Process::Flow;
FML::Process::Flow::ProcessStart($obj, $args);
where C<$obj> is an FML::Process::C<something> object and
C<$args> is HASH REFERENCE prepared by C<FML::Process::Switch>.
=head1 DESCRIPTION
This module describes the fml program flow. All methods, even if
dummy, should be implemented in each FML::Process::CLASS.
This flow is same among fml processes such as
programs kicked by MTA, command line interfaces and CGI's.
# create a new process object
my $process = $pkg->new($args);
# XXX private method to show help ASAP.
# XXX we need to trap here since $process object is clarified after
# XXX $pkg->new() above.
$process->sysflow_trap_help($args);
# e.g. parse the incoming message (e.g. STDIN)
$process->prepare($args);
# validate the request, for example,
# permit post from the sender,
# check the mail loop or not ...
$process->verify_request($args);
# start main transaction
$process->run($args);
# closing the process
$process->finish($args);
# clean up tmporary files
$process->tmp_file_cleanup();
=cut
# Descriptions: drive top level process flow
# 1. initialize processes and load configurations from *.cf,
# switch to each process according with $0 and @ARGV.
# 2. parse the incoming message(mail).
# 3. start the main transaction.
# lock, execute main routine, unlock, ...
# 4. inform error messages, clean up and more ...
# Arguments: OBJ($pkg) HASH_REF($args)
# Side Effects: ProcessSwtich() is exported to main:: Name Space.
# Return Value: none
sub ProcessStart
{
my ($pkg, $args) = @_;
# create a new process object
my $process = $pkg->new($args);
# curproc back pointer, used in emergency.
$args->{ curproc } = $process;
# XXX private method to show help ASAP
# XXX we need to trap here since $process object is clarified after
# XXX $pkg->new() above.
$process->sysflow_trap_help($args);
# e.g. parse the incoming message (e.g. STDIN)
$process->prepare($args);
# close and reopen STDERR to record log messages written into STDERR.
$process->sysflow_reopen_stderr_channel();
# validate the request, for example,
# permit post from the sender,
# check the mail loop or not ...
$process->verify_request($args);
# start main transaction
$process->run($args);
# start closing of this process
$process->finish($args);
# flush stderr channel log.
$process->sysflow_finalize_stderr_channel($args);
# log file rotation et.al.
$process->log_file_cleanup();
# clean up temporary files.
$process->tmp_file_cleanup();
$process->isolated_message_cleanup_queue();
$process->incoming_message_cleanup_queue();
# debug
$process->finalize();
}
=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) 2001,2002,2003,2004,2005,2006,2008 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::Process::Flow first appeared in fml8 mailing list driver package.
See C<http://www.fml.org/> for more details.
=cut
1;
|
