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