#!/usr/bin/perl -T
###########################
#
#  MarlboroClassSchedule.cgi 
#       is a web .cgi script to display an editable
#       Marlboro College class schedule.
#       The documentation is at the end of this file in POD format.
#
#  $Id: MarlboroClassSchedule.cgi,v 1.3 2002/04/12 09:19:20 msie Exp $
###########################
package MarlboroClassSchedule;

# -== initialization ============================================-
# I'd rather define globals with the "our" keyword, 
# but on akbar we're still stuck at perl 5.005 ...
use vars qw( $VERSION $cgi 
             $title1 $title2 $contact
             $datafilename $lastmodified $blockdata
             $schedulehtml
           );
$VERSION = "0.1";
use CGI;
use CGI::Carp qw(fatalsToBrowser);

# -== main ======================================================-
defineGlobals();
readData();             # Define $blockdata from the disk file $datafilename .

# If the user has clicked "Save Changes", 
if ($cgi->param('saveChanges')) {
  my $whichBlock = $cgi->param('whichBlock');
  my $text =       $cgi->param('text');
  $blockdata->{ $whichBlock } = $text;
  writeData();
}

# When accessed through the internet, via apache .cgi, caller() is false.
# Under mod_perl, caller() is 'Apache::Registry'.
# If we're invoked either of these ways, output a web page.
# (Otherwise, another file such as test.pl is executing this file.)
if ( not caller() or caller() eq 'Apache::Registry' ) {
  print $cgi->header();
  if (my $whichBlock = $cgi->param('edit')) {
    print htmlEdit($whichBlock);
  }
  else {
    print htmlSchedule();
  }
}

# -== define various global parameters  ==========================-
sub defineGlobals {
  $cgi = new CGI;
  $title1 = 'Marlboro College - Fall 2002 Class Schedule';
  $title2 = 'Marlboro College <br> Fall 2002 Class Schedule';
  $contact = 
   'Jim Mahoney (<a href="mailto"mahoney@marlboro.edu>mahoney@marlboro.edu</a>)';

  # I don't think this is really necessary - I put it in to have short 
  # keys for the hash which stores the text for each time block, but it 
  # would probably be cleaner to just uses the longer, full names everywhere.
  %timeblocks = (
                 mon830         => "Monday 8:30am",
                 wed830         => "Wednesday 8:30am",
                 fri830         => "Friday 8:30am",
                 mon930         => "Monday 9:30am",
                 wed930         => "Wednesday 9:30am",
                 fri930         => "Friday 9:30am",
                 mon1030        => "Monday 10:30am",
                 wed1030        => "Wednesday 10:30am",
                 fri1030        => "Friday 10:30am",
                 tues830        => "Tuesday 8:30am",
                 thurs830       => "Thursday 8:30am",
                 tues1000       => "Tuesday 10:00am",
                 thurs1000      => "Thursday 10:00am",
                 mon1130        => "Monday 11:30am",
                 tues1130       => "Tuesday 11:30am",
                 wed1130        => "Wednesday 11:30am",
                 thurs1130      => "Thursday 11:30am",
                 fri1130        => "Friday 11:30am",
                 mon130         => "Monday 1:30pm",
                 tues130        => "Tuesday 1:30pm",
                 thurs130       => "Thursday 1:30pm",
                 fri130         => "Friday 1:30pm",
                 mon330         => "Monday 3:30pm",
                 tues330        => "Tuesday 3:30pm",
                 thurs330       => "Thursday 3:30pm",
                 fri330         => "Friday 3:30pm",
                 tues630        => "Tuesday 6:30pm",
                 wed630         => "Wednesday 6:30pm",
                 thurs630       => "Thursday 6:30pm",
                 fri630         => "Friday 6:30pm",
                );

  # The web server must have read/write access to this file.
  $datafilename = "datafile.txt";
}

# -== data persistence routines ==========================================-

# Storable reports errors by throwing exceptions which are caught with eval{}.
# See http://theoryx5.uwinnipeg.ca/CPAN/data/Storable/Storable.html
use Storable;

# Since this routine creates the file $datafilename
# and sets its privileges, whoever runs it must have 
# write access to the directory where $datafilename lives.
sub initData {
  $blockdata = {};
  unlink $datafilename;
  writeData();
  chmod 0666, $datafilename;
}

sub readData {
  initData() unless -e $datafilename;
  $lastmodified = -M $datafilename;
  $lastmodified = scalar localtime( time() - 24*3600*$lastmodified );
  $lastmodified =~ s/\d+:\d+:\d+ //;
  eval { $blockdata = Storable::lock_retrieve( $datafilename ) };
  if ($@) { die "couldn't read data : $@"; }
}

sub writeData {
  # nstore is "network store" - uses file format compatible across platforms
  eval { Storable::lock_nstore( $blockdata, $datafilename ) };
  if ($@) { die "couldn't write data : $@"; }
}

# -==  html string for edit page ==================================-
sub htmlEdit {
  my ($whichBlock) = @_;
  return <<"END_EDIT_HTML";
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
<html>
<head>
   <title>$title1</title>
<body bgcolor="white">
<h1>$title2</h2><p>
<table><tr><td>
<hr noshade size=1>
<big><b>Editing $timeblocks{$whichBlock} </b></big>
<p>
<form method="POST" action="MarlboroClassSchedule.cgi">
 <input type="hidden" name="whichBlock" value="$whichBlock">
 <textarea name="text" rows="20" cols="40" wrap="soft">$blockdata->{$whichBlock}</textarea><br>
 <input name="saveChanges" type="Submit" value="Save Changes">
</form>
</td></tr></table>
</body>
</html>
END_EDIT_HTML
}


# -==  html string for schedule page ==================================-
sub htmlSchedule {
return <<"END_SCHEDULE_HTML";
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
<html>
<head>
   <title>$title1</title>
   <style type="text/css">
      .weekday { 
        background:     #666666;
        color:          white;
        font-family:    Verdana, Helvetica, Arial;
        }
      .time {
        background:     #666666;
        color:          white;
        font-family:    Verdana, Helvetica, Arial;
        font-size:      small;
        vertical-align: top;
        }
      .colorA {
        background:     #ffffee;
        vertical-align: top;
        }
      .colorB {
        background:     #ffffdd;
        vertical-align: top;
        }
      .colorC {
        background:     #ffffcc;
        vertical-align: top;
        }
   </style>
</head>

<body bgcolor="white">
<h1>$title2</h1>

<table align='center'><tr><td bgcolor="#cccccc"> <!== cell border color ==>
<table border="3" cellpadding="2" cellspacing="3" bgcolor="white" width=800> 

                <tr>
                <td></td>
                <td width="20%" class="weekday">Monday</td>
                <td width="20%" class="weekday">Tuesday</td>
                <td width="20%" class="weekday">Wednesday</td>
                <td width="20%" class="weekday">Thursday</td>
                <td width="20%" class="weekday">Friday</td>
                </tr>

                <tr>
                <td class="time">8:30<br><br></td>

                <td rowspan="2" class="colorB">

<!== Mon 8:30 ==>
<pre>$blockdata->{mon830}</pre><p>
<div align="right">
 <small><a href="MarlboroClassSchedule.cgi?edit=mon830">Edit</a></small>
</div>

                </td>
                <td rowspan="3" class="colorA">

<!== Tue 8:30 ==>
<pre>$blockdata->{tues830}</pre><p>
<div align="right">
 <small><a href="MarlboroClassSchedule.cgi?edit=tues830">Edit</a></small>
</div>

                </td>
                <td rowspan="2" class="colorB">

<!== Wed 8:30 ==>
<pre>$blockdata->{wed830}</pre><p>
<div align="right">
 <small><a href="MarlboroClassSchedule.cgi?edit=wed830">Edit</a></small>
</div>

                </td>
                <td rowspan="3" class="colorA">

<!== Thurs 8:30 ==>
<pre>$blockdata->{thurs830}</pre><p>
<div align="right">
 <small><a href="MarlboroClassSchedule.cgi?edit=thurs830">Edit</a></small>
</div>

                </td>
                <td rowspan="2" class="colorB">

<!== Fri 8:30 ==>
<pre>$blockdata->{fri830}</pre><p>
<div align="right">
 <small><a href="MarlboroClassSchedule.cgi?edit=fri830">Edit</a></small>
</div>

                </td>
                </tr>

                <tr>
                <td class="time">9:00<br><br></td>
                </tr>

                <tr>
                <td class="time">9:30<br><br></td>

                <td rowspan="2" class="colorB">

<!== Mon 9:30 ==>
<pre>$blockdata->{mon930}</pre><p>
<div align="right">
 <small><a href="MarlboroClassSchedule.cgi?edit=mon930">Edit</a></small>
</div>

                </td>
                <td rowspan="2" class="colorB">

<!== Wed 9:30 ==>
<pre>$blockdata->{wed930}</pre><p>
<div align="right">
 <small><a href="MarlboroClassSchedule.cgi?edit=wed930">Edit</a></small>
</div>

                </td>
                <td rowspan="2" class="colorB">

<!== Fri 9:30 ==>
<pre>$blockdata->{fri930}</pre><p>
<div align="right">
 <small><a href="MarlboroClassSchedule.cgi?edit=fri930">Edit</a></small>
</div>

                </td>
                </tr>

                <tr>
                <td class="time">10:00<br><br></td>

                <td rowspan="3" class="colorA">

<!== Tue 10:00 ==>
<pre>$blockdata->{tues1000}</pre><p>
<div align="right">
 <small><a href="MarlboroClassSchedule.cgi?edit=tues1000">Edit</a></small>
</div>

                </td>
                <td rowspan="3" class="colorA">

<!== Thurs 10:00 ==>
<pre>$blockdata->{thurs1000}</pre><p>
<div align="right">
 <small><a href="MarlboroClassSchedule.cgi?edit=thurs1000">Edit</a></small>
</div>

                </td>
                </tr>

                <tr>
                <td class="time">10:30<br><br></td>

                <td rowspan="2" class="colorB">

<!== Mon 10:30 ==>
<pre>$blockdata->{mon1030}</pre><p>
<div align="right">
 <small><a href="MarlboroClassSchedule.cgi?edit=mon1030">Edit</a></small>
</div>

                </td>
                <td rowspan="2" class="colorB">

<!== Wed 10:30 ==>
<pre>$blockdata->{wed1030}</pre><p>
<div align="right">
 <small><a href="MarlboroClassSchedule.cgi?edit=wed1030">Edit</a></small>
</div>

                </td>
                <td rowspan="2" class="colorB">

<!== Fri 10:30 ==>
<pre>$blockdata->{fri1030}</pre><p>
<div align="right">
 <small><a href="MarlboroClassSchedule.cgi?edit=fri1030">Edit</a></small>
</div>

                </td>
                <td ></td>
                </tr>

                <tr>
                <td class="time">11:00<br><br></td>
                </tr>

                <tr>
                <td class="time">11:30<br><br></td>

                <td rowspan="3" class="colorB">

<!== Mon 11:30 ==>
<pre>$blockdata->{mon1130}</pre><p>
<div align="right">
 <small><a href="MarlboroClassSchedule.cgi?edit=mon1130">Edit</a></small>
</div>

                </td>
                <td rowspan="3" class="colorA">

<!== Tue 11:30 ==>
<pre>$blockdata->{tues1130}</pre><p>
<div align="right">
 <small><a href="MarlboroClassSchedule.cgi?edit=tues1130">Edit</a></small>
</div>

                </td>
                <td rowspan="3" class="colorB">

<!== Wed 11:30 ==>
<pre>$blockdata->{wed1130}</pre><p>
<div align="right">
 <small><a href="MarlboroClassSchedule.cgi?edit=wed1130">Edit</a></small>
</div>

                </td>
                <td rowspan="3" class="colorA">

<!== Thurs 11:30 ==>
<pre>$blockdata->{thurs1130}</pre><p>
<div align="right">
 <small><a href="MarlboroClassSchedule.cgi?edit=thurs1130">Edit</a></small>
</div>

                </td>
                <td rowspan="3" class="colorB">

<!== Fri 11:30 ==>
<pre>$blockdata->{fri1130}</pre><p>
<div align="right">
 <small><a href="MarlboroClassSchedule.cgi?edit=fri1130">Edit</a></small>
</div>

                </td>
                </tr>

                <tr>
                <td class="time">12:00<br><br></td>
                </tr>

                <tr>
                <td class="time">12:30<br><br></td>
                </tr>

                <tr>
                <td class="time">1:00<br><br></td>
                
                <td valign="top">

<!== Mon 1:00 ==>
<br>
                </td>
                <td valign="top">

<!== Tues 1:00 ==>
<br>
                </td>
                <td rowspan="2" class="colorC"> Dedicated<br>Hour </td>
                <td valign="top">

<!== Thurs 1:00 ==>
<br>
                </td>
                <td valign="top">

<!== Fri 1:00 ==>
<br>
                </td>
                </tr>

                <tr>
                <td class="time">1:30<br><br></td>

                <td rowspan="4" class="colorA">

<!== Mon 1:30 ==>
<pre>$blockdata->{mon130}</pre><p>
<div align="right">
 <small><a href="MarlboroClassSchedule.cgi?edit=mon130">Edit</a></small>
</div>

                </td>
                <td rowspan="4" bgcolor="ffffdd" valign="top">

<!== Tue 1:30 ==>
<pre>$blockdata->{tues130}</pre><p>
<div align="right">
 <small><a href="MarlboroClassSchedule.cgi?edit=tues130">Edit</a></small>
</div>

                </td>
                <td rowspan="4" class="colorA">

<!== Thurs 1:30 ==>
<pre>$blockdata->{thurs130}</pre><p>
<div align="right">
 <small><a href="MarlboroClassSchedule.cgi?edit=thurs130">Edit</a></small>
</div>
                </td>
                <td rowspan="4" bgcolor="ffffdd" valign="top">

<!== Fri 1:30 ==>
<pre>$blockdata->{fri130}</pre><p>
<div align="right">
 <small><a href="MarlboroClassSchedule.cgi?edit=fri130">Edit</a></small>
</div>

                </td>
                </tr>

                <tr>
                <td class="time">2:00<br><br></td>
                <td rowspan="7" class="colorC">
                Town / Faculty <br>
                Meeting
                </td>
                </tr>

                <tr>
                <td class="time">2:30<br><br></td>
                </tr>
                
                <tr>
                <td class="time">3:00<br><br></td>
                </tr>

                <tr>
                <td class="time">3:30<br><br></td>
                <td rowspan="4" class="colorA">

<!== Mon 3:30 ==>
<pre>$blockdata->{mon330}</pre><p>
<div align="right">
 <small><a href="MarlboroClassSchedule.cgi?edit=mon330">Edit</a></small>
</div>
                </td>
                <td rowspan="4" class="colorB">

<!== Tue 3:30 ==>
<pre>$blockdata->{tues330}</pre><p>
<div align="right">
 <small><a href="MarlboroClassSchedule.cgi?edit=tues330">Edit</a></small>
</div>

                </td>
                <td rowspan="4" class="colorA">

<!== Thurs 3:30 ==>
<pre>$blockdata->{thurs330}</pre><p>
<div align="right">
 <small><a href="MarlboroClassSchedule.cgi?edit=thurs330">Edit</a></small>
</div>

                </td>
                <td rowspan="4" class="colorB">

<!== Fri 3:30 ==>
<pre>$blockdata->{fri330}</pre><p>
<div align="right">
 <small><a href="MarlboroClassSchedule.cgi?edit=fri330">Edit</a></small>
</div>

                </td>
                </tr>
                
                <tr>
                <td class="time">4:00<br><br></td>
                </tr>

                <tr>
                <td class="time">4:30<br><br></td>
                </tr>

                <tr>
                <td class="time">5:00<br><br></td>
                </tr>

                <tr>
                <td class="time">5:30</td>
                <td rowspan="2"><br></td>
                <td rowspan="2"><br></td>
                <td rowspan="2"><br></td>
                <td rowspan="2"><br></td>
                <td rowspan="2"><br></td>
                </tr>

                <tr>
                <td class="time">6:00</td>
                </tr>

                <tr>
                <td class="time">6:30</td>
                <td rowspan="5"><br></td>
                <td rowspan="5" class="colorA">

<!== Tues 6:30pm ==>
<pre>$blockdata->{tues630}</pre><p>
<div align="right">
 <small><a href="MarlboroClassSchedule.cgi?edit=tues630">Edit</a></small>
</div>

                </td>
                <td rowspan="5" class="colorA">

<!== Wed 6:30pm ==>
<pre>$blockdata->{wed630}</pre><p>
<div align="right">
 <small><a href="MarlboroClassSchedule.cgi?edit=wed630">Edit</a></small>
</div>

                </td>
                <td rowspan="5" class="colorA">

<!== Thurs 6:30pm ==>
<pre>$blockdata->{thurs630}</pre><p>
<div align="right">
 <small><a href="MarlboroClassSchedule.cgi?edit=thurs630">Edit</a></small>
</div>
                </td>
                <td rowspan="5" class="colorA">

<!== Fri 6:30pm ==>
<pre>$blockdata->{fri630}</pre><p>
<div align="right">
 <small><a href="MarlboroClassSchedule.cgi?edit=fri630">Edit</a></small>
</div>
                </td>
                </tr>

                <tr><td class="time">7:00</td></tr>
                <tr><td class="time">7:30</td></tr>
                <tr><td class="time">8:00</td></tr>
                <tr><td class="time">8:30</td></tr>

</table>
</td></tr></table>

<p>
<div align='left'>
<b>Notes:</b><br>
<ul>
 <li>No afternoon classes permitted on Wednesdays 
     because of community meetings.
 <li>No evening classes permitted on Mondays due to the lecture series.
 <li>Evening classes must take into account theater conflicts.
 <li> 1 hour, 3 times per week classes meet MWF mornings.
 <li> 1.5 or 2 hours, twice per week classes meet TuThu mornings, MTh afternoons, or TuF afternoons.
 <li> 1.5 hour, 3 times per week classes meet MWF 11:30-12:50.
 <li> Classes must end at least 10 minutes before the start of the next 
      block, for example 8:30-9:20, or 11:30-12:50.
 <li><b>Exceptions</b> to time blocks must be approved by 
     appointed faculty representatives and the Registrar.
</ul>
</div>

<div align='right'>
 <small>
  $contact
  <br>
  Last modified $lastmodified
 </small>
</div>

</body>
</html>

END_SCHEDULE_HTML
}

1;

# -== Documentation ==============================================-

=head1 NAME

MarlboroClassSchedule - Perl cgi script for an editable 
weekly class schedule, using the time blocks typical at Marlboro College.

=head1 SYNOPSIS

  (1) Run install.pl to define the datafile name and copy
      the script to your cgi-bin directory.

      Or, to install it by hand, 
      put MarlboroClassSchedule.cgi in a cgi enabled web directory, and
      edit its global parameters at the start of the file, 
      particularly $datafilename.  Make sure the web server can 
      create and edit the data file.

  (2) (Optional)
      Run test.pl to see if everything is working.

  (3) To use it, point your browser at wherever you installed it
      (i.e. http://..../MarlboroClassSchedule.cgi)
      and click away.

=head1 DESCRIPTION

MarlboroClassSchedule.cgi is 
a web script which displays a class schedule, and 
let's you edit it by clicking on links with each time block.

A test suite, test.pl, may be used to exercise
the various subroutines with the script, as well as 
fetch and interact with the installed web script.

=head1 AUTHOR

Jim Mahoney <mahoney@marlboro.edu>, Marlboro College

=head1 COPYRIGHT

Copyright 2002, Jim Mahoney.

This program is free software; you can redistribute it
and/or modify it under the same terms as Perl itself.

See http://www.perl.com/perl/misc/Artistic.html

=cut