CRM/Contact/Page/View/Note.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.4                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26 */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2013
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * Main page for viewing Notes.
  38  *
  39  */
  40 class CRM_Contact_Page_View_Note extends CRM_Core_Page {
  41
  42   /**
  43    * The action links for notes that we need to display for the browse screen
  44    *
  45    * @var array
  46    * @static
  47    */
  48   static $_links = NULL;
  49
  50   /**
  51    * The action links for comments that we need to display for the browse screen
  52    *
  53    * @var array
  54    * @static
  55    */
  56   static $_commentLinks = NULL;
  57
  58   /**
  59    * View details of a note
  60    *
  61    * @return void
  62    * @access public
  63    */
  64   function view() {
  65     $note = new CRM_Core_DAO_Note();
  66     $note->id = $this->_id;
  67     if ($note->find(TRUE)) {
  68       $values = array();
  69       CRM_Core_DAO::storeValues($note, $values);
  70       $values['privacy'] = CRM_Core_OptionGroup::optionLabel('note_privacy', $values['privacy']);
  71       $this->assign('note', $values);
  72     }
  73
  74     $comments = CRM_Core_BAO_Note::getNoteTree($values['id'], 1);
  75     if (!empty($comments)) {
  76       $this->assign('comments', $comments);
  77     }
  78
  79     // add attachments part
  80     $currentAttachmentInfo = CRM_Core_BAO_File::getEntityFile('civicrm_note', $this->_id);
  81     $this->assign('currentAttachmentInfo', $currentAttachmentInfo);
  82
  83   }
  84
  85   /**
  86    * This function is called when action is browse
  87    *
  88    * return null
  89    * @access public
  90    */
  91   function browse() {
  92     $note               = new CRM_Core_DAO_Note();
  93     $note->entity_table = 'civicrm_contact';
  94     $note->entity_id    = $this->_contactId;
  95
  96     $note->orderBy('modified_date desc');
  97
  98     //CRM-4418, handling edit and delete separately.
  99     $permissions = array($this->_permission);
 100     if ($this->_permission == CRM_Core_Permission::EDIT) {
 101       //previously delete was subset of edit
 102       //so for consistency lets grant delete also.
 103       $permissions[] = CRM_Core_Permission::DELETE;
 104     }
 105     $mask = CRM_Core_Action::mask($permissions);
 106
 107     $values = array();
 108     $links  = self::links();
 109     $action = array_sum(array_keys($links)) & $mask;
 110
 111     $note->find();
 112     while ($note->fetch()) {
 113       if (!CRM_Core_BAO_Note::getNotePrivacyHidden($note)) {
 114         CRM_Core_DAO::storeValues($note, $values[$note->id]);
 115
 116         $values[$note->id]['action'] = CRM_Core_Action::formLink($links,
 117           $action,
 118           array(
 119             'id' => $note->id,
 120             'cid' => $this->_contactId,
 121           )
 122         );
 123         $contact = new CRM_Contact_DAO_Contact();
 124         $contact->id = $note->contact_id;
 125         $contact->find();
 126         $contact->fetch();
 127         $values[$note->id]['createdBy'] = $contact->display_name;
 128         $values[$note->id]['comment_count'] = CRM_Core_BAO_Note::getChildCount($note->id);
 129       }
 130     }
 131
 132     $this->assign('notes', $values);
 133
 134     $commentLinks = self::commentLinks();
 135
 136     $action = array_sum(array_keys($commentLinks)) & $mask;
 137
 138     $commentAction = CRM_Core_Action::formLink($commentLinks,
 139       $action,
 140       array(
 141         'id' => $note->id,
 142         'pid' => $note->entity_id,
 143         'cid' => $note->entity_id,
 144       )
 145     );
 146     $this->assign('commentAction', $commentAction);
 147   }
 148
 149   /**
 150    * This function is called when action is update or new
 151    *
 152    * return null
 153    * @access public
 154    */
 155   function edit() {
 156     $controller = new CRM_Core_Controller_Simple('CRM_Note_Form_Note', ts('Contact Notes'), $this->_action);
 157     $controller->setEmbedded(TRUE);
 158
 159     // set the userContext stack
 160     $session = CRM_Core_Session::singleton();
 161     $url = CRM_Utils_System::url('civicrm/contact/view',
 162       'action=browse&selectedChild=note&cid=' . $this->_contactId
 163     );
 164     $session->pushUserContext($url);
 165
 166     if (CRM_Utils_Request::retrieve('confirmed', 'Boolean',
 167         CRM_Core_DAO::$_nullObject
 168       )) {
 169       CRM_Core_BAO_Note::del($this->_id);
 170       CRM_Utils_System::redirect($url);
 171     }
 172
 173     $controller->reset();
 174     $controller->set('entityTable', 'civicrm_contact');
 175     $controller->set('entityId', $this->_contactId);
 176     $controller->set('id', $this->_id);
 177
 178     $controller->process();
 179     $controller->run();
 180   }
 181
 182   function preProcess() {
 183     $this->_id = CRM_Utils_Request::retrieve('id', 'Positive', $this);
 184
 185     if ($this->_id && CRM_Core_BAO_Note::getNotePrivacyHidden($this->_id)) {
 186       CRM_Core_Error::statusBounce(ts('You do not have access to this note.'));
 187     }
 188
 189     $this->_contactId = CRM_Utils_Request::retrieve('cid', 'Positive', $this, TRUE);
 190     $this->assign('contactId', $this->_contactId);
 191
 192     // check logged in url permission
 193     CRM_Contact_Page_View::checkUserPermission($this);
 194
 195     // set page title
 196     CRM_Contact_Page_View::setTitle($this->_contactId);
 197
 198     $displayName = CRM_Contact_BAO_Contact::displayName($this->_contactId);
 199     CRM_Utils_System::setTitle(ts('Notes for') . ' ' . $displayName);
 200
 201     $this->_action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 'browse');
 202     $this->assign('action', $this->_action);
 203   }
 204
 205   /**
 206    * This function is the main function that is called when the page loads,
 207    * it decides the which action has to be taken for the page.
 208    *
 209    * return null
 210    * @access public
 211    */
 212   function run() {
 213     $this->preProcess();
 214
 215     if ($this->_action & CRM_Core_Action::VIEW) {
 216       $this->view();
 217     }
 218     elseif ($this->_action & (CRM_Core_Action::UPDATE | CRM_Core_Action::ADD)) {
 219       $this->edit();
 220     }
 221     elseif ($this->_action & CRM_Core_Action::DELETE) {
 222       // we use the edit screen the confirm the delete
 223       $this->edit();
 224     }
 225
 226     $this->browse();
 227     return parent::run();
 228   }
 229
 230   /**
 231    * delete the note object from the db
 232    *
 233    * @return void
 234    * @access public
 235    */
 236   function delete() {
 237     CRM_Core_BAO_Note::del($this->_id);
 238   }
 239
 240   /**
 241    * Get action links
 242    *
 243    * @return array (reference) of action links
 244    * @static
 245    */
 246   static function &links() {
 247     if (!(self::$_links)) {
 248       $deleteExtra = ts('Are you sure you want to delete this note?');
 249
 250       self::$_links = array(
 251         CRM_Core_Action::VIEW => array(
 252           'name' => ts('View'),
 253           'url' => 'civicrm/contact/view/note',
 254           'qs' => 'action=view&reset=1&cid=%%cid%%&id=%%id%%&selectedChild=note',
 255           'title' => ts('View Note'),
 256         ),
 257         CRM_Core_Action::UPDATE => array(
 258           'name' => ts('Edit'),
 259           'url' => 'civicrm/contact/view/note',
 260           'qs' => 'action=update&reset=1&cid=%%cid%%&id=%%id%%&selectedChild=note',
 261           'title' => ts('Edit Note'),
 262         ),
 263         CRM_Core_Action::ADD => array(
 264           'name' => ts('Comment'),
 265           'url' => 'civicrm/contact/view/note',
 266           'qs' => 'action=add&reset=1&cid=%%cid%%&parentId=%%id%%&selectedChild=note',
 267           'title' => ts('Add Comment'),
 268         ),
 269         CRM_Core_Action::DELETE => array(
 270           'name' => ts('Delete'),
 271           'url' => 'civicrm/contact/view/note',
 272           'qs' => 'action=delete&reset=1&cid=%%cid%%&id=%%id%%&selectedChild=note',
 273           'extra' => 'onclick = "if (confirm(\'' . $deleteExtra . '\') ) this.href+=\'&amp;confirmed=1\'; else return false;"',
 274           'title' => ts('Delete Note'),
 275         ),
 276       );
 277     }
 278     return self::$_links;
 279   }
 280
 281   /**
 282    * Get action links for comments
 283    *
 284    * @return array (reference) of action links
 285    * @static
 286    */
 287   static function &commentLinks() {
 288     if (!(self::$_commentLinks)) {
 289       $deleteExtra = ts('Are you sure you want to delete this comment?');
 290       self::$_commentLinks = array(
 291         CRM_Core_Action::VIEW => array(
 292           'name' => ts('View'),
 293           'url' => 'civicrm/contact/view/note',
 294           'qs' => 'action=view&reset=1&cid=%%cid%%&id={id}&selectedChild=note',
 295           'title' => ts('View Comment'),
 296         ),
 297         CRM_Core_Action::UPDATE => array(
 298           'name' => ts('Edit'),
 299           'url' => 'civicrm/contact/view/note',
 300           'qs' => 'action=update&reset=1&cid=%%cid%%&id={id}&parentId=%%pid%%&selectedChild=note',
 301           'title' => ts('Edit Comment'),
 302         ),
 303         CRM_Core_Action::DELETE => array(
 304           'name' => ts('Delete'),
 305           'url' => 'civicrm/contact/view/note',
 306           'qs' => 'action=delete&reset=1&cid=%%cid%%&id={id}&selectedChild=note',
 307           'extra' => 'onclick = "if (confirm(\'' . $deleteExtra . '\') ) this.href+=\'&amp;confirmed=1\'; else return false;"',
 308           'title' => ts('Delete Comment'),
 309         ),
 310       );
 311     }
 312     return self::$_commentLinks;
 313   }
 314 }
 315