3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
29 * This api exposes CiviCRM system functionality.
31 * Includes caching, logging, and checking system functionality.
33 * @package CiviCRM_APIv3
37 * Flush all system caches.
39 * @param array $params
41 * - triggers: bool, whether to drop/create SQL triggers; default: FALSE
42 * - session: bool, whether to reset the CiviCRM session data; default: FALSE
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)
51 return civicrm_api3_create_success();
55 * Adjust Metadata for Flush action.
57 * The metadata is used for setting defaults, documentation & validation.
59 * @param array $params
60 * Array of parameters determined by getfields.
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
,
68 $params['session'] = array(
69 'title' => 'Sessions',
70 'description' => 'refresh sessions (boolean)',
71 'type' => CRM_Utils_Type
::T_BOOLEAN
,
76 * System.Check API specification (optional).
78 * This is used for documentation and validation.
81 * Description of fields supported by this API call.
83 * @see http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
85 function _civicrm_api3_system_check_spec(&$spec) {
86 // $spec['magicword']['api.required'] = 1;
87 $spec['is_visible'] = array(
88 'title' => 'is visible',
89 'type' => CRM_Utils_Type
::T_BOOLEAN
,
96 * @param array $params
99 * API result descriptor; return items are alert codes/messages
100 * @see civicrm_api3_create_success
101 * @see civicrm_api3_create_error
102 * @throws API_Exception
104 function civicrm_api3_system_check($params) {
105 // array(array('name'=> $, 'severity'=>$, ...))
107 $returnValues = array();
109 // array(CRM_Utils_Check_Message)
110 $messages = CRM_Utils_Check
::singleton()->checkAll();
112 foreach ($messages as $msg) {
113 $returnValues[] = $msg->toArray() +
array('id' => $id++
);
116 return _civicrm_api3_basic_array_get('systemCheck', $params, $returnValues, "id", array('id', 'name', 'message', 'title', 'severity', 'is_visible'));
120 * Log entry to system log table.
122 * @param array $params
126 function civicrm_api3_system_log($params) {
127 $log = new CRM_Utils_SystemLogger();
128 // This part means fields with separate db storage are accepted as params which kind of seems more intuitive to me
129 // 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?
130 if (!isset($params['context'])) {
131 $params['context'] = array();
133 $specialFields = array('contact_id', 'hostname');
134 foreach ($specialFields as $specialField) {
135 if (isset($params[$specialField]) && !isset($params['context'])) {
136 $params['context'][$specialField] = $params[$specialField];
139 $returnValues = $log->log($params['level'], $params['message'], $params['context']);
140 return civicrm_api3_create_success($returnValues, $params, 'System', 'Log');
144 * Metadata for log function.
146 * @param array $params
148 function _civicrm_api3_system_log_spec(&$params) {
149 $params['level'] = array(
150 'title' => 'Log Level',
151 'description' => 'Log level as described in PSR3 (info, debug, warning etc)',
152 'type' => CRM_Utils_Type
::T_STRING
,
153 'api.required' => TRUE,
155 $params['message'] = array(
156 'title' => 'Log Message',
157 'description' => 'Standardised message string, you can also ',
158 'type' => CRM_Utils_Type
::T_STRING
,
159 'api.required' => TRUE,
161 $params['context'] = array(
162 'title' => 'Log Context',
163 'description' => 'An array of additional data to store.',
164 'type' => CRM_Utils_Type
::T_LONGTEXT
,
165 'api.default' => array(),
167 $params['contact_id'] = array(
168 'title' => 'Log Contact ID',
169 'description' => 'Optional ID of relevant contact',
170 'type' => CRM_Utils_Type
::T_INT
,
172 $params['hostname'] = array(
173 'title' => 'Log Hostname',
174 'description' => 'Optional name of host',
175 'type' => CRM_Utils_Type
::T_STRING
,
182 * @param array $params
186 function civicrm_api3_system_get($params) {
187 $config = CRM_Core_Config
::singleton();
188 $returnValues = array(
190 'version' => CRM_Utils_System
::version(), // deprecated in favor of civi.version
191 'uf' => CIVICRM_UF
, // deprecated in favor of cms.type
193 'version' => phpversion(),
194 'tz' => date_default_timezone_get(),
195 'extensions' => get_loaded_extensions(),
196 'ini' => _civicrm_api3_system_get_redacted_ini(),
199 'version' => CRM_Core_DAO
::singleValueQuery('SELECT @@version'),
202 'type' => CIVICRM_UF
,
203 'modules' => CRM_Core_Module
::collectStatuses($config->userSystem
->getModules()),
206 'version' => CRM_Utils_System
::version(),
207 'dev' => (bool) CRM_Utils_System
::isDevelopment(),
208 'components' => array_keys(CRM_Core_Component
::getEnabledComponents()),
209 'extensions' => preg_grep(
211 CRM_Extension_System
::singleton()->getManager()->getStatuses(),
214 'exampleUrl' => CRM_Utils_System
::url('civicrm/example', NULL, TRUE, NULL, FALSE),
219 return civicrm_api3_create_success($returnValues, $params, 'System', 'get');
223 * Generate a sanitized/anonymized/redacted dump of the PHP configuration.
225 * Some INI fields contain site-identifying information (SII) -- e.g. URLs,
226 * hostnames, file paths, IP addresses, passwords, or free-form comments
227 * could be used to identify a site or gain access to its resources.
229 * A number of INI fields have been examined to determine whether they
230 * contain SII. Approved fields are put in a whitelist; all other fields
233 * Redaction hides the substance of a field but does not completely omit
234 * all information. Consider the field 'mail.log' - setting this field
235 * has a functional effect (it enables or disables the logging behavior)
236 * and also points to particular file. Empty values (FALSE/NULL/0/"")
237 * will pass through redaction, but all other values will be replaced
238 * by a string (eg "REDACTED"). This roughly indicates whether the
239 * option is enabled/disabled without giving away its content.
243 function _civicrm_api3_system_get_redacted_ini() {
244 static $whitelist = NULL;
245 if ($whitelist === NULL) {
246 $whitelistFile = __DIR__
. '/System/ini-whitelist.txt';
247 $whitelist = array_filter(
248 explode("\n", file_get_contents($whitelistFile)),
250 return !empty($k) && !preg_match('/^\s*#/', $k);
255 $inis = ini_get_all(NULL, FALSE);
257 foreach ($inis as $k => $v) {
258 if (empty($v) ||
in_array($k, $whitelist)) {
262 $result[$k] = 'REDACTED';