4 # Author: Rael Dornfest <rael@oreilly.com>
6 # Home/Docs/Licensing: http://www.blosxom.com/
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 # Where are my plugins kept?
50 # Where should my modules keep their state information?
51 $plugin_state_dir = "$plugin_dir/state";
53 # --- Static Rendering -----
55 # Where are this blog's static files to be created?
56 $static_dir = "/Library/WebServer/Documents/blog";
58 # What's my administrative password (you must set this for static rendering)?
59 $static_password = "";
61 # What flavours should I generate statically?
62 @static_flavours = qw/html rss/;
64 # Should I statically generate individual entries?
68 # --------------------------------
70 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 !;
77 use CGI qw/:standard :netscape/;
81 my $fh = new FileHandle;
83 %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');
84 @num2month = sort { $month2num{$a} <=> $month2num{$b} } keys %month2num;
86 # Use the stated preferred URL or figure it out automatically
87 $url ||= url(-path_info => 1);
88 $url =~ s/^included:/http:/ if $ENV{SERVER_PROTOCOL} eq 'INCLUDED';
90 # NOTE: Since v3.12, it looks as if CGI.pm misbehaves for SSIs and
91 # always appends path_info to the url. To fix this, we always
92 # request an url with path_info, and always remove it from the end of the
94 my $pi_len = length $ENV{PATH_INFO};
95 my $might_be_pi = substr($url, -$pi_len);
96 substr($url, -length $ENV{PATH_INFO}) = '' if $might_be_pi eq $ENV{PATH_INFO};
100 # Drop ending any / from dir settings
101 $datadir =~ s!/$!!; $plugin_dir =~ s!/$!!; $static_dir =~ s!/$!!;
103 # Fix depth to take into account datadir's path
104 $depth and $depth += ($datadir =~ tr[/][]) - 1;
106 # Global variable to be used in head/foot.{flavour} templates
109 $static_or_dynamic = (!$ENV{GATEWAY_INTERFACE} and param('-password') and $static_password and param('-password') eq $static_password) ? 'static' : 'dynamic';
110 $static_or_dynamic eq 'dynamic' and param(-name=>'-quiet', -value=>1);
113 # Take a gander at HTTP's PATH_INFO for optional blog name, archive yr/mo/day
114 my @path_info = split m{/}, path_info() || param('path');
117 while ($path_info[0] and $path_info[0] =~ /^[a-zA-Z].*$/ and $path_info[0] !~ /(.*)\.(.*)/) { $path_info .= '/' . shift @path_info; }
119 # Flavour specified by ?flav={flav} or index.{flav}
122 if ( $path_info[$#path_info] =~ /(.+)\.(.+)$/ ) {
124 $1 ne 'index' and $path_info .= "/$1.$2";
127 $flavour = param('flav') || $default_flavour;
130 # Strip spurious slashes
131 $path_info =~ s!(^/*)|(/*$)!!g;
134 ($path_info_yr,$path_info_mo,$path_info_da) = @path_info;
135 $path_info_mo_num = $path_info_mo ? ( $path_info_mo =~ /\d{2}/ ? $path_info_mo : ($month2num{ucfirst(lc $path_info_mo)} || undef) ) : undef;
137 # Define standard template subroutine, plugin-overridable at Plugins: Template
140 my ($path, $chunk, $flavour) = @_;
143 return join '', <$fh> if $fh->open("< $datadir/$path/$chunk.$flavour");
144 } while ($path =~ s/(\/*[^\/]*)$// and $1);
146 return join '', ($template{$flavour}{$chunk} || $template{error}{$chunk} || '');
148 # Bring in the templates
151 last if /^(__END__)$/;
152 my($ct, $comp, $txt) = /^(\S+)\s(\S+)\s(.*)$/ or next;
154 $template{$ct}{$comp} .= $txt . "\n";
158 if ( $plugin_dir and opendir PLUGINS, $plugin_dir ) {
159 foreach my $plugin ( grep { /^\w+$/ && -f "$plugin_dir/$_" } sort readdir(PLUGINS) ) {
160 next if ($plugin =~ /~$/); # Ignore emacs backups
161 my($plugin_name, $off) = $plugin =~ /^\d*(\w+?)(_?)$/;
162 my $on_off = $off eq '_' ? -1 : 1;
163 require "$plugin_dir/$plugin";
164 $plugin_name->start() and ( $plugins{$plugin_name} = $on_off ) and push @plugins, $plugin_name;
170 # Allow for the first encountered plugin::template subroutine to override the
171 # default built-in template subroutine
172 my $tmp; foreach my $plugin ( @plugins ) { $plugins{$plugin} > 0 and $plugin->can('template') and defined($tmp = $plugin->template()) and $template = $tmp and last; }
174 # Provide backward compatibility for Blosxom < 2.0rc1 plug-ins
176 return &$template(@_);
179 # Define default entries subroutine
182 my(%files, %indexes, %others);
186 my $curr_depth = $File::Find::dir =~ tr[/][];
187 return if $depth and $curr_depth > $depth;
191 $File::Find::name =~ m!^$datadir/(?:(.*)/)?(.+)\.$file_extension$!
192 # not an index, .file, and is readable
193 and $2 ne 'index' and $2 !~ /^\./ and (-r $File::Find::name)
196 # to show or not to show future entries
199 or stat($File::Find::name)->mtime < time
202 # add the file and its associated mtime to the list of files
203 and $files{$File::Find::name} = stat($File::Find::name)->mtime
205 # static rendering bits
208 or !-f "$static_dir/$1/index." . $static_flavours[0]
209 or stat("$static_dir/$1/index." . $static_flavours[0])->mtime < stat($File::Find::name)->mtime
212 and $d = join('/', (nice_date($files{$File::Find::name}))[5,2,3])
214 and $indexes{$d} = $d
215 and $static_entries and $indexes{ ($1 ? "$1/" : '') . "$2.$file_extension" } = 1
219 !-d $File::Find::name and -r $File::Find::name and $others{$File::Find::name} = stat($File::Find::name)->mtime
224 return (\%files, \%indexes, \%others);
228 # Allow for the first encountered plugin::entries subroutine to override the
229 # default built-in entries subroutine
230 my $tmp; foreach my $plugin ( @plugins ) { $plugins{$plugin} > 0 and $plugin->can('entries') and defined($tmp = $plugin->entries()) and $entries = $tmp and last; }
232 my ($files, $indexes, $others) = &$entries();
233 %indexes = %$indexes;
236 if (!$ENV{GATEWAY_INTERFACE} and param('-password') and $static_password and param('-password') eq $static_password) {
238 param('-quiet') or print "Blosxom is generating static index pages...\n";
240 # Home Page and Directory Indexes
242 foreach my $path ( sort keys %indexes) {
244 foreach ( ('', split /\//, $path) ) {
247 $done{$p}++ and next;
248 (-d "$static_dir/$p" or $p =~ /\.$file_extension$/) or mkdir "$static_dir/$p", 0755;
249 foreach $flavour ( @static_flavours ) {
250 my $content_type = (&$template($p,'content_type',$flavour));
251 $content_type =~ s!\n.*!!s;
252 my $fn = $p =~ m!^(.+)\.$file_extension$! ? $1 : "$p/index";
253 param('-quiet') or print "$fn.$flavour\n";
254 my $fh_w = new FileHandle "> $static_dir/$fn.$flavour" or die "Couldn't open $static_dir/$p for writing: $!";
256 if ($indexes{$path} == 1) {
260 $path_info =~ s!\.$file_extension$!\.$flavour!;
261 print $fh_w &generate('static', $path_info, '', $flavour, $content_type);
264 local ($path_info_yr,$path_info_mo,$path_info_da, $path_info) =
266 unless (defined $path_info) {$path_info = ""};
267 print $fh_w &generate('static', '', $p, $flavour, $content_type);
277 my $content_type = (&$template($path_info,'content_type',$flavour));
278 $content_type =~ s!\n.*!!s;
280 $header = {-type=>$content_type};
282 print generate('dynamic', $path_info, "$path_info_yr/$path_info_mo_num/$path_info_da", $flavour, $content_type);
286 foreach my $plugin ( @plugins ) { $plugins{$plugin} > 0 and $plugin->can('end') and $entries = $plugin->end() }
290 my($static_or_dynamic, $currentdir, $date, $flavour, $content_type) = @_;
292 %files = %$files; %others = ref $others ? %$others : ();
295 foreach my $plugin ( @plugins ) { $plugins{$plugin} > 0 and $plugin->can('filter') and $entries = $plugin->filter(\%files, \%others) }
300 # Allow plugins to decide if we can cut short story generation
301 my $skip; foreach my $plugin ( @plugins ) { $plugins{$plugin} > 0 and $plugin->can('skip') and defined($tmp = $plugin->skip()) and $skip = $tmp and last; }
303 # Define default interpolation subroutine
307 my $template = shift;
309 s/(\$\w+(?:::)?\w*)/"defined $1 ? $1 : ''"/gee;
313 unless (defined($skip) and $skip) {
315 # Plugins: Interpolate
316 # Allow for the first encountered plugin::interpolate subroutine to
317 # override the default built-in interpolate subroutine
318 my $tmp; foreach my $plugin ( @plugins ) { $plugins{$plugin} > 0 and $plugin->can('interpolate') and defined($tmp = $plugin->interpolate()) and $interpolate = $tmp and last; }
321 my $head = (&$template($currentdir,'head',$flavour));
324 foreach my $plugin ( @plugins ) { $plugins{$plugin} > 0 and $plugin->can('head') and $entries = $plugin->head($currentdir, \$head) }
326 $head = &$interpolate($head);
332 my $ne = $num_entries;
334 if ( $currentdir =~ /(.*?)([^\/]+)\.(.+)$/ and $2 ne 'index' ) {
335 $currentdir = "$1$2.$file_extension";
336 $files{"$datadir/$1$2.$file_extension"} and %f = ( "$datadir/$1$2.$file_extension" => $files{"$datadir/$1$2.$file_extension"} );
339 $currentdir =~ s!/index\..+$!!;
342 # Define a default sort subroutine
345 return sort { $files_ref->{$b} <=> $files_ref->{$a} } keys %$files_ref;
349 # Allow for the first encountered plugin::sort subroutine to override the
350 # default built-in sort subroutine
351 my $tmp; foreach my $plugin ( @plugins ) { $plugins{$plugin} > 0 and $plugin->can('sort') and defined($tmp = $plugin->sort()) and $sort = $tmp and last; }
353 foreach my $path_file ( &$sort(\%f, \%others) ) {
354 last if $ne <= 0 && $date !~ /\d/;
355 use vars qw/ $path $fn /;
356 ($path,$fn) = $path_file =~ m!^$datadir/(?:(.*)/)?(.*)\.$file_extension!;
358 # Only stories in the right hierarchy
359 $path =~ /^$currentdir/ or $path_file eq "$datadir/$currentdir" or next;
361 # Prepend a slash for use in templates only if a path exists
364 # Date fiddling for by-{year,month,day} archive views
365 use vars qw/ $dw $mo $mo_num $da $ti $yr $hr $min $hr12 $ampm /;
366 ($dw,$mo,$mo_num,$da,$ti,$yr) = nice_date($files{"$path_file"});
367 ($hr,$min) = split /:/, $ti;
368 ($hr12, $ampm) = $hr >= 12 ? ($hr - 12,'pm') : ($hr, 'am');
369 $hr12 =~ s/^0//; $hr12 == 0 and $hr12 = 12;
371 # Only stories from the right date
372 my($path_info_yr,$path_info_mo_num, $path_info_da) = split /\//, $date;
373 next if $path_info_yr && $yr != $path_info_yr; last if $path_info_yr && $yr < $path_info_yr;
374 next if $path_info_mo_num && $mo ne $num2month[$path_info_mo_num];
375 next if $path_info_da && $da != $path_info_da; last if $path_info_da && $da < $path_info_da;
378 my $date = (&$template($path,'date',$flavour));
381 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) }
383 $date = &$interpolate($date);
385 $curdate ne $date and $curdate = $date and $output .= $date;
387 use vars qw/ $title $body $raw /;
388 if (-f "$path_file" && $fh->open("< $path_file")) {
389 chomp($title = <$fh>);
390 chomp($body = join '', <$fh>);
392 $raw = "$title\n$body";
394 my $story = (&$template($path,'story',$flavour));
397 foreach my $plugin ( @plugins ) { $plugins{$plugin} > 0 and $plugin->can('story') and $entries = $plugin->story($path, $fn, \$story, \$title, \$body) }
399 if ($content_type =~ m{\bxml\b}) {
400 # Escape <, >, and &, and to produce valid RSS
401 my %escape = ('<'=>'<', '>'=>'>', '&'=>'&', '"'=>'"');
402 my $escape_re = join '|' => keys %escape;
403 $title =~ s/($escape_re)/$escape{$1}/g;
404 $body =~ s/($escape_re)/$escape{$1}/g;
407 $story = &$interpolate($story);
416 my $foot = (&$template($currentdir,'foot',$flavour));
419 foreach my $plugin ( @plugins ) { $plugins{$plugin} > 0 and $plugin->can('foot') and $entries = $plugin->foot($currentdir, \$foot) }
421 $foot = &$interpolate($foot);
425 foreach my $plugin ( @plugins ) { $plugins{$plugin} > 0 and $plugin->can('last') and $entries = $plugin->last() }
429 # Finally, add the header, if any and running dynamically
430 $static_or_dynamic eq 'dynamic' and $header and $output = header($header) . $output;
439 my $c_time = ctime($unixtime);
440 my($dw,$mo,$da,$ti,$yr) = ( $c_time =~ /(\w{3}) +(\w{3}) +(\d{1,2}) +(\d{2}:\d{2}):\d{2} +(\d{4})$/ );
441 $da = sprintf("%02d", $da);
442 my $mo_num = $month2num{$mo};
444 return ($dw,$mo,$mo_num,$da,$ti,$yr);
448 # Default HTML and RSS template bits
450 html content_type text/html
454 html head <link rel="alternate" type="type="application/rss+xml" title="RSS" href="$url/index.rss" />
455 html head <title>$blog_title $path_info_da $path_info_mo $path_info_yr
460 html head <font size="+3">$blog_title</font><br />
461 html head $path_info_da $path_info_mo $path_info_yr
466 html story <a name="$fn"><b>$title</b></a><br />
467 html story $body<br />
469 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>
472 html date <h3>$dw, $da $mo $yr</h3>
477 html foot <a href="http://www.blosxom.com/"><img src="http://www.blosxom.com/images/pb_blosxom.gif" border="0" /></a>
482 rss content_type text/xml
484 rss head <?xml version="1.0"?>
485 rss head <!-- name="generator" content="blosxom/$version" -->
486 rss head <!DOCTYPE rss PUBLIC "-//Netscape Communications//DTD RSS 0.91//EN" "http://my.netscape.com/publish/formats/rss-0.91.dtd">
488 rss head <rss version="0.91">
490 rss head <title>$blog_title $path_info_da $path_info_mo $path_info_yr</title>
491 rss head <link>$url</link>
492 rss head <description>$blog_description</description>
493 rss head <language>$blog_language</language>
496 rss story <title>$title</title>
497 rss story <link>$url/$yr/$mo_num/$da#$fn</link>
498 rss story <description>$body</description>
506 error content_type text/html
510 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>
513 error story <p><b>$title</b><br />
514 error story $body <a href="$url/$yr/$mo_num/$da#fn.$default_flavour">#</a></p>
516 error date <h3>$dw, $da $mo $yr</h3>