_Shaarli is a minimalist delicious clone that you can install on your own server._
_It is designed to be personal (single-user), fast and handy._
-[](https://travis-ci.org/shaarli/Shaarli)
+[](https://github.com/shaarli/Shaarli/releases/tag/v0.7.1)
[](https://travis-ci.org/shaarli/Shaarli)
-[](https://github.com/shaarli/Shaarli/releases/latest/)
-[](https://hub.docker.com/r/shaarli/shaarli/)
+•
+[](https://github.com/shaarli/Shaarli/releases/tag/v0.8.4)
+[](https://travis-ci.org/shaarli/Shaarli)
+•
+[](https://github.com/shaarli/Shaarli)
+[](https://travis-ci.org/shaarli/Shaarli)
[](https://gitter.im/shaarli/Shaarli)
[](https://www.bountysource.com/teams/shaarli/issues)
+[](https://hub.docker.com/r/shaarli/shaarli/)
## Quickstart
- [Wiki/documentation](https://github.com/shaarli/Shaarli/wiki)
*/
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 = ' */ ?>';
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('', '', ''),
$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;
}
// 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
);
}
$this->tpl->assign('shaarlititle', $this->conf->get('general.title', 'Shaarli'));
$this->tpl->assign('openshaarli', $this->conf->get('security.open_shaarli', false));
- $this->tpl->assign('showatom', $this->conf->get('feed.show_atom', false));
+ $this->tpl->assign('showatom', $this->conf->get('feed.show_atom', true));
+ $this->tpl->assign('feed_type', $this->conf->get('feed.show_atom', true) !== false ? 'atom' : 'rss');
$this->tpl->assign('hide_timestamps', $this->conf->get('privacy.hide_timestamps', false));
$this->tpl->assign('token', getToken($this->conf));
// To be removed with a proper theme configuration.
$this->conf->set('plugins.PIWIK_URL', 'http://'. $this->conf->get('plugins.PIWIK_URL'));
$this->conf->write($this->isLoggedIn);
+
+ return true;
+ }
+
+ /**
+ * Use ATOM feed as default.
+ */
+ public function updateMethodAtomDefault()
+ {
+ if (!$this->conf->exists('feed.show_atom') || $this->conf->get('feed.show_atom') === true) {
+ return true;
+ }
+
+ $this->conf->set('feed.show_atom', true);
+ $this->conf->write($this->isLoggedIn);
+
+ 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;
}
}
$data = str_replace(self::getPhpSuffix(), '', $data);
$data = json_decode($data, true);
if ($data === null) {
- $error = json_last_error();
- throw new \Exception('An error occurred while parsing JSON file: error code #'. $error);
+ $errorCode = json_last_error();
+ $error = 'An error occurred while parsing JSON configuration file ('. $filepath .'): error code #';
+ $error .= $errorCode. '<br>➜ <code>' . json_last_error_msg() .'</code>';
+ if ($errorCode === JSON_ERROR_SYNTAX) {
+ $error .= '<br>Please check your JSON syntax (without PHP comment tags) using a JSON lint tool such as ';
+ $error .= '<a href="http://jsonlint.com/">jsonlint.com</a>.';
+ }
+ throw new \Exception($error);
}
return $data;
}
*/
protected function load()
{
- $this->loadedConfig = $this->configIO->read($this->getConfigFileExt());
+ try {
+ $this->loadedConfig = $this->configIO->read($this->getConfigFileExt());
+ } catch (\Exception $e) {
+ die($e->getMessage());
+ }
$this->setDefaultValues();
}
$this->setEmpty('updates.check_updates_interval', 86400);
$this->setEmpty('feed.rss_permalinks', true);
- $this->setEmpty('feed.show_atom', false);
+ $this->setEmpty('feed.show_atom', true);
$this->setEmpty('privacy.default_private_links', false);
$this->setEmpty('privacy.hide_public_links', false);
<?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
/*
* 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)));
exit;
}
+define('shaarli_version', ApplicationUtils::getVersion(__DIR__ .'/'. ApplicationUtils::$VERSION_FILE));
+
// Force cookie path (but do not change lifetime)
$cookie = session_get_cookie_params();
$cookiedir = '';
-<?php /* 0.8.3 */ ?>
+<?php /* dev */ ?>
/**
* 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;
}
}
}
+ /**
+ * 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
);
$this->assertRegExp(
self::$versionPattern,
- ApplicationUtils::getLatestGitVersionCode(
+ ApplicationUtils::getVersion(
'https://raw.githubusercontent.com/shaarli/Shaarli/'
.'master/shaarli_version.php',
$testTimeout
}
/**
- * Attempt to retrieve the latest version from an invalid URL
+ * Attempt to retrieve the latest version from an invalid File
+ */
+ 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 testGetLatestGitVersionCodeInvalidUrl()
+ 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);
}
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)
+ );
+ }
}
$this->assertTrue($updater->updateMethodPiwikUrl());
$this->assertEquals($url, $this->conf->get('plugins.PIWIK_URL'));
}
+
+ /**
+ * Test updateMethodAtomDefault with show_atom set to false
+ * => update to true.
+ */
+ public function testUpdateMethodAtomDefault()
+ {
+ $sandboxConf = 'sandbox/config';
+ copy(self::$configFile . '.json.php', $sandboxConf . '.json.php');
+ $this->conf = new ConfigManager($sandboxConf);
+ $this->conf->set('feed.show_atom', false);
+ $updater = new Updater([], [], $this->conf, true);
+ $this->assertTrue($updater->updateMethodAtomDefault());
+ $this->assertTrue($this->conf->get('feed.show_atom'));
+ // reload from file
+ $this->conf = new ConfigManager($sandboxConf);
+ $this->assertTrue($this->conf->get('feed.show_atom'));
+ }
+ /**
+ * Test updateMethodAtomDefault with show_atom not set.
+ * => nothing to do
+ */
+ public function testUpdateMethodAtomDefaultNoExist()
+ {
+ $sandboxConf = 'sandbox/config';
+ copy(self::$configFile . '.json.php', $sandboxConf . '.json.php');
+ $this->conf = new ConfigManager($sandboxConf);
+ $updater = new Updater([], [], $this->conf, true);
+ $this->assertTrue($updater->updateMethodAtomDefault());
+ $this->assertTrue($this->conf->get('feed.show_atom'));
+ }
+ /**
+ * Test updateMethodAtomDefault with show_atom set to true.
+ * => nothing to do
+ */
+ public function testUpdateMethodAtomDefaultAlreadyTrue()
+ {
+ $sandboxConf = 'sandbox/config';
+ copy(self::$configFile . '.json.php', $sandboxConf . '.json.php');
+ $this->conf = new ConfigManager($sandboxConf);
+ $this->conf->set('feed.show_atom', true);
+ $updater = new Updater([], [], $this->conf, true);
+ $this->assertTrue($updater->updateMethodAtomDefault());
+ $this->assertTrue($this->conf->get('feed.show_atom'));
+ }
}
* Read a non existent config file -> empty array.
*
* @expectedException \Exception
- * @expectedExceptionMessage An error occurred while parsing JSON file: error code #4
+ * @expectedExceptionMessageRegExp /An error occurred while parsing JSON configuration file \([\w\/\.]+\): error code #4/
*/
public function testReadInvalidJson()
{
</li>
{/loop}
<li class="pure-menu-item pure-u-lg-0">
- <a href="?do=atom{$searchcrits}" class="pure-menu-link">{'RSS Feed'|t}</a>
+ <a href="?do={$feed_type}{$searchcrits}" class="pure-menu-link">{'RSS Feed'|t}</a>
</li>
{if="isLoggedIn()"}
<li class="pure-menu-item pure-u-lg-0">
</a>
</li>
<li class="pure-menu-item">
- <a href="?do=atom{$searchcrits}" class="pure-menu-link" title="{'RSS Feed'|t}">
+ <a href="?do={$feed_type}{$searchcrits}" class="pure-menu-link" title="{'RSS Feed'|t}">
<i class="fa fa-rss"></i>
</a>
</li>
projects / github / shaarli / Shaarli.git / commitdiff
