YouTube: Add comment to format list
[videosite.git] / videosite / FileGetter.pm
1 # (c) 2007 by Ralf Ertzinger <ralf@camperquake.de>
2 # licensed under GNU GPL v2
3 #
4 # A getter which will download the media to a local file storage
5 #
6
7 package videosite::FileGetter;
8
9 use videosite::GetterBase;
10 @ISA = qw(videosite::GetterBase);
11
12 use strict;
13 use File::Basename;
14
15 sub new {
16     my $class = shift;
17     my $self = $class->SUPER::new();
18
19     $self->{'NAME'} = 'filegetter';
20     $self->{'_PARAMS'} = {'MINFREE' => ['500000', 'The amount of space that needs to be available on the filesystem before the video is downloaded (in kilobytes)'], 'FILEPATTERN', => ['/tmp/%s - %s - %s.flv', "The file name to save the file under. This is a string which is passed to a sprintf call later on. The parameters passed to that sprintf call, in order, are:\n- The site the video is from\n- The ID of the video\n- The title of the video\n- The URL of the video file itself\n- The URL of the site the video was taken from\nAll parameters are encoded (space and / replaced by _)"]};
21
22     bless($self, $class);
23     $self->_prepare_parameters();
24
25     return $self;
26 }
27
28 sub get {
29     my $self = shift;
30     my $video = shift;
31     my $dlfile;
32     my $dirname;
33     my $ua = $self->ua();
34     my $res;
35
36     $dlfile = sprintf($self->_getval('FILEPATTERN'),
37         $self->_encode($video->{'SOURCE'}),
38         $self->_encode($video->{'ID'}),
39         $self->_encode($video->{'TITLE'}),
40         $self->_encode($video->{'DLURL'}),
41         $self->_encode($video)->{'URL'});
42
43     $dirname = dirname($dlfile);
44     if ($self->_diskfree($dirname) < $self->_getval('MINFREE')) {
45         $self->error("Not enough free space to download");
46         return 0;
47     }
48
49     $self->debug('Going to download %s to %s', $video->{'DLURL'}, $dlfile);
50
51     $res = $ua->mirror($video->{'DLURL'}, $dlfile);
52     if (!$res->is_success()) {
53         $self->error('Could not download %s to %s (%s)', $video->{'DLURL'}, $dlfile, $res->code());
54         return 0;
55     }
56
57     return 1;
58 }
59
60
61 sub _encode {
62     my $self = shift;
63     my $s = shift;
64
65     $s =~ s|[/ ]|_|g;
66
67     return $s;
68 }
69
70 sub _diskfree {
71
72     # poor man's df
73     # if you want it portable, use Filesys::Statvfs
74
75     my $self = shift;
76     my $dir = shift;
77     my $size;
78
79     open DF, "df -P $dir|" or return 0;
80     my $line = <DF>; # skip header
81
82     if ( $line = <DF> ) {
83         if ($line =~ /\s(\d+)\s+\d{1,3}% (\/.*)$/) {
84             $size = $1;
85         }
86     } else {
87         $size = -1; #some error occurred
88     }
89
90     close DF;
91     return $size;
92 }