CRM/Utils/VersionCheck.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.3                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   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-2013
  32  * $Id: $
  33  *
  34  */
  35 class CRM_Utils_VersionCheck {
  36   CONST
  37     LATEST_VERSION_AT = 'http://latest.civicrm.org/stable.php',
  38     // timeout for when the connection or the server is slow
  39     CHECK_TIMEOUT = 5,
  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;
  46
  47   /**
  48    * We only need one instance of this object, so we use the
  49    * singleton pattern and cache the instance in this variable
  50    *
  51    * @var object
  52    * @static
  53    */
  54   static private $_singleton = NULL;
  55
  56   /**
  57    * The version of the current (local) installation
  58    *
  59    * @var string
  60    */
  61   public $localVersion = NULL;
  62
  63   /**
  64    * The latest version of CiviCRM
  65    *
  66    * @var string
  67    */
  68   public $latestVersion = NULL;
  69
  70   /**
  71    * Pingback params
  72    *
  73    * @var string
  74    */
  75   protected $stats = array();
  76
  77   /**
  78    * Class constructor
  79    *
  80    * @access private
  81    */
  82   function __construct() {
  83     global $civicrm_root;
  84     $config = CRM_Core_Config::singleton();
  85
  86     $localfile = $civicrm_root . DIRECTORY_SEPARATOR . self::LOCALFILE_NAME;
  87     $cachefile = $config->uploadDir . self::CACHEFILE_NAME;
  88
  89     if (file_exists($localfile)) {
  90       require_once ($localfile);
  91       if (function_exists('civicrmVersion')) {
  92         $info = civicrmVersion();
  93         $this->localVersion = trim($info['version']);
  94       }
  95     }
  96     if ($config->versionCheck) {
  97       $expiryTime = time() - self::CACHEFILE_EXPIRE;
  98
  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));
 103       }
 104       else {
 105         $siteKey = md5(defined('CIVICRM_SITE_KEY') ? CIVICRM_SITE_KEY : '');
 106
 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*'),
 117         );
 118
 119         // Add usage stats
 120         $this->payProcStats();
 121         $this->entityStats();
 122         $this->extensionStats();
 123
 124         // Get the latest version and send site info
 125         $this->pingBack();
 126
 127         // Update cache file
 128         if ($this->latestVersion) {
 129           $fp = @fopen($cachefile, 'w');
 130           if (!$fp) {
 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');
 135             }
 136             return;
 137           }
 138           fwrite($fp, $this->latestVersion);
 139           fclose($fp);
 140         }
 141       }
 142     }
 143   }
 144
 145   /**
 146    * Static instance provider
 147    *
 148    * Method providing static instance of CRM_Utils_VersionCheck,
 149    * as in Singleton pattern
 150    *
 151    * @return CRM_Utils_VersionCheck
 152    */
 153   static function &singleton() {
 154     if (!isset(self::$_singleton)) {
 155       self::$_singleton = new CRM_Utils_VersionCheck();
 156     }
 157     return self::$_singleton;
 158   }
 159
 160   /**
 161    * Get the latest version number if it's newer than the local one
 162    *
 163    * @return string|null
 164    * Returns the newer version's number, or null if the versions are equal
 165    */
 166   public function newerVersion() {
 167     if ($this->latestVersion) {
 168       if (version_compare($this->localVersion, $this->latestVersion) < 0) {
 169         return $this->latestVersion;
 170       }
 171     }
 172     return NULL;
 173   }
 174
 175   /**
 176    * Alert the site admin of new versions of CiviCRM
 177    * Show the message once a day
 178    */
 179   public function versionAlert() {
 180     if (CRM_Core_Permission::check('administer CiviCRM') && $this->newerVersion()) {
 181       $session = CRM_Core_Session::singleton();
 182       if ($session->timer('version_alert', 24 * 60 * 60)) {
 183         $msg = ts('A newer version of CiviCRM is available: %1', array(1 => $this->latestVersion))
 184         . '<br />' . ts('<a href="%1">Download Now</a>', array(1 => 'http://civicrm.org/download'));
 185         $session->setStatus($msg, ts('Update Available'));
 186       }
 187     }
 188   }
 189
 190   /**
 191    * Get active payment processor types
 192    */
 193   private function payProcStats() {
 194     $dao = new CRM_Financial_DAO_PaymentProcessor;
 195     $dao->is_active = 1;
 196     $dao->find();
 197     $ppTypes = array();
 198
 199     // Get title and id for all processor types
 200     $ppTypeNames = CRM_Core_PseudoConstant::paymentProcessorType();
 201
 202     while ($dao->fetch()) {
 203       $ppTypes[] = $ppTypeNames[$dao->payment_processor_type_id];
 204     }
 205     // add the .-separated list of the processor types
 206     $this->stats['PPTypes'] = implode(',', array_unique($ppTypes));
 207
 208   }
 209
 210   /**
 211    * Fetch counts from entity tables
 212    * Add info to the 'entities' array
 213    */
 214   private function entityStats() {
 215     $tables = array(
 216       'CRM_Activity_DAO_Activity' => 'is_test = 0',
 217       'CRM_Case_DAO_Case' => 'is_deleted = 0',
 218       'CRM_Contact_DAO_Contact' => 'is_deleted = 0',
 219       'CRM_Contact_DAO_Relationship' => NULL,
 220       'CRM_Campaign_DAO_Campaign' => NULL,
 221       'CRM_Contribute_DAO_Contribution' => 'is_test = 0',
 222       'CRM_Contribute_DAO_ContributionPage' => 'is_active = 1',
 223       'CRM_Contribute_DAO_ContributionProduct' => NULL,
 224       'CRM_Contribute_DAO_Widget' => 'is_active = 1',
 225       'CRM_Core_DAO_Discount' => NULL,
 226       'CRM_Price_DAO_SetEntity' => NULL,
 227       'CRM_Core_DAO_UFGroup' => 'is_active = 1',
 228       'CRM_Event_DAO_Event' => 'is_active = 1',
 229       'CRM_Event_DAO_Participant' => 'is_test = 0',
 230       'CRM_Friend_DAO_Friend' => 'is_active = 1',
 231       'CRM_Grant_DAO_Grant' => NULL,
 232       'CRM_Mailing_DAO_Mailing' => 'is_completed = 1',
 233       'CRM_Member_DAO_Membership' => 'is_test = 0',
 234       'CRM_Member_DAO_MembershipBlock' => 'is_active = 1',
 235       'CRM_Pledge_DAO_Pledge' => 'is_test = 0',
 236       'CRM_Pledge_DAO_PledgeBlock' => NULL,
 237     );
 238     foreach ($tables as $daoName => $where) {
 239       $dao = new $daoName;
 240       if ($where) {
 241         $dao->whereAdd($where);
 242       }
 243       $short_name = substr($daoName, strrpos($daoName, '_') + 1);
 244       $this->stats['entities'][] = array(
 245         'name' => $short_name,
 246         'size' => $dao->count(),
 247       );
 248     }
 249   }
 250
 251   /**
 252    * Fetch stats about enabled components/extensions
 253    * Add info to the 'extensions' array
 254    */
 255   private function extensionStats() {
 256     // Core components
 257     $config = CRM_Core_Config::singleton();
 258     foreach ($config->enableComponents as $comp) {
 259       $this->stats['extensions'][] = array(
 260         'name' => 'org.civicrm.component.' . strtolower($comp),
 261         'enabled' => 1,
 262         'version' => $this->stats['version'],
 263       );
 264     }
 265     // Contrib extensions
 266     $mapper = CRM_Extension_System::singleton()->getMapper();
 267     $dao = new CRM_Core_DAO_Extension();
 268     $dao->find();
 269     while ($dao->fetch()) {
 270       $info = $mapper->keyToInfo($dao->full_name);
 271       $this->stats['extensions'][] = array(
 272         'name' => $dao->full_name,
 273         'enabled' => $dao->is_active,
 274         'version' => isset($info->version) ? $info->version : NULL,
 275       );
 276     }
 277   }
 278
 279   /**
 280    * Send the request to civicrm.org
 281    * Set timeout and suppress errors
 282    */
 283   private function pingBack() {
 284     ini_set('default_socket_timeout', self::CHECK_TIMEOUT);
 285     $params = array(
 286       'http' => array(
 287         'method' => 'POST',
 288         'header' => 'Content-type: application/x-www-form-urlencoded',
 289         'content' => http_build_query($this->stats),
 290       ),
 291     );
 292     $ctx = stream_context_create($params);
 293     $this->latestVersion = @file_get_contents(self::LATEST_VERSION_AT, FALSE, $ctx);
 294     if (!preg_match('/^\d+\.\d+\.\d+$/', $this->latestVersion)) {
 295       $this->latestVersion = NULL;
 296     }
 297     else {
 298       $this->latestVersion = trim($this->latestVersion);
 299     }
 300     ini_restore('default_socket_timeout');
 301   }
 302
 303 }