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() {
102 $phpNow = date('Y-m-d H:i');
103 $sqlNow = CRM_Core_DAO
::singleValueQuery("SELECT date_format(now(), '%Y-%m-%d %H:%i')");
104 if (!CRM_Utils_Time
::isEqual($phpNow, $sqlNow, 2.5 * 60)) {
105 $messages[] = new CRM_Utils_Check_Message(
107 ts('Timestamps reported by MySQL (eg "%2") and PHP (eg "%3" ) are mismatched.<br /><a href="%1">Read more about this warning</a>', array(
108 1 => CRM_Utils_System
::getWikiBaseURL() . 'checkMysqlTime',
112 ts('Timestamp Mismatch'),
113 \Psr\Log\LogLevel
::ERROR
,
124 public function checkDebug() {
127 $config = CRM_Core_Config
::singleton();
128 if ($config->debug
) {
129 $messages[] = new CRM_Utils_Check_Message(
131 ts('Warning: Debug is enabled in <a href="%1">system settings</a>. This should not be enabled on production servers.',
132 array(1 => CRM_Utils_System
::url('civicrm/admin/setting/debug', 'reset=1'))),
133 ts('Debug Mode Enabled'),
134 \Psr\Log\LogLevel
::WARNING
,
145 public function checkOutboundMail() {
148 $mailingInfo = Civi
::settings()->get('mailing_backend');
149 if (($mailingInfo['outBound_option'] == CRM_Mailing_Config
::OUTBOUND_OPTION_REDIRECT_TO_DB
150 ||
(defined('CIVICRM_MAIL_LOG') && CIVICRM_MAIL_LOG
)
151 ||
$mailingInfo['outBound_option'] == CRM_Mailing_Config
::OUTBOUND_OPTION_DISABLED
152 ||
$mailingInfo['outBound_option'] == CRM_Mailing_Config
::OUTBOUND_OPTION_MOCK
)
154 $messages[] = new CRM_Utils_Check_Message(
156 ts('Warning: Outbound email is disabled in <a href="%1">system settings</a>. Proper settings should be enabled on production servers.',
157 array(1 => CRM_Utils_System
::url('civicrm/admin/setting/smtp', 'reset=1'))),
158 ts('Outbound Email Disabled'),
159 \Psr\Log\LogLevel
::WARNING
,
168 * Check that domain email and org name are set
171 public function checkDomainNameEmail() {
174 list($domainEmailName, $domainEmailAddress) = CRM_Core_BAO_Domain
::getNameAndEmail(TRUE);
175 $domain = CRM_Core_BAO_Domain
::getDomain();
176 $domainName = $domain->name
;
177 $fixEmailUrl = CRM_Utils_System
::url("civicrm/admin/domain", "action=update&reset=1");
179 if (!$domainEmailAddress ||
$domainEmailAddress == 'info@EXAMPLE.ORG') {
180 if (!$domainName ||
$domainName == 'Default Domain Name') {
181 $msg = ts("Please enter your organization's <a href=\"%1\">name, primary address, and default FROM Email Address</a> (for system-generated emails).",
182 array(1 => $fixEmailUrl));
185 $msg = ts('Please enter a <a href="%1">default FROM Email Address</a> (for system-generated emails).',
186 array(1 => $fixEmailUrl));
189 elseif (!$domainName ||
$domainName == 'Default Domain Name') {
190 $msg = ts("Please enter your organization's <a href=\"%1\">name and primary address</a>.",
191 array(1 => $fixEmailUrl));
195 $messages[] = new CRM_Utils_Check_Message(
198 ts('Complete Setup'),
199 \Psr\Log\LogLevel
::WARNING
,
208 * Checks if a default bounce handling mailbox is set up
211 public function checkDefaultMailbox() {
213 $config = CRM_Core_Config
::singleton();
215 if (in_array('CiviMail', $config->enableComponents
) &&
216 CRM_Core_BAO_MailSettings
::defaultDomain() == "EXAMPLE.ORG"
218 $message = new CRM_Utils_Check_Message(
220 ts('Please configure a <a href="%1">default mailbox</a> for CiviMail.',
221 array(1 => CRM_Utils_System
::url('civicrm/admin/mailSettings', "reset=1"))),
222 ts('Configure Default Mailbox'),
223 \Psr\Log\LogLevel
::WARNING
,
226 $docUrl = 'target="_blank" href="' . CRM_Utils_System
::docURL(array('page' => 'user/advanced-configuration/email-system-configuration/', 'URLonly' => TRUE)) . '""';
228 ts('A default mailbox must be configured for email bounce processing.') . '<br />' .
229 ts("Learn more in the <a %1>online documentation</a>.", array(1 => $docUrl))
231 $messages[] = $message;
238 * Checks if cron has run in a reasonable amount of time
241 public function checkLastCron() {
244 $statusPreference = new CRM_Core_DAO_StatusPreference();
245 $statusPreference->domain_id
= CRM_Core_Config
::domainID();
246 $statusPreference->name
= 'checkLastCron';
248 if ($statusPreference->find(TRUE) && !empty($statusPreference->check_info
)) {
249 $lastCron = $statusPreference->check_info
;
250 $msg = ts('Last cron run at %1.', array(1 => CRM_Utils_Date
::customFormat(date('c', $lastCron))));
254 $msg = ts('No cron runs have been recorded.');
257 if ($lastCron > gmdate('U') - 3600) {
258 $messages[] = new CRM_Utils_Check_Message(
261 ts('Cron Running OK'),
262 \Psr\Log\LogLevel
::INFO
,
267 $message = new CRM_Utils_Check_Message(
270 ts('Cron Not Running'),
271 ($lastCron > gmdate('U') - 86400) ? \Psr\Log\LogLevel
::WARNING
: \Psr\Log\LogLevel
::ERROR
,
274 $docUrl = 'target="_blank" href="' . CRM_Utils_System
::docURL(array('resource' => 'wiki', 'page' => 'Managing Scheduled Jobs', 'URLonly' => TRUE)) . '""';
276 ts('Configuring cron on your server is necessary for running scheduled jobs such as sending mail and scheduled reminders.') . '<br />' .
277 ts("Learn more in the <a %1>online documentation</a>.", array(1 => $docUrl))
279 $messages[] = $message;
286 * Checks if new versions are available
289 public function checkVersion() {
292 $vc = new CRM_Utils_VersionCheck();
295 catch (Exception
$e) {
296 $messages[] = new CRM_Utils_Check_Message(
298 ts('Directory %1 is not writable. Please change your file permissions.',
299 array(1 => dirname($vc->cacheFile
))),
300 ts('Directory not writable'),
301 \Psr\Log\LogLevel
::ERROR
,
307 // Show a notice if the version_check job is disabled
308 if (empty($vc->cronJob
['is_active'])) {
309 $args = empty($vc->cronJob
['id']) ?
array('reset' => 1) : array('reset' => 1, 'action' => 'update', 'id' => $vc->cronJob
['id']);
310 $messages[] = new CRM_Utils_Check_Message(
311 'checkVersionDisabled',
312 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) . '"')),
313 ts('Update Check Disabled'),
314 \Psr\Log\LogLevel
::NOTICE
,
319 if ($vc->isInfoAvailable
) {
320 $newerVersion = $vc->isNewerVersionAvailable();
321 if ($newerVersion['version']) {
323 1 => $newerVersion['version'],
324 2 => $vc->localVersion
,
326 // LTS = long-term support version
327 if ($newerVersion['status'] == 'lts') {
328 $vInfo[1] .= ' ' . ts('(long-term support)');
331 if ($newerVersion['upgrade'] == 'security') {
333 $severity = \Psr\Log\LogLevel
::CRITICAL
;
334 $title = ts('CiviCRM Security Update Required');
335 $message = ts('New security release %1 is available. The site is currently running %2.', $vInfo);
337 elseif ($newerVersion['status'] == 'eol') {
339 $severity = \Psr\Log\LogLevel
::WARNING
;
340 $title = ts('CiviCRM Update Needed');
341 $message = ts('New version %1 is available. The site is currently running %2, which has reached its end of life.', $vInfo);
344 // For most new versions, just make them notice
345 $severity = \Psr\Log\LogLevel
::NOTICE
;
346 $title = ts('CiviCRM Update Available');
347 $message = ts('New version %1 is available. The site is currently running %2.', $vInfo);
350 elseif (!empty($vc->cronJob
['is_active'])) {
351 $vNum = $vc->localVersion
;
352 // LTS = long-term support version
353 if ($newerVersion['status'] == 'lts') {
354 $vNum .= ' ' . ts('(long-term support)');
357 $severity = \Psr\Log\LogLevel
::INFO
;
358 $title = ts('CiviCRM Up-to-Date');
359 $message = ts('CiviCRM version %1 is up-to-date.', array(1 => $vNum));
362 if (!empty($message)) {
363 $messages[] = new CRM_Utils_Check_Message(
377 * Checks if extensions are set up properly
380 public function checkExtensions() {
382 $extensionSystem = CRM_Extension_System
::singleton();
383 $mapper = $extensionSystem->getMapper();
384 $manager = $extensionSystem->getManager();
386 if ($extensionSystem->getDefaultContainer()) {
387 $basedir = $extensionSystem->getDefaultContainer()->baseDir
;
390 if (empty($basedir)) {
391 // no extension directory
392 $messages[] = new CRM_Utils_Check_Message(
394 ts('Your extensions directory is not set. Click <a href="%1">here</a> to set the extensions directory.',
395 array(1 => CRM_Utils_System
::url('civicrm/admin/setting/path', 'reset=1'))),
396 ts('Directory not writable'),
397 \Psr\Log\LogLevel
::NOTICE
,
403 if (!is_dir($basedir)) {
404 $messages[] = new CRM_Utils_Check_Message(
406 ts('Your extensions directory path points to %1, which is not a directory. Please check your file system.',
407 array(1 => $basedir)),
408 ts('Extensions directory incorrect'),
409 \Psr\Log\LogLevel
::ERROR
,
414 elseif (!is_writable($basedir)) {
415 $messages[] = new CRM_Utils_Check_Message(
417 ts('Directory %1 is not writable. Please change your file permissions.',
418 array(1 => $basedir)),
419 ts('Directory not writable'),
420 \Psr\Log\LogLevel
::ERROR
,
426 if (empty($extensionSystem->getDefaultContainer()->baseUrl
)) {
427 $messages[] = new CRM_Utils_Check_Message(
429 ts('The extensions URL is not properly set. Please go to the <a href="%1">URL setting page</a> and correct it.',
430 array(1 => CRM_Utils_System
::url('civicrm/admin/setting/url', 'reset=1'))),
431 ts('Extensions url missing'),
432 \Psr\Log\LogLevel
::ERROR
,
438 if (!$extensionSystem->getBrowser()->isEnabled()) {
439 $messages[] = new CRM_Utils_Check_Message(
441 ts('Not checking remote URL for extensions since ext_repo_url is set to false.'),
442 ts('Extensions check disabled'),
443 \Psr\Log\LogLevel
::NOTICE
,
450 $remotes = $extensionSystem->getBrowser()->getExtensions();
452 catch (CRM_Extension_Exception
$e) {
453 $messages[] = new CRM_Utils_Check_Message(
456 ts('Extension download error'),
457 \Psr\Log\LogLevel
::ERROR
,
464 // 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.
465 $messages[] = new CRM_Utils_Check_Message(
467 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(
468 1 => CRM_Utils_System
::majorVersion(),
469 2 => 'href="http://wiki.civicrm.org/confluence/display/CRMDOC/Extensions"',
471 ts('No Extensions Available for this Version'),
472 \Psr\Log\LogLevel
::NOTICE
,
478 $keys = array_keys($manager->getStatuses());
480 $updates = $errors = $okextensions = array();
482 foreach ($keys as $key) {
484 $obj = $mapper->keyToInfo($key);
486 catch (CRM_Extension_Exception
$ex) {
487 $errors[] = ts('Failed to read extension (%1). Please refresh the extension list.', array(1 => $key));
490 $row = CRM_Admin_Page_Extensions
::createExtendedInfo($obj);
491 switch ($row['status']) {
492 case CRM_Extension_Manager
::STATUS_INSTALLED_MISSING
:
493 $errors[] = ts('%1 extension (%2) is installed but missing files.', array(1 => CRM_Utils_Array
::value('label', $row), 2 => $key));
496 case CRM_Extension_Manager
::STATUS_INSTALLED
:
497 if (!empty($remotes[$key]) && version_compare($row['version'], $remotes[$key]->version
, '<')) {
498 $updates[] = ts('%1 (%2) version %3 is installed. <a %4>Upgrade to version %5</a>.', array(
499 1 => CRM_Utils_Array
::value('label', $row),
501 3 => $row['version'],
502 4 => 'href="' . CRM_Utils_System
::url('civicrm/admin/extensions', "action=update&id=$key&key=$key") . '"',
503 5 => $remotes[$key]->version
,
507 if (empty($row['label'])) {
508 $okextensions[] = $key;
511 $okextensions[] = ts('%1 (%2) version %3', array(
514 3 => $row['version'],
522 if (!$okextensions && !$updates && !$errors) {
523 $messages[] = new CRM_Utils_Check_Message(
525 ts('No extensions installed. <a %1>Browse available extensions</a>.', array(
526 1 => 'href="' . CRM_Utils_System
::url('civicrm/admin/extensions', 'reset=1') . '"',
529 \Psr\Log\LogLevel
::INFO
,
535 $messages[] = new CRM_Utils_Check_Message(
537 '<ul><li>' . implode('</li><li>', $errors) . '</li></ul>',
538 ts('Extension Error'),
539 \Psr\Log\LogLevel
::ERROR
,
545 $messages[] = new CRM_Utils_Check_Message(
547 '<ul><li>' . implode('</li><li>', $updates) . '</li></ul>',
548 ts('Extension Update Available', array('plural' => '%count Extension Updates Available', 'count' => count($updates))),
549 \Psr\Log\LogLevel
::WARNING
,
555 if ($updates ||
$errors) {
556 $message = ts('1 extension is up-to-date:', array('plural' => '%count extensions are up-to-date:', 'count' => count($okextensions)));
559 $message = ts('All extensions are up-to-date:');
561 $messages[] = new CRM_Utils_Check_Message(
563 $message . '<ul><li>' . implode('</li><li>', $okextensions) . '</li></ul>',
565 \Psr\Log\LogLevel
::INFO
,
575 * Checks if extensions are set up properly
578 public function checkExtensionUpgrades() {
581 if (CRM_Extension_Upgrades
::hasPending()) {
582 $messages[] = new CRM_Utils_Check_Message(
584 ts('Extension upgrades are pending. Please visit <a href="%1">the upgrade page</a> to run them.',
585 array(1 => CRM_Utils_System
::url('civicrm/admin/extensions/upgrade', 'reset=1'))),
586 ts('Run Extension Upgrades'),
587 \Psr\Log\LogLevel
::ERROR
,
595 * Checks if CiviCRM database version is up-to-date
598 public function checkDbVersion() {
600 $dbVersion = CRM_Core_BAO_Domain
::version();
601 $upgradeUrl = CRM_Utils_System
::url("civicrm/upgrade", "reset=1");
605 $messages[] = new CRM_Utils_Check_Message(
607 ts('Version information found to be missing in database. You will need to determine the correct version corresponding to your current database state.'),
608 ts('Database Version Missing'),
609 \Psr\Log\LogLevel
::ERROR
,
613 elseif (!CRM_Utils_System
::isVersionFormatValid($dbVersion)) {
614 $messages[] = new CRM_Utils_Check_Message(
616 ts('Database is marked with invalid version format. You may want to investigate this before you proceed further.'),
617 ts('Database Version Invalid'),
618 \Psr\Log\LogLevel
::ERROR
,
622 elseif (stripos($dbVersion, 'upgrade')) {
623 // if db.ver indicates a partially upgraded db
624 $messages[] = new CRM_Utils_Check_Message(
626 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)),
627 ts('Database Partially Upgraded'),
628 \Psr\Log\LogLevel
::ALERT
,
633 $codeVersion = CRM_Utils_System
::version();
635 // if db.ver < code.ver, time to upgrade
636 if (version_compare($dbVersion, $codeVersion) < 0) {
637 $messages[] = new CRM_Utils_Check_Message(
639 ts('New codebase version detected. You must visit <a href=\'%1\'>upgrade screen</a> to upgrade the database.', array(1 => $upgradeUrl)),
640 ts('Database Upgrade Required'),
641 \Psr\Log\LogLevel
::ALERT
,
646 // if db.ver > code.ver, sth really wrong
647 if (version_compare($dbVersion, $codeVersion) > 0) {
648 $messages[] = new CRM_Utils_Check_Message(
650 ts('Your database is marked with an unexpected version number: %1. The v%2 codebase may not be compatible with your database state.
651 You will need to determine the correct version corresponding to your current database state. You may want to revert to the codebase
652 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.',
653 array(1 => $dbVersion, 2 => $codeVersion)
655 ts('Database In Unexpected Version'),
656 \Psr\Log\LogLevel
::ERROR
,
666 * ensure that all CiviCRM tables are InnoDB
669 public function checkDbEngine() {
672 if (CRM_Core_DAO
::isDBMyISAM(150)) {
673 $messages[] = new CRM_Utils_Check_Message(
675 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.'),
676 ts('MyISAM Database Engine'),
677 \Psr\Log\LogLevel
::ERROR
,