notice-sender/trunk/sender.pl

#!/usr/bin/perl -w

use strict;
use blib;
use Nos;
use Getopt::Long;

=head1 NAME

sender.pl - command line notify sender utility

=head1 SYNOPSYS

 sender.pl --new=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

In C</etc/aliases> something like:

 mylist: "| cd /path/to && ./sender.pl --inbox=mylist"

=head2 Command options

=over 20

=cut

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

my $result = GetOptions(
        "new=s" => \$opt->{'new'},
        "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'},
);

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 --new=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->{'new'}) {

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

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

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

        print "added 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'},
        );


=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  {
        die "see perldoc $0 for help\n";
}

=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 AUTHOR

Dobrica Pavlinusic <dpavlin@rot13.org>

=cut

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