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 # Where are this blog's entries kept?
23 $datadir = "/Library/WebServer/Documents/blosxom";
25 # What's my preferred base URL for this blog (leave blank for automatic)?
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
33 # How many entries should I show on the home page?
36 # What file extension signifies a blosxom entry?
37 $file_extension = "txt";
39 # What is the default flavour?
40 $default_flavour = "html";
42 # Should I show entries from the future (i.e. dated after now)?
43 $show_future_entries = 0;
45 # --- Plugins (Optional) -----
47 # File listing plugins blosxom should load (if empty blosxom will walk $plugin_dir)
50 # Where are my plugins kept?
53 # Where should my modules keep their state information?
54 $plugin_state_dir = "$plugin_dir/state";
56 # --- Static Rendering -----
58 # Where are this blog's static files to be created?
59 $static_dir = "/Library/WebServer/Documents/blog";
61 # What's my administrative password (you must set this for static rendering)?
62 $static_password = "";
64 # What flavours should I generate statically?
65 @static_flavours = qw/html rss/;
67 # Should I statically generate individual entries?
71 # --------------------------------
73 use vars qw! $version $blog_title $blog_description $blog_language $datadir $url %template $template $depth $num_entries $file_extension $default_flavour $static_or_dynamic $config_dir $plugin_list $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 !;
81 use CGI qw/:standard :netscape/;
85 # Load configuration from $ENV{BLOSXOM_CONFIG_DIR}/blosxom.conf, if it exists
87 if ($ENV{BLOSXOM_CONFIG_FILE} && -r $ENV{BLOSXOM_CONFIG_FILE}) {
88 $blosxom_config = $ENV{BLOSXOM_CONFIG_FILE};
89 ($config_dir = $blosxom_config) =~ s! / [^/]* $ !!x;
92 for my $blosxom_config_dir ($ENV{BLOSXOM_CONFIG_DIR}, '/etc/blosxom', '/etc') {
93 if (-r "$blosxom_config_dir/blosxom.conf") {
94 $config_dir = $blosxom_config_dir;
95 $blosxom_config = "$blosxom_config_dir/blosxom.conf";
100 # Load $blosxom_config
101 if ($blosxom_config) {
102 if (-r $blosxom_config) {
103 eval { require $blosxom_config } or
104 warn "Error reading blosxom config file '$blosxom_config'" . ($@ ? ": $@" : '');
107 warn "Cannot find or read blosxom config file '$blosxom_config'";
111 my $fh = new FileHandle;
113 %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');
114 @num2month = sort { $month2num{$a} <=> $month2num{$b} } keys %month2num;
116 # Use the stated preferred URL or figure it out automatically
117 $url ||= url(-path_info => 1);
118 $url =~ s/^included:/http:/ if $ENV{SERVER_PROTOCOL} eq 'INCLUDED';
120 # NOTE: Since v3.12, it looks as if CGI.pm misbehaves for SSIs and
121 # always appends path_info to the url. To fix this, we always
122 # request an url with path_info, and always remove it from the end of the
124 my $pi_len = length $ENV{PATH_INFO};
125 my $might_be_pi = substr($url, -$pi_len);
126 substr($url, -length $ENV{PATH_INFO}) = '' if $might_be_pi eq $ENV{PATH_INFO};
130 # Drop ending any / from dir settings
131 $datadir =~ s!/$!!; $plugin_dir =~ s!/$!!; $static_dir =~ s!/$!!;
133 # Fix depth to take into account datadir's path
134 $depth and $depth += ($datadir =~ tr[/][]) - 1;
136 # Global variable to be used in head/foot.{flavour} templates
139 $static_or_dynamic = (!$ENV{GATEWAY_INTERFACE} and param('-password') and $static_password and param('-password') eq $static_password) ? 'static' : 'dynamic';
140 $static_or_dynamic eq 'dynamic' and param(-name=>'-quiet', -value=>1);
143 # Take a gander at HTTP's PATH_INFO for optional blog name, archive yr/mo/day
144 my @path_info = split m{/}, path_info() || param('path');
147 while ($path_info[0] and $path_info[0] =~ /^[a-zA-Z].*$/ and $path_info[0] !~ /(.*)\.(.*)/) { $path_info .= '/' . shift @path_info; }
149 # Flavour specified by ?flav={flav} or index.{flav}
152 if ( $path_info[$#path_info] =~ /(.+)\.(.+)$/ ) {
154 $1 ne 'index' and $path_info .= "/$1.$2";
157 $flavour = param('flav') || $default_flavour;
160 # Strip spurious slashes
161 $path_info =~ s!(^/*)|(/*$)!!g;
164 ($path_info_yr,$path_info_mo,$path_info_da) = @path_info;
165 $path_info_mo_num = $path_info_mo ? ( $path_info_mo =~ /\d{2}/ ? $path_info_mo : ($month2num{ucfirst(lc $path_info_mo)} || undef) ) : undef;
167 # Define standard template subroutine, plugin-overridable at Plugins: Template
170 my ($path, $chunk, $flavour) = @_;
173 return join '', <$fh> if $fh->open("< $datadir/$path/$chunk.$flavour");
174 } while ($path =~ s/(\/*[^\/]*)$// and $1);
176 # Check for definedness, since flavour can be the empty string
177 if (defined $template{$flavour}{$chunk}) {
178 return $template{$flavour}{$chunk};
179 } elsif (defined $template{error}{$chunk}) {
180 return $template{error}{$chunk}
185 # Bring in the templates
188 last if /^(__END__)$/;
189 my($ct, $comp, $txt) = /^(\S+)\s(\S+)(?:\s(.*))?$/ or next;
191 $template{$ct}{$comp} .= $txt . "\n";
195 my @plugin_list = ();
197 # If $plugin_list is set, read plugins to use from that file
198 $plugin_list = "$config_dir/$plugin_list"
199 if $plugin_list && $plugin_list !~ m!^\s*/!;
200 if ( $plugin_list and -r $plugin_list and $fh->open("< $plugin_list") ) {
201 @plugin_list = map { chomp $_; $_ } grep { /\S/ && ! /^#/ } <$fh>;
204 # Otherwise walk $plugin_dir to get list of plugins to use
205 elsif ( $plugin_dir and opendir PLUGINS, $plugin_dir ) {
206 @plugin_list = grep { /^[\w:]+$/ && ! /~$/ && -f "$plugin_dir/$_" } sort readdir(PLUGINS);
210 unshift @INC, $plugin_dir;
211 foreach my $plugin ( @plugin_list ) {
212 my($plugin_name, $off) = $plugin =~ /^\d*([\w:]+?)(_?)$/;
213 my $on_off = $off eq '_' ? -1 : 1;
214 # Allow perl module plugins
215 if ($plugin =~ m/::/ && -z "$plugin_dir/$plugin") {
216 # For Blosxom::Plugin::Foo style plugins, we need to use a string require
217 eval "require $plugin_name";
220 eval { require $plugin };
222 $@ and warn "error finding or loading blosxom plugin $plugin_name - skipping\n" and next;
223 $plugin_name->start() and ( $plugins{$plugin_name} = $on_off ) and push @plugins, $plugin_name;
228 # Allow for the first encountered plugin::template subroutine to override the
229 # default built-in template subroutine
230 my $tmp; foreach my $plugin ( @plugins ) { $plugins{$plugin} > 0 and $plugin->can('template') and defined($tmp = $plugin->template()) and $template = $tmp and last; }
232 # Provide backward compatibility for Blosxom < 2.0rc1 plug-ins
234 return &$template(@_);
237 # Define default entries subroutine
240 my(%files, %indexes, %others);
244 my $curr_depth = $File::Find::dir =~ tr[/][];
245 return if $depth and $curr_depth > $depth;
249 $File::Find::name =~ m!^$datadir/(?:(.*)/)?(.+)\.$file_extension$!
250 # not an index, .file, and is readable
251 and $2 ne 'index' and $2 !~ /^\./ and (-r $File::Find::name)
254 # to show or not to show future entries
257 or stat($File::Find::name)->mtime < time
260 # add the file and its associated mtime to the list of files
261 and $files{$File::Find::name} = stat($File::Find::name)->mtime
263 # static rendering bits
266 or !-f "$static_dir/$1/index." . $static_flavours[0]
267 or stat("$static_dir/$1/index." . $static_flavours[0])->mtime < stat($File::Find::name)->mtime
270 and $d = join('/', (nice_date($files{$File::Find::name}))[5,2,3])
272 and $indexes{$d} = $d
273 and $static_entries and $indexes{ ($1 ? "$1/" : '') . "$2.$file_extension" } = 1
277 !-d $File::Find::name and -r $File::Find::name and $others{$File::Find::name} = stat($File::Find::name)->mtime
282 return (\%files, \%indexes, \%others);
286 # Allow for the first encountered plugin::entries subroutine to override the
287 # default built-in entries subroutine
288 my $tmp; foreach my $plugin ( @plugins ) { $plugins{$plugin} > 0 and $plugin->can('entries') and defined($tmp = $plugin->entries()) and $entries = $tmp and last; }
290 my ($files, $indexes, $others) = &$entries();
291 %indexes = %$indexes;
294 if (!$ENV{GATEWAY_INTERFACE} and param('-password') and $static_password and param('-password') eq $static_password) {
296 param('-quiet') or print "Blosxom is generating static index pages...\n";
298 # Home Page and Directory Indexes
300 foreach my $path ( sort keys %indexes) {
302 foreach ( ('', split /\//, $path) ) {
305 $done{$p}++ and next;
306 (-d "$static_dir/$p" or $p =~ /\.$file_extension$/) or mkdir "$static_dir/$p", 0755;
307 foreach $flavour ( @static_flavours ) {
308 my $content_type = (&$template($p,'content_type',$flavour));
309 $content_type =~ s!\n.*!!s;
310 my $fn = $p =~ m!^(.+)\.$file_extension$! ? $1 : "$p/index";
311 param('-quiet') or print "$fn.$flavour\n";
312 my $fh_w = new FileHandle "> $static_dir/$fn.$flavour" or die "Couldn't open $static_dir/$p for writing: $!";
314 if ($indexes{$path} == 1) {
318 $path_info =~ s!\.$file_extension$!\.$flavour!;
319 print $fh_w &generate('static', $path_info, '', $flavour, $content_type);
322 local ($path_info_yr,$path_info_mo,$path_info_da, $path_info) =
324 unless (defined $path_info) {$path_info = ""};
325 print $fh_w &generate('static', '', $p, $flavour, $content_type);
335 my $content_type = (&$template($path_info,'content_type',$flavour));
336 $content_type =~ s!\n.*!!s;
338 print generate('dynamic', $path_info, "$path_info_yr/$path_info_mo_num/$path_info_da", $flavour, $content_type);
342 foreach my $plugin ( @plugins ) { $plugins{$plugin} > 0 and $plugin->can('end') and $entries = $plugin->end() }
346 my($static_or_dynamic, $currentdir, $date, $flavour, $content_type) = @_;
348 %files = %$files; %others = ref $others ? %$others : ();
351 foreach my $plugin ( @plugins ) { $plugins{$plugin} > 0 and $plugin->can('filter') and $entries = $plugin->filter(\%files, \%others) }
356 # Allow plugins to decide if we can cut short story generation
357 my $skip; foreach my $plugin ( @plugins ) { $plugins{$plugin} > 0 and $plugin->can('skip') and defined($tmp = $plugin->skip()) and $skip = $tmp and last; }
359 # Define default interpolation subroutine
363 my $template = shift;
365 s/(\$\w+(?:::)?\w*)/"defined $1 ? $1 : ''"/gee;
369 unless (defined($skip) and $skip) {
371 # Plugins: Interpolate
372 # Allow for the first encountered plugin::interpolate subroutine to
373 # override the default built-in interpolate subroutine
374 my $tmp; foreach my $plugin ( @plugins ) { $plugins{$plugin} > 0 and $plugin->can('interpolate') and defined($tmp = $plugin->interpolate()) and $interpolate = $tmp and last; }
377 $content_type=&$interpolate($content_type);
378 $header = {-type=>$content_type};
381 my $head = (&$template($currentdir,'head',$flavour));
384 foreach my $plugin ( @plugins ) { $plugins{$plugin} > 0 and $plugin->can('head') and $entries = $plugin->head($currentdir, \$head) }
386 $head = &$interpolate($head);
392 my $ne = $num_entries;
394 if ( $currentdir =~ /(.*?)([^\/]+)\.(.+)$/ and $2 ne 'index' ) {
395 $currentdir = "$1$2.$file_extension";
396 $files{"$datadir/$1$2.$file_extension"} and %f = ( "$datadir/$1$2.$file_extension" => $files{"$datadir/$1$2.$file_extension"} );
399 $currentdir =~ s!/index\..+$!!;
402 # Define a default sort subroutine
405 return sort { $files_ref->{$b} <=> $files_ref->{$a} } keys %$files_ref;
409 # Allow for the first encountered plugin::sort subroutine to override the
410 # default built-in sort subroutine
411 my $tmp; foreach my $plugin ( @plugins ) { $plugins{$plugin} > 0 and $plugin->can('sort') and defined($tmp = $plugin->sort()) and $sort = $tmp and last; }
413 foreach my $path_file ( &$sort(\%f, \%others) ) {
414 last if $ne <= 0 && $date !~ /\d/;
415 use vars qw/ $path $fn /;
416 ($path,$fn) = $path_file =~ m!^$datadir/(?:(.*)/)?(.*)\.$file_extension!;
418 # Only stories in the right hierarchy
419 $path =~ /^$currentdir/ or $path_file eq "$datadir/$currentdir" or next;
421 # Prepend a slash for use in templates only if a path exists
424 # Date fiddling for by-{year,month,day} archive views
425 use vars qw/ $dw $mo $mo_num $da $ti $yr $hr $min $hr12 $ampm $utc_offset/;
426 ($dw,$mo,$mo_num,$da,$ti,$yr,$utc_offset) = nice_date($files{"$path_file"});
427 ($hr,$min) = split /:/, $ti;
428 ($hr12, $ampm) = $hr >= 12 ? ($hr - 12,'pm') : ($hr, 'am');
429 $hr12 =~ s/^0//; $hr12 == 0 and $hr12 = 12;
431 # Only stories from the right date
432 my($path_info_yr,$path_info_mo_num, $path_info_da) = split /\//, $date;
433 next if $path_info_yr && $yr != $path_info_yr; last if $path_info_yr && $yr < $path_info_yr;
434 next if $path_info_mo_num && $mo ne $num2month[$path_info_mo_num];
435 next if $path_info_da && $da != $path_info_da; last if $path_info_da && $da < $path_info_da;
438 my $date = (&$template($path,'date',$flavour));
441 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) }
443 $date = &$interpolate($date);
445 $curdate ne $date and $curdate = $date and $output .= $date;
447 use vars qw/ $title $body $raw /;
448 if (-f "$path_file" && $fh->open("< $path_file")) {
449 chomp($title = <$fh>);
450 chomp($body = join '', <$fh>);
452 $raw = "$title\n$body";
454 my $story = (&$template($path,'story',$flavour));
457 foreach my $plugin ( @plugins ) { $plugins{$plugin} > 0 and $plugin->can('story') and $entries = $plugin->story($path, $fn, \$story, \$title, \$body) }
459 if ($content_type =~ m{\bxml\b}) {
460 # Escape <, >, and &, and to produce valid RSS
461 my %escape = ('<'=>'<', '>'=>'>', '&'=>'&', '"'=>'"');
462 my $escape_re = join '|' => keys %escape;
463 $title =~ s/($escape_re)/$escape{$1}/g;
464 $body =~ s/($escape_re)/$escape{$1}/g;
467 $story = &$interpolate($story);
476 my $foot = (&$template($currentdir,'foot',$flavour));
479 foreach my $plugin ( @plugins ) { $plugins{$plugin} > 0 and $plugin->can('foot') and $entries = $plugin->foot($currentdir, \$foot) }
481 $foot = &$interpolate($foot);
485 foreach my $plugin ( @plugins ) { $plugins{$plugin} > 0 and $plugin->can('last') and $entries = $plugin->last() }
489 # Finally, add the header, if any and running dynamically
490 $static_or_dynamic eq 'dynamic' and $header and $output = header($header) . $output;
499 my $c_time = ctime($unixtime);
500 my($dw,$mo,$da,$hr,$min,$yr) = ( $c_time =~ /(\w{3}) +(\w{3}) +(\d{1,2}) +(\d{2}):(\d{2}):\d{2} +(\d{4})$/ );
502 $da = sprintf("%02d", $da);
503 my $mo_num = $month2num{$mo};
505 my $offset = timegm(00, $min, $hr, $da, $mo_num-1, $yr-1900)-$unixtime;
506 my $utc_offset = sprintf("%+03d", int($offset / 3600)).sprintf("%02d", ($offset % 3600)/60) ;
508 return ($dw,$mo,$mo_num,$da,$ti,$yr,$utc_offset);
512 # Default HTML and RSS template bits
514 html content_type text/html
518 html head <link rel="alternate" type="type="application/rss+xml" title="RSS" href="$url/index.rss" />
519 html head <title>$blog_title $path_info_da $path_info_mo $path_info_yr
524 html head <font size="+3">$blog_title</font><br />
525 html head $path_info_da $path_info_mo $path_info_yr
530 html story <a name="$fn"><b>$title</b></a><br />
531 html story $body<br />
533 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>
536 html date <h3>$dw, $da $mo $yr</h3>
541 html foot <a href="http://blosxom.sourceforge.net/"><img src="http://blosxom.sourceforge.net/images/pb_blosxom.gif" border="0" /></a>
546 rss content_type text/xml
548 rss head <?xml version="1.0"?>
549 rss head <!-- name="generator" content="blosxom/$version" -->
550 rss head <!DOCTYPE rss PUBLIC "-//Netscape Communications//DTD RSS 0.91//EN" "http://my.netscape.com/publish/formats/rss-0.91.dtd">
552 rss head <rss version="0.91">
554 rss head <title>$blog_title $path_info_da $path_info_mo $path_info_yr</title>
555 rss head <link>$url</link>
556 rss head <description>$blog_description</description>
557 rss head <language>$blog_language</language>
560 rss story <title>$title</title>
561 rss story <link>$url/$yr/$mo_num/$da#$fn</link>
562 rss story <description>$body</description>
570 error content_type text/html
574 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>
577 error story <p><b>$title</b><br />
578 error story $body <a href="$url/$yr/$mo_num/$da#fn.$default_flavour">#</a></p>
580 error date <h3>$dw, $da $mo $yr</h3>