initial module creation

diff --git a/convert-template.pl b/convert-template.pl
new file mode 100755 (executable)
index 0000000..e6b2d9e
--- /dev/null
+++ b/convert-template.pl
@@ -0,0 +1,2 @@
+#!/usr/bin/perl -p
+s/\<WORKSHIFT\>([\w\s]+)\<\/WORKSHIFT\>/\{ inputbox\(\"$1\"\); \}/ig;

diff --git a/shift.cgi b/shift.cgi
new file mode 100755 (executable)
index 0000000..7f9bcd6
--- /dev/null
+++ b/shift.cgi
@@ -0,0 +1,234 @@
+#!/usr/bin/perl -w
+#!/usr/bin/perl -Tw
+# (Text::Template can't do -T, but no user input is used dangerously)
+#
+# $Id: shift.cgi,v 1.1 2000-05-11 11:27:32 ivan Exp $
+#
+# Copyright (C) 2000 Adam Gould
+# Copyright (C) 2000 Michal Migurski
+# Copyright (C) 2000 Ivan Kohler
+# All rights reserved.
+#
+# This program is free software; you can redistribute it and/or modify it under
+# the same terms as Perl itself.
+
+###
+# user-servicable parts
+###
+
+$template_file = '/home/ivan/staffsheet/table.html';
+$data_directory = '/home/ivan/staffsheet/data';
+$mail_smtpserver = 'localhost'; # set blank to disable
+$mail_from = 'ivan-misconfigured-shift-from@420.am';
+$mail_subject = 'Your shift has been replaced';
+@mail_cc = (
+  'ivan-misconfigured-shift-cc@420.am',
+  'ivan-misconfigured-shift-cc2@420.am'
+);
+$mail_footer = <<END;
+
+Sorry, I don't have any more information.  The person who installed the 
+staff sheet didn't customize this message.
+
+END
+
+###
+# end of user-servicable parts
+###
+
+use strict;
+use vars qw( $template_file $data_directory $mail_smtpserver $mail_from
+             $mail_subject @mail_cc $mail_footer
+             $cgi $template %shifthash %warning @messages );
+use subs qw( form inputbox );
+use Fcntl ":flock";
+use CGI 2.15;
+use CGI::Carp qw(fatalsToBrowser);
+use Text::Template;
+use Mail::Internet;
+use Mail::Header;
+use Date::Format;
+
+$cgi = new CGI;
+
+$template = new Text::Template (
+  TYPE   => 'FILE',
+  SOURCE => $template_file,
+) or die "Can't create template for $template_file: $Text::Template::ERROR";
+
+# fill in new data if provided
+%warning = ();
+@messages = ();
+if ( $cgi->param() ) {
+
+  # kludge - grep for inputbox("field") in template to find valid form fields
+  # (DON'T get them from form submission - that's insecure!)
+  open (TEMPLATE_FILE,"<$template_file")
+    or die "Can't open template for $template_file: $!";
+  my @form_fields =
+    map { /inputbox\s*\(\s*([\'\"])(.*)\1\s*\)/; $2 }
+      #grep { /inputbox\s*\(\s*([\'\"])(.*)\1\s*\)/ }
+      grep { /inputbox\s*\(\s*([\'\"])(.*)\1\s*\);?\s*\}/ }
+        <TEMPLATE_FILE>;
+  close TEMPLATE_FILE;
+
+  #changed fields
+  #foreach $_ ( @form_fields ) {
+  #  warn "${_}_old undefined!" unless defined $cgi->param($_. '_old');
+  #  warn "${_}_new undefined!" unless defined $cgi->param($_. '_new');
+  #}
+  my @diff_fields =
+    grep { $cgi->param($_. '_old') ne $cgi->param($_. '_new') } @form_fields;
+
+  if ( @diff_fields ) {
+
+    local $SIG{HUP} = 'IGNORE';
+    local $SIG{INT} = 'IGNORE';
+    local $SIG{QUIT} = 'IGNORE';
+    local $SIG{TERM} = 'IGNORE';
+    local $SIG{TSTP} = 'IGNORE';
+    local $SIG{PIPE} = 'IGNORE';
+
+    #open(LOCKFILE,">>$data_directory/.lock")
+    open(LOCKFILE,"+<$data_directory/.lock")
+      or open(LOCKFILE,">>$data_directory/.lock")
+      or die "Can't open $data_directory/.lock: $!";
+    flock(LOCKFILE,LOCK_EX); #blocks until we have the lock
+    seek(LOCKFILE, 0, 0);
+    print LOCKFILE "$$     \n"; #superfluous
+
+    get_data();
+
+    foreach my $field ( @diff_fields ) {
+      $shifthash{$field}='' unless defined $shifthash{$field};
+      if ( $shifthash{$field} eq $cgi->param($field. '_old') ) {
+        if ( $cgi->param($field. "_new") =~
+               /\b(\w[\w\-\.\+]*\@(([\w\.\-]+\.)+\w+))\b/
+             || $cgi->param($field. "_new") =~ /^\s*$/
+        ) {
+          open(FILE,">$data_directory/.new.$field")
+            or die "Can't open file $data_directory/$field: $!";
+          print FILE $cgi->param($field. "_new");
+          close FILE;
+          rename "$data_directory/.new.$field", "$data_directory/$field";
+          $warning{$field} = '';
+          if (
+            $mail_smtpserver
+            && $shifthash{$field} =~ /\b(\w[\w\-\.\+]*\@(([\w\.\-]+\.)+\w+))\b/
+          ) {
+            my $to = $1;
+            my $header = Mail::Header->new( [
+              "From: $mail_from",
+              "To: $to",
+              "Cc: ". join(", ", @mail_cc),
+              "Sender: $mail_from",
+              "Reply-To: $mail_from",
+              "Date: ". time2str("%a, %d %b %Y %X %z", time),
+              "Subject: $mail_subject",
+            ] );
+            my $msg = Mail::Internet->new(
+              'Header' => $header,
+              'Body'   => [ map "$_\n",
+                "Hi,",
+                "",
+                "The \"$field\" shift you signed up for has been changed to",
+                '"'. $cgi->param($field. "_new"). '"',
+                "",
+                split("\n", $mail_footer),
+              ],
+            );
+            #send later - don't want to block on smtp while we have the lock
+            push @messages, $msg;
+          }
+        } else {
+          $warning{$field} = 
+            "WARNING: you tried to sign up for <B>$field</B>, but your entry ".
+            "<B>\"". $cgi->param($field. '_new').
+            "</B>\" does not contain a valid email address."
+          ;
+        }
+      } elsif ( $shifthash{$field} eq $cgi->param($field. '_new') ) {
+        #somebody else made the same change (or you hit reload); no need to warn
+        $warning{$field} = '';
+      } else {
+        $warning{$field} =
+          "WARNING: you tried to change <B>$field</B> from \"<B>".
+          $cgi->param($field. '_old').
+          "</B>\" to \"<B>".
+          $cgi->param($field. "_new").
+          "</B>\", but in the meantime someone changed it to: "
+        ;
+      }
+    }
+
+    flock(LOCKFILE,LOCK_UN);
+    close LOCKFILE;
+
+  }
+
+}
+
+get_data();
+
+my $text = $template->fill_in()
+  or die "Can't fill in template for $template_file: $Text::Template::ERROR";
+
+print $cgi->header, $text;
+
+$ENV{SMTPHOSTS} = $mail_smtpserver;
+$ENV{MAILADDRESS} = $mail_from;
+foreach my $msg ( @messages ) {
+  $msg->smtpsend;
+}
+
+# subroutines
+
+sub get_data {
+  opendir DATA_DIR, $data_directory
+    or die "Can't open directory $data_directory: $!";
+  %shifthash = map {
+    open(FILE, "<$data_directory/$_")
+      or die "Can't open file $data_directory/$_: $!";
+    my $value = scalar(<FILE>) || '';
+    close FILE;
+    chomp $value;
+    ( $_ => $value );
+  } grep { ! /^\.{1,2}(lock)?$/ } readdir(DATA_DIR);
+  closedir DATA_DIR;
+}
+
+# subroutines for the template
+
+sub form {
+ $cgi->start_form;
+}
+
+sub inputbox {
+  my $field = shift;
+  return $shifthash{$field} || "&nbsp;"
+    if defined $cgi->param('__MAGIC') && $cgi->param('__MAGIC') eq 'print';
+  $shifthash{$field}='' unless defined $shifthash{$field};
+  $warning{$field}='' unless defined $warning{$field};
+  #"$field ".
+  $cgi->hidden(
+    -name    => $field. '_old',
+    -default => $shifthash{$field},
+    -force   => 1,
+  ).
+  $warning{$field}.
+  $cgi->textfield(
+    -name    => $field. '_new',
+    -default => $shifthash{$field},
+    -force   => 1,
+    -size    => 15,
+  );
+}
+
+sub warnings {
+  join "<BR>", map {
+    "$warning{$_}<b>$shifthash{$_}</b>"
+  } grep {
+    $warning{$_}
+  } keys %warning;
+}
+

diff --git a/table.html b/table.html
new file mode 100644 (file)
index 0000000..8603c82
--- /dev/null
+++ b/table.html
@@ -0,0 +1,260 @@
+<!-- #include "header.incl" -->
+<!-- HEADER BEGIN -->
+
+<HTML>
+<HEAD>
+
+<TITLE>Viberation</TITLE>
+
+<SCRIPT LANGUAGE = "JavaScript">
+<!--
+function makeRemote() \{
+       remote = window.open("","remotewin","width=620,height=480,toolbar=no,directories=no,menubar=no,status=yes,location=no,scrollbars=no,resizable=no");
+       remote.location.href = "vibe_main.html";
+       if (remote.opener == null) \{ remote.opener = window; \} 
+       remote.opener.name = "opener";
+\}
+
+function testmovie_DoFSCommand(command, args) \{ 
+       if ( command == "call_alert" )
+       \{ 
+               alert("Here's the Flash message: " + args);
+       \}
+\}
+//-->
+
+</SCRIPT>
+
+<STYLE type="text/css">
+<!--
+       A:active \{ color: #FF0000; \}
+       A:visited \{ color: #336699; \}
+       A:link \{ color: #0033FF; \}
+
+       P \{
+               font-family: arial, helvetica, sans-serif;
+               color: #666666; 
+       \}
+
+       P EM \{
+               font-style: italic;
+       \}
+
+       P STRONG \{
+               font-weight: bold;
+       \}
+
+       H1, H2, H3, H4, H5, H6 \{
+               font-family: "trebuchet ms", arial,
+                               helvetica, sans-serif;
+       \}
+       
+-->
+</STYLE>
+
+</HEAD>
+<BODY TEXT="#666666" LINK="#0033FF" VLINK="#336699" ALINK="#FF0000" BGCOLOR="#FFFFFF">
+
+<CENTER>
+
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" WIDTH="90%" HEIGHT="90%">
+<TR><TD ALIGN=CENTER VALIGN=MIDDLE>
+       
+       <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0">
+       <TR VALIGN=BOTTOM>
+               <TD ALIGN=RIGHT><A HREF="http://www.viberation.com/index.html"><IMG SRC="http://www.viberation.com/graphics/head_left.gif" WIDTH="181" HEIGHT="40" BORDER="0"></A></TD>
+               <TD ALIGN=LEFT><A HREF="http://www.viberation.com/index.html"><IMG SRC="http://www.viberation.com/graphics/head_right_sfba.gif" WIDTH="216" HEIGHT="40" BORDER="0"></A></TD>
+       </TR>
+       <TR VALIGN=TOP>
+               <TD></TD>
+               <TD ALIGN=LEFT NOWRAP>
+               
+               &nbsp;<BR>
+               &nbsp;<BR>
+               
+<!-- HEADER END -->
+<!-- end include -->
+
+
+{ form(); }
+
+<P>{ warnings(); }</P>
+
+<P><INPUT TYPE="SUBMIT"><INPUT TYPE="RESET"><BR>
+<INPUT TYPE="checkbox" NAME="__MAGIC" VALUE="print">show results in printable format</P>
+
+<TABLE BORDER="1" CELLSPACING="1" CELLPADDING="4">
+       <TR>
+               <TH WIDTH="70" BGCOLOR="#999999" NOWRAP>Time</TD>
+               <TH WIDTH="70" BGCOLOR="#999999" NOWRAP>Door</TD>
+               <TH COLSPAN="2" BGCOLOR="#999999" NOWRAP>Parking</TD>
+               <TH WIDTH="70" BGCOLOR="#999999" NOWRAP>Time</TD>
+       </TR>
+       <TR>
+               <TD BGCOLOR="#CCCCCC" ALIGN=LEFT NOWRAP>9pm - 10pm</TD>
+               <TD ROWSPAN="2" BGCOLOR="#CCCCCC" ALIGN=LEFT>{ inputbox("Door 1"); }</TD>
+               <TD WIDTH="70" ROWSPAN="2" BGCOLOR="#CCCCCC" ALIGN=LEFT NOWRAP>{ inputbox("Park 1"); }</TD>
+               <TD WIDTH="70" ALIGN=LEFT NOWRAP>&nbsp;</TD>
+               <TD BGCOLOR="#CCCCCC" ALIGN=LEFT NOWRAP>9pm - 10pm</TD>
+       </TR>
+       <TR>
+               <TD BGCOLOR="#CCCCCC" ALIGN=LEFT NOWRAP>10pm - 11pm</TD>
+               <TD ROWSPAN="2" BGCOLOR="#CCCCCC" ALIGN=LEFT>{ inputbox("Park 2"); }</TD>
+               <TD BGCOLOR="#CCCCCC" ALIGN=LEFT NOWRAP>10pm - 11pm</TD>
+       </TR>
+       <TR>
+               <TD BGCOLOR="#CCCCCC" ALIGN=LEFT NOWRAP>11pm - 12am</TD>
+               <TD ROWSPAN="2" BGCOLOR="#CCCCCC" ALIGN=LEFT>{ inputbox("Door 2"); }</TD>
+               <TD ROWSPAN="2" BGCOLOR="#CCCCCC" ALIGN=LEFT>{ inputbox("Park 3"); }</TD>
+               <TD BGCOLOR="#CCCCCC" ALIGN=LEFT NOWRAP>11pm - 12am</TD>
+       </TR>
+       <TR>
+               <TD BGCOLOR="#CCCCCC" ALIGN=LEFT NOWRAP>12am - 1am</TD>
+               <TD ROWSPAN="2" BGCOLOR="#CCCCCC" ALIGN=LEFT>{ inputbox("Park 4"); }</TD>
+               <TD BGCOLOR="#CCCCCC" ALIGN=LEFT NOWRAP>12am - 1am</TD>
+       </TR>
+       <TR>
+               <TD BGCOLOR="#CCCCCC" ALIGN=LEFT NOWRAP>1am - 2am</TD>
+               <TD ROWSPAN="2" BGCOLOR="#CCCCCC" ALIGN=LEFT>{ inputbox("Door 3"); }</TD>
+               <TD ROWSPAN="2" BGCOLOR="#CCCCCC" ALIGN=LEFT>{ inputbox("Park 5"); }</TD>
+               <TD BGCOLOR="#CCCCCC" ALIGN=LEFT NOWRAP>1am - 2am</TD>
+       </TR>
+       <TR>
+               <TD BGCOLOR="#CCCCCC" ALIGN=LEFT NOWRAP>2am - 3am</TD>
+               <TD ROWSPAN="2" BGCOLOR="#CCCCCC" ALIGN=LEFT>{ inputbox("Park 6"); }</TD>
+               <TD BGCOLOR="#CCCCCC" ALIGN=LEFT NOWRAP>2am - 3am</TD>
+       </TR>
+       <TR>
+               <TD BGCOLOR="#CCCCCC" ALIGN=LEFT NOWRAP>3am - 4am</TD>
+               <TD ROWSPAN="2" BGCOLOR="#CCCCCC" ALIGN=LEFT>{ inputbox("Door 5"); }</TD>
+               <TD ROWSPAN="2" BGCOLOR="#CCCCCC" ALIGN=LEFT>{ inputbox("Park 7"); }</TD>
+               <TD BGCOLOR="#CCCCCC" ALIGN=LEFT NOWRAP>3am - 4am</TD>
+       </TR>
+       <TR>
+               <TD BGCOLOR="#CCCCCC" ALIGN=LEFT NOWRAP>4am - 5am</TD>
+               <TD ROWSPAN="2" BGCOLOR="#CCCCCC" ALIGN=LEFT>{ inputbox("Park 8"); }</TD>
+               <TD BGCOLOR="#CCCCCC" ALIGN=LEFT NOWRAP>4am - 5am</TD>
+       </TR>
+       <TR>
+               <TD BGCOLOR="#CCCCCC" ALIGN=LEFT NOWRAP>5am - 6am</TD>
+               <TD ALIGN=LEFT NOWRAP>&nbsp;</TD>
+               <TD ALIGN=LEFT NOWRAP>&nbsp;</TD>
+               <TD BGCOLOR="#CCCCCC" ALIGN=LEFT NOWRAP>5am - 6am</TD>
+       </TR>
+</TABLE>
+
+<P><SUBMIT_RESET></P>
+
+</FORM>
+
+
+<P>
+&copy;2000 Adam Gould and Michal Migurski.
+</P>
+
+
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" WIDTH="400">
+<TR><TD ALIGN=LEFT VALIGN=TOP>
+
+       <P>
+       Above is an example of the Online Staffing Sheet in action. Names can be modified by typing in the fields. Hitting "Submit" automatically updates the storage directory.
+       </P>
+
+       <H2>Download</H2>
+       
+       <P>All relevant files are included in the <A HREF="staffingsheet.sit">staffingsheet.sit</A> archive.</P>
+       <P>You also need the <A HREF="http://search.cpan.org/search?dist=Text-Template">Text::Template</A>, <A HREF="http://search.cpan.org/search?dist=MailTools">MailTools</A> and <A HREF="http://search.cpan.org/search?dist=TimeDate">TimeDate</A> perl modules.  (<a href="http://www.perl.com/CPAN/doc/manual/html/lib/CPAN.html">CPAN</a> will query, download and build perl modules automatically)
+
+
+       <H2>Configuration</H2>
+       
+       <P>
+       Configuring the staffing sheet is easy.
+       </P>
+       
+       <P>
+       <STRONG>Front-end</STRONG> changes can be made to the <A        HREF="table.html">table.html</A> file, which stores the layout of the staffing sheet and is     used to generate the database file. The table.html file uses some non-standard tags:
+       <UL>
+               <LI><CODE>\{&nbsp;form();&nbsp;\}</CODE><BR>
+                       Use this tag to start your form instead of the HTML <CODE>&lt;FORM&gt;</CODE> tag.  (You should end the form with the normal <CODE>&lt;/FORM&gt;</CODE> tag.)
+               <LI><CODE>\{&nbsp;inputbox("<i>shift</i>");&nbsp;\}</CODE><BR>
+                       This tag specifies the name of a workshift, as in       <CODE>\{&nbsp;inputbox("Door 1");&nbsp;\}</CODE>. The text enclosed in the tag is used as the workshift name, and is used to generate FORM INPUT fields by the shift.cgi program.  Characters allowed within the tag include spaces, digits, and letters; however the tag cannot begin or end with a space.  To ensure trouble-free use, please keep the tag on <STRONG>ONE</STRONG> line.  For an example of intended use, check the source of <A HREF="table.html">table.html</A>.
+               <LI><CODE>\{&nbsp;warnings();&nbsp;\}</CODE><BR>
+                       If, during the time between when you load the form and when you submit your changes, one of the fields you are changing has been changed by someone else, your changes will not be accepted and a warning will be issued next to the input box for that field.  You can use the <CODE>\{&nbsp;warnings();&nbsp;\}</CODE> tag to return a list of all warnings, so that you can locate them prominantly on the resulting page.
+               <LI>Note: old-style <CODE>&lt;WORKSHIFT&gt;<i>shift</i>&lt;/WORKSHIFT&gt;</CODE> tags can be converted to \{&nbsp;inputbox("<i>shift</i>");&nbsp;\} tags with the convert-template.pl program: <CODE>./convert-template.pl&nbsp;old-table-file.html&nbsp;>new-table-file.html</CODE>.
+       </UL>
+       Other than these tags, anything goes. You can include tables, various types of text formatting, and anything else not covered by the above restrictions.  If you need to use the <STRONG>\{</STRONG> or <STRONG>\}</STRONG> characters (the curly braces), you must preceed them with a <STRONG>\</STRONG> (backslash).  See the <A HREF="http://search.cpan.org/doc/MJD/Text-Template-1.23/Template.pm">Text::Template</A> documentation for details on the substitution language.
+       </P>
+       
+       <P>
+       <STRONG>Back-end</STRONG> configuration involves editing a few lines in the     <STRONG>shift.cgi</STRONG> file. The <CODE>$template_file</CODE> variable must be set to the full path and name of the front-end table.html file.  The <CODE>$data_directory</CODE> must be set to the full path and name of a directory where the data will be stored.  If you want to enable the optional mail-notification feature (will send email to anyone who has their shift replaced if they included an email address), set the <CODE>$mail_smtpserver</CODE> variable to the name of an SMTP server which will relay your messages, set the <CODE>$mail_from</CODE> variable to the address you wish to appear in the From:, Sender: and Reply-To: headers, set the <CODE>$mail_subject</CODE> variable to the subject you wish to appear in the Subject: header, set the <CODE>@mail_cc</CODE> variable to any addresses you wish Cc:'ed, and set the <CODE>$mail_footer</CODE> variable to a message which will appear at the bottom of all warning messages.<BR>
+<PRE>###
+# user-servicable parts
+###
+
+$template_file = '/home/ivan/staffsheet/table.html';
+$data_directory = '/home/ivan/staffsheet/data';
+$mail_smtpserver = 'localhost'; # set blank to disable
+$mail_from = 'ivan-misconfigured-shift-from@420.am';
+$mail_subject = 'Your shift has been replaced';
+@mail_cc = (
+  'ivan-misconfigured-shift-cc@420.am',
+  'ivan-misconfigured-shift-cc2@420.am',
+);
+$mail_footer = &lt;&lt;END;
+
+Sorry, I don't have any more information.  The person who installed the 
+staff sheet didn't customize this message.
+
+END
+
+###
+# end of user-servicable parts
+###
+</PRE>
+       
+       <H2>Use</H2>
+       
+       <P>
+       To use the files, install <STRONG>shift.cgi</STRONG> in a public web    directory as a CGI program.  (probably by placing it in a <A HREF="http://www.apache.org/docs/mod/mod_alias.html#scriptalias">cgi-bin</A> directory or using <A HREF="http://www.apache.org/docs/mod/mod_mime.html#addhandler">AddHandler</A>).  Permissions for all files must be set correctly. To make the <STRONG>shift.cgi</STRONG>        excecutable, set its permissions to 755 (<CODE>rwxr-xr-x</CODE>):<BR>
+       <PRE>chmod 755 shift.cgi</PRE><BR>
+       To create the the data directory:<BR>
+       <PRE>mkdir /path/to/data_dir</PRE><BR>
+       The data directory needs to be writable by the user executing the CGI.  It's probably best to simply make the data directory owned by the user as which <STRONG>shift.cgi</STRONG> runs (probably the <A HREF=http://www.apache.org/docs/mod/core.html#user>user as which the web server answers requests</A>, unless you are using <A HREF="http://www.apache.org/docs/suexec.html">suEXEC</A>), and set its permissions to 755:<BR>
+       <PRE>chown httpd /path/to/data_dir
+chmod 755 /path/to/data_dir</PRE>
+       </P>
+       
+       <H2>Contact</H2>
+       
+       <P>
+       Any questions or problems with the staffing sheet should be directed at <A HREF="mailto:mike@viberation.com">mike@viberation.com</A> or <A HREF="mailto:goolie@cloudfactory.org">goolie@cloudfactory.org</A> - We'd be happy to answer reasonable questions about the functions of the staffing list program.<BR>
+       </P>
+
+</TD></TR>
+</TABLE>
+
+
+<!-- #include "footer.incl" -->
+<!-- FOOTER BEGIN -->
+
+<!--           &nbsp;ÇBRÈ
+               &nbsp;ÇBRÈ
+
+               ÇPÈ
+               ÇA HREF="index.html"ÈHome.Ç/AÈ
+               Ç/PÈ -->
+               
+               </TD>
+       </TR>
+       </TABLE>
+</TD></TR>
+</TABLE>
+
+</CENTER>
+
+</BODY>
+</HTML>
+
+<!-- FOOTER END -->
+<!-- end include -->