Commit | Line | Data |
---|---|---|
1248c859 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
4 | | CiviCRM version 4.4 | | |
5 | +--------------------------------------------------------------------+ | |
6 | | Copyright CiviCRM LLC (c) 2004-2014 | | |
7 | +--------------------------------------------------------------------+ | |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
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. | | |
13 | | | | |
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. | | |
18 | | | | |
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 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | /** | |
29 | * | |
30 | * @package CRM | |
31 | * @copyright CiviCRM LLC (c) 2004-2014 | |
32 | * $Id: $ | |
33 | * | |
34 | */ | |
35 | class CRM_Utils_Check { | |
36 | CONST | |
37 | // How often to run checks and notify admins about issues. | |
38 | CHECK_TIMER = 86400; | |
39 | ||
40 | /** | |
41 | * We only need one instance of this object, so we use the | |
42 | * singleton pattern and cache the instance in this variable | |
43 | * | |
44 | * @var object | |
45 | * @static | |
46 | */ | |
47 | static private $_singleton = NULL; | |
48 | ||
49 | /** | |
50 | * Provide static instance of CRM_Utils_Check. | |
51 | * | |
52 | * @return CRM_Utils_Check | |
53 | */ | |
54 | static function &singleton() { | |
55 | if (!isset(self::$_singleton)) { | |
56 | self::$_singleton = new CRM_Utils_Check(); | |
57 | } | |
58 | return self::$_singleton; | |
59 | } | |
60 | ||
61 | /** | |
62 | * Execute "checkAll" | |
63 | */ | |
64 | public function showPeriodicAlerts() { | |
65 | if (CRM_Core_Permission::check('administer CiviCRM') | |
66 | && CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'securityAlert', NULL, TRUE) | |
67 | ) { | |
68 | $session = CRM_Core_Session::singleton(); | |
69 | if ($session->timer('check_' . __CLASS__, self::CHECK_TIMER)) { | |
70 | ||
71 | // Best attempt at re-securing folders | |
72 | $config = CRM_Core_Config::singleton(); | |
73 | $config->cleanup(0, FALSE); | |
74 | ||
75 | foreach ($this->checkAll() as $message) { | |
76 | CRM_Core_Session::setStatus($message->getMessage(), $message->getTitle()); | |
77 | } | |
78 | } | |
79 | } | |
80 | } | |
81 | ||
c0bc3902 TO |
82 | /** |
83 | * Throw an exception if any of the checks fail | |
84 | */ | |
85 | public function assertValid() { | |
86 | $messages = $this->checkAll(); | |
87 | if (!empty($messages)) { | |
88 | $messagesAsArray = array(); | |
89 | foreach ($messages as $message) { | |
90 | $messagesAsArray[] = $message->toArray(); | |
91 | } | |
92 | throw new Exception('There are configuration problems with this installation: ' . print_r($messagesAsArray, TRUE)); | |
93 | } | |
94 | } | |
95 | ||
1248c859 TO |
96 | /** |
97 | * Run some sanity checks. | |
98 | * | |
99 | * This could become a hook so that CiviCRM can run both built-in | |
100 | * configuration & sanity checks, and modules/extensions can add | |
101 | * their own checks. | |
102 | * | |
103 | * We might even expose the results of these checks on the Wordpress | |
104 | * plugin status page or the Drupal admin/reports/status path. | |
105 | * | |
106 | * @return array of messages | |
107 | * @see Drupal's hook_requirements() - | |
108 | * https://api.drupal.org/api/drupal/modules%21system%21system.api.php/function/hook_requirements | |
109 | */ | |
110 | public function checkAll() { | |
111 | $security = new CRM_Utils_Check_Security(); | |
1e927c45 | 112 | $env = new CRM_Utils_Check_Env(); |
1248c859 | 113 | $messages = array_merge( |
1e927c45 TO |
114 | $security->checkAll(), |
115 | $env->checkAll() | |
1248c859 TO |
116 | ); |
117 | return $messages; | |
118 | } | |
119 | ||
120 | } |