Added session database cleanup tools.

- Resolves VUFIND-948.

module/VuFind/src/VuFind/Db/Table/Session.php

@@ -138,4 +138,22 @@ class Session extends Gateway
         };
         $this->delete($callback);
     }
+
+    /**
+     * Get a query representing expired sessions (this can be passed
+     * to select() or delete() for further processing).
+     *
+     * @param int $daysOld Age in days of an "expired" session.
+     *
+     * @return function
+     */
+    public function getExpiredQuery($daysOld = 2)
+    {
+        // Determine the expiration date:
+        $expireDate = time() - $daysOld * 24 * 60 * 60;
+        $callback = function ($select) use ($expireDate) {
+            $select->where->lessThan('last_used', $expireDate);
+        };
+        return $callback;
+    }
 }
\ No newline at end of file

module/VuFindAdmin/src/VuFindAdmin/Controller/MaintenanceController.php

@@ -58,27 +58,68 @@ class MaintenanceController extends AbstractAdmin
      */
     public function deleteexpiredsearchesAction()
     {
-        $daysOld = intval($this->params()->fromQuery('daysOld', 2));
-        if ($daysOld < 2) {
+        // Delete the expired searches--this cleans up any junk left in the
+        // database from old search histories that were not caught by the
+        // session garbage collector.
+        return $this->expire(
+            'Search',
+            '%%count%% expired searches deleted.',
+            'No expired searches to delete.'
+        );
+    }
+
+    /**
+     * Delete expired sessions.
+     *
+     * @return mixed
+     */
+    public function deleteexpiredsessionsAction()
+    {
+        // Delete the expired sessions--this cleans up any junk left in the
+        // database by the session garbage collector.
+        return $this->expire(
+            'Session',
+            '%%count%% expired sessions deleted.',
+            'No expired sessions to delete.'
+        );
+    }
+
+    /**
+     * Abstract delete method.
+     *
+     * @param string $table         Table to operate on.
+     * @param string $successString String for reporting success.
+     * @param string $failString    String for reporting failure.
+     * @param int    $minAge        Minimum age allowed for expiration (also used
+     * as default value).
+     *
+     * @return mixed
+     */
+    protected function expire($table, $successString, $failString, $minAge = 2)
+    {
+        $daysOld = intval($this->params()->fromQuery('daysOld', $minAge));
+        if ($daysOld < $minAge) {
             $this->flashMessenger()->setNamespace('error')
                 ->addMessage(
-                    'Expiration age must be at least two days.'
+                    str_replace(
+                        '%%age%%', $minAge,
+                        'Expiration age must be at least %%age%% days.'
+                    )
                 );
         } else {
-            // Delete the expired searches--this cleans up any junk left in the
-            // database from old search histories that were not caught by the
-            // session garbage collector.
-            $search = $this->getTable('Search');
+            $search = $this->getTable($table);
+            if (!method_exists($search, 'getExpiredQuery')) {
+                throw new \Exception($table . ' does not support getExpiredQuery()');
+            }
             $query = $search->getExpiredQuery($daysOld);
             if (($count = count($search->select($query))) == 0) {
-                $msg = "No expired searches to delete.";
+                $msg = $failString;
             } else {
                 $search->delete($query);
-                $msg = "{$count} expired searches deleted.";
+                $msg = str_replace('%%count%%', $count, $successString);
             }
             $this->flashMessenger()->setNamespace('info')->addMessage($msg);
         }
         return $this->forwardTo('AdminMaintenance', 'Home');
     }
-}
-
+}
\ No newline at end of file

module/VuFindConsole/src/VuFindConsole/Controller/UtilController.php

@@ -366,30 +366,26 @@ class UtilController extends AbstractBase
      */
     public function expiresearchesAction()
     {
-        // Get command-line arguments
-        $argv = $this->consoleOpts->getRemainingArgs();
-
-        // Use command line value as expiration age, or default to 2.
-        $daysOld = isset($argv[0]) ? intval($argv[0]) : 2;
-
-        // Abort if we have an invalid expiration age.
-        if ($daysOld < 2) {
-            Console::writeLine("Expiration age must be at least two days.");
-            return $this->getFailureResponse();
-        }
+        return $this->expire(
+            'Search',
+            '%%count%% expired searches deleted.',
+            'No expired searches to delete.'
+        );
+    }
 
-        // Delete the expired searches--this cleans up any junk left in the database
-        // from old search histories that were not
-        // caught by the session garbage collector.
-        $search = $this->getTable('Search');
-        $query = $search->getExpiredQuery($daysOld);
-        if (($count = count($search->select($query))) == 0) {
-            Console::writeLine("No expired searches to delete.");
-            return $this->getSuccessResponse();
-        }
-        $search->delete($query);
-        Console::writeLine("{$count} expired searches deleted.");
-        return $this->getSuccessResponse();
+    /**
+     * Command-line tool to clear unwanted entries
+     * from session database table.
+     *
+     * @return \Zend\Console\Response
+     */
+    public function expiresessionsAction()
+    {
+        return $this->expire(
+            'Session',
+            '%%count%% expired sessions deleted.',
+            'No expired sessions to delete.'
+        );
     }
 
     /**
@@ -459,4 +455,51 @@ class UtilController extends AbstractBase
         }
         return $this->getSuccessResponse();
     }
+
+    /**
+     * Abstract delete method.
+     *
+     * @param string $table         Table to operate on.
+     * @param string $successString String for reporting success.
+     * @param string $failString    String for reporting failure.
+     * @param int    $minAge        Minimum age allowed for expiration (also used
+     * as default value).
+     *
+     * @return mixed
+     */
+    protected function expire($table, $successString, $failString, $minAge = 2)
+    {
+        // Get command-line arguments
+        $argv = $this->consoleOpts->getRemainingArgs();
+
+        // Use command line value as expiration age, or default to $minAge.
+        $daysOld = isset($argv[0]) ? intval($argv[0]) : $minAge;
+
+        // Abort if we have an invalid expiration age.
+        if ($daysOld < 2) {
+            Console::writeLine(
+                str_replace(
+                    '%%age%%', $minAge,
+                    'Expiration age must be at least %%age%% days.'
+                )
+            );
+            return $this->getFailureResponse();
+        }
+
+        // Delete the expired searches--this cleans up any junk left in the database
+        // from old search histories that were not
+        // caught by the session garbage collector.
+        $search = $this->getTable($table);
+        if (!method_exists($search, 'getExpiredQuery')) {
+            throw new \Exception($table . ' does not support getExpiredQuery()');
+        }
+        $query = $search->getExpiredQuery($daysOld);
+        if (($count = count($search->select($query))) == 0) {
+            Console::writeLine($failString);
+            return $this->getSuccessResponse();
+        }
+        $search->delete($query);
+        Console::writeLine(str_replace('%%count%%', $count, $successString));
+        return $this->getSuccessResponse();
+    }
 }

themes/blueprint/templates/admin/maintenance/home.phtml

@@ -16,6 +16,11 @@
     <input id="del_daysOld" type="text" name="daysOld" size="5" value="2"/> days.
     <input type="submit" name="submit" value="<?=$this->transEsc('Submit')?>"/>
   </form>
+  <form method="get" action="<?=$this->url('admin/maintenance', array('action' => 'DeleteExpiredSessions'))?>">
+    <label for="delsess_daysOld" style="font-weight: normal;">Delete user sessions older than</label>
+    <input id="delsess_daysOld" type="text" name="daysOld" size="5" value="2"/> days.
+    <input type="submit" name="submit" value="<?=$this->transEsc('Submit')?>"/>
+  </form>
 </div>
 
 <div class="clear"></div>

themes/bootstrap/templates/admin/maintenance/home.phtml

@@ -12,6 +12,11 @@
     <input id="del_daysOld" type="text" name="daysOld" size="5" value="2"/> days.
     <input type="submit" name="submit" value="<?=$this->transEsc('Submit')?>"/>
   </form>
+  <form method="get" action="<?=$this->url('admin/maintenance', array('action' => 'DeleteExpiredSessions'))?>">
+    <label for="delsess_daysOld" style="font-weight: normal;">Delete user sessions older than</label>
+    <input id="delsess_daysOld" type="text" name="daysOld" size="5" value="2"/> days.
+    <input type="submit" name="submit" value="<?=$this->transEsc('Submit')?>"/>
+  </form>
 </div>
 
 <div class="<?=$this->layoutClass('sidebar')?>">

util/expire_sessions.php

+<?php
+/**
+ * Command-line tool to clear unwanted entries from session database table.
+ *
+ * PHP version 5
+ *
+ * Copyright (C) Villanova University 2010.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2,
+ * as published by the Free Software Foundation.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ *
+ * @category VuFind2
+ * @package  Utilities
+ * @author   Demian Katz <demian.katz@villanova.edu>
+ * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
+ * @link     http://vufind.org/jira/browse/VUFIND-235 JIRA Ticket
+ */
+
+// Load the Zend framework -- this will automatically trigger the appropriate
+// controller action based on directory and file names
+define('CLI_DIR', __DIR__);     // save directory name of current script
+require_once __DIR__ . '/../public/index.php';