X-Git-Url: https://git.camperquake.de/gitweb.cgi?a=blobdiff_plain;f=videosite%2FBase.pm;h=c641f2d2abdbbcbe1b7e5fe32ea7db3882f39168;hb=bf54a33472a858abd6fb0e6cfa37b5e2fc363615;hp=d8a4e988b50ec500f23719752ea38ab7af063f84;hpb=56322f8fce4f7ceadbd24a4e91e0eebd0fd249d5;p=videosite.git diff --git a/videosite/Base.pm b/videosite/Base.pm index d8a4e98..c641f2d 100644 --- a/videosite/Base.pm +++ b/videosite/Base.pm @@ -1,29 +1,39 @@ # (c) 2007 by Ralf Ertzinger # licensed under GNU GPL v2 -package Base; +package videosite::Base; use strict; +use LWP::UserAgent; +use HTTP::Cookies; use Data::Dumper; sub new { my $class = shift; - my $self = {'_DEBUG' => 0, '_OUT' => sub {print shift}}; - + my $self = {'_DEBUG' => 0, + '_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; } sub error { my $self = shift; - my $t; + my @data = @_; - $t = sprintf(shift(@_), @_); - $t =~ s/%/%%/g; - $self->{'_OUT'}($t); + $data[0] = "(" . ref($self) . ") " . $data[0]; + + $self->{_API}->{io}->(@data); } sub debug { @@ -34,33 +44,6 @@ 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; @@ -84,13 +67,6 @@ 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"; @@ -111,6 +87,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"; @@ -125,7 +125,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; @@ -137,4 +146,112 @@ sub setdebug { $self->{'_DEBUG'} = shift; } +sub ua { + my $self = shift; + my $ua; + + $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'}); + + if (defined($self->{'_CONNECTOR'})) { + my $schemas = $self->{'_CONNECTOR'}->{'schemas'}; + foreach (keys(%{$schemas})) { + $self->debug("Adding schema %s with proxy %s", $_, $schemas->{$_}); + if ($_ eq 'https') { + # 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 + # 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. + # + # Setting a proxy for the https schema in LWP WILL NOT ACCOMPLISH + # THIS. + # + # LWP will connect to the proxy server, and issue a standard GET + # request for the target URL, which most proxy servers will refuse + # to get. + # + # The way to use a proxy server is to set some environment variables + # and let the underlying Crypt::SSLeay module do the rest. + # + # This is positively appaling. + $ENV{'HTTPS_PROXY'} = $schemas->{$_}; + } else { + $ua->proxy($_, $schemas->{$_}); + } + } + } + + $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; + my $ua = shift || $self->ua(); + my $r; + + $r = $ua->get($url); + return $r->decoded_content() if $r->is_success(); + return undef; +} + +sub decode_hexurl { + my $self = shift; + my $d = shift; + + $d =~ s/%([[:xdigit:]]{2})/chr(hex($1))/ge; + + return $d; +} + +sub decode_querystring { + my $self = shift; + + return { map { split /=/, $_, 2; } split /&/, shift }; +} + +sub connectors { + my $self = shift; + + return $self->{_API}->{connectors}->(); +} + +sub selectconn { + my $self = shift; + + $self->{'_CONNECTOR'} = shift; +} + +# +# 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->{_API} = $api; +} + 1;