notice-sender/trunk/sender.pl

#!/usr/bin/perl -w

use strict;
use lib 'lib';
use Nos 0.9;
use Getopt::Long;
use Pod::Usage;

=head1 NAME

sender.pl - command line notify sender utility

=head1 SYNOPSIS

 sender.pl --create=mylist
 sender.pl --drop=mylist
 sender.pl --add=mylist members.txt
 sender.pl --delete=mylist members.txt
 sender.pl --list[=mylist]
 sender.pl --queue[=mylist message.txt]
 sender.pl --send=mylist
 sender.pl --help
 sender.pl --man

=head1 OPTIONS

=over 20

=cut

my $debug = 0;
my $verbose = 0;
my $opt;

my $result = GetOptions(
        "create=s" => \$opt->{'create'},
        "drop=s" => \$opt->{'drop'},
        "list:s" => \$opt->{'list'},
        "add=s" => \$opt->{'add'},
        "delete=s" => \$opt->{'delete'},
        "queue:s" => \$opt->{'queue'},
        "send:s" => \$opt->{'send'},
        "inbox=s" => \$opt->{'inbox'},
        "debug" => \$debug,
        "verbose" => \$verbose,
        "from=s" => \$opt->{'from'},
        "driver=s" => \$opt->{'email_send_driver'},
        "sleep=i" => \$opt->{'sleep'},
        "aliases=s" => \$opt->{'aliases'},
        "help" => \$opt->{'help'},
        "man" => \$opt->{'man'}
) || pod2usage(-verbose => 0);

pod2usage(-verbose => 1) if ($opt->{'help'});
pod2usage(-verbose => 2) if ($opt->{'man'});

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

my $loader = $nos->{'loader'} || die "can't find loader?";

my $lists = $loader->find_class('lists');
my $users = $loader->find_class('users');
my $user_list = $loader->find_class('user_list');
my $messages = $loader->find_class('messages');
my $queue = $loader->find_class('queue');
my $sent = $loader->find_class('sent');

$queue->set_sql( list_queue => qq{
        SELECT messages.message, messages.date AS date, lists.name AS list
        FROM queue
        JOIN messages on message_id = messages.id
        JOIN lists on list_id = lists.id
} );

my $list_name;

=item --aliases=/full/path/to/aliases

Optional parametar C<--aliases> can be used to specify aliases file other
than default C</etc/aliases>.

=cut

my $aliases = $opt->{'aliases'} || '/etc/aliases';


=item --create=list_name my-list@example.com

Adds new list. You can also feed list name as first line to C<STDIN>.

You can also add C<--from='Full name of list'> to specify full name (comment)
in outgoing e-mail.

=cut

if ($list_name = $opt->{'create'}) {

        my $email = shift @ARGV || <>;
        chomp($email);

        die "need e-mail address for list (as argument or on STDIN)\n" unless ($email);

        my $id = $nos->create_list(
                list => $list_name,
                from => ($opt->{'from'} || ''),
                email => $email,
                aliases => $aliases,
        ) || die "can't add list $list_name\n";

        print "added list $list_name with ID $id\n";


=item --drop=list_name

Remove list.

Optional parametar C<--aliases='/full/path/to/aliases'> can be used to
specify aliases file other than C</etc/aliases>.

=cut

} elsif ($list_name = $opt->{'drop'}) {

        my $id = $nos->drop_list(
                list => $list_name,
                aliases => $aliases,
        ) || die "can't remove list $list_name\n";

        print "drop list $list_name with ID $id\n";


=item --list[=list_name]

List all available lists and users on them.

Optional value is name of list. With it, this option will produce just users
on that list.

=cut

} elsif (defined($list_name = $opt->{'list'})) {

        my @lists;

        if ($list_name ne '') {
                @lists = $lists->search( name=> $list_name )->first || die "can't find list $list_name";
        } else {
                @lists = $lists->retrieve_all;
        }

        foreach my $list (@lists) {
                print $list->name,": ",$list->from_addr," <",$list->email,">\n";
                foreach my $u ($nos->list_members( list => $list->name )) {
                        print "\t",$u->{'name'}, " <", $u->{'email'}, ">",( $u->{'ext_id'} ? ' ['.$u->{'ext_id'}.']' : '' ),"\n";
                }
        }


=item --add=list_name

Add users to list. Users are stored in file (which can be supplied as
argument) or read from C<STDIN>. List should be in following format:

 email@example.com      Optional full name of person
 dpavlin@rot13.org      Dobrica Pavlinusic

=cut

} elsif ($list_name = $opt->{'add'}) {

        my $list = $nos->_get_list($list_name) || die "can't find list $list_name\n";

        my $added = 0;

        while(<>) {
                chomp;
                next if (/^#/ || /^\s*$/);
                my ($email, $name) = split(/\s+/,$_, 2);
                $added++ if ($nos->add_member_to_list( email => $email, name => $name, list => $list_name ));
        }

        print "list ",$list->name," has $added users\n";


=item --delete=list_name

Delete users from list. User e-mails can be stored in file (which can be
supplied as argument) or read from C<STDIN>.

=cut
} elsif ($list_name = $opt->{'delete'}) {

        my $list = $nos->_get_list($list_name) || die "can't find list $list_name\n";

        my $deleted = 0;

        while(<>) {
                chomp;
                next if (/^#/ || /^\s*$/);
                my $email = $_;
                $deleted++ if ($nos->delete_member_from_list( email => $email, list => $list_name ));
        }

        print "list ",$list->name," lost $deleted users\n";


=item --queue[=list_name]

Queue message for later delivery. Message can be read from file (specified as
argument) or read from C<STDIN>.

This option without optional parametar will display pending queue. If you
add C<--verbose> flag, it will display all messages in queue.

=cut

} elsif (defined($list_name = $opt->{'queue'})) {

        if ($list_name ne '') {
                # add message to list queue

                my $message_text;
                while(<>) {
                        $message_text .= $_;
                }

                my $id = $nos->add_message_to_list(
                        list => $list_name,
                        message => $message_text,
                ) || die "can't add message to list $list_name\n";

                print "added message $id to list $list_name\n";

        } else {
                # list messages in queue        

                foreach my $m ($queue->retrieve_all) {
                        next if ($m->all_sent && ! $verbose);

                        my $l = $m->all_sent ? 'S' : 'Q';

                        my $date = $m->message_id->date;
                        $date =~ s/\..+$//;
                        my $msg = $m->message_id->message;
                        $msg =~ s/\s+/ /gs;

                        $l .= sprintf(" %-15s %15s : ", $m->list_id->name, $date);
                        $l .= substr($msg, 0, 79 - length($l));

                        print "$l\n";
                }

        }


=item --send[=list_name]

Send e-mails waiting in queue, or with optional argument, just send messages
for single list.

Optional argument C<--driver=smtp> forces sending using SMTP server at
localhost (127.0.0.1).

Optional argument C<--sleep=42> defines that sender will sleep 42 seconds
between sending e-mail.

=cut

} elsif (defined($list_name = $opt->{'send'})) {

        unless ($opt->{'email_send_driver'}) {
                print "WARNING: this will dump debugging output to STDERR\n";
                print "enter alternative driver (e.g. smtp): ";
                my $d = <STDIN>;
                chomp($d);
                $opt->{'email_send_driver'} = $d;
        }

        $nos->send_queued_messages(
                list => $list_name,
                driver => $opt->{'email_send_driver'},
                sleep => $opt->{'sleep'},
                verbose => 1,
        );


=item --inbox=list_name

Feed incomming message back into notice sender.

=cut

} elsif ($list_name = $opt->{'inbox'}) {

        my $message;
        while(<>) {
                $message .= $_;
        }

        $nos->inbox_message(
                list => $list_name,
                message => $message,
        ) || die "can't receive message for list $list_name";


} else  {
        pod2usage(-verbose=>0);
}

=back


=head2 Helper options

=over 20

=item --debug

Turn on debugging output from C<Class::DBI>

=item --verbose

Dump more info on screen.

=back

=head1 DESCRIPTION

This command will use notice-sender C<Nos.pm> module directly to make modifications on lists
or with C<--inbox> option server as incomming mail filter.

=head1 AUTHOR

Dobrica Pavlinusic <dpavlin@rot13.org>

=cut

1	dpavlin	1	#!/usr/bin/perl -w
2
3			use strict;
4	dpavlin	93	use lib 'lib';
5			use Nos 0.9;
6	dpavlin	1	use Getopt::Long;
7	dpavlin	73	use Pod::Usage;
8	dpavlin	1
9	dpavlin	6	=head1 NAME
10
11			sender.pl - command line notify sender utility
12
13	dpavlin	73	=head1 SYNOPSIS
14	dpavlin	8
15	dpavlin	72	sender.pl --create=mylist
16			sender.pl --drop=mylist
17	dpavlin	8	sender.pl --add=mylist members.txt
18	dpavlin	61	sender.pl --delete=mylist members.txt
19	dpavlin	9	sender.pl --list[=mylist]
20	dpavlin	14	sender.pl --queue[=mylist message.txt]
21	dpavlin	8	sender.pl --send=mylist
22	dpavlin	73	sender.pl --help
23			sender.pl --man
24	dpavlin	8
25	dpavlin	73	=head1 OPTIONS
26	dpavlin	29
27	dpavlin	8	=over 20
28
29	dpavlin	6	=cut
30
31	dpavlin	12	my $debug = 0;
32	dpavlin	15	my $verbose = 0;
33	dpavlin	30	my $opt;
34	dpavlin	1
35			my $result = GetOptions(
36	dpavlin	72	"create=s" => \$opt->{'create'},
37			"drop=s" => \$opt->{'drop'},
38	dpavlin	30	"list:s" => \$opt->{'list'},
39			"add=s" => \$opt->{'add'},
40	dpavlin	61	"delete=s" => \$opt->{'delete'},
41	dpavlin	30	"queue:s" => \$opt->{'queue'},
42			"send:s" => \$opt->{'send'},
43			"inbox=s" => \$opt->{'inbox'},
44	dpavlin	1	"debug" => \$debug,
45	dpavlin	15	"verbose" => \$verbose,
46	dpavlin	47	"from=s" => \$opt->{'from'},
47			"driver=s" => \$opt->{'email_send_driver'},
48	dpavlin	49	"sleep=i" => \$opt->{'sleep'},
49	dpavlin	69	"aliases=s" => \$opt->{'aliases'},
50	dpavlin	73	"help" => \$opt->{'help'},
51			"man" => \$opt->{'man'}
52			) \|\| pod2usage(-verbose => 0);
53	dpavlin	1
54	dpavlin	73	pod2usage(-verbose => 1) if ($opt->{'help'});
55			pod2usage(-verbose => 2) if ($opt->{'man'});
56
57	dpavlin	20	my $nos = new Nos(
58			dsn => 'dbi:Pg:dbname=notices',
59			user => 'dpavlin',
60			passwd => '',
61			debug => $debug,
62			verbose => $verbose,
63	dpavlin	1	);
64
65	dpavlin	20	my $loader = $nos->{'loader'} \|\| die "can't find loader?";
66
67	dpavlin	2	my $lists = $loader->find_class('lists');
68			my $users = $loader->find_class('users');
69			my $user_list = $loader->find_class('user_list');
70	dpavlin	6	my $messages = $loader->find_class('messages');
71	dpavlin	11	my $queue = $loader->find_class('queue');
72	dpavlin	15	my $sent = $loader->find_class('sent');
73	dpavlin	2
74	dpavlin	14	$queue->set_sql( list_queue => qq{
75	dpavlin	15	SELECT messages.message, messages.date AS date, lists.name AS list
76	dpavlin	14	FROM queue
77			JOIN messages on message_id = messages.id
78			JOIN lists on list_id = lists.id
79			} );
80
81	dpavlin	30	my $list_name;
82	dpavlin	14
83	dpavlin	72	=item --aliases=/full/path/to/aliases
84	dpavlin	30
85	dpavlin	72	Optional parametar C<--aliases> can be used to specify aliases file other
86			than default C</etc/aliases>.
87	dpavlin	30
88	dpavlin	72	=cut
89
90			my $aliases = $opt->{'aliases'} \|\| '/etc/aliases';
91
92
93			=item --create=list_name my-list@example.com
94
95	dpavlin	30	Adds new list. You can also feed list name as first line to C<STDIN>.
96
97	dpavlin	47	You can also add C<--from='Full name of list'> to specify full name (comment)
98			in outgoing e-mail.
99
100	dpavlin	30	=cut
101
102	dpavlin	72	if ($list_name = $opt->{'create'}) {
103	dpavlin	30
104			my $email = shift @ARGV \|\| <>;
105			chomp($email);
106
107			die "need e-mail address for list (as argument or on STDIN)\n" unless ($email);
108
109	dpavlin	72	my $id = $nos->create_list(
110	dpavlin	30	list => $list_name,
111	dpavlin	47	from => ($opt->{'from'} \|\| ''),
112	dpavlin	30	email => $email,
113	dpavlin	69	aliases => $aliases,
114	dpavlin	30	) \|\| die "can't add list $list_name\n";
115
116	dpavlin	33	print "added list $list_name with ID $id\n";
117	dpavlin	30
118
119	dpavlin	72	=item --drop=list_name
120
121			Remove list.
122
123			Optional parametar C<--aliases='/full/path/to/aliases'> can be used to
124			specify aliases file other than C</etc/aliases>.
125
126			=cut
127
128			} elsif ($list_name = $opt->{'drop'}) {
129
130			my $id = $nos->drop_list(
131			list => $list_name,
132			aliases => $aliases,
133			) \|\| die "can't remove list $list_name\n";
134
135			print "drop list $list_name with ID $id\n";
136
137
138	dpavlin	9	=item --list[=list_name]
139	dpavlin	8
140	dpavlin	14	List all available lists and users on them.
141	dpavlin	8
142	dpavlin	14	Optional value is name of list. With it, this option will produce just users
143			on that list.
144
145	dpavlin	8	=cut
146
147	dpavlin	30	} elsif (defined($list_name = $opt->{'list'})) {
148
149	dpavlin	9	my @lists;
150	dpavlin	30
151			if ($list_name ne '') {
152			@lists = $lists->search( name=> $list_name )->first \|\| die "can't find list $list_name";
153	dpavlin	9	} else {
154			@lists = $lists->retrieve_all;
155			}
156
157			foreach my $list (@lists) {
158	dpavlin	53	print $list->name,": ",$list->from_addr," <",$list->email,">\n";
159	dpavlin	45	foreach my $u ($nos->list_members( list => $list->name )) {
160	dpavlin	57	print "\t",$u->{'name'}, " <", $u->{'email'}, ">",( $u->{'ext_id'} ? ' ['.$u->{'ext_id'}.']' : '' ),"\n";
161	dpavlin	1	}
162			}
163	dpavlin	8
164	dpavlin	30
165	dpavlin	8	=item --add=list_name
166
167			Add users to list. Users are stored in file (which can be supplied as
168			argument) or read from C<STDIN>. List should be in following format:
169
170			email@example.com Optional full name of person
171			dpavlin@rot13.org Dobrica Pavlinusic
172
173			=cut
174
175	dpavlin	30	} elsif ($list_name = $opt->{'add'}) {
176
177	dpavlin	51	my $list = $nos->_get_list($list_name) \|\| die "can't find list $list_name\n";
178	dpavlin	21
179	dpavlin	6	my $added = 0;
180
181	dpavlin	2	while(<>) {
182			chomp;
183			next if (/^#/ \|\| /^\s*$/);
184			my ($email, $name) = split(/\s+/,$_, 2);
185	dpavlin	30	$added++ if ($nos->add_member_to_list( email => $email, name => $name, list => $list_name ));
186	dpavlin	2	}
187	dpavlin	3
188	dpavlin	6	print "list ",$list->name," has $added users\n";
189
190	dpavlin	30
191	dpavlin	61	=item --delete=list_name
192
193			Delete users from list. User e-mails can be stored in file (which can be
194			supplied as argument) or read from C<STDIN>.
195
196			=cut
197			} elsif ($list_name = $opt->{'delete'}) {
198
199			my $list = $nos->_get_list($list_name) \|\| die "can't find list $list_name\n";
200
201			my $deleted = 0;
202
203			while(<>) {
204			chomp;
205			next if (/^#/ \|\| /^\s*$/);
206			my $email = $_;
207			$deleted++ if ($nos->delete_member_from_list( email => $email, list => $list_name ));
208			}
209
210			print "list ",$list->name," lost $deleted users\n";
211
212
213	dpavlin	14	=item --queue[=list_name]
214	dpavlin	8
215			Queue message for later delivery. Message can be read from file (specified as
216			argument) or read from C<STDIN>.
217
218	dpavlin	16	This option without optional parametar will display pending queue. If you
219			add C<--verbose> flag, it will display all messages in queue.
220	dpavlin	14
221	dpavlin	8	=cut
222
223	dpavlin	30	} elsif (defined($list_name = $opt->{'queue'})) {
224	dpavlin	6
225	dpavlin	30	if ($list_name ne '') {
226	dpavlin	14	# add message to list queue
227
228			my $message_text;
229			while(<>) {
230			$message_text .= $_;
231			}
232
233	dpavlin	29	my $id = $nos->add_message_to_list(
234	dpavlin	30	list => $list_name,
235	dpavlin	24	message => $message_text,
236	dpavlin	32	) \|\| die "can't add message to list $list_name\n";
237	dpavlin	14
238	dpavlin	30	print "added message $id to list $list_name\n";
239	dpavlin	14
240			} else {
241			# list messages in queue
242
243			foreach my $m ($queue->retrieve_all) {
244	dpavlin	15	next if ($m->all_sent && ! $verbose);
245
246			my $l = $m->all_sent ? 'S' : 'Q';
247
248			my $date = $m->message_id->date;
249			$date =~ s/\..+$//;
250			my $msg = $m->message_id->message;
251			$msg =~ s/\s+/ /gs;
252
253	dpavlin	36	$l .= sprintf(" %-15s %15s : ", $m->list_id->name, $date);
254	dpavlin	15	$l .= substr($msg, 0, 79 - length($l));
255
256	dpavlin	14	print "$l\n";
257			}
258
259	dpavlin	6	}
260
261	dpavlin	30
262	dpavlin	14	=item --send[=list_name]
263	dpavlin	6
264	dpavlin	16	Send e-mails waiting in queue, or with optional argument, just send messages
265			for single list.
266	dpavlin	6
267	dpavlin	47	Optional argument C<--driver=smtp> forces sending using SMTP server at
268			localhost (127.0.0.1).
269
270	dpavlin	49	Optional argument C<--sleep=42> defines that sender will sleep 42 seconds
271			between sending e-mail.
272
273	dpavlin	14	=cut
274	dpavlin	6
275	dpavlin	30	} elsif (defined($list_name = $opt->{'send'})) {
276	dpavlin	6
277	dpavlin	55	unless ($opt->{'email_send_driver'}) {
278			print "WARNING: this will dump debugging output to STDERR\n";
279			print "enter alternative driver (e.g. smtp): ";
280			my $d = <STDIN>;
281			chomp($d);
282			$opt->{'email_send_driver'} = $d;
283			}
284
285	dpavlin	49	$nos->send_queued_messages(
286			list => $list_name,
287			driver => $opt->{'email_send_driver'},
288			sleep => $opt->{'sleep'},
289	dpavlin	93	verbose => 1,
290	dpavlin	49	);
291	dpavlin	6
292	dpavlin	30
293	dpavlin	29	=item --inbox=list_name
294
295			Feed incomming message back into notice sender.
296
297			=cut
298
299	dpavlin	36	} elsif ($list_name = $opt->{'inbox'}) {
300	dpavlin	29
301	dpavlin	36	my $message;
302			while(<>) {
303			$message .= $_;
304			}
305	dpavlin	29
306	dpavlin	36	$nos->inbox_message(
307			list => $list_name,
308			message => $message,
309			) \|\| die "can't receive message for list $list_name";
310
311
312	dpavlin	1	} else {
313	dpavlin	73	pod2usage(-verbose=>0);
314	dpavlin	1	}
315
316	dpavlin	8	=back
317
318	dpavlin	15
319
320			=head2 Helper options
321
322			=over 20
323
324			=item --debug
325
326			Turn on debugging output from C<Class::DBI>
327
328			=item --verbose
329
330			Dump more info on screen.
331
332			=back
333
334	dpavlin	73	=head1 DESCRIPTION
335	dpavlin	15
336	dpavlin	73	This command will use notice-sender C<Nos.pm> module directly to make modifications on lists
337			or with C<--inbox> option server as incomming mail filter.
338	dpavlin	15
339	dpavlin	8	=head1 AUTHOR
340
341			Dobrica Pavlinusic <dpavlin@rot13.org>
342
343			=cut
344