]>
git.immae.eu Git - github/shaarli/Shaarli.git/blob - application/ApplicationUtils.php
3 * Shaarli (application) utilities
7 private static $GIT_URL = 'https://raw.githubusercontent.com/shaarli/Shaarli';
8 private static $GIT_BRANCHES = array('master', 'stable');
9 private static $VERSION_FILE = 'shaarli_version.php';
10 private static $VERSION_START_TAG = '<?php /* ';
11 private static $VERSION_END_TAG = ' */ ?>';
14 * Gets the latest version code from the Git repository
16 * The code is read from the raw content of the version file on the Git server.
18 * @return mixed the version code from the repository if available, else 'false'
20 public static function getLatestGitVersionCode($url, $timeout=2)
22 list($headers, $data) = get_http_response($url, $timeout);
24 if (strpos($headers[0], '200 OK') === false) {
25 error_log('Failed to retrieve ' . $url);
30 array(self
::$VERSION_START_TAG, self
::$VERSION_END_TAG, PHP_EOL
),
37 * Checks if a new Shaarli version has been published on the Git repository
39 * Updates checks are run periodically, according to the following criteria:
40 * - the update checks are enabled (install, global config);
41 * - the user is logged in (or this is an open instance);
42 * - the last check is older than a given interval;
43 * - the check is non-blocking if the HTTPS connection to Git fails;
44 * - in case of failure, the update file's modification date is updated,
45 * to avoid intempestive connection attempts.
47 * @param string $currentVersion the current version code
48 * @param string $updateFile the file where to store the latest version code
49 * @param int $checkInterval the minimum interval between update checks (in seconds
50 * @param bool $enableCheck whether to check for new versions
51 * @param bool $isLoggedIn whether the user is logged in
53 * @throws Exception an invalid branch has been set for update checks
55 * @return mixed the new version code if available and greater, else 'false'
57 public static function checkUpdate($currentVersion,
65 // Do not check versions for visitors
69 if (empty($enableCheck)) {
70 // Do not check if the user doesn't want to
74 if (is_file($updateFile) && (filemtime($updateFile) > time() - $checkInterval)) {
75 // Shaarli has checked for updates recently - skip HTTP query
76 $latestKnownVersion = file_get_contents($updateFile);
78 if (version_compare($latestKnownVersion, $currentVersion) == 1) {
79 return $latestKnownVersion;
84 if (! in_array($branch, self
::$GIT_BRANCHES)) {
86 'Invalid branch selected for updates: "' . $branch . '"'
90 // Late Static Binding allows overriding within tests
91 // See http://php.net/manual/en/language.oop5.late-static-bindings.php
92 $latestVersion = static::getLatestGitVersionCode(
93 self
::$GIT_URL . '/' . $branch . '/' . self
::$VERSION_FILE
96 if (! $latestVersion) {
97 // Only update the file's modification date
98 file_put_contents($updateFile, $currentVersion);
102 // Update the file's content and modification date
103 file_put_contents($updateFile, $latestVersion);
105 if (version_compare($latestVersion, $currentVersion) == 1) {
106 return $latestVersion;
113 * Checks the PHP version to ensure Shaarli can run
115 * @param string $minVersion minimum PHP required version
116 * @param string $curVersion current PHP version (use PHP_VERSION)
118 * @throws Exception the PHP version is not supported
120 public static function checkPHPVersion($minVersion, $curVersion)
122 if (version_compare($curVersion, $minVersion) < 0) {
124 'Your PHP version is obsolete!'
125 .' Shaarli requires at least PHP '.$minVersion.', and thus cannot run.'
126 .' Your PHP version has known security vulnerabilities and should be'
127 .' updated as soon as possible.'
133 * Checks Shaarli has the proper access permissions to its resources
135 * @param ConfigManager $conf Configuration Manager instance.
137 * @return array A list of the detected configuration issues
139 public static function checkResourcePermissions($conf)
143 // Check script and template directories are readable
148 $conf->get('resource.raintpl_tpl'),
150 if (! is_readable(realpath($path))) {
151 $errors[] = '"'.$path.'" directory is not readable';
155 // Check cache and data directories are readable and writeable
157 $conf->get('resource.thumbnails_cache'),
158 $conf->get('resource.data_dir'),
159 $conf->get('resource.page_cache'),
160 $conf->get('resource.raintpl_tmp'),
162 if (! is_readable(realpath($path))) {
163 $errors[] = '"'.$path.'" directory is not readable';
165 if (! is_writable(realpath($path))) {
166 $errors[] = '"'.$path.'" directory is not writable';
170 // Check configuration files are readable and writeable
172 $conf->getConfigFileExt(),
173 $conf->get('resource.datastore'),
174 $conf->get('resource.ban_file'),
175 $conf->get('resource.log'),
176 $conf->get('resource.update_check'),
178 if (! is_file(realpath($path))) {
179 # the file may not exist yet
183 if (! is_readable(realpath($path))) {
184 $errors[] = '"'.$path.'" file is not readable';
186 if (! is_writable(realpath($path))) {
187 $errors[] = '"'.$path.'" file is not writable';