- Import parameter changes from videosite

[quotesite.git] / quotesite / Base.pm

diff --git a/quotesite/Base.pm b/quotesite/Base.pm
index d8a4e98..f0fa439 100644 (file)
--- a/quotesite/Base.pm
+++ b/quotesite/Base.pm
@@ -111,6 +111,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 +149,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;