3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2016 |
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-2016
33 class CRM_Utils_Check_Component_Env
extends CRM_Utils_Check_Component
{
38 public function checkPhpVersion() {
41 if (version_compare(phpversion(), CRM_Upgrade_Incremental_General
::MIN_RECOMMENDED_PHP_VER
) < 0) {
42 $messages[] = new CRM_Utils_Check_Message(
44 ts('This system uses PHP version %1. While this meets the minimum requirements for CiviCRM to function, upgrading to PHP version %2 or newer is recommended for maximum compatibility.',
47 2 => CRM_Upgrade_Incremental_General
::MIN_RECOMMENDED_PHP_VER
,
49 ts('PHP Out-of-Date'),
50 \Psr\Log\LogLevel
::NOTICE
,
55 $messages[] = new CRM_Utils_Check_Message(
57 ts('This system uses PHP version %1 which meets or exceeds the minimum recommendation of %2.',
60 2 => CRM_Upgrade_Incremental_General
::MIN_RECOMMENDED_PHP_VER
,
63 \Psr\Log\LogLevel
::INFO
,
72 * Check that the MySQL time settings match the PHP time settings.
74 * @return array<CRM_Utils_Check_Message> an empty array, or a list of warnings
76 public function checkMysqlTime() {
77 //CRM-19115 - Always set MySQL time before checking it.
78 CRM_Core_Config
::singleton()->userSystem
->setMySQLTimeZone();
81 $phpNow = date('Y-m-d H:i');
82 $sqlNow = CRM_Core_DAO
::singleValueQuery("SELECT date_format(now(), '%Y-%m-%d %H:%i')");
83 if (!CRM_Utils_Time
::isEqual($phpNow, $sqlNow, 2.5 * 60)) {
84 $messages[] = new CRM_Utils_Check_Message(
86 ts('Timestamps reported by MySQL (eg "%2") and PHP (eg "%3" ) are mismatched.<br /><a href="%1">Read more about this warning</a>', array(
87 1 => CRM_Utils_System
::getWikiBaseURL() . 'checkMysqlTime',
91 ts('Timestamp Mismatch'),
92 \Psr\Log\LogLevel
::ERROR
,
103 public function checkDebug() {
106 $config = CRM_Core_Config
::singleton();
107 if ($config->debug
) {
108 $messages[] = new CRM_Utils_Check_Message(
110 ts('Warning: Debug is enabled in <a href="%1">system settings</a>. This should not be enabled on production servers.',
111 array(1 => CRM_Utils_System
::url('civicrm/admin/setting/debug', 'reset=1'))),
112 ts('Debug Mode Enabled'),
113 \Psr\Log\LogLevel
::WARNING
,
124 public function checkOutboundMail() {
127 $mailingInfo = Civi
::settings()->get('mailing_backend');
128 if (($mailingInfo['outBound_option'] == CRM_Mailing_Config
::OUTBOUND_OPTION_REDIRECT_TO_DB
129 ||
(defined('CIVICRM_MAIL_LOG') && CIVICRM_MAIL_LOG
)
130 ||
$mailingInfo['outBound_option'] == CRM_Mailing_Config
::OUTBOUND_OPTION_DISABLED
131 ||
$mailingInfo['outBound_option'] == CRM_Mailing_Config
::OUTBOUND_OPTION_MOCK
)
133 $messages[] = new CRM_Utils_Check_Message(
135 ts('Warning: Outbound email is disabled in <a href="%1">system settings</a>. Proper settings should be enabled on production servers.',
136 array(1 => CRM_Utils_System
::url('civicrm/admin/setting/smtp', 'reset=1'))),
137 ts('Outbound Email Disabled'),
138 \Psr\Log\LogLevel
::WARNING
,
147 * Check that domain email and org name are set
150 public function checkDomainNameEmail() {
153 list($domainEmailName, $domainEmailAddress) = CRM_Core_BAO_Domain
::getNameAndEmail(TRUE);
154 $domain = CRM_Core_BAO_Domain
::getDomain();
155 $domainName = $domain->name
;
156 $fixEmailUrl = CRM_Utils_System
::url("civicrm/admin/domain", "action=update&reset=1");
158 if (!$domainEmailAddress ||
$domainEmailAddress == 'info@EXAMPLE.ORG') {
159 if (!$domainName ||
$domainName == 'Default Domain Name') {
160 $msg = ts("Please enter your organization's <a href=\"%1\">name, primary address, and default FROM Email Address</a> (for system-generated emails).",
161 array(1 => $fixEmailUrl));
164 $msg = ts('Please enter a <a href="%1">default FROM Email Address</a> (for system-generated emails).',
165 array(1 => $fixEmailUrl));
168 elseif (!$domainName ||
$domainName == 'Default Domain Name') {
169 $msg = ts("Please enter your organization's <a href=\"%1\">name and primary address</a>.",
170 array(1 => $fixEmailUrl));
174 $messages[] = new CRM_Utils_Check_Message(
177 ts('Complete Setup'),
178 \Psr\Log\LogLevel
::WARNING
,
187 * Checks if a default bounce handling mailbox is set up
190 public function checkDefaultMailbox() {
192 $config = CRM_Core_Config
::singleton();
194 if (in_array('CiviMail', $config->enableComponents
) &&
195 CRM_Core_BAO_MailSettings
::defaultDomain() == "EXAMPLE.ORG"
197 $message = new CRM_Utils_Check_Message(
199 ts('Please configure a <a href="%1">default mailbox</a> for CiviMail.',
200 array(1 => CRM_Utils_System
::url('civicrm/admin/mailSettings', "reset=1"))),
201 ts('Configure Default Mailbox'),
202 \Psr\Log\LogLevel
::WARNING
,
205 $docUrl = 'target="_blank" href="' . CRM_Utils_System
::docURL(array('page' => 'user/advanced-configuration/email-system-configuration/', 'URLonly' => TRUE)) . '""';
207 ts('A default mailbox must be configured for email bounce processing.') . '<br />' .
208 ts("Learn more in the <a %1>online documentation</a>.", array(1 => $docUrl))
210 $messages[] = $message;
217 * Checks if cron has run in a reasonable amount of time
220 public function checkLastCron() {
223 $statusPreference = new CRM_Core_DAO_StatusPreference();
224 $statusPreference->domain_id
= CRM_Core_Config
::domainID();
225 $statusPreference->name
= 'checkLastCron';
227 if ($statusPreference->find(TRUE) && !empty($statusPreference->check_info
)) {
228 $lastCron = $statusPreference->check_info
;
229 $msg = ts('Last cron run at %1.', array(1 => CRM_Utils_Date
::customFormat(date('c', $lastCron))));
233 $msg = ts('No cron runs have been recorded.');
236 if ($lastCron > gmdate('U') - 3600) {
237 $messages[] = new CRM_Utils_Check_Message(
240 ts('Cron Running OK'),
241 \Psr\Log\LogLevel
::INFO
,
246 $message = new CRM_Utils_Check_Message(
249 ts('Cron Not Running'),
250 ($lastCron > gmdate('U') - 86400) ? \Psr\Log\LogLevel
::WARNING
: \Psr\Log\LogLevel
::ERROR
,
253 $docUrl = 'target="_blank" href="' . CRM_Utils_System
::docURL(array('resource' => 'wiki', 'page' => 'Managing Scheduled Jobs', 'URLonly' => TRUE)) . '""';
255 ts('Configuring cron on your server is necessary for running scheduled jobs such as sending mail and scheduled reminders.') . '<br />' .
256 ts("Learn more in the <a %1>online documentation</a>.", array(1 => $docUrl))
258 $messages[] = $message;
265 * Checks if new versions are available
268 public function checkVersion() {
271 $vc = new CRM_Utils_VersionCheck();
274 catch (Exception
$e) {
275 $messages[] = new CRM_Utils_Check_Message(
277 ts('Directory %1 is not writable. Please change your file permissions.',
278 array(1 => dirname($vc->cacheFile
))),
279 ts('Directory not writable'),
280 \Psr\Log\LogLevel
::ERROR
,
286 // Show a notice if the version_check job is disabled
287 if (empty($vc->cronJob
['is_active'])) {
288 $args = empty($vc->cronJob
['id']) ?
array('reset' => 1) : array('reset' => 1, 'action' => 'update', 'id' => $vc->cronJob
['id']);
289 $messages[] = new CRM_Utils_Check_Message(
290 'checkVersionDisabled',
291 ts('The check for new versions of CiviCRM has been disabled. <a %1>Re-enable the scheduled job</a> to receive important security update notifications.', array(1 => 'href="' . CRM_Utils_System
::url('civicrm/admin/job', $args) . '"')),
292 ts('Update Check Disabled'),
293 \Psr\Log\LogLevel
::NOTICE
,
298 if ($vc->isInfoAvailable
) {
299 $newerVersion = $vc->isNewerVersionAvailable();
300 if ($newerVersion['version']) {
302 1 => $newerVersion['version'],
303 2 => $vc->localVersion
,
305 // LTS = long-term support version
306 if ($newerVersion['status'] == 'lts') {
307 $vInfo[1] .= ' ' . ts('(long-term support)');
310 if ($newerVersion['upgrade'] == 'security') {
312 $severity = \Psr\Log\LogLevel
::CRITICAL
;
313 $title = ts('CiviCRM Security Update Required');
314 $message = ts('New security release %1 is available. The site is currently running %2.', $vInfo);
316 elseif ($newerVersion['status'] == 'eol') {
318 $severity = \Psr\Log\LogLevel
::WARNING
;
319 $title = ts('CiviCRM Update Needed');
320 $message = ts('New version %1 is available. The site is currently running %2, which has reached its end of life.', $vInfo);
323 // For most new versions, just make them notice
324 $severity = \Psr\Log\LogLevel
::NOTICE
;
325 $title = ts('CiviCRM Update Available');
326 $message = ts('New version %1 is available. The site is currently running %2.', $vInfo);
329 elseif (!empty($vc->cronJob
['is_active'])) {
330 $vNum = $vc->localVersion
;
331 // LTS = long-term support version
332 if ($newerVersion['status'] == 'lts') {
333 $vNum .= ' ' . ts('(long-term support)');
336 $severity = \Psr\Log\LogLevel
::INFO
;
337 $title = ts('CiviCRM Up-to-Date');
338 $message = ts('CiviCRM version %1 is up-to-date.', array(1 => $vNum));
341 if (!empty($message)) {
342 $messages[] = new CRM_Utils_Check_Message(
356 * Checks if extensions are set up properly
359 public function checkExtensions() {
361 $extensionSystem = CRM_Extension_System
::singleton();
362 $mapper = $extensionSystem->getMapper();
363 $manager = $extensionSystem->getManager();
365 if ($extensionSystem->getDefaultContainer()) {
366 $basedir = $extensionSystem->getDefaultContainer()->baseDir
;
369 if (empty($basedir)) {
370 // no extension directory
371 $messages[] = new CRM_Utils_Check_Message(
373 ts('Your extensions directory is not set. Click <a href="%1">here</a> to set the extensions directory.',
374 array(1 => CRM_Utils_System
::url('civicrm/admin/setting/path', 'reset=1'))),
375 ts('Directory not writable'),
376 \Psr\Log\LogLevel
::NOTICE
,
382 if (!is_dir($basedir)) {
383 $messages[] = new CRM_Utils_Check_Message(
385 ts('Your extensions directory path points to %1, which is not a directory. Please check your file system.',
386 array(1 => $basedir)),
387 ts('Extensions directory incorrect'),
388 \Psr\Log\LogLevel
::ERROR
,
393 elseif (!is_writable($basedir)) {
394 $messages[] = new CRM_Utils_Check_Message(
396 ts('Directory %1 is not writable. Please change your file permissions.',
397 array(1 => $basedir)),
398 ts('Directory not writable'),
399 \Psr\Log\LogLevel
::ERROR
,
405 if (empty($extensionSystem->getDefaultContainer()->baseUrl
)) {
406 $messages[] = new CRM_Utils_Check_Message(
408 ts('The extensions URL is not properly set. Please go to the <a href="%1">URL setting page</a> and correct it.',
409 array(1 => CRM_Utils_System
::url('civicrm/admin/setting/url', 'reset=1'))),
410 ts('Extensions url missing'),
411 \Psr\Log\LogLevel
::ERROR
,
417 if (!$extensionSystem->getBrowser()->isEnabled()) {
418 $messages[] = new CRM_Utils_Check_Message(
420 ts('Not checking remote URL for extensions since ext_repo_url is set to false.'),
421 ts('Extensions check disabled'),
422 \Psr\Log\LogLevel
::NOTICE
,
429 $remotes = $extensionSystem->getBrowser()->getExtensions();
431 catch (CRM_Extension_Exception
$e) {
432 $messages[] = new CRM_Utils_Check_Message(
435 ts('Extension download error'),
436 \Psr\Log\LogLevel
::ERROR
,
443 // CRM-13141 There may not be any compatible extensions available for the requested CiviCRM version + CMS. If so, $extdir is empty so just return a notice.
444 $messages[] = new CRM_Utils_Check_Message(
446 ts('There are currently no extensions on the CiviCRM public extension directory which are compatible with version %1. If you want to install an extension which is not marked as compatible, you may be able to <a %2>download and install extensions manually</a> (depending on access to your web server).', array(
447 1 => CRM_Utils_System
::majorVersion(),
448 2 => 'href="http://wiki.civicrm.org/confluence/display/CRMDOC/Extensions"',
450 ts('No Extensions Available for this Version'),
451 \Psr\Log\LogLevel
::NOTICE
,
457 $keys = array_keys($manager->getStatuses());
459 $updates = $errors = $okextensions = array();
461 foreach ($keys as $key) {
463 $obj = $mapper->keyToInfo($key);
465 catch (CRM_Extension_Exception
$ex) {
466 $errors[] = ts('Failed to read extension (%1). Please refresh the extension list.', array(1 => $key));
469 $row = CRM_Admin_Page_Extensions
::createExtendedInfo($obj);
470 switch ($row['status']) {
471 case CRM_Extension_Manager
::STATUS_INSTALLED_MISSING
:
472 $errors[] = ts('%1 extension (%2) is installed but missing files.', array(1 => CRM_Utils_Array
::value('label', $row), 2 => $key));
475 case CRM_Extension_Manager
::STATUS_INSTALLED
:
476 if (!empty($remotes[$key]) && version_compare($row['version'], $remotes[$key]->version
, '<')) {
477 $updates[] = ts('%1 (%2) version %3 is installed. <a %4>Upgrade to version %5</a>.', array(
478 1 => CRM_Utils_Array
::value('label', $row),
480 3 => $row['version'],
481 4 => 'href="' . CRM_Utils_System
::url('civicrm/admin/extensions', "action=update&id=$key&key=$key") . '"',
482 5 => $remotes[$key]->version
,
486 if (empty($row['label'])) {
487 $okextensions[] = $key;
490 $okextensions[] = ts('%1 (%2) version %3', array(
493 3 => $row['version'],
501 if (!$okextensions && !$updates && !$errors) {
502 $messages[] = new CRM_Utils_Check_Message(
504 ts('No extensions installed. <a %1>Browse available extensions</a>.', array(
505 1 => 'href="' . CRM_Utils_System
::url('civicrm/admin/extensions', 'reset=1') . '"',
508 \Psr\Log\LogLevel
::INFO
,
514 $messages[] = new CRM_Utils_Check_Message(
516 '<ul><li>' . implode('</li><li>', $errors) . '</li></ul>',
517 ts('Extension Error'),
518 \Psr\Log\LogLevel
::ERROR
,
524 $messages[] = new CRM_Utils_Check_Message(
526 '<ul><li>' . implode('</li><li>', $updates) . '</li></ul>',
527 ts('Extension Update Available', array('plural' => '%count Extension Updates Available', 'count' => count($updates))),
528 \Psr\Log\LogLevel
::WARNING
,
534 if ($updates ||
$errors) {
535 $message = ts('1 extension is up-to-date:', array('plural' => '%count extensions are up-to-date:', 'count' => count($okextensions)));
538 $message = ts('All extensions are up-to-date:');
540 $messages[] = new CRM_Utils_Check_Message(
542 $message . '<ul><li>' . implode('</li><li>', $okextensions) . '</li></ul>',
544 \Psr\Log\LogLevel
::INFO
,
554 * Checks if extensions are set up properly
557 public function checkExtensionUpgrades() {
560 if (CRM_Extension_Upgrades
::hasPending()) {
561 $messages[] = new CRM_Utils_Check_Message(
563 ts('Extension upgrades are pending. Please visit <a href="%1">the upgrade page</a> to run them.',
564 array(1 => CRM_Utils_System
::url('civicrm/admin/extensions/upgrade', 'reset=1'))),
565 ts('Run Extension Upgrades'),
566 \Psr\Log\LogLevel
::ERROR
,
574 * Checks if CiviCRM database version is up-to-date
577 public function checkDbVersion() {
579 $dbVersion = CRM_Core_BAO_Domain
::version();
580 $upgradeUrl = CRM_Utils_System
::url("civicrm/upgrade", "reset=1");
584 $messages[] = new CRM_Utils_Check_Message(
586 ts('Version information found to be missing in database. You will need to determine the correct version corresponding to your current database state.'),
587 ts('Database Version Missing'),
588 \Psr\Log\LogLevel
::ERROR
,
592 elseif (!CRM_Utils_System
::isVersionFormatValid($dbVersion)) {
593 $messages[] = new CRM_Utils_Check_Message(
595 ts('Database is marked with invalid version format. You may want to investigate this before you proceed further.'),
596 ts('Database Version Invalid'),
597 \Psr\Log\LogLevel
::ERROR
,
601 elseif (stripos($dbVersion, 'upgrade')) {
602 // if db.ver indicates a partially upgraded db
603 $messages[] = new CRM_Utils_Check_Message(
605 ts('Database check failed - the database looks to have been partially upgraded. You must reload the database with the backup and try the <a href=\'%1\'>upgrade process</a> again.', array(1 => $upgradeUrl)),
606 ts('Database Partially Upgraded'),
607 \Psr\Log\LogLevel
::ALERT
,
612 $codeVersion = CRM_Utils_System
::version();
614 // if db.ver < code.ver, time to upgrade
615 if (version_compare($dbVersion, $codeVersion) < 0) {
616 $messages[] = new CRM_Utils_Check_Message(
618 ts('New codebase version detected. You must visit <a href=\'%1\'>upgrade screen</a> to upgrade the database.', array(1 => $upgradeUrl)),
619 ts('Database Upgrade Required'),
620 \Psr\Log\LogLevel
::ALERT
,
625 // if db.ver > code.ver, sth really wrong
626 if (version_compare($dbVersion, $codeVersion) > 0) {
627 $messages[] = new CRM_Utils_Check_Message(
629 ts('Your database is marked with an unexpected version number: %1. The v%2 codebase may not be compatible with your database state.
630 You will need to determine the correct version corresponding to your current database state. You may want to revert to the codebase
631 you were using until you resolve this problem.<br/>OR if this is a manual install from git, you might want to fix civicrm-version.php file.',
632 array(1 => $dbVersion, 2 => $codeVersion)
634 ts('Database In Unexpected Version'),
635 \Psr\Log\LogLevel
::ERROR
,
645 * ensure that all CiviCRM tables are InnoDB
648 public function checkDbEngine() {
651 if (CRM_Core_DAO
::isDBMyISAM(150)) {
652 $messages[] = new CRM_Utils_Check_Message(
654 ts('Your database is configured to use the MyISAM database engine. CiviCRM requires InnoDB. You will need to convert any MyISAM tables in your database to InnoDB. Using MyISAM tables will result in data integrity issues.'),
655 ts('MyISAM Database Engine'),
656 \Psr\Log\LogLevel
::ERROR
,