+--------------------------------------------------------------------+
| CiviCRM version 4.6 |
+--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014 |
+ | Copyright CiviCRM LLC (c) 2004-2015 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
*/
/**
- * File for the CiviCRM APIv3 domain functions
+ * This api exposes CiviCRM system functionality.
*
- * @package CiviCRM_APIv3
- * @subpackage API_Domain
- *
- * @copyright CiviCRM LLC (c) 2004-2014
- * @version $Id: Domain.php 30171 2010-10-14 09:11:27Z mover $
+ * Includes caching, logging, and checking system functionality.
*
+ * @package CiviCRM_APIv3
*/
/**
- * Flush all system caches
+ * Flush all system caches.
*
* @param array $params
* Input parameters.
- * - triggers: bool, whether to drop/create SQL triggers; default: FALSE
- * - session: bool, whether to reset the CiviCRM session data; defaul: FALSE
+ * - triggers: bool, whether to drop/create SQL triggers; default: FALSE
+ * - session: bool, whether to reset the CiviCRM session data; default: FALSE
*
* @return array
*/
}
/**
- * Adjust Metadata for Flush action
+ * Adjust Metadata for Flush action.
*
* The metadata is used for setting defaults, documentation & validation.
*
* @param array $params
- * Array or parameters determined by getfields.
+ * Array of parameters determined by getfields.
*/
function _civicrm_api3_system_flush_spec(&$params) {
- $params['triggers'] = array('title' => 'rebuild triggers (boolean)');
- $params['session'] = array('title' => 'refresh sessions (boolean)');
+ $params['triggers'] = array(
+ 'title' => 'Triggers',
+ 'description' => 'rebuild triggers (boolean)',
+ 'type' => CRM_Utils_Type::T_BOOLEAN,
+ );
+ $params['session'] = array(
+ 'title' => 'Sessions',
+ 'description' => 'refresh sessions (boolean)',
+ 'type' => CRM_Utils_Type::T_BOOLEAN,
+ );
}
/**
- * System.Check API specification (optional)
+ * System.Check API specification (optional).
+ *
* This is used for documentation and validation.
*
* @param array $spec
* Description of fields supported by this API call.
- * @return void
+ *
* @see http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
*/
function _civicrm_api3_system_check_spec(&$spec) {
}
/**
- * System.Check API
+ * System Check API.
*
* @param array $params
+ *
* @return array
* API result descriptor; return items are alert codes/messages
* @see civicrm_api3_create_success
}
/**
+ * Log entry to system log table.
+ *
* @param array $params
*
* @return array
*/
function civicrm_api3_system_log($params) {
$log = new CRM_Utils_SystemLogger();
- // this part means fields with separate db storage are accepted as params which kind of seems more intuitive to me
+ // This part means fields with separate db storage are accepted as params which kind of seems more intuitive to me
// 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?
if (!isset($params['context'])) {
$params['context'] = array();
}
/**
- * Metadata for log function
+ * Metadata for log function.
+ *
* @param array $params
*/
function _civicrm_api3_system_log_spec(&$params) {
}
/**
- * System.Get API
+ * System.Get API.
*
* @param array $params
+ *
* @return array
*/
function civicrm_api3_system_get($params) {
+ $config = CRM_Core_Config::singleton();
$returnValues = array(
array(
- 'version' => CRM_Utils_System::version(),
- 'uf' => CIVICRM_UF,
+ 'version' => CRM_Utils_System::version(), // deprecated in favor of civi.version
+ 'uf' => CIVICRM_UF, // deprecated in favor of cms.type
+ 'php' => array(
+ 'version' => phpversion(),
+ 'tz' => date_default_timezone_get(),
+ 'extensions' => get_loaded_extensions(),
+ 'ini' => _civicrm_api3_system_get_redacted_ini(),
+ ),
+ 'mysql' => array(
+ 'version' => CRM_Core_DAO::singleValueQuery('SELECT @@version'),
+ ),
+ 'cms' => array(
+ 'type' => CIVICRM_UF,
+ 'modules' => CRM_Core_Module::collectStatuses($config->userSystem->getModules()),
+ ),
+ 'civi' => array(
+ 'version' => CRM_Utils_System::version(),
+ 'dev' => (bool) CRM_Utils_System::isDevelopment(),
+ 'components' => array_keys(CRM_Core_Component::getEnabledComponents()),
+ 'extensions' => preg_grep(
+ '/^uninstalled$/',
+ CRM_Extension_System::singleton()->getManager()->getStatuses(),
+ PREG_GREP_INVERT
+ ),
+ 'exampleUrl' => CRM_Utils_System::url('civicrm/example', NULL, TRUE, NULL, FALSE),
+ ),
),
);
+
return civicrm_api3_create_success($returnValues, $params, 'System', 'get');
}
+
+/**
+ * Generate a sanitized/anonymized/redacted dump of the PHP configuration.
+ *
+ * Some INI fields contain site-identifying information (SII) -- e.g. URLs,
+ * hostnames, file paths, IP addresses, passwords, or free-form comments
+ * could be used to identify a site or gain access to its resources.
+ *
+ * A number of INI fields have been examined to determine whether they
+ * contain SII. Approved fields are put in a whitelist; all other fields
+ * are redacted.
+ *
+ * Redaction hides the substance of a field but does not completely omit
+ * all information. Consider the field 'mail.log' - setting this field
+ * has a functional effect (it enables or disables the logging behavior)
+ * and also points to particular file. Empty values (FALSE/NULL/0/"")
+ * will pass through redaction, but all other values will be replaced
+ * by a string (eg "REDACTED"). This roughly indicates whether the
+ * option is enabled/disabled without giving away its content.
+ *
+ * @return array
+ */
+function _civicrm_api3_system_get_redacted_ini() {
+ static $whitelist = NULL;
+ if ($whitelist === NULL) {
+ $whitelistFile = __DIR__ . '/System/ini-whitelist.txt';
+ $whitelist = array_filter(
+ explode("\n", file_get_contents($whitelistFile)),
+ function ($k) {
+ return !empty($k) && !preg_match('/^\s*#/', $k);
+ }
+ );
+ }
+
+ $inis = ini_get_all(NULL, FALSE);
+ $result = array();
+ foreach ($inis as $k => $v) {
+ if (empty($v) || in_array($k, $whitelist)) {
+ $result[$k] = $v;
+ }
+ else {
+ $result[$k] = 'REDACTED';
+ }
+ }
+
+ return $result;
+}