# Blosxom
# Author: Rael Dornfest <rael@oreilly.com>
# Version: 2.0.2
-# Home/Docs/Licensing: http://www.blosxom.com/
+# Home/Docs/Licensing: http://blosxom.sourceforge.net/
# Development/Downloads: http://sourceforge.net/projects/blosxom
package blosxom;
# 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";
# --- 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 -----
# --------------------------------
-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.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;
%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');
$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 = '';
-$static_or_dynamic = (!$ENV{GATEWAY_INTERFACE} and param('-password') and $static_password and param('-password') eq $static_password) ? 'static' : 'dynamic';
-$static_or_dynamic eq 'dynamic' and param(-name=>'-quiet', -value=>1);
+if ( !$ENV{GATEWAY_INTERFACE}
+ and param('-password')
+ and $static_password
+ and param('-password') eq $static_password )
+{
+ $static_or_dynamic = 'static';
+}
+else {
+ $static_or_dynamic = 'dynamic';
+ param( -name => '-quiet', -value => 1 );
+}
# Path Info Magic
# Take a gander at HTTP's PATH_INFO for optional blog name, archive yr/mo/day
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;
}
# 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
# not an index, .file, and is readable
and $2 ne 'index' and $2 !~ /^\./ and (-r $File::Find::name)
) {
+ # read modification time
+ my $mtime = stat($File::Find::name)->mtime or return;
+
# to show or not to show future entries
- (
- $show_future_entries
- or stat($File::Find::name)->mtime < time
- )
+ return unless ($show_future_entries or $mtime < time);
# add the file and its associated mtime to the list of files
- and $files{$File::Find::name} = stat($File::Find::name)->mtime
+ $files{$File::Find::name} = $mtime;
# static rendering bits
- and (
- param('-all')
- or !-f "$static_dir/$1/index." . $static_flavours[0]
- or stat("$static_dir/$1/index." . $static_flavours[0])->mtime < stat($File::Find::name)->mtime
- )
- and $indexes{$1} = 1
- and $d = join('/', (nice_date($files{$File::Find::name}))[5,2,3])
-
- and $indexes{$d} = $d
- and $static_entries and $indexes{ ($1 ? "$1/" : '') . "$2.$file_extension" } = 1
-
- }
- else {
- !-d $File::Find::name and -r $File::Find::name and $others{$File::Find::name} = stat($File::Find::name)->mtime
- }
+ my $static_file = "$static_dir/$1/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{$d} = $d;
+ $indexes{ ($1 ? "$1/" : '') . "$2.$file_extension" } = 1 if $static_entries;
+ }
+ }
+ # not an entries match
+ elsif (!-d $File::Find::name and -r $File::Find::name)
+ {
+ $others{$File::Find::name} = stat($File::Find::name)->mtime;
+ }
}, $datadir
);
# Plugins: Entries
# Allow for the first encountered plugin::entries subroutine to override the
# default built-in entries subroutine
-my $tmp; foreach my $plugin ( @plugins ) { $plugins{$plugin} > 0 and $plugin->can('entries') and defined($tmp = $plugin->entries()) and $entries = $tmp and last; }
+foreach my $plugin (@plugins) {
+ if ( $plugins{$plugin} > 0 and $plugin->can('entries') ) {
+ if ( my $tmp = $plugin->entries() ) {
+ $entries = $tmp;
+ last;
+ }
+ }
+}
my ($files, $indexes, $others) = &$entries();
%indexes = %$indexes;
foreach ( ('', split /\//, $path) ) {
$p .= "/$_";
$p =~ s!^/!!;
- $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;
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);
%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) }
+ foreach my $plugin ( @plugins ) {
+ if ($plugins{$plugin} > 0 and $plugin->can('filter')){ $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 =
# 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);
# 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/;
$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;
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
my $foot = (&$template($currentdir,'foot',$flavour));
# Plugins: Foot
- foreach my $plugin ( @plugins ) { $plugins{$plugin} > 0 and $plugin->can('foot') and $entries = $plugin->foot($currentdir, \$foot) }
+ foreach my $plugin (@plugins) {
+ if ( $plugins{$plugin} > 0 and $plugin->can('foot') ) {
+ $entries = $plugin->foot( $currentdir, \$foot );
+ }
+ }
$foot = &$interpolate($foot);
$output .= $foot;
# Plugins: Last
- foreach my $plugin ( @plugins ) { $plugins{$plugin} > 0 and $plugin->can('last') and $entries = $plugin->last() }
+ foreach my $plugin (@plugins) {
+ if ( $plugins{$plugin} > 0 and $plugin->can('last') ) {
+ $entries = $plugin->last();
+ }
+ }
} # End skip
# Finally, add the header, if any and running dynamically
- $static_or_dynamic eq 'dynamic' and $header and $output = header($header) . $output;
+ $output = header($header) . $output if ($static_or_dynamic eq 'dynamic' and $header);
$output;
}
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 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 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>
-rss content_type text/xml
+rss content_type text/xml; charset=$blog_encoding
-rss head <?xml version="1.0"?>
-rss head <!-- name="generator" content="blosxom/$version" -->
-rss head <!DOCTYPE rss PUBLIC "-//Netscape Communications//DTD RSS 0.91//EN" "http://my.netscape.com/publish/formats/rss-0.91.dtd">
-rss head
-rss head <rss version="0.91">
+rss head <?xml version="1.0" encoding="$blog_encoding"?>
+rss head <rss version="2.0">
rss head <channel>
-rss head <title>$blog_title $path_info_da $path_info_mo $path_info_yr</title>
-rss head <link>$url</link>
+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>
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>
+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 />