Merge branch 'devel'

[videosite.git] / videosite / Base.pm

diff --git a/videosite/Base.pm b/videosite/Base.pm
index f6108f6..437ef98 100644 (file)
--- a/videosite/Base.pm
+++ b/videosite/Base.pm
@@ -10,17 +10,20 @@ use Data::Dumper;
 
 sub new {
     my $class = shift;
-    my $self = {'_DEBUG' => 0,
-                '_OUT' => sub {printf(@_)},
-                '_CONNECTORS' => sub { return ({ 'name' => 'direct',
-                                                 'schemas' => {} }) },
-                '_CONNECTOR' => undef,
+    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;
 }
 
@@ -30,52 +33,35 @@ sub error {
 
     $data[0] = "(" . ref($self) . ") " . $data[0];
 
-    $self->{'_OUT'}(@data);
+    $self->{_API}->{io}->(@data);
 }
 
 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);
+    $data[0] = "("  . ref($self) . ") " . $data[0];
 
-    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];
-    }
+    $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;
 }
 
@@ -83,32 +69,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->_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;
@@ -261,7 +233,7 @@ sub decode_querystring {
 sub connectors {
     my $self = shift;
     
-    return $self->{'_CONNECTORS'}->();
+    return $self->{_API}->{connectors}->();
 }
 
 sub selectconn {
@@ -270,10 +242,29 @@ sub selectconn {
     $self->{'_CONNECTOR'} = shift;
 }
 
-sub setconn {
+#
+# 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.
+#
+sub register_api {
     my $self = shift;
+    my $api = shift;
 
-    $self->{'_CONNECTORS'} = shift;
+    $self->{_API} = $api;
 }
 
 1;