#!/usr/bin/perl # Blosxom # Author: Rael Dornfest # Version: 2.0.2 # Home/Docs/Licensing: http://blosxom.sourceforge.net/ # Development/Downloads: http://sourceforge.net/projects/blosxom package blosxom; # --- Configurable variables ----- # What's this blog's title? $blog_title = "My Weblog"; # What's this blog's description (for outgoing RSS feed)? $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"; # What's my preferred base URL for this blog (leave blank for automatic)? $url = ""; # Should I stick only to the datadir for items or travel down the # directory hierarchy looking for items? If so, to what depth? # 0 = infinite depth (aka grab everything), 1 = datadir only, n = n levels down $depth = 0; # How many entries should I show on the home page? $num_entries = 40; # What file extension signifies a blosxom entry? $file_extension = "txt"; # What is the default flavour? $default_flavour = "html"; # Should I show entries from the future (i.e. dated after now)? $show_future_entries = 0; # --- Plugins (Optional) ----- # File listing plugins blosxom should load # (if empty blosxom will load all plugins in $plugin_dir and $plugin_path directories) $plugin_list = ""; # Where are my plugins kept? $plugin_dir = ""; # Where should my plugins keep their state information? $plugin_state_dir = "$plugin_dir/state"; # Additional plugins location # List of directories, separated by ';' on windows, ':' everywhere else $plugin_path = ""; # --- Static Rendering ----- # Where are this blog's static files to be created? $static_dir = "/Library/WebServer/Documents/blog"; # What's my administrative password (you must set this for static rendering)? $static_password = ""; # What flavours should I generate statically? @static_flavours = qw/html rss/; # Should I statically generate individual entries? # 0 = no, 1 = yes $static_entries = 0; # -------------------------------- 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_full $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 $encode_xml_entities !; use strict; use FileHandle; use File::Find; use File::stat; use Time::Local; use CGI qw/:standard :netscape/; $version = "2.0.2"; # Should I encode entities for xml content-types? (plugins can turn this off if they do it themselves) $encode_xml_entities = 1; # 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' ); @num2month = sort { $month2num{$a} <=> $month2num{$b} } keys %month2num; # Use the stated preferred URL or figure it out automatically $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 += ( $datadir =~ tr[/][] ) - 1 if $depth; # Global variable to be used in head/foot.{flavour} templates $path_info = ''; 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 my @path_info = split m{/}, path_info() || param('path'); $path_info_full = join '/', @path_info; # Equivalent to $ENV{PATH_INFO} shift @path_info; while ( $path_info[0] and $path_info[0] =~ /^[a-zA-Z].*$/ and $path_info[0] !~ /(.*)\.(.*)/ ) { $path_info .= '/' . shift @path_info; } # Flavour specified by ?flav={flav} or index.{flav} $flavour = ''; if ( $path_info[$#path_info] =~ /(.+)\.(.+)$/ ) { $flavour = $2; $path_info .= "/$1.$2" if $1 ne 'index'; pop @path_info; } else { $flavour = param('flav') || $default_flavour; } # Strip spurious slashes $path_info =~ s!(^/*)|(/*$)!!g; # Date fiddling ( $path_info_yr, $path_info_mo, $path_info_da ) = @path_info; $path_info_mo_num = $path_info_mo ? ( $path_info_mo =~ /\d{2}/ ? $path_info_mo : ( $month2num{ ucfirst( lc $path_info_mo ) } || undef ) ) : undef; # Define standard template subroutine, plugin-overridable at Plugins: Template $template = sub { my ( $path, $chunk, $flavour ) = @_; do { return join '', <$fh> if $fh->open("< $datadir/$path/$chunk.$flavour"); } while ( $path =~ s/(\/*[^\/]*)$// and $1 ); # 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 () { last if /^(__END__)$/; my ( $ct, $comp, $txt ) = /^(\S+)\s(\S+)(?:\s(.*))?$/ or next; $txt =~ s/\\n/\n/mg; $template{$ct}{$comp} .= $txt . "\n"; } # Plugins: Start my $path_sep = $^O eq 'MSWin32' ? ';' : ':'; my @plugin_dirs = split /$path_sep/, $plugin_path; unshift @plugin_dirs, $plugin_dir; my @plugin_list = (); my %plugin_hash = (); # If $plugin_list is set, read plugins to use from that file if ( $plugin_list ) { if ( -r $plugin_list and $fh->open("< $plugin_list") ) { @plugin_list = map { chomp $_; $_ } grep { /\S/ && !/^#/ } <$fh>; $fh->close; } else { warn "unable to read or open plugin_list '$plugin_list': $!"; $plugin_list = ''; } } # Otherwise walk @plugin_dirs to get list of plugins to use if ( ! @plugin_list && @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 $plugin_file = $plugin_list ? $plugin_name : $plugin; 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 # $plugin_path directory to indicate an @INC module should be loaded if ( $plugin =~ m/::/ && ( $plugin_list || -z $plugin_hash{$plugin} ) ) { # For Blosxom::Plugin::Foo style plugins, we need to use a string require eval "require $plugin_file"; } else { # we try first to load from $plugin_dir before attempting from $plugin_path eval { require "$plugin_dir/$plugin_file" } or eval { require $plugin_file }; } if ($@) { warn "error finding or loading blosxom plugin '$plugin_name': $@"; next; } if ( $plugin_name->start() and ( $plugins{$plugin_name} = $on_off ) ) { push @plugins, $plugin_name; } } shift @INC foreach @plugin_dirs; # Plugins: Template # Allow for the first encountered plugin::template subroutine to override the # default built-in template subroutine foreach my $plugin (@plugins) { if ( $plugins{$plugin} > 0 and $plugin->can('template') ) { if ( my $tmp = $plugin->template() ) { $template = $tmp; last; } } } # Provide backward compatibility for Blosxom < 2.0rc1 plug-ins sub load_template { return &$template(@_); } # Define default entries subroutine $entries = sub { my ( %files, %indexes, %others ); find( sub { my $d; my $curr_depth = $File::Find::dir =~ tr[/][]; return if $depth and $curr_depth > $depth; 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 ) ) { # read modification time my $mtime = stat($File::Find::name)->mtime or return; # to show or not to show future entries return unless ( $show_future_entries or $mtime < time ); # add the file and its associated mtime to the list of files $files{$File::Find::name} = $mtime; # static rendering bits 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 ); return ( \%files, \%indexes, \%others ); }; # Plugins: Entries # Allow for the first encountered plugin::entries subroutine to override the # default built-in entries subroutine 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; # Static if ( !$ENV{GATEWAY_INTERFACE} and param('-password') and $static_password and param('-password') eq $static_password ) { param('-quiet') or print "Blosxom is generating static index pages...\n"; # Home Page and Directory Indexes my %done; foreach my $path ( sort keys %indexes ) { my $p = ''; foreach ( ( '', split /\//, $path ) ) { $p .= "/$_"; $p =~ s!^/!!; 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 $fn = $p =~ m!^(.+)\.$file_extension$! ? $1 : "$p/index"; 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 = ''; 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; } } } } # Dynamic 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 ); } # Plugins: End foreach my $plugin (@plugins) { if ( $plugins{$plugin} > 0 and $plugin->can('end') ) { $entries = $plugin->end(); } } # Generate sub generate { my ( $static_or_dynamic, $currentdir, $date, $flavour, $content_type ) = @_; %files = %$files; %others = ref $others ? %$others : (); # Plugins: Filter 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) { if ( $plugins{$plugin} > 0 and $plugin->can('skip') ) { if ( my $tmp = $plugin->skip() ) { $skip = $tmp; last; } } } # 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; return $template; }; unless ( defined($skip) and $skip ) { # Plugins: Interpolate # Allow for the first encountered plugin::interpolate subroutine to # override the default built-in interpolate subroutine 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) { if ( $plugins{$plugin} > 0 and $plugin->can('head') ) { $entries = $plugin->head( $currentdir, \$head ); } } $head = &$interpolate($head); $output .= $head; # Stories my $curdate = ''; my $ne = $num_entries; if ( $currentdir =~ /(.*?)([^\/]+)\.(.+)$/ and $2 ne 'index' ) { $currentdir = "$1$2.$file_extension"; %f = ( "$datadir/$currentdir" => $files{"$datadir/$currentdir"} ) if $files{"$datadir/$currentdir"}; } else { $currentdir =~ s!/index\..+$!!; } # Define a default sort subroutine my $sort = sub { my ($files_ref) = @_; return sort { $files_ref->{$b} <=> $files_ref->{$a} } keys %$files_ref; }; # Plugins: Sort # Allow for the first encountered plugin::sort subroutine to override the # default built-in sort subroutine 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/; use vars qw/ $path $fn /; ( $path, $fn ) = $path_file =~ m!^$datadir/(?:(.*)/)?(.*)\.$file_extension!; # Only stories in the right hierarchy $path =~ /^$currentdir/ or $path_file eq "$datadir/$currentdir" or next; # Prepend a slash for use in templates only if a path exists $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 $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//; if ( $hr12 == 0 ) { $hr12 = 12 } # Only stories from the right date my ( $path_info_yr, $path_info_mo_num, $path_info_da ) = split /\//, $date; next if $path_info_yr && $yr != $path_info_yr; last if $path_info_yr && $yr < $path_info_yr; next if $path_info_mo_num && $mo ne $num2month[$path_info_mo_num]; next if $path_info_da && $da != $path_info_da; last if $path_info_da && $da < $path_info_da; # Date my $date = ( &$template( $path, 'date', $flavour ) ); # Plugins: Date foreach my $plugin (@plugins) { if ( $plugins{$plugin} > 0 and $plugin->can('date') ) { $entries = $plugin->date( $currentdir, \$date, $files{$path_file}, $dw, $mo, $mo_num, $da, $ti, $yr ); } } $date = &$interpolate($date); if ( $date && $curdate ne $date ) { $curdate = $date; $output .= $date; } use vars qw/ $title $body $raw /; if ( -f "$path_file" && $fh->open("< $path_file") ) { chomp( $title = <$fh> ); chomp( $body = join '', <$fh> ); $fh->close; $raw = "$title\n$body"; } my $story = ( &$template( $path, 'story', $flavour ) ); # Plugins: Story foreach my $plugin (@plugins) { if ( $plugins{$plugin} > 0 and $plugin->can('story') ) { $entries = $plugin->story( $path, $fn, \$story, \$title, \$body ); } } if ( $encode_xml_entities && $content_type =~ m{\bxml\b} ) { # Escape <, >, and &, and to produce valid RSS my %escape = ( '<' => '<', '>' => '>', '&' => '&', '"' => '"' ); my $escape_re = join '|' => keys %escape; $title =~ s/($escape_re)/$escape{$1}/g; $body =~ s/($escape_re)/$escape{$1}/g; } $story = &$interpolate($story); $output .= $story; $fh->close; $ne--; } # Foot my $foot = ( &$template( $currentdir, 'foot', $flavour ) ); # Plugins: 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) { if ( $plugins{$plugin} > 0 and $plugin->can('last') ) { $entries = $plugin->last(); } } } # End skip # Finally, add the header, if any and running dynamically $output = header($header) . $output if ( $static_or_dynamic eq 'dynamic' and $header ); $output; } sub nice_date { my ($unixtime) = @_; my $c_time = CORE::localtime($unixtime); my ( $dw, $mo, $da, $hr, $min, $sec, $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}; my $offset = timegm( $sec, $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; charset=$blog_encoding html head html head html head html head html head $blog_title $path_info_da $path_info_mo $path_info_yr html head html head html head html head
html head $blog_title
html head $path_info_da $path_info_mo $path_info_yr html head
html head

html story

html story $title
html story $body
html story
html story posted at: $ti | path: $path | permanent link to this entry html story

html date

$dw, $da $mo $yr

html foot html foot

html foot

html foot html foot
html foot html foot rss content_type text/xml; charset=$blog_encoding rss head rss head rss head rss head $blog_title rss head $url/$path_info rss head $blog_description rss head $blog_language rss head http://blogs.law.harvard.edu/tech/rss rss head blosxom/$version rss story rss story $title rss story $dw, $da $mo $yr $ti:00 $utc_offset rss story $url/$yr/$mo_num/$da#$fn rss story $path rss story $path/$fn rss story $body rss story rss date rss foot rss foot error content_type text/html error head error head error head

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.

error story

$title
error story $body #

error date

$dw, $da $mo $yr

error foot error foot __END__