- Add feedback for /videosite save
[videosite.git] / videosite.pl
1 # autodownload flash videos
2 #
3 # (c) 2007 by Ralf Ertzinger <ralf@camperquake.de>
4 # licensed under GNU GPL v2
5 #
6 # Based on youtube.pl by Christian Garbs <mitch@cgarbs.de>
7 # which in turn is
8 # based on trigger.pl by Wouter Coekaerts <wouter@coekaerts.be>
9
10 use strict;
11 use Irssi 20020324 qw (command_bind command_runsub signal_add_first signal_add_last);
12 use vars qw($VERSION %IRSSI);
13 use XML::Simple;
14 use Data::Dumper;
15 use File::Spec;
16
17 my @grabbers;
18 my @getters;
19 my $getter;
20 my $conf;
21 my $conffile = File::Spec->catfile(Irssi::get_irssi_dir(), 'videosite.xml');
22
23 # activate debug here
24 my $debug = 0;
25
26 # "message public", SERVER_REC, char *msg, char *nick, char *address, char *target
27 signal_add_last("message public" => sub {check_for_link(\@_,1,4,2,0);});
28 # "message own_public", SERVER_REC, char *msg, char *target
29 signal_add_last("message own_public" => sub {check_for_link(\@_,1,2,-1,0);});
30
31 # "message private", SERVER_REC, char *msg, char *nick, char *address
32 signal_add_last("message private" => sub {check_for_link(\@_,1,-1,2,0);});
33 # "message own_private", SERVER_REC, char *msg, char *target, char *orig_target
34 signal_add_last("message own_private" => sub {check_for_link(\@_,1,2,-1,0);});
35
36 # "message irc action", SERVER_REC, char *msg, char *nick, char *address, char *target
37 signal_add_last("message irc action" => sub {check_for_link(\@_,1,4,2,0);});
38 # "message irc own_action", SERVER_REC, char *msg, char *target
39 signal_add_last("message irc own_action" => sub {check_for_link(\@_,1,2,-1,0);});
40
41 sub write_irssi {
42     my $witem = shift;
43     my @text = @_;
44
45     if (defined $witem) {
46         $witem->print(sprintf(shift(@text), @text), MSGLEVEL_CLIENTCRAP);
47     } else {
48         Irssi::print(sprintf(shift(@text), @text));
49     }
50
51 }
52
53 sub write_verbose {
54     if (Irssi::settings_get_bool('youtube_verbose')) {
55         write_irssi(shift, @_);
56     }
57 }
58
59 sub write_debug {
60     if ($debug) {
61         write_irssi(shift, @_);
62     }
63 }
64
65 sub check_for_link {
66     my ($signal,$parammessage,$paramchannel,$paramnick,$paramserver) = @_;
67     my $server = $signal->[$paramserver];
68     my $target = $signal->[$paramchannel];
69     my $message = ($parammessage == -1) ? '' : $signal->[$parammessage];
70     my $g;
71     my $m;
72
73
74     my $witem;
75     if (defined $server) {
76         $witem = $server->window_item_find($target);
77     } else {
78         $witem = Irssi::window_item_find($target);
79     }
80
81     # Look if we should ignore this line
82     if ($message =~ m,(?:\s|^)/nosave(?:\s|$),) {
83         return;
84     }
85
86     # Offer the message to all Grabbers in turn
87     foreach $g (@grabbers) {
88         if (defined($m = $g->get($message))) {
89             write_irssi($witem, '%%R>>> %%NSaving %%Y%s%%N %%G%s', $m->{'SOURCE'}, $m->{'TITLE'});
90             unless($getter->get($m)) {
91                 write_irssi($witem, '%%R>>> FAILED');
92             }
93         }
94     }
95 }
96
97 sub cmd_save {
98
99     eval {
100         open(CONF, '>'.$conffile) or die 'Could not open config file';
101         print CONF XML::Simple::XMLout($conf, KeepRoot => 1, KeyAttr => {'config' => 'module', 'option' => 'key'});
102         close(CONF);
103     };
104     if ($@) {
105         write_irssi(undef, 'Could not save config: %s', $@);
106     } else {
107         write_irssi(undef, 'Saved config');
108     }
109 }
110
111 sub cmd_set {
112     my $target = shift;
113     my $key = shift;
114     my $val = shift;
115     my $p;
116
117     foreach $p (@getters, @grabbers) {
118         if ($p->{'NAME'} eq $target) {
119             $p->setval($key, $val);
120             return;
121         }
122     }
123     write_irssi(undef, 'No such module');
124 }
125
126 sub cmd_show {
127     my $target = shift;
128     my $p;
129
130     if (defined($target)) {
131         foreach $p (@getters, @grabbers) {
132             if ($p->{'NAME'} eq $target) {
133                 write_irssi(undef, $p->getconfstr());
134                 return;
135             }
136         }
137         write_irssi(undef, 'No such module');
138     } else {
139         write_irssi(undef, 'Loaded grabbers:');
140         foreach $p (@grabbers) {
141             write_irssi(undef, ' ' . $p->{'NAME'});
142         };
143
144         write_irssi(undef, 'Loaded getters:');
145         foreach $p (@getters) {
146             write_irssi(undef, ' ' . $p->{'NAME'});
147         };
148     }
149 }
150
151 sub cmd_help {
152     my $target = shift;
153     my $p;
154
155     if (defined($target)) {
156         foreach $p (@getters, @grabbers) {
157             if ($p->{'NAME'} eq $target) {
158                 write_irssi(undef, $p->gethelpstr());
159                 return;
160             }
161         }
162         write_irssi(undef, 'No such module');
163     } else {
164         write_irssi(undef, <<'EOT');
165 Supported commands:
166  save: Save the current configuration
167  help [modulename]: Display this help, or module specific help
168  show [modulename]: Show loaded modules, or the current parameters of a module
169  set modulename parameter value: set a module parameter to a new value
170  getter [modulename]: display or set the getter to use
171  debug: enable debugging messages
172  nodebug: disable debugging messages
173 EOT
174     }
175 }
176
177 sub cmd_getter {
178     my $target = shift;
179     my $p;
180
181     if (defined($target)) {
182         foreach $p (@getters, @grabbers) {
183             if (($p->{'NAME'} eq $target) && ($p->{'TYPE'} eq 'getter')) {
184                 $getter = $p;
185                 $conf->{'videosite'}->{'getter'} = $target;
186                 return;
187             }
188         }
189         write_irssi(undef, 'No such getter');
190     } else {
191         write_irssi(undef, 'Current getter: %s', $conf->{'videosite'}->{'getter'});
192     }
193 }
194
195
196 # save on unload
197 sub sig_command_script_unload {
198     my $script = shift;
199     if ($script =~ /(.*\/)?videosite(\.pl)?$/) {
200         cmd_save();
201     }
202 }
203
204 sub ploader {
205
206     my $dir = shift;
207     my $pattern = shift;
208     my $type = shift;
209     my @list;
210     my $p;
211     my $g;
212     my @g = ();
213
214     opendir(D, $dir) || return ();
215     @list = grep {/$pattern/ && -f File::Spec->catfile($dir, $_) } readdir(D);
216     closedir(D);
217
218     foreach $p (@list) {
219         write_debug(undef, "Trying to load $p:");
220         $p =~ s/\.pm$//;
221         eval qq{ require $p; };
222         if ($@) {
223             write_debug(undef, "Failed to load plugin: $@");
224             next;
225         }
226
227         $g = eval $p.q{->new();};
228         if ($@) {
229             write_debug(undef, "Failed to instanciate: $@");
230             next;
231         }
232
233         write_debug(undef, "found $g->{'TYPE'} $g->{'NAME'}");
234         if ($type eq $g->{'TYPE'}) {
235             push(@g, $g);
236         } else {
237             write_irssi(undef, '%s has wrong type (got %s, expected %s)', $p, $g->{'TYPE'}, $type);
238         }
239     }
240
241     write_debug(undef, "Loaded %d plugins", $#g+1);
242     
243     return @g;
244 }
245
246 sub init_videosite {
247
248     my $p;
249
250     unless(-r $conffile && defined($conf = XML::Simple::XMLin($conffile, ForceArray => ['config', 'option'], KeepRoot => 1, KeyAttr => {'config' => 'module', 'option' => 'key'}))) {
251         # No config, start with an empty one
252         write_debug(undef, 'No config found, using defaults');
253         $conf = { 'videosite' => { 'getter' => '' }};
254     }
255
256     unshift(@INC, File::Spec->catfile(Irssi::get_irssi_dir(), 'scripts', 'videosite'));
257     @grabbers = ploader(File::Spec->catfile(Irssi::get_irssi_dir(), 'scripts', 'videosite'), '.*Grabber\.pm$', 'grabber');
258     @getters = ploader(File::Spec->catfile(Irssi::get_irssi_dir(), 'scripts', 'videosite'), '.*Getter\.pm$', 'getter');
259
260     unless (defined(@grabbers) && defined(@getters)) {
261         write_irssi(undef, 'No grabbers or no getters found, can not proceed.');
262         return;
263     }
264
265     $getter = $getters[0];
266     foreach $p (@getters) {
267         if ($conf->{'videosite'}->{'getter'} eq $p->{'NAME'}) {
268             $getter = $p;
269         }
270     }
271     write_debug(undef, 'Selected %s as getter', $getter->{'NAME'});
272     $conf->{'videosite'}->{'getter'} = $getter->{'NAME'};
273
274     # Loop through all plugins and load the config
275     foreach $p (@grabbers, @getters) {
276         $conf->{'videosite'}->{'config'}->{$p->{'NAME'}} = $p->mergeconfig($conf->{'videosite'}->{'config'}->{$p->{'NAME'}});
277     }
278
279     Irssi::signal_add_first('command script load', 'sig_command_script_unload');
280     Irssi::signal_add_first('command script unload', 'sig_command_script_unload');
281
282     Irssi::command_bind('videosite' => \&cmdhandler);
283 }
284
285 sub cmdhandler {
286     my ($data, $server, $item) = @_;
287     my @params = split(/\s+/, $data);
288
289     if ($params[0] eq 'save') {
290         cmd_save();
291     } elsif ($params[0] eq 'set') {
292         shift(@params);
293         cmd_set(@params);
294     } elsif ($params[0] eq 'show') {
295         shift(@params);
296         cmd_show(@params);
297     } elsif ($params[0] eq 'help') {
298         shift(@params);
299         cmd_help(@params);
300     } elsif ($params[0] eq 'getter') {
301         shift(@params);
302         cmd_getter(@params);
303     } elsif ($params[0] eq 'debug') {
304         $debug = 1;
305         foreach (@grabbers, @getters) {
306             $_->setdebug(1);
307         }
308         write_irssi(undef, 'Enabled debugging');
309     } elsif ($params[0] eq 'nodebug') {
310         $debug = 0;
311         foreach (@grabbers, @getters) {
312             $_->setdebug(0);
313         }
314         write_irssi(undef, 'Disabled debugging');
315     }
316 }
317
318 init_videosite();