X-Git-Url: https://git.camperquake.de/gitweb.cgi?a=blobdiff_plain;f=videosite%2FBase.pm;h=923585aee35105f4e41426cbf199666314570532;hb=c3e786cc2000051ed931b918f3e4929b3b0abea8;hp=b31fcb6d8adbe428482683e73bd8a8f91e345b9c;hpb=bde8149e4eac9d8c194adf1daa99ca8ccddb6d82;p=videosite.git diff --git a/videosite/Base.pm b/videosite/Base.pm index b31fcb6..923585a 100644 --- a/videosite/Base.pm +++ b/videosite/Base.pm @@ -11,16 +11,19 @@ use Data::Dumper; sub new { my $class = shift; my $self = {'_DEBUG' => 0, - '_OUT' => sub {printf(@_)}, - '_CONNECTORS' => sub { return ({ 'name' => 'direct', - 'schemas' => {} }) }, '_CONNECTOR' => undef, + _API => { + io => sub { printf(@_) }, + connectors => sub { return ({ 'name' => 'direct', + 'schemas' => {} }) }, + }, + @_, }; + # Add the 'enabled' property to all modules + $self->{_PARAMS}->{enabled} = [1, 'Whether the module is enabled']; bless($self, $class); - $self->_prepare_parameters(); - return $self; } @@ -30,7 +33,7 @@ sub error { $data[0] = "(" . ref($self) . ") " . $data[0]; - $self->{'_OUT'}(@data); + $self->{_API}->{io}->(@data); } sub debug { @@ -41,41 +44,23 @@ sub debug { if ($self->{'_DEBUG'} != 0) {$self->error(@data)}; } -sub mergeconfig { - my $self = shift; - my $c = shift; - my $o; - - return $self->{'_CONFIG'} unless defined($c); - - foreach $o (keys(%{$c->{'option'}})) { - if (exists($self->{'_CONFIG'}->{'option'}->{$o})) { - $self->{'_CONFIG'}->{'option'}->{$o}->{'content'} = $c->{'option'}->{$o}->{'content'}; - } - } - - return $self->{'_CONFIG'}; -} - -sub _prepare_parameters { - my $self = shift; - my $p; - - $self->{'_CONFIG'} = {'option' => {'enabled' => {'content' => '1'}}}; - - foreach $p (keys(%{$self->{'_PARAMS'}})) { - $self->{'_CONFIG'}->{'option'}->{$p}->{'content'} = $self->{'_PARAMS'}->{$p}->[0]; - } -} - sub _getval { my $self = shift; my $key = shift; + my $path = ['plugin', $self->{NAME}, $key]; my $val; - $val = $self->{'_CONFIG'}->{'option'}->{$key}->{'content'}; - $self->debug('Returning %s=%s', $key, $val); + # Try to read from the global config + # Fall back to default + if ($self->{_API}->{config_has}->($path)) { + $val = $self->{_API}->{config_get}->($path); + } elsif (exists($self->{_PARAMS}->{$key})) { + $val = $self->{_PARAMS}->{$key}->[0]; + } else { + $self->error('Requested unknown config key %s', $key); + } + $self->debug('Returning %s=%s', $key, $val); return $val; } @@ -83,32 +68,25 @@ sub setval { my $self = shift; my $key = shift; my $val = shift; + my $path = ['plugin', $self->{NAME}, $key]; - if (exists($self->{'_CONFIG'}->{'option'}->{$key})) { - $self->{'_CONFIG'}->{'option'}->{$key}->{'content'} = $val; + if (exists($self->{'_PARAMS'}->{$key})) { + $self->{_API}->{config_set}->($path, $val); } else { - $self->error('Module %s does not have a parameter named %s', $self->{'NAME'}, $key); + $self->error('Module does not have a parameter named %s', $self->$key); } } -sub setio { - my $self = shift; - my $io = shift; - - $self->{'_OUT'} = $io; -} - sub getconfstr { my $self = shift; my $s = 'Options for ' . $self->{'NAME'} . ":\n"; my $k; my $p; - foreach $k (keys(%{$self->{'_CONFIG'}->{'option'}})) { - $p = $self->{'_CONFIG'}->{'option'}->{$k}->{'content'}; - $p =~ s/%/%%/g; + foreach $k (keys(%{$self->{'_PARAMS'}})) { + $p = $self->{_API}->{config_get}->{$k}; $s .= sprintf(" %s: %s", $k, $p); - if ($self->{'_CONFIG'}->{'option'}->{$k}->{'content'} eq $self->{'_PARAMS'}->{$k}->[0]) { + if ($p eq $self->{'_PARAMS'}->{$k}->[0]) { $s .= " (default)\n"; } else { $s .= "\n"; @@ -153,9 +131,8 @@ sub gethelpstr { } $s .= " Options:\n"; - foreach $k (keys(%{$self->{'_CONFIG'}->{'option'}})) { + foreach $k (keys(%{$self->{'_PARAMS'}})) { $p = $self->{'_PARAMS'}->{$k}->[0]; - $p =~ s/%/%%/g; 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); @@ -181,7 +158,11 @@ sub ua { my $self = shift; my $ua; - $ua = LWP::UserAgent->new('agent' => 'Mozilla/5.0', 'cookie_jar' => HTTP::Cookies->new); + $ua = LWP::UserAgent->new( + 'agent' => 'Mozilla/5.0', + 'cookie_jar' => HTTP::Cookies->new, + 'timeout' => 15, + ); # Remove a currently defined HTTPS proxy. See below for a longer explanation. delete($ENV{'HTTPS_PROXY'}); @@ -217,9 +198,17 @@ sub ua { } } + $self->{_CACHED_UA} = $ua; + return $ua; } +sub _cached_ua { + my $self = shift; + + return $self->{_CACHED_UA}; +} + sub simple_get { my $self = shift; my $url = shift; @@ -249,7 +238,7 @@ sub decode_querystring { sub connectors { my $self = shift; - return $self->{'_CONNECTORS'}->(); + return $self->{_API}->{connectors}->(); } sub selectconn { @@ -258,10 +247,19 @@ sub selectconn { $self->{'_CONNECTOR'} = shift; } -sub setconn { +# +# Register a callbacks into the core API to the plugin. +# Example of those are config getter/setters and IO functions +# The API is a hash reference containing subroutine references. +# +# After the API is registered an attempt is made to load the config +# (or set defaults if config values are not found) +# +sub register_api { my $self = shift; + my $api = shift; - $self->{'_CONNECTORS'} = shift; + $self->{_API} = $api; } 1;