Change new() function in plugins to avoid having to call _prepare_parameters() in...
[videosite.git] / videosite / YouTubeGrabber.pm
1 # (c) 2007 by Ralf Ertzinger <ralf@camperquake.de>
2 # licensed under GNU GPL v2
3 #
4 # Grabber for youtube.com/de/...
5 #
6 # download strategy revised using
7 # http://www.kde-apps.org/content/show.php?content=41456
8
9 package videosite::YouTubeGrabber;
10
11 use videosite::GrabberBase;
12 @ISA = qw(videosite::GrabberBase);
13
14 use HTML::TokeParser;
15 use HTML::Entities qw(decode_entities);
16 use Encode;
17 use Data::Dumper;
18 use videosite::JSArrayParser;
19
20 use strict;
21
22 my %preflist = (
23     'insane' => [38, 37, 22, 35, 18, 34, 6, 5, 43],
24     'hd' => [37, 22, 35, 18, 34, 6, 5, 38, 43],
25     'h264' => [18, 34, 37, 22, 35, 6, 5, 38, 43],
26     'high' => [34, 35, 18, 37, 22, 6, 5, 38, 43],
27     'normal' => [6, 5, 34, 35, 18, 22, 37, 38, 43]);
28 my %videoformats = (
29     # Container/Video codec/Audio codec/Resolution
30     5 => 'FLV/Sorenson/MP3/240p',
31     6 => 'FLV/Sorenson/MP3/270p',
32     13 => '3GP/MPEG4-Visual/144p',  # 0.5MBit
33     17 => '3GP/MPEG4-Visual/144p',  # 2MBit
34     18 => 'MP4/H264/AAC/360p',      # isommp42, Baseline
35     22 => 'MP4/H264/AAC/720p',      # isommp42, High
36     34 => 'FLV/H264/AAC/360p',      # Main
37     35 => 'FLV/H264/AAC/480p',      # Main
38     36 => '3GP/MPEG4-Visual/240p',
39     37 => 'MP4/H264/AAC/1080p',     # High
40     38 => 'MP4/H264/AAC/3072p',     # High
41     43 => 'WebM/VP8/Vorbis/360p',   
42     44 => 'WebM/VP8/Vorbis/480p',
43     45 => 'WebM/VP8/Vorbis/720p',
44     46 => 'WebM/VP8/Vorbis/1080p/3D',  # effective 540p
45     82 => 'MP4/H264/AAC/360p/3D',      # isomavc1mp42
46     83 => 'MP4/H264/AAC/240p/3D',      # isomavc1mp42
47     84 => 'MP4/H264/AAC/720p/3D',      # isomavc1mp42
48     85 => 'MP4/H264/AAC/1080p/3D',     # isomavc1mp42, effective 540p
49     100 => 'WebM/VP8/Vorbis/360p/3D',
50     101 => 'WebM/VP8/Vorbis/480p/3D',
51     102 => 'WebM/VP8/Vorbis/720p/3D',
52     );
53
54 sub new {
55     my $class = shift;
56     my $self = $class->SUPER::new(
57         NAME => 'youtube',
58         _SELFTESTURL => 'http://www.youtube.com/watch?v=dMH0bHeiRNg',
59         _SELFTESTTITLE => 'Evolution of Dance - By Judson Laipply',
60         PATTERNS => ['(https?://(?:[-a-zA-Z0-9_.]+\.)*youtube\.(?:com|de|co.uk)/watch(?:_popup)?\?.*?v=([-a-zA-Z0-9_]+))',
61                      '(https?://(?:[-a-zA-Z0-9_.]+\.)*youtube\.(?:com|de|co.uk)/watch\#\!v=([-a-zA-Z0-9_]+))',
62                      '(https?://(?:[-a-zA-Z0-9_.]+\.)*youtube\.(?:com|de|co.uk)/v/([-a-zA-Z0-9_]+))',
63                      '(https?://(?:[-a-zA-Z0-9_.]+\.)*youtube\.(?:com|de|co.uk)/embed/([-a-zA-Z0-9_]+))',
64                      '(https?://(?:[-a-zA-Z0-9_.]+\.)*youtube\.(?:com|de|co.uk)/user/[[:alnum:]]+\?v=([-a-zA-Z0-9_]+))',
65                      '(https?://(?:[-a-zA-Z0-9_.]+\.)*youtube\.(?:com|de|co.uk)/(?:user/)?[[:alnum:]]+#p/(?:\w+/)+\d+/([-a-zA-Z0-9_]+))',
66                      '(https?://(?:[-a-zA-Z0-9_.]+\.)*youtu\.be/watch\?v=([-a-zA-Z0-9_]+))',
67                      '(https?://(?:[-a-zA-Z0-9_.]+\.)*youtu\.be/([-a-zA-Z0-9_]+))',
68                      '(https?://(?:[-a-zA-Z0-9_.]+\.)*youtube\.(?:com|de|co.uk)/user/\w+\?.*/([-a-zA-Z0-9_]+))'],
69         _PARAMS => {
70             QUALITY => ['normal', 'Quality of the video to download.', {
71                            normal => 'standard resolution flash video',
72                            high => 'higher resolution flash video',
73                            h264 => 'high resolution MPEG4 video',
74                            hd => 'HD720 resolution'}],
75             USERNAME => ['', 'Username to use for YouTube login'],
76             PASSWORD => ['', 'Password to use for YouTube login'],
77             HTTPS => [1, 'Whether to use HTTPS (if available) to connect to YouTube']
78         },
79     );
80
81     return bless($self, $class);
82 }
83
84 sub _parse {
85     my $self = shift;
86     my $url = shift;
87     my $pattern = shift;
88     my $id;
89     my $res;
90
91     $url =~ m|$pattern|;
92     $url = $1;
93     $id = $2;
94
95     $self->debug("Matched id %s from pattern %s", $id, $pattern);
96
97     $res = $self->_parse_by_video_info($url, $id);
98     if (defined($res) && ref($res)) {
99         return $res;
100     } else {
101         $res = $self->_parse_by_scrape($url, $id);
102     }
103
104     return $res;
105 }
106
107 sub _parse_by_video_info {
108     my $self = shift;
109     my $url = shift;
110     my $id = shift;
111     my $quality = $self->_getval('QUALITY');
112     my $metadata;
113     my $videourl;
114     my $ua = $self->ua();
115     my $preflist;
116     my $r;
117     my $content;
118     my $urls;
119
120     $metadata->{'URL'} = $url;
121     $metadata->{'ID'} = $id;
122     $metadata->{'TYPE'} = 'video';
123     $metadata->{'SOURCE'} = $self->{'NAME'};
124     $metadata->{'TITLE'} = undef;
125     $metadata->{'DLURL'} = undef;
126
127     $preflist = $preflist{$quality};
128     $self->debug("Quality: %s, preflist: [%s]", $quality, join(", ", @{$preflist}));
129
130     $videourl = sprintf('%s://www.youtube.com/get_video_info?video_id=%s&eurl=%s',
131             $self->_getval('HTTPS')?'https':'http', $id, 'http%3A%2F%2Fwww%2Eyoutube%2Ecom%2F');
132     $self->debug("Video info URL: %s", $videourl);
133
134     $r = $ua->get($videourl);
135     unless($r->is_success()) {
136         $self->debug('Could not download %s: %s', $videourl, $r->code());
137         return undef;
138     }
139
140     $content = $r->content();
141     $self->debug('Content from get_video_info: %s', $content);
142
143     # Decode content
144     $content = $self->decode_querystring($content);
145
146     if ($content->{'status'} ne 'ok') {
147         $self->debug("Non OK status code found: %s", $content->{'status'});
148         return undef;
149     }
150
151     if (exists($content->{'fmt_url_map'})) {
152         # Decode fmt_url_map
153         $urls = $self->decode_hexurl($content->{'fmt_url_map'});
154         $urls = { split /[\|,]/, $urls };
155     } elsif (exists($content->{'url_encoded_fmt_stream_map'})) {
156         $urls = $self->_decode_url_encoded_fmt_stream_map($content->{'url_encoded_fmt_stream_map'}, 1);
157     } else {
158         $self->debug("No URL data found");
159         return undef;
160     }
161
162     unless(exists($content->{'title'})) {
163         $self->debug("No title found");
164         return undef;
165     }
166
167     $self->__pick_url($urls, $preflist, $metadata);
168
169     $metadata->{'TITLE'} = $content->{'title'};
170     $metadata->{'TITLE'} =~ s/\+/ /g;
171     $metadata->{'TITLE'} = $self->decode_hexurl($metadata->{'TITLE'});
172     $metadata->{'TITLE'} = decode("utf8", $metadata->{'TITLE'});
173
174     $self->debug('Title found: %s', $metadata->{'TITLE'});
175
176     unless(defined($metadata->{'DLURL'}) && defined($metadata->{'TITLE'})) {
177         $self->error('Could not determine download URL');
178         return undef;
179     }
180
181     return $metadata;
182 }
183
184 sub _parse_by_scrape {
185     my $self = shift;
186     my $url = shift;
187     my $id = shift;
188     my $content;
189     my $metadata = {};
190     my $p;
191     my $e;
192     my $tag;
193     my $ua = $self->ua();
194     my $r;
195     my $videourl;
196     my $quality = $self->_getval('QUALITY');
197     my $preflist;
198     my $jsp;
199
200     $metadata->{'URL'} = $url;
201     $metadata->{'ID'} = $id;
202     $metadata->{'TYPE'} = 'video';
203     $metadata->{'SOURCE'} = $self->{'NAME'};
204     $metadata->{'TITLE'} = undef;
205     $metadata->{'DLURL'} = undef;
206
207
208     $preflist = $preflist{$quality};
209     $self->debug("Quality: %s, preflist: [%s]", $quality, join(", ", @{$preflist}));
210
211     $videourl = sprintf('%s://www.youtube.com/watch?v=%s', $self->_getval('HTTPS')?'https':'http', $id);
212
213     unless(defined($r = $ua->get($videourl))) {
214         $self->error('Could not download %s', $url);
215         return undef;
216     }
217
218     if ($r->base->as_string() =~ m,/verify_age,) {
219         $self->debug('Video requires age verification');
220         my @logindata = $self->__login($videourl, $ua);
221         $r = $logindata[0];
222         unless(defined($r)) {
223             $self->error('Could not log into YouTube');
224             return undef;
225         }
226     }
227     $content = $r->content();
228
229     $p = HTML::TokeParser->new(\$content);
230
231     SWF_ARGS: while ($tag = $p->get_tag('div', 'meta', 'script')) {
232         if ('meta' eq $tag->[0]) {
233             if (exists($tag->[1]->{'name'}) and ('title' eq $tag->[1]->{'name'})) {
234                 $metadata->{'TITLE'} = $tag->[1]->{'content'};
235                 # Convert HTML entities in the title. This is a bit convoluted.
236                 $metadata->{'TITLE'} = decode_entities(
237                                            decode("utf8", $metadata->{'TITLE'}));
238                     
239                 $self->debug('Title found: %s', $metadata->{'TITLE'});
240             }
241         } elsif ('script' eq $tag->[0]) {
242             my %urls;
243
244             $e = $p->get_text();
245             $self->debug("Found script: %s", $e);
246
247              if ($e =~ m|ytplayer\.config\s*=\s*(.+);$|) {
248                 my $args = $1;
249                 $self->debug("Found PLAYER_CONFIG: %s", $args);
250
251                 $jsp = videosite::JSArrayParser->new();
252                 $self->debug("Using %s to parse", ref($jsp));
253                 $r = $jsp->parse($args);
254
255                 unless(defined($r)) {
256                     $self->error("Found information hash, but could not parse");
257                     return undef;
258                 }
259
260                 if (exists($r->{'args'}) and exists($r->{'args'}->{'ps'}) and ($r->{'args'}->{'ps'} eq 'live')) {
261                     $self->error("Video URL seems to point to a live stream, cannot save this");
262                     return undef;
263                 }
264
265                 if (exists($r->{'args'}) and exists($r->{'args'}->{'fmt_url_map'}) and ($r->{'args'}->{'fmt_url_map'} ne '')) {
266                     my $urls = $r->{'args'}->{'fmt_url_map'};
267
268                     $self->debug("Video has fmt_url_map: %s", $urls);
269
270                     %urls = split(/[\|,]/, $urls);
271                     foreach (keys(%urls)) {
272                         $urls{$_} = $self->decode_hexurl($urls{$_});
273                     }
274                     $self->debug("Pagetype: 2011 (PLAYER_CONFIG), fmt_url_map");
275                 } elsif (exists($r->{'args'}) and exists($r->{'args'}->{'url_encoded_fmt_stream_map'}) and ($r->{'args'}->{'url_encoded_fmt_stream_map'} ne '')) {
276                     %urls = %{$self->_decode_url_encoded_fmt_stream_map($r->{'args'}->{'url_encoded_fmt_stream_map'}, 0)};
277
278                     $self->debug("Pagetype: 2011 (PLAYER_CONFIG), url_encoded_fmt_stream_map");
279                 } else {
280                     $self->error('fmt_url_map not found in PLAYER_CONFIG');
281                     return undef;
282                 }
283             } elsif ($e =~ m|yt\.playerConfig\s*=\s*(.+);\n|) {
284                 my $args = $1;
285                 $self->debug("Found yt.playerConfig: %s", $args);
286
287                 $jsp = videosite::JSArrayParser->new();
288                 $self->debug("Using %s to parse", ref($jsp));
289                 $r = $jsp->parse($args);
290
291                 unless(defined($r)) {
292                     $self->error("Found information hash, but could not parse");
293                     return undef;
294                 }
295
296                 if (exists($r->{'args'}) and exists($r->{'args'}->{'ps'}) and ($r->{'args'}->{'ps'} eq 'live')) {
297                     $self->error("Video URL seems to point to a live stream, cannot save this");
298                     return undef;
299                 }
300
301                 if (exists($r->{'args'}) and exists($r->{'args'}->{'url_encoded_fmt_stream_map'}) and ($r->{'args'}->{'url_encoded_fmt_stream_map'} ne '')) {
302                     %urls = %{$self->_decode_url_encoded_fmt_stream_map($r->{'args'}->{'url_encoded_fmt_stream_map'}, 0)};
303
304                     $self->debug("Pagetype: 2012 (yt.playerConfig), url_encoded_fmt_stream_map");
305                 } else {
306                     $self->error('url_map not found in yt.playerConfig');
307                     return undef;
308                 }
309             }
310
311
312             if (%urls) {
313                 $self->__pick_url(\%urls, $preflist, $metadata);
314                 last SWF_ARGS;
315             }
316         } elsif ('div' eq $tag->[0]) {
317             if (exists($tag->[1]->{'id'}) and ('watch-player-unavailable-message-container' eq $tag->[1]->{'id'})) {
318                 # Search forward to the next <div>
319                 $tag = $p->get_tag('div');
320                 $self->error("Could not get video data for youtube %s: %s",
321                         $metadata->{'ID'}, $p->get_trimmed_text());
322                 return undef;
323             }
324         }
325     }
326
327     unless(defined($metadata->{'DLURL'}) && defined($metadata->{'TITLE'})) {
328         $self->error('Could not determine download URL');
329         return undef;
330     }
331
332     return $metadata;
333 }
334
335 sub __login {
336     my $self = shift;
337     my $videourl = shift;
338     my $ua = shift;
339     my $user = $self->_getval('USERNAME');
340     my $pass = $self->_getval('PASSWORD');
341     my $r;
342     my $p;
343     my $c;
344     my $token;
345
346     sub check_cookie {
347
348         my $jar = shift;
349         my $key = shift;
350         my $found = undef;
351
352         $jar->scan(sub { $found = 1 if ( $key eq $_[1]) });
353
354         return $found;
355     }
356
357     sub get_all_cookies {
358
359         my $jar = shift;
360         my $key = shift;
361         my $val = "";
362         $jar->scan(sub { $val .= "; " if !( $val eq "" ); $val .= "$_[1]=$_[2]" });
363
364         return $val;
365     }
366
367     if (($user eq '') or ($pass eq '')) {
368         $self->error('No username or password defined for YouTube');
369         return undef;
370     }
371
372     $self->debug('Logging in');
373     $r = $ua->get('https://www.google.com/accounts/ServiceLoginAuth?service=youtube');
374     unless($r->is_success()) {
375         $self->debug("Could not get login page (make sure your LWP supports HTTPS!)");
376         return undef;
377     }
378     $c = $r->decoded_content();
379     $p = HTML::TokeParser->new(\$c);
380     while (my $tag = $p->get_tag('input')) {
381         $self->debug("%s", Dumper($tag));
382         if ($tag->[1]{name} eq 'GALX') {
383             $token = $tag->[1]{value};
384             last;
385         }
386     }
387     $self->debug("GALX = %s", $token);
388     $r = $ua->post('https://www.google.com/accounts/ServiceLoginAuth?service=youtube', { 'service' => 'youtube', 'Email' => $user, 'Passwd' => $pass, 'GALX' => $token });
389     unless($r->is_success()) {
390         $self->debug("Could not get login page (make sure your LWP supports HTTPS!)");
391         return undef;
392     }
393     $c = $r -> decoded_content();
394     $p = HTML::TokeParser->new(\$c);
395     while (my $tag = $p->get_tag('script')) {
396         if($p->get_text() =~ /location\.replace\("(.+)"\)/) {
397             $token = $1;
398             $token =~ s/\\x([A-Fa-f0-9]{2})/pack('C', hex($1))/seg;
399             last;
400         }
401     }
402     $r = $ua->get($token);
403     unless(check_cookie($ua->cookie_jar, 'LOGIN_INFO')) {
404         $self->error('Could not log into YouTube');
405         return undef;
406     }
407
408     $self->debug("Got a cookie");
409
410     $r = $ua->get($videourl);
411     if ($r->base->as_string() =~ m,/verify_age,) {
412         $self->debug("Looking for session token...");
413         $c = $r->decoded_content();
414         $p = HTML::TokeParser->new(\$c);
415         while (my $tag = $p->get_tag('script')) {
416             if ($p->get_text() =~ /'XSRF_TOKEN': '(.+)'/) {
417                 $token = $1;
418                 last;
419             }
420         }
421
422         unless(defined($token)) {
423             $self->error("Could not find session token");
424             return undef;
425         }
426
427         $self->debug('Authenticating session...');
428         $r = $ua->post($r->base->as_string, { 'next_url' => $r->base->path, 'action_confirm' => 'Confirm Birth Date', 'session_token' => $token });
429     }
430
431 # Apparently there is no longer a specific "is_adult" cookie
432 # or, by the looks of it, anything similar
433 #
434 #    unless(check_cookie($ua->cookie_jar, 'is_adult')) {
435 #        $self->error('Could not authenticate session');
436 #        return undef;
437 #    }
438
439     my $cookie = get_all_cookies($ua->cookie_jar);
440     return ($ua->get($videourl), $cookie);
441 }
442
443 # Take an encoded url_encoded_fmt_stream_map and return a hash
444 # matching video IDs to download URLs
445 sub _decode_url_encoded_fmt_stream_map {
446     my $self = shift;
447     my $data = shift;
448     my $dataencoded = shift;
449     my @data;
450     my $h = {};
451
452     $data = $self->decode_hexurl($data) if $dataencoded;
453     # This will
454     # - Split the decoded string into segments (along ,)
455     # - Interpret each segment as a concatenated key-value list (key and value separated by =, pairs separated by &
456     # - URL-decode each key and value _again_
457     #
458     # @data will be an array of hash references
459     
460     @data = map { { map { $self->decode_hexurl($_) } split /[&=]/  } } split /,/, $data;
461     $self->debug("_decode_url_encoded_fmt_stream_map() decoded %s", Dumper(\@data));
462
463     # From each array entry, pick the itag and the url values and return that
464     # as a hash reference
465     
466
467     foreach (@data) {
468         if (exists($_->{'sig'})) {
469             $h->{$_->{'itag'}} = sprintf('%s&signature=%s', $_->{'url'}, $_->{'sig'});
470         } else {
471             $h->{$_->{'itag'}} =  $_->{'url'};
472         }
473     }
474
475     return $h;
476 }
477
478
479
480 sub __pick_url {
481     my $self = shift;
482     my $urls = shift;
483     my $preflist = shift;
484     my $metadata = shift;
485
486     foreach (keys(%{$urls})) {
487         if (exists($videoformats{$_})) {
488             $self->debug('Found URL for format %s (%s): %s', $_, $videoformats{$_}, $urls->{$_});
489         } else {
490             $self->error('Unknown format %s: %s', $_, $urls->{$_});
491         }
492     }
493
494     foreach (@{$preflist}) {
495         if (exists($urls->{$_})) {
496             $self->debug("Selected URL with quality level %s", $_);
497             $metadata->{'DLURL'} = $urls->{$_};
498             if (exists($videoformats{$_})) {
499                 $metadata->{'FORMAT'} = $videoformats{$_};
500             } else {
501                 $metadata->{'FORMAT'} = 'unknown';
502             }
503             last;
504         }
505     }
506
507     $self->debug('URL found: %s', $metadata->{'DLURL'});
508 }
509
510 1;
511