Knah-Tsaeb/MyShaarli
Knah-Tsaeb/MyShaarli
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Merge pull request #816 from ArthurHoaro/project/master-version

Browse source 
Use 'dev' version on the master branch
This commit is contained in:
ArthurHoaro 2017-03-22 18:50:33 +01:00 committed by GitHub
commit 64c34078e4
5 changed files with 123 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

45
application/ApplicationUtils.php
View file

@ -4,9 +4,13 @@
*/
class ApplicationUtils
{
/**
* @var string File containing the current version
*/
public static $VERSION_FILE = 'shaarli_version.php';
private static $GIT_URL = 'https://raw.githubusercontent.com/shaarli/Shaarli';
private static $GIT_BRANCHES = array('master', 'stable');
private static $VERSION_FILE = 'shaarli_version.php';
private static $GIT_BRANCHES = array('latest', 'stable');
private static $VERSION_START_TAG = '<?php /* ';
private static $VERSION_END_TAG = ' */ ?>';
@ -29,6 +33,30 @@ public static function getLatestGitVersionCode($url, $timeout=2)
return false;
}
return $data;
}
/**
* Retrieve the version from a remote URL or a file.
*
* @param string $remote URL or file to fetch.
* @param int $timeout For URLs fetching.
*
* @return bool|string The version or false if it couldn't be retrieved.
*/
public static function getVersion($remote, $timeout = 2)
{
if (startsWith($remote, 'http')) {
if (($data = static::getLatestGitVersionCode($remote, $timeout)) === false) {
return false;
}
} else {
if (! is_file($remote)) {
return false;
}
$data = file_get_contents($remote);
}
return str_replace(
array(self::$VERSION_START_TAG, self::$VERSION_END_TAG, PHP_EOL),
array('', '', ''),
@ -65,13 +93,10 @@ public static function checkUpdate($currentVersion,
$isLoggedIn,
$branch='stable')
{
if (! $isLoggedIn) {
// Do not check versions for visitors
return false;
}
if (empty($enableCheck)) {
// Do not check if the user doesn't want to
// Do not check versions for visitors
// Do not check if the user doesn't want to
// Do not check with dev version
if (! $isLoggedIn || empty($enableCheck) || $currentVersion === 'dev') {
return false;
}
@ -93,7 +118,7 @@ public static function checkUpdate($currentVersion,
// Late Static Binding allows overriding within tests
// See http://php.net/manual/en/language.oop5.late-static-bindings.php
$latestVersion = static::getLatestGitVersionCode(
$latestVersion = static::getVersion(
self::$GIT_URL . '/' . $branch . '/' . self::$VERSION_FILE
);

44
application/Updater.php
View file

@ -396,6 +396,50 @@ public function updateMethodAtomDefault()
return true;
}
/**
* Update updates.check_updates_branch setting.
*
* If the current major version digit matches the latest branch
* major version digit, we set the branch to `latest`,
* otherwise we'll check updates on the `stable` branch.
*
* No update required for the dev version.
*
* Note: due to hardcoded URL and lack of dependency injection, this is not unit testable.
*
* FIXME! This needs to be removed when we switch to first digit major version
* instead of the second one since the versionning process will change.
*/
public function updateMethodCheckUpdateRemoteBranch()
{
if (shaarli_version === 'dev' || $this->conf->get('updates.check_updates_branch') === 'latest') {
return true;
}
// Get latest branch major version digit
$latestVersion = ApplicationUtils::getLatestGitVersionCode(
'https://raw.githubusercontent.com/shaarli/Shaarli/latest/shaarli_version.php',
5
);
if (preg_match('/(\d+)\.\d+$/', $latestVersion, $matches) === false) {
return false;
}
$latestMajor = $matches[1];
// Get current major version digit
preg_match('/(\d+)\.\d+$/', shaarli_version, $matches);
$currentMajor = $matches[1];
if ($currentMajor === $latestMajor) {
$branch = 'latest';
} else {
$branch = 'stable';
}
$this->conf->set('updates.check_updates_branch', $branch);
$this->conf->write($this->isLoggedIn);
return true;
}
}
/**

7
index.php
View file

@ -1,8 +1,6 @@
<?php
/**
* Shaarli v0.8.3 - Shaare your links...
*
* The personal, minimalist, super-fast, database free, bookmarking service.
* Shaarli - The personal, minimalist, super-fast, database free, bookmarking service.
*
* Friendly fork by the Shaarli community:
* - https://github.com/shaarli/Shaarli
@ -25,7 +23,6 @@
/*
* PHP configuration
*/
define('shaarli_version', '0.8.2');
// http://server.com/x/shaarli --> /shaarli/
define('WEB_PATH', substr($_SERVER['REQUEST_URI'], 0, 1+strrpos($_SERVER['REQUEST_URI'], '/', 0)));
@ -90,6 +87,8 @@
exit;
}
define('shaarli_version', ApplicationUtils::getVersion(__DIR__ .'/'. ApplicationUtils::$VERSION_FILE));
// Force cookie path (but do not change lifetime)
$cookie = session_get_cookie_params();
$cookiedir = '';

2
shaarli_version.php
View file

@ -1 +1 @@
<?php /* 0.8.3 */ ?>
<?php /* dev */ ?>

47
tests/ApplicationUtilsTest.php
View file

@ -17,7 +17,7 @@ class FakeApplicationUtils extends ApplicationUtils
/**
* Toggle HTTP requests, allow overriding the version code
*/
public static function getLatestGitVersionCode($url, $timeout=0)
public static function getVersion($url, $timeout=0)
{
return self::$VERSION_CODE;
}
@ -44,18 +44,28 @@ public function setUp()
}
}
/**
* Remove test version file if it exists
*/
public function tearDown()
{
if (is_file('sandbox/version.php')) {
unlink('sandbox/version.php');
}
}
/**
* Retrieve the latest version code available on Git
*
* Expected format: Semantic Versioning - major.minor.patch
*/
public function testGetLatestGitVersionCode()
public function testGetVersionCode()
{
$testTimeout = 10;
$this->assertEquals(
'0.5.4',
ApplicationUtils::getLatestGitVersionCode(
ApplicationUtils::getVersion(
'https://raw.githubusercontent.com/shaarli/Shaarli/'
.'v0.5.4/shaarli_version.php',
$testTimeout
@ -63,7 +73,7 @@ public function testGetLatestGitVersionCode()
);
$this->assertRegExp(
self::$versionPattern,
ApplicationUtils::getLatestGitVersionCode(
ApplicationUtils::getVersion(
'https://raw.githubusercontent.com/shaarli/Shaarli/'
.'master/shaarli_version.php',
$testTimeout
@ -72,14 +82,26 @@ public function testGetLatestGitVersionCode()
}
/**
* Attempt to retrieve the latest version from an invalid URL
* Attempt to retrieve the latest version from an invalid File
*/
public function testGetLatestGitVersionCodeInvalidUrl()
public function testGetVersionCodeFromFile()
{
file_put_contents('sandbox/version.php', '<?php /* 1.2.3 */ ?>'. PHP_EOL);
$this->assertEquals(
'1.2.3',
ApplicationUtils::getVersion('sandbox/version.php', 1)
);
}
/**
* Attempt to retrieve the latest version from an invalid File
*/
public function testGetVersionCodeInvalidFile()
{
$oldlog = ini_get('error_log');
ini_set('error_log', '/dev/null');
$this->assertFalse(
ApplicationUtils::getLatestGitVersionCode('htttp://null.io', 1)
ApplicationUtils::getVersion('idontexist', 1)
);
ini_set('error_log', $oldlog);
}
@ -332,4 +354,15 @@ public function testCheckCurrentResourcePermissionsErrors()
ApplicationUtils::checkResourcePermissions($conf)
);
}
/**
* Check update with 'dev' as curent version (master branch).
* It should always return false.
*/
public function testCheckUpdateDev()
{
$this->assertFalse(
ApplicationUtils::checkUpdate('dev', self::$testUpdateFile, 100, true, true)
);
}
}