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