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
35 class CRM_Utils_Check
{
37 // How often to run checks and notify admins about issues.
41 * We only need one instance of this object, so we use the
42 * singleton pattern and cache the instance in this variable
46 static private $_singleton = NULL;
49 * Provide static instance of CRM_Utils_Check.
51 * @return CRM_Utils_Check
53 public static function &singleton() {
54 if (!isset(self
::$_singleton)) {
55 self
::$_singleton = new CRM_Utils_Check();
57 return self
::$_singleton;
63 * @param array|NULL $messages
64 * List of CRM_Utils_Check_Message; or NULL if the default list should be fetched.
65 * @param array|string|callable $filter
66 * Restrict messages using a callback filter.
67 * By default, only show warnings and errors.
68 * Set TRUE to show all messages.
70 public function showPeriodicAlerts($messages = NULL, $filter = array(__CLASS__
, 'severityMap')) {
71 if (CRM_Core_Permission
::check('administer CiviCRM')
72 && CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
, 'securityAlert', NULL, TRUE)
74 $session = CRM_Core_Session
::singleton();
75 if ($session->timer('check_' . __CLASS__
, self
::CHECK_TIMER
)) {
77 // Best attempt at re-securing folders
78 $config = CRM_Core_Config
::singleton();
79 $config->cleanup(0, FALSE);
81 if ($messages === NULL) {
82 $messages = $this->checkAll();
84 $statusMessages = array();
85 $statusType = 'alert';
86 foreach ($messages as $message) {
87 if ($filter === TRUE ||
$message->getSeverity() >= 3) {
88 $statusType = $message->getSeverity() >= 4 ?
'error' : $statusType;
89 $statusMessage = $message->getMessage();
90 $statusMessages[] = $statusTitle = $message->getTitle();
94 if (count($statusMessages)) {
95 if (count($statusMessages) > 1) {
96 $statusTitle = ts('Multiple Alerts');
97 $statusMessage = '<ul><li>' . implode('</li><li>', $statusMessages) . '</li></ul>';
100 // TODO: add link to status page
101 CRM_Core_Session
::setStatus($statusMessage, $statusTitle, $statusType);
108 * Sort messages based upon severity
110 * @param CRM_Utils_Check_Message $a
111 * @param CRM_Utils_Check_Message $b
114 public function severitySort($a, $b) {
115 $aSeverity = $a->getSeverity();
116 $bSeverity = $b->getSeverity();
117 if ($aSeverity == $bSeverity) {
118 return strcmp($a->getName(), $b->getName());
120 // The Message constructor guarantees that these will always be integers.
121 return ($aSeverity < $bSeverity);
125 * Get the integer value (useful for thresholds) of the severity.
127 * @param int|const $severity
128 * the value to look up
129 * @param bool $reverse
130 * whether to find the constant from the integer
133 public static function severityMap($severity, $reverse = FALSE) {
134 // Lowercase string-based severities
136 $severity = strtolower($severity);
139 // See https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md
141 \Psr\Log\LogLevel
::EMERGENCY
=> 7,
142 \Psr\Log\LogLevel
::ALERT
=> 6,
143 \Psr\Log\LogLevel
::CRITICAL
=> 5,
144 \Psr\Log\LogLevel
::ERROR
=> 4,
145 \Psr\Log\LogLevel
::WARNING
=> 3,
146 \Psr\Log\LogLevel
::NOTICE
=> 2,
147 \Psr\Log\LogLevel
::INFO
=> 1,
148 \Psr\Log\LogLevel
::DEBUG
=> 0,
150 return ($reverse) ?
array_search($severity, $levels) : $levels[$severity];
154 * Throw an exception if any of the checks fail.
156 * @param array|NULL $messages list of CRM_Utils_Check_Message; or NULL if the default list should be fetched
160 public function assertValid($messages = NULL) {
161 if ($messages === NULL) {
162 $messages = $this->checkAll();
164 if (!empty($messages)) {
165 $messagesAsArray = array();
166 foreach ($messages as $message) {
167 $messagesAsArray[] = $message->toArray();
169 throw new Exception('There are configuration problems with this installation: ' . print_r($messagesAsArray, TRUE));
174 * Run some sanity checks.
176 * This could become a hook so that CiviCRM can run both built-in
177 * configuration & sanity checks, and modules/extensions can add
180 * We might even expose the results of these checks on the Wordpress
181 * plugin status page or the Drupal admin/reports/status path.
185 * @link https://api.drupal.org/api/drupal/modules%21system%21system.api.php/function/hook_requirements
187 public function checkAll($showHushed = 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);
211 foreach ($messages as $key => $message) {
212 $hush = self
::checkHushSnooze($message);
214 unset($messages[$key]);
218 uasort($messages, array(__CLASS__
, 'severitySort'));
224 * Evaluate if a system check should be hushed/snoozed.
227 * TRUE means hush/snooze, FALSE means display.
229 public function checkHushSnooze($message) {
230 $statusPreferenceParams = array(
231 'name' => $message->getName(),
232 'domain_id' => CRM_Core_Config
::domainID(),
234 // Check if there's a StatusPreference matching this name/domain.
235 $statusPreference = civicrm_api3('StatusPreference', 'get', $statusPreferenceParams);
237 if (isset($statusPreference['id'])) {
238 $spid = $statusPreference['id'];
241 // If so, compare severity to StatusPreference->severity.
242 $severity = $message->getSeverity();
243 if ($severity <= $statusPreference['values'][$spid]['ignore_severity']) {
244 // A hush or a snooze has been set. Find out which.
245 if (isset($statusPreference['values'][$spid]['hush_until'])) {
247 $today = new DateTime();
248 $snoozeDate = new DateTime($statusPreference['values'][$spid]['hush_until']);
249 if ($today > $snoozeDate) {
250 // Snooze is expired.