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
,
74 public function checkPhpMysqli() {
77 if (!extension_loaded('mysqli')) {
78 $messages[] = new CRM_Utils_Check_Message(
80 ts('Future versions of CiviCRM may require the PHP extension "%2". To ensure that your system will be compatible, please install it in advance. For more explanation, see <a href="%1">the announcement</a>.',
82 1 => 'https://civicrm.org/blog/totten/psa-please-verify-php-extension-mysqli',
85 ts('Forward Compatibility: Enable "mysqli"'),
86 \Psr\Log\LogLevel
::WARNING
,
95 * Check that the MySQL time settings match the PHP time settings.
97 * @return array<CRM_Utils_Check_Message> an empty array, or a list of warnings
99 public function checkMysqlTime() {
100 //CRM-19115 - Always set MySQL time before checking it.
101 CRM_Core_Config
::singleton()->userSystem
->setMySQLTimeZone();
104 $phpNow = date('Y-m-d H:i');
105 $sqlNow = CRM_Core_DAO
::singleValueQuery("SELECT date_format(now(), '%Y-%m-%d %H:%i')");
106 if (!CRM_Utils_Time
::isEqual($phpNow, $sqlNow, 2.5 * 60)) {
107 $messages[] = new CRM_Utils_Check_Message(
109 ts('Timestamps reported by MySQL (eg "%2") and PHP (eg "%3" ) are mismatched.<br /><a href="%1">Read more about this warning</a>', array(
110 1 => CRM_Utils_System
::getWikiBaseURL() . 'checkMysqlTime',
114 ts('Timestamp Mismatch'),
115 \Psr\Log\LogLevel
::ERROR
,
126 public function checkDebug() {
129 $config = CRM_Core_Config
::singleton();
130 if ($config->debug
) {
131 $messages[] = new CRM_Utils_Check_Message(
133 ts('Warning: Debug is enabled in <a href="%1">system settings</a>. This should not be enabled on production servers.',
134 array(1 => CRM_Utils_System
::url('civicrm/admin/setting/debug', 'reset=1'))),
135 ts('Debug Mode Enabled'),
136 \Psr\Log\LogLevel
::WARNING
,
147 public function checkOutboundMail() {
150 $mailingInfo = Civi
::settings()->get('mailing_backend');
151 if (($mailingInfo['outBound_option'] == CRM_Mailing_Config
::OUTBOUND_OPTION_REDIRECT_TO_DB
152 ||
(defined('CIVICRM_MAIL_LOG') && CIVICRM_MAIL_LOG
)
153 ||
$mailingInfo['outBound_option'] == CRM_Mailing_Config
::OUTBOUND_OPTION_DISABLED
154 ||
$mailingInfo['outBound_option'] == CRM_Mailing_Config
::OUTBOUND_OPTION_MOCK
)
156 $messages[] = new CRM_Utils_Check_Message(
158 ts('Warning: Outbound email is disabled in <a href="%1">system settings</a>. Proper settings should be enabled on production servers.',
159 array(1 => CRM_Utils_System
::url('civicrm/admin/setting/smtp', 'reset=1'))),
160 ts('Outbound Email Disabled'),
161 \Psr\Log\LogLevel
::WARNING
,
170 * Check that domain email and org name are set
173 public function checkDomainNameEmail() {
176 list($domainEmailName, $domainEmailAddress) = CRM_Core_BAO_Domain
::getNameAndEmail(TRUE);
177 $domain = CRM_Core_BAO_Domain
::getDomain();
178 $domainName = $domain->name
;
179 $fixEmailUrl = CRM_Utils_System
::url("civicrm/admin/domain", "action=update&reset=1");
181 if (!$domainEmailAddress ||
$domainEmailAddress == 'info@EXAMPLE.ORG') {
182 if (!$domainName ||
$domainName == 'Default Domain Name') {
183 $msg = ts("Please enter your organization's <a href=\"%1\">name, primary address, and default FROM Email Address</a> (for system-generated emails).",
184 array(1 => $fixEmailUrl));
187 $msg = ts('Please enter a <a href="%1">default FROM Email Address</a> (for system-generated emails).',
188 array(1 => $fixEmailUrl));
191 elseif (!$domainName ||
$domainName == 'Default Domain Name') {
192 $msg = ts("Please enter your organization's <a href=\"%1\">name and primary address</a>.",
193 array(1 => $fixEmailUrl));
197 $messages[] = new CRM_Utils_Check_Message(
200 ts('Complete Setup'),
201 \Psr\Log\LogLevel
::WARNING
,
210 * Checks if a default bounce handling mailbox is set up
213 public function checkDefaultMailbox() {
215 $config = CRM_Core_Config
::singleton();
217 if (in_array('CiviMail', $config->enableComponents
) &&
218 CRM_Core_BAO_MailSettings
::defaultDomain() == "EXAMPLE.ORG"
220 $message = new CRM_Utils_Check_Message(
222 ts('Please configure a <a href="%1">default mailbox</a> for CiviMail.',
223 array(1 => CRM_Utils_System
::url('civicrm/admin/mailSettings', "reset=1"))),
224 ts('Configure Default Mailbox'),
225 \Psr\Log\LogLevel
::WARNING
,
228 $docUrl = 'target="_blank" href="' . CRM_Utils_System
::docURL(array('page' => 'user/advanced-configuration/email-system-configuration/', 'URLonly' => TRUE)) . '""';
230 ts('A default mailbox must be configured for email bounce processing.') . '<br />' .
231 ts("Learn more in the <a %1>online documentation</a>.", array(1 => $docUrl))
233 $messages[] = $message;
240 * Checks if cron has run in a reasonable amount of time
243 public function checkLastCron() {
246 $statusPreference = new CRM_Core_DAO_StatusPreference();
247 $statusPreference->domain_id
= CRM_Core_Config
::domainID();
248 $statusPreference->name
= 'checkLastCron';
250 if ($statusPreference->find(TRUE) && !empty($statusPreference->check_info
)) {
251 $lastCron = $statusPreference->check_info
;
252 $msg = ts('Last cron run at %1.', array(1 => CRM_Utils_Date
::customFormat(date('c', $lastCron))));
256 $msg = ts('No cron runs have been recorded.');
259 if ($lastCron > gmdate('U') - 3600) {
260 $messages[] = new CRM_Utils_Check_Message(
263 ts('Cron Running OK'),
264 \Psr\Log\LogLevel
::INFO
,
269 $message = new CRM_Utils_Check_Message(
272 ts('Cron Not Running'),
273 ($lastCron > gmdate('U') - 86400) ? \Psr\Log\LogLevel
::WARNING
: \Psr\Log\LogLevel
::ERROR
,
276 $docUrl = 'target="_blank" href="' . CRM_Utils_System
::docURL(array('resource' => 'wiki', 'page' => 'Managing Scheduled Jobs', 'URLonly' => TRUE)) . '""';
278 ts('Configuring cron on your server is necessary for running scheduled jobs such as sending mail and scheduled reminders.') . '<br />' .
279 ts("Learn more in the <a %1>online documentation</a>.", array(1 => $docUrl))
281 $messages[] = $message;
288 * Checks if new versions are available
291 public function checkVersion() {
294 $vc = new CRM_Utils_VersionCheck();
297 catch (Exception
$e) {
298 $messages[] = new CRM_Utils_Check_Message(
300 ts('Directory %1 is not writable. Please change your file permissions.',
301 array(1 => dirname($vc->cacheFile
))),
302 ts('Directory not writable'),
303 \Psr\Log\LogLevel
::ERROR
,
309 // Show a notice if the version_check job is disabled
310 if (empty($vc->cronJob
['is_active'])) {
311 $args = empty($vc->cronJob
['id']) ?
array('reset' => 1) : array('reset' => 1, 'action' => 'update', 'id' => $vc->cronJob
['id']);
312 $messages[] = new CRM_Utils_Check_Message(
313 'checkVersionDisabled',
314 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) . '"')),
315 ts('Update Check Disabled'),
316 \Psr\Log\LogLevel
::NOTICE
,
321 if ($vc->isInfoAvailable
) {
322 $newerVersion = $vc->isNewerVersionAvailable();
323 if ($newerVersion['version']) {
325 1 => $newerVersion['version'],
326 2 => $vc->localVersion
,
328 // LTS = long-term support version
329 if ($newerVersion['status'] == 'lts') {
330 $vInfo[1] .= ' ' . ts('(long-term support)');
333 if ($newerVersion['upgrade'] == 'security') {
335 $severity = \Psr\Log\LogLevel
::CRITICAL
;
336 $title = ts('CiviCRM Security Update Required');
337 $message = ts('New security release %1 is available. The site is currently running %2.', $vInfo);
339 elseif ($newerVersion['status'] == 'eol') {
341 $severity = \Psr\Log\LogLevel
::WARNING
;
342 $title = ts('CiviCRM Update Needed');
343 $message = ts('New version %1 is available. The site is currently running %2, which has reached its end of life.', $vInfo);
346 // For most new versions, just make them notice
347 $severity = \Psr\Log\LogLevel
::NOTICE
;
348 $title = ts('CiviCRM Update Available');
349 $message = ts('New version %1 is available. The site is currently running %2.', $vInfo);
352 elseif (!empty($vc->cronJob
['is_active'])) {
353 $vNum = $vc->localVersion
;
354 // LTS = long-term support version
355 if ($newerVersion['status'] == 'lts') {
356 $vNum .= ' ' . ts('(long-term support)');
359 $severity = \Psr\Log\LogLevel
::INFO
;
360 $title = ts('CiviCRM Up-to-Date');
361 $message = ts('CiviCRM version %1 is up-to-date.', array(1 => $vNum));
364 if (!empty($message)) {
365 $messages[] = new CRM_Utils_Check_Message(
379 * Checks if extensions are set up properly
382 public function checkExtensions() {
384 $extensionSystem = CRM_Extension_System
::singleton();
385 $mapper = $extensionSystem->getMapper();
386 $manager = $extensionSystem->getManager();
388 if ($extensionSystem->getDefaultContainer()) {
389 $basedir = $extensionSystem->getDefaultContainer()->baseDir
;
392 if (empty($basedir)) {
393 // no extension directory
394 $messages[] = new CRM_Utils_Check_Message(
396 ts('Your extensions directory is not set. Click <a href="%1">here</a> to set the extensions directory.',
397 array(1 => CRM_Utils_System
::url('civicrm/admin/setting/path', 'reset=1'))),
398 ts('Directory not writable'),
399 \Psr\Log\LogLevel
::NOTICE
,
405 if (!is_dir($basedir)) {
406 $messages[] = new CRM_Utils_Check_Message(
408 ts('Your extensions directory path points to %1, which is not a directory. Please check your file system.',
409 array(1 => $basedir)),
410 ts('Extensions directory incorrect'),
411 \Psr\Log\LogLevel
::ERROR
,
416 elseif (!is_writable($basedir)) {
417 $messages[] = new CRM_Utils_Check_Message(
419 ts('Directory %1 is not writable. Please change your file permissions.',
420 array(1 => $basedir)),
421 ts('Directory not writable'),
422 \Psr\Log\LogLevel
::ERROR
,
428 if (empty($extensionSystem->getDefaultContainer()->baseUrl
)) {
429 $messages[] = new CRM_Utils_Check_Message(
431 ts('The extensions URL is not properly set. Please go to the <a href="%1">URL setting page</a> and correct it.',
432 array(1 => CRM_Utils_System
::url('civicrm/admin/setting/url', 'reset=1'))),
433 ts('Extensions url missing'),
434 \Psr\Log\LogLevel
::ERROR
,
440 if (!$extensionSystem->getBrowser()->isEnabled()) {
441 $messages[] = new CRM_Utils_Check_Message(
443 ts('Not checking remote URL for extensions since ext_repo_url is set to false.'),
444 ts('Extensions check disabled'),
445 \Psr\Log\LogLevel
::NOTICE
,
452 $remotes = $extensionSystem->getBrowser()->getExtensions();
454 catch (CRM_Extension_Exception
$e) {
455 $messages[] = new CRM_Utils_Check_Message(
458 ts('Extension download error'),
459 \Psr\Log\LogLevel
::ERROR
,
466 // 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.
467 $messages[] = new CRM_Utils_Check_Message(
469 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(
470 1 => CRM_Utils_System
::majorVersion(),
471 2 => 'href="http://wiki.civicrm.org/confluence/display/CRMDOC/Extensions"',
473 ts('No Extensions Available for this Version'),
474 \Psr\Log\LogLevel
::NOTICE
,
480 $keys = array_keys($manager->getStatuses());
482 $updates = $errors = $okextensions = array();
484 foreach ($keys as $key) {
486 $obj = $mapper->keyToInfo($key);
488 catch (CRM_Extension_Exception
$ex) {
489 $errors[] = ts('Failed to read extension (%1). Please refresh the extension list.', array(1 => $key));
492 $row = CRM_Admin_Page_Extensions
::createExtendedInfo($obj);
493 switch ($row['status']) {
494 case CRM_Extension_Manager
::STATUS_INSTALLED_MISSING
:
495 $errors[] = ts('%1 extension (%2) is installed but missing files.', array(1 => CRM_Utils_Array
::value('label', $row), 2 => $key));
498 case CRM_Extension_Manager
::STATUS_INSTALLED
:
499 if (!empty($remotes[$key]) && version_compare($row['version'], $remotes[$key]->version
, '<')) {
500 $updates[] = ts('%1 (%2) version %3 is installed. <a %4>Upgrade to version %5</a>.', array(
501 1 => CRM_Utils_Array
::value('label', $row),
503 3 => $row['version'],
504 4 => 'href="' . CRM_Utils_System
::url('civicrm/admin/extensions', "action=update&id=$key&key=$key") . '"',
505 5 => $remotes[$key]->version
,
509 if (empty($row['label'])) {
510 $okextensions[] = $key;
513 $okextensions[] = ts('%1 (%2) version %3', array(
516 3 => $row['version'],
524 if (!$okextensions && !$updates && !$errors) {
525 $messages[] = new CRM_Utils_Check_Message(
527 ts('No extensions installed. <a %1>Browse available extensions</a>.', array(
528 1 => 'href="' . CRM_Utils_System
::url('civicrm/admin/extensions', 'reset=1') . '"',
531 \Psr\Log\LogLevel
::INFO
,
537 $messages[] = new CRM_Utils_Check_Message(
539 '<ul><li>' . implode('</li><li>', $errors) . '</li></ul>',
540 ts('Extension Error'),
541 \Psr\Log\LogLevel
::ERROR
,
547 $messages[] = new CRM_Utils_Check_Message(
549 '<ul><li>' . implode('</li><li>', $updates) . '</li></ul>',
550 ts('Extension Update Available', array('plural' => '%count Extension Updates Available', 'count' => count($updates))),
551 \Psr\Log\LogLevel
::WARNING
,
557 if ($updates ||
$errors) {
558 $message = ts('1 extension is up-to-date:', array('plural' => '%count extensions are up-to-date:', 'count' => count($okextensions)));
561 $message = ts('All extensions are up-to-date:');
563 $messages[] = new CRM_Utils_Check_Message(
565 $message . '<ul><li>' . implode('</li><li>', $okextensions) . '</li></ul>',
567 \Psr\Log\LogLevel
::INFO
,
577 * Checks if extensions are set up properly
580 public function checkExtensionUpgrades() {
583 if (CRM_Extension_Upgrades
::hasPending()) {
584 $messages[] = new CRM_Utils_Check_Message(
586 ts('Extension upgrades are pending. Please visit <a href="%1">the upgrade page</a> to run them.',
587 array(1 => CRM_Utils_System
::url('civicrm/admin/extensions/upgrade', 'reset=1'))),
588 ts('Run Extension Upgrades'),
589 \Psr\Log\LogLevel
::ERROR
,
597 * Checks if CiviCRM database version is up-to-date
600 public function checkDbVersion() {
602 $dbVersion = CRM_Core_BAO_Domain
::version();
603 $upgradeUrl = CRM_Utils_System
::url("civicrm/upgrade", "reset=1");
607 $messages[] = new CRM_Utils_Check_Message(
609 ts('Version information found to be missing in database. You will need to determine the correct version corresponding to your current database state.'),
610 ts('Database Version Missing'),
611 \Psr\Log\LogLevel
::ERROR
,
615 elseif (!CRM_Utils_System
::isVersionFormatValid($dbVersion)) {
616 $messages[] = new CRM_Utils_Check_Message(
618 ts('Database is marked with invalid version format. You may want to investigate this before you proceed further.'),
619 ts('Database Version Invalid'),
620 \Psr\Log\LogLevel
::ERROR
,
624 elseif (stripos($dbVersion, 'upgrade')) {
625 // if db.ver indicates a partially upgraded db
626 $messages[] = new CRM_Utils_Check_Message(
628 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)),
629 ts('Database Partially Upgraded'),
630 \Psr\Log\LogLevel
::ALERT
,
635 $codeVersion = CRM_Utils_System
::version();
637 // if db.ver < code.ver, time to upgrade
638 if (version_compare($dbVersion, $codeVersion) < 0) {
639 $messages[] = new CRM_Utils_Check_Message(
641 ts('New codebase version detected. You must visit <a href=\'%1\'>upgrade screen</a> to upgrade the database.', array(1 => $upgradeUrl)),
642 ts('Database Upgrade Required'),
643 \Psr\Log\LogLevel
::ALERT
,
648 // if db.ver > code.ver, sth really wrong
649 if (version_compare($dbVersion, $codeVersion) > 0) {
650 $messages[] = new CRM_Utils_Check_Message(
652 ts('Your database is marked with an unexpected version number: %1. The v%2 codebase may not be compatible with your database state.
653 You will need to determine the correct version corresponding to your current database state. You may want to revert to the codebase
654 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.',
655 array(1 => $dbVersion, 2 => $codeVersion)
657 ts('Database In Unexpected Version'),
658 \Psr\Log\LogLevel
::ERROR
,
668 * ensure that all CiviCRM tables are InnoDB
671 public function checkDbEngine() {
674 if (CRM_Core_DAO
::isDBMyISAM(150)) {
675 $messages[] = new CRM_Utils_Check_Message(
677 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.'),
678 ts('MyISAM Database Engine'),
679 \Psr\Log\LogLevel
::ERROR
,