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