9c3b313b58a1c44dcfe2aa98ee29b7b2c3401410
[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_debug($witem, 'Metadata: %s', Dumper($m));
90             write_irssi($witem, '%%R>>> %%NSaving %%Y%s%%N %%G%s', $m->{'SOURCE'}, $m->{'TITLE'});
91             unless($getter->get($m)) {
92                 write_irssi($witem, '%%R>>> FAILED');
93             }
94         }
95     }
96 }
97
98 sub cmd_save {
99
100     eval {
101         open(CONF, '>'.$conffile) or die 'Could not open config file';
102         print CONF XML::Simple::XMLout($conf, KeepRoot => 1, KeyAttr => {'config' => 'module', 'option' => 'key'});
103         close(CONF);
104     };
105     if ($@) {
106         write_irssi(undef, 'videosite: Could not save config to %s: %s', ($conffile, $@));
107     } else {
108         write_irssi(undef, 'Videosite configuration saved to %s', $conffile);
109     }
110 }
111
112 sub cmd_set {
113     my $target = shift;
114     my $key = shift;
115     my $val = shift;
116     my $p;
117
118     foreach $p (@getters, @grabbers) {
119         if ($p->{'NAME'} eq $target) {
120             $p->setval($key, $val);
121             return;
122         }
123     }
124     write_irssi(undef, 'No such module');
125 }
126
127 sub cmd_show {
128     my $target = shift;
129     my $p;
130
131     if (defined($target)) {
132         foreach $p (@getters, @grabbers) {
133             if ($p->{'NAME'} eq $target) {
134                 write_irssi(undef, $p->getconfstr());
135                 return;
136             }
137         }
138         write_irssi(undef, 'No such module');
139     } else {
140         write_irssi(undef, 'Loaded grabbers:');
141         foreach $p (@grabbers) {
142             write_irssi(undef, ' ' . $p->{'NAME'});
143         };
144
145         write_irssi(undef, 'Loaded getters:');
146         foreach $p (@getters) {
147             write_irssi(undef, ' ' . $p->{'NAME'});
148         };
149     }
150 }
151
152 sub cmd_help {
153     my $target = shift;
154     my $p;
155
156     if (defined($target)) {
157         foreach $p (@getters, @grabbers) {
158             if ($p->{'NAME'} eq $target) {
159                 write_irssi(undef, $p->gethelpstr());
160                 return;
161             }
162         }
163         write_irssi(undef, 'No such module');
164     } else {
165         write_irssi(undef, <<'EOT');
166 Supported commands:
167  save: Save the current configuration
168  help [modulename]: Display this help, or module specific help
169  show [modulename]: Show loaded modules, or the current parameters of a module
170  set modulename parameter value: set a module parameter to a new value
171  getter [modulename]: display or set the getter to use
172  debug: enable debugging messages
173  nodebug: disable debugging messages
174 EOT
175     }
176 }
177
178 sub cmd_getter {
179     my $target = shift;
180     my $p;
181
182     if (defined($target)) {
183         foreach $p (@getters, @grabbers) {
184             if (($p->{'NAME'} eq $target) && ($p->{'TYPE'} eq 'getter')) {
185                 $getter = $p;
186                 $conf->{'videosite'}->{'getter'} = $target;
187                 return;
188             }
189         }
190         write_irssi(undef, 'No such getter');
191     } else {
192         write_irssi(undef, 'Current getter: %s', $conf->{'videosite'}->{'getter'});
193     }
194 }
195
196
197 # save on unload
198 sub sig_command_script_unload {
199     my $script = shift;
200     if ($script =~ /(.*\/)?videosite(\.pl)?$/) {
201         cmd_save();
202     }
203 }
204
205 sub ploader {
206
207     my $dir = shift;
208     my $pattern = shift;
209     my $type = shift;
210     my @list;
211     my $p;
212     my $g;
213     my @g = ();
214
215     opendir(D, $dir) || return ();
216     @list = grep {/$pattern/ && -f File::Spec->catfile($dir, $_) } readdir(D);
217     closedir(D);
218
219     foreach $p (@list) {
220         write_debug(undef, "Trying to load $p:");
221         $p =~ s/\.pm$//;
222         eval qq{ require $p; };
223         if ($@) {
224             write_debug(undef, "Failed to load plugin: $@");
225             next;
226         }
227
228         $g = eval $p.q{->new();};
229         if ($@) {
230             write_debug(undef, "Failed to instanciate: $@");
231             next;
232         }
233
234         write_debug(undef, "found $g->{'TYPE'} $g->{'NAME'}");
235         if ($type eq $g->{'TYPE'}) {
236             push(@g, $g);
237         } else {
238             write_irssi(undef, '%s has wrong type (got %s, expected %s)', $p, $g->{'TYPE'}, $type);
239         }
240     }
241
242     write_debug(undef, "Loaded %d plugins", $#g+1);
243     
244     return @g;
245 }
246
247 sub init_videosite {
248
249     my $p;
250
251     unless(-r $conffile && defined($conf = XML::Simple::XMLin($conffile, ForceArray => ['config', 'option'], KeepRoot => 1, KeyAttr => {'config' => 'module', 'option' => 'key'}))) {
252         # No config, start with an empty one
253         write_debug(undef, 'No config found, using defaults');
254         $conf = { 'videosite' => { 'getter' => '' }};
255     }
256
257     unshift(@INC, File::Spec->catfile(Irssi::get_irssi_dir(), 'scripts', 'videosite'));
258     @grabbers = ploader(File::Spec->catfile(Irssi::get_irssi_dir(), 'scripts', 'videosite'), '.*Grabber\.pm$', 'grabber');
259     @getters = ploader(File::Spec->catfile(Irssi::get_irssi_dir(), 'scripts', 'videosite'), '.*Getter\.pm$', 'getter');
260
261     unless (defined(@grabbers) && defined(@getters)) {
262         write_irssi(undef, 'No grabbers or no getters found, can not proceed.');
263         return;
264     }
265
266     $getter = $getters[0];
267     foreach $p (@getters) {
268         if ($conf->{'videosite'}->{'getter'} eq $p->{'NAME'}) {
269             $getter = $p;
270         }
271     }
272     write_debug(undef, 'Selected %s as getter', $getter->{'NAME'});
273     $conf->{'videosite'}->{'getter'} = $getter->{'NAME'};
274
275     # Loop through all plugins and load the config
276     foreach $p (@grabbers, @getters) {
277         $conf->{'videosite'}->{'config'}->{$p->{'NAME'}} = $p->mergeconfig($conf->{'videosite'}->{'config'}->{$p->{'NAME'}});
278     }
279
280     Irssi::signal_add_first('command script load', 'sig_command_script_unload');
281     Irssi::signal_add_first('command script unload', 'sig_command_script_unload');
282     Irssi::signal_add('setup saved', 'cmd_save');
283
284
285     Irssi::command_bind('videosite' => \&cmdhandler);
286 }
287
288 sub cmdhandler {
289     my ($data, $server, $item) = @_;
290     my @params = split(/\s+/, $data);
291
292     if ($params[0] eq 'save') {
293         cmd_save();
294     } elsif ($params[0] eq 'set') {
295         shift(@params);
296         cmd_set(@params);
297     } elsif ($params[0] eq 'show') {
298         shift(@params);
299         cmd_show(@params);
300     } elsif ($params[0] eq 'help') {
301         shift(@params);
302         cmd_help(@params);
303     } elsif ($params[0] eq 'getter') {
304         shift(@params);
305         cmd_getter(@params);
306     } elsif ($params[0] eq 'debug') {
307         $debug = 1;
308         foreach (@grabbers, @getters) {
309             $_->setdebug(1);
310         }
311         write_irssi(undef, 'Enabled debugging');
312     } elsif ($params[0] eq 'nodebug') {
313         $debug = 0;
314         foreach (@grabbers, @getters) {
315             $_->setdebug(0);
316         }
317         write_irssi(undef, 'Disabled debugging');
318     }
319 }
320
321 init_videosite();