api/v3/System.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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(
  64     'title' => 'Triggers',
  65     'description' => 'rebuild triggers (boolean)',
  66     'type' => CRM_Utils_Type::T_BOOLEAN,
  67   );
  68   $params['session'] = array(
  69     'title' => 'Sessions',
  70     'description' => 'refresh sessions (boolean)',
  71     'type' => CRM_Utils_Type::T_BOOLEAN,
  72   );
  73 }
  74
  75 /**
  76  * System.Check API specification (optional).
  77  *
  78  * This is used for documentation and validation.
  79  *
  80  * @param array $spec
  81  *   Description of fields supported by this API call.
  82  *
  83  * @see http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  84  */
  85 function _civicrm_api3_system_check_spec(&$spec) {
  86   // $spec['magicword']['api.required'] = 1;
  87   $spec['show_hushed'] = array(
  88     'api.default' => FALSE,
  89     'title' => 'Show hushed',
  90     'type' => CRM_Utils_Type::T_BOOLEAN,
  91   );
  92 }
  93
  94 /**
  95  * System Check API.
  96  *
  97  * @param array $params
  98  *
  99  * @return array
 100  *   API result descriptor; return items are alert codes/messages
 101  * @see civicrm_api3_create_success
 102  * @see civicrm_api3_create_error
 103  * @throws API_Exception
 104  */
 105 function civicrm_api3_system_check($params) {
 106   $returnValues = array();
 107   $messages = CRM_Utils_Check::singleton()->checkAll(CRM_Utils_Array::value('show_hushed', $params));
 108   foreach ($messages as $msg) {
 109     $returnValues[] = $msg->toArray();
 110   }
 111
 112   // Spec: civicrm_api3_create_success($values = 1, $params = array(), $entity = NULL, $action = NULL)
 113   return civicrm_api3_create_success($returnValues, $params, 'System', 'Check');
 114 }
 115
 116 /**
 117  * Log entry to system log table.
 118  *
 119  * @param array $params
 120  *
 121  * @return array
 122  */
 123 function civicrm_api3_system_log($params) {
 124   $log = new CRM_Utils_SystemLogger();
 125   // This part means fields with separate db storage are accepted as params which kind of seems more intuitive to me
 126   // 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?
 127   if (!isset($params['context'])) {
 128     $params['context'] = array();
 129   }
 130   $specialFields = array('contact_id', 'hostname');
 131   foreach ($specialFields as $specialField) {
 132     if (isset($params[$specialField]) && !isset($params['context'])) {
 133       $params['context'][$specialField] = $params[$specialField];
 134     }
 135   }
 136   $returnValues = $log->log($params['level'], $params['message'], $params['context']);
 137   return civicrm_api3_create_success($returnValues, $params, 'System', 'Log');
 138 }
 139
 140 /**
 141  * Metadata for log function.
 142  *
 143  * @param array $params
 144  */
 145 function _civicrm_api3_system_log_spec(&$params) {
 146   $params['level'] = array(
 147     'title' => 'Log Level',
 148     'description' => 'Log level as described in PSR3 (info, debug, warning etc)',
 149     'type' => CRM_Utils_Type::T_STRING,
 150     'api.required' => TRUE,
 151   );
 152   $params['message'] = array(
 153     'title' => 'Log Message',
 154     'description' => 'Standardised message string, you can also ',
 155     'type' => CRM_Utils_Type::T_STRING,
 156     'api.required' => TRUE,
 157   );
 158   $params['context'] = array(
 159     'title' => 'Log Context',
 160     'description' => 'An array of additional data to store.',
 161     'type' => CRM_Utils_Type::T_LONGTEXT,
 162     'api.default' => array(),
 163   );
 164   $params['contact_id'] = array(
 165     'title' => 'Log Contact ID',
 166     'description' => 'Optional ID of relevant contact',
 167     'type' => CRM_Utils_Type::T_INT,
 168   );
 169   $params['hostname'] = array(
 170     'title' => 'Log Hostname',
 171     'description' => 'Optional name of host',
 172     'type' => CRM_Utils_Type::T_STRING,
 173   );
 174 }
 175
 176 /**
 177  * System.Get API.
 178  *
 179  * @param array $params
 180  *
 181  * @return array
 182  */
 183 function civicrm_api3_system_get($params) {
 184   $config = CRM_Core_Config::singleton();
 185   $returnValues = array(
 186     array(
 187       'version' => CRM_Utils_System::version(), // deprecated in favor of civi.version
 188       'uf' => CIVICRM_UF, // deprecated in favor of cms.type
 189       'php' => array(
 190         'version' => phpversion(),
 191         'tz' => date_default_timezone_get(),
 192         'extensions' => get_loaded_extensions(),
 193         'ini' => _civicrm_api3_system_get_redacted_ini(),
 194       ),
 195       'mysql' => array(
 196         'version' => CRM_Core_DAO::singleValueQuery('SELECT @@version'),
 197       ),
 198       'cms' => array(
 199         'type' => CIVICRM_UF,
 200         'modules' => CRM_Core_Module::collectStatuses($config->userSystem->getModules()),
 201       ),
 202       'civi' => array(
 203         'version' => CRM_Utils_System::version(),
 204         'dev' => (bool) CRM_Utils_System::isDevelopment(),
 205         'components' => array_keys(CRM_Core_Component::getEnabledComponents()),
 206         'extensions' => preg_grep(
 207           '/^uninstalled$/',
 208           CRM_Extension_System::singleton()->getManager()->getStatuses(),
 209           PREG_GREP_INVERT
 210         ),
 211         'exampleUrl' => CRM_Utils_System::url('civicrm/example', NULL, TRUE, NULL, FALSE),
 212       ),
 213     ),
 214   );
 215
 216   return civicrm_api3_create_success($returnValues, $params, 'System', 'get');
 217 }
 218
 219 /**
 220  * Generate a sanitized/anonymized/redacted dump of the PHP configuration.
 221  *
 222  * Some INI fields contain site-identifying information (SII) -- e.g. URLs,
 223  * hostnames, file paths, IP addresses, passwords, or free-form comments
 224  * could be used to identify a site or gain access to its resources.
 225  *
 226  * A number of INI fields have been examined to determine whether they
 227  * contain SII. Approved fields are put in a whitelist; all other fields
 228  * are redacted.
 229  *
 230  * Redaction hides the substance of a field but does not completely omit
 231  * all information. Consider the field 'mail.log' - setting this field
 232  * has a functional effect (it enables or disables the logging behavior)
 233  * and also points to particular file. Empty values (FALSE/NULL/0/"")
 234  * will pass through redaction, but all other values will be replaced
 235  * by a string (eg "REDACTED"). This roughly indicates whether the
 236  * option is enabled/disabled without giving away its content.
 237  *
 238  * @return array
 239  */
 240 function _civicrm_api3_system_get_redacted_ini() {
 241   static $whitelist = NULL;
 242   if ($whitelist === NULL) {
 243     $whitelistFile = __DIR__ . '/System/ini-whitelist.txt';
 244     $whitelist = array_filter(
 245       explode("\n", file_get_contents($whitelistFile)),
 246       function ($k) {
 247         return !empty($k) && !preg_match('/^\s*#/', $k);
 248       }
 249     );
 250   }
 251
 252   $inis = ini_get_all(NULL, FALSE);
 253   $result = array();
 254   foreach ($inis as $k => $v) {
 255     if (empty($v) || in_array($k, $whitelist)) {
 256       $result[$k] = $v;
 257     }
 258     else {
 259       $result[$k] = 'REDACTED';
 260     }
 261   }
 262
 263   return $result;
 264 }