artemus

   1 #!/usr/bin/perl
   2
   3 #
   4 #   artemus - HTML (and other things) Preprocessor
   5 #
   6 #   Copyright (C) 2000/2003 Angel Ortega <angel@triptico.com>
   7 #
   8 #   This program is free software; you can redistribute it and/or
   9 #   modify it under the terms of the GNU General Public License
  10 #   as published by the Free Software Foundation; either version 2
  11 #   of the License, or (at your option) any later version.
  12 #
  13 #   This program is distributed in the hope that it will be useful,
  14 #   but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 #   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 #   GNU General Public License for more details.
  17 #
  18 #   You should have received a copy of the GNU General Public License
  19 #   along with this program; if not, write to the Free Software
  20 #   Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  21 #
  22 #   http://www.triptico.com
  23 #
  24
  25 use locale;
  26 use Getopt::Long;
  27
  28 use Artemus;
  29
  30 # substitution variables
  31 %vars = ();
  32
  33 # substitution functions
  34 %funcs = ();
  35
  36 # source and destination files
  37 $src = "";
  38 $dst = "";
  39
  40 # config file
  41 $config_file = "artemus.conf";
  42
  43 # local configuration file
  44 $local_config_file = "local-artemus.conf";
  45
  46 # paragraph separator
  47 $para_sep = "";
  48
  49 # use cr/lf instead of lf
  50 $use_cr_lf = 0;
  51
  52 # append instead of overwrite output file
  53 $append = 0;
  54
  55 # send files using ftp
  56 $use_ftp = 0;
  57
  58 # build site map
  59 $site_map = 0;
  60
  61 # create makefile template
  62 $makefile_template = 0;
  63
  64 # quiet flag
  65 $quiet = 0;
  66
  67 # inverse substitutions
  68 $inverse_config_file = "artemus-inv.conf";
  69 %inv_vars = ();
  70
  71 # include path
  72 $include_path = "";
  73
  74 # include debugging info
  75 $debug = 0;
  76
  77 # unresolved templates
  78 @unresolved = ();
  79
  80 #####################################################################
  81
  82 # special utility functions
  83 $funcs{"filesize"} = sub { -s $_[0] };
  84 $funcs{"shell"} = sub { $_=`$_[0]`; chop; return $_ };
  85
  86 # id
  87 $VERSION = $Artemus::VERSION;
  88 $artemus_id = "Artemus $VERSION";
  89
  90 usage() if (!GetOptions( "i|input=s"       => \$src,
  91                         "o|output=s"       => \$dst,
  92                         "c|conf=s"         => \$config_file,
  93                         "p|paragraph=s"    => \$para_sep,
  94                         "m|msdos"          => \$use_cr_lf,
  95                         "a|append"         => \$append,
  96                         "v|version-only"   => \$version_only,
  97                         "f|ftp"            => \$use_ftp,
  98                         "k|makefile"       => \$makefile_template,
  99                         "s|site-map"       => \$site_map,
 100                         "q|quiet"          => \$quiet,
 101                         "l|include-path=s" => \$include_path,
 102                         "d|debug"          => \$debug,
 103                         "h|help"           => \$help) or $help);
 104
 105 $dst = ">-" if $dst eq "-";
 106
 107 version_only() if $version_only;
 108
 109 make_makefile() if $makefile_template;
 110
 111 build_site_map(@ARGV) if $site_map;
 112
 113 if (!$use_ftp) {
 114         usage() unless $src;
 115         usage() unless $dst;
 116 }
 117
 118 # read the configuration files
 119 read_config($config_file) if -f $config_file;
 120 read_config($local_config_file) if -f $local_config_file;
 121 read_config($inverse_config_file,1) if -f $inverse_config_file;
 122
 123 ftp_send() if $use_ftp;
 124
 125 open F, $src or die "can't open '$src'";
 126
 127 # get all the file
 128 #undef $/;
 129 $data = join("",<F>);
 130 close F;
 131
 132 # create the Artemus handle
 133 $ah = new Artemus("paragraph-separator" => $para_sep,
 134                 "vars"                => \%vars,
 135                 "inv-vars"            => \%inv_vars,
 136                 "funcs"               => \%funcs,
 137                 "include-path"        => $include_path,
 138                 "use-cr-lf"           => $use_cr_lf,
 139                 "unresolved"          => \@unresolved
 140               );
 141
 142 # do it
 143 $data = $ah->process($data);
 144
 145 # save file
 146
 147 open F, ($append ? ">" : "").">$dst" or die "can't write '$dst'";
 148 print F $data;
 149 close F;
 150
 151 foreach my $t (@unresolved) {
 152         print STDERR "Artemus: unresolved '$t'\n";
 153 }
 154
 155 exit(0);
 156
 157 ######################################################################
 158
 159 sub read_config
 160 {
 161         my ($conf,$inverse) = @_;
 162         local (*F);
 163
 164         # read config file
 165         unless (open F, $conf) {
 166                 if($quiet) {
 167                         return;
 168                 }
 169                 else {
 170                         die "'$conf' bad config file";
 171                 }
 172         }
 173
 174         while (<F>) {
 175                 my ($key, $val);
 176
 177                 chomp($_);
 178
 179                 unless (/^#/ or /^$/) {
 180                         ($key, $val) = split("=",$_,2);
 181
 182                         if ($val =~ s/^\|//) {
 183                                 $val = `$val`;
 184                                 chop($val);
 185                         }
 186                         elsif ($val eq "<<EOF") {
 187                                 # 'document here' construction
 188                                 $val = '';
 189
 190                                 while (<F>) {
 191                                         last if /^EOF/;
 192
 193                                         $val .= $_;
 194                                 }
 195                         }
 196                         elsif ($key eq "\\INCLUDE") {
 197                                 read_config($val);
 198                                 next;
 199                         }
 200
 201                         $vars{$key} = $val;
 202                         $inv_vars{$key} = $val if($inverse);
 203                 }
 204         }
 205
 206         close F;
 207 }
 208
 209
 210 sub usage
 211 {
 212         print("$artemus_id - HTML (and other things) Preprocessor\n");
 213         print("Copyright (C) 2000/2003 Angel Ortega <angel\@triptico.com>\n\n");
 214
 215         print("Usage:\n");
 216         print("  artemus -i|--input={input file} -o|--output={output file}\n");
 217         print("        [-c|--conf={config file}]\n");
 218         print("        [-l|--include-path={path to includes}]\n");
 219         print("        [-p|--paragraph={paragraph_separator}]\n");
 220         print("        [-q|--quiet]\n");
 221         print("        [-m|--msdos] [-a|--append] [-d|--debug]\n\n");
 222         print("    or\n\n");
 223         print("  artemus -f|--ftp {files to ftp...}\n\n");
 224         print("    or\n\n");
 225         print("  artemus -k|--makefile\n");
 226         print("    or\n\n");
 227         print("  artemus -s|--site-map\n");
 228
 229         exit(1);
 230 }
 231
 232
 233 sub version_only
 234 {
 235         print("$VERSION\n");
 236         exit(0);
 237 }
 238
 239
 240 sub ftp_send
 241 # send files using ftp
 242 {
 243         my ($ftp);
 244
 245         require Net::FTP;
 246
 247         if (scalar(@ARGV) == 0) {
 248                 print "Nothing to send.\n";
 249                 exit(0);
 250         }
 251
 252         print "Connecting to $vars{'ftp.host'}...\n";
 253         $ftp = Net::FTP->new($vars{'ftp.host'});
 254         print "OK\n";
 255
 256         print "Logging in as $vars{'ftp.user'}...\n";
 257         $ftp->login($vars{'ftp.user'},$vars{'ftp.passwd'})
 258                 or die "ftp login error";
 259         print "OK\n";
 260
 261         if (defined($vars{'ftp.dir'})) {
 262                 print "Chdir $vars{'ftp.dir'}...\n";
 263                 $ftp->cwd($vars{'ftp.dir'});
 264                 print "OK\n";
 265         }
 266
 267         $ftp->binary();
 268
 269         foreach my $f (@ARGV) {
 270                 print "Sending $f...\n";
 271                 $ftp->put($f,$f);
 272                 print "OK\n";
 273         }
 274
 275         print "Done.\n";
 276         $ftp->quit;
 277
 278         exit(0);
 279 }
 280
 281
 282 sub make_makefile
 283 # makes a makefile template
 284 {
 285         print <<"EOF";
 286 #
 287 # Makefile template created by $artemus_id
 288 # for HTML projects (GNU Make)
 289 #
 290 # artemus (C) 2000/2003 Angel Ortega <angel\@triptico.com>
 291 #
 292 # Use:
 293 #       make            -- to build everything
 294 #       make file.html  -- to build just file.html from file.artemus
 295 #       make clean      -- to delete every rebuildable thing
 296 #       make ftp        -- to upload using ftp
 297 #
 298
 299 # Fill DEST with a list of the .html files created by artemus
 300 # Use relative paths (e.g. misc/contact.html) if there are
 301 # subdirectories. This paths will be the same when uploading;
 302 # subdirs on ftp server must exist
 303
 304 DEST=   index.html [MODIFY HERE]
 305
 306 # Add \$(DEST) to INET plus any other file/directory than will
 307 # be uploaded but not built by this makefile.
 308 # e.g.: download/* or images/*
 309
 310 INET=\$(DEST) images/* [MODIFY HERE]
 311
 312 # directories for the site map
 313 DIRS= [MODIFY HERE]
 314
 315 # default target
 316 .PHONY: all
 317 all: \$(DEST)
 318
 319 # default rule. Artemus sources use the .artemus extension.
 320 # Change if you use another
 321 %.html: %.artemus
 322         artemus -i \$< -o \$@
 323
 324 # site map. File sitemap/index.artemus must be included
 325 # in DEST in order to be correctly remade.
 326 map:
 327         artemus --site-map \$(DIRS) > sitemap/index.artemus
 328         \$(MAKE)
 329
 330 # The usual clean
 331 .PHONY: clean
 332 clean:
 333         -rm \$(DEST) unresolved
 334
 335 # Last upload timestamp
 336 .PHONY: ftp
 337 ftp: ftpstamp
 338
 339 # if any file is newer than the last upload,
 340 # send it and recreate timestamp
 341 ftpstamp: \$(INET)
 342         artemus --ftp \$?
 343         touch ftpstamp
 344
 345 EOF
 346
 347         exit(0);
 348 }
 349
 350
 351 sub build_site_map
 352 # builds a site map from current directory to stdout
 353 {
 354         my (@dirs) = @_;
 355
 356         # special artemus token site-map-head
 357         print "{-site-map-head}\n\n";
 358         print "<ul>\n";
 359
 360         foreach my $dir (@dirs) {
 361                 my ($cnt, @l);
 362
 363                 open F, "find $dir -name \"*.html\" -follow|" or next;
 364
 365                 while (<F>) {
 366                         chop;
 367                         s/^\.\///;
 368                         push(@l,$_) unless /index.html$/;
 369                 }
 370
 371                 close F;
 372
 373                 @l = sort(@l);
 374
 375                 # the (supposed) index.html is put the first
 376                 unshift(@l,"$dir/index.html");
 377
 378                 # travel the list
 379                 $cnt = 0;
 380                 foreach my $i (@l) {
 381                         my ($size, $file, $title);
 382
 383                         $size = -s $i;
 384
 385                         # slurps all
 386                         open F, $i or next;
 387                         $file = join("",<F>);
 388                         close F;
 389
 390                         if ($file =~ /<title>([^<]*)/i) {
 391                                 $title = $1;
 392                         }
 393                         else {
 394                                 $title = $i;
 395                         }
 396
 397                         print "<li><a href='../$i'>$title</a> [$i] $size bytes\n";
 398                         print "<ul>\n" unless $cnt;
 399
 400                         $cnt++;
 401                 }
 402                 print "</ul>\n";
 403         }
 404
 405         print "</ul>\n";
 406
 407         # special artemus token site-map-foot
 408         print "{-site-map-foot}\n";
 409
 410         exit(0);
 411 }