From e23503f2e2db8c8fd655617eeeae640db66164d1 Mon Sep 17 00:00:00 2001
From: mattab <matthieu.aubry@gmail.com>
Date: Sat, 14 Sep 2013 13:02:30 +1200
Subject: [PATCH] Adding Filechecks class for all filesystem checks
---
core/Filechecks.php | 212 +++++++++++++++++++
core/Filesystem.php | 2 +-
core/FrontController.php | 2 +-
core/Piwik.php | 202 ------------------
core/Session.php | 2 +-
plugins/CorePluginsAdmin/Controller.php | 3 +-
plugins/CorePluginsAdmin/PluginInstaller.php | 4 +-
plugins/CoreUpdater/Controller.php | 9 +-
plugins/Installation/Controller.php | 7 +-
9 files changed, 228 insertions(+), 215 deletions(-)
create mode 100644 core/Filechecks.php
diff --git a/core/Filechecks.php b/core/Filechecks.php
new file mode 100644
index 0000000000..a6fd37e582
--- /dev/null
+++ b/core/Filechecks.php
@@ -0,0 +1,212 @@
+<?php
+/**
+ * Piwik - Open source web analytics
+ *
+ * @link http://piwik.org
+ * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
+ *
+ * @category Piwik
+ * @package Piwik
+ */
+namespace Piwik;
+
+class Filechecks
+{
+ /**
+ * Check if this installation can be auto-updated.
+ * For performance, we look for clues rather than an exhaustive test.
+ *
+ * @return bool
+ */
+ public static function canAutoUpdate()
+ {
+ if (!is_writable(PIWIK_INCLUDE_PATH . '/') ||
+ !is_writable(PIWIK_DOCUMENT_ROOT . '/index.php') ||
+ !is_writable(PIWIK_INCLUDE_PATH . '/core') ||
+ !is_writable(PIWIK_USER_PATH . '/config/global.ini.php')
+ ) {
+ return false;
+ }
+ return true;
+ }
+
+ /**
+ * Checks if directories are writable and create them if they do not exist.
+ *
+ * @param array $directoriesToCheck array of directories to check - if not given default Piwik directories that needs write permission are checked
+ * @return array directory name => true|false (is writable)
+ */
+ public static function checkDirectoriesWritable($directoriesToCheck)
+ {
+ $resultCheck = array();
+ foreach ($directoriesToCheck as $directoryToCheck) {
+ if (!preg_match('/^' . preg_quote(PIWIK_USER_PATH, '/') . '/', $directoryToCheck)) {
+ $directoryToCheck = PIWIK_USER_PATH . $directoryToCheck;
+ }
+
+ // Create an empty directory
+ $isFile = strpos($directoryToCheck, '.') !== false;
+ if (!$isFile && !file_exists($directoryToCheck)) {
+ Filesystem::mkdir($directoryToCheck);
+ }
+
+ $directory = Filesystem::realpath($directoryToCheck);
+ $resultCheck[$directory] = false;
+ if ($directory !== false // realpath() returns FALSE on failure
+ && is_writable($directoryToCheck)
+ ) {
+ $resultCheck[$directory] = true;
+ }
+ }
+ return $resultCheck;
+ }
+
+ /**
+ * Checks that the directories Piwik needs write access are actually writable
+ * Displays a nice error page if permissions are missing on some directories
+ *
+ * @param array $directoriesToCheck Array of directory names to check
+ */
+ public static function dieIfDirectoriesNotWritable($directoriesToCheck = null)
+ {
+ $resultCheck = self::checkDirectoriesWritable($directoriesToCheck);
+ if (array_search(false, $resultCheck) === false) {
+ return;
+ }
+
+ $directoryList = '';
+ foreach ($resultCheck as $dir => $bool) {
+ $realpath = Filesystem::realpath($dir);
+ if (!empty($realpath) && $bool === false) {
+ $directoryList .= self::getMakeWritableCommand($realpath);
+ }
+ }
+
+ // Also give the chown since the chmod is only 755
+ if (!Common::isWindows()) {
+ $realpath = Filesystem::realpath(PIWIK_INCLUDE_PATH . '/');
+ $directoryList = "<code>chown -R www-data:www-data " . $realpath . "</code><br/>" . $directoryList;
+ }
+
+ // The error message mentions chmod 777 in case users can't chown
+ $directoryMessage = "<p><b>Piwik couldn't write to some directories</b>.</p>
+ <p>Try to Execute the following commands on your server, to allow Write access on these directories:</p>"
+ . "<blockquote>$directoryList</blockquote>"
+ . "<p>If this doesn't work, you can try to create the directories with your FTP software, and set the CHMOD to 0755 (or 0777 if 0755 is not enough). To do so with your FTP software, right click on the directories then click permissions.</p>"
+ . "<p>After applying the modifications, you can <a href='index.php'>refresh the page</a>.</p>"
+ . "<p>If you need more help, try <a href='?module=Proxy&action=redirect&url=http://piwik.org'>Piwik.org</a>.</p>";
+
+ Piwik_ExitWithMessage($directoryMessage, false, true);
+ }
+
+ /**
+ * Get file integrity information (in PIWIK_INCLUDE_PATH).
+ *
+ * @return array(bool, string, ...) Return code (true/false), followed by zero or more error messages
+ */
+ public static function getFileIntegrityInformation()
+ {
+ $messages = array();
+ $messages[] = true;
+
+ $manifest = PIWIK_INCLUDE_PATH . '/config/manifest.inc.php';
+ if (!file_exists($manifest)) {
+ $suffix = " If you are deploying Piwik from Git, this message is normal.";
+ $messages[] = Piwik_Translate('General_WarningFileIntegrityNoManifest') . $suffix;
+ return $messages;
+ }
+
+ require_once $manifest;
+
+ $files = Manifest::$files;
+
+ $hasMd5file = function_exists('md5_file');
+ $hasMd5 = function_exists('md5');
+ foreach ($files as $path => $props) {
+ $file = PIWIK_INCLUDE_PATH . '/' . $path;
+
+ if (!file_exists($file)) {
+ $messages[] = Piwik_Translate('General_ExceptionMissingFile', $file);
+ } else if (filesize($file) != $props[0]) {
+ if (!$hasMd5 || in_array(substr($path, -4), array('.gif', '.ico', '.jpg', '.png', '.swf'))) {
+ // files that contain binary data (e.g., images) must match the file size
+ $messages[] = Piwik_Translate('General_ExceptionFilesizeMismatch', array($file, $props[0], filesize($file)));
+ } else {
+ // convert end-of-line characters and re-test text files
+ $content = @file_get_contents($file);
+ $content = str_replace("\r\n", "\n", $content);
+ if ((strlen($content) != $props[0])
+ || (@md5($content) !== $props[1])
+ ) {
+ $messages[] = Piwik_Translate('General_ExceptionFilesizeMismatch', array($file, $props[0], filesize($file)));
+ }
+ }
+ } else if ($hasMd5file && (@md5_file($file) !== $props[1])) {
+ $messages[] = Piwik_Translate('General_ExceptionFileIntegrity', $file);
+ }
+ }
+
+ if (count($messages) > 1) {
+ $messages[0] = false;
+ }
+
+ if (!$hasMd5file) {
+ $messages[] = Piwik_Translate('General_WarningFileIntegrityNoMd5file');
+ }
+
+ return $messages;
+ }
+
+ /**
+ * Returns the help message when the auto update can't run because of missing permissions
+ *
+ * @return string
+ */
+ public static function getAutoUpdateMakeWritableMessage()
+ {
+ $realpath = Filesystem::realpath(PIWIK_INCLUDE_PATH . '/');
+ $message = '';
+ $message .= "<code>chown -R www-data:www-data " . $realpath . "</code><br />";
+ $message .= "<code>chmod -R 0755 " . $realpath . "</code><br />";
+ $message .= 'After you execute these commands (or change permissions via your FTP software), refresh the page and you should be able to use the "Automatic Update" feature.';
+ return $message;
+ }
+
+ /**
+ * Returns friendly error message explaining how to fix permissions
+ *
+ * @param string $path to the directory missing permissions
+ * @return string Error message
+ */
+ public static function getErrorMessageMissingPermissions($path)
+ {
+ $message = "Please check that the web server has enough permission to write to these files/directories:<br />";
+
+ if (Common::isWindows()) {
+ $message .= "On Windows, check that the folder is not read only and is writable.
+ You can try to execute:<br />";
+ } else {
+ $message .= "For example, on a Linux server if your Apache httpd user
+ is www-data, you can try to execute:<br />"
+ . "<code>chown -R www-data:www-data " . $path . "</code><br />";
+ }
+
+ $message .= self::getMakeWritableCommand($path);
+
+ return $message;
+ }
+
+ /**
+ * Returns the help text displayed to suggest which command to run to give writable access to a file or directory
+ *
+ * @param string $realpath
+ * @return string
+ */
+ private static function getMakeWritableCommand($realpath)
+ {
+ if (Common::isWindows()) {
+ return "<code>cacls $realpath /t /g " . get_current_user() . ":f</code><br />";
+ }
+ return "<code>chmod -R 0755 $realpath</code><br />";
+ }
+}
\ No newline at end of file
diff --git a/core/Filesystem.php b/core/Filesystem.php
index ab5be2bca0..361304cea3 100644
--- a/core/Filesystem.php
+++ b/core/Filesystem.php
@@ -226,7 +226,7 @@ class Filesystem
@chmod($dest, 0755);
if (!@copy($source, $dest)) {
$message = "Error while creating/copying file to <code>$dest</code>. <br />"
- . Piwik::getErrorMessageMissingPermissions(self::getPathToPiwikRoot());
+ . Filechecks::getErrorMessageMissingPermissions(self::getPathToPiwikRoot());
throw new Exception($message);
}
}
diff --git a/core/FrontController.php b/core/FrontController.php
index b26a754808..ef5a9a411c 100644
--- a/core/FrontController.php
+++ b/core/FrontController.php
@@ -233,7 +233,7 @@ class FrontController
'/tmp/tcpdf/'
);
- Piwik::dieIfDirectoriesNotWritable($directoriesToCheck);
+ Filechecks::dieIfDirectoriesNotWritable($directoriesToCheck);
Common::assignCliParametersToRequest();
Translate::getInstance()->loadEnglishTranslation();
diff --git a/core/Piwik.php b/core/Piwik.php
index d2f760ed7f..45b2caf0e6 100644
--- a/core/Piwik.php
+++ b/core/Piwik.php
@@ -178,208 +178,6 @@ class Piwik
return $url;
}
- /*
- * File and directory operations
- */
-
- /**
- * Returns friendly error message explaining how to fix permissions
- *
- * @param string $path to the directory missing permissions
- * @return string Error message
- */
- static public function getErrorMessageMissingPermissions($path)
- {
- $message = "Please check that the web server has enough permission to write to these files/directories:<br />";
-
- if (Common::isWindows()) {
- $message .= "On Windows, check that the folder is not read only and is writable.
- You can try to execute:<br />";
- } else {
- $message .= "For example, on a Linux server if your Apache httpd user
- is www-data, you can try to execute:<br />"
- . "<code>chown -R www-data:www-data " . $path . "</code><br />";
- }
-
- $message .= self::getMakeWritableCommand($path);
-
- return $message;
- }
-
- /**
- * Returns the help text displayed to suggest which command to run to give writable access to a file or directory
- *
- * @param string $realpath
- * @return string
- */
- static private function getMakeWritableCommand($realpath)
- {
- if (Common::isWindows()) {
- return "<code>cacls $realpath /t /g " . get_current_user() . ":f</code><br />";
- }
- return "<code>chmod -R 0755 $realpath</code><br />";
- }
-
- /**
- * Checks that the directories Piwik needs write access are actually writable
- * Displays a nice error page if permissions are missing on some directories
- *
- * @param array $directoriesToCheck Array of directory names to check
- */
- static public function dieIfDirectoriesNotWritable($directoriesToCheck = null)
- {
- $resultCheck = Piwik::checkDirectoriesWritable($directoriesToCheck);
- if (array_search(false, $resultCheck) === false) {
- return;
- }
-
- $directoryList = '';
- foreach ($resultCheck as $dir => $bool) {
- $realpath = Filesystem::realpath($dir);
- if (!empty($realpath) && $bool === false) {
- $directoryList .= self::getMakeWritableCommand($realpath);
- }
- }
-
- // Also give the chown since the chmod is only 755
- if (!Common::isWindows()) {
- $realpath = Filesystem::realpath(PIWIK_INCLUDE_PATH . '/');
- $directoryList = "<code>chown -R www-data:www-data " . $realpath . "</code><br/>" . $directoryList;
- }
-
- // The error message mentions chmod 777 in case users can't chown
- $directoryMessage = "<p><b>Piwik couldn't write to some directories</b>.</p>
- <p>Try to Execute the following commands on your server, to allow Write access on these directories:</p>"
- . "<blockquote>$directoryList</blockquote>"
- . "<p>If this doesn't work, you can try to create the directories with your FTP software, and set the CHMOD to 0755 (or 0777 if 0755 is not enough). To do so with your FTP software, right click on the directories then click permissions.</p>"
- . "<p>After applying the modifications, you can <a href='index.php'>refresh the page</a>.</p>"
- . "<p>If you need more help, try <a href='?module=Proxy&action=redirect&url=http://piwik.org'>Piwik.org</a>.</p>";
-
- Piwik_ExitWithMessage($directoryMessage, false, true);
- }
-
- /**
- * Checks if directories are writable and create them if they do not exist.
- *
- * @param array $directoriesToCheck array of directories to check - if not given default Piwik directories that needs write permission are checked
- * @return array directory name => true|false (is writable)
- */
- static public function checkDirectoriesWritable($directoriesToCheck)
- {
- $resultCheck = array();
- foreach ($directoriesToCheck as $directoryToCheck) {
- if (!preg_match('/^' . preg_quote(PIWIK_USER_PATH, '/') . '/', $directoryToCheck)) {
- $directoryToCheck = PIWIK_USER_PATH . $directoryToCheck;
- }
-
- // Create an empty directory
- $isFile = strpos($directoryToCheck, '.') !== false;
- if (!$isFile && !file_exists($directoryToCheck)) {
- Filesystem::mkdir($directoryToCheck);
- }
-
- $directory = Filesystem::realpath($directoryToCheck);
- $resultCheck[$directory] = false;
- if ($directory !== false // realpath() returns FALSE on failure
- && is_writable($directoryToCheck)
- ) {
- $resultCheck[$directory] = true;
- }
- }
- return $resultCheck;
- }
-
- /**
- * Check if this installation can be auto-updated.
- * For performance, we look for clues rather than an exhaustive test.
- *
- * @return bool
- */
- static public function canAutoUpdate()
- {
- if (!is_writable(PIWIK_INCLUDE_PATH . '/') ||
- !is_writable(PIWIK_DOCUMENT_ROOT . '/index.php') ||
- !is_writable(PIWIK_INCLUDE_PATH . '/core') ||
- !is_writable(PIWIK_USER_PATH . '/config/global.ini.php')
- ) {
- return false;
- }
- return true;
- }
-
- /**
- * Returns the help message when the auto update can't run because of missing permissions
- *
- * @return string
- */
- static public function getAutoUpdateMakeWritableMessage()
- {
- $realpath = Filesystem::realpath(PIWIK_INCLUDE_PATH . '/');
- $message = '';
- $message .= "<code>chown -R www-data:www-data " . $realpath . "</code><br />";
- $message .= "<code>chmod -R 0755 " . $realpath . "</code><br />";
- $message .= 'After you execute these commands (or change permissions via your FTP software), refresh the page and you should be able to use the "Automatic Update" feature.';
- return $message;
- }
-
- /**
- * Get file integrity information (in PIWIK_INCLUDE_PATH).
- *
- * @return array(bool, string, ...) Return code (true/false), followed by zero or more error messages
- */
- static public function getFileIntegrityInformation()
- {
- $messages = array();
- $messages[] = true;
-
- $manifest = PIWIK_INCLUDE_PATH . '/config/manifest.inc.php';
- if (!file_exists($manifest)) {
- $suffix = " If you are deploying Piwik from Git, this message is normal.";
- $messages[] = Piwik_Translate('General_WarningFileIntegrityNoManifest') . $suffix;
- return $messages;
- }
-
- require_once $manifest;
-
- $files = Manifest::$files;
-
- $hasMd5file = function_exists('md5_file');
- $hasMd5 = function_exists('md5');
- foreach ($files as $path => $props) {
- $file = PIWIK_INCLUDE_PATH . '/' . $path;
-
- if (!file_exists($file)) {
- $messages[] = Piwik_Translate('General_ExceptionMissingFile', $file);
- } else if (filesize($file) != $props[0]) {
- if (!$hasMd5 || in_array(substr($path, -4), array('.gif', '.ico', '.jpg', '.png', '.swf'))) {
- // files that contain binary data (e.g., images) must match the file size
- $messages[] = Piwik_Translate('General_ExceptionFilesizeMismatch', array($file, $props[0], filesize($file)));
- } else {
- // convert end-of-line characters and re-test text files
- $content = @file_get_contents($file);
- $content = str_replace("\r\n", "\n", $content);
- if ((strlen($content) != $props[0])
- || (@md5($content) !== $props[1])
- ) {
- $messages[] = Piwik_Translate('General_ExceptionFilesizeMismatch', array($file, $props[0], filesize($file)));
- }
- }
- } else if ($hasMd5file && (@md5_file($file) !== $props[1])) {
- $messages[] = Piwik_Translate('General_ExceptionFileIntegrity', $file);
- }
- }
-
- if (count($messages) > 1) {
- $messages[0] = false;
- }
-
- if (!$hasMd5file) {
- $messages[] = Piwik_Translate('General_WarningFileIntegrityNoMd5file');
- }
-
- return $messages;
- }
-
/**
* Create CSV (or other delimited) files
*
diff --git a/core/Session.php b/core/Session.php
index d89df96ea1..c3ca8dbb45 100644
--- a/core/Session.php
+++ b/core/Session.php
@@ -131,7 +131,7 @@ class Session extends Zend_Session
$message = sprintf("Error: %s %s %s\n<pre>Debug: the original error was \n%s</pre>",
Piwik_Translate('General_ExceptionUnableToStartSession'),
- Piwik::getErrorMessageMissingPermissions(Filesystem::getPathToPiwikRoot() . '/tmp/sessions/'),
+ Filechecks::getErrorMessageMissingPermissions(Filesystem::getPathToPiwikRoot() . '/tmp/sessions/'),
$enableDbSessions,
$e->getMessage()
);
diff --git a/plugins/CorePluginsAdmin/Controller.php b/plugins/CorePluginsAdmin/Controller.php
index 867a645953..243484acc3 100644
--- a/plugins/CorePluginsAdmin/Controller.php
+++ b/plugins/CorePluginsAdmin/Controller.php
@@ -12,6 +12,7 @@ namespace Piwik\Plugins\CorePluginsAdmin;
use Piwik\Common;
use Piwik\Config;
+use Piwik\Filechecks;
use Piwik\Filesystem;
use Piwik\Piwik;
use Piwik\Plugin;
@@ -197,7 +198,7 @@ class Controller extends \Piwik\Controller\Admin
$uninstalled = \Piwik\PluginsManager::getInstance()->uninstallPlugin($pluginName);
if (!$uninstalled) {
$path = Filesystem::getPathToPiwikRoot() . '/plugins/' . $pluginName . '/';
- $messagePermissions = Piwik::getErrorMessageMissingPermissions($path);
+ $messagePermissions = Filechecks::getErrorMessageMissingPermissions($path);
$messageIntro = Piwik_Translate("Warning: \"%s\" could not be uninstalled. Piwik did not have enough permission to delete the files in $path. ",
$pluginName);
diff --git a/plugins/CorePluginsAdmin/PluginInstaller.php b/plugins/CorePluginsAdmin/PluginInstaller.php
index eb7cf7095c..6afae27957 100644
--- a/plugins/CorePluginsAdmin/PluginInstaller.php
+++ b/plugins/CorePluginsAdmin/PluginInstaller.php
@@ -9,8 +9,8 @@
* @package CorePluginsAdmin
*/
namespace Piwik\Plugins\CorePluginsAdmin;
+use Piwik\Filechecks;
use Piwik\Filesystem;
-use Piwik\Piwik;
use Piwik\Unzip;
/**
@@ -46,7 +46,7 @@ class PluginInstaller
private function makeSureFoldersAreWritable()
{
- Piwik::dieIfDirectoriesNotWritable(array(self::PATH_TO_DOWNLOAD, self::PATH_TO_EXTRACT));
+ Filechecks::dieIfDirectoriesNotWritable(array(self::PATH_TO_DOWNLOAD, self::PATH_TO_EXTRACT));
}
private function downloadPluginFromMarketplace($pluginZipTargetFile)
diff --git a/plugins/CoreUpdater/Controller.php b/plugins/CoreUpdater/Controller.php
index ae48b8e8ce..d34a125487 100644
--- a/plugins/CoreUpdater/Controller.php
+++ b/plugins/CoreUpdater/Controller.php
@@ -15,6 +15,7 @@ use Piwik\API\Request;
use Piwik\ArchiveProcessor\Rules;
use Piwik\Common;
use Piwik\Config;
+use Piwik\Filechecks;
use Piwik\Filesystem;
use Piwik\Http;
use Piwik\Piwik;
@@ -59,8 +60,8 @@ class Controller extends \Piwik\Controller
$view->piwik_version = Version::VERSION;
$view->piwik_new_version = $newVersion;
$view->piwik_latest_version_url = self::getLatestZipUrl($newVersion);
- $view->can_auto_update = Piwik::canAutoUpdate();
- $view->makeWritableCommands = Piwik::getAutoUpdateMakeWritableMessage();
+ $view->can_auto_update = Filechecks::canAutoUpdate();
+ $view->makeWritableCommands = Filechecks::getAutoUpdateMakeWritableMessage();
echo $view->render();
}
@@ -125,7 +126,7 @@ class Controller extends \Piwik\Controller
private function oneClick_Download()
{
$this->pathPiwikZip = PIWIK_USER_PATH . self::PATH_TO_EXTRACT_LATEST_VERSION . 'latest.zip';
- Piwik::dieIfDirectoriesNotWritable(array(self::PATH_TO_EXTRACT_LATEST_VERSION));
+ Filechecks::dieIfDirectoriesNotWritable(array(self::PATH_TO_EXTRACT_LATEST_VERSION));
// we catch exceptions in the caller (i.e., oneClickUpdate)
$url = self::getLatestZipUrl($this->newVersion) . '?cb=' . $this->newVersion;
@@ -316,7 +317,7 @@ class Controller extends \Piwik\Controller
}
// check file integrity
- $integrityInfo = Piwik::getFileIntegrityInformation();
+ $integrityInfo = Filechecks::getFileIntegrityInformation();
if (isset($integrityInfo[1])) {
if ($integrityInfo[0] == false) {
$this->warningMessages[] = '<b>' . Piwik_Translate('General_FileIntegrityWarningExplanation') . '</b>';
diff --git a/plugins/Installation/Controller.php b/plugins/Installation/Controller.php
index 106023195d..4983e5cb57 100644
--- a/plugins/Installation/Controller.php
+++ b/plugins/Installation/Controller.php
@@ -18,6 +18,7 @@ use Piwik\Config;
use Piwik\DataAccess\ArchiveTableCreator;
use Piwik\Db\Adapter;
use Piwik\Db;
+use Piwik\Filechecks;
use Piwik\Filesystem;
use Piwik\Http;
use Piwik\Piwik;
@@ -727,9 +728,9 @@ class Controller extends \Piwik\Controller\Admin
'/tmp/sessions/',
));
- $infos['directories'] = Piwik::checkDirectoriesWritable($directoriesToCheck);
+ $infos['directories'] = Filechecks::checkDirectoriesWritable($directoriesToCheck);
- $infos['can_auto_update'] = Piwik::canAutoUpdate();
+ $infos['can_auto_update'] = Filechecks::canAutoUpdate();
self::initServerFilesForSecurity();
@@ -837,7 +838,7 @@ class Controller extends \Piwik\Controller\Admin
$infos['isWindows'] = Common::isWindows();
- $integrityInfo = Piwik::getFileIntegrityInformation();
+ $integrityInfo = Filechecks::getFileIntegrityInformation();
$infos['integrity'] = $integrityInfo[0];
$infos['integrityErrorMessages'] = array();
--
GitLab