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