Add support for $plugin_list plugin config file.
[matthijs/upstream/blosxom.git] / blosxom.cgi
index 068b7183d1afb9f85010de247d56f428670346e7..4bdfc4aa30a829d883cc5969713d4163f95ef4e9 100755 (executable)
@@ -2,8 +2,8 @@
 
 # Blosxom
 # Author: Rael Dornfest <rael@oreilly.com>
-# Version: 2.0.1
-# Home/Docs/Licensing: http://www.blosxom.com/
+# Version: 2.0.2
+# Home/Docs/Licensing: http://blosxom.sourceforge.net/
 # Development/Downloads: http://sourceforge.net/projects/blosxom
 
 package blosxom;
@@ -44,6 +44,9 @@ $show_future_entries = 0;
 
 # --- Plugins (Optional) -----
 
+# File listing plugins blosxom should load (if empty blosxom will walk $plugin_dir)
+$plugin_list = "";
+
 # Where are my plugins kept?
 $plugin_dir = "";
 
@@ -67,7 +70,7 @@ $static_entries = 0;
 
 # --------------------------------
 
-use vars qw! $version $blog_title $blog_description $blog_language $datadir $url %template $template $depth $num_entries $file_extension $default_flavour $static_or_dynamic $plugin_dir $plugin_state_dir @plugins %plugins $static_dir $static_password @static_flavours $static_entries $path_info $path_info_yr $path_info_mo $path_info_da $path_info_mo_num $flavour $static_or_dynamic %month2num @num2month $interpolate $entries $output $header $show_future_entries %files %indexes %others !;
+use vars qw! $version $blog_title $blog_description $blog_language $datadir $url %template $template $depth $num_entries $file_extension $default_flavour $static_or_dynamic $config_dir $plugin_list $plugin_dir $plugin_state_dir @plugins %plugins $static_dir $static_password @static_flavours $static_entries $path_info $path_info_yr $path_info_mo $path_info_da $path_info_mo_num $flavour $static_or_dynamic %month2num @num2month $interpolate $entries $output $header $show_future_entries %files %indexes %others !;
 
 use strict;
 use FileHandle;
@@ -76,7 +79,33 @@ use File::stat;
 use Time::localtime;
 use CGI qw/:standard :netscape/;
 
-$version = "2.0";
+$version = "2.0.2";
+
+# Load configuration from $ENV{BLOSXOM_CONFIG_DIR}/blosxom.conf, if it exists
+my $blosxom_config;
+if ($ENV{BLOSXOM_CONFIG_FILE} && -r $ENV{BLOSXOM_CONFIG_FILE}) {
+  $blosxom_config = $ENV{BLOSXOM_CONFIG_FILE};
+  ($config_dir = $blosxom_config) =~ s! / [^/]* $ !!x;                          
+}
+else {
+  for my $blosxom_config_dir ($ENV{BLOSXOM_CONFIG_DIR}, '/etc/blosxom', '/etc') {
+    if (-r "$blosxom_config_dir/blosxom.conf") {
+      $config_dir = $blosxom_config_dir;
+      $blosxom_config = "$blosxom_config_dir/blosxom.conf";
+      last;
+    }
+  }
+}
+# Load $blosxom_config
+if ($blosxom_config) { 
+  if (-r $blosxom_config) {
+    eval { require $blosxom_config } or
+      warn "Error reading blosxom config file '$blosxom_config'" . ($@ ? ": $@" : '');
+  }
+  else {
+    warn "Cannot find or read blosxom config file '$blosxom_config'";
+  }
+}
 
 my $fh = new FileHandle;
 
@@ -84,8 +113,17 @@ my $fh = new FileHandle;
 @num2month = sort { $month2num{$a} <=> $month2num{$b} } keys %month2num;
 
 # Use the stated preferred URL or figure it out automatically
-$url ||= url();
-$url =~ s/^included:/http:/; # Fix for Server Side Includes (SSI)
+$url ||= url(-path_info => 1);
+$url =~ s/^included:/http:/ if $ENV{SERVER_PROTOCOL} eq 'INCLUDED';
+
+# NOTE: Since v3.12, it looks as if CGI.pm misbehaves for SSIs and
+# always appends path_info to the url. To fix this, we always
+# request an url with path_info, and always remove it from the end of the
+# string.
+my $pi_len = length $ENV{PATH_INFO};
+my $might_be_pi = substr($url, -$pi_len);
+substr($url, -length $ENV{PATH_INFO}) = '' if $might_be_pi eq $ENV{PATH_INFO};
+
 $url =~ s!/$!!;
 
 # Drop ending any / from dir settings
@@ -134,29 +172,57 @@ $template =
       return join '', <$fh> if $fh->open("< $datadir/$path/$chunk.$flavour");
     } while ($path =~ s/(\/*[^\/]*)$// and $1);
 
-    return join '', ($template{$flavour}{$chunk} || $template{error}{$chunk} || '');
+    # Check for definedness, since flavour can be the empty string
+    if (defined $template{$flavour}{$chunk}) {
+       return $template{$flavour}{$chunk};
+    } elsif (defined $template{error}{$chunk}) {
+       return $template{error}{$chunk} 
+    } else {
+       return '';
+    }
   };
 # Bring in the templates
 %template = ();
 while (<DATA>) {
   last if /^(__END__)$/;
-  my($ct, $comp, $txt) = /^(\S+)\s(\S+)\s(.*)$/ or next;
+  my($ct, $comp, $txt) = /^(\S+)\s(\S+)(?:\s(.*))?$/ or next;
   $txt =~ s/\\n/\n/mg;
   $template{$ct}{$comp} .= $txt . "\n";
 }
 
 # Plugins: Start
-if ( $plugin_dir and opendir PLUGINS, $plugin_dir ) {
-  foreach my $plugin ( grep { /^\w+$/ && -f "$plugin_dir/$_"  } sort readdir(PLUGINS) ) {
-    next if ($plugin =~ /~$/);   # Ignore emacs backups
-    my($plugin_name, $off) = $plugin =~ /^\d*(\w+?)(_?)$/;
-    my $on_off = $off eq '_' ? -1 : 1;
-    require "$plugin_dir/$plugin";
-    $plugin_name->start() and ( $plugins{$plugin_name} = $on_off ) and push @plugins, $plugin_name;
-  }
+my @plugin_list = ();
+
+# If $plugin_list is set, read plugins to use from that file
+$plugin_list = "$config_dir/$plugin_list"
+  if $plugin_list && $plugin_list !~ m!^\s*/!;
+if ( $plugin_list and -r $plugin_list and $fh->open("< $plugin_list") ) {
+  @plugin_list = map { chomp $_; $_ } grep { /\S/ && ! /^#/ } <$fh>; 
+  $fh->close;
+}
+# Otherwise walk $plugin_dir to get list of plugins to use
+elsif ( $plugin_dir and opendir PLUGINS, $plugin_dir ) {
+  @plugin_list = grep { /^[\w:]+$/ && ! /~$/ && -f "$plugin_dir/$_" } sort readdir(PLUGINS);
   closedir PLUGINS;
 }
 
+unshift @INC, $plugin_dir;
+foreach my $plugin ( @plugin_list ) {
+  my($plugin_name, $off) = $plugin =~ /^\d*([\w:]+?)(_?)$/;
+  my $on_off = $off eq '_' ? -1 : 1;
+  # Allow perl module plugins
+  if ($plugin =~ m/::/ && -z "$plugin_dir/$plugin") {
+    # For Blosxom::Plugin::Foo style plugins, we need to use a string require
+    eval "require $plugin_name";
+  }
+  else {
+    eval { require $plugin };
+  }
+  $@ and warn "error finding or loading blosxom plugin $plugin_name - skipping\n" and next;
+  $plugin_name->start() and ( $plugins{$plugin_name} = $on_off ) and push @plugins, $plugin_name;
+}
+shift @INC;
+
 # Plugins: Template
 # Allow for the first encountered plugin::template subroutine to override the
 # default built-in template subroutine
@@ -465,7 +531,7 @@ html date         <h3>$dw, $da $mo $yr</h3>
 html foot
 html foot         <p />
 html foot         <center>
-html foot             <a href="http://www.blosxom.com/"><img src="http://www.blosxom.com/images/pb_blosxom.gif" border="0" /></a>
+html foot             <a href="http://blosxom.sourceforge.net/"><img src="http://blosxom.sourceforge.net/images/pb_blosxom.gif" border="0" /></a>
 html foot         </center>
 html foot     </body>
 html foot </html>