# --- Plugins (Optional) -----
# File listing plugins blosxom should load
-# (if empty blosxom will load all plugins in $plugin_path directories)
+# (if empty blosxom will load all plugins in $plugin_dir and $plugin_path directories)
$plugin_list = "";
# Where are my plugins kept?
-# List of directories, separated by ';' on windows, ':' everywhere else
-$plugin_path = "";
+$plugin_dir = "";
# Where should my plugins keep their state information?
-$plugin_state_dir = "";
+$plugin_state_dir = "$plugin_dir/state";
-#$plugin_state_dir = "/var/lib/blosxom/state";
+# Additional plugins location
+# List of directories, separated by ';' on windows, ':' everywhere else
+$plugin_path = "";
# --- Static Rendering -----
# --------------------------------
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 !;
+ 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 $encode_xml_entities !;
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";
+# 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} ) {
# Plugins: Start
my $path_sep = $^O eq 'MSWin32' ? ';' : ':';
-my @plugin_dirs = split /$path_sep/, ( $plugin_path || $plugin_dir );
+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
-$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;
+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
-elsif (@plugin_dirs) {
+if ( ! @plugin_list && @plugin_dirs ) {
for my $plugin_dir (@plugin_dirs) {
next unless -d $plugin_dir;
if ( opendir PLUGINS, $plugin_dir ) {
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
- if ( $plugin =~ m/::/ && -z $plugin_hash{$plugin} ) {
+ # 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_name";
+ eval "require $plugin_file";
}
- else {
- eval { require $plugin };
+ 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 ($@) {
my $content_type = ( &$template( $path_info, 'content_type', $flavour ) );
$content_type =~ s!\n.*!!s;
- $content_type =~ s/(\$\w+(?:::)?\w*)/"defined $1 ? $1 : ''"/gee;
+ $content_type =~ s/(\$\w+(?:::\w+)*)/"defined $1 ? $1 : ''"/gee;
$header = { -type => $content_type };
print generate( 'dynamic', $path_info,
}
}
-# Generate
+# 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;
- $template =~
- s/(\$\w+(?:::)?\w*)/"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
+ 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('interpolate') ) {
- if ( my $tmp = $plugin->interpolate() ) {
- $interpolate = $tmp;
- last;
- }
+ if ( $plugins{$plugin} > 0 and $plugin->can('filter') ) {
+ $entries = $plugin->filter( \%files, \%others );
}
}
-
- # Head
- my $head = (&$template($currentdir,'head',$flavour));
-
- # Plugins: Head
+
+ 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('head') ) {
- $entries = $plugin->head( $currentdir, \$head );
+ if ( $plugins{$plugin} > 0 and $plugin->can('skip') ) {
+ if ( my $tmp = $plugin->skip() ) {
+ $skip = $tmp;
+ last;
+ }
}
}
-
- $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;
+ # 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;
};
-
- # 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;
+
+ 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;
+ }
}
}
- }
-
- 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 ($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 );
+
+ # 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 );
+ }
}
- }
-
- $foot = &$interpolate($foot);
- $output .= $foot;
- # Plugins: Last
- foreach my $plugin (@plugins) {
- if ( $plugins{$plugin} > 0 and $plugin->can('last') ) {
- $entries = $plugin->last();
+ $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\..+$!!;
}
- }
- } # End skip
+ # 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;
+ }
+ }
+ }
- # Finally, add the header, if any and running dynamically
- $output = header($header) . $output if ($static_or_dynamic eq 'dynamic' and $header);
-
- $output;
-}
+ 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);
-sub nice_date {
- my($unixtime) = @_;
-
- my $c_time = ctime($unixtime);
- 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};
-
- 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);
+ 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 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 <link rel="alternate" 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>
error foot </body>
error foot </html>
__END__
+
projects / matthijs / upstream / blosxom.git / blobdiff