Updates::notification() - Code Metrics - Inspection of "allow to sepecify last security release for multip..." - EGroupware/egroupware - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 16.1 ( 263fa0...62d2b3 )

by Ralf

created 2018-01-21 09:31 UTC

Updates::notification() C

↳ Parent: Updates

Complexity

Conditions	11
Paths	16

Size

Total Lines	44
Code Lines	26

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	11
eloc	26
nc	16
nop	0
dl	0
loc	44
rs	5.2653
c	0
b	0
f	0

How to fix Complexity

<?php
/**
 * EGroupware API - Check for updates
 *
 * @link http://www.egroupware.org
 * @author Ralf Becker <RalfBecker-AT-outdoor-training.de>
 * @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
 * @package api
 * @subpackage framework
 * @access public
 */

namespace EGroupware\Api\Framework;

use EGroupware\Api\Html;
use EGroupware\Api\Cache;
use EGroupware\Api;

/**
 * Check for updates
 *
 * https://www.egroupware.org/currentversion
 *
 * Contains multiple lines with version numbers:
 * 1. current stable version      eg. 17.1.20180118
 * 2. last stable security update eg. 17.1.20180118
 * 3. last old-stable security up.eg. 16.1.20171106 (only if that is still secure!)
 * 4. further old secure versions, if available
 */
class Updates
{
	/**
	 * URL to check for security or maintenance updates
	 */
	const CURRENT_VERSION_URL = 'https://www.egroupware.org/currentversion';
	/**
	 * How long to cache (in secs) / often to check for updates
	 */
	const VERSIONS_CACHE_TIMEOUT = 7200;
	/**
	 * After how many days of not applied security updates, start warning non-admins too
	 */
	const WARN_USERS_DAYS = 5;

	/**
	 * Get versions of available updates
	 *
	 * @param string $api =null major api version to return security for, default latest
	 * @return array verions for keys "current" and "security"
	 */
	public static function available($api=null)
	{
		$versions = Cache::getTree(__CLASS__, 'versions', function() use ($api)
		{
			$versions = array();
			$security = null;
			if (($remote = file_get_contents(self::CURRENT_VERSION_URL, false, Api\Framework::proxy_context())))
			{
				$all_versions = explode("\n", $remote);
				$current = array_shift($all_versions);
				if (empty($all_versions)) $all_versions = array($current);
				// find latest security release for optional API version
				foreach(array_reverse($all_versions) as $security)
				{
					if (isset($api) && $api === substr($security, 0, strlen($api))) break;
				}
				$versions = array(
					'current'  => $current,		// last maintenance update
					'security' => $security,	// last security update
				);
			}
			return $versions;
		}, array(), self::VERSIONS_CACHE_TIMEOUT);

		//error_log(__METHOD__."($api) returning ".array2string($versions));
		return $versions;
	}

	/**
	 * Check update status
	 *
	 * @return string
	 * @todo Check from client-side, if server-side check fails
	 */
	public static function notification()
	{
		$api = self::api_version();
		$api_major = $matches = null;
		if (preg_match('/^(\d+\.\d+)\./', $api, $matches))
		{
			$api_major = $matches[1];
		}

		$versions = self::available($api_major);

		if ($versions)
		{
			if (version_compare($api, $versions['security'], '<'))
			{
				if (!$GLOBALS['egw_info']['user']['apps']['admin'] && !self::update_older($versions['security'], self::WARN_USERS_DAYS))
				{
					return null;
				}
				return Html::a_href(Html::image('api', 'security-update', lang('EGroupware security update %1 needs to be installed!', $versions['security'])),
					'http://www.egroupware.org/changelog', null, ' target="_blank"');
			}
			if ($GLOBALS['egw_info']['user']['apps']['admin'] && version_compare($api, $versions['current'], '<'))
			{
				$msg = substr($versions['current'], 0, strlen($api_major)) == $api_major ?
					lang('EGroupware maintenance update %1 available', $versions['current']) :
					lang('New EGroupware release %1 available', $versions['current']);
				return Html::a_href(Html::image('api', 'update', $msg),
					'http://www.egroupware.org/changelog', null, ' target="_blank"');
			}
		}
		elseif ($GLOBALS['egw_info']['user']['apps']['admin'])
		{
			$error = lang('Automatic update check failed, you need to check manually!');
			if (!ini_get('allow_url_fopen'))
			{
				$error .= "\n".lang('%1 setting "%2" = %3 disallows access via http!',
					'php.ini', 'allow_url_fopen', array2string(ini_get('allow_url_fopen')));
			}
			return Html::a_href(Html::image('api', 'update', $error),
				'http://www.egroupware.org/changelog', null, ' target="_blank" data-api-version="'.$api.'"');
		}
		return null;
	}

	/**
	 * Check if version is older then $days days
	 *
	 * @param string $version eg. "14.1.20140715" last part is checked (only if > 20140000!)
	 * @param int $days
	 * @return boolean
	 */
	protected static function update_older($version, $days)
	{
		list(,,$date) = explode('.', $version);
		if ($date < 20140000) return false;
		$version_timestamp = mktime(0, 0, 0, (int)substr($date, 4, 2), (int)substr($date, -2), (int)substr($date, 0, 4));

		return (time() - $version_timestamp) / 86400 > $days;
	}

	/**
	 * Get current API version from api/setup/setup.inc.php "maintenance_release" or database, whichever is bigger
	 *
	 * @param string &$changelog on return path to changelog
	 * @return string
	 */
	public static function api_version(&$changelog=null)
	{
		$changelog = EGW_SERVER_ROOT.'/doc/rpm-build/debian.changes';

		return Cache::getTree(__CLASS__, 'api_version', function()
		{
			$version = preg_replace('/[^0-9.]/', '', $GLOBALS['egw_info']['server']['versions']['api']);

			if (empty($GLOBALS['egw_info']['server']['versions']['maintenance_release']))
			{
				$setup_info = null;
				include (EGW_SERVER_ROOT.'/api/setup/setup.inc.php');
				$GLOBALS['egw_info']['server']['versions'] += $setup_info['api']['versions'];
				unset($setup_info);
			}
			if (version_compare($version, $GLOBALS['egw_info']['server']['versions']['maintenance_release'], '<'))
			{
				$version = $GLOBALS['egw_info']['server']['versions']['maintenance_release'];
			}
			return $version;
		}, array(), 300);
	}
}


1			<?php
2			/**
3			* EGroupware API - Check for updates
4			*
5			* @link http://www.egroupware.org
6			* @author Ralf Becker <RalfBecker-AT-outdoor-training.de>
7			* @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
8			* @package api
9			* @subpackage framework
10			* @access public
11			*/
12
13			namespace EGroupware\Api\Framework;
14
15			use EGroupware\Api\Html;
16			use EGroupware\Api\Cache;
17			use EGroupware\Api;
18
19			/**
20			* Check for updates
21			*
22			* https://www.egroupware.org/currentversion
23			*
24			* Contains multiple lines with version numbers:
25			* 1. current stable version eg. 17.1.20180118
26			* 2. last stable security update eg. 17.1.20180118
27			* 3. last old-stable security up.eg. 16.1.20171106 (only if that is still secure!)
28			* 4. further old secure versions, if available
29			*/
30			class Updates
31			{
32			/**
33			* URL to check for security or maintenance updates
34			*/
35			const CURRENT_VERSION_URL = 'https://www.egroupware.org/currentversion';
36			/**
37			* How long to cache (in secs) / often to check for updates
38			*/
39			const VERSIONS_CACHE_TIMEOUT = 7200;
40			/**
41			* After how many days of not applied security updates, start warning non-admins too
42			*/
43			const WARN_USERS_DAYS = 5;
44
45			/**
46			* Get versions of available updates
47			*
48			* @param string $api =null major api version to return security for, default latest
49			* @return array verions for keys "current" and "security"
50			*/
51			public static function available($api=null)
52			{
53			$versions = Cache::getTree(__CLASS__, 'versions', function() use ($api)
54			{
55			$versions = array();
56			$security = null;
57			if (($remote = file_get_contents(self::CURRENT_VERSION_URL, false, Api\Framework::proxy_context())))
58			{
59			$all_versions = explode("\n", $remote);
60			$current = array_shift($all_versions);
61			if (empty($all_versions)) $all_versions = array($current);
62			// find latest security release for optional API version
63			foreach(array_reverse($all_versions) as $security)
64			{
65			if (isset($api) && $api === substr($security, 0, strlen($api))) break;
66			}
67			$versions = array(
68			'current' => $current, // last maintenance update
69			'security' => $security, // last security update
70			);
71			}
72			return $versions;
73			}, array(), self::VERSIONS_CACHE_TIMEOUT);
74
75			//error_log(__METHOD__."($api) returning ".array2string($versions));
76			return $versions;
77			}
78
79			/**
80			* Check update status
81			*
82			* @return string
83			* @todo Check from client-side, if server-side check fails
84			*/
85			public static function notification()
86			{
87			$api = self::api_version();
88			$api_major = $matches = null;
89			if (preg_match('/^(\d+\.\d+)\./', $api, $matches))
90			{
91			$api_major = $matches[1];
92			}
93
94			$versions = self::available($api_major);
95
96			if ($versions)
97			{
98			if (version_compare($api, $versions['security'], '<'))
99			{
100			if (!$GLOBALS['egw_info']['user']['apps']['admin'] && !self::update_older($versions['security'], self::WARN_USERS_DAYS))
101			{
102			return null;
103			}
104			return Html::a_href(Html::image('api', 'security-update', lang('EGroupware security update %1 needs to be installed!', $versions['security'])),
105			'http://www.egroupware.org/changelog', null, ' target="_blank"');
106			}
107			if ($GLOBALS['egw_info']['user']['apps']['admin'] && version_compare($api, $versions['current'], '<'))
108			{
109			$msg = substr($versions['current'], 0, strlen($api_major)) == $api_major ?
110			lang('EGroupware maintenance update %1 available', $versions['current']) :
111			lang('New EGroupware release %1 available', $versions['current']);
112			return Html::a_href(Html::image('api', 'update', $msg),
113			'http://www.egroupware.org/changelog', null, ' target="_blank"');
114			}
115			}
116			elseif ($GLOBALS['egw_info']['user']['apps']['admin'])
117			{
118			$error = lang('Automatic update check failed, you need to check manually!');
119			if (!ini_get('allow_url_fopen'))
120			{
121			$error .= "\n".lang('%1 setting "%2" = %3 disallows access via http!',
122			'php.ini', 'allow_url_fopen', array2string(ini_get('allow_url_fopen')));
123			}
124			return Html::a_href(Html::image('api', 'update', $error),
125			'http://www.egroupware.org/changelog', null, ' target="_blank" data-api-version="'.$api.'"');
126			}
127			return null;
128			}
129
130			/**
131			* Check if version is older then $days days
132			*
133			* @param string $version eg. "14.1.20140715" last part is checked (only if > 20140000!)
134			* @param int $days
135			* @return boolean
136			*/
137			protected static function update_older($version, $days)
138			{
139			list(,,$date) = explode('.', $version);
140			if ($date < 20140000) return false;
141			$version_timestamp = mktime(0, 0, 0, (int)substr($date, 4, 2), (int)substr($date, -2), (int)substr($date, 0, 4));
142
143			return (time() - $version_timestamp) / 86400 > $days;
144			}
145
146			/**
147			* Get current API version from api/setup/setup.inc.php "maintenance_release" or database, whichever is bigger
148			*
149			* @param string &$changelog on return path to changelog
150			* @return string
151			*/
152			public static function api_version(&$changelog=null)
153			{
154			$changelog = EGW_SERVER_ROOT.'/doc/rpm-build/debian.changes';
155
156			return Cache::getTree(__CLASS__, 'api_version', function()
157			{
158			$version = preg_replace('/[^0-9.]/', '', $GLOBALS['egw_info']['server']['versions']['api']);
159
160			if (empty($GLOBALS['egw_info']['server']['versions']['maintenance_release']))
161			{
162			$setup_info = null;
163			include (EGW_SERVER_ROOT.'/api/setup/setup.inc.php');
164			$GLOBALS['egw_info']['server']['versions'] += $setup_info['api']['versions'];
165			unset($setup_info);
166			}
167			if (version_compare($version, $GLOBALS['egw_info']['server']['versions']['maintenance_release'], '<'))
168			{
169			$version = $GLOBALS['egw_info']['server']['versions']['maintenance_release'];
170			}
171			return $version;
172			}, array(), 300);
173			}
174			}
175

EGroupware / egroupware

Push — 16.1 ( 263fa0...62d2b3 )

Updates::notification() C

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like