Avoid "conditional and" for running plugins "story"
[pkg/blosxom.git] / blosxom.cgi
index 1233ea4..7dba635 100755 (executable)
@@ -2,8 +2,9 @@
 
 # Blosxom
 # Author: Rael Dornfest <rael@oreilly.com>
-# Version: 2.0
-# Home/Docs/Licensing: http://www.raelity.org/apps/blosxom/
+# Version: 2.0.2
+# Home/Docs/Licensing: http://blosxom.sourceforge.net/
+# Development/Downloads: http://sourceforge.net/projects/blosxom
 
 package blosxom;
 
@@ -18,6 +19,9 @@ $blog_description = "Yet another Blosxom weblog.";
 # What's this blog's primary language (for outgoing RSS feed)?
 $blog_language = "en";
 
+# What's this blog's text encoding ?
+$blog_encoding = "UTF-8";
+
 # Where are this blog's entries kept?
 $datadir = "/Library/WebServer/Documents/blosxom";
 
@@ -43,11 +47,17 @@ $show_future_entries = 0;
 
 # --- Plugins (Optional) -----
 
-# Where are my plugins kept?
-$plugin_dir = "";
+# File listing plugins blosxom should load 
+# (if empty blosxom will load all plugins in $plugin_path directories)
+$plugin_list = "";
+
+# Where are my plugins kept? 
+# List of directories, separated by ';' on windows, ':' everywhere else
+$plugin_path = "";
 
-# Where should my modules keep their state information?
-$plugin_state_dir = "$plugin_dir/state";
+# Where should my plugins keep their state information?
+$plugin_state_dir = "";
+#$plugin_state_dir = "/var/lib/blosxom/state";
 
 # --- Static Rendering -----
 
@@ -66,16 +76,43 @@ $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 $blog_encoding $datadir $url %template $template $depth $num_entries $file_extension $default_flavour $static_or_dynamic $config_dir $plugin_list $plugin_path $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;
 use File::Find;
 use File::stat;
 use Time::localtime;
+use Time::Local;
 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;
 
@@ -83,15 +120,24 @@ 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
 $datadir =~ s!/$!!; $plugin_dir =~ s!/$!!; $static_dir =~ s!/$!!;
   
 # Fix depth to take into account datadir's path
-$depth and $depth += ($datadir =~ tr[/][]) - 1;
+$depth += ($datadir =~ tr[/][]) - 1 if $depth;
 
 # Global variable to be used in head/foot.{flavour} templates
 $path_info = '';
@@ -111,7 +157,7 @@ $flavour = '';
 
 if ( $path_info[$#path_info] =~ /(.+)\.(.+)$/ ) {
   $flavour = $2;
-  $1 ne 'index' and $path_info .= "/$1.$2";
+  $path_info .= "/$1.$2" if $1 ne 'index';
   pop @path_info;
 } else {
   $flavour = param('flav') || $default_flavour;
@@ -133,28 +179,72 @@ $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(.*)$/;
+  last if /^(__END__)$/;
+  my($ct, $comp, $txt) = /^(\S+)\s(\S+)(?:\s(.*))?$/ or next;
   $txt =~ s/\\n/\n/mg;
-  $template{$ct}{$comp} = $txt;
+  $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 $path_sep = $^O eq 'MSWin32' ? ';' : ':';
+my @plugin_dirs = split /$path_sep/, ($plugin_path || $plugin_dir);
+my @plugin_list = ();
+my %plugin_hash = ();
+
+# 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_dirs to get list of plugins to use
+elsif ( @plugin_dirs ) {
+  for my $plugin_dir ( @plugin_dirs ) {
+    next unless -d $plugin_dir;
+    if ( opendir PLUGINS, $plugin_dir ) {
+      for my $plugin ( grep { /^[\w:]+$/ && ! /~$/ && -f "$plugin_dir/$_" } readdir(PLUGINS) ) {
+        # Ignore duplicates
+        next if $plugin_hash{ $plugin };
+        # Add to @plugin_list and %plugin_hash
+        $plugin_hash{ $plugin } = "$plugin_dir/$plugin";
+        push @plugin_list, $plugin;
+      }
+      closedir PLUGINS;
+    }
+  }
+  @plugin_list = sort @plugin_list;
+}
+
+# Load all plugins in @plugin_list
+unshift @INC, @plugin_dirs;
+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_hash{ $plugin }) {
+    # For Blosxom::Plugin::Foo style plugins, we need to use a string require
+    eval "require $plugin_name";
+  }
+  else {
+    eval { require $plugin };
   }
-  closedir PLUGINS;
+  $@ 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 foreach @plugin_dirs;
 
 # Plugins: Template
 # Allow for the first encountered plugin::template subroutine to override the
@@ -220,10 +310,7 @@ $entries =
 my $tmp; foreach my $plugin ( @plugins ) { $plugins{$plugin} > 0 and $plugin->can('entries') and defined($tmp = $plugin->entries()) and $entries = $tmp and last; }
 
 my ($files, $indexes, $others) = &$entries();
-%files = %$files; %indexes = %$indexes; %others = ref $others ? %$others : ();
-
-# Plugins: Filter
-foreach my $plugin ( @plugins ) { $plugins{$plugin} > 0 and $plugin->can('filter') and $entries = $plugin->filter(\%files, \%others) }
+%indexes = %$indexes;
 
 # Static
 if (!$ENV{GATEWAY_INTERFACE} and param('-password') and $static_password and param('-password') eq $static_password) {
@@ -237,9 +324,8 @@ if (!$ENV{GATEWAY_INTERFACE} and param('-password') and $static_password and par
     foreach ( ('', split /\//, $path) ) {
       $p .= "/$_";
       $p =~ s!^/!!;
-      $path_info = $p;
-      $done{$p}++ and next;
-      (-d "$static_dir/$p" or $p =~ /\.$file_extension$/) or mkdir "$static_dir/$p", 0755;
+      next if $done{$p}++;
+      mkdir "$static_dir/$p", 0755 unless (-d "$static_dir/$p" or $p =~ /\.$file_extension$/);
       foreach $flavour ( @static_flavours ) {
         my $content_type = (&$template($p,'content_type',$flavour));
         $content_type =~ s!\n.*!!s;
@@ -247,10 +333,19 @@ if (!$ENV{GATEWAY_INTERFACE} and param('-password') and $static_password and par
         param('-quiet') or print "$fn.$flavour\n";
         my $fh_w = new FileHandle "> $static_dir/$fn.$flavour" or die "Couldn't open $static_dir/$p for writing: $!";  
         $output = '';
-        print $fh_w 
-          $indexes{$path} == 1
-            ? &generate('static', $p, '', $flavour, $content_type)
-            : &generate('static', '', $p, $flavour, $content_type);
+        if ($indexes{$path} == 1) {
+          # category
+          $path_info = $p;
+          # individual story
+          $path_info =~ s!\.$file_extension$!\.$flavour!;
+          print $fh_w &generate('static', $path_info, '', $flavour, $content_type);
+        } else {
+          # date
+          local ($path_info_yr,$path_info_mo,$path_info_da, $path_info) = 
+              split /\//, $p, 4;
+          unless (defined $path_info) {$path_info = ""};
+          print $fh_w &generate('static', '', $p, $flavour, $content_type);
+        }
         $fh_w->close;
       }
     }
@@ -262,6 +357,7 @@ else {
   my $content_type = (&$template($path_info,'content_type',$flavour));
   $content_type =~ s!\n.*!!s;
 
+  $content_type =~ s/(\$\w+(?:::)?\w*)/"defined $1 ? $1 : ''"/gee;
   $header = {-type=>$content_type};
 
   print generate('dynamic', $path_info, "$path_info_yr/$path_info_mo_num/$path_info_da", $flavour, $content_type);
@@ -274,11 +370,25 @@ foreach my $plugin ( @plugins ) { $plugins{$plugin} > 0 and $plugin->can('end')
 sub generate {
   my($static_or_dynamic, $currentdir, $date, $flavour, $content_type) = @_;
 
+  %files = %$files; %others = ref $others ? %$others : ();
+
+  # Plugins: Filter
+  foreach my $plugin ( @plugins ) { $plugins{$plugin} > 0 and $plugin->can('filter') and $entries = $plugin->filter(\%files, \%others) }
+
   my %f = %files;
 
   # Plugins: Skip
   # Allow plugins to decide if we can cut short story generation
-  my $skip; foreach my $plugin ( @plugins ) { $plugins{$plugin} > 0 and $plugin->can('skip') and defined($tmp = $plugin->skip()) and $skip = $tmp and last; }
+  my $skip;
+  foreach my $plugin (@plugins) {
+      if ( $plugins{$plugin} > 0 and $plugin->can('skip') ) {
+          if ( my $tmp = $plugin->skip() ) {
+              $skip = $tmp;
+              last;
+          }
+      }
+  }
+
   
   # Define default interpolation subroutine
   $interpolate = 
@@ -295,13 +405,24 @@ sub generate {
     # Plugins: Interpolate
     # Allow for the first encountered plugin::interpolate subroutine to 
     # override the default built-in interpolate subroutine
-    my $tmp; foreach my $plugin ( @plugins ) { $plugins{$plugin} > 0 and $plugin->can('interpolate') and defined($tmp = $plugin->interpolate()) and $interpolate = $tmp and last; }
+    foreach my $plugin (@plugins) {
+        if ( $plugins{$plugin} > 0 and $plugin->can('interpolate') ) {
+            if ( my $tmp = $plugin->interpolate() ) {
+                $interpolate = $tmp;
+                last;
+            }
+        }
+    }
         
     # Head
     my $head = (&$template($currentdir,'head',$flavour));
   
     # Plugins: Head
-    foreach my $plugin ( @plugins ) { $plugins{$plugin} > 0 and $plugin->can('head') and $entries = $plugin->head($currentdir, \$head) }
+    foreach my $plugin (@plugins) {
+        if ( $plugins{$plugin} > 0 and $plugin->can('head') ) {
+            $entries = $plugin->head( $currentdir, \$head );
+        }
+    }
   
     $head = &$interpolate($head);
   
@@ -328,7 +449,14 @@ sub generate {
     # Plugins: Sort
     # Allow for the first encountered plugin::sort subroutine to override the
     # default built-in sort subroutine
-    my $tmp; foreach my $plugin ( @plugins ) { $plugins{$plugin} > 0 and $plugin->can('sort') and defined($tmp = $plugin->sort()) and $sort = $tmp and last; }
+    foreach my $plugin (@plugins) {
+        if ( $plugins{$plugin} > 0 and $plugin->can('sort') ) {
+            if ( my $tmp = $plugin->sort() ) {
+                $sort = $tmp;
+                last;
+            }
+        }
+    }
   
     foreach my $path_file ( &$sort(\%f, \%others) ) {
       last if $ne <= 0 && $date !~ /\d/;
@@ -342,8 +470,8 @@ sub generate {
       $path &&= "/$path";
 
       # Date fiddling for by-{year,month,day} archive views
-      use vars qw/ $dw $mo $mo_num $da $ti $yr $hr $min $hr12 $ampm /;
-      ($dw,$mo,$mo_num,$da,$ti,$yr) = nice_date($files{"$path_file"});
+      use vars qw/ $dw $mo $mo_num $da $ti $yr $hr $min $hr12 $ampm $utc_offset/;
+      ($dw,$mo,$mo_num,$da,$ti,$yr,$utc_offset) = nice_date($files{"$path_file"});
       ($hr,$min) = split /:/, $ti;
       ($hr12, $ampm) = $hr >= 12 ? ($hr - 12,'pm') : ($hr, 'am'); 
       $hr12 =~ s/^0//; $hr12 == 0 and $hr12 = 12;
@@ -374,7 +502,11 @@ sub generate {
       my $story = (&$template($path,'story',$flavour));
   
       # Plugins: Story
-      foreach my $plugin ( @plugins ) { $plugins{$plugin} > 0 and $plugin->can('story') and $entries = $plugin->story($path, $fn, \$story, \$title, \$body) }
+      foreach my $plugin (@plugins) {
+          if ( $plugins{$plugin} > 0 and $plugin->can('story') ) {
+              $entries = $plugin->story( $path, $fn, \$story, \$title, \$body );
+          }
+      }
       
       if ($content_type =~ m{\bxml\b}) {
         # Escape <, >, and &, and to produce valid RSS
@@ -417,29 +549,91 @@ sub nice_date {
   my($unixtime) = @_;
   
   my $c_time = ctime($unixtime);
-  my($dw,$mo,$da,$ti,$yr) = ( $c_time =~ /(\w{3}) +(\w{3}) +(\d{1,2}) +(\d{2}:\d{2}):\d{2} +(\d{4})$/ );
+  my($dw,$mo,$da,$hr,$min,$yr) = ( $c_time =~ /(\w{3}) +(\w{3}) +(\d{1,2}) +(\d{2}):(\d{2}):\d{2} +(\d{4})$/ );
+  $ti="$hr:$min";
   $da = sprintf("%02d", $da);
   my $mo_num = $month2num{$mo};
-  
-  return ($dw,$mo,$mo_num,$da,$ti,$yr);
+
+  my $offset = timegm(00, $min, $hr, $da, $mo_num-1, $yr-1900)-$unixtime;  
+  my $utc_offset = sprintf("%+03d", int($offset / 3600)).sprintf("%02d", ($offset % 3600)/60) ;
+
+  return ($dw,$mo,$mo_num,$da,$ti,$yr,$utc_offset);
 }
 
 
 # Default HTML and RSS template bits
 __DATA__
-html content_type text/html
-html head <html><head><link rel="alternate" type="type="application/rss+xml" title="RSS" href="$url/index.rss" /><title>$blog_title $path_info_da $path_info_mo $path_info_yr</title></head><body><center><font size="+3">$blog_title</font><br />$path_info_da $path_info_mo $path_info_yr</center><p />
-html story <p><a name="$fn"><b>$title</b></a><br />$body<br /><br />posted at: $ti | path: <a href="$url$path">$path</a> | <a href="$url/$yr/$mo_num/$da#$fn">permanent link to this entry</a></p>\n
-html date <h3>$dw, $da $mo $yr</h3>\n
-html foot <p /><center><a href="http://www.blosxom.com/"><img src="http://www.blosxom.com/images/pb_blosxom.gif" border="0" /></a></body></html>
-rss content_type text/xml
-rss head <?xml version="1.0"?>\n<!-- name="generator" content="blosxom/$version" -->\n<!DOCTYPE rss PUBLIC "-//Netscape Communications//DTD RSS 0.91//EN" "http://my.netscape.com/publish/formats/rss-0.91.dtd">\n\n<rss version="0.91">\n  <channel>\n    <title>$blog_title $path_info_da $path_info_mo $path_info_yr</title>\n    <link>$url</link>\n    <description>$blog_description</description>\n    <language>$blog_language</language>\n
-rss story   <item>\n    <title>$title</title>\n    <link>$url/$yr/$mo_num/$da#$fn</link>\n    <description>$body</description>\n  </item>\n
-rss date \n
-rss foot   </channel>\n</rss>
+html content_type text/html; charset=$blog_encoding
+
+html head <html>
+html head     <head>
+html head         <meta http-equiv="content-type" content="text/html;charset=$blog_encoding" />
+html head         <link rel="alternate" type="type="application/rss+xml" title="RSS" href="$url/index.rss" />
+html head         <title>$blog_title $path_info_da $path_info_mo $path_info_yr
+html head         </title>
+html head     </head>
+html head     <body>
+html head         <center>
+html head             <font size="+3">$blog_title</font><br />
+html head             $path_info_da $path_info_mo $path_info_yr
+html head         </center>
+html head         <p />
+
+html story        <p>
+html story            <a name="$fn"><b>$title</b></a><br />
+html story            $body<br />
+html story            <br />
+html story            posted at: $ti | path: <a href="$url$path">$path </a> | <a href="$url/$yr/$mo_num/$da#$fn">permanent link to this entry</a>
+html story        </p>
+
+html date         <h3>$dw, $da $mo $yr</h3>
+
+html foot
+html foot         <p />
+html foot         <center>
+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>
+
+rss content_type text/xml; charset=$blog_encoding
+
+rss head <?xml version="1.0" encoding="$blog_encoding"?>
+rss head <rss version="2.0">
+rss head   <channel>
+rss head     <title>$blog_title</title>
+rss head     <link>$url/$path_info</link>
+rss head     <description>$blog_description</description>
+rss head     <language>$blog_language</language>
+rss head     <docs>http://blogs.law.harvard.edu/tech/rss</docs>
+rss head     <generator>blosxom/$version</generator>
+
+rss story   <item>
+rss story     <title>$title</title>
+rss story     <pubDate>$dw, $da $mo $yr $ti:00 $utc_offset</pubDate>
+rss story     <link>$url/$yr/$mo_num/$da#$fn</link>
+rss story     <category>$path</category>
+rss story     <guid isPermaLink="false">$path/$fn</guid>
+rss story     <description>$body</description>
+rss story   </item>
+
+rss date 
+
+rss foot   </channel>
+rss foot </rss>
+
 error content_type text/html
-error head <html><body><p><font color="red">Error: I'm afraid this is the first I've heard of a "$flavour" flavoured Blosxom.  Try dropping the "/+$flavour" bit from the end of the URL.</font>\n\n
-error story <p><b>$title</b><br />$body <a href="$url/$yr/$mo_num/$da#fn.$default_flavour">#</a></p>\n
-error date <h3>$dw, $da $mo $yr</h3>\n
-error foot </body></html>
+
+error head <html>
+error head <body>
+error head     <p><font color="red">Error: I'm afraid this is the first I've heard of a "$flavour" flavoured Blosxom.  Try dropping the "/+$flavour" bit from the end of the URL.</font></p>
+
+
+error story <p><b>$title</b><br />
+error story $body <a href="$url/$yr/$mo_num/$da#fn.$default_flavour">#</a></p>
+
+error date <h3>$dw, $da $mo $yr</h3>
+
+error foot     </body>
+error foot </html>
 __END__