prototype of digest delivery

1 files changed, 245 insertions, 0 deletions

diff --git a/fml/lib/FML/Process/Digest.pm b/fml/lib/FML/Process/Digest.pm
new file mode 100644
index 00000000..c6c5e7b1
--- /dev/null
+++ b/fml/lib/FML/Process/Digest.pm
@@ -0,0 +1,245 @@
+#-*- perl -*-
+#
+# Copyright (C) 2002 Ken'ichi Fukamachi
+#          All rights reserved.
+#
+# $FML: Digest.pm,v 1.99 2002/10/03 22:10:15 fukachan Exp $
+#
+
+package FML::Process::Digest;
+
+use vars qw($debug @ISA @EXPORT @EXPORT_OK);
+use strict;
+use Carp;
+
+use FML::Log qw(Log LogWarn LogError);
+use FML::Config;
+use FML::Process::Kernel;
+@ISA = qw(FML::Process::Kernel);
+
+
+=head1 NAME
+
+FML::Process::Digest -- digest delivery.
+
+=head1 SYNOPSIS
+
+   use FML::Process::Digest;
+   ...
+
+See L<FML::Process::Flow> for details of the fml flow.
+
+=head1 DESCRIPTION
+
+C<FML::Process::Flow::ProcessStart($obj, $args)> drives the fml flow
+where C<$obj> is the object C<FML::Process::$module::new()> returns.
+
+=head1 METHOD
+
+=head2 C<new($args)>
+
+create C<FML::Process::Digest> object.
+C<$curproc> is the object C<FML::Process::Kernel> returns but
+we bless it as C<FML::Process::Digest> object again.
+
+=cut
+
+
+# Descriptions: ordinary constructor.
+#               sub class of FML::Process::Kernel
+#    Arguments: OBJ($self) HASH_REF($args)
+# Side Effects: none
+# Return Value: OBJ(FML::Process::Digest)
+sub new
+{
+    my ($self, $args) = @_;
+    my $type    = ref($self) || $self;
+    my $curproc = new FML::Process::Kernel $args;
+    return bless $curproc, $type;
+}
+
+
+=head2 C<prepare($args)>
+
+forward the request to the base class.
+adjust ml_* and load configuration files.
+
+=cut
+
+
+# Descriptions: prepare miscellaneous work before the main routine starts.
+#               adjust ml_* and load configuration files.
+#    Arguments: OBJ($curproc) HASH_REF($args)
+# Side Effects: none
+# Return Value: none
+sub prepare
+{
+    my ($curproc, $args) = @_;
+    my $config = $curproc->{ config };
+
+    my $eval = $config->get_hook( 'digest_prepare_start_hook' );
+    if ($eval) { eval qq{ $eval; }; LogWarn($@) if $@; }
+
+    $curproc->resolve_ml_specific_variables( $args );
+    $curproc->load_config_files( $args->{ cf_list } );
+    $curproc->fix_perl_include_path();
+    $curproc->scheduler_init();
+
+    unless ($config->yes('use_digest_program')) {
+	LogError("use of digest_program prohibited");
+	exit(0);
+    }
+
+    $eval = $config->get_hook( 'digest_prepare_end_hook' );
+    if ($eval) { eval qq{ $eval; }; LogWarn($@) if $@; }
+}
+
+
+=head2 C<verify_request($args)>
+
+check the mail sender and the mail loop possibility.
+
+=cut
+
+
+# Descriptions: verify the mail sender and others
+#               1. verify user credential
+#               2. primitive loop check
+#               3. filter
+#    Arguments: OBJ($curproc) HASH_REF($args)
+# Side Effects: none
+# Return Value: none
+sub verify_request
+{
+    my ($curproc, $args) = @_;
+    my $config = $curproc->{ config };
+
+    my $eval = $config->get_hook( 'digest_verify_request_start_hook' );
+    if ($eval) { eval qq{ $eval; }; LogWarn($@) if $@; }
+
+    # do nothing :-)
+
+    $eval = $config->get_hook( 'digest_verify_request_end_hook' );
+    if ($eval) { eval qq{ $eval; }; LogWarn($@) if $@; }
+}
+
+
+=head2 C<run($args>)
+
+Firstly it locks (giant lock) the current process.
+
+If the mail sender is one of our mailing list member,
+we can digest the mail as an article.
+If not, we inform "you are not a member" which is sent by
+C<inform_reply_messages()> in C<FML::Process::Kernel>.
+
+Lastly we unlock the current process.
+
+=cut
+
+
+# Descriptions: the main routine, kick off _digest()
+#    Arguments: OBJ($curproc) HASH_REF($args)
+# Side Effects: distribution of articles.
+#               See _digest() for more details.
+# Return Value: none
+sub run
+{
+    my ($curproc, $args) = @_;
+    my $config     = $curproc->{ config };
+    my $maintainer = $config->{ maintainer };
+    my $sender     = $curproc->{'credential'}->{'sender'};
+
+    my $eval = $config->get_hook( 'digest_run_start_hook' );
+    if ($eval) { eval qq{ $eval; }; LogWarn($@) if $@; }
+
+    $curproc->lock();
+    unless ($curproc->is_refused()) {
+	;
+    }
+    else {
+	LogError("ignore this request.");
+    }
+    $curproc->unlock();
+
+    $eval = $config->get_hook( 'digest_run_end_hook' );
+    if ($eval) { eval qq{ $eval; }; LogWarn($@) if $@; }
+}
+
+
+=head2 help()
+
+=cut
+
+
+# Descriptions: show help
+#    Arguments: none
+# Side Effects: none
+# Return Value: none
+sub help
+{
+print <<"_EOF_";
+
+Usage: $0 \$ml_home_prefix/\$ml_name [options]
+
+   For example, digest of elena ML
+   $0 /var/spool/ml/elena
+
+_EOF_
+}
+
+
+=head2 C<finish($args)>
+
+Finalize the current process.
+If needed, we send back error messages to the mail sender.
+
+=cut
+
+
+# Descriptions: clean up in the end of the curreen process.
+#               return error messages et. al.
+#    Arguments: OBJ($curproc) HASH_REF($args)
+# Side Effects: queue flush
+# Return Value: none
+sub finish
+{
+    my ($curproc, $args) = @_;
+    my $config = $curproc->{ config };
+
+    my $eval = $config->get_hook( 'digest_finish_start_hook' );
+    if ($eval) { eval qq{ $eval; }; LogWarn($@) if $@; }
+
+    # $curproc->inform_reply_messages();
+    # $curproc->queue_flush();
+
+    $eval = $config->get_hook( 'digest_finish_end_hook' );
+    if ($eval) { eval qq{ $eval; }; LogWarn($@) if $@; }
+
+}
+
+
+=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) 2000,2001,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::Process::Digest first appeared in fml8 mailing list driver package.
+See C<http://www.fml.org/> for more details.
+
+=cut
+
+
+1;