notice-sender/trunk/Nos.pm

package Nos;

use 5.008;
use strict;
use warnings;

require Exporter;

our @ISA = qw(Exporter);

our %EXPORT_TAGS = ( 'all' => [ qw(
) ] );

our @EXPORT_OK = ( @{ $EXPORT_TAGS{'all'} } );

our @EXPORT = qw( 
);

our $VERSION = '0.2';

use Class::DBI::Loader;
use Email::Valid;
use Email::Send;
use Carp;

=head1 NAME

Nos - Notice Sender core module

=head1 SYNOPSIS

  use Nos;
  my $nos = new Nos();

=head1 DESCRIPTION

Core module for notice sender's functionality.

=head1 METHODS

=head2 new

Create new instance specifing database, user, password and options.

 my $nos = new Nos(
        dsn => 'dbi:Pg:dbname=notices',
        user => 'dpavlin',
        passwd => '',
        debug => 1,
        verbose => 1,
 );

=cut

sub new {
        my $class = shift;
        my $self = {@_};
        bless($self, $class);

        croak "need at least dsn" unless ($self->{'dsn'});

        $self->{'loader'} = Class::DBI::Loader->new(
                debug           => $self->{'debug'},
                dsn             => $self->{'dsn'},
                user            => $self->{'user'},
                password        => $self->{'passwd'},
                namespace       => "Nos",
#               additional_classes      => qw/Class::DBI::AbstractSearch/,
#               additional_base_classes => qw/My::Stuff/,
                relationships   => 1,
        ) || croak "can't init Class::DBI::Loader";

        $self ? return $self : return undef;
}

=head2 add_member_to_list

Add new member to list

 $nos->add_member_to_list(
        list => "My list",
        email => "john.doe@example.com",
        name => "John A. Doe",
 );

C<name> parametar is optional.

Return member ID if user is added.

=cut

sub add_member_to_list {
        my $self = shift;

        my $arg = {@_};

        my $email = $arg->{'email'} || confess "can't add user without e-mail";
        my $name = $arg->{'name'} || '';
        confess "need list name" unless ($arg->{'list'});

        if (! Email::Valid->address($email)) {
                warn "SKIPPING $name <$email>";
                return 0;
        }

        print STDERR "# $name <$email>\n";

        my $lists = $self->{'loader'}->find_class('lists');
        my $users = $self->{'loader'}->find_class('users');
        my $user_list = $self->{'loader'}->find_class('user_list');

        my $list = $lists->find_or_create({
                name => $arg->{'list'},
        }) || croak "can't add list ",$arg->{'list'},"\n";
        
        my $this_user = $users->find_or_create({
                email => $email,
                full_name => $name,
        }) || croak "can't find or create member\n";

        my $user_on_list = $user_list->find_or_create({
                user_id => $this_user->id,
                list_id => $list->id,
        }) || croak "can't add user to list";

        $list->dbi_commit;
        $this_user->dbi_commit;
        $user_on_list->dbi_commit;

        return $this_user->id;
}

=head2 add_message_to_queue

Adds message to one list's queue for later sending.

 $nos->add_message_to_queue(
        list => 'My list',
        message => 'From: My list <mylist@example.com>
 To: John A. Doe <john.doe@example.com>
 
 This is example message
 ',
 );     

On success returns ID of newly created (or existing) message.

=cut

sub add_message_to_queue {
        my $self = shift;

        my $args = {@_};

        my $list_name = $args->{'list'} || confess "need list name";
        my $message_text = $args->{'message'} || croak "need message";

        my $lists = $self->{'loader'}->find_class('lists');

        my $this_list = $lists->search(
                name => $list_name,
        )->first || croak "can't find list $list_name";

        my $messages = $self->{'loader'}->find_class('messages');

        my $this_message = $messages->find_or_create({
                message => $message_text
        }) || croak "can't insert message";

        $this_message->dbi_commit() || croak "can't add message";

        my $queue = $self->{'loader'}->find_class('queue');

        $queue->find_or_create({
                message_id => $this_message->id,
                list_id => $this_list->id,
        }) || croak "can't add message ",$this_message->id," to list ",$this_list->id, ": ",$this_list->name;

        $queue->dbi_commit || croak "can't add message to list ",$this_list->name;

        return $this_message->id;
}


=head2 send_queued_messages

Send queued messages or just ones for selected list

 $nos->send_queued_messages("My list");

=cut

sub send_queued_messages {
        my $self = shift;

        my $list_name = shift;

        my $lists = $self->{'loader'}->find_class('lists');
        my $queue = $self->{'loader'}->find_class('queue');
        my $user_list = $self->{'loader'}->find_class('user_list');
        my $sent = $self->{'loader'}->find_class('sent');

        my $my_q;
        if ($list_name ne '') {
                my $l_id = $lists->search_like( name => $list_name )->first ||
                        croak "can't find list $list_name";
                $my_q = $queue->search_like( list_id => $l_id ) ||
                        croak "can't find list $list_name";
        } else {
                $my_q = $queue->retrieve_all;
        }

        while (my $m = $my_q->next) {
                next if ($m->all_sent);

                print "sending message ",$m->message_id," enqueued on ",$m->date," to list ",$m->list_id->name,"\n";
                my $msg = $m->message_id->message;

                foreach my $u ($user_list->search(list_id => $m->list_id)) {

                        if ($sent->search( message_id => $m->message_id, user_id => $u->user_id )) {
                                print "SKIP ",$u->user_id->email," message allready sent\n";
                        } else {
                                print "\t",$u->user_id->email,"\n";

                                my $hdr = "From: " . $u->list_id->name . " <" . $u->list_id->email . ">\n" .
                                        "To: " . $u->user_id->full_name . " <". $u->user_id->email. ">\n";

                                # FIXME do real sending :-)
                                send IO => "$hdr\n$msg";

                                $sent->create({
                                        message_id => $m->message_id,
                                        user_id => $u->user_id,
                                });
                                $sent->dbi_commit;
                        }
                }
                $m->all_sent(1);
                $m->update;
                $m->dbi_commit;
        }

}

=head1 EXPORT

Nothing.

=head1 SEE ALSO

mailman, ezmlm, sympa, L<Mail::Salsa>


=head1 AUTHOR

Dobrica Pavlinusic, E<lt>dpavlin@rot13.orgE<gt>


=head1 COPYRIGHT AND LICENSE

Copyright (C) 2005 by Dobrica Pavlinusic

This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.8.4 or,
at your option, any later version of Perl 5 you may have available.


=cut
1	dpavlin	20	package Nos;
2
3			use 5.008;
4			use strict;
5			use warnings;
6
7			require Exporter;
8
9			our @ISA = qw(Exporter);
10
11			our %EXPORT_TAGS = ( 'all' => [ qw(
12			) ] );
13
14			our @EXPORT_OK = ( @{ $EXPORT_TAGS{'all'} } );
15
16			our @EXPORT = qw(
17			);
18
19	dpavlin	27	our $VERSION = '0.2';
20	dpavlin	20
21			use Class::DBI::Loader;
22			use Email::Valid;
23			use Email::Send;
24			use Carp;
25
26			=head1 NAME
27
28			Nos - Notice Sender core module
29
30			=head1 SYNOPSIS
31
32			use Nos;
33			my $nos = new Nos();
34
35			=head1 DESCRIPTION
36
37			Core module for notice sender's functionality.
38
39			=head1 METHODS
40
41			=head2 new
42
43			Create new instance specifing database, user, password and options.
44
45			my $nos = new Nos(
46			dsn => 'dbi:Pg:dbname=notices',
47			user => 'dpavlin',
48			passwd => '',
49			debug => 1,
50			verbose => 1,
51			);
52
53			=cut
54
55			sub new {
56			my $class = shift;
57			my $self = {@_};
58			bless($self, $class);
59
60	dpavlin	22	croak "need at least dsn" unless ($self->{'dsn'});
61
62	dpavlin	20	$self->{'loader'} = Class::DBI::Loader->new(
63			debug => $self->{'debug'},
64			dsn => $self->{'dsn'},
65			user => $self->{'user'},
66			password => $self->{'passwd'},
67			namespace => "Nos",
68			# additional_classes => qw/Class::DBI::AbstractSearch/,
69			# additional_base_classes => qw/My::Stuff/,
70			relationships => 1,
71	dpavlin	22	) \|\| croak "can't init Class::DBI::Loader";
72	dpavlin	20
73			$self ? return $self : return undef;
74			}
75
76	dpavlin	23	=head2 add_member_to_list
77
78			Add new member to list
79
80			$nos->add_member_to_list(
81			list => "My list",
82			email => "john.doe@example.com",
83			name => "John A. Doe",
84			);
85
86			C<name> parametar is optional.
87
88	dpavlin	27	Return member ID if user is added.
89	dpavlin	23
90			=cut
91
92			sub add_member_to_list {
93			my $self = shift;
94
95			my $arg = {@_};
96
97			my $email = $arg->{'email'} \|\| confess "can't add user without e-mail";
98			my $name = $arg->{'name'} \|\| '';
99			confess "need list name" unless ($arg->{'list'});
100
101			if (! Email::Valid->address($email)) {
102			warn "SKIPPING $name <$email>";
103			return 0;
104			}
105
106	dpavlin	27	print STDERR "# $name <$email>\n";
107	dpavlin	23
108			my $lists = $self->{'loader'}->find_class('lists');
109			my $users = $self->{'loader'}->find_class('users');
110			my $user_list = $self->{'loader'}->find_class('user_list');
111
112			my $list = $lists->find_or_create({
113			name => $arg->{'list'},
114			}) \|\| croak "can't add list ",$arg->{'list'},"\n";
115
116			my $this_user = $users->find_or_create({
117			email => $email,
118			full_name => $name,
119			}) \|\| croak "can't find or create member\n";
120
121			my $user_on_list = $user_list->find_or_create({
122			user_id => $this_user->id,
123			list_id => $list->id,
124			}) \|\| croak "can't add user to list";
125
126			$list->dbi_commit;
127			$this_user->dbi_commit;
128			$user_on_list->dbi_commit;
129
130	dpavlin	27	return $this_user->id;
131	dpavlin	23	}
132
133	dpavlin	24	=head2 add_message_to_queue
134
135			Adds message to one list's queue for later sending.
136
137			$nos->add_message_to_queue(
138			list => 'My list',
139			message => 'From: My list <mylist@example.com>
140			To: John A. Doe <john.doe@example.com>
141
142			This is example message
143			',
144			);
145
146			On success returns ID of newly created (or existing) message.
147
148			=cut
149
150			sub add_message_to_queue {
151			my $self = shift;
152
153			my $args = {@_};
154
155			my $list_name = $args->{'list'} \|\| confess "need list name";
156			my $message_text = $args->{'message'} \|\| croak "need message";
157
158			my $lists = $self->{'loader'}->find_class('lists');
159
160			my $this_list = $lists->search(
161			name => $list_name,
162			)->first \|\| croak "can't find list $list_name";
163
164			my $messages = $self->{'loader'}->find_class('messages');
165
166			my $this_message = $messages->find_or_create({
167			message => $message_text
168			}) \|\| croak "can't insert message";
169
170			$this_message->dbi_commit() \|\| croak "can't add message";
171
172			my $queue = $self->{'loader'}->find_class('queue');
173
174			$queue->find_or_create({
175			message_id => $this_message->id,
176			list_id => $this_list->id,
177			}) \|\| croak "can't add message ",$this_message->id," to list ",$this_list->id, ": ",$this_list->name;
178
179			$queue->dbi_commit \|\| croak "can't add message to list ",$this_list->name;
180
181			return $this_message->id;
182			}
183
184
185	dpavlin	22	=head2 send_queued_messages
186	dpavlin	20
187	dpavlin	22	Send queued messages or just ones for selected list
188	dpavlin	20
189	dpavlin	24	$nos->send_queued_messages("My list");
190	dpavlin	20
191	dpavlin	21	=cut
192	dpavlin	20
193	dpavlin	22	sub send_queued_messages {
194	dpavlin	21	my $self = shift;
195	dpavlin	20
196	dpavlin	22	my $list_name = shift;
197	dpavlin	20
198	dpavlin	22	my $lists = $self->{'loader'}->find_class('lists');
199			my $queue = $self->{'loader'}->find_class('queue');
200			my $user_list = $self->{'loader'}->find_class('user_list');
201			my $sent = $self->{'loader'}->find_class('sent');
202	dpavlin	20
203	dpavlin	22	my $my_q;
204			if ($list_name ne '') {
205			my $l_id = $lists->search_like( name => $list_name )->first \|\|
206			croak "can't find list $list_name";
207			$my_q = $queue->search_like( list_id => $l_id ) \|\|
208			croak "can't find list $list_name";
209			} else {
210			$my_q = $queue->retrieve_all;
211			}
212	dpavlin	20
213	dpavlin	22	while (my $m = $my_q->next) {
214			next if ($m->all_sent);
215	dpavlin	20
216	dpavlin	22	print "sending message ",$m->message_id," enqueued on ",$m->date," to list ",$m->list_id->name,"\n";
217			my $msg = $m->message_id->message;
218	dpavlin	20
219	dpavlin	22	foreach my $u ($user_list->search(list_id => $m->list_id)) {
220	dpavlin	20
221	dpavlin	22	if ($sent->search( message_id => $m->message_id, user_id => $u->user_id )) {
222			print "SKIP ",$u->user_id->email," message allready sent\n";
223			} else {
224			print "\t",$u->user_id->email,"\n";
225	dpavlin	20
226	dpavlin	22	my $hdr = "From: " . $u->list_id->name . " <" . $u->list_id->email . ">\n" .
227			"To: " . $u->user_id->full_name . " <". $u->user_id->email. ">\n";
228	dpavlin	20
229	dpavlin	22	# FIXME do real sending :-)
230			send IO => "$hdr\n$msg";
231
232			$sent->create({
233			message_id => $m->message_id,
234			user_id => $u->user_id,
235			});
236			$sent->dbi_commit;
237			}
238			}
239			$m->all_sent(1);
240			$m->update;
241			$m->dbi_commit;
242			}
243
244	dpavlin	20	}
245
246	dpavlin	25	=head1 EXPORT
247	dpavlin	20
248	dpavlin	27	Nothing.
249	dpavlin	20
250			=head1 SEE ALSO
251
252			mailman, ezmlm, sympa, L<Mail::Salsa>
253
254	dpavlin	25
255	dpavlin	20	=head1 AUTHOR
256
257			Dobrica Pavlinusic, E<lt>dpavlin@rot13.orgE<gt>
258
259	dpavlin	25
260	dpavlin	20	=head1 COPYRIGHT AND LICENSE
261
262			Copyright (C) 2005 by Dobrica Pavlinusic
263
264			This library is free software; you can redistribute it and/or modify
265			it under the same terms as Perl itself, either Perl version 5.8.4 or,
266			at your option, any later version of Perl 5 you may have available.
267
268
269			=cut