api/v3/System.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  * This api exposes CiviCRM system functionality.
  30  *
  31  * Includes caching, logging, and checking system functionality.
  32  *
  33  * @package CiviCRM_APIv3
  34  */
  35
  36 /**
  37  * Flush all system caches.
  38  *
  39  * @param array $params
  40  *   Input parameters.
  41  *   - triggers: bool, whether to drop/create SQL triggers; default: FALSE
  42  *   - session:  bool, whether to reset the CiviCRM session data; default: FALSE
  43  *
  44  * @return array
  45  */
  46 function civicrm_api3_system_flush($params) {
  47   CRM_Core_Invoke::rebuildMenuAndCaches(
  48     CRM_Utils_Array::value('triggers', $params, FALSE),
  49     CRM_Utils_Array::value('session', $params, FALSE)
  50   );
  51   return civicrm_api3_create_success();
  52 }
  53
  54 /**
  55  * Adjust Metadata for Flush action.
  56  *
  57  * The metadata is used for setting defaults, documentation & validation.
  58  *
  59  * @param array $params
  60  *   Array of parameters determined by getfields.
  61  */
  62 function _civicrm_api3_system_flush_spec(&$params) {
  63   $params['triggers'] = array('title' => 'rebuild triggers (boolean)');
  64   $params['session'] = array('title' => 'refresh sessions (boolean)');
  65 }
  66
  67 /**
  68  * System.Check API specification (optional).
  69  *
  70  * This is used for documentation and validation.
  71  *
  72  * @param array $spec
  73  *   Description of fields supported by this API call.
  74  *
  75  * @see http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  76  */
  77 function _civicrm_api3_system_check_spec(&$spec) {
  78   // $spec['magicword']['api.required'] = 1;
  79 }
  80
  81 /**
  82  * System Check API.
  83  *
  84  * @param array $params
  85  *
  86  * @return array
  87  *   API result descriptor; return items are alert codes/messages
  88  * @see civicrm_api3_create_success
  89  * @see civicrm_api3_create_error
  90  * @throws API_Exception
  91  */
  92 function civicrm_api3_system_check($params) {
  93   $returnValues = array();
  94   foreach (CRM_Utils_Check::singleton()->checkAll() as $message) {
  95     $returnValues[] = $message->toArray();
  96   }
  97
  98   // Spec: civicrm_api3_create_success($values = 1, $params = array(), $entity = NULL, $action = NULL)
  99   return civicrm_api3_create_success($returnValues, $params, 'System', 'Check');
 100 }
 101
 102 /**
 103  * Log entry to system log table.
 104  *
 105  * @param array $params
 106  *
 107  * @return array
 108  */
 109 function civicrm_api3_system_log($params) {
 110   $log = new CRM_Utils_SystemLogger();
 111   // This part means fields with separate db storage are accepted as params which kind of seems more intuitive to me
 112   // because I felt like not doing this required a bunch of explanation in the spec function - but perhaps other won't see it as helpful?
 113   if (!isset($params['context'])) {
 114     $params['context'] = array();
 115   }
 116   $specialFields = array('contact_id', 'hostname');
 117   foreach ($specialFields as $specialField) {
 118     if (isset($params[$specialField]) && !isset($params['context'])) {
 119       $params['context'][$specialField] = $params[$specialField];
 120     }
 121   }
 122   $returnValues = $log->log($params['level'], $params['message'], $params['context']);
 123   return civicrm_api3_create_success($returnValues, $params, 'System', 'Log');
 124 }
 125
 126 /**
 127  * Metadata for log function.
 128  *
 129  * @param array $params
 130  */
 131 function _civicrm_api3_system_log_spec(&$params) {
 132   $params['level'] = array(
 133     'title' => 'Log Level',
 134     'description' => 'Log level as described in PSR3 (info, debug, warning etc)',
 135     'type' => CRM_Utils_Type::T_STRING,
 136     'api.required' => TRUE,
 137   );
 138   $params['message'] = array(
 139     'title' => 'Log Message',
 140     'description' => 'Standardised message string, you can also ',
 141     'type' => CRM_Utils_Type::T_STRING,
 142     'api.required' => TRUE,
 143   );
 144   $params['context'] = array(
 145     'title' => 'Log Context',
 146     'description' => 'An array of additional data to store.',
 147     'type' => CRM_Utils_Type::T_LONGTEXT,
 148     'api.default' => array(),
 149   );
 150   $params['contact_id'] = array(
 151     'title' => 'Log Contact ID',
 152     'description' => 'Optional ID of relevant contact',
 153     'type' => CRM_Utils_Type::T_INT,
 154   );
 155   $params['hostname'] = array(
 156     'title' => 'Log Hostname',
 157     'description' => 'Optional name of host',
 158     'type' => CRM_Utils_Type::T_STRING,
 159   );
 160 }
 161
 162 /**
 163  * System.Get API.
 164  *
 165  * @param array $params
 166  *
 167  * @return array
 168  */
 169 function civicrm_api3_system_get($params) {
 170   $returnValues = array(
 171     array(
 172       'version' => CRM_Utils_System::version(),
 173       'uf' => CIVICRM_UF,
 174     ),
 175   );
 176   return civicrm_api3_create_success($returnValues, $params, 'System', 'get');
 177 }