CRM/Contact/Page/View/Note.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  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           ts('more'),
 123           FALSE,
 124           'note.selector.row',
 125           'Note',
 126           $note->id
 127         );
 128         $contact = new CRM_Contact_DAO_Contact();
 129         $contact->id = $note->contact_id;
 130         $contact->find();
 131         $contact->fetch();
 132         $values[$note->id]['createdBy'] = $contact->display_name;
 133         $values[$note->id]['comment_count'] = CRM_Core_BAO_Note::getChildCount($note->id);
 134
 135         // paper icon view for attachments part
 136         $paperIconAttachmentInfo = CRM_Core_BAO_File::paperIconAttachment('civicrm_note', $note->id);
 137         $values[$note->id]['attachment'] = $paperIconAttachmentInfo;
 138       }
 139     }
 140
 141     $this->assign('notes', $values);
 142
 143     $commentLinks = self::commentLinks();
 144
 145     $action = array_sum(array_keys($commentLinks)) & $mask;
 146
 147     $commentAction = CRM_Core_Action::formLink($commentLinks,
 148       $action,
 149       array(
 150         'id' => $note->id,
 151         'pid' => $note->entity_id,
 152         'cid' => $note->entity_id,
 153       ),
 154       ts('more'),
 155       FALSE,
 156       'note.comment.action',
 157       'Note',
 158       $note->id
 159     );
 160     $this->assign('commentAction', $commentAction);
 161
 162     $this->ajaxResponse['tabCount'] = CRM_Contact_BAO_Contact::getCountComponent('note', $this->_contactId);
 163   }
 164
 165   /**
 166    * This function is called when action is update or new
 167    *
 168    * return null
 169    * @access public
 170    */
 171   function edit() {
 172     $controller = new CRM_Core_Controller_Simple('CRM_Note_Form_Note', ts('Contact Notes'), $this->_action);
 173     $controller->setEmbedded(TRUE);
 174
 175     // set the userContext stack
 176     $session = CRM_Core_Session::singleton();
 177     $url = CRM_Utils_System::url('civicrm/contact/view',
 178       'action=browse&selectedChild=note&cid=' . $this->_contactId
 179     );
 180     $session->pushUserContext($url);
 181
 182     if (CRM_Utils_Request::retrieve('confirmed', 'Boolean',
 183         CRM_Core_DAO::$_nullObject
 184       )) {
 185       CRM_Core_BAO_Note::del($this->_id);
 186       CRM_Utils_System::redirect($url);
 187     }
 188
 189     $controller->reset();
 190     $controller->set('entityTable', 'civicrm_contact');
 191     $controller->set('entityId', $this->_contactId);
 192     $controller->set('id', $this->_id);
 193
 194     $controller->process();
 195     $controller->run();
 196   }
 197
 198   function preProcess() {
 199     $this->_id = CRM_Utils_Request::retrieve('id', 'Positive', $this);
 200
 201     if ($this->_id && CRM_Core_BAO_Note::getNotePrivacyHidden($this->_id)) {
 202       CRM_Core_Error::statusBounce(ts('You do not have access to this note.'));
 203     }
 204
 205     $this->_contactId = CRM_Utils_Request::retrieve('cid', 'Positive', $this, TRUE);
 206     $this->assign('contactId', $this->_contactId);
 207
 208     // check logged in url permission
 209     CRM_Contact_Page_View::checkUserPermission($this);
 210
 211     $displayName = CRM_Contact_BAO_Contact::displayName($this->_contactId);
 212     CRM_Utils_System::setTitle(ts('Notes for') . ' ' . $displayName);
 213
 214     $this->_action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 'browse');
 215     $this->assign('action', $this->_action);
 216   }
 217
 218   /**
 219    * This function is the main function that is called when the page loads,
 220    * it decides the which action has to be taken for the page.
 221    *
 222    * return null
 223    * @access public
 224    */
 225   function run() {
 226     $this->preProcess();
 227
 228     if ($this->_action & CRM_Core_Action::VIEW) {
 229       $this->view();
 230     }
 231     elseif ($this->_action & (CRM_Core_Action::UPDATE | CRM_Core_Action::ADD)) {
 232       $this->edit();
 233     }
 234     elseif ($this->_action & CRM_Core_Action::DELETE) {
 235       // we use the edit screen the confirm the delete
 236       $this->edit();
 237     }
 238
 239     $this->browse();
 240     return parent::run();
 241   }
 242
 243   /**
 244    * Delete the note object from the db
 245    *
 246    * @return void
 247    * @access public
 248    */
 249   function delete() {
 250     CRM_Core_BAO_Note::del($this->_id);
 251   }
 252
 253   /**
 254    * Get action links
 255    *
 256    * @return array (reference) of action links
 257    * @static
 258    */
 259   static function &links() {
 260     if (!(self::$_links)) {
 261       $deleteExtra = ts('Are you sure you want to delete this note?');
 262
 263       self::$_links = array(
 264         CRM_Core_Action::VIEW => array(
 265           'name' => ts('View'),
 266           'url' => 'civicrm/contact/view/note',
 267           'qs' => 'action=view&reset=1&cid=%%cid%%&id=%%id%%&selectedChild=note',
 268           'title' => ts('View Note'),
 269         ),
 270         CRM_Core_Action::UPDATE => array(
 271           'name' => ts('Edit'),
 272           'url' => 'civicrm/contact/view/note',
 273           'qs' => 'action=update&reset=1&cid=%%cid%%&id=%%id%%&selectedChild=note',
 274           'title' => ts('Edit Note'),
 275         ),
 276         CRM_Core_Action::ADD => array(
 277           'name' => ts('Comment'),
 278           'url' => 'civicrm/contact/view/note',
 279           'qs' => 'action=add&reset=1&cid=%%cid%%&parentId=%%id%%&selectedChild=note',
 280           'title' => ts('Add Comment'),
 281         ),
 282         CRM_Core_Action::DELETE => array(
 283           'name' => ts('Delete'),
 284           'url' => 'civicrm/contact/view/note',
 285           'qs' => 'action=delete&reset=1&cid=%%cid%%&id=%%id%%&selectedChild=note',
 286           'title' => ts('Delete Note'),
 287         ),
 288       );
 289     }
 290     return self::$_links;
 291   }
 292
 293   /**
 294    * Get action links for comments
 295    *
 296    * @return array (reference) of action links
 297    * @static
 298    */
 299   static function &commentLinks() {
 300     if (!(self::$_commentLinks)) {
 301       self::$_commentLinks = array(
 302         CRM_Core_Action::VIEW => array(
 303           'name' => ts('View'),
 304           'url' => 'civicrm/contact/view/note',
 305           'qs' => 'action=view&reset=1&cid=%%cid%%&id={id}&selectedChild=note',
 306           'title' => ts('View Comment'),
 307         ),
 308         CRM_Core_Action::UPDATE => array(
 309           'name' => ts('Edit'),
 310           'url' => 'civicrm/contact/view/note',
 311           'qs' => 'action=update&reset=1&cid=%%cid%%&id={id}&parentId=%%pid%%&selectedChild=note',
 312           'title' => ts('Edit Comment'),
 313         ),
 314         CRM_Core_Action::DELETE => array(
 315           'name' => ts('Delete'),
 316           'url' => 'civicrm/contact/view/note',
 317           'qs' => 'action=delete&reset=1&cid=%%cid%%&id={id}&selectedChild=note',
 318           'title' => ts('Delete Comment'),
 319         ),
 320       );
 321     }
 322     return self::$_commentLinks;
 323   }
 324 }
 325