3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
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__
, 'isImportantAlert')) {
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 foreach ($messages as $message) {
85 if ($filter === TRUE ||
call_user_func($filter, $message)) {
86 CRM_Core_Session
::setStatus($message->getMessage(), $message->getTitle());
94 * Determine if a message is important enough to harass the administrator about.
96 * @param CRM_Utils_Check_Message $message
99 protected static function isImportantAlert($message) {
100 return in_array($message->getLevel(), array(
101 \Psr\Log\LogLevel
::WARNING
,
102 \Psr\Log\LogLevel
::ALERT
,
103 \Psr\Log\LogLevel
::CRITICAL
,
104 \Psr\Log\LogLevel
::EMERGENCY
,
109 * Throw an exception if any of the checks fail.
111 * @param array|NULL $messages list of CRM_Utils_Check_Message; or NULL if the default list should be fetched
115 public function assertValid($messages = NULL) {
116 if ($messages === NULL) {
117 $messages = $this->checkAll();
119 if (!empty($messages)) {
120 $messagesAsArray = array();
121 foreach ($messages as $message) {
122 $messagesAsArray[] = $message->toArray();
124 throw new Exception('There are configuration problems with this installation: ' . print_r($messagesAsArray, TRUE));
129 * Run some sanity checks.
131 * This could become a hook so that CiviCRM can run both built-in
132 * configuration & sanity checks, and modules/extensions can add
135 * We might even expose the results of these checks on the Wordpress
136 * plugin status page or the Drupal admin/reports/status path.
140 * @link https://api.drupal.org/api/drupal/modules%21system%21system.api.php/function/hook_requirements
142 public function checkAll() {
144 $checks[] = new CRM_Utils_Check_Security();
145 $checks[] = new CRM_Utils_Check_Env();
147 $compInfo = CRM_Core_Component
::getEnabledComponents();
148 foreach ($compInfo as $compObj) {
149 switch ($compObj->info
['name']) {
151 $checks[] = new CRM_Utils_Check_Case(CRM_Case_XMLRepository
::singleton(), CRM_Case_PseudoConstant
::caseType('name'));
159 foreach ($checks as $check) {
160 $messages = array_merge($messages, $check->checkAll());
163 CRM_Utils_Hook
::check($messages);