X-Git-Url: https://git.camperquake.de/gitweb.cgi?a=blobdiff_plain;f=videosite%2FBase.pm;h=1bd229fbb175ae891b0ef2870acda3e3ab7c9fc8;hb=5979c22b30775fa2ebe09b3b415246d73a50bd17;hp=a081dcedb021d8df36813d5a6f55edc88890eb11;hpb=0e4b9927afa5f8dd94cefaea455107ca69176a9d;p=videosite.git diff --git a/videosite/Base.pm b/videosite/Base.pm index a081dce..1bd229f 100644 --- a/videosite/Base.pm +++ b/videosite/Base.pm @@ -10,24 +10,20 @@ use Data::Dumper; sub new { my $class = shift; - my $self = {'_DEBUG' => 0, - '_CONNECTORS' => sub { return ({ 'name' => 'direct', - 'schemas' => {} }) }, - '_CONNECTOR' => undef, - API => { - io => sub { printf(@_) }, + my $self = {'_CONNECTOR' => undef, + _API => { + io => sub { print(@_) }, + io_debug => sub { print(@_) }, 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; } @@ -44,45 +40,28 @@ sub debug { my $self = shift; my @data = @_; - $data[0] = "DEBUG: " . $data[0]; - 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'}; -} + $data[0] = "(" . ref($self) . ") " . $data[0]; -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]; - } + $self->{_API}->{io_debug}->(@data); } 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; } @@ -90,11 +69,12 @@ 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); } } @@ -104,11 +84,10 @@ sub getconfstr { 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->_getval($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 +132,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); @@ -171,12 +149,6 @@ sub gethelpstr { return $s; } -sub setdebug { - my $self = shift; - - $self->{'_DEBUG'} = shift; -} - sub ua { my $self = shift; my $ua; @@ -184,6 +156,7 @@ sub ua { $ua = LWP::UserAgent->new( 'agent' => 'Mozilla/5.0', 'cookie_jar' => HTTP::Cookies->new, + 'parse_head' => 0, 'timeout' => 15, ); @@ -191,6 +164,15 @@ sub ua { delete($ENV{'HTTPS_PROXY'}); if (defined($self->{'_CONNECTOR'})) { + # + # The "environment" connector is special, it loads proxies from + # the environment variables. It also does not define any schemas, + # so the code below will not reset this. + # + if ($self->{'_CONNECTOR'}->{'name'} eq 'environment') { + $self->debug("Using proxy settings from environment"); + $ua->env_proxy; + } my $schemas = $self->{'_CONNECTOR'}->{'schemas'}; foreach (keys(%{$schemas})) { $self->debug("Adding schema %s with proxy %s", $_, $schemas->{$_}); @@ -198,7 +180,7 @@ sub ua { # OK, so here's the gist. # # The usual way of reqesting an HTTPS URL through a proxy is - # to connect to the proxy server, issue a CONNECT request to + # to connect to the proxy server, issue a CONNECT request to # create a channel to the web server and start an SSL session over # this channel, so there is an end-to-end connection between # the client and the server. @@ -238,7 +220,10 @@ sub simple_get { my $ua = shift || $self->ua(); my $r; + $self->debug("Getting %s", $url); $r = $ua->get($url); + $self->debug("Return code: %s", $r->status_line); + $self->debug("Content length: %d", length($r->decoded_content)) if $r->is_success(); return $r->decoded_content() if $r->is_success(); return undef; } @@ -260,8 +245,8 @@ sub decode_querystring { sub connectors { my $self = shift; - - return $self->{'_CONNECTORS'}->(); + + return $self->{_API}->{connectors}->(); } sub selectconn { @@ -271,13 +256,23 @@ sub selectconn { } # +# This function was used in previous versions of videosite. If it's called +# we are dealing with an old plugin which probably needs some minor modifications +# to work properly. +# +# Generate a warning message. +# +sub _prepare_parameters { + my $self = shift; + + $self->error("THIS MODULE IS CALLING _prepare_parameters(). THIS FUNCTION IS DEPRECATED. See readme.txt in the plugin directory."); +} + +# # 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;