/usr/bin/chronicle-spooler is in chronicle 4.6-2.
This file is owned by root:root, with mode 0o755.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 | #!/usr/bin/perl -w
=head1 NAME
chronicle-spooler - Automatically post pre-written entries.
=cut
=head1 SYNOPSIS
Path Options:
--config Specify a configuration file to read.
--spool-dir Specify where pending entries are located.
--live-dir Specify where the entries should be moved to.
Post-Spool Commands:
--post-move Specify a command to execute once entries have been moved.
Optional Features:
--test Only report on what would be executed.
Help Options:
--help Show the help information for this script.
--manual Read the manual for this script.
=cut
=head1 ABOUT
chronicle-spooler is a companion scrip to the chronicle blog compiler.
It is designed to facilitate posting new entries automatically upon
particular dates. (ie. If you have ten written blog entries in a spool
directory it will move them into place upon the date you've specified.)
=cut
=head1 DATE SPECIFICATION
To specify the date a particular entry should be made live you
must add another pseudo-header to your blog entry files, as follows:
=for example begin
Title: This is the title of the blog post
Date: 2nd March 2007
Publish: 15th April 2008
Tags: one, two, three, long tag
The text of your entry goes here.
=for example end
In this example we know that this entry will be made live upon the
15th April 2008, and not before.
=cut
=head1 AUTHOR
Steve
--
http://www.steve.org.uk/
=cut
=head1 LICENSE
Copyright (c) 2008-2010 by Steve Kemp. All rights reserved.
This module is free software;
you can redistribute it and/or modify it under
the same terms as Perl itself.
The LICENSE file contains the full text of the license.
=cut
use strict;
use warnings;
use Date::Parse;
use File::Copy;
use Getopt::Long;
use Pod::Usage;
#
# Release number
#
# NOTE: Set by 'make release'.
#
my $RELEASE = '4.6';
#
# Our configuration options.
#
my %CONFIG;
#
# Read the global and per-user configuration files, if they exist.
#
readConfigurationFile("/etc/chroniclerc");
readConfigurationFile( $ENV{ 'HOME' } . "/.chroniclerc" );
#
# Parse the command line arguments.
#
parseCommandLineArguments();
#
# Another configuration file?
#
readConfigurationFile( $CONFIG{ 'config' } ) if ( defined $CONFIG{ 'config' } );
#
# Make sure we have arguments which are sane.
#
# Specifically we need an input directory and an output directory.
#
#
sanityCheckArguments();
#
# Find the potentially pending entries.
#
my @files = findPendingPosts( $CONFIG{ 'spool-dir' } );
#
# Process each entry
#
my $live = 0;
foreach my $entry ( sort(@files) )
{
if ( shouldBeLive($entry) )
{
if ( $CONFIG{ 'test' } )
{
print "test: make entry live: $entry\n";
}
else
{
makeEntryLive($entry);
$live += 1;
}
}
}
#
# If we should run our command do so.
#
if ( ( $CONFIG{ 'post-move' } ) && $live )
{
if ( $CONFIG{ 'test' } )
{
print "test: should run: $CONFIG{'post-move'}\n";
}
else
{
system( $CONFIG{ 'post-move' } );
}
}
#
# All done.
#
exit;
=begin doc
Parse the command line arguments this script was given.
=end doc
=cut
sub parseCommandLineArguments
{
my $HELP = 0;
my $MANUAL = 0;
my $VERSION = 0;
#
# Parse options.
#
if (
!GetOptions(
# input / output
"spool-dir=s", \$CONFIG{ 'spool-dir' },
"live-dir=s", \$CONFIG{ 'live-dir' },
# testing?
"test", \$CONFIG{ 'test' },
# command?
"post-move=s", \$CONFIG{ 'post-move' },
# Help options
"help", \$HELP,
"manual", \$MANUAL,
"verbose", \$CONFIG{ 'verbose' },
"version", \$VERSION,
) )
{
exit;
}
pod2usage(1) if $HELP;
pod2usage( -verbose => 2 ) if $MANUAL;
if ($VERSION)
{
print("chronicle release $RELEASE\n");
exit;
}
}
=begin doc
Read the specified configuration file if it exists.
=end doc
=cut
sub readConfigurationFile
{
my ($file) = (@_);
#
# If it doesn't exist ignore it.
#
return if ( !-e $file );
my $line = "";
open my $handle, "<", $file or die "Cannot read file '$file' - $!";
while ( defined( $line = <$handle> ) )
{
chomp $line;
if ( $line =~ s/\\$// )
{
$line .= <FILE>;
redo unless eof(FILE);
}
# Skip lines beginning with comments
next if ( $line =~ /^([ \t]*)\#/ );
# Skip blank lines
next if ( length($line) < 1 );
# Strip trailing comments.
if ( $line =~ /(.*)\#(.*)/ )
{
$line = $1;
}
# Find variable settings
if ( $line =~ /([^=]+)=([^\n]+)/ )
{
my $key = $1;
my $val = $2;
# Strip leading and trailing whitespace.
$key =~ s/^\s+//;
$key =~ s/\s+$//;
$val =~ s/^\s+//;
$val =~ s/\s+$//;
# command expansion?
if ( $val =~ /(.*)`([^`]+)`(.*)/ )
{
# store
my $pre = $1;
my $cmd = $2;
my $post = $3;
# get output
my $output = `$cmd`;
chomp($output);
# build up replacement.
$val = $pre . $output . $post;
}
# Store value.
$CONFIG{ $key } = $val;
}
}
close($handle);
}
=begin doc
Sanity check our arguments, and setup to make sure there is nothing
obviously broken.
=end doc
=cut
sub sanityCheckArguments
{
if ( ( !$CONFIG{ 'spool-dir' } ) ||
( !-d $CONFIG{ 'spool-dir' } ) )
{
print <<EOF;
Please specify the spool directory, which contains the entries which
are to be moved into the live directory in the future.
EOF
exit;
}
if ( ( !$CONFIG{ 'live-dir' } ) ||
( !-d $CONFIG{ 'live-dir' } ) )
{
print <<EOF;
Please specify the output directory into which entries should be
moved to make them live.
EOF
exit;
}
}
=begin doc
Find any files that might be in the pending directory.
=end doc
=cut
sub findPendingPosts
{
my ($dir) = (@_);
my $pattern = "*";
my @files;
foreach my $file ( sort( glob("$dir/$pattern") ) )
{
push( @files, $file ) unless ( -d $file );
}
return (@files);
}
=begin doc
Read the given file and see if it should be published now.
That means that the file contained a "Publish:" pseudo-header
which is either in the past, or equal to todays date.
=end doc
=cut
sub shouldBeLive
{
my ($file) = (@_);
#
# If the file doesn't exist we don't publish it. Huh?
#
return 0 if ( !-e $file );
#
# Look for a header
#
my $header = "";
open my $handle, "<", $file or
die "Failed to read file $file - $!";
foreach my $line (<$handle>)
{
if ( ( $line =~ /^Publish:(.*)/i ) &&
( !length($header) ) )
{
$header = $1;
# Strip leading and trailing whitespace.
$header =~ s/^\s+//;
$header =~ s/\s+$//;
}
}
close($handle);
#
# No header? Not to be published
#
return 0 if ( length($header) < 1 );
#
# OK we got a header - is it current / past?
#
my $today = time;
if ( !defined($today) )
{
print "FAILED TO FIND TODAY\n";
return 0;
}
#
# Date of entry
#
my $ent = str2time($header);
if ( !defined($ent) )
{
print "FAILED TO PARSE: '$header'\n";
return 0;
}
#
# Do the date test.
#
if ( $ent < $today )
{
return 1;
}
else
{
return 0;
}
}
=begin doc
Move the specified file into our "live" directory.
=end doc
=cut
sub makeEntryLive
{
my ($file) = (@_);
if ( -d $CONFIG{ 'live-dir' } )
{
#
# Is there already a file there with that name?
#
# If so don't truncate it.
#
my $dir = $file;
my $base = $file;
if ( $base =~ /^(.*)[\\\/](.*)$/ )
{
$dir = $1;
$base = $2;
}
while ( -e "$CONFIG{'live-dir'}/$base" )
{
$base = "x$base";
}
#
# Moving
#
File::Copy::move( $file, $CONFIG{ 'live-dir' } . "/" . $base );
}
else
{
print "Weirdness $CONFIG{'live-dir'} is not a directory!\n";
exit;
}
}
|