Simplify default entries sub, removing hanging $1/$2 refs.
[matthijs/upstream/blosxom.git] / blosxom.cgi
index 160d4edebba298e99b97c3685426062e1e2c098d..f6473743edd2d5e229b24526b00583902e3c3fa4 100755 (executable)
@@ -2,7 +2,7 @@
 
 # Blosxom
 # Author: Rael Dornfest (2002-2003), The Blosxom Development Team (2005-2009)
-# Version: 2.1.2 ($Id: blosxom.cgi,v 1.95 2009/03/08 01:28:06 xtaran Exp $)
+# Version: 2.1.2 ($Id: blosxom.cgi,v 1.98 2009/07/19 17:18:37 xtaran Exp $)
 # Home/Docs/Licensing: http://blosxom.sourceforge.net/
 # Development/Downloads: http://sourceforge.net/projects/blosxom
 
@@ -142,6 +142,11 @@ $encode_xml_entities = 1;
 # can change this, too)
 $encode_8bit_chars = 0;
 
+# RegExp matching all characters which should be URL encoded in links.
+# Defaults to anything but numbers, letters, slash, colon, dash,
+# underscore and dot.
+$url_escape_re = qr([^-/a-zA-Z0-9:._]);
+
 # --------------------------------
 
 =head1 ENVIRONMENT
@@ -190,7 +195,6 @@ development was picked up by a team of dedicated users of blosxom since
 
 =cut
 
-
 use vars qw!
     $version
     $blog_title
@@ -224,7 +228,6 @@ use vars qw!
     $path_info_da
     $path_info_mo_num
     $flavour
-    $static_or_dynamic
     %month2num
     @num2month
     $interpolate
@@ -237,8 +240,9 @@ use vars qw!
     %others
     $encode_xml_entities
     $encode_8bit_chars
+    $url_escape_re
     $content_type
-!;
+    !;
 
 use strict;
 use FileHandle;
@@ -306,7 +310,7 @@ unless ($url) {
     $url = url();
 
     # Unescape %XX hex codes (from URI::Escape::uri_unescape)
-    $url =~ s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg;      
+    $url =~ s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg;
 
     # Support being called from inside a SSI document
     $url =~ s/^included:/http:/ if $ENV{SERVER_PROTOCOL} eq 'INCLUDED';
@@ -357,14 +361,14 @@ else {
 # Path Info Magic
 # Take a gander at HTTP's PATH_INFO for optional blog name, archive yr/mo/day
 my @path_info = split m{/}, path_info() || param('path');
-$path_info_full = join '/', @path_info;      # Equivalent to $ENV{PATH_INFO}
+$path_info_full = join '/', @path_info;    # Equivalent to $ENV{PATH_INFO}
 shift @path_info;
 
 # Flavour specified by ?flav={flav} or index.{flav}
 $flavour = '';
-if (! ($flavour = param('flav'))) {
+if ( !( $flavour = param('flav') ) ) {
     if ( $path_info[$#path_info] =~ /(.+)\.(.+)$/ ) {
-       $flavour = $2;
+        $flavour = $2;
         pop @path_info if $1 eq 'index';
     }
 }
@@ -374,45 +378,50 @@ $flavour ||= $default_flavour;
 $flavour = blosxom_html_escape($flavour);
 
 sub blosxom_html_escape {
-  my $string = shift;
-  my %escape = (
-                '<' => '&lt;',
-                '>' => '&gt;',
-                '&' => '&amp;',
-                '"' => '&quot;',
-                "'" => '&apos;'
-                );
-  my $escape_re = join '|' => keys %escape;
-  $string =~ s/($escape_re)/$escape{$1}/g;
-  $string;
+    my $string = shift;
+    my %escape = (
+        '<' => '&lt;',
+        '>' => '&gt;',
+        '&' => '&amp;',
+        '"' => '&quot;',
+        "'" => '&apos;'
+    );
+    my $escape_re = join '|' => keys %escape;
+    $string =~ s/($escape_re)/$escape{$1}/g;
+    $string;
 }
 
 # Global variable to be used in head/foot.{flavour} templates
 $path_info = '';
+
 # Add all @path_info elements to $path_info till we come to one that could be a year
-while ( $path_info[0] && $path_info[0] !~ /^(19|20)\d{2}$/) {
+while ( $path_info[0] && $path_info[0] !~ /^(19|20)\d{2}$/ ) {
     $path_info .= '/' . shift @path_info;
 }
 
 # Pull date elements out of path
-if ($path_info[0] && $path_info[0] =~ /^(19|20)\d{2}$/) {
-  $path_info_yr = shift @path_info;
-  if ($path_info[0] && 
-     ($path_info[0] =~ /^(0\d|1[012])$/ || 
-      exists $month2num{ ucfirst lc $path_info_mo })) {
-    $path_info_mo = shift @path_info;
-    # Map path_info_mo to numeric $path_info_mo_num
-    $path_info_mo_num = $path_info_mo =~ /^\d{2}$/
-      ? $path_info_mo
-      : $month2num{ ucfirst lc $path_info_mo };
-    if ($path_info[0] && $path_info[0] =~ /^[0123]\d$/) {
-      $path_info_da = shift @path_info;
+if ( $path_info[0] && $path_info[0] =~ /^(19|20)\d{2}$/ ) {
+    $path_info_yr = shift @path_info;
+    if ($path_info[0]
+        && ( $path_info[0] =~ /^(0\d|1[012])$/
+            || exists $month2num{ ucfirst lc $path_info_mo } )
+        )
+    {
+        $path_info_mo = shift @path_info;
+
+        # Map path_info_mo to numeric $path_info_mo_num
+        $path_info_mo_num
+            = $path_info_mo =~ /^\d{2}$/
+            ? $path_info_mo
+            : $month2num{ ucfirst lc $path_info_mo };
+        if ( $path_info[0] && $path_info[0] =~ /^[0123]\d$/ ) {
+            $path_info_da = shift @path_info;
+        }
     }
-  }
 }
 
 # Add remaining path elements to $path_info
-$path_info .= '/' . join('/', @path_info);
+$path_info .= '/' . join( '/', @path_info );
 
 # Strip spurious slashes
 $path_info =~ s!(^/*)|(/*$)!!g;
@@ -455,7 +464,7 @@ my @plugin_list = ();
 my %plugin_hash = ();
 
 # If $plugin_list is set, read plugins to use from that file
-if ( $plugin_list ) {
+if ($plugin_list) {
     if ( -r $plugin_list and $fh->open("< $plugin_list") ) {
         @plugin_list = map { chomp $_; $_ } grep { /\S/ && !/^#/ } <$fh>;
         $fh->close;
@@ -467,7 +476,7 @@ if ( $plugin_list ) {
 }
 
 # Otherwise walk @plugin_dirs to get list of plugins to use
-if ( ! @plugin_list && @plugin_dirs ) {
+if ( !@plugin_list && @plugin_dirs ) {
     for my $plugin_dir (@plugin_dirs) {
         next unless -d $plugin_dir;
         if ( opendir PLUGINS, $plugin_dir ) {
@@ -497,7 +506,7 @@ foreach my $plugin (@plugin_list) {
     my $on_off = $off eq '_' ? -1 : 1;
 
     # Allow perl module plugins
-    # The -z test is a hack to allow a zero-length placeholder file in a 
+    # The -z test is a hack to allow a zero-length placeholder file in a
     #   $plugin_path directory to indicate an @INC module should be loaded
     if ( $plugin =~ m/::/ && ( $plugin_list || -z $plugin_hash{$plugin} ) ) {
 
@@ -541,22 +550,18 @@ sub load_template {
 # Define default entries subroutine
 $entries = sub {
     my ( %files, %indexes, %others );
+    my $param_all = param('-all');
     find(
         sub {
-            my $d;
             my $curr_depth = $File::Find::dir =~ tr[/][];
             return if $depth and $curr_depth > $depth;
+            return if !-r $File::Find::name;
 
-            if (
-
-                # a match
-                $File::Find::name
-                =~ m!^$datadir/(?:(.*)/)?(.+)\.$file_extension$!
-
-                # not an index, .file, and is readable
-                and $2 ne 'index' and $2 !~ /^\./ and ( -r $File::Find::name )
-                )
+            # if a $file_extension file and not a .file or an index
+            if ( m/^([^.].*)\.$file_extension$/
+                and $1 ne 'index' )
             {
+                my $basename_noext = $1;
 
                 # read modification time
                 my $mtime = stat($File::Find::name)->mtime or return;
@@ -568,22 +573,23 @@ $entries = sub {
                 $files{$File::Find::name} = $mtime;
 
                 # static rendering bits
+                (my $dirname = $File::Find::dir) =~ s!^$datadir/?!!;
                 my $static_file
-                    = "$static_dir/$1/index." . $static_flavours[0];
-                if (   param('-all')
+                    = "$static_dir/${dirname}index.$static_flavours[0]";
+                if (   $param_all
                     or !-f $static_file
                     or stat($static_file)->mtime < $mtime )
                 {
-                    $indexes{$1} = 1;
-                    $d = join( '/', ( nice_date($mtime) )[ 5, 2, 3 ] );
+                    $indexes{$dirname} = 1;
+                    my $d = join( '/', ( nice_date($mtime) )[ 5, 2, 3 ] );
                     $indexes{$d} = $d;
-                    $indexes{ ( $1 ? "$1/" : '' ) . "$2.$file_extension" } = 1
+                    $indexes{"$dirname$basename_noext.$file_extension"} = 1
                         if $static_entries;
                 }
             }
 
             # not an entries match
-            elsif ( !-d $File::Find::name and -r $File::Find::name ) {
+            elsif ( !-d $File::Find::name ) {
                 $others{$File::Find::name} = stat($File::Find::name)->mtime;
             }
         },
@@ -609,11 +615,7 @@ my ( $files, $indexes, $others ) = &$entries();
 %indexes = %$indexes;
 
 # Static
-if (    !$ENV{GATEWAY_INTERFACE}
-    and param('-password')
-    and $static_password
-    and param('-password') eq $static_password )
-{
+if ( $static_or_dynamic eq 'static' ) {
 
     param('-quiet') or print "Blosxom is generating static index pages...\n";
 
@@ -714,10 +716,13 @@ sub generate {
 
     # Define default interpolation subroutine
     $interpolate = sub {
+
         package blosxom;
         my $template = shift;
+
         # Interpolate scalars, namespaced scalars, and hash/hashref scalars
-        $template =~ s/(\$\w+(?:::\w+)*(?:(?:->)?{([\'\"]?)[-\w]+\2})?)/"defined $1 ? $1 : ''"/gee;
+        $template
+            =~ s/(\$\w+(?:::\w+)*(?:(?:->)?{([\'\"]?)[-\w]+\2})?)/"defined $1 ? $1 : ''"/gee;
         return $template;
     };
 
@@ -765,8 +770,7 @@ sub generate {
         # Define a default sort subroutine
         my $sort = sub {
             my ($files_ref) = @_;
-            return
-                sort { $files_ref->{$b} <=> $files_ref->{$a} }
+            return sort { $files_ref->{$b} <=> $files_ref->{$a} }
                 keys %$files_ref;
         };
 
@@ -852,18 +856,22 @@ sub generate {
                 }
             }
 
-            if ( $encode_xml_entities &&
-                 $content_type =~ m{\bxml\b} &&
-                 $content_type !~ m{\bxhtml\b} ) {
-                # Escape special characters inside the <link> container
+            # Save unescaped versions and allow them to be used in
+            # flavour templates.
+            use vars qw/$url_unesc $path_unesc $fn_unesc/;
+            $url_unesc  = $url;
+            $path_unesc = $path;
+            $fn_unesc   = $fn;
+
+            # Fix special characters in links inside XML content
+            if (   $encode_xml_entities
+                && $content_type =~ m{\bxml\b}
+                && $content_type !~ m{\bxhtml\b} )
+            {
 
-                # The following line should be moved more towards to top for
-                # performance reasons -- Axel Beckert, 2008-07-22
-                my $url_escape_re = qr([^-/a-zA-Z0-9:._]);
+                # Escape special characters inside the <link> container
 
-                $url   =~ s($url_escape_re)(sprintf('%%%02X', ord($&)))eg;
-                $path  =~ s($url_escape_re)(sprintf('%%%02X', ord($&)))eg;
-                $fn    =~ s($url_escape_re)(sprintf('%%%02X', ord($&)))eg;
+                &url_escape_url_path_and_fn();
 
                 # Escape <, >, and &, and to produce valid RSS
                 $title = blosxom_html_escape($title);
@@ -873,10 +881,9 @@ sub generate {
                 $fn    = blosxom_html_escape($fn);
             }
 
+            # Fix special characters in links inside XML content
             if ($encode_8bit_chars) {
-                $url   =~ s([^-a-zA-Z0-9_./:])(sprintf('%%%02X', ord($&)))ge;
-                $path  =~ s([^-a-zA-Z0-9_./:])(sprintf('%%%02X', ord($&)))ge;
-                $fn    =~ s([^-a-zA-Z0-9_./:])(sprintf('%%%02X', ord($&)))ge;
+                &url_escape_url_path_and_fn();
             }
 
             $story = &$interpolate($story);
@@ -936,6 +943,12 @@ sub nice_date {
     return ( $dw, $mo, $mo_num, $da, $ti, $yr, $utc_offset );
 }
 
+sub url_escape_url_path_and_fn {
+    $url  =~ s($url_escape_re)(sprintf('%%%02X', ord($&)))eg;
+    $path =~ s($url_escape_re)(sprintf('%%%02X', ord($&)))eg;
+    $fn   =~ s($url_escape_re)(sprintf('%%%02X', ord($&)))eg;
+}
+
 # Default HTML and RSS template bits
 __DATA__
 html content_type text/html; charset=$blog_encoding