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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2015
33 class CRM_Utils_Check
{
34 // How often to run checks and notify admins about issues.
35 const CHECK_TIMER
= 86400;
38 * We only need one instance of this object, so we use the
39 * singleton pattern and cache the instance in this variable
43 static private $_singleton = NULL;
46 * Provide static instance of CRM_Utils_Check.
48 * @return CRM_Utils_Check
50 public static function &singleton() {
51 if (!isset(self
::$_singleton)) {
52 self
::$_singleton = new CRM_Utils_Check();
54 return self
::$_singleton;
60 * @param array|NULL $messages
61 * List of CRM_Utils_Check_Message; or NULL if the default list should be fetched.
62 * @param array|string|callable $filter
63 * Restrict messages using a callback filter.
64 * By default, only show warnings and errors.
65 * Set TRUE to show all messages.
67 public function showPeriodicAlerts($messages = NULL, $filter = array(__CLASS__
, 'severityMap')) {
68 if (CRM_Core_Permission
::check('administer CiviCRM')
69 && CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
, 'securityAlert', NULL, TRUE)
71 $session = CRM_Core_Session
::singleton();
72 if ($session->timer('check_' . __CLASS__
, self
::CHECK_TIMER
)) {
74 // Best attempt at re-securing folders
75 $config = CRM_Core_Config
::singleton();
76 $config->cleanup(0, FALSE);
78 if ($messages === NULL) {
79 $messages = $this->checkAll();
81 $statusMessages = array();
82 $statusType = 'alert';
83 foreach ($messages as $message) {
84 if ($filter === TRUE ||
$message->getSeverity() >= 3) {
85 $statusType = $message->getSeverity() >= 4 ?
'error' : $statusType;
86 $statusMessage = $message->getMessage();
87 $statusMessages[] = $statusTitle = $message->getTitle();
91 if (count($statusMessages)) {
92 if (count($statusMessages) > 1) {
93 $statusTitle = ts('Multiple Alerts');
94 $statusMessage = ts('Please check your <a href="%1">status page</a> for a full list and further details.', array(1 => CRM_Utils_System
::url('civicrm/a/#/status'))) . '<ul><li>' . implode('</li><li>', $statusMessages) . '</li></ul>';
97 // @todo add link to status page
98 CRM_Core_Session
::setStatus($statusMessage, $statusTitle, $statusType);
105 * Sort messages based upon severity
107 * @param CRM_Utils_Check_Message $a
108 * @param CRM_Utils_Check_Message $b
111 public static function severitySort($a, $b) {
112 $aSeverity = $a->getSeverity();
113 $bSeverity = $b->getSeverity();
114 if ($aSeverity == $bSeverity) {
115 return strcmp($a->getName(), $b->getName());
117 // The Message constructor guarantees that these will always be integers.
118 return ($aSeverity < $bSeverity);
122 * Get the integer value (useful for thresholds) of the severity.
124 * @param int|const $severity
125 * the value to look up
126 * @param bool $reverse
127 * whether to find the constant from the integer
130 public static function severityMap($severity, $reverse = FALSE) {
131 // Lowercase string-based severities
133 $severity = strtolower($severity);
136 // See https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md
138 \Psr\Log\LogLevel
::EMERGENCY
=> 7,
139 \Psr\Log\LogLevel
::ALERT
=> 6,
140 \Psr\Log\LogLevel
::CRITICAL
=> 5,
141 \Psr\Log\LogLevel
::ERROR
=> 4,
142 \Psr\Log\LogLevel
::WARNING
=> 3,
143 \Psr\Log\LogLevel
::NOTICE
=> 2,
144 \Psr\Log\LogLevel
::INFO
=> 1,
145 \Psr\Log\LogLevel
::DEBUG
=> 0,
147 return ($reverse) ?
array_search($severity, $levels) : $levels[$severity];
151 * Throw an exception if any of the checks fail.
153 * @param array|NULL $messages list of CRM_Utils_Check_Message; or NULL if the default list should be fetched
157 public function assertValid($messages = NULL) {
158 if ($messages === NULL) {
159 $messages = $this->checkAll();
161 if (!empty($messages)) {
162 $messagesAsArray = array();
163 foreach ($messages as $message) {
164 $messagesAsArray[] = $message->toArray();
166 throw new Exception('There are configuration problems with this installation: ' . print_r($messagesAsArray, TRUE));
171 * Run some sanity checks.
173 * This could become a hook so that CiviCRM can run both built-in
174 * configuration & sanity checks, and modules/extensions can add
177 * We might even expose the results of these checks on the Wordpress
178 * plugin status page or the Drupal admin/reports/status path.
181 * Whether to return just the maximum non-hushed severity
185 * @link https://api.drupal.org/api/drupal/modules%21system%21system.api.php/function/hook_requirements
187 public static function checkAll($max = FALSE) {
189 $checks[] = new CRM_Utils_Check_Security();
190 $checks[] = new CRM_Utils_Check_Env();
192 $compInfo = CRM_Core_Component
::getEnabledComponents();
193 foreach ($compInfo as $compObj) {
194 switch ($compObj->info
['name']) {
196 $checks[] = new CRM_Utils_Check_Case(CRM_Case_XMLRepository
::singleton(), CRM_Case_PseudoConstant
::caseType('name'));
204 foreach ($checks as $check) {
205 $messages = array_merge($messages, $check->checkAll());
208 CRM_Utils_Hook
::check($messages);
210 foreach ($messages as $key => $message) {
211 $hush = self
::checkHushSnooze($message);
212 $message->setVisible(!$hush);
214 uasort($messages, array(__CLASS__
, 'severitySort'));
217 foreach ($messages as $message) {
218 if (!$message->isVisible()) {
221 $maxSeverity = max(1, $message->getLevel());
225 Civi
::cache()->set('systemCheckSeverity', $maxSeverity);
227 Civi
::cache()->set('systemCheckDate', $timestamp);
229 return ($max) ?
$maxSeverity : $messages;
233 * Evaluate if a system check should be hushed/snoozed.
236 * TRUE means hush/snooze, FALSE means display.
238 public static function checkHushSnooze($message) {
239 $statusPreferenceParams = array(
240 'name' => $message->getName(),
241 'domain_id' => CRM_Core_Config
::domainID(),
243 // Check if there's a StatusPreference matching this name/domain.
244 $statusPreference = civicrm_api3('StatusPreference', 'get', $statusPreferenceParams);
246 if (isset($statusPreference['id'])) {
247 $spid = $statusPreference['id'];
250 // If so, compare severity to StatusPreference->severity.
251 $severity = $message->getSeverity();
252 if ($severity <= $statusPreference['values'][$spid]['ignore_severity']) {
253 // A hush or a snooze has been set. Find out which.
254 if (isset($statusPreference['values'][$spid]['hush_until'])) {
256 $today = new DateTime();
257 $snoozeDate = new DateTime($statusPreference['values'][$spid]['hush_until']);
258 if ($today > $snoozeDate) {
259 // Snooze is expired.