# Blosxom Plugin: publish
# Author(s): Peter Florijn <tooh@tooh.myweb.nl> 
# Version: 2.0b5
# Blosxom Home/Docs/Licensing: http://www.raelity.org/apps/blosxom/
# Blosxom Plugin Docs: http://www.raelity.org/apps/blosxom/plugin.shtml

package publish;

# --- Configurable variables -----
$debug_level ||= 1;
$hours_valid = 24; 


# --------------------------------
my $package = "publish";

$expire_value = $hours_valid * 60 *60; 
$expire =''; # use as $publish::expire in flavour templates

sub debug {
    my ($level, @msg) = @_;

    if ($debug_level >= $level) {
	print STDERR "$package debug $level: @msg\n";
    }
}

sub start {
  1;
}

sub head {
  my($pkg, $currentdir, $head_ref) = @_;
  debug(1, "Expire after $hours_valid hours");
  $expire = "<META HTTP-EQUIV=\"expires\" CONTENT=\"$expire_value\">";

  1;
}


1;

__END__

=head1 NAME

Blosxom Plug-in: publish

=head1 SYNOPSIS

Purpose: Produces the meta tag 'expires' with a value that indicates the numer of seconds to preserve the page. 
After this time the page must be refreshed and not served from a proxy server cache.
Allowing frequently updated pages to show up immediately in the browser without an manual refresh. 

=head1 VERSION

2.0b5

Version number coincides with the version of Blosxom with which the 
current version was first bundled.

=head1 AUTHOR

Peter Florijn  <tooh@tooh.myweb.nl>, http://tooh.myweb.nl/

=head1 SEE ALSO

Blosxom Home/Docs/Licensing: http://www.raelity.org/apps/blosxom/

Blosxom Plugin Docs: http://www.raelity.org/apps/blosxom/plugin.shtml

=head1 BUGS

Address bug reports and comments to the Blosxom mailing list 
[http://www.yahoogroups.com/group/blosxom].

=head1 LICENSE

This Blosxom Plug-in
Copyright 2003, Peter Florijn 

Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.