SlatePermutate Changeset - 896a269a2822 · protofusion repositories

Changeset - 896a269a2822

Parent rev.

Child rev.

[Not reviewed]

default

0 4 1

Nathan Brink (binki) - 15 years ago 2011-01-01 21:27:06
ohnobinki@ohnopublishing.net

Support purging saved schedules through the administration interfaces.

5 files changed with 247 insertions and 34 deletions:

admin.php

admin/saveschedule_purge.php

157

inc/admin.inc

inc/class.page.php

inc/config.inc.example

0 comments (0 inline, 0 general)

admin.php

➞

Show inline comments

@@ @@ -47,71 +47,67 @@ require_once('inc/admin.inc'); @@
+  }
   function isBeforeDate($toCheck, $reference) {
     $formatted = date("Y-m-d", $toCheck);
     $refUnix = strtotime($reference);
     if($toCheck < $refUnix) {
       return true;
+    }
     return false;
+  }
   function emptySavedDir($todate = null) {
     // Empty the saved_schedules directory
     $dir = "saved_schedules";
     if(!is_dir($dir)) {
       echo "<p><pre>{$dir}</pre> is not a valid directory! Please check your installation.";
       return;
+    }
     // Do this the new fun php5 OO-way
     foreach(new DirectoryIterator($dir) as $file) {
       if(is_numeric($file->getFilename())){
         $isBeforeDate = isBeforeDate($file->getCTime(), $todate);
         if(!$todate || $isBeforeDate) {
           // unlink($dir . '/' . $file->getFilename());
           $date = date("Y-m-d",$file->getCTime());
           echo "<p>Erased file: " . $dir . '/' . $file->getFilename() . " ({$date})</p>";
+        }
+      }
+    }
+  }
   function checkAction() {
     $result = '';
     if(isset($_GET['rehash'])) {
       // Run the rehash
       $crawl_schools = NULL;
       if (isset($_REQUEST['rehash_school']))
 	$crawl_schools = array($_REQUEST['rehash_school']);
       if (school_cache_recreate($crawl_schools))
 	$result = 'Rehash Failed';
       else
 	$result = 'Rehash Successful';
       if ($crawl_schools !== NULL)
 	$result .= ': ' . implode(', ', $crawl_schools);
+    }
     else if(isset($_GET['purgetodate'])) {
       // Purge saved schedule cache up to date
       emptySavedDir($_GET['purgetodate']);
       $result = 'Purged all saved schedules up to ' . $_GET['purgetodate'];
+    }
     else if(isset($_GET['purge'])) {
       // Purge the saved schedule cache
       emptySavedDir();
       $result = 'Purge Complete';
+    }
     else if(isset($_GET['purge']))
+      {
 	$purge_date = NULL;
 	if(isset($_GET['purgetodate']))
+	  {
 	    $t = strptime($_REQUEST['purgetodate'], '%Y-%m-%d');
 	    $purge_date = mktime($t['tm_hour'], $t['tm_min'], $t['tm_sec'], $t['tm_mon'], $t['tm_mday'], $t['tm_year'] + 1900);
+	  }
 	$schedule_store = schedule_store_init();
 	if (!$schedule_store)
 	  return 'Purging saved schedules failed: unable to initialize schedule_store handle.';
 	$num_purged = schedule_store_purge_range($schedule_store, 0, $purge_date);
 	if ($num_purged === FALSE)
+	  {
 	    $result = 'Purging saved scheduled failed.';
 	    if (!$admin_enable_purge)
 	      $result .= ' To enable purging saved schedules, since this is an irreversable operation, you must set $admin_enable_purge = TRUE in config.inc.';
+	  }
 	else
+	  {
 	    $result .= 'Purged ' . $num_purged . ' schedules';
 	    if ($purge_date !== NULL)
 	      $result .= ' up to ' . $purge_date;
+	  }
+      }
     return $result;
+  }
   function getLastRehash(){
     $stats = stat("cache/schools");
     if(!$stats){
       return false;
+    }
     return date("F j, Y, g:i a", $stats[9]);
+  }
   function schoolsDropList()
@@ @@ -165,17 +161,23 @@ require_once('inc/admin.inc'); @@
   <li>
     <form action="admin.php">Rehash schedules for <?php schoolsDropList(); ?>
       <input type="hidden" name="rehash" value="1" />
       <input type="submit" value="Go &raquo;" />
     </form>
   </li>
 </ul>
 <h3>Purge</h3>
     <p>The highest saved_schedule id is <a href="<?php $max_saved = getMaxSaved(); echo Schedule::url($max_saved); ?>"><?php echo $max_saved;?></a>.</p>
 <ul>
   <li><a href="admin.php?purge">Purge Entire Cache</a></li>
   <li><form action="admin.php">Purge cache up to <input type="text" name="purgetodate" size="8" id="datepicker"/> <input type="submit" value="Go &raquo;" /></form></li>
   <li>
     <form action="admin.php">Purge cache up to
       <input type="text" name="purgetodate" size="8" id="datepicker"/>
       <input type="submit" value="Go &raquo;" />
       <input type="hidden" name="purge" value="1" /> <!-- simplify our server-side code -->
     </form>
   </li>
 </ul>
 <?php
 $adminpage->foot();

admin/saveschedule_purge.php

➞

Show inline comments

@@ new file 100755 @@
 #!/usr/bin/env php
 <?php
 /*
  * Copyright 2010 Nathan Phillip Brink <ohnobinki@ohnopublishing.net>
+ *
  * This file is a part of slate_permutate.
+ *
  * slate_permutate is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as published by
  * the Free Software Foundation, either version 3 of the License, or
  * (at your option) any later version.
+ *
  * slate_permutate is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU Affero General Public License for more details.
+ *
  * You should have received a copy of the GNU Affero General Public License
  * along with slate_permutate.  If not, see <http://www.gnu.org/licenses/>.
  */
 /**
  * \file
+ *
  * Provides a way to easily purge a number of saved schedules through
  * a date range.
  */
 $inc_base = dirname(__FILE__) . DIRECTORY_SEPARATOR . '..' . DIRECTORY_SEPARATOR . 'inc' . DIRECTORY_SEPARATOR;
 require_once($inc_base . 'admin.inc');
 return main($argc, $argv);
 function main($argc, $argv)
+{
   global $admin_enable_purge;
   $n = test();
   if ($n)
+    {
       fprintf(STDERR, "%d tests failed; exiting\n",
 	      $n);
       return 1;
+    }
   $opts = getopt('hV:', array('all', 'max-time:', 'min-time:', 'help', 'verbosity:'));
   if (isset($opts['help']) || isset($opts['h']))
+    {
       usage($argv[0]);
       return 0;
+    }
   $all = FALSE;
   if (isset($opts['all']))
     $crawl = TRUE;
   foreach (array('min', 'max') as $time_var)
+    {
       if (isset($opts[$time_var . '-time']))
+	{
 	  ${$time_var . '_time'} = strtotime($opts[$time_var . '-time']);
 	  /* two ways of saying the thing failed -- was -1 until PHP 5.1.0 */
 	  if (${$time_var . '_time'} === FALSE || ${$time_var . '_time'} == -1)
+	    {
 	      fprintf(STDERR, "%s-time: Invalid date/time format, can't understand string: ``%s''.\n",
 		      $time_var, $opts['min-time']);
 	      return 1;
+	    }
+	}
+    }
   if ($all && (isset($min_time) || isset($max_time)))
+    {
       fprintf(STDERR, "error: Both --all and one of --max-time or --min-time were specified. These options are mutually exclusive.\n");
       return 1;
+    }
   if (!$all && (!isset($min_time) || !isset($max_time)))
+    {
       if (isset($min_time) || isset($max_time))
 	fprintf(STDERR, "error: If --min-time is set, --max-time must also be set and vice versa. This is to prevent accidents.\n");
       else
 	fprintf(STDERR, "error: Either --all or both of --min-time and --max-time must be passed to purge saved schedules.\n");
       return 1;
+    }
   $verbosity = 1;
   if (isset($opts['verbosity']))
     $verbosity = (int)$opts['verbosity'];
   if (isset($opts['V']))
     $verbosity = (int)$opts['V'];
   if ($verbosity < 0 || $verbosity > 10)
+    {
       fprintf(STDERR, "error: Invalid verbosity level: %d\n", $verbosity);
       fprintf(STDERR, "\n");
       usage();
       return 1;
+    }
   if ($all)
+    {
       fprintf(STDOUT, "Purging all schedules.\n");
+    }
   if (!isset($min_time))
     $min_time = 0;
   if (!isset($max_time))
     $max_time = NULL;
   else
     fprintf(STDOUT, "Purging from %s to %s.\n",
 	    strftime("%F %T", $min_time), strftime("%F %T", $max_time));
   $schedule_store = schedule_store_init();
   if (!$schedule_store)
+    {
       fprintf(STDERR, "error: Unable to initialize schedule_store.\n");
       return 1;
+    }
   $ret = schedule_store_purge_range($schedule_store, $min_time, $max_time);
   if ($ret === FALSE)
+    {
       fprintf(STDERR, "error: Unable to purge schedule_store%s.\n",
 	      $all ? '' : ' range');
       if (!$admin_enable_purge)
 	fprintf(STDERR, "error: You need to set " . '$admin_enable_purge' . " in config.inc to enable purging schedules through the administration utilities.\n");
       return 1;
+    }
   fprintf(STDOUT, "Schedules deleted: %s\n",
 	  $ret);
   fprintf(STDOUT, "Purge successful.\n");
   return 0;
+}
 /**
  * \brief
  *   Display CLI interface usage.
  */
 function usage($progname)
+{
   fprintf(STDERR, "Usage: %s [--all] [--min-time=<min time>] [--max-time=<max time>] [--help] [-h]\n"
 	  . "\n"
 	  . " -h, --help   Show this usage information and exit.\n"
 	  . "\n"
 	  . " --all        Purge all saved schedules.\n"
 	  . " --min-time   Takes a date/time string after which a schedule must\n"
 	  . "              have been created to be deleted.\n"
 	  . " --max-time   Takes a date/time string before which a schedule must\n"
 	  . "              be saved to be dleted.\n"
 	  . " -v, --verbosity Set the verbosity level. Valid range is from 0\n"
 	  . "              through 10.",
 	  $progname);
+}

inc/admin.inc

➞

Show inline comments

@@ @@ -309,24 +309,68 @@ function school_cache_recreate($crawl_on @@
       $schools[] = $school;
+    }
   if (school_cache($schools))
+    {
       fprintf(STDERR, "Error writing out school cache\n");
       return 1;
+    }
   return 0;
+}
 /**
  * \brief
  *   Purge a range of saved_schedules.
+ *
  * \param $schedule_store
  *   The schedule_store handle for which a range of saved schedules
  *   must be deleted.
  * \param $time_min
  *   The minimum unix timestamp for the range of schedules to be
  *   purged.
  * \param $time_max
  *   The maximum unix timestamp for the range of schedules to be
  *   purged or NULL for no limit.
  * \return
  *   FALSE on failure, an integer indicating the number of deleted
  *   saved_schedules on success.
  */
 function schedule_store_purge_range($schedule_store, $time_min = 0, $time_max = NULL)
+{
   global $admin_enable_purge;
   $schedule_id_max = schedule_store_getmaxid($schedule_store);
   $num_deleted = 0;
   if (!$admin_enable_purge)
     return FALSE;
   for ($schedule_id = 0; $schedule_id < $schedule_id_max; $schedule_id ++)
+    {
       $filename = $schedule_store['dir'] . DIRECTORY_SEPARATOR . $schedule_id;
       if (!file_exists($filename))
 	continue;
       $statbuf = stat($filename);
       if ($statbuf['ctime'] >= $time_min
 	  && ($time_max === NULL || $statbuf['ctime'] <= $time_max))
+	{
 	  unlink($filename);
 	  $num_deleted ++;
+	}
+    }
   return $num_deleted;
+}
 /**
  * \brief
  *   A small testsuite to help developers.
+ *
  * \return
  *   Number of failures.
  */
 function test()
+{
   $ideal = array('department' => 'CS',
 		 'course' => '262',

inc/class.page.php

➞

Show inline comments

@@ @@ -36,24 +36,25 @@ define('SP_PACKAGE_STRING', SP_PACKAGE_N @@
 set_include_path(get_include_path() . PATH_SEPARATOR . dirname(dirname(__FILE__)) . DIRECTORY_SEPARATOR . 'libs');
 /**
  * Not sure if there's a better place for this... it'd be a pita to
  * make a new include file like doconfig.inc but maybe that'll make
  * sense soon.
  */
 /* defaults */
 $clean_urls = FALSE;
 $ga_trackers = array();
 $feedback_emails = array('ez@ethanzonca.com, ngelderloos7@gmail.com, ohnobinki@ohnopublishing.net');
 $use_captcha = FALSE;
 $admin_enable_purge = FALSE;
 $config_inc = dirname(__FILE__) . DIRECTORY_SEPARATOR . 'config.inc';
 if (file_exists($config_inc)) {
   require_once($config_inc);
+}
 //**************************************************
 // class.page.php   Author: Ethan Zonca
 //

inc/config.inc.example

➞

Show inline comments

@@ @@ -69,17 +69,26 @@ @@
  */
 /* $use_captcha = FALSE; */
 /**
  * \brief
  *   Password to be used for administration page (admin.php)
+ *
  */
 /* $admin_pass = ''; */
 /**
  * \brief
- *    Setting this variable true enables the administration page
  *   Setting this variable true enables the administration page
+ *
  */
-/* $admin_enable = false; */
+/* $admin_enable = FALSE; */
 /**
  * \brief
  *   Enable purging saved schedules through the admin/rehash.php
  *   script or web interface.
+ *
  * Set to TRUE to enable this functionality. It is disabled by default
  * because it causes irreparable information loss.
  */
 /* $admin_enable_purge = FALSE; */

0 comments (0 inline, 0 general)