/usr/share/php/Horde/Alarm/Object.php is in php-horde-alarm 2.2.10-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 | <?php
/**
* Copyright 2010-2017 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (LGPL). If you
* did not receive this file, see http://www.horde.org/licenses/lgpl21.
*
* @author Jan Schneider <jan@horde.org>
* @category Horde
* @license http://www.horde.org/licenses/lgpl21 LGPL-2.1
* @package Alarm
*/
/**
* The Horde_Alarm_Object class is a Horde_Alarm storage implementation using
* an object instance.
*
* @author Jan Schneider <jan@horde.org>
* @category Horde
* @copyright 2010-2017 Horde LLC
* @license http://www.horde.org/licenses/lgpl21 LGPL-2.1
* @package Alarm
*/
class Horde_Alarm_Object extends Horde_Alarm
{
protected $_alarms = array();
/**
* Returns a certain alarm.
*
* @param string $id The alarm's unique id.
* @param string $user The alarm's user
* @param string $instanceid An optional instanceid to match.
*
*
* @return array An alarm hash.
*/
protected function &_findAlarm($id, $user, $instanceid = null)
{
foreach ($this->_alarms as &$alarm) {
if ($alarm['id'] == $id && $alarm['user'] === $user) {
if (empty($instanceid) || (!empty($instanceid) && $alarm['instanceid'] == $instanceid)) {
return $alarm;
}
}
}
$result = null;
return $result;
}
/**
* Sorts a number of alarms in chronological order.
*/
protected function _sortAlarms($a, $b)
{
$cmp = $a['start']->compareDateTime($b['start']);
if ($cmp) {
return $cmp;
}
if (empty($a['end'])) {
return -1;
}
if (empty($b['end'])) {
return 1;
}
return $a['end']->compareDateTime($b['end']);
}
/**
* Returns a list of alarms from the backend.
*
* @param Horde_Date $time The time when the alarms should be active.
* @param string $user Return alarms for this user, all users if
* null, or global alarms if empty.
*
* @return array A list of alarm hashes.
* @throws Horde_Alarm_Exception
*/
protected function _list($user, Horde_Date $time)
{
$alarms = array();
foreach ($this->_alarms as $alarm) {
if (empty($alarm['dismissed']) &&
((empty($alarm['snooze']) && $alarm['start']->compareDateTime($time) <= 0) ||
$alarm['snooze']->compareDateTime($time) <= 0) &&
(empty($alarm['end']) || $alarm['end']->compareDateTime($time) >= 0) &&
(is_null($user) || empty($alarm['uid']) || $alarm['uid'] = $user)) {
$alarms[] = $alarm;
}
}
usort($alarms, array($this, '_sortAlarms'));
return $alarms;
}
/**
* Returns a list of all global alarms from the backend.
*
* @return array A list of alarm hashes.
*/
protected function _global()
{
return array();
}
/**
* Returns an alarm hash from the backend.
*
* @param string $id The alarm's unique id.
* @param string $user The alarm's user.
*
* @return array An alarm hash.
* @throws Horde_Alarm_Exception
*/
protected function _get($id, $user)
{
$alarm = $this->_findAlarm($id, $user);
if (!$alarm) {
throw new Horde_Alarm_Exception('Alarm not found');
}
return $alarm;
}
/**
* Adds an alarm hash to the backend.
*
* @param array $alarm An alarm hash.
*/
protected function _add(array $alarm)
{
$alarm = array_merge(
array('user' => '',
'end' => null,
'text' => null,
'snooze' => null,
'internal' => null),
$alarm);
$this->_alarms[] = $alarm;
}
/**
* Updates an alarm hash in the backend.
*
* @param array $alarm An alarm hash.
* @param boolean $keepsnooze Whether to keep the snooze value unchanged.
*/
protected function _update(array $alarm, $keepsnooze = false)
{
$user = isset($alarm['user']) ? $alarm['user'] : null;
$al = &$this->_findAlarm($alarm['id'], $user);
foreach (array('start', 'end', 'methods', 'params', 'title', 'text') as $property) {
$al[$property] = isset($alarm[$property]) ? $alarm[$property] : null;
}
if (!$keepsnooze) {
$al['snooze'] = null;
}
}
/**
* Updates internal alarm properties, i.e. properties not determined by
* the application setting the alarm.
*
* @param string $id The alarm's unique id.
* @param string $user The alarm's user
* @param array $internal A hash with the internal data.
*
* @throws Horde_Alarm_Exception
*/
public function internal($id, $user, array $internal)
{
$alarm = &$this->_findAlarm($id, $user);
$alarm['internal'] = $internal;
}
/**
* Returns whether an alarm with the given id exists already.
*
* @param string $id The alarm's unique id.
* @param string $user The alarm's user
* @param string $instanceid An optional instanceid to match.
*
* @return boolean True if the specified alarm exists.
* @throws Horde_Alarm_Exception
*/
protected function _exists($id, $user, $instanceid = null)
{
return (bool)$this->_findAlarm($id, $user, $instanceid);
}
/**
* Delays (snoozes) an alarm for a certain period.
*
* @param string $id The alarm's unique id.
* @param string $user The alarm's user
* @param Horde_Date $snooze The snooze time.
*
* @throws Horde_Alarm_Exception
*/
protected function _snooze($id, $user, Horde_Date $snooze)
{
$alarm = &$this->_findAlarm($id, $user);
$alarm['snooze'] = $snooze;
}
/**
* Returns whether an alarm is snoozed.
*
* @param string $id The alarm's unique id.
* @param string $user The alarm's user
* @param Horde_Date $time The time when the alarm may be snoozed.
*
* @return boolean True if the alarm is snoozed.
* @throws Horde_Alarm_Exception
*/
protected function _isSnoozed($id, $user, Horde_Date $time)
{
$alarm = $this->_findAlarm($id, $user);
return !empty($alarm['dismissed']) ||
(isset($alarm['snooze']) &&
$alarm['snooze']->compareDateTime($time) >= 0);
}
/**
* Dismisses an alarm.
*
* @param string $id The alarm's unique id.
* @param string $user The alarm's user
*
* @throws Horde_Alarm_Exception
*/
protected function _dismiss($id, $user)
{
$alarm = &$this->_findAlarm($id, $user);
$alarm['dismissed'] = true;
}
/**
* Deletes an alarm from the backend.
*
* @param string $id The alarm's unique id.
* @param string $user The alarm's user. All users' alarms if null.
*
* @throws Horde_Alarm_Exception
*/
protected function _delete($id, $user = null)
{
$newAlarms = array();
foreach ($this->_alarms as &$alarm) {
if ($alarm['id'] != $id ||
(!is_null($user) && $alarm['user'] != $user)) {
$newAlarms[] = $alarm;
}
}
$this->_alarms = $newAlarms;
}
/**
* Garbage collects old alarms in the backend.
*
* @throws Horde_Alarm_Exception
*/
protected function _gc()
{
}
/**
* Attempts to initialize the backend.
*
* @throws Horde_Alarm_Exception
*/
public function initialize()
{
}
/**
* Converts a value from the driver's charset.
*
* @param mixed $value Value to convert.
*
* @return mixed Converted value.
*/
protected function _fromDriver($value)
{
return $value;
}
/**
* Converts a value to the driver's charset.
*
* @param mixed $value Value to convert.
*
* @return mixed Converted value.
*/
protected function _toDriver($value)
{
return $value;
}
}
|