1: <?php
 2: /**
 3:  * Login tasks module that purges old events.
 4:  *
 5:  * Copyright 2008-2012 Horde LLC (http://www.horde.org/)
 6:  *
 7:  * See the enclosed file COPYING for license information (GPL). If you
 8:  * did not receive this file, see http://www.horde.org/licenses/gpl.
 9:  *
10:  * @author   Michael J. Rubinsky <mrubinsk@horde.org>
11:  * @category Horde
12:  * @package  Kronolith
13:  */
14: class Kronolith_LoginTasks_Task_PurgeEvents extends Horde_LoginTasks_Task
15: {
16:     /**
17:      * Constructor.
18:      */
19:     public function __construct()
20:     {
21:         $this->active = $GLOBALS['prefs']->getValue('purge_events');
22:         if ($this->active) {
23:             $this->interval = $GLOBALS['prefs']->getValue('purge_events_interval');
24:             if ($GLOBALS['prefs']->isLocked('purge_events')) {
25:                 $this->display = Horde_LoginTasks::DISPLAY_NONE;
26:             }
27:         }
28:     }
29: 
30:     /**
31:      * Purge old events.
32:      *
33:      * @throws Kronolith_Exception
34:      * @throws Horde_Exception_NotFound
35:      */
36:     public function execute()
37:     {
38:         /* Get the current time minus the number of days specified in
39:          * 'purge_events_keep'.  An event will be deleted if it has an end
40:          * time prior to this time. */
41:         $del_time = new Horde_Date($_SERVER['REQUEST_TIME']);
42:         $del_time->mday -= $GLOBALS['prefs']->getValue('purge_events_keep');
43: 
44:         /* Need to have Horde_Perms::DELETE on a calendar to delete events
45:          * from it */
46:         $calendars = Kronolith::listInternalCalendars(true, Horde_Perms::DELETE);
47: 
48:         /* Start building the search */
49:         $kronolith_driver = Kronolith::getDriver();
50:         $query = new StdClass();
51:         $query->start = null;
52:         $query->end = $del_time;
53:         $query->status = null;
54:         $query->calendars = array(Horde_String::ucfirst($GLOBALS['conf']['calendar']['driver']) => array_keys($calendars));
55:         $query->creator = $GLOBALS['registry']->getAuth();
56: 
57:         /* Perform the search */
58:         $days = Kronolith::search($query);
59:         $count = 0;
60:         foreach ($days as $events) {
61:             foreach ($events as $event) {
62:                 /* Delete if no recurrence, or if we are past the last occurence */
63:                 if (!$event->recurs() ||
64:                     $event->recurrence->nextRecurrence($del_time) == false) {
65: 
66:                     if ($event->calendar != $kronolith_driver->calendar) {
67:                         $kronolith_driver->open($event->calendar);
68:                     }
69:                     try {
70:                         $kronolith_driver->deleteEvent($event->id, true);
71:                         ++$count;
72:                     } catch (Exception $e) {
73:                         Horde::logMessage($e, 'ERR');
74:                         throw $e;
75:                     }
76:                 }
77:             }
78:         }
79: 
80:         $GLOBALS['notification']->push(sprintf(ngettext("Deleted %d event older than %d days.", "Deleted %d events older than %d days.", $count), $count, $GLOBALS['prefs']->getValue('purge_events_keep')));
81:     }
82: 
83:     /**
84:      * Return information for the login task.
85:      *
86:      * @return string  Description of what the operation is going to do during
87:      *                 this login.
88:      */
89:     public function describe()
90:     {
91:         return sprintf(_("All of your events older than %d days will be permanently deleted."),
92:                        $GLOBALS['prefs']->getValue('purge_events_keep'));
93:     }
94: 
95: }
96: