CRM/Core/BAO/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  * BAO object for crm_note table
  38  */
  39 class CRM_Core_BAO_Note extends CRM_Core_DAO_Note {
  40
  41   /**
  42    * Const the max number of notes we display at any given time
  43    * @var int
  44    */
  45   const MAX_NOTES = 3;
  46
  47   /**
  48    * Given a note id, retrieve the note text
  49    *
  50    * @param int $id
  51    *   Id of the note to retrieve.
  52    *
  53    * @return string   the note text or NULL if note not found
  54    *
  55    * @static
  56    */
  57   public static function getNoteText($id) {
  58     return CRM_Core_DAO::getFieldValue('CRM_Core_DAO_Note', $id, 'note');
  59   }
  60
  61   /**
  62    * Given a note id, retrieve the note subject
  63    *
  64    * @param int $id
  65    *   Id of the note to retrieve.
  66    *
  67    * @return string   the note subject or NULL if note not found
  68    *
  69    * @static
  70    */
  71   public static function getNoteSubject($id) {
  72     return CRM_Core_DAO::getFieldValue('CRM_Core_DAO_Note', $id, 'subject');
  73   }
  74
  75   /**
  76    * Given a note id, decide if the note should be displayed based on privacy setting
  77    *
  78    * @param object $note
  79    *   Either the id of the note to retrieve, or the CRM_Core_DAO_Note object itself.
  80    *
  81    * @return boolean TRUE if the note should be displayed, otherwise FALSE
  82    *
  83    * @static
  84    */
  85   public static function getNotePrivacyHidden($note) {
  86     if (CRM_Core_Permission::check('view all notes')) {
  87       return FALSE;
  88     }
  89
  90     $noteValues = array();
  91     if (is_object($note) && get_class($note) == 'CRM_Core_DAO_Note') {
  92       CRM_Core_DAO::storeValues($note, $noteValues);
  93     }
  94     else {
  95       $noteDAO = new CRM_Core_DAO_Note();
  96       $noteDAO->id = $note;
  97       $noteDAO->find();
  98       if ($noteDAO->fetch()) {
  99         CRM_Core_DAO::storeValues($noteDAO, $noteValues);
 100       }
 101     }
 102
 103     CRM_Utils_Hook::notePrivacy($noteValues);
 104
 105     if (!$noteValues['privacy']) {
 106       return FALSE;
 107     }
 108     elseif (isset($noteValues['notePrivacy_hidden'])) {
 109       // If the hook has set visibility, use that setting.
 110       return $noteValues['notePrivacy_hidden'];
 111     }
 112     else {
 113       // Default behavior (if hook has not set visibility)
 114       // is to hide privacy notes unless the note creator is the current user.
 115
 116       if ($noteValues['privacy']) {
 117         $session = CRM_Core_Session::singleton();
 118         $userID = $session->get('userID');
 119         return ($noteValues['contact_id'] != $userID);
 120       }
 121       else {
 122         return FALSE;
 123       }
 124     }
 125   }
 126
 127   /**
 128    * Takes an associative array and creates a note object
 129    *
 130    * the function extract all the params it needs to initialize the create a
 131    * note object. the params array could contain additional unused name/value
 132    * pairs
 133    *
 134    * @param array $params
 135    *   (reference) an assoc array of name/value pairs.
 136    * @param array $ids
 137    *   (deprecated) associated array with note id - preferably set $params['id'].
 138    *
 139    * @return object $note CRM_Core_BAO_Note object
 140    * @static
 141    */
 142   public static function &add(&$params, $ids = array()) {
 143     $dataExists = self::dataExists($params);
 144     if (!$dataExists) {
 145       return CRM_Core_DAO::$_nullObject;
 146     }
 147
 148     $note = new CRM_Core_BAO_Note();
 149
 150     if (!isset($params['modified_date'])) {
 151       $params['modified_date'] = date("Ymd");
 152     }
 153
 154     if (!isset($params['privacy'])) {
 155       $params['privacy'] = 0;
 156     }
 157
 158     $note->copyValues($params);
 159     if (empty($params['contact_id'])) {
 160       if ($params['entity_table'] == 'civicrm_contact') {
 161         $note->contact_id = $params['entity_id'];
 162       }
 163     }
 164     $id = CRM_Utils_Array::value('id', $params, CRM_Utils_Array::value('id', $ids));
 165     if ($id) {
 166       $note->id = $id;
 167     }
 168
 169     $note->save();
 170
 171     // check and attach and files as needed
 172     CRM_Core_BAO_File::processAttachment($params, 'civicrm_note', $note->id);
 173
 174     if ($note->entity_table == 'civicrm_contact') {
 175       CRM_Core_BAO_Log::register($note->entity_id,
 176         'civicrm_note',
 177         $note->id
 178       );
 179       $displayName = CRM_Contact_BAO_Contact::displayName($note->entity_id);
 180
 181       $noteActions = FALSE;
 182       $session = CRM_Core_Session::singleton();
 183       if ($session->get('userID')) {
 184         if ($session->get('userID') == $note->entity_id) {
 185           $noteActions = TRUE;
 186         }
 187         elseif (CRM_Contact_BAO_Contact_Permission::allow($note->entity_id, CRM_Core_Permission::EDIT)) {
 188           $noteActions = TRUE;
 189         }
 190       }
 191
 192       $recentOther = array();
 193       if ($noteActions) {
 194         $recentOther = array(
 195           'editUrl' => CRM_Utils_System::url('civicrm/contact/view/note',
 196             "reset=1&action=update&cid={$note->entity_id}&id={$note->id}&context=home"
 197           ),
 198           'deleteUrl' => CRM_Utils_System::url('civicrm/contact/view/note',
 199             "reset=1&action=delete&cid={$note->entity_id}&id={$note->id}&context=home"
 200           ),
 201         );
 202       }
 203
 204       // add the recently created Note
 205       CRM_Utils_Recent::add($displayName . ' - ' . $note->subject,
 206         CRM_Utils_System::url('civicrm/contact/view/note',
 207           "reset=1&action=view&cid={$note->entity_id}&id={$note->id}&context=home"
 208         ),
 209         $note->id,
 210         'Note',
 211         $note->entity_id,
 212         $displayName,
 213         $recentOther
 214       );
 215     }
 216
 217     return $note;
 218   }
 219
 220   /**
 221    * Check if there is data to create the object
 222    *
 223    * @param array $params
 224    *   (reference ) an assoc array of name/value pairs.
 225    *
 226    * @return boolean
 227    * @static
 228    */
 229   public static function dataExists(&$params) {
 230     // return if no data present
 231     if (!strlen($params['note'])) {
 232       return FALSE;
 233     }
 234     return TRUE;
 235   }
 236
 237   /**
 238    * Given the list of params in the params array, fetch the object
 239    * and store the values in the values array
 240    *
 241    * @param array $params
 242    *   Input parameters to find object.
 243    * @param array $values
 244    *   Output values of the object.
 245    * @param int $numNotes
 246    *   The maximum number of notes to return (0 if all).
 247    *
 248    * @return object $notes  Object of CRM_Core_BAO_Note
 249    * @static
 250    */
 251   public static function &getValues(&$params, &$values, $numNotes = self::MAX_NOTES) {
 252     if (empty($params)) {
 253       return NULL;
 254     }
 255     $note               = new CRM_Core_BAO_Note();
 256     $note->entity_id    = $params['contact_id'];
 257     $note->entity_table = 'civicrm_contact';
 258
 259     // get the total count of notes
 260     $values['noteTotalCount'] = $note->count();
 261
 262     // get only 3 recent notes
 263     $note->orderBy('modified_date desc');
 264     $note->limit($numNotes);
 265     $note->find();
 266
 267     $notes = array();
 268     $count = 0;
 269     while ($note->fetch()) {
 270       $values['note'][$note->id] = array();
 271       CRM_Core_DAO::storeValues($note, $values['note'][$note->id]);
 272       $notes[] = $note;
 273
 274       $count++;
 275       // if we have collected the number of notes, exit loop
 276       if ($numNotes > 0 && $count >= $numNotes) {
 277         break;
 278       }
 279     }
 280
 281     return $notes;
 282   }
 283
 284   /**
 285    * Delete the notes
 286    *
 287    * @param int $id
 288    *   Note id.
 289    * @param bool $showStatus
 290    *   Do we need to set status or not.
 291    *
 292    * @return mixed|NULL $return no of deleted notes on success, FALSE otherwise@access public
 293    * @static
 294    */
 295   public static function del($id, $showStatus = TRUE) {
 296     $return   = NULL;
 297     $recent   = array($id);
 298     $note     = new CRM_Core_DAO_Note();
 299     $note->id = $id;
 300     $note->find();
 301     $note->fetch();
 302     if ($note->entity_table == 'civicrm_note') {
 303       $status = ts('Selected Comment has been deleted successfully.');
 304     }
 305     else {
 306       $status = ts('Selected Note has been deleted successfully.');
 307     }
 308
 309     // Delete all descendents of this Note
 310     foreach (self::getDescendentIds($id) as $childId) {
 311       $childNote = new CRM_Core_DAO_Note();
 312       $childNote->id = $childId;
 313       $childNote->delete();
 314       $childNote->free();
 315       $recent[] = $childId;
 316     }
 317
 318     $return = $note->delete();
 319     $note->free();
 320     if ($showStatus) {
 321       CRM_Core_Session::setStatus($status, ts('Deleted'), 'success');
 322     }
 323
 324     // delete the recently created Note
 325     foreach ($recent as $recentId) {
 326       $noteRecent = array(
 327         'id' => $recentId,
 328         'type' => 'Note',
 329       );
 330       CRM_Utils_Recent::del($noteRecent);
 331     }
 332     return $return;
 333   }
 334
 335   /**
 336    * Delete all records for this contact id
 337    *
 338    * @param int $id
 339    *   ID of the contact for which note needs to be deleted.
 340    *
 341    * @return void
 342    *
 343    * @static
 344    */
 345   public static function deleteContact($id) {
 346     // need to delete for both entity_id
 347     $dao               = new CRM_Core_DAO_Note();
 348     $dao->entity_table = 'civicrm_contact';
 349     $dao->entity_id    = $id;
 350     $dao->delete();
 351
 352     // and the creator contact id
 353     $dao = new CRM_Core_DAO_Note();
 354     $dao->contact_id = $id;
 355     $dao->delete();
 356   }
 357
 358   /**
 359    * Retrieve all records for this entity-id
 360    *
 361    * @param int $id
 362    *   ID of the relationship for which records needs to be retrieved.
 363    *
 364    * @param string $entityTable
 365    *
 366    * @return array $viewNote array of note properties
 367    *
 368    * @static
 369    */
 370   public static function &getNote($id, $entityTable = 'civicrm_relationship') {
 371     $viewNote = array();
 372
 373     $query = "
 374   SELECT  id,
 375           note
 376     FROM  civicrm_note
 377    WHERE  entity_table=\"{$entityTable}\"
 378      AND  entity_id = %1
 379      AND  note is not null
 380 ORDER BY  modified_date desc";
 381     $params = array(1 => array($id, 'Integer'));
 382
 383     $dao = CRM_Core_DAO::executeQuery($query, $params);
 384
 385     while ($dao->fetch()) {
 386       $viewNote[$dao->id] = $dao->note;
 387     }
 388
 389     return $viewNote;
 390   }
 391
 392   /**
 393    * Get log record count for a Contact
 394    *
 395    * @param int $contactID
 396    *
 397    * @return int $count count of log records
 398    *
 399    * @static
 400    */
 401   public static function getContactNoteCount($contactID) {
 402     $note               = new CRM_Core_DAO_Note();
 403     $note->entity_id    = $contactID;
 404     $note->entity_table = 'civicrm_contact';
 405     $note->find();
 406     $count = 0;
 407     while ($note->fetch()) {
 408       if (!self::getNotePrivacyHidden($note)) {
 409         $count++;
 410       }
 411     }
 412     return $count;
 413   }
 414
 415   /**
 416    * Get all descendent notes of the note with given ID
 417    *
 418    * @param int $parentId
 419    *   ID of the note to start from.
 420    * @param int $maxDepth
 421    *   Maximum number of levels to descend into the tree; if not given, will include all descendents.
 422    * @param bool $snippet
 423    *   If TRUE, returned values will be pre-formatted for display in a table of notes.
 424    *
 425    * @return array Nested associative array beginning with direct children of given note.
 426    *
 427    * @static
 428    */
 429   public static function getNoteTree($parentId, $maxDepth = 0, $snippet = FALSE) {
 430     return self::buildNoteTree($parentId, $maxDepth, $snippet);
 431   }
 432
 433   /**
 434    * Get total count of direct children visible to the current user
 435    *
 436    * @param int $id
 437    *   Note ID.
 438    *
 439    * @return int $count Number of notes having the give note as parent
 440    *
 441    * @static
 442    */
 443   public static function getChildCount($id) {
 444     $note               = new CRM_Core_DAO_Note();
 445     $note->entity_table = 'civicrm_note';
 446     $note->entity_id    = $id;
 447     $note->find();
 448     $count = 0;
 449     while ($note->fetch()) {
 450       if (!self::getNotePrivacyHidden($note)) {
 451         $count++;
 452       }
 453     }
 454     return $count;
 455   }
 456
 457   /**
 458    * Recursive function to get all descendent notes of the note with given ID
 459    *
 460    * @param int $parentId
 461    *   ID of the note to start from.
 462    * @param int $maxDepth
 463    *   Maximum number of levels to descend into the tree; if not given, will include all descendents.
 464    * @param bool $snippet
 465    *   If TRUE, returned values will be pre-formatted for display in a table of notes.
 466    * @param array $tree
 467    *   (Reference) Variable to store all found descendents.
 468    * @param int $depth
 469    *   Depth of current iteration within the descendent tree (used for comparison against maxDepth).
 470    *
 471    * @return array Nested associative array beginning with direct children of given note.
 472    * @static
 473    */
 474   private static function buildNoteTree($parentId, $maxDepth = 0, $snippet = FALSE, &$tree = array(), $depth = 0) {
 475     if ($maxDepth && $depth > $maxDepth) {
 476       return FALSE;
 477     }
 478
 479     // get direct children of given parentId note
 480     $note               = new CRM_Core_DAO_Note();
 481     $note->entity_table = 'civicrm_note';
 482     $note->entity_id    = $parentId;
 483     $note->orderBy('modified_date asc');
 484     $note->find();
 485     while ($note->fetch()) {
 486       // foreach child, call this function, unless the child is private/hidden
 487       if (!self::getNotePrivacyHidden($note)) {
 488         CRM_Core_DAO::storeValues($note, $tree[$note->id]);
 489
 490         // get name of user that created this note
 491         $contact     = new CRM_Contact_DAO_Contact();
 492         $createdById = $note->contact_id;
 493         $contact->id = $createdById;
 494         $contact->find();
 495         $contact->fetch();
 496         $tree[$note->id]['createdBy'] = $contact->display_name;
 497         $tree[$note->id]['createdById'] = $createdById;
 498         $tree[$note->id]['modified_date'] = CRM_Utils_Date::customFormat($tree[$note->id]['modified_date']);
 499
 500         // paper icon view for attachments part
 501         $paperIconAttachmentInfo = CRM_Core_BAO_File::paperIconAttachment('civicrm_note', $note->id);
 502         $tree[$note->id]['attachment'] = $paperIconAttachmentInfo ? implode('', $paperIconAttachmentInfo) : '';
 503
 504         if ($snippet) {
 505           $tree[$note->id]['note'] = nl2br($tree[$note->id]['note']);
 506           $tree[$note->id]['note'] = smarty_modifier_mb_truncate(
 507             $tree[$note->id]['note'],
 508             80,
 509             '...',
 510             TRUE
 511           );
 512           CRM_Utils_Date::customFormat($tree[$note->id]['modified_date']);
 513         }
 514         self::buildNoteTree(
 515           $note->id,
 516           $maxDepth,
 517           $snippet,
 518           $tree[$note->id]['child'],
 519           $depth + 1
 520         );
 521       }
 522     }
 523
 524     return $tree;
 525   }
 526
 527   /**
 528    * Given a note id, get a list of the ids of all notes that are descendents of that note
 529    *
 530    * @param int $parentId
 531    *   Id of the given note.
 532    * @param array $ids
 533    *   (reference) one-dimensional array to store found descendent ids.
 534    *
 535    * @return array $ids One-dimensional array containing ids of all desendent notes
 536    */
 537   public static function getDescendentIds($parentId, &$ids = array()) {
 538     // get direct children of given parentId note
 539     $note               = new CRM_Core_DAO_Note();
 540     $note->entity_table = 'civicrm_note';
 541     $note->entity_id    = $parentId;
 542     $note->find();
 543     while ($note->fetch()) {
 544       // foreach child, add to ids list, and recurse
 545       $ids[] = $note->id;
 546       self::getDescendentIds($note->id, $ids);
 547     }
 548     return $ids;
 549   }
 550
 551   /**
 552    * Delete all note related to contact when contact is deleted
 553    *
 554    * @param int $contactID
 555    *   Contact id whose notes to be deleted.
 556    *
 557    * @return void
 558    * @static
 559    */
 560   public static function cleanContactNotes($contactID) {
 561     $params = array(1 => array($contactID, 'Integer'));
 562
 563     // delete all notes related to contribution
 564     $contributeQuery = "DELETE note.*
 565 FROM civicrm_note note LEFT JOIN civicrm_contribution contribute ON note.entity_id = contribute.id
 566 WHERE contribute.contact_id = %1 AND note.entity_table = 'civicrm_contribution'";
 567
 568     CRM_Core_DAO::executeQuery($contributeQuery, $params);
 569
 570     // delete all notes related to participant
 571     $participantQuery = "DELETE note.*
 572 FROM civicrm_note note LEFT JOIN civicrm_participant participant ON note.entity_id = participant.id
 573 WHERE participant.contact_id = %1 AND  note.entity_table = 'civicrm_participant'";
 574
 575     CRM_Core_DAO::executeQuery($participantQuery, $params);
 576
 577     // delete all contact notes
 578     $contactQuery = "SELECT id FROM civicrm_note WHERE entity_id = %1 AND entity_table = 'civicrm_contact'";
 579
 580     $contactNoteId = CRM_Core_DAO::executeQuery($contactQuery, $params);
 581     while ($contactNoteId->fetch()) {
 582       self::del($contactNoteId->id, FALSE);
 583     }
 584   }
 585 }