YouTube: Add comment to format list

[videosite.git] / videosite / Base.pm

diff --git a/videosite/Base.pm b/videosite/Base.pm
index 939e203..577eb52 100644 (file)
--- a/videosite/Base.pm
+++ b/videosite/Base.pm
@@ -1,15 +1,17 @@
 # (c) 2007 by Ralf Ertzinger <ralf@camperquake.de>
 # licensed under GNU GPL v2
 
-package Base;
+package videosite::Base;
 
 use strict;
-use Irssi;
+use LWP::UserAgent;
+use HTTP::Cookies;
+use Data::Dumper;
 
 sub new {
     my $class = shift;
-    my $self = {'_DEBUG' => 0};
-
+    my $self = {'_DEBUG' => 0, '_OUT' => sub {printf(@_)}};
+    
     bless($self, $class);
 
     $self->_prepare_parameters();
@@ -21,7 +23,9 @@ sub error {
     my $self = shift;
     my @data = @_;
 
-    Irssi::print(sprintf(shift(@_), @_));
+    $data[0] = "(" . ref($self) . ") " . $data[0];
+
+    $self->{'_OUT'}(@data);
 }
 
 sub debug {
@@ -52,7 +56,7 @@ sub _prepare_parameters {
     my $self = shift;
     my $p;
 
-    $self->{'_CONFIG'} = {'option' => {}};
+    $self->{'_CONFIG'} = {'option' => {'enabled' => {'content' => '1'}}};
 
     foreach $p (keys(%{$self->{'_PARAMS'}})) {
         $self->{'_CONFIG'}->{'option'}->{$p}->{'content'} = $self->{'_PARAMS'}->{$p}->[0];
@@ -62,8 +66,12 @@ sub _prepare_parameters {
 sub _getval {
     my $self = shift;
     my $key = shift;
+    my $val;
 
-    return $self->{'_CONFIG'}->{'option'}->{$key}->{'content'}
+    $val = $self->{'_CONFIG'}->{'option'}->{$key}->{'content'};
+    $self->debug('Returning %s=%s', $key, $val);
+
+    return $val;
 }
 
 sub setval {
@@ -78,6 +86,13 @@ sub setval {
     }
 }
 
+sub setio {
+    my $self = shift;
+    my $io = shift;
+
+    $self->{'_OUT'} = $io;
+}
+
 sub getconfstr {
     my $self = shift;
     my $s = 'Options for ' . $self->{'NAME'} . ":\n";
@@ -88,7 +103,7 @@ sub getconfstr {
         $p = $self->{'_CONFIG'}->{'option'}->{$k}->{'content'};
         $p =~ s/%/%%/g;
         $s .= sprintf("  %s: %s", $k, $p);
-        if ($self->{'_CONFIG'}->{'option'}->{$k}->{'content'} == $self->{'_PARAMS'}->{$k}->[0]) {
+        if ($self->{'_CONFIG'}->{'option'}->{$k}->{'content'} eq $self->{'_PARAMS'}->{$k}->[0]) {
             $s .= " (default)\n";
         } else {
             $s .= "\n";
@@ -98,6 +113,30 @@ sub getconfstr {
     return $s;
 }
 
+# Return a list of the parameters supported by the module
+# Does not return the 'enabled' parameter
+sub getparamlist {
+    my $self = shift;
+    my $word = shift;
+
+    return grep {$_ ne 'enabled' && /^$word/} keys %{$self->{'_PARAMS'}};
+}
+
+# Return a list of valid parameter values, if the parameter has
+# such a list.
+sub getparamvalues {
+    my $self = shift;
+    my $param = shift;
+    my $word = shift;
+
+    unless(exists($self->{'_PARAMS'}->{$param}->[2])) {
+        return ();
+    } else {
+        return grep {/^$word/} keys %{$self->{'_PARAMS'}->{$param}->[2]};
+    }
+}
+
+
 sub gethelpstr {
     my $self = shift;
     my $s = 'Help for ' . $self->{'NAME'} . ":\n";
@@ -112,7 +151,16 @@ sub gethelpstr {
     foreach $k (keys(%{$self->{'_CONFIG'}->{'option'}})) {
         $p = $self->{'_PARAMS'}->{$k}->[0];
         $p =~ s/%/%%/g;
-        $s .= sprintf("  %s: %s (default: %s)\n", $k, $self->{'_PARAMS'}->{$k}->[1], $p);
+        if (exists($self->{'_PARAMS'}->{$k}->[2])) {
+            # The parameter has a list of allowed values. Add the keys and their help
+            $s .= sprintf("  %s: %s (default: %s)\n", $k, $self->{'_PARAMS'}->{$k}->[1], $p);
+            foreach (sort keys(%{$self->{'_PARAMS'}->{$k}->[2]})) {
+                $s .= sprintf("     %s: %s\n", $_, $self->{'_PARAMS'}->{$k}->[2]->{$_});
+            }
+        } else {
+            # The parameter just has a default value and a help text
+            $s .= sprintf("  %s: %s (default: %s)\n", $k, $self->{'_PARAMS'}->{$k}->[1], $p);
+        }
     }
 
     return $s;
@@ -124,4 +172,19 @@ sub setdebug {
     $self->{'_DEBUG'} = shift;
 }
 
+sub ua {
+    my $self = shift;
+
+    return LWP::UserAgent->new('agent' => 'Mozilla/5.0', 'cookie_jar' => HTTP::Cookies->new);
+}
+
+sub decode_hexurl {
+    my $self = shift;
+    my $d = shift;
+
+    $d =~ s/%([[:xdigit:]]{2})/chr(hex($1))/ge;
+
+    return $d;
+}
+
 1;