/usr/share/horde/nag/lib/Driver/Kolab.php is in php-horde-nag 4.2.1-4.
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 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 | <?php
/**
* Nag driver classes for the Kolab IMAP server.
*
* Copyright 2004-2014 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (GPL). If you
* did not receive this file, see http://www.horde.org/licenses/gpl.
*
* @author Gunnar Wrobel <wrobel@pardus.de>
* @author Thomas Jarosch <thomas.jarosch@intra2net.com>
* @author Stuart Binge <omicron@mighty.co.za>
* @package Nag
*/
class Nag_Driver_Kolab extends Nag_Driver
{
/**
* The Kolab_Storage backend.
*
* @var Horde_Kolab_Storage
*/
protected $_kolab;
/**
* The current tasklist.
*
* @var Horde_Kolab_Storage_Data
*/
protected $_data;
/**
* Constructs a new Kolab storage object.
*
* @param string $tasklist The tasklist to load.
* @param array $params A hash containing connection parameters.
*/
public function __construct($tasklist, $params = array())
{
$this->_tasklist = $tasklist;
$this->_kolab = $params['kolab'];
}
/**
* Return the Kolab data handler for the current tasklist.
*
* @return Horde_Kolab_Storage_Data The data handler.
*/
protected function _getData()
{
if (empty($this->_tasklist)) {
throw new Nag_Exception(
'The tasklist has been left undefined but is required!'
);
}
if ($this->_data === null) {
$this->_data = $this->_getDataForTasklist($this->_tasklist);
}
return $this->_data;
}
/**
* Return the Kolab data handler for the specified tasklist.
*
* @param string $tasklist The tasklist name.
*
* @return Horde_Kolab_Storage_Date The data handler.
*/
protected function _getDataForTasklist($tasklist)
{
return $this->_kolab->getData(
$GLOBALS['nag_shares']->getShare($tasklist)->get('folder'),
'task'
);
}
/**
* Retrieves one task from the backend.
*
* @param string $taskId The id of the task to retrieve.
*
* @return Nag_Task A Nag_Task object.
* @throws Horde_Exception_NotFound
* @throws Nag_Exception
*/
public function get($taskId)
{
$uid = Horde_Url::uriB64Decode($taskId);
if (!$this->_getData()->objectIdExists($uid)) {
throw new Horde_Exception_NotFound();
}
$task = $this->_getData()->getObject($uid)->getData();
$nag_task = $this->_buildTask($task);
$nag_task['tasklist_id'] = $this->_tasklist;
return new Nag_Task($this, $nag_task);
}
/**
* Build a task based a data array
*
* @param array $task The data for the task
*
* @return array The converted data array representing the task
*/
protected function _buildTask($task)
{
$result = array(
'task_id' => Horde_Url::uriB64Encode($task['uid']),
'uid' => $task['uid'],
'name' => $task['summary'],
'desc' => $task['body'],
'priority' => $task['priority'],
'parent' => $task['parent'],
'alarm' => $task['alarm'],
'completed' => !empty($task['completed']),
'completed_date' => $task['completed_date'],
'private' => $task['sensitivity'] != 'public',
'owner' => $GLOBALS['nag_shares']->getShare($this->_tasklist)->get('owner'),
);
if (isset($task['categories'])) {
$result['internaltags'] = $task['categories'];
}
if (!empty($task['start-date'])) {
$result['start'] = $task['start-date']->format('U');
}
if (!empty($task['due-date'])) {
$result['due'] = $task['due-date']->format('U');
}
if (!empty($task['creation-date'])) {
$result['created'] = new Horde_Date($task['creation-date']);
}
if (!empty($task['last-modification-date'])) {
$result['modified'] = new Horde_Date($task['last-modification-date']);
}
if (isset($task['recurrence']) && isset($task['due-date'])) {
$recurrence = new Horde_Date_Recurrence($task['due-date']);
$recurrence->fromKolab($task['recurrence']);
$result['recurrence'] = $recurrence;
}
if (isset($task['organizer'])) {
$result['assignee'] = $task['organizer']['smtp-address'];
}
if (isset($task['horde-estimate'])) {
$result['estimate'] = $task['horde-estimate'];
}
if (isset($task['horde-alarm-methods'])) {
$result['methods'] = @unserialize($task['horde-alarm-methods']);
}
return $result;
}
/**
* Retrieves one task from the database by UID.
*
* @param string $uid The UID of the task to retrieve.
*
* @return array The array of task attributes.
*/
public function getByUID($uid)
{
foreach (array_keys(Nag::listTasklists(false, Horde_Perms::READ, false)) as $tasklist) {
$this->_tasklist = $tasklist;
try {
return $this->get(Horde_Url::uriB64Encode($uid));
} catch (Horde_Exception_NotFound $e) {
}
}
throw new Horde_Exception_NotFound();
}
/**
* Adds a task to the backend storage.
*
* @param array $task A hash with the following possible properties:
* - name: (string) The name (short) of the task.
* - desc: (string) The description (long) of the task.
* - start: (OPTIONAL, integer) The start date of the task.
* - due: (OPTIONAL, integer) The due date of the task.
* - priority: (OPTIONAL, integer) The priority of the task.
* - estimate: (OPTIONAL, float) The estimated time to complete the
* task.
* - completed: (OPTIONAL, integer) The completion state of the task.
* - tags: (OPTIONAL, string) The tags of the task.
* - alarm: (OPTIONAL, integer) The alarm associated with the task.
* - methods: (OPTIONAL, array) The overridden alarm notification
* methods.
* - uid: (OPTIONAL, string) A Unique Identifier for the task.
* - parent: (OPTIONAL, string) The parent task.
* - private: (OPTIONAL, boolean) Whether the task is private.
* - owner: (OPTIONAL, string) The owner of the event.
* - assignee: (OPTIONAL, string) The assignee of the event.
* - recurrence: (OPTIONAL, Horde_Date_Recurrence|array) Recurrence
* information.
*
* @return string The Nag ID of the new task.
* @throws Nag_Exception
*/
protected function _add(array $task)
{
$object = $this->_getObject($task);
$object['uid'] = $this->_getData()->generateUid();
try {
$this->_getData()->create($object);
$this->_addTags($task);
} catch (Horde_Kolab_Storage_Exception $e) {
throw new Nag_Exception($e);
}
return Horde_Url::uriB64Encode($object['uid']);
}
/**
* Modifies an existing task.
*
* @param string $taskId The task to modify.
* @param array $properties A hash with the following possible properties:
* - id: (string) The task to modify.
* - name: (string) The name (short) of the task.
* - desc: (string) The description (long) of the task.
* - start: (OPTIONAL, integer) The start date of the task.
* - due: (OPTIONAL, integer) The due date of the task.
* - priority: (OPTIONAL, integer) The priority of the task.
* - estimate: (OPTIONAL, float) The estimated time to complete the
* task.
* - completed: (OPTIONAL, integer) The completion state of the task.
* - tags: (OPTIONAL, string) The tags of the task.
* - alarm: (OPTIONAL, integer) The alarm associated with the task.
* - methods: (OPTIONAL, array) The overridden alarm notification
* methods.
* - uid: (OPTIONAL, string) A Unique Identifier for the task.
* - parent: (OPTIONAL, string) The parent task.
* - private: (OPTIONAL, boolean) Whether the task is private.
* - owner: (OPTIONAL, string) The owner of the event.
* - assignee: (OPTIONAL, string) The assignee of the event.
* - completed_date: (OPTIONAL, integer) The task's completion date.
* - recurrence: (OPTIONAL, Horde_Date_Recurrence|array) Recurrence
* information.
*/
protected function _modify($taskId, array $task)
{
$object = $this->_getObject($task);
$object['uid'] = Horde_Url::uriB64Decode($taskId);
try {
$this->_getData()->modify($object);
$this->_updateTags($task);
} catch (Horde_Kolab_Storage_Exception $e) {
throw new Nag_Exception($e);
}
}
/**
* Retrieve the Kolab object representations for the task.
*
* @param array $task A hash with the following possible properties:
* - name: (string) The name (short) of the task.
* - desc: (string) The description (long) of the task.
* - start: (OPTIONAL, integer) The start date of the task.
* - due: (OPTIONAL, integer) The due date of the task.
* - priority: (OPTIONAL, integer) The priority of the task.
* - estimate: (OPTIONAL, float) The estimated time to complete the
* task.
* - completed: (OPTIONAL, integer) The completion state of the task.
* - tags: (OPTIONAL, string) The tags of the task.
* - alarm: (OPTIONAL, integer) The alarm associated with the task.
* - methods: (OPTIONAL, array) The overridden alarm notification
* methods.
* - uid: (OPTIONAL, string) A Unique Identifier for the task.
* - parent: (OPTIONAL, string) The parent task.
* - private: (OPTIONAL, boolean) Whether the task is private.
* - owner: (OPTIONAL, string) The owner of the event.
* - assignee: (OPTIONAL, string) The assignee of the event.
* - completed_date: (OPTIONAL, integer) The task's completion date.
* - recurrence: (OPTIONAL, Horde_Date_Recurrence|array) Recurrence
* information.
*
* @return array The Kolab object.
*/
protected function _getObject($task)
{
$object = array(
'summary' => $task['name'],
'body' => $task['desc'],
//@todo: Match Horde/Kolab priority values
'priority' => $task['priority'],
'parent' => $task['parent'],
);
if (!empty($task['start'])) {
$object['start-date'] = new DateTime('@' . $task['start']);
}
if (!empty($task['due'])) {
$object['due-date'] = new DateTime('@' . $task['due']);
}
if ($task['recurrence']) {
$object['recurrence'] = $task['recurrence']->toKolab();
}
if ($task['completed']) {
$object['completed'] = 100;
$object['status'] = 'completed';
} else {
$object['completed'] = 0;
$object['status'] = 'not-started';
}
if ($task['alarm'] !== 0) {
$object['alarm'] = (int)$task['alarm'];
}
if ($task['private']) {
$object['sensitivity'] = 'private';
} else {
$object['sensitivity'] = 'public';
}
if (isset($task['completed_date'])) {
$object['completed_date'] = $task['completed_date'];
}
if ($task['estimate'] !== 0.0) {
$object['horde-estimate'] = number_format((float)$task['estimate'], 2);
}
if ($task['methods'] !== null) {
$object['horde-alarm-methods'] = serialize($task['methods']);
}
if ($task['owner'] !== null) {
//@todo: Display name
$object['creator'] = array(
'smtp-address' => $task['owner'],
);
}
if ($task['assignee'] !== null) {
//@todo: Display name
$object['organizer'] = array(
'smtp-address' => $task['assignee'],
);
}
if ($task['tags'] && !is_array($task['tags'])) {
$object['categories'] = $GLOBALS['injector']->getInstance('Nag_Tagger')->split($task['tags']);
usort($object['categories'], 'strcoll');
}
return $object;
}
/**
* Moves a task to a different tasklist.
*
* @param string $taskId The task to move.
* @param string $newTasklist The new tasklist.
*/
protected function _move($taskId, $newTasklist)
{
$this->_getData()->move(
Horde_Url::uriB64Decode($taskId),
$GLOBALS['nag_shares']->getShare($newTasklist)->get('folder')
);
$this->_getDataForTasklist($newTasklist)->synchronize();
}
/**
* Deletes a task from the backend.
*
* @param string $taskId The task to delete.
*/
protected function _delete($taskId)
{
$this->_getData()->delete(Horde_Url::uriB64Decode($taskId));
}
/**
* Deletes all tasks from the backend.
*
* @return array An array of ids that have been deleted.
*/
protected function _deleteAll()
{
$this->retrieve();
$this->tasks->reset();
$ids = array();
while ($task = $this->tasks->each()) {
$ids[] = $task->id;
}
$this->_getData()->deleteAll();
return $ids;
}
/**
* Retrieves tasks from the Kolab server.
*
* @param integer $completed Which tasks to retrieve (1 = all tasks,
* 0 = incomplete tasks, 2 = complete tasks).
*/
public function retrieve($completed = Nag::VIEW_ALL)
{
$dict = array();
$this->tasks = new Nag_Task();
$task_list = $this->_getData()->getObjects();
if (empty($task_list)) {
return;
}
foreach ($task_list as $task) {
$tid = Horde_Url::uriB64Encode($task['uid']);
$nag_task = $this->_buildTask($task);
$nag_task['tasklist_id'] = $this->_tasklist;
$t = new Nag_Task($this, $nag_task);
$complete = $t->completed;
if (empty($t->start)) {
$start = null;
} else {
$start = $t->start;
}
if (($completed == Nag::VIEW_INCOMPLETE && ($complete || $start > $_SERVER['REQUEST_TIME'])) ||
($completed == Nag::VIEW_COMPLETE && !$complete) ||
($completed == Nag::VIEW_FUTURE &&
($complete || $start == 0 || $start < $_SERVER['REQUEST_TIME'])) ||
($completed == Nag::VIEW_FUTURE_INCOMPLETE && $complete)) {
continue;
}
if (empty($t->parent_id)) {
$this->tasks->add($t);
} else {
$dict[$tid] = $t;
}
}
/* Build a tree from the subtasks. */
foreach (array_keys($dict) as $key) {
$task = $this->tasks->get($dict[$key]->parent_id);
if ($task) {
$task->add($dict[$key]);
} elseif (isset($dict[$dict[$key]->parent_id])) {
$dict[$dict[$key]->parent_id]->add($dict[$key]);
} else {
$this->tasks->add($dict[$key]);
}
}
}
/**
* Lists all alarms near $date.
*
* @param integer $date The unix epoch time to check for alarms.
*
* @return array An array of Nag_Task objects that have alarms that match.
*/
public function listAlarms($date)
{
$task_list = $this->_getData()->getObjects();
if (empty($task_list)) {
return array();
}
$tasks = array();
foreach ($task_list as $task) {
$t = new Nag_Task($this, $this->_buildTask($task));
if ($t->alarm && $t->due &&
$t->due - $t->alarm * 60 < $date) {
$tasks[] = $t;
}
}
return $tasks;
}
/**
* Retrieves sub-tasks from the database.
*
* @param string $parentId The parent id for the sub-tasks to retrieve.
*
* @return array List of sub-tasks.
*/
public function getChildren($parentId)
{
$task_list = $this->_getData()->getObjects();
if (empty($task_list)) {
return array();
}
$tasks = array();
foreach ($task_list as $task) {
if (Horde_Url::uriB64Encode($task['parent']) != $parentId) {
continue;
}
$t = new Nag_Task($this, $this->_buildTask($task));
$children = $this->getChildren($t->id);
$t->mergeChildren($children);
$tasks[] = $t;
}
return $tasks;
}
}
|