4 # Author: Rael Dornfest <rael@oreilly.com>
6 # Home/Docs/Licensing: http://blosxom.sourceforge.net/
7 # Development/Downloads: http://sourceforge.net/projects/blosxom
11 # --- Configurable variables -----
13 # What's this blog's title?
14 $blog_title = "My Weblog";
16 # What's this blog's description (for outgoing RSS feed)?
17 $blog_description = "Yet another Blosxom weblog.";
19 # What's this blog's primary language (for outgoing RSS feed)?
20 $blog_language = "en";
22 # What's this blog's text encoding ?
23 $blog_encoding = "UTF-8";
25 # Where are this blog's entries kept?
26 $datadir = "/Library/WebServer/Documents/blosxom";
28 # What's my preferred base URL for this blog (leave blank for automatic)?
31 # Should I stick only to the datadir for items or travel down the
32 # directory hierarchy looking for items? If so, to what depth?
33 # 0 = infinite depth (aka grab everything), 1 = datadir only, n = n levels down
36 # How many entries should I show on the home page?
39 # What file extension signifies a blosxom entry?
40 $file_extension = "txt";
42 # What is the default flavour?
43 $default_flavour = "html";
45 # Should I show entries from the future (i.e. dated after now)?
46 $show_future_entries = 0;
48 # --- Plugins (Optional) -----
50 # File listing plugins blosxom should load
51 # (if empty blosxom will load all plugins in $plugin_dir and $plugin_path directories)
54 # Where are my plugins kept?
57 # Where should my plugins keep their state information?
58 $plugin_state_dir = "$plugin_dir/state";
60 # Additional plugins location
61 # List of directories, separated by ';' on windows, ':' everywhere else
64 # --- Static Rendering -----
66 # Where are this blog's static files to be created?
67 $static_dir = "/Library/WebServer/Documents/blog";
69 # What's my administrative password (you must set this for static rendering)?
70 $static_password = "";
72 # What flavours should I generate statically?
73 @static_flavours = qw/html rss/;
75 # Should I statically generate individual entries?
79 # --------------------------------
82 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 !;
89 use CGI qw/:standard :netscape/;
93 # Should I encode entities for xml content-types? (plugins can turn this off if they do it themselves)
94 $encode_xml_entities = 1;
96 # Load configuration from $ENV{BLOSXOM_CONFIG_DIR}/blosxom.conf, if it exists
98 if ( $ENV{BLOSXOM_CONFIG_FILE} && -r $ENV{BLOSXOM_CONFIG_FILE} ) {
99 $blosxom_config = $ENV{BLOSXOM_CONFIG_FILE};
100 ( $config_dir = $blosxom_config ) =~ s! / [^/]* $ !!x;
103 for my $blosxom_config_dir ( $ENV{BLOSXOM_CONFIG_DIR}, '/etc/blosxom',
106 if ( -r "$blosxom_config_dir/blosxom.conf" ) {
107 $config_dir = $blosxom_config_dir;
108 $blosxom_config = "$blosxom_config_dir/blosxom.conf";
114 # Load $blosxom_config
115 if ($blosxom_config) {
116 if ( -r $blosxom_config ) {
117 eval { require $blosxom_config }
118 or warn "Error reading blosxom config file '$blosxom_config'"
119 . ( $@ ? ": $@" : '' );
122 warn "Cannot find or read blosxom config file '$blosxom_config'";
126 my $fh = new FileHandle;
143 @num2month = sort { $month2num{$a} <=> $month2num{$b} } keys %month2num;
145 # Use the stated preferred URL or figure it out automatically
146 $url ||= url( -path_info => 1 );
147 $url =~ s/^included:/http:/ if $ENV{SERVER_PROTOCOL} eq 'INCLUDED';
149 # NOTE: Since v3.12, it looks as if CGI.pm misbehaves for SSIs and
150 # always appends path_info to the url. To fix this, we always
151 # request an url with path_info, and always remove it from the end of the
153 my $pi_len = length $ENV{PATH_INFO};
154 my $might_be_pi = substr( $url, -$pi_len );
155 substr( $url, -length $ENV{PATH_INFO} ) = ''
156 if $might_be_pi eq $ENV{PATH_INFO};
160 # Drop ending any / from dir settings
162 $plugin_dir =~ s!/$!!;
163 $static_dir =~ s!/$!!;
165 # Fix depth to take into account datadir's path
166 $depth += ( $datadir =~ tr[/][] ) - 1 if $depth;
168 if ( !$ENV{GATEWAY_INTERFACE}
169 and param('-password')
171 and param('-password') eq $static_password )
173 $static_or_dynamic = 'static';
176 $static_or_dynamic = 'dynamic';
177 param( -name => '-quiet', -value => 1 );
181 # Take a gander at HTTP's PATH_INFO for optional blog name, archive yr/mo/day
182 my @path_info = split m{/}, path_info() || param('path');
183 $path_info_full = join '/', @path_info; # Equivalent to $ENV{PATH_INFO}
186 # Flavour specified by ?flav={flav} or index.{flav}
188 if (! ($flavour = param('flav'))) {
189 if ( $path_info[$#path_info] =~ /(.+)\.(.+)$/ ) {
191 pop @path_info if $1 eq 'index';
194 $flavour ||= $default_flavour;
196 # Global variable to be used in head/foot.{flavour} templates
198 # Add all @path_info elements to $path_info till we come to one that could be a year
199 while ( $path_info[0] && $path_info[0] !~ /^(19|20)\d{2}$/) {
200 $path_info .= '/' . shift @path_info;
203 # Pull date elements out of path
204 if ($path_info[0] && $path_info[0] =~ /^(19|20)\d{2}$/) {
205 $path_info_yr = shift @path_info;
207 ($path_info[0] =~ /^(0\d|1[012])$/ ||
208 exists $month2num{ ucfirst lc $path_info_mo })) {
209 $path_info_mo = shift @path_info;
210 # Map path_info_mo to numeric $path_info_mo_num
211 $path_info_mo_num = $path_info_mo =~ /^\d{2}$/
213 : $month2num{ ucfirst lc $path_info_mo };
214 if ($path_info[0] && $path_info[0] =~ /^[0123]\d$/) {
215 $path_info_da = shift @path_info;
220 # Add remaining path elements to $path_info
221 $path_info .= '/' . join('/', @path_info);
223 # Strip spurious slashes
224 $path_info =~ s!(^/*)|(/*$)!!g;
226 # Define standard template subroutine, plugin-overridable at Plugins: Template
228 my ( $path, $chunk, $flavour ) = @_;
231 return join '', <$fh>
232 if $fh->open("< $datadir/$path/$chunk.$flavour");
233 } while ( $path =~ s/(\/*[^\/]*)$// and $1 );
235 # Check for definedness, since flavour can be the empty string
236 if ( defined $template{$flavour}{$chunk} ) {
237 return $template{$flavour}{$chunk};
239 elsif ( defined $template{error}{$chunk} ) {
240 return $template{error}{$chunk};
247 # Bring in the templates
250 last if /^(__END__)$/;
251 my ( $ct, $comp, $txt ) = /^(\S+)\s(\S+)(?:\s(.*))?$/ or next;
253 $template{$ct}{$comp} .= $txt . "\n";
257 my $path_sep = $^O eq 'MSWin32' ? ';' : ':';
258 my @plugin_dirs = split /$path_sep/, $plugin_path;
259 unshift @plugin_dirs, $plugin_dir;
260 my @plugin_list = ();
261 my %plugin_hash = ();
263 # If $plugin_list is set, read plugins to use from that file
264 if ( $plugin_list ) {
265 if ( -r $plugin_list and $fh->open("< $plugin_list") ) {
266 @plugin_list = map { chomp $_; $_ } grep { /\S/ && !/^#/ } <$fh>;
270 warn "unable to read or open plugin_list '$plugin_list': $!";
275 # Otherwise walk @plugin_dirs to get list of plugins to use
276 if ( ! @plugin_list && @plugin_dirs ) {
277 for my $plugin_dir (@plugin_dirs) {
278 next unless -d $plugin_dir;
279 if ( opendir PLUGINS, $plugin_dir ) {
281 grep { /^[\w:]+$/ && !/~$/ && -f "$plugin_dir/$_" }
286 next if $plugin_hash{$plugin};
288 # Add to @plugin_list and %plugin_hash
289 $plugin_hash{$plugin} = "$plugin_dir/$plugin";
290 push @plugin_list, $plugin;
295 @plugin_list = sort @plugin_list;
298 # Load all plugins in @plugin_list
299 unshift @INC, @plugin_dirs;
300 foreach my $plugin (@plugin_list) {
301 my ( $plugin_name, $off ) = $plugin =~ /^\d*([\w:]+?)(_?)$/;
302 my $plugin_file = $plugin_list ? $plugin_name : $plugin;
303 my $on_off = $off eq '_' ? -1 : 1;
305 # Allow perl module plugins
306 # The -z test is a hack to allow a zero-length placeholder file in a
307 # $plugin_path directory to indicate an @INC module should be loaded
308 if ( $plugin =~ m/::/ && ( $plugin_list || -z $plugin_hash{$plugin} ) ) {
310 # For Blosxom::Plugin::Foo style plugins, we need to use a string require
311 eval "require $plugin_file";
314 { # we try first to load from $plugin_dir before attempting from $plugin_path
315 eval { require "$plugin_dir/$plugin_file" }
316 or eval { require $plugin_file };
320 warn "error finding or loading blosxom plugin '$plugin_name': $@";
323 if ( $plugin_name->start() and ( $plugins{$plugin_name} = $on_off ) ) {
324 push @plugins, $plugin_name;
328 shift @INC foreach @plugin_dirs;
331 # Allow for the first encountered plugin::template subroutine to override the
332 # default built-in template subroutine
333 foreach my $plugin (@plugins) {
334 if ( $plugins{$plugin} > 0 and $plugin->can('template') ) {
335 if ( my $tmp = $plugin->template() ) {
342 # Provide backward compatibility for Blosxom < 2.0rc1 plug-ins
344 return &$template(@_);
347 # Define default entries subroutine
349 my ( %files, %indexes, %others );
353 my $curr_depth = $File::Find::dir =~ tr[/][];
354 return if $depth and $curr_depth > $depth;
360 =~ m!^$datadir/(?:(.*)/)?(.+)\.$file_extension$!
362 # not an index, .file, and is readable
363 and $2 ne 'index' and $2 !~ /^\./ and ( -r $File::Find::name )
367 # read modification time
368 my $mtime = stat($File::Find::name)->mtime or return;
370 # to show or not to show future entries
371 return unless ( $show_future_entries or $mtime < time );
373 # add the file and its associated mtime to the list of files
374 $files{$File::Find::name} = $mtime;
376 # static rendering bits
378 = "$static_dir/$1/index." . $static_flavours[0];
381 or stat($static_file)->mtime < $mtime )
384 $d = join( '/', ( nice_date($mtime) )[ 5, 2, 3 ] );
386 $indexes{ ( $1 ? "$1/" : '' ) . "$2.$file_extension" } = 1
391 # not an entries match
392 elsif ( !-d $File::Find::name and -r $File::Find::name ) {
393 $others{$File::Find::name} = stat($File::Find::name)->mtime;
399 return ( \%files, \%indexes, \%others );
403 # Allow for the first encountered plugin::entries subroutine to override the
404 # default built-in entries subroutine
405 foreach my $plugin (@plugins) {
406 if ( $plugins{$plugin} > 0 and $plugin->can('entries') ) {
407 if ( my $tmp = $plugin->entries() ) {
414 my ( $files, $indexes, $others ) = &$entries();
415 %indexes = %$indexes;
418 if ( !$ENV{GATEWAY_INTERFACE}
419 and param('-password')
421 and param('-password') eq $static_password )
424 param('-quiet') or print "Blosxom is generating static index pages...\n";
426 # Home Page and Directory Indexes
428 foreach my $path ( sort keys %indexes ) {
430 foreach ( ( '', split /\//, $path ) ) {
434 mkdir "$static_dir/$p", 0755
435 unless ( -d "$static_dir/$p" or $p =~ /\.$file_extension$/ );
436 foreach $flavour (@static_flavours) {
438 = ( &$template( $p, 'content_type', $flavour ) );
439 $content_type =~ s!\n.*!!s;
440 my $fn = $p =~ m!^(.+)\.$file_extension$! ? $1 : "$p/index";
441 param('-quiet') or print "$fn.$flavour\n";
442 my $fh_w = new FileHandle "> $static_dir/$fn.$flavour"
443 or die "Couldn't open $static_dir/$p for writing: $!";
445 if ( $indexes{$path} == 1 ) {
451 $path_info =~ s!\.$file_extension$!\.$flavour!;
452 print $fh_w &generate( 'static', $path_info, '', $flavour,
459 $path_info_yr, $path_info_mo,
460 $path_info_da, $path_info
461 ) = split /\//, $p, 4;
462 unless ( defined $path_info ) { $path_info = "" }
463 print $fh_w &generate( 'static', '', $p, $flavour,
474 my $content_type = ( &$template( $path_info, 'content_type', $flavour ) );
475 $content_type =~ s!\n.*!!s;
477 $content_type =~ s/(\$\w+(?:::\w+)*)/"defined $1 ? $1 : ''"/gee;
478 $header = { -type => $content_type };
480 print generate( 'dynamic', $path_info,
481 "$path_info_yr/$path_info_mo_num/$path_info_da",
482 $flavour, $content_type );
486 foreach my $plugin (@plugins) {
487 if ( $plugins{$plugin} > 0 and $plugin->can('end') ) {
488 $entries = $plugin->end();
494 my ( $static_or_dynamic, $currentdir, $date, $flavour, $content_type )
498 %others = ref $others ? %$others : ();
501 foreach my $plugin (@plugins) {
502 if ( $plugins{$plugin} > 0 and $plugin->can('filter') ) {
503 $entries = $plugin->filter( \%files, \%others );
510 # Allow plugins to decide if we can cut short story generation
512 foreach my $plugin (@plugins) {
513 if ( $plugins{$plugin} > 0 and $plugin->can('skip') ) {
514 if ( my $tmp = $plugin->skip() ) {
521 # Define default interpolation subroutine
524 my $template = shift;
525 # Interpolate scalars, namespaced scalars, and hash/hashref scalars
526 $template =~ s/(\$\w+(?:::\w+)*(?:(?:->)?{(['"]?)[-\w]+\2})?)/"defined $1 ? $1 : ''"/gee;
530 unless ( defined($skip) and $skip ) {
532 # Plugins: Interpolate
533 # Allow for the first encountered plugin::interpolate subroutine to
534 # override the default built-in interpolate subroutine
535 foreach my $plugin (@plugins) {
536 if ( $plugins{$plugin} > 0 and $plugin->can('interpolate') ) {
537 if ( my $tmp = $plugin->interpolate() ) {
545 my $head = ( &$template( $currentdir, 'head', $flavour ) );
548 foreach my $plugin (@plugins) {
549 if ( $plugins{$plugin} > 0 and $plugin->can('head') ) {
550 $entries = $plugin->head( $currentdir, \$head );
554 $head = &$interpolate($head);
560 my $ne = $num_entries;
562 if ( $currentdir =~ /(.*?)([^\/]+)\.(.+)$/ and $2 ne 'index' ) {
563 $currentdir = "$1$2.$file_extension";
564 %f = ( "$datadir/$currentdir" => $files{"$datadir/$currentdir"} )
565 if $files{"$datadir/$currentdir"};
568 $currentdir =~ s!/index\..+$!!;
571 # Define a default sort subroutine
573 my ($files_ref) = @_;
575 sort { $files_ref->{$b} <=> $files_ref->{$a} }
580 # Allow for the first encountered plugin::sort subroutine to override the
581 # default built-in sort subroutine
582 foreach my $plugin (@plugins) {
583 if ( $plugins{$plugin} > 0 and $plugin->can('sort') ) {
584 if ( my $tmp = $plugin->sort() ) {
591 foreach my $path_file ( &$sort( \%f, \%others ) ) {
592 last if $ne <= 0 && $date !~ /\d/;
593 use vars qw/ $path $fn /;
595 = $path_file =~ m!^$datadir/(?:(.*)/)?(.*)\.$file_extension!;
597 # Only stories in the right hierarchy
598 $path =~ /^$currentdir/
599 or $path_file eq "$datadir/$currentdir"
602 # Prepend a slash for use in templates only if a path exists
605 # Date fiddling for by-{year,month,day} archive views
607 qw/ $dw $mo $mo_num $da $ti $yr $hr $min $hr12 $ampm $utc_offset/;
608 ( $dw, $mo, $mo_num, $da, $ti, $yr, $utc_offset )
609 = nice_date( $files{"$path_file"} );
610 ( $hr, $min ) = split /:/, $ti;
611 ( $hr12, $ampm ) = $hr >= 12 ? ( $hr - 12, 'pm' ) : ( $hr, 'am' );
613 if ( $hr12 == 0 ) { $hr12 = 12 }
615 # Only stories from the right date
616 my ( $path_info_yr, $path_info_mo_num, $path_info_da )
618 next if $path_info_yr && $yr != $path_info_yr;
619 last if $path_info_yr && $yr < $path_info_yr;
620 next if $path_info_mo_num && $mo ne $num2month[$path_info_mo_num];
621 next if $path_info_da && $da != $path_info_da;
622 last if $path_info_da && $da < $path_info_da;
625 my $date = ( &$template( $path, 'date', $flavour ) );
628 foreach my $plugin (@plugins) {
629 if ( $plugins{$plugin} > 0 and $plugin->can('date') ) {
631 = $plugin->date( $currentdir, \$date,
632 $files{$path_file}, $dw, $mo, $mo_num, $da, $ti,
637 $date = &$interpolate($date);
639 if ( $date && $curdate ne $date ) {
644 use vars qw/ $title $body $raw /;
645 if ( -f "$path_file" && $fh->open("< $path_file") ) {
646 chomp( $title = <$fh> );
647 chomp( $body = join '', <$fh> );
649 $raw = "$title\n$body";
651 my $story = ( &$template( $path, 'story', $flavour ) );
654 foreach my $plugin (@plugins) {
655 if ( $plugins{$plugin} > 0 and $plugin->can('story') ) {
656 $entries = $plugin->story( $path, $fn, \$story, \$title,
661 if ( $encode_xml_entities && $content_type =~ m{\bxml\b} ) {
663 # Escape <, >, and &, and to produce valid RSS
670 my $escape_re = join '|' => keys %escape;
671 $title =~ s/($escape_re)/$escape{$1}/g;
672 $body =~ s/($escape_re)/$escape{$1}/g;
675 $story = &$interpolate($story);
684 my $foot = ( &$template( $currentdir, 'foot', $flavour ) );
687 foreach my $plugin (@plugins) {
688 if ( $plugins{$plugin} > 0 and $plugin->can('foot') ) {
689 $entries = $plugin->foot( $currentdir, \$foot );
693 $foot = &$interpolate($foot);
697 foreach my $plugin (@plugins) {
698 if ( $plugins{$plugin} > 0 and $plugin->can('last') ) {
699 $entries = $plugin->last();
705 # Finally, add the header, if any and running dynamically
706 $output = header($header) . $output
707 if ( $static_or_dynamic eq 'dynamic' and $header );
715 my $c_time = CORE::localtime($unixtime);
716 my ( $dw, $mo, $da, $hr, $min, $sec, $yr )
718 =~ /(\w{3}) +(\w{3}) +(\d{1,2}) +(\d{2}):(\d{2}):(\d{2}) +(\d{4})$/
721 $da = sprintf( "%02d", $da );
722 my $mo_num = $month2num{$mo};
725 = timegm( $sec, $min, $hr, $da, $mo_num - 1, $yr - 1900 ) - $unixtime;
726 my $utc_offset = sprintf( "%+03d", int( $offset / 3600 ) )
727 . sprintf( "%02d", ( $offset % 3600 ) / 60 );
729 return ( $dw, $mo, $mo_num, $da, $ti, $yr, $utc_offset );
732 # Default HTML and RSS template bits
734 html content_type text/html; charset=$blog_encoding
738 html head <meta http-equiv="content-type" content="text/html;charset=$blog_encoding" />
739 html head <link rel="alternate" type="application/rss+xml" title="RSS" href="$url/index.rss" />
740 html head <title>$blog_title $path_info_da $path_info_mo $path_info_yr
745 html head <font size="+3">$blog_title</font><br />
746 html head $path_info_da $path_info_mo $path_info_yr
751 html story <a name="$fn"><b>$title</b></a><br />
752 html story $body<br />
754 html story posted at: $ti | path: <a href="$url$path">$path </a> | <a href="$url/$yr/$mo_num/$da#$fn">permanent link to this entry</a>
757 html date <h3>$dw, $da $mo $yr</h3>
762 html foot <a href="http://blosxom.sourceforge.net/"><img src="http://blosxom.sourceforge.net/images/pb_blosxom.gif" border="0" /></a>
767 rss content_type text/xml; charset=$blog_encoding
769 rss head <?xml version="1.0" encoding="$blog_encoding"?>
770 rss head <rss version="2.0">
772 rss head <title>$blog_title</title>
773 rss head <link>$url/$path_info</link>
774 rss head <description>$blog_description</description>
775 rss head <language>$blog_language</language>
776 rss head <docs>http://blogs.law.harvard.edu/tech/rss</docs>
777 rss head <generator>blosxom/$version</generator>
780 rss story <title>$title</title>
781 rss story <pubDate>$dw, $da $mo $yr $ti:00 $utc_offset</pubDate>
782 rss story <link>$url/$yr/$mo_num/$da#$fn</link>
783 rss story <category>$path</category>
784 rss story <guid isPermaLink="false">$path/$fn</guid>
785 rss story <description>$body</description>
793 error content_type text/html
797 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>
800 error story <p><b>$title</b><br />
801 error story $body <a href="$url/$yr/$mo_num/$da#fn.$default_flavour">#</a></p>
803 error date <h3>$dw, $da $mo $yr</h3>