blosxom.cgi

   1 #!/usr/bin/perl
   2
   3 # Blosxom
   4 # Author: Rael Dornfest <rael@oreilly.com>
   5 # Version: 2.0.1
   6 # Home/Docs/Licensing: http://www.blosxom.com/
   7 # Development/Downloads: http://sourceforge.net/projects/blosxom
   8
   9 package blosxom;
  10
  11 # --- Configurable variables -----
  12
  13 # What's this blog's title?
  14 $blog_title = "My Weblog";
  15
  16 # What's this blog's description (for outgoing RSS feed)?
  17 $blog_description = "Yet another Blosxom weblog.";
  18
  19 # What's this blog's primary language (for outgoing RSS feed)?
  20 $blog_language = "en";
  21
  22 # Where are this blog's entries kept?
  23 $datadir = "/Library/WebServer/Documents/blosxom";
  24
  25 # What's my preferred base URL for this blog (leave blank for automatic)?
  26 $url = "";
  27
  28 # Should I stick only to the datadir for items or travel down the
  29 # directory hierarchy looking for items?  If so, to what depth?
  30 # 0 = infinite depth (aka grab everything), 1 = datadir only, n = n levels down
  31 $depth = 0;
  32
  33 # How many entries should I show on the home page?
  34 $num_entries = 40;
  35
  36 # What file extension signifies a blosxom entry?
  37 $file_extension = "txt";
  38
  39 # What is the default flavour?
  40 $default_flavour = "html";
  41
  42 # Should I show entries from the future (i.e. dated after now)?
  43 $show_future_entries = 0;
  44
  45 # --- Plugins (Optional) -----
  46
  47 # Where are my plugins kept?
  48 $plugin_dir = "";
  49
  50 # Where should my modules keep their state information?
  51 $plugin_state_dir = "$plugin_dir/state";
  52
  53 # --- Static Rendering -----
  54
  55 # Where are this blog's static files to be created?
  56 $static_dir = "/Library/WebServer/Documents/blog";
  57
  58 # What's my administrative password (you must set this for static rendering)?
  59 $static_password = "";
  60
  61 # What flavours should I generate statically?
  62 @static_flavours = qw/html rss/;
  63
  64 # Should I statically generate individual entries?
  65 # 0 = no, 1 = yes
  66 $static_entries = 0;
  67
  68 # --------------------------------
  69
  70 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 !;
  71
  72 use strict;
  73 use FileHandle;
  74 use File::Find;
  75 use File::stat;
  76 use Time::localtime;
  77 use CGI qw/:standard :netscape/;
  78
  79 $version = "2.0";
  80
  81 my $fh = new FileHandle;
  82
  83 %month2num = (nil=>'00', Jan=>'01', Feb=>'02', Mar=>'03', Apr=>'04', May=>'05', Jun=>'06', Jul=>'07', Aug=>'08', Sep=>'09', Oct=>'10', Nov=>'11', Dec=>'12');
  84 @num2month = sort { $month2num{$a} <=> $month2num{$b} } keys %month2num;
  85
  86 # Use the stated preferred URL or figure it out automatically
  87 $url ||= url();
  88 $url =~ s/^included:/http:/; # Fix for Server Side Includes (SSI)
  89 $url =~ s!/$!!;
  90
  91 # Drop ending any / from dir settings
  92 $datadir =~ s!/$!!; $plugin_dir =~ s!/$!!; $static_dir =~ s!/$!!;
  93
  94 # Fix depth to take into account datadir's path
  95 $depth and $depth += ($datadir =~ tr[/][]) - 1;
  96
  97 # Global variable to be used in head/foot.{flavour} templates
  98 $path_info = '';
  99
 100 $static_or_dynamic = (!$ENV{GATEWAY_INTERFACE} and param('-password') and $static_password and param('-password') eq $static_password) ? 'static' : 'dynamic';
 101 $static_or_dynamic eq 'dynamic' and param(-name=>'-quiet', -value=>1);
 102
 103 # Path Info Magic
 104 # Take a gander at HTTP's PATH_INFO for optional blog name, archive yr/mo/day
 105 my @path_info = split m{/}, path_info() || param('path');
 106 shift @path_info;
 107
 108 while ($path_info[0] and $path_info[0] =~ /^[a-zA-Z].*$/ and $path_info[0] !~ /(.*)\.(.*)/) { $path_info .= '/' . shift @path_info; }
 109
 110 # Flavour specified by ?flav={flav} or index.{flav}
 111 $flavour = '';
 112
 113 if ( $path_info[$#path_info] =~ /(.+)\.(.+)$/ ) {
 114   $flavour = $2;
 115   $1 ne 'index' and $path_info .= "/$1.$2";
 116   pop @path_info;
 117 } else {
 118   $flavour = param('flav') || $default_flavour;
 119 }
 120
 121 # Strip spurious slashes
 122 $path_info =~ s!(^/*)|(/*$)!!g;
 123
 124 # Date fiddling
 125 ($path_info_yr,$path_info_mo,$path_info_da) = @path_info;
 126 $path_info_mo_num = $path_info_mo ? ( $path_info_mo =~ /\d{2}/ ? $path_info_mo : ($month2num{ucfirst(lc $path_info_mo)} || undef) ) : undef;
 127
 128 # Define standard template subroutine, plugin-overridable at Plugins: Template
 129 $template =
 130   sub {
 131     my ($path, $chunk, $flavour) = @_;
 132
 133     do {
 134       return join '', <$fh> if $fh->open("< $datadir/$path/$chunk.$flavour");
 135     } while ($path =~ s/(\/*[^\/]*)$// and $1);
 136
 137     return join '', ($template{$flavour}{$chunk} || $template{error}{$chunk} || '');
 138   };
 139 # Bring in the templates
 140 %template = ();
 141 while (<DATA>) {
 142   last if /^(__END__)?$/;
 143   my($ct, $comp, $txt) = /^(\S+)\s(\S+)\s(.*)$/;
 144   $txt =~ s/\\n/\n/mg;
 145   $template{$ct}{$comp} = $txt;
 146 }
 147
 148 # Plugins: Start
 149 if ( $plugin_dir and opendir PLUGINS, $plugin_dir ) {
 150   foreach my $plugin ( grep { /^\w+$/ && -f "$plugin_dir/$_"  } sort readdir(PLUGINS) ) {
 151     next if ($plugin =~ /~$/);   # Ignore emacs backups
 152     my($plugin_name, $off) = $plugin =~ /^\d*(\w+?)(_?)$/;
 153     my $on_off = $off eq '_' ? -1 : 1;
 154     require "$plugin_dir/$plugin";
 155     $plugin_name->start() and ( $plugins{$plugin_name} = $on_off ) and push @plugins, $plugin_name;
 156   }
 157   closedir PLUGINS;
 158 }
 159
 160 # Plugins: Template
 161 # Allow for the first encountered plugin::template subroutine to override the
 162 # default built-in template subroutine
 163 my $tmp; foreach my $plugin ( @plugins ) { $plugins{$plugin} > 0 and $plugin->can('template') and defined($tmp = $plugin->template()) and $template = $tmp and last; }
 164
 165 # Provide backward compatibility for Blosxom < 2.0rc1 plug-ins
 166 sub load_template {
 167   return &$template(@_);
 168 }
 169
 170 # Define default entries subroutine
 171 $entries =
 172   sub {
 173     my(%files, %indexes, %others);
 174     find(
 175       sub {
 176         my $d;
 177         my $curr_depth = $File::Find::dir =~ tr[/][];
 178         return if $depth and $curr_depth > $depth;
 179
 180         if (
 181           # a match
 182           $File::Find::name =~ m!^$datadir/(?:(.*)/)?(.+)\.$file_extension$!
 183           # not an index, .file, and is readable
 184           and $2 ne 'index' and $2 !~ /^\./ and (-r $File::Find::name)
 185         ) {
 186
 187             # to show or not to show future entries
 188             (
 189               $show_future_entries
 190               or stat($File::Find::name)->mtime < time
 191             )
 192
 193               # add the file and its associated mtime to the list of files
 194               and $files{$File::Find::name} = stat($File::Find::name)->mtime
 195
 196                 # static rendering bits
 197                 and (
 198                   param('-all')
 199                   or !-f "$static_dir/$1/index." . $static_flavours[0]
 200                   or stat("$static_dir/$1/index." . $static_flavours[0])->mtime < stat($File::Find::name)->mtime
 201                 )
 202                   and $indexes{$1} = 1
 203                     and $d = join('/', (nice_date($files{$File::Find::name}))[5,2,3])
 204
 205                       and $indexes{$d} = $d
 206                         and $static_entries and $indexes{ ($1 ? "$1/" : '') . "$2.$file_extension" } = 1
 207
 208             }
 209             else {
 210               !-d $File::Find::name and -r $File::Find::name and $others{$File::Find::name} = stat($File::Find::name)->mtime
 211             }
 212       }, $datadir
 213     );
 214
 215     return (\%files, \%indexes, \%others);
 216   };
 217
 218 # Plugins: Entries
 219 # Allow for the first encountered plugin::entries subroutine to override the
 220 # default built-in entries subroutine
 221 my $tmp; foreach my $plugin ( @plugins ) { $plugins{$plugin} > 0 and $plugin->can('entries') and defined($tmp = $plugin->entries()) and $entries = $tmp and last; }
 222
 223 my ($files, $indexes, $others) = &$entries();
 224 %files = %$files; %indexes = %$indexes; %others = ref $others ? %$others : ();
 225
 226 # Plugins: Filter
 227 foreach my $plugin ( @plugins ) { $plugins{$plugin} > 0 and $plugin->can('filter') and $entries = $plugin->filter(\%files, \%others) }
 228
 229 # Static
 230 if (!$ENV{GATEWAY_INTERFACE} and param('-password') and $static_password and param('-password') eq $static_password) {
 231
 232   param('-quiet') or print "Blosxom is generating static index pages...\n";
 233
 234   # Home Page and Directory Indexes
 235   my %done;
 236   foreach my $path ( sort keys %indexes) {
 237     my $p = '';
 238     foreach ( ('', split /\//, $path) ) {
 239       $p .= "/$_";
 240       $p =~ s!^/!!;
 241       $done{$p}++ and next;
 242       (-d "$static_dir/$p" or $p =~ /\.$file_extension$/) or mkdir "$static_dir/$p", 0755;
 243       foreach $flavour ( @static_flavours ) {
 244         my $content_type = (&$template($p,'content_type',$flavour));
 245         $content_type =~ s!\n.*!!s;
 246         my $fn = $p =~ m!^(.+)\.$file_extension$! ? $1 : "$p/index";
 247         param('-quiet') or print "$fn.$flavour\n";
 248         my $fh_w = new FileHandle "> $static_dir/$fn.$flavour" or die "Couldn't open $static_dir/$p for writing: $!";
 249         $output = '';
 250         if ($indexes{$path} == 1) {
 251           # category
 252           $path_info = $p;
 253           print $fh_w &generate('static', $p, '', $flavour, $content_type);
 254         } else {
 255           # date
 256           local ($path_info_yr,$path_info_mo,$path_info_da, $path_info) =
 257               split /\//, $p, 4;
 258           unless (defined $path_info) {$path_info = ""};
 259           print $fh_w &generate('static', '', $p, $flavour, $content_type);
 260         }
 261         $fh_w->close;
 262       }
 263     }
 264   }
 265 }
 266
 267 # Dynamic
 268 else {
 269   my $content_type = (&$template($path_info,'content_type',$flavour));
 270   $content_type =~ s!\n.*!!s;
 271
 272   $header = {-type=>$content_type};
 273
 274   print generate('dynamic', $path_info, "$path_info_yr/$path_info_mo_num/$path_info_da", $flavour, $content_type);
 275 }
 276
 277 # Plugins: End
 278 foreach my $plugin ( @plugins ) { $plugins{$plugin} > 0 and $plugin->can('end') and $entries = $plugin->end() }
 279
 280 # Generate
 281 sub generate {
 282   my($static_or_dynamic, $currentdir, $date, $flavour, $content_type) = @_;
 283
 284   my %f = %files;
 285
 286   # Plugins: Skip
 287   # Allow plugins to decide if we can cut short story generation
 288   my $skip; foreach my $plugin ( @plugins ) { $plugins{$plugin} > 0 and $plugin->can('skip') and defined($tmp = $plugin->skip()) and $skip = $tmp and last; }
 289
 290   # Define default interpolation subroutine
 291   $interpolate =
 292     sub {
 293       package blosxom;
 294       my $template = shift;
 295       $template =~
 296         s/(\$\w+(?:::)?\w*)/"defined $1 ? $1 : ''"/gee;
 297       return $template;
 298     };
 299
 300   unless (defined($skip) and $skip) {
 301
 302     # Plugins: Interpolate
 303     # Allow for the first encountered plugin::interpolate subroutine to
 304     # override the default built-in interpolate subroutine
 305     my $tmp; foreach my $plugin ( @plugins ) { $plugins{$plugin} > 0 and $plugin->can('interpolate') and defined($tmp = $plugin->interpolate()) and $interpolate = $tmp and last; }
 306
 307     # Head
 308     my $head = (&$template($currentdir,'head',$flavour));
 309
 310     # Plugins: Head
 311     foreach my $plugin ( @plugins ) { $plugins{$plugin} > 0 and $plugin->can('head') and $entries = $plugin->head($currentdir, \$head) }
 312
 313     $head = &$interpolate($head);
 314
 315     $output .= $head;
 316
 317     # Stories
 318     my $curdate = '';
 319     my $ne = $num_entries;
 320
 321     if ( $currentdir =~ /(.*?)([^\/]+)\.(.+)$/ and $2 ne 'index' ) {
 322       $currentdir = "$1$2.$file_extension";
 323       $files{"$datadir/$1$2.$file_extension"} and %f = ( "$datadir/$1$2.$file_extension" => $files{"$datadir/$1$2.$file_extension"} );
 324     }
 325     else {
 326       $currentdir =~ s!/index\..+$!!;
 327     }
 328
 329     # Define a default sort subroutine
 330     my $sort = sub {
 331       my($files_ref) = @_;
 332       return sort { $files_ref->{$b} <=> $files_ref->{$a} } keys %$files_ref;
 333     };
 334
 335     # Plugins: Sort
 336     # Allow for the first encountered plugin::sort subroutine to override the
 337     # default built-in sort subroutine
 338     my $tmp; foreach my $plugin ( @plugins ) { $plugins{$plugin} > 0 and $plugin->can('sort') and defined($tmp = $plugin->sort()) and $sort = $tmp and last; }
 339
 340     foreach my $path_file ( &$sort(\%f, \%others) ) {
 341       last if $ne <= 0 && $date !~ /\d/;
 342       use vars qw/ $path $fn /;
 343       ($path,$fn) = $path_file =~ m!^$datadir/(?:(.*)/)?(.*)\.$file_extension!;
 344
 345       # Only stories in the right hierarchy
 346       $path =~ /^$currentdir/ or $path_file eq "$datadir/$currentdir" or next;
 347
 348       # Prepend a slash for use in templates only if a path exists
 349       $path &&= "/$path";
 350
 351       # Date fiddling for by-{year,month,day} archive views
 352       use vars qw/ $dw $mo $mo_num $da $ti $yr $hr $min $hr12 $ampm /;
 353       ($dw,$mo,$mo_num,$da,$ti,$yr) = nice_date($files{"$path_file"});
 354       ($hr,$min) = split /:/, $ti;
 355       ($hr12, $ampm) = $hr >= 12 ? ($hr - 12,'pm') : ($hr, 'am');
 356       $hr12 =~ s/^0//; $hr12 == 0 and $hr12 = 12;
 357
 358       # Only stories from the right date
 359       my($path_info_yr,$path_info_mo_num, $path_info_da) = split /\//, $date;
 360       next if $path_info_yr && $yr != $path_info_yr; last if $path_info_yr && $yr < $path_info_yr;
 361       next if $path_info_mo_num && $mo ne $num2month[$path_info_mo_num];
 362       next if $path_info_da && $da != $path_info_da; last if $path_info_da && $da < $path_info_da;
 363
 364       # Date
 365       my $date = (&$template($path,'date',$flavour));
 366
 367       # Plugins: Date
 368       foreach my $plugin ( @plugins ) { $plugins{$plugin} > 0 and $plugin->can('date') and $entries = $plugin->date($currentdir, \$date, $files{$path_file}, $dw,$mo,$mo_num,$da,$ti,$yr) }
 369
 370       $date = &$interpolate($date);
 371
 372       $curdate ne $date and $curdate = $date and $output .= $date;
 373
 374       use vars qw/ $title $body $raw /;
 375       if (-f "$path_file" && $fh->open("< $path_file")) {
 376         chomp($title = <$fh>);
 377         chomp($body = join '', <$fh>);
 378         $fh->close;
 379         $raw = "$title\n$body";
 380       }
 381       my $story = (&$template($path,'story',$flavour));
 382
 383       # Plugins: Story
 384       foreach my $plugin ( @plugins ) { $plugins{$plugin} > 0 and $plugin->can('story') and $entries = $plugin->story($path, $fn, \$story, \$title, \$body) }
 385
 386       if ($content_type =~ m{\bxml\b}) {
 387         # Escape <, >, and &, and to produce valid RSS
 388         my %escape = ('<'=>'&lt;', '>'=>'&gt;', '&'=>'&amp;', '"'=>'&quot;');
 389         my $escape_re  = join '|' => keys %escape;
 390         $title =~ s/($escape_re)/$escape{$1}/g;
 391         $body =~ s/($escape_re)/$escape{$1}/g;
 392       }
 393
 394       $story = &$interpolate($story);
 395
 396       $output .= $story;
 397       $fh->close;
 398
 399       $ne--;
 400     }
 401
 402     # Foot
 403     my $foot = (&$template($currentdir,'foot',$flavour));
 404
 405     # Plugins: Foot
 406     foreach my $plugin ( @plugins ) { $plugins{$plugin} > 0 and $plugin->can('foot') and $entries = $plugin->foot($currentdir, \$foot) }
 407
 408     $foot = &$interpolate($foot);
 409     $output .= $foot;
 410
 411     # Plugins: Last
 412     foreach my $plugin ( @plugins ) { $plugins{$plugin} > 0 and $plugin->can('last') and $entries = $plugin->last() }
 413
 414   } # End skip
 415
 416   # Finally, add the header, if any and running dynamically
 417   $static_or_dynamic eq 'dynamic' and $header and $output = header($header) . $output;
 418
 419   $output;
 420 }
 421
 422
 423 sub nice_date {
 424   my($unixtime) = @_;
 425
 426   my $c_time = ctime($unixtime);
 427   my($dw,$mo,$da,$ti,$yr) = ( $c_time =~ /(\w{3}) +(\w{3}) +(\d{1,2}) +(\d{2}:\d{2}):\d{2} +(\d{4})$/ );
 428   $da = sprintf("%02d", $da);
 429   my $mo_num = $month2num{$mo};
 430
 431   return ($dw,$mo,$mo_num,$da,$ti,$yr);
 432 }
 433
 434
 435 # Default HTML and RSS template bits
 436 __DATA__
 437 html content_type text/html
 438 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 />
 439 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
 440 html date <h3>$dw, $da $mo $yr</h3>\n
 441 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>
 442 rss content_type text/xml
 443 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
 444 rss story   <item>\n    <title>$title</title>\n    <link>$url/$yr/$mo_num/$da#$fn</link>\n    <description>$body</description>\n  </item>\n
 445 rss date \n
 446 rss foot   </channel>\n</rss>
 447 error content_type text/html
 448 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
 449 error story <p><b>$title</b><br />$body <a href="$url/$yr/$mo_num/$da#fn.$default_flavour">#</a></p>\n
 450 error date <h3>$dw, $da $mo $yr</h3>\n
 451 error foot </body></html>
 452 __END__