Add a new youtube URL format
[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 LWP::UserAgent;
15 use HTTP::Cookies;
16 use HTML::TokeParser;
17 use HTML::Entities qw(decode_entities);
18 use Encode;
19 use Data::Dumper;
20 use videosite::JSArrayParser;
21
22 use strict;
23
24 sub new {
25     my $class = shift;
26     my $self = $class->SUPER::new();
27
28     $self->{'NAME'} = 'youtube';
29     $self->{'PATTERNS'} = ['(http://(?:[-a-zA-Z0-9_.]+\.)*youtube\.(?:com|de|co.uk)/watch\?(?:.+=.+&)*v=([-a-zA-Z0-9_]+))',
30                            '(http://(?:[-a-zA-Z0-9_.]+\.)*youtube\.(?:com|de|co.uk)/watch\#\!v=([-a-zA-Z0-9_]+))',
31                            '(http://(?:[-a-zA-Z0-9_.]+\.)*youtube\.(?:com|de|co.uk)/v/([-a-zA-Z0-9_]+))',
32                            '(http://(?:[-a-zA-Z0-9_.]+\.)*youtu\.be/([-a-zA-Z0-9_]+))',
33                            '(http://(?:[-a-zA-Z0-9_.]+\.)*youtube\.(?:com|de|co.uk)/user/\w+\?.*/([-a-zA-Z0-9_]+))'];
34     $self->{'_PARAMS'} = {
35             'QUALITY' => ['normal', 'Quality of the video to download.', {
36                     'normal' => 'standard resolution flash video',
37                     'high' => 'higher resolution flash video',
38                     'h264' => 'high resolution MPEG4 video',
39                     'hd' => 'HD720 resolution'}],
40             'USERNAME' => ['', 'Username to use for YouTube login'],
41             'PASSWORD' => ['', 'Password to use for YouTube login']};
42
43     bless($self, $class);
44     $self->_prepare_parameters();
45
46     return $self;
47 }
48
49 sub _parse {
50     my $self = shift;
51     my $url = shift;
52     my $pattern = shift;
53     my $content;
54     my $metadata = {};
55     my $p;
56     my $e;
57     my $tag;
58     my $jar = HTTP::Cookies->new;
59     my $ua = LWP::UserAgent->new('agent' => 'Mozilla/5.0');
60     my $r;
61     my $videourl;
62     my $quality = $self->_getval('QUALITY');
63     my %preflist = (
64         'hd' => [37, 22, 35, 18, 34, 6, 5],
65         'h264' => [18, 34, 37, 22, 35, 6, 5],
66         'high' => [34, 35, 18, 37, 22, 6, 5],
67         'normal' => [6, 5, 34, 35, 18, 22, 37]);
68     my $preflist;
69     my $jsp;
70
71     $url =~ m|$pattern|;
72     $url = $1;
73
74     $metadata->{'URL'} = $url;
75     $metadata->{'ID'} = $2;
76     $metadata->{'TYPE'} = 'video';
77     $metadata->{'SOURCE'} = $self->{'NAME'};
78     $metadata->{'TITLE'} = undef;
79     $metadata->{'DLURL'} = undef;
80
81     $self->debug("Matched id %s from pattern %s", $2, $pattern);
82
83     $preflist = $preflist{$quality};
84     $self->debug("Quality: %s, preflist: [%s]", $quality, join(", ", @{$preflist}));
85
86     $videourl = sprintf('http://www.youtube.com/watch?v=%s', $2);
87
88     unless(defined($r = $ua->get($videourl))) {
89         $self->error('Could not download %s', $url);
90         return undef;
91     }
92
93     if ($r->base->as_string() =~ m,/verify_age,) {
94         $self->debug('Video requires age verification');
95         $ua->cookie_jar($jar);
96         $r = $self->__login($videourl, $ua);
97         unless(defined($r)) {
98             $self->error('Could not log into YouTube');
99             return undef;
100         }
101     }
102     $content = $r->content();
103
104     $p = HTML::TokeParser->new(\$content);
105
106     SWF_ARGS: while ($tag = $p->get_tag('div', 'meta', 'script')) {
107         if ('meta' eq $tag->[0]) {
108             if ('title' eq $tag->[1]->{'name'}) {
109                 $metadata->{'TITLE'} = $tag->[1]->{'content'};
110                 # Convert HTML entities in the title. This is a bit convoluted.
111                 $metadata->{'TITLE'} = encode("utf8",
112                                          decode_entities(
113                                            decode("utf8", $metadata->{'TITLE'})));
114                     
115                 $self->debug('Title found: %s', $metadata->{'TITLE'});
116             }
117         } elsif ('script' eq $tag->[0]) {
118             $e = $p->get_text();
119             $self->debug("Found script: %s", $e);
120             if ($e =~ m|\x27SWF_ARGS\x27:\s+(.+),|) {
121                 my %urls;
122                 my $args = $1;
123
124                 $self->debug("Found SWF_ARGS: %s", $args);
125                 $jsp = videosite::JSArrayParser->new();
126                 $self->debug("Using %s to parse", ref($jsp));
127                 $r = $jsp->parse($args);
128
129                 unless(defined($r)) {
130                     $self->error("Found information hash, but could not parse");
131                     return undef;
132                 }
133
134                 if (exists($r->{'fmt_url_map'}) and ($r->{'fmt_url_map'} ne '')) {
135                     my $urls =  $r->{'fmt_url_map'};
136
137                     $self->debug("Video has fmt_url_map: %s", $urls);
138
139                     $urls =~ s/%([[:xdigit:]]{2})/chr(hex($1))/ge;
140                     %urls = split(/[\|,]/, $urls);
141                 } elsif (exists($r->{'t'}) and ($r->{'t'} ne '')) {
142                     my $thash = $r->{'t'};
143
144                     if (exists($r->{'fmt_map'}) && ($r->{'fmt_map'} ne '')) {
145                         my $fmt = $r->{'fmt_map'};
146                         my @fmt;
147
148                         $self->debug('Video has fmt_map');
149                         $fmt =~ s/%([[:xdigit:]]{2})/chr(hex($1))/ge;
150                         @fmt = split(/,/, $fmt);
151                         foreach (@fmt) {
152                             split(/\//);
153                             $urls{$_[0]} =  sprintf('http://www.youtube.com/get_video?video_id=%s&fmt=%d&t=%s', 
154                                 $metadata->{'ID'},
155                                 $_[0],
156                                 $thash);
157                         }
158                     } else {
159                         $urls{5} = sprintf('http://www.youtube.com/get_video?video_id=%s&t=%s',
160                             $metadata->{'ID'},
161                             $thash);
162                     }
163                 } else {
164                     $self->error('Neither fmt_url_map nor t found in video information hash');
165                     return undef;
166                 }
167                 $self->debug("Found quality levels [%s]", join(", ", keys(%urls)));
168
169                 foreach (keys(%urls)) {
170                     if ($_ == 35) {
171                         $self->debug('Found flv,h264,large: %s', $urls{$_});
172                     } elsif ($_ == 34) {
173                         $self->debug('Found flv,h264: %s', $urls{$_});
174                     } elsif ($_ == 22) {
175                         $self->debug('Found mp4,h264,720p: %s', $urls{$_});
176                     } elsif ($_ == 37) {
177                         $self->debug('Found mp4,h264,1080p: %s', $urls{$_});
178                     } elsif ($_ == 18) {
179                         $self->debug('Found mp4,h264: %s', $urls{$_});
180                     } elsif ($_ == 5) {
181                         $self->debug('Found flv,flv: %s', $urls{$_});
182                     } else {
183                         $self->error('Unknown tag %s: %s', $_, $urls{$_});
184                     }
185                 }
186
187                 foreach (@{$preflist}) {
188                     if (exists($urls{$_})) {
189                         $self->debug("Selected URL with quality level %s", $_);
190                         $metadata->{'DLURL'} = $urls{$_};
191                         last;
192                     }
193                 }
194
195                 $self->debug('URL found: %s', $metadata->{'DLURL'});
196                 last SWF_ARGS;
197             }
198         } elsif ('div' eq $tag->[0]) {
199             if (exists($tag->[1]->{'class'}) and ('yt-alert-content' eq $tag->[1]->{'class'})) {
200                 $self->error("Could not get video data for youtube %s: %s",
201                         $metadata->{'ID'}, $p->get_trimmed_text());
202                 return undef;
203             }
204         }
205     }
206
207     unless(defined($metadata->{'DLURL'}) && defined($metadata->{'TITLE'})) {
208         $self->error('Could not determine download URL');
209         return undef;
210     }
211
212     return $metadata;
213 }
214
215 sub __login {
216     my $self = shift;
217     my $videourl = shift;
218     my $ua = shift;
219     my $user = $self->_getval('USERNAME');
220     my $pass = $self->_getval('PASSWORD');
221     my $r;
222     my $p;
223     my $c;
224     my $token;
225
226     sub check_cookie {
227
228         my $jar = shift;
229         my $key = shift;
230         my $found = undef;
231
232         $jar->scan(sub { $found = 1 if ( $key eq $_[1]) });
233
234         return $found;
235     }
236
237     if (($user eq '') or ($pass eq '')) {
238         $self->error('No username or password defined for YouTube');
239         return undef;
240     }
241
242     $self->debug('Logging in');
243     $r = $ua->post('http://www.youtube.com/signup', { 'next' => '/', 'current_form' => 'login', 'action_login' => '1', 'username' => $user, 'password' => $pass });
244
245     unless(check_cookie($ua->cookie_jar, 'LOGIN_INFO')) {
246         $self->error('Could not log into YouTube');
247         return undef;
248     }
249
250     $self->debug("Got a cookie");
251
252     $r = $ua->get($videourl);
253     if ($r->base->as_string() =~ m,/verify_age,) {
254         $self->debug("Looking for session token...");
255         $c = $r->decoded_content();
256         $p = HTML::TokeParser->new(\$c);
257         while (my $tag = $p->get_tag('script')) {
258             if ($p->get_text() =~ /gXSRF_token = '(.+)'/) {
259                 $token = $1;
260                 last;
261             }
262         }
263
264         unless(defined($token)) {
265             $self->error("Could not find session token");
266             return undef;
267         }
268
269         $self->debug('Authenticating session...');
270         $r = $ua->post($r->base->as_string, { 'next_url' => $r->base->path, 'action_confirm' => 'Confirm Birth Date', 'session_token' => $token });
271     }
272
273     unless(check_cookie($ua->cookie_jar, 'is_adult')) {
274         $self->error('Could not authenticate session');
275         return undef;
276     }
277
278     return $ua->get($videourl);
279 }
280
281 1;