3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
35 class CRM_Utils_VersionCheck
{
37 LATEST_VERSION_AT
= 'http://latest.civicrm.org/stable.php',
38 // timeout for when the connection or the server is slow
40 // relative to $civicrm_root
41 LOCALFILE_NAME
= 'civicrm-version.php',
42 // relative to $config->uploadDir
43 CACHEFILE_NAME
= 'latest-version-cache.txt',
44 // cachefile expiry time (in seconds) - one day
45 CACHEFILE_EXPIRE
= 86400;
48 * We only need one instance of this object, so we use the
49 * singleton pattern and cache the instance in this variable
54 static private $_singleton = NULL;
57 * The version of the current (local) installation
61 public $localVersion = NULL;
64 * The latest version of CiviCRM
68 public $latestVersion = NULL;
75 protected $stats = array();
82 function __construct() {
84 $config = CRM_Core_Config
::singleton();
86 $localfile = $civicrm_root . DIRECTORY_SEPARATOR
. self
::LOCALFILE_NAME
;
87 $cachefile = $config->uploadDir
. self
::CACHEFILE_NAME
;
89 if (file_exists($localfile)) {
90 require_once ($localfile);
91 if (function_exists('civicrmVersion')) {
92 $info = civicrmVersion();
93 $this->localVersion
= trim($info['version']);
96 if ($config->versionCheck
) {
97 $expiryTime = time() - self
::CACHEFILE_EXPIRE
;
99 // if there's a cachefile and it's not stale use it to
100 // read the latestVersion, else read it from the Internet
101 if (file_exists($cachefile) && (filemtime($cachefile) > $expiryTime)) {
102 $this->latestVersion
= trim(file_get_contents($cachefile));
105 $siteKey = md5(defined('CIVICRM_SITE_KEY') ? CIVICRM_SITE_KEY
: '');
107 $this->stats
= array(
108 'hash' => md5($siteKey . $config->userFrameworkBaseURL
),
109 'version' => $this->localVersion
,
110 'uf' => $config->userFramework
,
111 'lang' => $config->lcMessages
,
112 'co' => $config->defaultContactCountry
,
113 'ufv' => $config->userFrameworkVersion
,
114 'PHP' => phpversion(),
115 'MySQL' => CRM_CORE_DAO
::singleValueQuery('SELECT VERSION()'),
116 'communityMessagesUrl' => CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
, 'communityMessagesUrl', NULL, '*default*'),
120 $this->payProcStats();
121 $this->entityStats();
122 $this->extensionStats();
124 // Get the latest version and send site info
128 if ($this->latestVersion
) {
129 $fp = @fopen
($cachefile, 'w');
131 if (CRM_Core_Permission
::check('administer CiviCRM')) {
132 CRM_Core_Session
::setStatus(
133 ts('Unable to write file') . ":$cachefile<br />" . ts('Please check your system file permissions.'),
134 ts('File Error'), 'error');
138 fwrite($fp, $this->latestVersion
);
146 * Static instance provider
148 * Method providing static instance of CRM_Utils_VersionCheck,
149 * as in Singleton pattern
151 * @return CRM_Utils_VersionCheck
153 static function &singleton() {
154 if (!isset(self
::$_singleton)) {
155 self
::$_singleton = new CRM_Utils_VersionCheck();
157 return self
::$_singleton;
161 * Get the latest version number if it's newer than the local one
163 * @return string|null
164 * Returns the newer version's number, or null if the versions are equal
166 public function newerVersion() {
167 if ($this->latestVersion
) {
168 if (version_compare($this->localVersion
, $this->latestVersion
) < 0) {
169 return $this->latestVersion
;
176 * Alert the site admin of new versions of CiviCRM
177 * Show the message once a day
179 public function versionAlert() {
180 if (CRM_Core_Permission
::check('administer CiviCRM') && $this->newerVersion()
181 && CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
, 'versionAlert', NULL, TRUE)) {
182 $session = CRM_Core_Session
::singleton();
183 if ($session->timer('version_alert', 24 * 60 * 60)) {
184 $msg = ts('A newer version of CiviCRM is available: %1', array(1 => $this->latestVersion
))
185 . '<br />' . ts('<a href="%1">Download Now</a>', array(1 => 'http://civicrm.org/download'));
186 $session->setStatus($msg, ts('Update Available'));
192 * Get active payment processor types
194 private function payProcStats() {
195 $dao = new CRM_Financial_DAO_PaymentProcessor
;
200 // Get title and id for all processor types
201 $ppTypeNames = CRM_Core_PseudoConstant
::paymentProcessorType();
203 while ($dao->fetch()) {
204 $ppTypes[] = $ppTypeNames[$dao->payment_processor_type_id
];
206 // add the .-separated list of the processor types
207 $this->stats
['PPTypes'] = implode(',', array_unique($ppTypes));
212 * Fetch counts from entity tables
213 * Add info to the 'entities' array
215 private function entityStats() {
217 'CRM_Activity_DAO_Activity' => 'is_test = 0',
218 'CRM_Case_DAO_Case' => 'is_deleted = 0',
219 'CRM_Contact_DAO_Contact' => 'is_deleted = 0',
220 'CRM_Contact_DAO_Relationship' => NULL,
221 'CRM_Campaign_DAO_Campaign' => NULL,
222 'CRM_Contribute_DAO_Contribution' => 'is_test = 0',
223 'CRM_Contribute_DAO_ContributionPage' => 'is_active = 1',
224 'CRM_Contribute_DAO_ContributionProduct' => NULL,
225 'CRM_Contribute_DAO_Widget' => 'is_active = 1',
226 'CRM_Core_DAO_Discount' => NULL,
227 'CRM_Price_DAO_PriceSetEntity' => NULL,
228 'CRM_Core_DAO_UFGroup' => 'is_active = 1',
229 'CRM_Event_DAO_Event' => 'is_active = 1',
230 'CRM_Event_DAO_Participant' => 'is_test = 0',
231 'CRM_Friend_DAO_Friend' => 'is_active = 1',
232 'CRM_Grant_DAO_Grant' => NULL,
233 'CRM_Mailing_DAO_Mailing' => 'is_completed = 1',
234 'CRM_Member_DAO_Membership' => 'is_test = 0',
235 'CRM_Member_DAO_MembershipBlock' => 'is_active = 1',
236 'CRM_Pledge_DAO_Pledge' => 'is_test = 0',
237 'CRM_Pledge_DAO_PledgeBlock' => NULL,
239 foreach ($tables as $daoName => $where) {
242 $dao->whereAdd($where);
244 $short_name = substr($daoName, strrpos($daoName, '_') +
1);
245 $this->stats
['entities'][] = array(
246 'name' => $short_name,
247 'size' => $dao->count(),
253 * Fetch stats about enabled components/extensions
254 * Add info to the 'extensions' array
256 private function extensionStats() {
258 $config = CRM_Core_Config
::singleton();
259 foreach ($config->enableComponents
as $comp) {
260 $this->stats
['extensions'][] = array(
261 'name' => 'org.civicrm.component.' . strtolower($comp),
263 'version' => $this->stats
['version'],
266 // Contrib extensions
267 $mapper = CRM_Extension_System
::singleton()->getMapper();
268 $dao = new CRM_Core_DAO_Extension();
270 while ($dao->fetch()) {
271 $info = $mapper->keyToInfo($dao->full_name
);
272 $this->stats
['extensions'][] = array(
273 'name' => $dao->full_name
,
274 'enabled' => $dao->is_active
,
275 'version' => isset($info->version
) ?
$info->version
: NULL,
281 * Send the request to civicrm.org
282 * Set timeout and suppress errors
284 private function pingBack() {
285 ini_set('default_socket_timeout', self
::CHECK_TIMEOUT
);
289 'header' => 'Content-type: application/x-www-form-urlencoded',
290 'content' => http_build_query($this->stats
),
293 $ctx = stream_context_create($params);
294 $this->latestVersion
= @file_get_contents
(self
::LATEST_VERSION_AT
, FALSE, $ctx);
295 if (!preg_match('/^\d+\.\d+\.\d+$/', $this->latestVersion
)) {
296 $this->latestVersion
= NULL;
299 $this->latestVersion
= trim($this->latestVersion
);
301 ini_restore('default_socket_timeout');