/usr/share/horde/whups/lib/Ticket.php is in php-horde-whups 3.0.0~beta1-1.
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 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 | <?php
/**
* The Whups_Ticket class encapsulates some logic relating to tickets, sending
* updates, etc.
*
* Copyright 2004-2013 Horde LLC (http://www.horde.org/)
*
* See the enclosed file LICENSE for license information (BSD). If you
* did not receive this file, see http://www.horde.org/licenses/bsdl.php.
*
* @author Chuck Hagenbuch <chuck@horde.org>
* @author Jan Schneider <jan@horde.org>
* @package Whups
*/
class Whups_Ticket
{
/**
* The id of the ticket this object wraps.
*
* @var integer
*/
protected $_id;
/**
* The current values of the ticket.
*
* @var array
*/
protected $_details;
/**
* Array of changes to make to the ticket.
*
* @var array
*/
protected $_changes = array();
/**
* Returns a ticket object for an id.
*
* @param integer $id The ticket id.
*
* @return Whups_Ticket Whups_Ticket object
*/
static public function makeTicket($id)
{
global $whups_driver;
$details = $whups_driver->getTicketDetails($id);
$ticket = new Whups_Ticket($id, $details);
return $ticket;
}
/**
* Creates a new ticket.
*
* Pretty bare wrapper around Whups_Driver::addTicket().
*
* @static
*
* @param array $info A hash with ticket information.
*
* @return Whups_Ticket Whups_Ticket object.
*/
static public function newTicket($info, $requester)
{
global $whups_driver;
if (!isset($info['type'])) {
$info['type'] = $whups_driver->getDefaultType($info['queue']);
if (!$info['type']) {
$queue = $whups_driver->getQueue($info['queue']);
throw new Whups_Exception(
sprintf(
_("No type for this ticket and no default type for queue \"%s\" specified."),
$queue['name']));
}
}
if (!isset($info['state'])) {
$info['state'] = $whups_driver->getDefaultState($info['type']);
if (!$info['state']) {
throw new Whups_Exception(
sprintf(
_("No state for this ticket and no default state for ticket type \"%s\" specified."),
$whups_driver->getTypeName($info['type'])));
}
}
if (!isset($info['priority'])) {
$info['priority'] = $whups_driver->getDefaultPriority($info['type']);
if (!$info['priority']) {
throw new Whups_Exception(
sprintf(
_("No priority for this ticket and no default priority for ticket type \"%s\" specified."),
$whups_driver->getTypeName($info['type'])));
}
}
$id = $whups_driver->addTicket($info, $requester);
$details = $whups_driver->getTicketDetails($id, false);
$ticket = new Whups_Ticket($id, $details);
// Add attachment if one was uploaded.
if (!empty($info['newattachment']['name'])) {
$ticket->change(
'attachment',
array(
'name' => $info['newattachment']['name'],
'tmp_name' => $info['newattachment']['tmp_name']));
}
// Check for a deferred attachment upload.
if (!empty($info['deferred_attachment']) &&
($a_name = $GLOBALS['session']->get('whups', 'deferred_attachment/' . $info['deferred_attachment']))) {
$ticket->change(
'attachment',
array(
'name' => $info['deferred_attachment'],
'tmp_name' => $a_name));
unlink($a_name);
}
// Check for manually added attachments.
if (!empty($info['attachments'])) {
$ticket->change('attachments', $info['attachments']);
}
// Commit any changes (new attachments, etc.)
$ticket->commit(
$ticket->get('user_id_requester'),
$info['last-transaction'],
false);
// Send email notifications.
$ticket->notify($ticket->get('user_id_requester'), true);
return $ticket;
}
/**
* Constructor.
*
* @param integer $id The ticket id.
* @param array $details The hash of ticket information.
*
* @return Whups_Ticket
*/
public function __construct($id, array $details)
{
$this->_id = $id;
$this->_details = $details;
}
/**
* Returns all ticket information.
*
* @return array The ticket information.
*/
public function getDetails()
{
return $this->_details;
}
/**
* Returns the ticket id.
*
* @return integer The ticket id.
*/
public function getId()
{
return $this->_id;
}
/**
* Returns a piece of information from this ticket.
*
* @param string $detail The detail to return.
*
* @return mixed The detail value.
*/
public function get($detail)
{
return isset($this->_details[$detail])
? $this->_details[$detail]
: null;
}
/**
* Changes a detail of the ticket to a new value.
*
* Never touches the backend; do not use for changes that you want to
* persist.
*
* @param string $detail The detail to change.
* @param string $value The new detail value.
*/
public function set($detail, $value)
{
$this->_details[$detail] = $value;
}
/**
* Tracks that a detail of the ticket should change, but does not actually
* make the change until commit() is called.
*
* @see commit()
*
* @param string $detail The detail to change.
* @param string $value The new detail value.
*/
public function change($detail, $value)
{
$previous_value = isset($this->_details[$detail])
? $this->_details[$detail]
: '';
if ($previous_value != $value) {
$this->_changes[$detail] = array(
'from' => $this->get($detail),
'from_name' => $this->get($detail . '_name'),
'to' => $value);
}
}
/**
* Goes through a list of built-up changes and commits them to the
* backend.
*
* This will send email updates by default, update the ticket log, etc.
*
* @see change()
*
* @param string $user The Horde user of the changes to be made.
* Defaults to the current user.
* @param integer $transaction The transaction these changes are part of.
* Defaults to a new transaction.
* @param boolean $notify Send ticket notifications?
*/
public function commit($user = null, $transaction = null, $notify = true)
{
global $whups_driver;
if (!count($this->_changes)) {
return;
}
if (is_null($user)) {
$user = $GLOBALS['registry']->getAuth();
}
$author_email = isset($this->_changes['comment-email']['to'])
? $this->_changes['comment-email']['to']
: null;
if (is_null($transaction)) {
// Get a new transaction id from the backend.
$transaction = $whups_driver->newTransaction($user, $author_email);
}
// If this is a guest update, the comment id is going to map to the
// requester pseudo-username.
if ($user === false) {
$user = '-' . $transaction . '_transaction';
}
// Run hook before setting the dates.
try {
$this->_changes = Horde::callHook('ticket_update', array($this, $this->_changes), 'whups');
} catch (Horde_Exception_HookNotSet $e) {
}
// Update cached dates.
$timestamp = time();
$this->_changes['date_updated'] = array('to' => $timestamp);
if (isset($this->_changes['state'])) {
$state = $whups_driver->getState($this->_changes['state']['to']);
if ($state['category'] == 'assigned') {
$this->_changes['date_assigned'] = array('to' => $timestamp);
$this->_changes['date_resolved'] = array('to' => null);
} elseif ($state['category'] == 'resolved') {
$this->_changes['date_resolved'] = array('to' => $timestamp);
} else {
$this->_changes['date_resolved'] = array('to' => null);
}
}
$updates = array();
foreach ($this->_changes as $detail => $values) {
$value = $values['to'];
switch ($detail) {
case 'owners':
// Fetch $oldOwners list; then loop through $value adding and
// deleting as needed.
$oldOwners = current($whups_driver->getOwners($this->_id));
$this->_changes['oldowners'] = $oldOwners;
foreach ($value as $owner) {
if (!$oldOwners ||
array_search($owner, $oldOwners) === false) {
$whups_driver->addTicketOwner($this->_id, $owner);
$whups_driver->updateLog(
$this->_id, $user,
array('assign' => $owner),
$transaction);
} else {
// Remove $owner from the old owners list; anyone left
// in $oldOwners will be removed.
unset($oldOwners[array_search($owner, $oldOwners)]);
}
}
// Delete removed owners and log the removals.
if (is_array($oldOwners)) {
foreach ($oldOwners as $owner) {
$whups_driver->deleteTicketOwner($this->_id, $owner);
$whups_driver->updateLog(
$this->_id, $user,
array('unassign' => $owner),
$transaction);
}
}
break;
case 'comment':
$commentId = $whups_driver->addComment(
$this->_id, $value, $user, $author_email);
// Store the comment id in the updates array for the log.
$updates['comment'] = $commentId;
if (!empty($this->_changes['comment-perms'])) {
$this->addCommentPerms(
$commentId,
$this->_changes['comment-perms']['to']);
}
break;
case 'comment-email':
case 'comment-perms':
// Skip these, handled in the comment case.
break;
case 'attachment':
$this->addAttachment($value['name'], $value['tmp_name']);
// Store the new file name in the updates array for the
// log.
$updates['attachment'][] = $value['name'];
break;
case 'attachments':
foreach ($value as $attachment) {
$this->addAttachment($attachment['name'], $attachment['tmp_name']);
// Store the new file name in the updates array for the
// log.
$updates['attachment'][] = $attachment['name'];
}
break;
case 'delete-attachment':
$this->deleteAttachment($value);
// Store the deleted file name in the updates array for
// the log.
$updates['delete-attachment'] = $value;
break;
case 'queue':
// Reset version if new queue is not versioned.
$newqueue = $whups_driver->getQueue($value);
if (empty($newqueue['queue_versioned'])) {
$updates['version'] = 0;
}
$updates['queue'] = $value;
default:
if (strpos($detail, 'attribute_') === 0 &&
!is_string($value)) {
$value = Horde_Serialize::Serialize($value,
Horde_Serialize::JSON);
}
$updates[$detail] = $value;
}
}
if (count($updates)) {
$whups_driver->updateTicket($this->_id, $updates);
$whups_driver->updateLog($this->_id, $user, $updates, $transaction);
}
// Reload $this->_details to make sure we have the latest information.
//
// @todo Only touch the db if we have to.
$details = $whups_driver->getTicketDetails($this->_id);
$this->_details = array_merge($this->_details, $details);
// Send notification emails to all ticket listeners.
if ($notify) {
$this->notify($user, false);
}
// Reset the changes array.
$this->_changes = array();
}
/**
* Deletes this ticket.
*
* @throws Whups_Exception
*/
public function delete()
{
global $whups_driver;
/* Build message template. */
$view = new Horde_View(array('templatePath' => WHUPS_BASE . '/config'));
$view->date = strftime($GLOBALS['prefs']->getValue('date_format'));
$view->auth_name = $GLOBALS['injector']
->getInstance('Horde_Core_Factory_Identity')
->create()
->getValue('fullname');
if (empty($view->auth_name)) {
$view->auth_name = $GLOBALS['registry']->getAuth('bare');
}
/* Get queue specific notification message text, if available. */
$message_file = WHUPS_BASE . '/config/delete_email.plain';
if (file_exists($message_file . '.' . $this->get('queue') . '.php')) {
$message_file .= '.' . $this->get('queue') . '.php';
} elseif (file_exists($message_file . '.local.php')) {
$message_file .= '.local.php';
} else {
$message_file .= '.php';
}
$message_file = basename($message_file);
if ($GLOBALS['conf']['mail']['incl_resp'] ||
!count(current($whups_driver->getOwners($this->_id)))) {
/* Include all responsible. */
$listeners = $whups_driver->getListeners(
$this->_id, true, false, true);
} else {
/* Don't include all responsible unless ticket is assigned. */
$listeners = $whups_driver->getListeners(
$this->_id, true, false, false);
}
$this->change('comment', _("The ticket was deleted."));
$this->commit(null, null, false);
$whups_driver->deleteTicket($this->_id);
$whups_driver->mail(array('ticket' => $this,
'recipients' => $listeners,
'subject' => _("Deleted:") . ' ' . $this->get('summary'),
'view' => $view,
'template' => $message_file,
'from' => $GLOBALS['registry']->getAuth()));
}
/**
* Adds an attachment to this ticket.
*
* @param string $attachment_name The name of the attachment.
* @param string $attachment_file The temporary file containing the data
* to be stored.
*
* @throws Whups_Exception
*/
public function addAttachment(&$attachment_name, $attachment_file)
{
if (!isset($GLOBALS['conf']['vfs']['type'])) {
throw new Whups_Exception(
_("The VFS backend needs to be configured to enable attachment uploads."),
'horde.error');
}
try {
$vfs = $GLOBALS['injector']
->getInstance('Horde_Core_Factory_Vfs')
->create();
} catch (Horde_Vfs_Exception $e) {
throw new Whups_Exception($e);
}
// Get existing attachment names.
$used_names = $this->listAllAttachments();
$dir = Whups::VFS_ATTACH_PATH . '/' . $this->_id;
while ((array_search($attachment_name, $used_names) !== false) ||
$vfs->exists($dir, $attachment_name)) {
if (preg_match('/(.*)\[(\d+)\](\.[^.]*)?$/', $attachment_name,
$match)) {
$attachment_name = $match[1] . '[' . ++$match[2] . ']';
if (isset($match[3])) {
$attachment_name .= $match[3];
}
} else {
$dot = strrpos($attachment_name, '.');
if ($dot === false) {
$attachment_name .= '[1]';
} else {
$attachment_name = substr($attachment_name, 0, $dot)
. '[1]' . substr($attachment_name, $dot);
}
}
}
try {
$vfs->write($dir, $attachment_name, $attachment_file, true);
} catch (Horde_Vfs_Exception $e) {
throw new Whups_Exception($e);
}
}
/**
* Removes an attachment from this ticket.
*
* @param string $attachment_name The name of the attachment.
*
* @throws Whups_Exception
*/
public function deleteAttachment($attachment_name)
{
if (!isset($GLOBALS['conf']['vfs']['type'])) {
throw new Whups_Exception(
_("The VFS backend needs to be configured to enable attachment uploads."),
'horde.error');
}
try {
$vfs = $GLOBALS['injector']
->getInstance('Horde_Core_Factory_Vfs')
->create();
} catch (Horde_Vfs_Exception $e) {
throw Whups_Exception($e);
}
$dir = Whups::VFS_ATTACH_PATH . '/' . $this->_id;
if (!$vfs->exists($dir, $attachment_name)) {
throw new Whups_Exception(
sprintf(_("Attachment %s not found."),
$attachment_name),
'horde.error');
}
try {
$vfs->deleteFile($dir, $attachment_name);
} catch (Horde_Vfs_Exception $e) {
throw new Whups_Exception($e);
}
}
/**
* Returns a list of all files that have been attached to this ticket,
* whether they still exist or not.
*
* @return array The list of file attachments
* @throws Whups_Exception
*/
public function listAllAttachments()
{
$files = array();
$history = $GLOBALS['whups_driver']->getHistory($this->_id);
foreach ($history as $row) {
if (isset($row['changes'])) {
foreach ($row['changes'] as $change) {
if (isset($change['type']) &&
$change['type'] == 'attachment') {
$files[] = $change['value'];
}
}
}
}
return array_unique($files);
}
/**
* Redirects the browser to this ticket's view.
*/
public function show()
{
Whups::urlFor('ticket', $this->_id, true)->redirect();
}
/**
* Returns <link> data for this ticket's feed.
*
* @return array Link data.
*/
public function feedLink()
{
return array(
'href' => Whups::urlFor('ticket_rss', $this->getId(), true, -1),
'title' => '[#' . $this->getId() . '] ' . $this->get('summary')
);
}
/**
* Sets exclusive read permissions on a comment to a certain group.
*
* @param integer $commentId The id of the comment to restrict.
* @param string $group The group name to limit access by.
*
* @return integer The permission id.
*/
static public function addCommentPerms($commentId, $group)
{
if (!empty($group)) {
$perms = $GLOBALS['injector']
->getInstance('Horde_Perms');
$perms_core = $GLOBALS['injector']
->getInstance('Horde_Core_Perms');
if (!$perms->exists('whups')) {
$perm = $perms_core->newPermission('whups');
$perm->addDefaultPermission(Horde_Perms::ALL, false);
$perms->addPermission($perm);
}
if (!$perms->exists('whups:comments')) {
$perms->addPermission($perms_core->newPermission('whups:comments'));
}
$perm = $perms_core->newPermission('whups:comments:' . $commentId);
$perm->addGroupPermission($group, Horde_Perms::READ, false);
return $perms->addPermission($perm);
}
}
/**
* Sets all properties of the ticket necessary to display the
* TicketDetailsForm.
*
* @param Horde_Variables $vars The form variables object to set info in.
*/
public function setDetails(Horde_Variables &$vars)
{
$vars->set('id', $this->getId());
foreach ($this->getDetails() as $varname => $value) {
$vars->set($varname, $value);
}
/* User formatting. */
$vars->set('user_id_requester',
Whups::formatUser($this->get('user_id_requester')));
$vars->set('user_id_owner', Whups::getOwners($this->_id));
/* Attachments. */
$attachments = array();
try {
$files = Whups::getAttachments($this->_id);
} catch (Whups_Exception $e) {
$GLOBALS['notification']->push($e->getMessage());
}
if ($files) {
foreach ($files as $file) {
$attachments[] = Whups::attachmentUrl(
$this->_id, $file, $this->_details['queue']);
}
$vars->set('attachments', implode("<br />\n", $attachments));
}
}
/**
* Notifies all appropriate people of the creation/update of this ticket.
*
* @param string $author Who created/changed the ticket?
* @param boolean $isNew Is this a new ticket or a change to an existing
* one?
* @param array $listeners The list of listener that should receive the
* notification, with user names as keys and user
* roles as values. If empty, the list will be
* created automatically.
*/
public function notify($author, $isNew, $listeners = array())
{
global $conf, $whups_driver;
/* Get the attributes for this ticket. */
$attributes = $whups_driver->getAttributesForType($this->get('type'));
$fields = array(
'queue' => _("Queue"),
'version' => _("Version"),
'type' => _("Type"),
'state' => _("State"),
'priority' => _("Priority"),
'due' => _("Due"),
);
$field_names = array_merge($fields, array(_("Created By"),
_("Updated By"),
_("Summary"),
_("Owners"),
_("New Attachment"),
_("Deleted Attachment")));
foreach ($attributes as $attribute) {
$field_names[] = $attribute['human_name'];
}
/* Find the longest translated field name. */
$length = 0;
foreach ($field_names as $field_name) {
$length = max($length, Horde_String::length($field_name));
}
$wrap_break = "\n" . str_repeat(' ', $length + 2) . '| ';
$wrap_width = 73 - $length;
/* Ticket URL. */
$url = sprintf(_("Ticket URL: %s"),
Whups::urlFor('ticket', $this->_id, true, -1));
/* Ticket properties. */
$table = "------------------------------------------------------------------------------\n"
. ' ' . Horde_String::pad(_("Ticket"), $length) . ' | '
. $this->_id . "\n" . ' '
. Horde_String::pad($isNew ? _("Created By") : _("Updated By"), $length)
. ' | ' . Whups::formatUser($author) . "\n";
if (isset($this->_changes['summary'])) {
$table .= '-' . Horde_String::pad(_("Summary"), $length) . ' | '
. Horde_String::wrap($this->_changes['summary']['from'],
$wrap_width, $wrap_break)
. "\n" . '+' . Horde_String::pad(_("Summary"), $length) . ' | '
. Horde_String::wrap($this->get('summary'), $wrap_width, $wrap_break)
. "\n";
} else {
$table .= ' ' . Horde_String::pad(_("Summary"), $length) . ' | '
. Horde_String::wrap($this->get('summary'), $wrap_width, $wrap_break)
. "\n";
}
foreach ($fields as $field => $label) {
if ($name = $this->get($field . '_name')) {
if (isset($this->_changes[$field])) {
$table .= '-' . Horde_String::pad($label, $length) . ' | '
. Horde_String::wrap($this->_changes[$field]['from_name'],
$wrap_width, $wrap_break)
. "\n" . '+' . Horde_String::pad($label, $length) . ' | '
. Horde_String::wrap($name, $wrap_width, $wrap_break) . "\n";
} else {
$table .= ' ' . Horde_String::pad($label, $length) . ' | '
. Horde_String::wrap($name, $wrap_width, $wrap_break) . "\n";
}
}
}
/* Attribute changes. */
foreach ($attributes as $id => $attribute) {
$attribute_id = 'attribute_' . $id;
$label = $attribute['human_name'];
if (isset($this->_changes[$attribute_id])) {
$table .= '-' . Horde_String::pad($label, $length) . ' | '
. Horde_String::wrap($this->_changes[$attribute_id]['from'],
$wrap_width, $wrap_break)
. "\n" . '+' . Horde_String::pad($label, $length) . ' | '
. Horde_String::wrap($this->_changes[$attribute_id]['to'],
$wrap_width, $wrap_break)
. "\n";
} else {
$table .= ' ' . Horde_String::pad($label, $length) . ' | '
. Horde_String::wrap($this->get($attribute_id),
$wrap_width, $wrap_break)
. "\n";
}
}
/* Show any change in ticket owners. */
$owners = $oldOwners = Horde_String::wrap(
Whups::getOwners($this->_id, false, true),
$wrap_width, $wrap_break);
if (isset($this->_changes['oldowners'])) {
$oldOwners = Horde_String::wrap(
Whups::getOwners($this->_id, false, true,
$this->_changes['oldowners']),
$wrap_width, $wrap_break);
}
if ($owners != $oldOwners) {
$table .= '-' . Horde_String::pad(_("Owners"), $length) . ' | '
. $oldOwners . "\n" . '+' . Horde_String::pad(_("Owners"), $length)
. ' | ' . $owners . "\n";
} else {
$table .= ' ' . Horde_String::pad(_("Owners"), $length) . ' | '
. $owners . "\n";
}
/* New Attachments. */
if (isset($this->_changes['attachment'])) {
$table .= '+' . Horde_String::pad(_("New Attachment"), $length) . ' | '
. $this->_changes['attachment']['to']['name'] . "\n";
}
if (!empty($this->_changes['attachments'])) {
foreach ($this->_changes['attachments']['to'] as $attachment) {
$table .= '+' . Horde_String::pad(_("New Attachment"), $length)
. ' | ' . $attachment['name'] . "\n";
}
}
/* Deleted Attachments. */
if (isset($this->_changes['delete-attachment'])) {
$table .= '+' . Horde_String::pad(_("Deleted Attachment"), $length)
. ' | ' . $this->_changes['delete-attachment']['to'] . "\n";
}
$table .= "------------------------------------------------------------------------------";
/* Add the "do not reply" tag if we don't monitor incoming mail. */
if (empty($conf['mail']['reply'])) {
$dont_reply = _("DO NOT REPLY TO THIS MESSAGE. THIS EMAIL ADDRESS IS NOT MONITORED.") . "\n\n";
} else {
$dont_reply = '';
}
/* Build message template. */
$view = new Horde_View(array('templatePath' => WHUPS_BASE . '/config'));
$view->ticket_url = $url;
$view->table = $table;
$view->dont_reply = empty($conf['mail']['reply']);
$view->date = strftime($GLOBALS['prefs']->getValue('date_format'));
$view->auth_name = $GLOBALS['injector']
->getInstance('Horde_Core_Factory_Identity')
->create()
->getValue('fullname');
if (empty($view->auth_name)) {
$view->auth_name = $GLOBALS['registry']->getAuth('bare');
}
/* Get queue specific notification message text, if available. */
$message_file = WHUPS_BASE . '/config/'
. ($isNew ? 'create_email.plain' : 'notify_email.plain');
if (file_exists($message_file . '.' . $this->get('queue') . '.php')) {
$message_file .= '.' . $this->get('queue') . '.php';
} elseif (file_exists($message_file . '.local.php')) {
$message_file .= '.local.php';
} else {
$message_file .= '.php';
}
$message_file = basename($message_file);
/* Include Re: if the ticket isn't new for easy
* filtering/eyeballing. */
$subject = $this->get('summary');
if (!$isNew) {
$subject = 'Re: ' . $subject;
}
if (empty($listeners)) {
if ($conf['mail']['incl_resp'] ||
!count(current($whups_driver->getOwners($this->_id)))) {
/* Include all responsible. */
$listeners = $whups_driver->getListeners(
$this->_id, true, true, true);
} else {
/* Don't include all responsible unless ticket is assigned. */
$listeners = $whups_driver->getListeners(
$this->_id, true, true, false);
}
/* Notify both old and new queue users if the queue has changed. */
if (isset($this->_changes['queue'])) {
foreach ($whups_driver->getQueueUsers($this->_changes['queue']['from_name']) as $user) {
$listeners[$user] = 'queue';
}
}
}
/* Pass off to Whups_Driver::mail() to do the actual comment fetching,
* permissions checks, etc. */
$whups_driver->mail(array('ticket' => $this,
'recipients' => $listeners,
'subject' => $subject,
'view' => $view,
'template' => $message_file,
'from' => $author,
'new' => $isNew));
}
/**
* Returns a plain text representation of a ticket.
*/
public function toString()
{
$fields = array('queue' => _("Queue"),
'version' => _("Version"),
'type' => _("Type"),
'state' => _("State"),
'priority' => _("Priority"),
'due' => _("Due"));
/* Find longest translated field name. */
$length = 0;
foreach (array_merge($fields, array(_("Summary"), _("Owners")))
as $field) {
$length = max($length, Horde_String::length($field));
}
$wrap_break = "\n" . str_repeat(' ', $length + 2) . '| ';
$wrap_width = 73 - $length;
/* Ticket properties. */
$message = ' ' . Horde_String::pad(_("Ticket"), $length) . ' | '
. $this->_id . "\n" . ' ' . Horde_String::pad(_("Summary"), $length)
. ' | ' . Horde_String::wrap($this->get('summary'),
$wrap_width, $wrap_break)
. "\n";
foreach ($fields as $field => $label) {
if ($name = $this->get($field . '_name')) {
$message .= ' ' . Horde_String::pad($label, $length) . ' | '
. Horde_String::wrap($name, $wrap_width, $wrap_break) . "\n";
}
}
$message .= ' ' . Horde_String::pad(_("Owners"), $length) . ' | '
. Horde_String::wrap(Whups::getOwners($this->_id, false, true),
$wrap_width, $wrap_break)
. "\n";
return $message;
}
public function __toString()
{
return $this->toString();
}
/**
* Adds ticket attribute values to the ticket's details, and returns the
* list of attributes.
*
* @return array List of ticket attribute hashes.
*/
public function addAttributes()
{
$attributes = $GLOBALS['whups_driver']
->getAllTicketAttributesWithNames($this->getId());
foreach ($attributes as $attribute_id => $attribute) {
$this->set('attribute_' . $attribute_id, $attribute['value']);
}
return $attributes;
}
}
|