diff options
Diffstat (limited to 'core/Piwik.php')
| -rw-r--r-- | core/Piwik.php | 5096 |
1 files changed, 2457 insertions, 2639 deletions
diff --git a/core/Piwik.php b/core/Piwik.php index 4a694b7b28..a1ffc1df27 100644 --- a/core/Piwik.php +++ b/core/Piwik.php @@ -22,591 +22,547 @@ require_once PIWIK_INCLUDE_PATH . '/core/Translate.php'; */ class Piwik { - const CLASSES_PREFIX = 'Piwik_'; - const COMPRESSED_FILE_LOCATION = '/tmp/assets/'; - - /** - * Piwik periods - * @var array - */ - public static $idPeriods = array( - 'day' => 1, - 'week' => 2, - 'month' => 3, - 'year' => 4, - 'range' => 5, - ); - - /** - * Should we process and display Unique Visitors? - * -> Always process for day/week/month periods - * For Year and Range, only process if it was enabled in the config file, - * - * @param string $periodLabel Period label (e.g., 'day') - * @return bool - */ - static public function isUniqueVisitorsEnabled($periodLabel) - { - $generalSettings = Piwik_Config::getInstance()->General; - - $settingName = "enable_processing_unique_visitors_$periodLabel"; - $result = !empty($generalSettings[$settingName]) && $generalSettings[$settingName] == 1; - - // check enable_processing_unique_visitors_year_and_range for backwards compatibility - if (($periodLabel == 'year' || $periodLabel == 'range') - && isset($generalSettings['enable_processing_unique_visitors_year_and_range'])) - { - $result |= $generalSettings['enable_processing_unique_visitors_year_and_range'] == 1; - } - - return $result; - } - - /** - * Prefix class name (if needed) - * - * @param string $class - * @return string - */ - static public function prefixClass( $class ) - { - if(!strncmp($class, Piwik::CLASSES_PREFIX, strlen(Piwik::CLASSES_PREFIX))) - { - return $class; - } - return Piwik::CLASSES_PREFIX.$class; - } - - /** - * Unprefix class name (if needed) - * - * @param string $class - * @return string - */ - static public function unprefixClass( $class ) - { - $lenPrefix = strlen(Piwik::CLASSES_PREFIX); - if(!strncmp($class, Piwik::CLASSES_PREFIX, $lenPrefix)) - { - return substr($class, $lenPrefix); - } - return $class; - } - - /** - * Installation helper - */ - static public function install() - { - Piwik_Common::mkdir(PIWIK_USER_PATH . '/' . Piwik_Config::getInstance()->smarty['compile_dir']); - } - - /** - * Uninstallation helper - */ - static public function uninstall() - { - Piwik_Db_Schema::getInstance()->dropTables(); - } - - /** - * Returns true if Piwik is installed - * - * @since 0.6.3 - * - * @return bool True if installed; false otherwise - */ - static public function isInstalled() - { - try { - return Piwik_Db_Schema::getInstance()->hasTables(); - } catch(Exception $e) { - return false; - } - } - - /** - * Called on Core install, update, plugin enable/disable - * Will clear all cache that could be affected by the change in configuration being made - */ - static public function deleteAllCacheOnUpdate() - { - Piwik_AssetManager::removeMergedAssets(); - Piwik_View::clearCompiledTemplates(); - Piwik_Tracker_Cache::deleteTrackerCache(); - } - - /** - * Cache for result of getPiwikUrl. - * Can be overwritten for testing purposes only. - * - * @var string - */ - static public $piwikUrlCache = null; - - /** - * Returns the cached the Piwik URL, eg. http://demo.piwik.org/ or http://example.org/piwik/ - * If not found, then tries to cache it and returns the value. - * - * If the Piwik URL changes (eg. Piwik moved to new server), the value will automatically be refreshed in the cache. - * - * @return string - */ - static public function getPiwikUrl() - { - // Only set in tests - if (self::$piwikUrlCache !== null) - { - return self::$piwikUrlCache; - } - - $key = 'piwikUrl'; - $url = Piwik_GetOption($key); - if(Piwik_Common::isPhpCliMode() - // in case archive.php is triggered with domain localhost - || Piwik_Common::isArchivePhpTriggered() - || defined('PIWIK_MODE_ARCHIVE')) - { - return $url; - } - - $currentUrl = Piwik_Common::sanitizeInputValue(Piwik_Url::getCurrentUrlWithoutFileName()); - - if(empty($url) - // if URL changes, always update the cache - || $currentUrl != $url) - { - if(strlen($currentUrl) >= strlen('http://a/')) - { - Piwik_SetOption($key, $currentUrl, $autoload = true); - } - $url = $currentUrl; - } - return $url; - } - - /** - * Returns true if this appears to be a secure HTTPS connection - * - * @return bool - */ - static public function isHttps() - { - return Piwik_Url::getCurrentScheme() === 'https'; - } - - /** - * Set response header, e.g., HTTP/1.0 200 Ok - * - * @param string $status Status - * @return bool - */ - static public function setHttpStatus($status) - { - if(substr_compare(PHP_SAPI, '-fcgi', -5)) - { - @header($_SERVER['SERVER_PROTOCOL'] . ' ' . $status); - } - else - { - // FastCGI - @header('Status: ' . $status); - } - } - - /** - * Workaround IE bug when downloading certain document types over SSL and - * cache control headers are present, e.g., - * - * Cache-Control: no-cache - * Cache-Control: no-store,max-age=0,must-revalidate - * Pragma: no-cache - * - * @see http://support.microsoft.com/kb/316431/ - * @see RFC2616 - * - * @param string $override One of "public", "private", "no-cache", or "no-store". (optional) - */ - static public function overrideCacheControlHeaders($override = null) - { - if($override || self::isHttps()) - { - @header('Pragma: '); - @header('Expires: '); - if(in_array($override, array('public', 'private', 'no-cache', 'no-store'))) - { - @header("Cache-Control: $override, must-revalidate"); - } - else - { - @header('Cache-Control: must-revalidate'); - } - } - } - -/* + const CLASSES_PREFIX = 'Piwik_'; + const COMPRESSED_FILE_LOCATION = '/tmp/assets/'; + + /** + * Piwik periods + * @var array + */ + public static $idPeriods = array( + 'day' => 1, + 'week' => 2, + 'month' => 3, + 'year' => 4, + 'range' => 5, + ); + + /** + * Should we process and display Unique Visitors? + * -> Always process for day/week/month periods + * For Year and Range, only process if it was enabled in the config file, + * + * @param string $periodLabel Period label (e.g., 'day') + * @return bool + */ + static public function isUniqueVisitorsEnabled($periodLabel) + { + $generalSettings = Piwik_Config::getInstance()->General; + + $settingName = "enable_processing_unique_visitors_$periodLabel"; + $result = !empty($generalSettings[$settingName]) && $generalSettings[$settingName] == 1; + + // check enable_processing_unique_visitors_year_and_range for backwards compatibility + if (($periodLabel == 'year' || $periodLabel == 'range') + && isset($generalSettings['enable_processing_unique_visitors_year_and_range']) + ) { + $result |= $generalSettings['enable_processing_unique_visitors_year_and_range'] == 1; + } + + return $result; + } + + /** + * Prefix class name (if needed) + * + * @param string $class + * @return string + */ + static public function prefixClass($class) + { + if (!strncmp($class, Piwik::CLASSES_PREFIX, strlen(Piwik::CLASSES_PREFIX))) { + return $class; + } + return Piwik::CLASSES_PREFIX . $class; + } + + /** + * Unprefix class name (if needed) + * + * @param string $class + * @return string + */ + static public function unprefixClass($class) + { + $lenPrefix = strlen(Piwik::CLASSES_PREFIX); + if (!strncmp($class, Piwik::CLASSES_PREFIX, $lenPrefix)) { + return substr($class, $lenPrefix); + } + return $class; + } + + /** + * Installation helper + */ + static public function install() + { + Piwik_Common::mkdir(PIWIK_USER_PATH . '/' . Piwik_Config::getInstance()->smarty['compile_dir']); + } + + /** + * Uninstallation helper + */ + static public function uninstall() + { + Piwik_Db_Schema::getInstance()->dropTables(); + } + + /** + * Returns true if Piwik is installed + * + * @since 0.6.3 + * + * @return bool True if installed; false otherwise + */ + static public function isInstalled() + { + try { + return Piwik_Db_Schema::getInstance()->hasTables(); + } catch (Exception $e) { + return false; + } + } + + /** + * Called on Core install, update, plugin enable/disable + * Will clear all cache that could be affected by the change in configuration being made + */ + static public function deleteAllCacheOnUpdate() + { + Piwik_AssetManager::removeMergedAssets(); + Piwik_View::clearCompiledTemplates(); + Piwik_Tracker_Cache::deleteTrackerCache(); + } + + /** + * Cache for result of getPiwikUrl. + * Can be overwritten for testing purposes only. + * + * @var string + */ + static public $piwikUrlCache = null; + + /** + * Returns the cached the Piwik URL, eg. http://demo.piwik.org/ or http://example.org/piwik/ + * If not found, then tries to cache it and returns the value. + * + * If the Piwik URL changes (eg. Piwik moved to new server), the value will automatically be refreshed in the cache. + * + * @return string + */ + static public function getPiwikUrl() + { + // Only set in tests + if (self::$piwikUrlCache !== null) { + return self::$piwikUrlCache; + } + + $key = 'piwikUrl'; + $url = Piwik_GetOption($key); + if (Piwik_Common::isPhpCliMode() + // in case archive.php is triggered with domain localhost + || Piwik_Common::isArchivePhpTriggered() + || defined('PIWIK_MODE_ARCHIVE') + ) { + return $url; + } + + $currentUrl = Piwik_Common::sanitizeInputValue(Piwik_Url::getCurrentUrlWithoutFileName()); + + if (empty($url) + // if URL changes, always update the cache + || $currentUrl != $url + ) { + if (strlen($currentUrl) >= strlen('http://a/')) { + Piwik_SetOption($key, $currentUrl, $autoload = true); + } + $url = $currentUrl; + } + return $url; + } + + /** + * Returns true if this appears to be a secure HTTPS connection + * + * @return bool + */ + static public function isHttps() + { + return Piwik_Url::getCurrentScheme() === 'https'; + } + + /** + * Set response header, e.g., HTTP/1.0 200 Ok + * + * @param string $status Status + * @return bool + */ + static public function setHttpStatus($status) + { + if (substr_compare(PHP_SAPI, '-fcgi', -5)) { + @header($_SERVER['SERVER_PROTOCOL'] . ' ' . $status); + } else { + // FastCGI + @header('Status: ' . $status); + } + } + + /** + * Workaround IE bug when downloading certain document types over SSL and + * cache control headers are present, e.g., + * + * Cache-Control: no-cache + * Cache-Control: no-store,max-age=0,must-revalidate + * Pragma: no-cache + * + * @see http://support.microsoft.com/kb/316431/ + * @see RFC2616 + * + * @param string $override One of "public", "private", "no-cache", or "no-store". (optional) + */ + static public function overrideCacheControlHeaders($override = null) + { + if ($override || self::isHttps()) { + @header('Pragma: '); + @header('Expires: '); + if (in_array($override, array('public', 'private', 'no-cache', 'no-store'))) { + @header("Cache-Control: $override, must-revalidate"); + } else { + @header('Cache-Control: must-revalidate'); + } + } + } + + /* * File and directory operations */ - /** - * Copy recursively from $source to $target. - * - * @param string $source eg. './tmp/latest' - * @param string $target eg. '.' - * @param bool $excludePhp - */ - static public function copyRecursive($source, $target, $excludePhp=false ) - { - if ( is_dir( $source ) ) - { - Piwik_Common::mkdir( $target, false ); - $d = dir( $source ); - while ( false !== ( $entry = $d->read() ) ) - { - if ( $entry == '.' || $entry == '..' ) - { - continue; - } - - $sourcePath = $source . '/' . $entry; - if ( is_dir( $sourcePath ) ) - { - self::copyRecursive( $sourcePath, $target . '/' . $entry, $excludePhp ); - continue; - } - $destPath = $target . '/' . $entry; - self::copy($sourcePath, $destPath, $excludePhp); - } - $d->close(); - } - else - { - self::copy($source, $target, $excludePhp); - } - } - - /** - * Copy individual file from $source to $target. - * - * @param string $source eg. './tmp/latest/index.php' - * @param string $dest eg. './index.php' - * @param bool $excludePhp - * @throws Exception - * @return bool - */ - static public function copy($source, $dest, $excludePhp=false) - { - static $phpExtensions = array('php', 'tpl'); - - if($excludePhp) - { - $path_parts = pathinfo($source); - if(in_array($path_parts['extension'], $phpExtensions)) - { - return true; - } - } - - if(!@copy( $source, $dest )) - { - @chmod($dest, 0755); - if(!@copy( $source, $dest )) - { - $message = "Error while creating/copying file to <code>$dest</code>. <br />" - . self::getErrorMessageMissingPermissions(Piwik_Common::getPathToPiwikRoot()); - throw new Exception($message); - } - } - return true; - } - - /** - * 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(Piwik_Common::isWindows()) - { - $message .= "On Windows, check that the folder is not read only and is writable. + /** + * Copy recursively from $source to $target. + * + * @param string $source eg. './tmp/latest' + * @param string $target eg. '.' + * @param bool $excludePhp + */ + static public function copyRecursive($source, $target, $excludePhp = false) + { + if (is_dir($source)) { + Piwik_Common::mkdir($target, false); + $d = dir($source); + while (false !== ($entry = $d->read())) { + if ($entry == '.' || $entry == '..') { + continue; + } + + $sourcePath = $source . '/' . $entry; + if (is_dir($sourcePath)) { + self::copyRecursive($sourcePath, $target . '/' . $entry, $excludePhp); + continue; + } + $destPath = $target . '/' . $entry; + self::copy($sourcePath, $destPath, $excludePhp); + } + $d->close(); + } else { + self::copy($source, $target, $excludePhp); + } + } + + /** + * Copy individual file from $source to $target. + * + * @param string $source eg. './tmp/latest/index.php' + * @param string $dest eg. './index.php' + * @param bool $excludePhp + * @throws Exception + * @return bool + */ + static public function copy($source, $dest, $excludePhp = false) + { + static $phpExtensions = array('php', 'tpl'); + + if ($excludePhp) { + $path_parts = pathinfo($source); + if (in_array($path_parts['extension'], $phpExtensions)) { + return true; + } + } + + if (!@copy($source, $dest)) { + @chmod($dest, 0755); + if (!@copy($source, $dest)) { + $message = "Error while creating/copying file to <code>$dest</code>. <br />" + . self::getErrorMessageMissingPermissions(Piwik_Common::getPathToPiwikRoot()); + throw new Exception($message); + } + } + return true; + } + + /** + * 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 (Piwik_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 + } 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; - } - - /** - * Recursively delete a directory - * - * @param string $dir Directory name - * @param boolean $deleteRootToo Delete specified top-level directory as well - */ - static public function unlinkRecursive($dir, $deleteRootToo) - { - if(!$dh = @opendir($dir)) - { - return; - } - while (false !== ($obj = readdir($dh))) - { - if($obj == '.' || $obj == '..') - { - continue; - } - - if (!@unlink($dir . '/' . $obj)) - { - self::unlinkRecursive($dir.'/'.$obj, true); - } - } - closedir($dh); - if ($deleteRootToo) - { - @rmdir($dir); - } - return; - } - - /** - * Recursively find pathnames that match a pattern - * @see glob() - * - * @param string $sDir directory - * @param string $sPattern pattern - * @param int $nFlags glob() flags - * @return array - */ - public static function globr($sDir, $sPattern, $nFlags = NULL) - { - if(($aFiles = _glob("$sDir/$sPattern", $nFlags)) == false) - { - $aFiles = array(); - } - if(($aDirs = _glob("$sDir/*", GLOB_ONLYDIR)) != false) - { - foreach ($aDirs as $sSubDir) - { - $aSubFiles = self::globr($sSubDir, $sPattern, $nFlags); - $aFiles = array_merge($aFiles, $aSubFiles); - } - } - return $aFiles; - } - - /** - * 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(Piwik_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 checkDirectoriesWritableOrDie( $directoriesToCheck = null ) - { - $resultCheck = Piwik::checkDirectoriesWritable( $directoriesToCheck ); - if( array_search(false, $resultCheck) === false ) - { - return; - } - - $directoryList = ''; - foreach($resultCheck as $dir => $bool) - { - $realpath = Piwik_Common::realpath($dir); - if(!empty($realpath) && $bool === false) - { - $directoryList .= self::getMakeWritableCommand($realpath); - } - } - - // Also give the chown since the chmod is only 755 - if(!Piwik_Common::isWindows()) - { - $realpath = Piwik_Common::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> + . "<code>chown -R www-data:www-data " . $path . "</code><br />"; + } + + $message .= self::getMakeWritableCommand($path); + + return $message; + } + + /** + * Recursively delete a directory + * + * @param string $dir Directory name + * @param boolean $deleteRootToo Delete specified top-level directory as well + */ + static public function unlinkRecursive($dir, $deleteRootToo) + { + if (!$dh = @opendir($dir)) { + return; + } + while (false !== ($obj = readdir($dh))) { + if ($obj == '.' || $obj == '..') { + continue; + } + + if (!@unlink($dir . '/' . $obj)) { + self::unlinkRecursive($dir . '/' . $obj, true); + } + } + closedir($dh); + if ($deleteRootToo) { + @rmdir($dir); + } + return; + } + + /** + * Recursively find pathnames that match a pattern + * @see glob() + * + * @param string $sDir directory + * @param string $sPattern pattern + * @param int $nFlags glob() flags + * @return array + */ + public static function globr($sDir, $sPattern, $nFlags = NULL) + { + if (($aFiles = _glob("$sDir/$sPattern", $nFlags)) == false) { + $aFiles = array(); + } + if (($aDirs = _glob("$sDir/*", GLOB_ONLYDIR)) != false) { + foreach ($aDirs as $sSubDir) { + $aSubFiles = self::globr($sSubDir, $sPattern, $nFlags); + $aFiles = array_merge($aFiles, $aSubFiles); + } + } + return $aFiles; + } + + /** + * 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 (Piwik_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 checkDirectoriesWritableOrDie($directoriesToCheck = null) + { + $resultCheck = Piwik::checkDirectoriesWritable($directoriesToCheck); + if (array_search(false, $resultCheck) === false) { + return; + } + + $directoryList = ''; + foreach ($resultCheck as $dir => $bool) { + $realpath = Piwik_Common::realpath($dir); + if (!empty($realpath) && $bool === false) { + $directoryList .= self::getMakeWritableCommand($realpath); + } + } + + // Also give the chown since the chmod is only 755 + if (!Piwik_Common::isWindows()) { + $realpath = Piwik_Common::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 = null) - { - if( $directoriesToCheck == null ) - { - $directoriesToCheck = array( - '/config/', - '/tmp/', - '/tmp/templates_c/', - '/tmp/cache/', - '/tmp/assets/', - '/tmp/latest/', - '/tmp/tcpdf/', - '/tmp/sessions/', - ); - } - - $resultCheck = array(); - foreach($directoriesToCheck as $directoryToCheck) - { - if( !preg_match('/^'.preg_quote(PIWIK_USER_PATH, '/').'/', $directoryToCheck) ) - { - $directoryToCheck = PIWIK_USER_PATH . $directoryToCheck; - } - - if(!file_exists($directoryToCheck)) - { - Piwik_Common::mkdir($directoryToCheck); - } - - $directory = Piwik_Common::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 = Piwik_Common::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; - } - - /** - * Generate default robots.txt, favicon.ico, etc to suppress - * 404 (Not Found) errors in the web server logs, if Piwik - * is installed in the web root (or top level of subdomain). - * - * @see misc/crossdomain.xml - */ - static public function createWebRootFiles() - { - $filesToCreate = array( - '/robots.txt', - '/favicon.ico', - ); - foreach($filesToCreate as $file) - { - @file_put_contents(PIWIK_DOCUMENT_ROOT . $file, ''); - } - } - - /** - * Generate Apache .htaccess files to restrict access - */ - static public function createHtAccessFiles() - { - // deny access to these folders - $directoriesToProtect = array( - '/config', - '/core', - '/lang', - '/tmp', - ); - foreach($directoriesToProtect as $directoryToProtect) - { - Piwik_Common::createHtAccess(PIWIK_INCLUDE_PATH . $directoryToProtect, $overwrite = true); - } - - // Allow/Deny lives in different modules depending on the Apache version - $allow = "<IfModule mod_access.c>\nAllow from all\n</IfModule>\n<IfModule !mod_access_compat>\n<IfModule mod_authz_host.c>\nAllow from all\n</IfModule>\n</IfModule>\n<IfModule mod_access_compat>\nAllow from all\n</IfModule>\n"; - $deny = "<IfModule mod_access.c>\nDeny from all\n</IfModule>\n<IfModule !mod_access_compat>\n<IfModule mod_authz_host.c>\nDeny from all\n</IfModule>\n</IfModule>\n<IfModule mod_access_compat>\nDeny from all\n</IfModule>\n"; - - // more selective allow/deny filters - $allowAny = "<Files \"*\">\n".$allow."Satisfy any\n</Files>\n"; - $allowStaticAssets = "<Files ~ \"\\.(test\.php|gif|ico|jpg|png|svg|js|css|swf)$\">\n".$allow."Satisfy any\n</Files>\n"; - $denyDirectPhp = "<Files ~ \"\\.(php|php4|php5|inc|tpl|in)$\">\n".$deny."</Files>\n"; - - $directoriesToProtect = array( - '/js' => $allowAny, - '/libs' => $denyDirectPhp . $allowStaticAssets, - '/plugins' => $denyDirectPhp . $allowStaticAssets, - '/themes' => $denyDirectPhp . $allowStaticAssets, - ); - foreach($directoriesToProtect as $directoryToProtect => $content) - { - Piwik_Common::createHtAccess(PIWIK_INCLUDE_PATH . $directoryToProtect, $overwrite = true, $content); - } - } - - /** - * Generate IIS web.config files to restrict access - * - * Note: for IIS 7 and above - */ - static public function createWebConfigFiles() - { - @file_put_contents(PIWIK_INCLUDE_PATH . '/web.config', -'<?xml version="1.0" encoding="UTF-8"?> + . "<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 = null) + { + if ($directoriesToCheck == null) { + $directoriesToCheck = array( + '/config/', + '/tmp/', + '/tmp/templates_c/', + '/tmp/cache/', + '/tmp/assets/', + '/tmp/latest/', + '/tmp/tcpdf/', + '/tmp/sessions/', + ); + } + + $resultCheck = array(); + foreach ($directoriesToCheck as $directoryToCheck) { + if (!preg_match('/^' . preg_quote(PIWIK_USER_PATH, '/') . '/', $directoryToCheck)) { + $directoryToCheck = PIWIK_USER_PATH . $directoryToCheck; + } + + if (!file_exists($directoryToCheck)) { + Piwik_Common::mkdir($directoryToCheck); + } + + $directory = Piwik_Common::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 = Piwik_Common::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; + } + + /** + * Generate default robots.txt, favicon.ico, etc to suppress + * 404 (Not Found) errors in the web server logs, if Piwik + * is installed in the web root (or top level of subdomain). + * + * @see misc/crossdomain.xml + */ + static public function createWebRootFiles() + { + $filesToCreate = array( + '/robots.txt', + '/favicon.ico', + ); + foreach ($filesToCreate as $file) { + @file_put_contents(PIWIK_DOCUMENT_ROOT . $file, ''); + } + } + + /** + * Generate Apache .htaccess files to restrict access + */ + static public function createHtAccessFiles() + { + // deny access to these folders + $directoriesToProtect = array( + '/config', + '/core', + '/lang', + '/tmp', + ); + foreach ($directoriesToProtect as $directoryToProtect) { + Piwik_Common::createHtAccess(PIWIK_INCLUDE_PATH . $directoryToProtect, $overwrite = true); + } + + // Allow/Deny lives in different modules depending on the Apache version + $allow = "<IfModule mod_access.c>\nAllow from all\n</IfModule>\n<IfModule !mod_access_compat>\n<IfModule mod_authz_host.c>\nAllow from all\n</IfModule>\n</IfModule>\n<IfModule mod_access_compat>\nAllow from all\n</IfModule>\n"; + $deny = "<IfModule mod_access.c>\nDeny from all\n</IfModule>\n<IfModule !mod_access_compat>\n<IfModule mod_authz_host.c>\nDeny from all\n</IfModule>\n</IfModule>\n<IfModule mod_access_compat>\nDeny from all\n</IfModule>\n"; + + // more selective allow/deny filters + $allowAny = "<Files \"*\">\n" . $allow . "Satisfy any\n</Files>\n"; + $allowStaticAssets = "<Files ~ \"\\.(test\.php|gif|ico|jpg|png|svg|js|css|swf)$\">\n" . $allow . "Satisfy any\n</Files>\n"; + $denyDirectPhp = "<Files ~ \"\\.(php|php4|php5|inc|tpl|in)$\">\n" . $deny . "</Files>\n"; + + $directoriesToProtect = array( + '/js' => $allowAny, + '/libs' => $denyDirectPhp . $allowStaticAssets, + '/plugins' => $denyDirectPhp . $allowStaticAssets, + '/themes' => $denyDirectPhp . $allowStaticAssets, + ); + foreach ($directoriesToProtect as $directoryToProtect => $content) { + Piwik_Common::createHtAccess(PIWIK_INCLUDE_PATH . $directoryToProtect, $overwrite = true, $content); + } + } + + /** + * Generate IIS web.config files to restrict access + * + * Note: for IIS 7 and above + */ + static public function createWebConfigFiles() + { + @file_put_contents(PIWIK_INCLUDE_PATH . '/web.config', + '<?xml version="1.0" encoding="UTF-8"?> <configuration> <system.webServer> <security> @@ -636,15 +592,14 @@ class Piwik </system.webServer> </configuration>'); - // deny direct access to .php files - $directoriesToProtect = array( - '/libs', - '/plugins', - ); - foreach($directoriesToProtect as $directoryToProtect) - { - @file_put_contents(PIWIK_INCLUDE_PATH . $directoryToProtect . '/web.config', -'<?xml version="1.0" encoding="UTF-8"?> + // deny direct access to .php files + $directoriesToProtect = array( + '/libs', + '/plugins', + ); + foreach ($directoriesToProtect as $directoryToProtect) { + @file_put_contents(PIWIK_INCLUDE_PATH . $directoryToProtect . '/web.config', + '<?xml version="1.0" encoding="UTF-8"?> <configuration> <system.webServer> <security> @@ -656,2124 +611,1987 @@ class Piwik </security> </system.webServer> </configuration>'); - } - } - - /** - * 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; - - // ignore dev environments - if(file_exists(PIWIK_INCLUDE_PATH . '/.git')) - { - $messages[] = Piwik_Translate('General_WarningFileIntegritySkipped'); - return $messages; - } - - $manifest = PIWIK_INCLUDE_PATH . '/config/manifest.inc.php'; - if(!file_exists($manifest)) - { - $messages[] = Piwik_Translate('General_WarningFileIntegrityNoManifest'); - 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; - } - - /** - * Test if php output is compressed - * - * @return bool True if php output is (or suspected/likely) to be compressed - */ - static public function isPhpOutputCompressed() - { - // Off = ''; On = '1'; otherwise, it's a buffer size - $zlibOutputCompression = ini_get('zlib.output_compression'); - - // could be ob_gzhandler, ob_deflatehandler, etc - $outputHandler = ini_get('output_handler'); - - // output handlers can be stacked - $obHandlers = array_filter( ob_list_handlers(), create_function('$var', 'return $var !== "default output handler";') ); - - // user defined handler via wrapper - $autoPrependFile = ini_get('auto_prepend_file'); - $autoAppendFile = ini_get('auto_append_file'); - - return !empty($zlibOutputCompression) || - !empty($outputHandler) || - !empty($obHandlers) || - !empty($autoPrependFile) || - !empty($autoAppendFile); - } - - /** - * Serve static files through php proxy. - * - * It performs the following actions: - * - Checks the file is readable or returns "HTTP/1.0 404 Not Found" - * - Returns "HTTP/1.1 304 Not Modified" after comparing the HTTP_IF_MODIFIED_SINCE - * with the modification date of the static file - * - Will try to compress the static file according to HTTP_ACCEPT_ENCODING. Compressed files are store in - * the /tmp directory. If compressing extensions are not available, a manually gzip compressed file - * can be provided in the /tmp directory. It has to bear the same name with an added .gz extension. - * Using manually compressed static files requires you to manually update the compressed file when - * the static file is updated. - * - Overrides server cache control config to allow caching - * - Sends Very Accept-Encoding to tell proxies to store different version of the static file according - * to users encoding capacities. - * - * Warning: - * Compressed filed are stored in the /tmp directory. - * If this method is used with two files bearing the same name but located in different locations, - * there is a risk of conflict. One file could be served with the content of the other. - * A future upgrade of this method would be to recreate the directory structure of the static file - * within a /tmp/compressed-static-files directory. - * - * @param string $file The location of the static file to serve - * @param string $contentType The content type of the static file. - * @param bool $expireFarFuture If set to true, will set Expires: header in far future. - * Should be set to false for files that don't have a cache buster (eg. piwik.js) - */ - static public function serveStaticFile($file, $contentType, $expireFarFuture = true) - { - if (file_exists($file)) - { - // conditional GET - $modifiedSince = ''; - if (isset($_SERVER['HTTP_IF_MODIFIED_SINCE'])) - { - $modifiedSince = $_SERVER['HTTP_IF_MODIFIED_SINCE']; - - // strip any trailing data appended to header - if (false !== ($semicolon = strpos($modifiedSince, ';'))) - { - $modifiedSince = substr($modifiedSince, 0, $semicolon); - } - } - - $fileModifiedTime = @filemtime($file); - $lastModified = gmdate('D, d M Y H:i:s', $fileModifiedTime) . ' GMT'; - - // set HTTP response headers - self::overrideCacheControlHeaders('public'); - @header('Vary: Accept-Encoding'); - @header('Content-Disposition: inline; filename='.basename($file)); - - if($expireFarFuture) - { - // Required by proxy caches potentially in between the browser and server to cache the request indeed - @header("Expires: ".gmdate('D, d M Y H:i:s', time() + 86400 * 100) . ' GMT'); - } - - // Returns 304 if not modified since - if ($modifiedSince === $lastModified) - { - self::setHttpStatus('304 Not Modified'); - } - else - { - // optional compression - $compressed = false; - $encoding = ''; - $compressedFileLocation = PIWIK_USER_PATH . self::COMPRESSED_FILE_LOCATION . basename($file); - - $phpOutputCompressionEnabled = self::isPhpOutputCompressed(); - if (isset($_SERVER['HTTP_ACCEPT_ENCODING']) && !$phpOutputCompressionEnabled) - { - $acceptEncoding = $_SERVER['HTTP_ACCEPT_ENCODING']; - - if (extension_loaded('zlib') && function_exists('file_get_contents') && function_exists('file_put_contents')) - { - if (preg_match('/(?:^|, ?)(deflate)(?:,|$)/', $acceptEncoding, $matches)) - { - $encoding = 'deflate'; - $filegz = $compressedFileLocation .'.deflate'; - } - else if (preg_match('/(?:^|, ?)((x-)?gzip)(?:,|$)/', $acceptEncoding, $matches)) - { - $encoding = $matches[1]; - $filegz = $compressedFileLocation .'.gz'; - } - - if (!empty($encoding)) - { - // compress-on-demand and use cache - if(!file_exists($filegz) || ($fileModifiedTime > @filemtime($filegz))) - { - $data = file_get_contents($file); - - if ($encoding == 'deflate') - { - $data = gzdeflate($data, 9); - } - else if ($encoding == 'gzip' || $encoding == 'x-gzip') - { - $data = gzencode($data, 9); - } - - file_put_contents($filegz, $data); - } - - $compressed = true; - $file = $filegz; - } - } - else - { - // manually compressed - $filegz = $compressedFileLocation .'.gz'; - if (preg_match('/(?:^|, ?)((x-)?gzip)(?:,|$)/', $acceptEncoding, $matches) && file_exists($filegz) && ($fileModifiedTime < @filemtime($filegz))) - { - $encoding = $matches[1]; - $compressed = true; - $file = $filegz; - } - } - } - - @header('Last-Modified: ' . $lastModified); - - if(!$phpOutputCompressionEnabled) - { - @header('Content-Length: ' . filesize($file)); - } - - if(!empty($contentType)) - { - @header('Content-Type: '.$contentType); - } - - if($compressed) - { - @header('Content-Encoding: ' . $encoding); - } - - if(!_readfile($file)) - { - self::setHttpStatus('505 Internal server error'); - } - } - } - else - { - self::setHttpStatus('404 Not Found'); - } - } - - /** - * Create CSV (or other delimited) files - * - * @param string $filePath filename to create - * @param array $fileSpec File specifications (delimiter, line terminator, etc) - * @param array $rows Array of array corresponding to rows of values - * @throws Exception if unable to create or write to file - */ - static public function createCSVFile($filePath, $fileSpec, $rows) - { - // Set up CSV delimiters, quotes, etc - $delim = $fileSpec['delim']; - $quote = $fileSpec['quote']; - $eol = $fileSpec['eol']; - $null = $fileSpec['null']; - $escapespecial_cb = $fileSpec['escapespecial_cb']; - - $fp = @fopen($filePath, 'wb'); - if (!$fp) - { - throw new Exception('Error creating the tmp file '.$filePath.', please check that the webserver has write permission to write this file.'); - } - - foreach ($rows as $row) - { - $output = ''; - foreach($row as $value) - { - if(!isset($value) || is_null($value) || $value === false) - { - $output .= $null.$delim; - } - else - { - $output .= $quote.$escapespecial_cb($value).$quote.$delim; - } - } - - // Replace delim with eol - $output = substr_replace($output, $eol, -1); - - $ret = fwrite($fp, $output); - if (!$ret) { - fclose($fp); - throw new Exception('Error writing to the tmp file '.$filePath); - } - } - fclose($fp); - - @chmod($filePath, 0777); - } - -/* + } + } + + /** + * 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; + + // ignore dev environments + if (file_exists(PIWIK_INCLUDE_PATH . '/.git')) { + $messages[] = Piwik_Translate('General_WarningFileIntegritySkipped'); + return $messages; + } + + $manifest = PIWIK_INCLUDE_PATH . '/config/manifest.inc.php'; + if (!file_exists($manifest)) { + $messages[] = Piwik_Translate('General_WarningFileIntegrityNoManifest'); + 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; + } + + /** + * Test if php output is compressed + * + * @return bool True if php output is (or suspected/likely) to be compressed + */ + static public function isPhpOutputCompressed() + { + // Off = ''; On = '1'; otherwise, it's a buffer size + $zlibOutputCompression = ini_get('zlib.output_compression'); + + // could be ob_gzhandler, ob_deflatehandler, etc + $outputHandler = ini_get('output_handler'); + + // output handlers can be stacked + $obHandlers = array_filter(ob_list_handlers(), create_function('$var', 'return $var !== "default output handler";')); + + // user defined handler via wrapper + $autoPrependFile = ini_get('auto_prepend_file'); + $autoAppendFile = ini_get('auto_append_file'); + + return !empty($zlibOutputCompression) || + !empty($outputHandler) || + !empty($obHandlers) || + !empty($autoPrependFile) || + !empty($autoAppendFile); + } + + /** + * Serve static files through php proxy. + * + * It performs the following actions: + * - Checks the file is readable or returns "HTTP/1.0 404 Not Found" + * - Returns "HTTP/1.1 304 Not Modified" after comparing the HTTP_IF_MODIFIED_SINCE + * with the modification date of the static file + * - Will try to compress the static file according to HTTP_ACCEPT_ENCODING. Compressed files are store in + * the /tmp directory. If compressing extensions are not available, a manually gzip compressed file + * can be provided in the /tmp directory. It has to bear the same name with an added .gz extension. + * Using manually compressed static files requires you to manually update the compressed file when + * the static file is updated. + * - Overrides server cache control config to allow caching + * - Sends Very Accept-Encoding to tell proxies to store different version of the static file according + * to users encoding capacities. + * + * Warning: + * Compressed filed are stored in the /tmp directory. + * If this method is used with two files bearing the same name but located in different locations, + * there is a risk of conflict. One file could be served with the content of the other. + * A future upgrade of this method would be to recreate the directory structure of the static file + * within a /tmp/compressed-static-files directory. + * + * @param string $file The location of the static file to serve + * @param string $contentType The content type of the static file. + * @param bool $expireFarFuture If set to true, will set Expires: header in far future. + * Should be set to false for files that don't have a cache buster (eg. piwik.js) + */ + static public function serveStaticFile($file, $contentType, $expireFarFuture = true) + { + if (file_exists($file)) { + // conditional GET + $modifiedSince = ''; + if (isset($_SERVER['HTTP_IF_MODIFIED_SINCE'])) { + $modifiedSince = $_SERVER['HTTP_IF_MODIFIED_SINCE']; + + // strip any trailing data appended to header + if (false !== ($semicolon = strpos($modifiedSince, ';'))) { + $modifiedSince = substr($modifiedSince, 0, $semicolon); + } + } + + $fileModifiedTime = @filemtime($file); + $lastModified = gmdate('D, d M Y H:i:s', $fileModifiedTime) . ' GMT'; + + // set HTTP response headers + self::overrideCacheControlHeaders('public'); + @header('Vary: Accept-Encoding'); + @header('Content-Disposition: inline; filename=' . basename($file)); + + if ($expireFarFuture) { + // Required by proxy caches potentially in between the browser and server to cache the request indeed + @header("Expires: " . gmdate('D, d M Y H:i:s', time() + 86400 * 100) . ' GMT'); + } + + // Returns 304 if not modified since + if ($modifiedSince === $lastModified) { + self::setHttpStatus('304 Not Modified'); + } else { + // optional compression + $compressed = false; + $encoding = ''; + $compressedFileLocation = PIWIK_USER_PATH . self::COMPRESSED_FILE_LOCATION . basename($file); + + $phpOutputCompressionEnabled = self::isPhpOutputCompressed(); + if (isset($_SERVER['HTTP_ACCEPT_ENCODING']) && !$phpOutputCompressionEnabled) { + $acceptEncoding = $_SERVER['HTTP_ACCEPT_ENCODING']; + + if (extension_loaded('zlib') && function_exists('file_get_contents') && function_exists('file_put_contents')) { + if (preg_match('/(?:^|, ?)(deflate)(?:,|$)/', $acceptEncoding, $matches)) { + $encoding = 'deflate'; + $filegz = $compressedFileLocation . '.deflate'; + } else if (preg_match('/(?:^|, ?)((x-)?gzip)(?:,|$)/', $acceptEncoding, $matches)) { + $encoding = $matches[1]; + $filegz = $compressedFileLocation . '.gz'; + } + + if (!empty($encoding)) { + // compress-on-demand and use cache + if (!file_exists($filegz) || ($fileModifiedTime > @filemtime($filegz))) { + $data = file_get_contents($file); + + if ($encoding == 'deflate') { + $data = gzdeflate($data, 9); + } else if ($encoding == 'gzip' || $encoding == 'x-gzip') { + $data = gzencode($data, 9); + } + + file_put_contents($filegz, $data); + } + + $compressed = true; + $file = $filegz; + } + } else { + // manually compressed + $filegz = $compressedFileLocation . '.gz'; + if (preg_match('/(?:^|, ?)((x-)?gzip)(?:,|$)/', $acceptEncoding, $matches) && file_exists($filegz) && ($fileModifiedTime < @filemtime($filegz))) { + $encoding = $matches[1]; + $compressed = true; + $file = $filegz; + } + } + } + + @header('Last-Modified: ' . $lastModified); + + if (!$phpOutputCompressionEnabled) { + @header('Content-Length: ' . filesize($file)); + } + + if (!empty($contentType)) { + @header('Content-Type: ' . $contentType); + } + + if ($compressed) { + @header('Content-Encoding: ' . $encoding); + } + + if (!_readfile($file)) { + self::setHttpStatus('505 Internal server error'); + } + } + } else { + self::setHttpStatus('404 Not Found'); + } + } + + /** + * Create CSV (or other delimited) files + * + * @param string $filePath filename to create + * @param array $fileSpec File specifications (delimiter, line terminator, etc) + * @param array $rows Array of array corresponding to rows of values + * @throws Exception if unable to create or write to file + */ + static public function createCSVFile($filePath, $fileSpec, $rows) + { + // Set up CSV delimiters, quotes, etc + $delim = $fileSpec['delim']; + $quote = $fileSpec['quote']; + $eol = $fileSpec['eol']; + $null = $fileSpec['null']; + $escapespecial_cb = $fileSpec['escapespecial_cb']; + + $fp = @fopen($filePath, 'wb'); + if (!$fp) { + throw new Exception('Error creating the tmp file ' . $filePath . ', please check that the webserver has write permission to write this file.'); + } + + foreach ($rows as $row) { + $output = ''; + foreach ($row as $value) { + if (!isset($value) || is_null($value) || $value === false) { + $output .= $null . $delim; + } else { + $output .= $quote . $escapespecial_cb($value) . $quote . $delim; + } + } + + // Replace delim with eol + $output = substr_replace($output, $eol, -1); + + $ret = fwrite($fp, $output); + if (!$ret) { + fclose($fp); + throw new Exception('Error writing to the tmp file ' . $filePath); + } + } + fclose($fp); + + @chmod($filePath, 0777); + } + + /* * PHP environment settings */ - /** - * Set maximum script execution time. - * - * @param int $executionTime max execution time in seconds (0 = no limit) - */ - static public function setMaxExecutionTime($executionTime) - { - // in the event one or the other is disabled... - @ini_set('max_execution_time', $executionTime); - @set_time_limit($executionTime); - } - - /** - * Get php memory_limit (in Megabytes) - * - * Prior to PHP 5.2.1, or on Windows, --enable-memory-limit is not a - * compile-time default, so ini_get('memory_limit') may return false. - * - * @see http://www.php.net/manual/en/faq.using.php#faq.using.shorthandbytes - * @return int|false memory limit in megabytes, or false if there is no limit - */ - static public function getMemoryLimitValue() - { - if(($memory = ini_get('memory_limit')) > 0) - { - // handle shorthand byte options (case-insensitive) - $shorthandByteOption = substr($memory, -1); - switch($shorthandByteOption) - { - case 'G': - case 'g': - return substr($memory, 0, -1) * 1024; - case 'M': - case 'm': - return substr($memory, 0, -1); - case 'K': - case 'k': - return substr($memory, 0, -1) / 1024; - } - return $memory / 1048576; - } - - // no memory limit - return false; - } - - /** - * Set PHP memory limit - * - * Note: system settings may prevent scripts from overriding the master value - * - * @param int $minimumMemoryLimit - * @return bool true if set; false otherwise - */ - static public function setMemoryLimit($minimumMemoryLimit) - { - // in Megabytes - $currentValue = self::getMemoryLimitValue(); - if( $currentValue === false - || ($currentValue < $minimumMemoryLimit && @ini_set('memory_limit', $minimumMemoryLimit.'M'))) - { - return true; - } - return false; - } - - /** - * Raise PHP memory limit if below the minimum required - * - * @return bool true if set; false otherwise - */ - static public function raiseMemoryLimitIfNecessary() - { - $memoryLimit = self::getMemoryLimitValue(); - if($memoryLimit === false) - { - return false; - } - $minimumMemoryLimit = Piwik_Config::getInstance()->General['minimum_memory_limit']; - - if(Piwik_Common::isArchivePhpTriggered() - && Piwik::isUserIsSuperUser()) - { - // archive.php: no time limit, high memory limit - self::setMaxExecutionTime(0); - $minimumMemoryLimitWhenArchiving = Piwik_Config::getInstance()->General['minimum_memory_limit_when_archiving']; - if($memoryLimit < $minimumMemoryLimitWhenArchiving) - { - return self::setMemoryLimit($minimumMemoryLimitWhenArchiving); - } - return false; - } - if($memoryLimit < $minimumMemoryLimit) - { - return self::setMemoryLimit($minimumMemoryLimit); - } - return false; - } - -/* + /** + * Set maximum script execution time. + * + * @param int $executionTime max execution time in seconds (0 = no limit) + */ + static public function setMaxExecutionTime($executionTime) + { + // in the event one or the other is disabled... + @ini_set('max_execution_time', $executionTime); + @set_time_limit($executionTime); + } + + /** + * Get php memory_limit (in Megabytes) + * + * Prior to PHP 5.2.1, or on Windows, --enable-memory-limit is not a + * compile-time default, so ini_get('memory_limit') may return false. + * + * @see http://www.php.net/manual/en/faq.using.php#faq.using.shorthandbytes + * @return int|false memory limit in megabytes, or false if there is no limit + */ + static public function getMemoryLimitValue() + { + if (($memory = ini_get('memory_limit')) > 0) { + // handle shorthand byte options (case-insensitive) + $shorthandByteOption = substr($memory, -1); + switch ($shorthandByteOption) { + case 'G': + case 'g': + return substr($memory, 0, -1) * 1024; + case 'M': + case 'm': + return substr($memory, 0, -1); + case 'K': + case 'k': + return substr($memory, 0, -1) / 1024; + } + return $memory / 1048576; + } + + // no memory limit + return false; + } + + /** + * Set PHP memory limit + * + * Note: system settings may prevent scripts from overriding the master value + * + * @param int $minimumMemoryLimit + * @return bool true if set; false otherwise + */ + static public function setMemoryLimit($minimumMemoryLimit) + { + // in Megabytes + $currentValue = self::getMemoryLimitValue(); + if ($currentValue === false + || ($currentValue < $minimumMemoryLimit && @ini_set('memory_limit', $minimumMemoryLimit . 'M')) + ) { + return true; + } + return false; + } + + /** + * Raise PHP memory limit if below the minimum required + * + * @return bool true if set; false otherwise + */ + static public function raiseMemoryLimitIfNecessary() + { + $memoryLimit = self::getMemoryLimitValue(); + if ($memoryLimit === false) { + return false; + } + $minimumMemoryLimit = Piwik_Config::getInstance()->General['minimum_memory_limit']; + + if (Piwik_Common::isArchivePhpTriggered() + && Piwik::isUserIsSuperUser() + ) { + // archive.php: no time limit, high memory limit + self::setMaxExecutionTime(0); + $minimumMemoryLimitWhenArchiving = Piwik_Config::getInstance()->General['minimum_memory_limit_when_archiving']; + if ($memoryLimit < $minimumMemoryLimitWhenArchiving) { + return self::setMemoryLimit($minimumMemoryLimitWhenArchiving); + } + return false; + } + if ($memoryLimit < $minimumMemoryLimit) { + return self::setMemoryLimit($minimumMemoryLimit); + } + return false; + } + + /* * Logging and error handling */ - public static $shouldLog = null; - - /** - * Log a message - * - * @param string $message - */ - static public function log($message = '') - { - if(is_null(self::$shouldLog)) - { - self::$shouldLog = self::shouldLoggerLog(); - // It is possible that the logger is not setup: - // - Tracker request, and debug disabled, - // - and some scheduled tasks call code that tries and log something - try { - Zend_Registry::get('logger_message'); - } catch(Exception $e) { - self::$shouldLog = false; - } - } - if(self::$shouldLog) - { - Zend_Registry::get('logger_message')->logEvent($message); - } - } - - /** - * Returns if logging should work - * @return bool - */ - static public function shouldLoggerLog() - { - try { - $shouldLog = (Piwik_Common::isPhpCliMode() - || Piwik_Config::getInstance()->log['log_only_when_cli'] == 0) - && - ( Piwik_Config::getInstance()->log['log_only_when_debug_parameter'] == 0 - || isset($_REQUEST['debug'])) - ; - } catch(Exception $e) { - $shouldLog = false; - } - return $shouldLog; - } - - /** - * Trigger E_USER_ERROR with optional message - * - * @param string $message - */ - static public function error($message = '') - { - trigger_error($message, E_USER_ERROR); - } - - /** - * Display the message in a nice red font with a nice icon - * ... and dies - * - * @param string $message - */ - static public function exitWithErrorMessage( $message ) - { - $output = "<style>a{color:red;}</style>\n". - "<div style='color:red;font-family:Georgia;font-size:120%'>". - "<p><img src='themes/default/images/error_medium.png' style='vertical-align:middle; float:left;padding:20 20 20 20' />". - $message. - "</p></div>"; - print(Piwik_Log_Formatter_ScreenFormatter::getFormattedString($output)); - exit; - } - -/* + public static $shouldLog = null; + + /** + * Log a message + * + * @param string $message + */ + static public function log($message = '') + { + if (is_null(self::$shouldLog)) { + self::$shouldLog = self::shouldLoggerLog(); + // It is possible that the logger is not setup: + // - Tracker request, and debug disabled, + // - and some scheduled tasks call code that tries and log something + try { + Zend_Registry::get('logger_message'); + } catch (Exception $e) { + self::$shouldLog = false; + } + } + if (self::$shouldLog) { + Zend_Registry::get('logger_message')->logEvent($message); + } + } + + /** + * Returns if logging should work + * @return bool + */ + static public function shouldLoggerLog() + { + try { + $shouldLog = (Piwik_Common::isPhpCliMode() + || Piwik_Config::getInstance()->log['log_only_when_cli'] == 0) + && + (Piwik_Config::getInstance()->log['log_only_when_debug_parameter'] == 0 + || isset($_REQUEST['debug'])); + } catch (Exception $e) { + $shouldLog = false; + } + return $shouldLog; + } + + /** + * Trigger E_USER_ERROR with optional message + * + * @param string $message + */ + static public function error($message = '') + { + trigger_error($message, E_USER_ERROR); + } + + /** + * Display the message in a nice red font with a nice icon + * ... and dies + * + * @param string $message + */ + static public function exitWithErrorMessage($message) + { + $output = "<style>a{color:red;}</style>\n" . + "<div style='color:red;font-family:Georgia;font-size:120%'>" . + "<p><img src='themes/default/images/error_medium.png' style='vertical-align:middle; float:left;padding:20 20 20 20' />" . + $message . + "</p></div>"; + print(Piwik_Log_Formatter_ScreenFormatter::getFormattedString($output)); + exit; + } + + /* * Profiling */ - /** - * Get total number of queries - * - * @return int number of queries - */ - static public function getQueryCount() - { - $profiler = Zend_Registry::get('db')->getProfiler(); - return $profiler->getTotalNumQueries(); - } - - /** - * Get total elapsed time (in seconds) - * - * @return int elapsed time - */ - static public function getDbElapsedSecs() - { - $profiler = Zend_Registry::get('db')->getProfiler(); - return $profiler->getTotalElapsedSecs(); - } - - /** - * Print number of queries and elapsed time - */ - static public function printQueryCount() - { - $totalTime = self::getDbElapsedSecs(); - $queryCount = self::getQueryCount(); - Piwik::log(sprintf("Total queries = %d (total sql time = %.2fs)", $queryCount, $totalTime)); - } - - /** - * Print profiling report for the tracker - * - * @param Piwik_Tracker_Db $db Tracker database object (or null) - */ - static public function printSqlProfilingReportTracker( $db = null ) - { - if(!function_exists('maxSumMsFirst')) - { - function maxSumMsFirst($a,$b) - { - return $a['sum_time_ms'] < $b['sum_time_ms']; - } - } - - if(is_null($db)) - { - $db = Piwik_Tracker::getDatabase(); - } - $tableName = Piwik_Common::prefixTable('log_profiling'); - - $all = $db->fetchAll('SELECT * FROM '.$tableName ); - if($all === false) - { - return; - } - uasort($all, 'maxSumMsFirst'); - - $infoIndexedByQuery = array(); - foreach($all as $infoQuery) - { - $query = $infoQuery['query']; - $count = $infoQuery['count']; - $sum_time_ms = $infoQuery['sum_time_ms']; - $infoIndexedByQuery[$query] = array('count' => $count, 'sumTimeMs' => $sum_time_ms); - } - Piwik::getSqlProfilingQueryBreakdownOutput($infoIndexedByQuery); - } - - /** - * Outputs SQL Profiling reports - * It is automatically called when enabling the SQL profiling in the config file enable_sql_profiler - * @throws Exception - */ - static function printSqlProfilingReportZend() - { - $profiler = Zend_Registry::get('db')->getProfiler(); - - if(!$profiler->getEnabled()) - { - throw new Exception("To display the profiler you should enable enable_sql_profiler on your config/config.ini.php file"); - } - - $infoIndexedByQuery = array(); - foreach($profiler->getQueryProfiles() as $query) - { - if(isset($infoIndexedByQuery[$query->getQuery()])) - { - $existing = $infoIndexedByQuery[$query->getQuery()]; - } - else - { - $existing = array( 'count' => 0, 'sumTimeMs' => 0); - } - $new = array( 'count' => $existing['count'] + 1, - 'sumTimeMs' => $existing['count'] + $query->getElapsedSecs() * 1000); - $infoIndexedByQuery[$query->getQuery()] = $new; - } - - if(!function_exists('sortTimeDesc')) - { - function sortTimeDesc($a,$b) - { - return $a['sumTimeMs'] < $b['sumTimeMs']; - } - } - uasort( $infoIndexedByQuery, 'sortTimeDesc'); - - $str = '<hr /><b>SQL Profiler</b><hr /><b>Summary</b><br/>'; - $totalTime = $profiler->getTotalElapsedSecs(); - $queryCount = $profiler->getTotalNumQueries(); - $longestTime = 0; - $longestQuery = null; - foreach ($profiler->getQueryProfiles() as $query) { - if ($query->getElapsedSecs() > $longestTime) { - $longestTime = $query->getElapsedSecs(); - $longestQuery = $query->getQuery(); - } - } - $str .= 'Executed ' . $queryCount . ' queries in ' . round($totalTime,3) . ' seconds'; - $str .= '(Average query length: ' . round($totalTime / $queryCount,3) . ' seconds)'; - $str .= '<br />Queries per second: ' . round($queryCount / $totalTime,1) ; - $str .= '<br />Longest query length: ' . round($longestTime,3) . " seconds (<code>$longestQuery</code>)"; - Piwik::log($str); - Piwik::getSqlProfilingQueryBreakdownOutput($infoIndexedByQuery); - } - - /** - * Log a breakdown by query - * - * @param array $infoIndexedByQuery - */ - static private function getSqlProfilingQueryBreakdownOutput( $infoIndexedByQuery ) - { - $output = '<hr /><b>Breakdown by query</b><br/>'; - foreach($infoIndexedByQuery as $query => $queryInfo) - { - $timeMs = round($queryInfo['sumTimeMs'],1); - $count = $queryInfo['count']; - $avgTimeString = ''; - if($count > 1) - { - $avgTimeMs = $timeMs / $count; - $avgTimeString = " (average = <b>". round($avgTimeMs,1) . "ms</b>)"; - } - $query = preg_replace('/([\t\n\r ]+)/', ' ', $query); - $output .= "Executed <b>$count</b> time". ($count==1?'':'s') ." in <b>".$timeMs."ms</b> $avgTimeString <pre>\t$query</pre>"; - } - Piwik::log($output); - } - - /** - * Print timer - */ - static public function printTimer() - { - Piwik::log(Zend_Registry::get('timer')); - } - - /** - * Print memory leak - * - * @param string $prefix - * @param string $suffix - */ - static public function printMemoryLeak($prefix = '', $suffix = '<br />') - { - echo $prefix; - echo Zend_Registry::get('timer')->getMemoryLeak(); - echo $suffix; - } - - /** - * Print memory usage - * - * @return string - */ - static public function getMemoryUsage() - { - $memory = false; - if(function_exists('xdebug_memory_usage')) - { - $memory = xdebug_memory_usage(); - } - elseif(function_exists('memory_get_usage')) - { - $memory = memory_get_usage(); - } - if($memory === false) - { - return "Memory usage function not found."; - } - $usage = number_format( round($memory / 1024 / 1024, 2), 2); - return "$usage Mb"; - } - -/* + /** + * Get total number of queries + * + * @return int number of queries + */ + static public function getQueryCount() + { + $profiler = Zend_Registry::get('db')->getProfiler(); + return $profiler->getTotalNumQueries(); + } + + /** + * Get total elapsed time (in seconds) + * + * @return int elapsed time + */ + static public function getDbElapsedSecs() + { + $profiler = Zend_Registry::get('db')->getProfiler(); + return $profiler->getTotalElapsedSecs(); + } + + /** + * Print number of queries and elapsed time + */ + static public function printQueryCount() + { + $totalTime = self::getDbElapsedSecs(); + $queryCount = self::getQueryCount(); + Piwik::log(sprintf("Total queries = %d (total sql time = %.2fs)", $queryCount, $totalTime)); + } + + /** + * Print profiling report for the tracker + * + * @param Piwik_Tracker_Db $db Tracker database object (or null) + */ + static public function printSqlProfilingReportTracker($db = null) + { + if (!function_exists('maxSumMsFirst')) { + function maxSumMsFirst($a, $b) + { + return $a['sum_time_ms'] < $b['sum_time_ms']; + } + } + + if (is_null($db)) { + $db = Piwik_Tracker::getDatabase(); + } + $tableName = Piwik_Common::prefixTable('log_profiling'); + + $all = $db->fetchAll('SELECT * FROM ' . $tableName); + if ($all === false) { + return; + } + uasort($all, 'maxSumMsFirst'); + + $infoIndexedByQuery = array(); + foreach ($all as $infoQuery) { + $query = $infoQuery['query']; + $count = $infoQuery['count']; + $sum_time_ms = $infoQuery['sum_time_ms']; + $infoIndexedByQuery[$query] = array('count' => $count, 'sumTimeMs' => $sum_time_ms); + } + Piwik::getSqlProfilingQueryBreakdownOutput($infoIndexedByQuery); + } + + /** + * Outputs SQL Profiling reports + * It is automatically called when enabling the SQL profiling in the config file enable_sql_profiler + * @throws Exception + */ + static function printSqlProfilingReportZend() + { + $profiler = Zend_Registry::get('db')->getProfiler(); + + if (!$profiler->getEnabled()) { + throw new Exception("To display the profiler you should enable enable_sql_profiler on your config/config.ini.php file"); + } + + $infoIndexedByQuery = array(); + foreach ($profiler->getQueryProfiles() as $query) { + if (isset($infoIndexedByQuery[$query->getQuery()])) { + $existing = $infoIndexedByQuery[$query->getQuery()]; + } else { + $existing = array('count' => 0, 'sumTimeMs' => 0); + } + $new = array('count' => $existing['count'] + 1, + 'sumTimeMs' => $existing['count'] + $query->getElapsedSecs() * 1000); + $infoIndexedByQuery[$query->getQuery()] = $new; + } + + if (!function_exists('sortTimeDesc')) { + function sortTimeDesc($a, $b) + { + return $a['sumTimeMs'] < $b['sumTimeMs']; + } + } + uasort($infoIndexedByQuery, 'sortTimeDesc'); + + $str = '<hr /><b>SQL Profiler</b><hr /><b>Summary</b><br/>'; + $totalTime = $profiler->getTotalElapsedSecs(); + $queryCount = $profiler->getTotalNumQueries(); + $longestTime = 0; + $longestQuery = null; + foreach ($profiler->getQueryProfiles() as $query) { + if ($query->getElapsedSecs() > $longestTime) { + $longestTime = $query->getElapsedSecs(); + $longestQuery = $query->getQuery(); + } + } + $str .= 'Executed ' . $queryCount . ' queries in ' . round($totalTime, 3) . ' seconds'; + $str .= '(Average query length: ' . round($totalTime / $queryCount, 3) . ' seconds)'; + $str .= '<br />Queries per second: ' . round($queryCount / $totalTime, 1); + $str .= '<br />Longest query length: ' . round($longestTime, 3) . " seconds (<code>$longestQuery</code>)"; + Piwik::log($str); + Piwik::getSqlProfilingQueryBreakdownOutput($infoIndexedByQuery); + } + + /** + * Log a breakdown by query + * + * @param array $infoIndexedByQuery + */ + static private function getSqlProfilingQueryBreakdownOutput($infoIndexedByQuery) + { + $output = '<hr /><b>Breakdown by query</b><br/>'; + foreach ($infoIndexedByQuery as $query => $queryInfo) { + $timeMs = round($queryInfo['sumTimeMs'], 1); + $count = $queryInfo['count']; + $avgTimeString = ''; + if ($count > 1) { + $avgTimeMs = $timeMs / $count; + $avgTimeString = " (average = <b>" . round($avgTimeMs, 1) . "ms</b>)"; + } + $query = preg_replace('/([\t\n\r ]+)/', ' ', $query); + $output .= "Executed <b>$count</b> time" . ($count == 1 ? '' : 's') . " in <b>" . $timeMs . "ms</b> $avgTimeString <pre>\t$query</pre>"; + } + Piwik::log($output); + } + + /** + * Print timer + */ + static public function printTimer() + { + Piwik::log(Zend_Registry::get('timer')); + } + + /** + * Print memory leak + * + * @param string $prefix + * @param string $suffix + */ + static public function printMemoryLeak($prefix = '', $suffix = '<br />') + { + echo $prefix; + echo Zend_Registry::get('timer')->getMemoryLeak(); + echo $suffix; + } + + /** + * Print memory usage + * + * @return string + */ + static public function getMemoryUsage() + { + $memory = false; + if (function_exists('xdebug_memory_usage')) { + $memory = xdebug_memory_usage(); + } elseif (function_exists('memory_get_usage')) { + $memory = memory_get_usage(); + } + if ($memory === false) { + return "Memory usage function not found."; + } + $usage = number_format(round($memory / 1024 / 1024, 2), 2); + return "$usage Mb"; + } + + /* * Amounts, Percentages, Currency, Time, Math Operations, and Pretty Printing */ - /** - * Returns a list of currency symbols - * - * @return array array( currencyCode => symbol, ... ) - */ - static public function getCurrencyList() - { - static $currenciesList = null; - if(is_null($currenciesList)) - { - require_once PIWIK_INCLUDE_PATH . '/core/DataFiles/Currencies.php'; - $currenciesList = $GLOBALS['Piwik_CurrencyList']; - } - return $currenciesList; - } - - /** - * Computes the division of i1 by i2. If either i1 or i2 are not number, or if i2 has a value of zero - * we return 0 to avoid the division by zero. - * - * @param number $i1 - * @param number $i2 - * @return number The result of the division or zero - */ - static public function secureDiv( $i1, $i2 ) - { - if ( is_numeric($i1) && is_numeric($i2) && floatval($i2) != 0) - { - return $i1 / $i2; - } - return 0; - } - - /** - * Safely compute a percentage. Return 0 to avoid division by zero. - * - * @param number $dividend - * @param number $divisor - * @param int $precision - * @return number - */ - static public function getPercentageSafe($dividend, $divisor, $precision = 0) - { - if($divisor == 0) - { - return 0; - } - return round(100 * $dividend / $divisor, $precision); - } - - /** - * Get currency symbol for a site - * - * @param int $idSite - * @return string - */ - static public function getCurrency($idSite) - { - $symbols = self::getCurrencyList(); - $site = new Piwik_Site($idSite); - $currency = $site->getCurrency(); - if(isset($symbols[$currency])) - { - return $symbols[$currency][0]; - } - - return ''; - } - - /** - * For the given value, based on the column name, will apply: pretty time, pretty money - * @param int $idSite - * @param string $columnName - * @param mixed $value - * @param bool $htmlAllowed - * @param string $timeAsSentence - * @return string - */ - static public function getPrettyValue($idSite, $columnName, $value, $htmlAllowed, $timeAsSentence) - { - // Display time in human readable - if(strpos($columnName, 'time') !== false) - { - return Piwik::getPrettyTimeFromSeconds($value, $timeAsSentence); - } - // Add revenue symbol to revenues - if(strpos($columnName, 'revenue') !== false && strpos($columnName, 'evolution') === false) - { - return Piwik::getPrettyMoney($value, $idSite, $htmlAllowed); - } - // Add % symbol to rates - if(strpos($columnName, '_rate') !== false) - { - if(strpos($value, "%") === false) - { - return $value . "%"; - } - } - return $value; - } - - /** - * Pretty format monetary value for a site - * - * @param int|string $value - * @param int $idSite - * @param bool $htmlAllowed - * @return string - */ - static public function getPrettyMoney($value, $idSite, $htmlAllowed = true) - { - $currencyBefore = self::getCurrency($idSite); - - $space = ' '; - if($htmlAllowed) - { - $space = ' '; - } - - $currencyAfter = ''; - // manually put the currency symbol after the amount for euro - // (maybe more currencies prefer this notation?) - if(in_array($currencyBefore,array('€', 'kr'))) - { - $currencyAfter = $space.$currencyBefore; - $currencyBefore = ''; - } - - // if the input is a number (it could be a string or INPUT form), - // and if this number is not an int, we round to precision 2 - if(is_numeric($value)) - { - if($value == round($value)) - { - // 0.0 => 0 - $value = round($value); - } - else - { - $precision = Piwik_Tracker_GoalManager::REVENUE_PRECISION; - $value = sprintf( "%01.".$precision."f", $value); - } - } - $prettyMoney = $currencyBefore . $space . $value . $currencyAfter; - return $prettyMoney; - } - - /** - * Pretty format a memory size value - * - * @param number $size size in bytes - * @param string $unit The specific unit to use, if any. If null, the unit is determined by $size. - * @param int $precision The precision to use when rounding. - * @return string - */ - static public function getPrettySizeFromBytes( $size, $unit = null, $precision = 1 ) - { - if ($size == 0) - { - return '0 M'; - } - - $units = array('B','K','M','G','T'); - foreach($units as $currentUnit) - { - if ($size >= 1024 && $unit != $currentUnit) - { - $size = $size / 1024; - } - else - { - break; - } - } - return round($size, $precision)." ".$currentUnit; - } - - /** - * Pretty format a time - * - * @param int $numberOfSeconds - * @param bool $displayTimeAsSentence If set to true, will output "5min 17s", if false "00:05:17" - * @param bool $isHtml - * @param bool $round to the full seconds - * @return string - */ - static public function getPrettyTimeFromSeconds($numberOfSeconds, $displayTimeAsSentence = true, $isHtml = true, $round = false) - { - $numberOfSeconds = $round ? (int)$numberOfSeconds : (float)$numberOfSeconds; - - // Display 01:45:17 time format - if($displayTimeAsSentence === false) - { - $hours = floor( $numberOfSeconds / 3600); - $minutes = floor( ($reminder = ($numberOfSeconds - $hours * 3600)) / 60 ); - $seconds = floor( $reminder - $minutes * 60 ); - $time = sprintf("%02s", $hours) . ':' . sprintf("%02s", $minutes) .':'. sprintf("%02s", $seconds); - $milliSeconds = ($numberOfSeconds * 1000) % 1000; - if ($milliSeconds) { - $time .= '.' . $milliSeconds; - } - return $time; - } - $secondsInYear = 86400 * 365.25; - $years = floor($numberOfSeconds / $secondsInYear); - $minusYears = $numberOfSeconds - $years * $secondsInYear; - $days = floor($minusYears / 86400); - - $minusDays = $numberOfSeconds - $days * 86400; - $hours = floor($minusDays / 3600); - - $minusDaysAndHours = $minusDays - $hours * 3600; - $minutes = floor($minusDaysAndHours / 60 ); - - $seconds = $minusDaysAndHours - $minutes * 60; - - if($years > 0) - { - $return = sprintf(Piwik_Translate('General_YearsDays'), $years, $days); - } - elseif($days > 0) - { - $return = sprintf(Piwik_Translate('General_DaysHours'), $days, $hours); - } - elseif($hours > 0) - { - $return = sprintf(Piwik_Translate('General_HoursMinutes'), $hours, $minutes); - } - elseif($minutes > 0) - { - $return = sprintf(Piwik_Translate('General_MinutesSeconds'), $minutes, $seconds); - } - else - { - $return = sprintf(Piwik_Translate('General_Seconds'), $seconds); - } - if($isHtml) - { - return str_replace(' ', ' ', $return); - } - return $return; - } - - /** - * Gets a prettified string representation of a number. The result will have - * thousands separators and a decimal point specific to the current locale. - * - * @param number $value - * @return string - */ - static public function getPrettyNumber( $value ) - { - $locale = localeconv(); - - $decimalPoint = $locale['decimal_point']; - $thousandsSeparator = $locale['thousands_sep']; - - return number_format($value, 0, $decimalPoint, $thousandsSeparator); - } - - /** - * Returns the Javascript code to be inserted on every page to track - * - * @param int $idSite - * @param string $piwikUrl http://path/to/piwik/directory/ - * @return string - */ - static public function getJavascriptCode($idSite, $piwikUrl) - { - $jsCode = file_get_contents( PIWIK_INCLUDE_PATH . "/core/Tracker/javascriptCode.tpl"); - $jsCode = htmlentities($jsCode); - preg_match('~^(http|https)://(.*)$~D', $piwikUrl, $matches); - $piwikUrl = @$matches[2]; - $jsCode = str_replace('{$idSite}', $idSite, $jsCode); - $jsCode = str_replace('{$piwikUrl}', Piwik_Common::sanitizeInputValue($piwikUrl), $jsCode); - return $jsCode; - } - - /** - * Generate a title for image tags - * - * @return string - */ - static public function getRandomTitle() - { - static $titles = array( - 'Web analytics', - 'Real Time Web Analytics', - 'Analytics', - 'Real Time Analytics', - 'Analytics in Real time', - 'Open Source Analytics', - 'Open Source Web Analytics', - 'Free Website Analytics', - 'Free Web Analytics', - 'Analytics Platform', - ); - $id = abs(intval(md5(Piwik_Url::getCurrentHost()))); - $title = $titles[ $id % count($titles)]; - return $title; - } - - /** - * Number of websites to show in the Website selector - * - * @return int - */ - static public function getWebsitesCountToDisplay() - { - $count = max(Piwik_Config::getInstance()->General['site_selector_max_sites'], - Piwik_Config::getInstance()->General['autocomplete_min_sites']); - return (int)$count; - } - - /** - * Segments to pre-process - * - * @return string - */ - static public function getKnownSegmentsToArchive() - { - static $cachedResult = null; - - if (is_null($cachedResult)) - { - $segments = Piwik_Config::getInstance()->Segments; - $cachedResult = isset($segments['Segments']) ? $segments['Segments'] : ''; - } - - return $cachedResult; - } - -/* + /** + * Returns a list of currency symbols + * + * @return array array( currencyCode => symbol, ... ) + */ + static public function getCurrencyList() + { + static $currenciesList = null; + if (is_null($currenciesList)) { + require_once PIWIK_INCLUDE_PATH . '/core/DataFiles/Currencies.php'; + $currenciesList = $GLOBALS['Piwik_CurrencyList']; + } + return $currenciesList; + } + + /** + * Computes the division of i1 by i2. If either i1 or i2 are not number, or if i2 has a value of zero + * we return 0 to avoid the division by zero. + * + * @param number $i1 + * @param number $i2 + * @return number The result of the division or zero + */ + static public function secureDiv($i1, $i2) + { + if (is_numeric($i1) && is_numeric($i2) && floatval($i2) != 0) { + return $i1 / $i2; + } + return 0; + } + + /** + * Safely compute a percentage. Return 0 to avoid division by zero. + * + * @param number $dividend + * @param number $divisor + * @param int $precision + * @return number + */ + static public function getPercentageSafe($dividend, $divisor, $precision = 0) + { + if ($divisor == 0) { + return 0; + } + return round(100 * $dividend / $divisor, $precision); + } + + /** + * Get currency symbol for a site + * + * @param int $idSite + * @return string + */ + static public function getCurrency($idSite) + { + $symbols = self::getCurrencyList(); + $site = new Piwik_Site($idSite); + $currency = $site->getCurrency(); + if (isset($symbols[$currency])) { + return $symbols[$currency][0]; + } + + return ''; + } + + /** + * For the given value, based on the column name, will apply: pretty time, pretty money + * @param int $idSite + * @param string $columnName + * @param mixed $value + * @param bool $htmlAllowed + * @param string $timeAsSentence + * @return string + */ + static public function getPrettyValue($idSite, $columnName, $value, $htmlAllowed, $timeAsSentence) + { + // Display time in human readable + if (strpos($columnName, 'time') !== false) { + return Piwik::getPrettyTimeFromSeconds($value, $timeAsSentence); + } + // Add revenue symbol to revenues + if (strpos($columnName, 'revenue') !== false && strpos($columnName, 'evolution') === false) { + return Piwik::getPrettyMoney($value, $idSite, $htmlAllowed); + } + // Add % symbol to rates + if (strpos($columnName, '_rate') !== false) { + if (strpos($value, "%") === false) { + return $value . "%"; + } + } + return $value; + } + + /** + * Pretty format monetary value for a site + * + * @param int|string $value + * @param int $idSite + * @param bool $htmlAllowed + * @return string + */ + static public function getPrettyMoney($value, $idSite, $htmlAllowed = true) + { + $currencyBefore = self::getCurrency($idSite); + + $space = ' '; + if ($htmlAllowed) { + $space = ' '; + } + + $currencyAfter = ''; + // manually put the currency symbol after the amount for euro + // (maybe more currencies prefer this notation?) + if (in_array($currencyBefore, array('€', 'kr'))) { + $currencyAfter = $space . $currencyBefore; + $currencyBefore = ''; + } + + // if the input is a number (it could be a string or INPUT form), + // and if this number is not an int, we round to precision 2 + if (is_numeric($value)) { + if ($value == round($value)) { + // 0.0 => 0 + $value = round($value); + } else { + $precision = Piwik_Tracker_GoalManager::REVENUE_PRECISION; + $value = sprintf("%01." . $precision . "f", $value); + } + } + $prettyMoney = $currencyBefore . $space . $value . $currencyAfter; + return $prettyMoney; + } + + /** + * Pretty format a memory size value + * + * @param number $size size in bytes + * @param string $unit The specific unit to use, if any. If null, the unit is determined by $size. + * @param int $precision The precision to use when rounding. + * @return string + */ + static public function getPrettySizeFromBytes($size, $unit = null, $precision = 1) + { + if ($size == 0) { + return '0 M'; + } + + $units = array('B', 'K', 'M', 'G', 'T'); + foreach ($units as $currentUnit) { + if ($size >= 1024 && $unit != $currentUnit) { + $size = $size / 1024; + } else { + break; + } + } + return round($size, $precision) . " " . $currentUnit; + } + + /** + * Pretty format a time + * + * @param int $numberOfSeconds + * @param bool $displayTimeAsSentence If set to true, will output "5min 17s", if false "00:05:17" + * @param bool $isHtml + * @param bool $round to the full seconds + * @return string + */ + static public function getPrettyTimeFromSeconds($numberOfSeconds, $displayTimeAsSentence = true, $isHtml = true, $round = false) + { + $numberOfSeconds = $round ? (int)$numberOfSeconds : (float)$numberOfSeconds; + + // Display 01:45:17 time format + if ($displayTimeAsSentence === false) { + $hours = floor($numberOfSeconds / 3600); + $minutes = floor(($reminder = ($numberOfSeconds - $hours * 3600)) / 60); + $seconds = floor($reminder - $minutes * 60); + $time = sprintf("%02s", $hours) . ':' . sprintf("%02s", $minutes) . ':' . sprintf("%02s", $seconds); + $milliSeconds = ($numberOfSeconds * 1000) % 1000; + if ($milliSeconds) { + $time .= '.' . $milliSeconds; + } + return $time; + } + $secondsInYear = 86400 * 365.25; + $years = floor($numberOfSeconds / $secondsInYear); + $minusYears = $numberOfSeconds - $years * $secondsInYear; + $days = floor($minusYears / 86400); + + $minusDays = $numberOfSeconds - $days * 86400; + $hours = floor($minusDays / 3600); + + $minusDaysAndHours = $minusDays - $hours * 3600; + $minutes = floor($minusDaysAndHours / 60); + + $seconds = $minusDaysAndHours - $minutes * 60; + + if ($years > 0) { + $return = sprintf(Piwik_Translate('General_YearsDays'), $years, $days); + } elseif ($days > 0) { + $return = sprintf(Piwik_Translate('General_DaysHours'), $days, $hours); + } elseif ($hours > 0) { + $return = sprintf(Piwik_Translate('General_HoursMinutes'), $hours, $minutes); + } elseif ($minutes > 0) { + $return = sprintf(Piwik_Translate('General_MinutesSeconds'), $minutes, $seconds); + } else { + $return = sprintf(Piwik_Translate('General_Seconds'), $seconds); + } + if ($isHtml) { + return str_replace(' ', ' ', $return); + } + return $return; + } + + /** + * Gets a prettified string representation of a number. The result will have + * thousands separators and a decimal point specific to the current locale. + * + * @param number $value + * @return string + */ + static public function getPrettyNumber($value) + { + $locale = localeconv(); + + $decimalPoint = $locale['decimal_point']; + $thousandsSeparator = $locale['thousands_sep']; + + return number_format($value, 0, $decimalPoint, $thousandsSeparator); + } + + /** + * Returns the Javascript code to be inserted on every page to track + * + * @param int $idSite + * @param string $piwikUrl http://path/to/piwik/directory/ + * @return string + */ + static public function getJavascriptCode($idSite, $piwikUrl) + { + $jsCode = file_get_contents(PIWIK_INCLUDE_PATH . "/core/Tracker/javascriptCode.tpl"); + $jsCode = htmlentities($jsCode); + preg_match('~^(http|https)://(.*)$~D', $piwikUrl, $matches); + $piwikUrl = @$matches[2]; + $jsCode = str_replace('{$idSite}', $idSite, $jsCode); + $jsCode = str_replace('{$piwikUrl}', Piwik_Common::sanitizeInputValue($piwikUrl), $jsCode); + return $jsCode; + } + + /** + * Generate a title for image tags + * + * @return string + */ + static public function getRandomTitle() + { + static $titles = array( + 'Web analytics', + 'Real Time Web Analytics', + 'Analytics', + 'Real Time Analytics', + 'Analytics in Real time', + 'Open Source Analytics', + 'Open Source Web Analytics', + 'Free Website Analytics', + 'Free Web Analytics', + 'Analytics Platform', + ); + $id = abs(intval(md5(Piwik_Url::getCurrentHost()))); + $title = $titles[$id % count($titles)]; + return $title; + } + + /** + * Number of websites to show in the Website selector + * + * @return int + */ + static public function getWebsitesCountToDisplay() + { + $count = max(Piwik_Config::getInstance()->General['site_selector_max_sites'], + Piwik_Config::getInstance()->General['autocomplete_min_sites']); + return (int)$count; + } + + /** + * Segments to pre-process + * + * @return string + */ + static public function getKnownSegmentsToArchive() + { + static $cachedResult = null; + + if (is_null($cachedResult)) { + $segments = Piwik_Config::getInstance()->Segments; + $cachedResult = isset($segments['Segments']) ? $segments['Segments'] : ''; + } + + return $cachedResult; + } + + /* * Access */ - /** - * Get current user email address - * - * @return string - */ - static public function getCurrentUserEmail() - { - if(!Piwik::isUserIsSuperUser()) - { - $user = Piwik_UsersManager_API::getInstance()->getUser(Piwik::getCurrentUserLogin()); - return $user['email']; - } - return self::getSuperUserEmail(); - } - - /** - * Returns Super User login - * - * @return string - */ - static public function getSuperUserLogin() - { - $superuser = Piwik_Config::getInstance()->superuser; - return $superuser['login']; - } - - /** - * Returns Super User email - * - * @return string - */ - static public function getSuperUserEmail() - { - $superuser = Piwik_Config::getInstance()->superuser; - return $superuser['email']; - } - - /** - * Get current user login - * - * @return string login ID - */ - static public function getCurrentUserLogin() - { - return Zend_Registry::get('access')->getLogin(); - } - - /** - * Get current user's token auth - * - * @return string Token auth - */ - static public function getCurrentUserTokenAuth() - { - return Zend_Registry::get('access')->getTokenAuth(); - } - - /** - * Returns true if the current user is either the super user, or the user $theUser - * Used when modifying user preference: this usually requires super user or being the user itself. - * - * @param string $theUser - * @return bool - */ - static public function isUserIsSuperUserOrTheUser( $theUser ) - { - try{ - self::checkUserIsSuperUserOrTheUser( $theUser ); - return true; - } catch( Exception $e){ - return false; - } - } - - /** - * Check that current user is either the specified user or the superuser - * - * @param string $theUser - * @throws Piwik_Access_NoAccessException if the user is neither the super user nor the user $theUser - */ - static public function checkUserIsSuperUserOrTheUser( $theUser ) - { - try{ - if( Piwik::getCurrentUserLogin() !== $theUser) - { - // or to the super user - Piwik::checkUserIsSuperUser(); - } - } catch( Piwik_Access_NoAccessException $e){ - throw new Piwik_Access_NoAccessException(Piwik_Translate('General_ExceptionCheckUserIsSuperUserOrTheUser', array($theUser))); - } - } - - /** - * Returns true if the current user is the Super User - * - * @return bool - */ - static public function isUserIsSuperUser() - { - try{ - self::checkUserIsSuperUser(); - return true; - } catch( Exception $e){ - return false; - } - } - - /** - * Is user the anonymous user? - * - * @return bool True if anonymouse; false otherwise - */ - static public function isUserIsAnonymous() - { - return Piwik::getCurrentUserLogin() == 'anonymous'; - } - - /** - * Checks if user is not the anonymous user. - * - * @throws Piwik_Access_NoAccessException if user is anonymous. - */ - static public function checkUserIsNotAnonymous() - { - if(self::isUserIsAnonymous()) - { - throw new Piwik_Access_NoAccessException(Piwik_Translate('General_YouMustBeLoggedIn')); - } - } - - /** - * Helper method user to set the current as Super User. - * This should be used with great care as this gives the user all permissions. - * - * @param bool $bool true to set current user as super user - */ - static public function setUserIsSuperUser( $bool = true ) - { - Zend_Registry::get('access')->setSuperUser($bool); - } - - /** - * Check that user is the superuser - * - * @throws Exception if not the superuser - */ - static public function checkUserIsSuperUser() - { - Zend_Registry::get('access')->checkUserIsSuperUser(); - } - - /** - * Returns true if the user has admin access to the sites - * - * @param mixed $idSites - * @return bool - */ - static public function isUserHasAdminAccess( $idSites ) - { - try{ - self::checkUserHasAdminAccess( $idSites ); - return true; - } catch( Exception $e){ - return false; - } - } - - /** - * Check user has admin access to the sites - * - * @param mixed $idSites - * @throws Exception if user doesn't have admin access to the sites - */ - static public function checkUserHasAdminAccess( $idSites ) - { - Zend_Registry::get('access')->checkUserHasAdminAccess( $idSites ); - } - - /** - * Returns true if the user has admin access to any sites - * - * @return bool - */ - static public function isUserHasSomeAdminAccess() - { - try{ - self::checkUserHasSomeAdminAccess(); - return true; - } catch( Exception $e){ - return false; - } - } - - /** - * Check user has admin access to any sites - * - * @throws Exception if user doesn't have admin access to any sites - */ - static public function checkUserHasSomeAdminAccess() - { - Zend_Registry::get('access')->checkUserHasSomeAdminAccess(); - } - - /** - * Returns true if the user has view access to the sites - * - * @param mixed $idSites - * @return bool - */ - static public function isUserHasViewAccess( $idSites ) - { - try{ - self::checkUserHasViewAccess( $idSites ); - return true; - } catch( Exception $e){ - return false; - } - } - - /** - * Check user has view access to the sites - * - * @param mixed $idSites - * @throws Exception if user doesn't have view access to sites - */ - static public function checkUserHasViewAccess( $idSites ) - { - Zend_Registry::get('access')->checkUserHasViewAccess( $idSites ); - } - - /** - * Returns true if the user has view access to any sites - * - * @return bool - */ - static public function isUserHasSomeViewAccess() - { - try{ - self::checkUserHasSomeViewAccess(); - return true; - } catch( Exception $e){ - return false; - } - } - - /** - * Check user has view access to any sites - * - * @throws Exception if user doesn't have view access to any sites - */ - static public function checkUserHasSomeViewAccess() - { - Zend_Registry::get('access')->checkUserHasSomeViewAccess(); - } - -/* + /** + * Get current user email address + * + * @return string + */ + static public function getCurrentUserEmail() + { + if (!Piwik::isUserIsSuperUser()) { + $user = Piwik_UsersManager_API::getInstance()->getUser(Piwik::getCurrentUserLogin()); + return $user['email']; + } + return self::getSuperUserEmail(); + } + + /** + * Returns Super User login + * + * @return string + */ + static public function getSuperUserLogin() + { + $superuser = Piwik_Config::getInstance()->superuser; + return $superuser['login']; + } + + /** + * Returns Super User email + * + * @return string + */ + static public function getSuperUserEmail() + { + $superuser = Piwik_Config::getInstance()->superuser; + return $superuser['email']; + } + + /** + * Get current user login + * + * @return string login ID + */ + static public function getCurrentUserLogin() + { + return Zend_Registry::get('access')->getLogin(); + } + + /** + * Get current user's token auth + * + * @return string Token auth + */ + static public function getCurrentUserTokenAuth() + { + return Zend_Registry::get('access')->getTokenAuth(); + } + + /** + * Returns true if the current user is either the super user, or the user $theUser + * Used when modifying user preference: this usually requires super user or being the user itself. + * + * @param string $theUser + * @return bool + */ + static public function isUserIsSuperUserOrTheUser($theUser) + { + try { + self::checkUserIsSuperUserOrTheUser($theUser); + return true; + } catch (Exception $e) { + return false; + } + } + + /** + * Check that current user is either the specified user or the superuser + * + * @param string $theUser + * @throws Piwik_Access_NoAccessException if the user is neither the super user nor the user $theUser + */ + static public function checkUserIsSuperUserOrTheUser($theUser) + { + try { + if (Piwik::getCurrentUserLogin() !== $theUser) { + // or to the super user + Piwik::checkUserIsSuperUser(); + } + } catch (Piwik_Access_NoAccessException $e) { + throw new Piwik_Access_NoAccessException(Piwik_Translate('General_ExceptionCheckUserIsSuperUserOrTheUser', array($theUser))); + } + } + + /** + * Returns true if the current user is the Super User + * + * @return bool + */ + static public function isUserIsSuperUser() + { + try { + self::checkUserIsSuperUser(); + return true; + } catch (Exception $e) { + return false; + } + } + + /** + * Is user the anonymous user? + * + * @return bool True if anonymouse; false otherwise + */ + static public function isUserIsAnonymous() + { + return Piwik::getCurrentUserLogin() == 'anonymous'; + } + + /** + * Checks if user is not the anonymous user. + * + * @throws Piwik_Access_NoAccessException if user is anonymous. + */ + static public function checkUserIsNotAnonymous() + { + if (self::isUserIsAnonymous()) { + throw new Piwik_Access_NoAccessException(Piwik_Translate('General_YouMustBeLoggedIn')); + } + } + + /** + * Helper method user to set the current as Super User. + * This should be used with great care as this gives the user all permissions. + * + * @param bool $bool true to set current user as super user + */ + static public function setUserIsSuperUser($bool = true) + { + Zend_Registry::get('access')->setSuperUser($bool); + } + + /** + * Check that user is the superuser + * + * @throws Exception if not the superuser + */ + static public function checkUserIsSuperUser() + { + Zend_Registry::get('access')->checkUserIsSuperUser(); + } + + /** + * Returns true if the user has admin access to the sites + * + * @param mixed $idSites + * @return bool + */ + static public function isUserHasAdminAccess($idSites) + { + try { + self::checkUserHasAdminAccess($idSites); + return true; + } catch (Exception $e) { + return false; + } + } + + /** + * Check user has admin access to the sites + * + * @param mixed $idSites + * @throws Exception if user doesn't have admin access to the sites + */ + static public function checkUserHasAdminAccess($idSites) + { + Zend_Registry::get('access')->checkUserHasAdminAccess($idSites); + } + + /** + * Returns true if the user has admin access to any sites + * + * @return bool + */ + static public function isUserHasSomeAdminAccess() + { + try { + self::checkUserHasSomeAdminAccess(); + return true; + } catch (Exception $e) { + return false; + } + } + + /** + * Check user has admin access to any sites + * + * @throws Exception if user doesn't have admin access to any sites + */ + static public function checkUserHasSomeAdminAccess() + { + Zend_Registry::get('access')->checkUserHasSomeAdminAccess(); + } + + /** + * Returns true if the user has view access to the sites + * + * @param mixed $idSites + * @return bool + */ + static public function isUserHasViewAccess($idSites) + { + try { + self::checkUserHasViewAccess($idSites); + return true; + } catch (Exception $e) { + return false; + } + } + + /** + * Check user has view access to the sites + * + * @param mixed $idSites + * @throws Exception if user doesn't have view access to sites + */ + static public function checkUserHasViewAccess($idSites) + { + Zend_Registry::get('access')->checkUserHasViewAccess($idSites); + } + + /** + * Returns true if the user has view access to any sites + * + * @return bool + */ + static public function isUserHasSomeViewAccess() + { + try { + self::checkUserHasSomeViewAccess(); + return true; + } catch (Exception $e) { + return false; + } + } + + /** + * Check user has view access to any sites + * + * @throws Exception if user doesn't have view access to any sites + */ + static public function checkUserHasSomeViewAccess() + { + Zend_Registry::get('access')->checkUserHasSomeViewAccess(); + } + + /* * Current module, action, plugin */ - /** - * Returns the name of the Login plugin currently being used. - * Must be used since it is not allowed to hardcode 'Login' in URLs - * in case another Login plugin is being used. - * - * @return string - */ - static public function getLoginPluginName() - { - return Zend_Registry::get('auth')->getName(); - } - - /** - * Returns the plugin currently being used to display the page - * - * @return Piwik_Plugin - */ - static public function getCurrentPlugin() - { - return Piwik_PluginsManager::getInstance()->getLoadedPlugin(Piwik::getModule()); - } - - /** - * Returns the current module read from the URL (eg. 'API', 'UserSettings', etc.) - * - * @return string - */ - static public function getModule() - { - return Piwik_Common::getRequestVar('module', '', 'string'); - } - - /** - * Returns the current action read from the URL - * - * @return string - */ - static public function getAction() - { - return Piwik_Common::getRequestVar('action', '', 'string'); - } - - /** - * Helper method used in API function to introduce array elements in API parameters. - * Array elements can be passed by comma separated values, or using the notation - * array[]=value1&array[]=value2 in the URL. - * This function will handle both cases and return the array. - * - * @param array|string $columns - * @return array - */ - static public function getArrayFromApiParameter($columns) - { - return $columns === false - ? array() - : (is_array($columns) - ? $columns - : explode(',', $columns) - ); - } - - /** - * Redirect to module (and action) - * - * @param string $newModule Target module - * @param string $newAction Target action - * @param array $parameters Parameters to modify in the URL - * @return bool false if the URL to redirect to is already this URL - */ - static public function redirectToModule( $newModule, $newAction = '', $parameters = array() ) - { - $newUrl = 'index.php' . Piwik_Url::getCurrentQueryStringWithParametersModified( - array('module' => $newModule, 'action' => $newAction) - + $parameters - ); - Piwik_Url::redirectToUrl($newUrl); - } - -/* + /** + * Returns the name of the Login plugin currently being used. + * Must be used since it is not allowed to hardcode 'Login' in URLs + * in case another Login plugin is being used. + * + * @return string + */ + static public function getLoginPluginName() + { + return Zend_Registry::get('auth')->getName(); + } + + /** + * Returns the plugin currently being used to display the page + * + * @return Piwik_Plugin + */ + static public function getCurrentPlugin() + { + return Piwik_PluginsManager::getInstance()->getLoadedPlugin(Piwik::getModule()); + } + + /** + * Returns the current module read from the URL (eg. 'API', 'UserSettings', etc.) + * + * @return string + */ + static public function getModule() + { + return Piwik_Common::getRequestVar('module', '', 'string'); + } + + /** + * Returns the current action read from the URL + * + * @return string + */ + static public function getAction() + { + return Piwik_Common::getRequestVar('action', '', 'string'); + } + + /** + * Helper method used in API function to introduce array elements in API parameters. + * Array elements can be passed by comma separated values, or using the notation + * array[]=value1&array[]=value2 in the URL. + * This function will handle both cases and return the array. + * + * @param array|string $columns + * @return array + */ + static public function getArrayFromApiParameter($columns) + { + return $columns === false + ? array() + : (is_array($columns) + ? $columns + : explode(',', $columns) + ); + } + + /** + * Redirect to module (and action) + * + * @param string $newModule Target module + * @param string $newAction Target action + * @param array $parameters Parameters to modify in the URL + * @return bool false if the URL to redirect to is already this URL + */ + static public function redirectToModule($newModule, $newAction = '', $parameters = array()) + { + $newUrl = 'index.php' . Piwik_Url::getCurrentQueryStringWithParametersModified( + array('module' => $newModule, 'action' => $newAction) + + $parameters + ); + Piwik_Url::redirectToUrl($newUrl); + } + + /* * Global database object */ - /** - * Create database object and connect to database - * @param array|null $dbInfos - */ - static public function createDatabaseObject( $dbInfos = null ) - { - $config = Piwik_Config::getInstance(); - - if(is_null($dbInfos)) - { - $dbInfos = $config->database; - } - - Piwik_PostEvent('Reporting.getDatabaseConfig', $dbInfos); - - $dbInfos['profiler'] = $config->Debug['enable_sql_profiler']; - - $db = null; - Piwik_PostEvent('Reporting.createDatabase', $db); - if(is_null($db)) - { - $adapter = $dbInfos['adapter']; - $db = @Piwik_Db_Adapter::factory($adapter, $dbInfos); - } - Zend_Registry::set('db', $db); - } - - /** - * Disconnect from database - */ - static public function disconnectDatabase() - { - Zend_Registry::get('db')->closeConnection(); - } - - /** - * Checks the database server version against the required minimum - * version. - * - * @see config/global.ini.php - * @since 0.4.4 - * @throws Exception if server version is less than the required version - */ - static public function checkDatabaseVersion() - { - Zend_Registry::get('db')->checkServerVersion(); - } - - /** - * Check database connection character set is utf8. - * - * @return bool True if it is (or doesn't matter); false otherwise - */ - static public function isDatabaseConnectionUTF8() - { - return Zend_Registry::get('db')->isConnectionUTF8(); - } - -/* + /** + * Create database object and connect to database + * @param array|null $dbInfos + */ + static public function createDatabaseObject($dbInfos = null) + { + $config = Piwik_Config::getInstance(); + + if (is_null($dbInfos)) { + $dbInfos = $config->database; + } + + Piwik_PostEvent('Reporting.getDatabaseConfig', $dbInfos); + + $dbInfos['profiler'] = $config->Debug['enable_sql_profiler']; + + $db = null; + Piwik_PostEvent('Reporting.createDatabase', $db); + if (is_null($db)) { + $adapter = $dbInfos['adapter']; + $db = @Piwik_Db_Adapter::factory($adapter, $dbInfos); + } + Zend_Registry::set('db', $db); + } + + /** + * Disconnect from database + */ + static public function disconnectDatabase() + { + Zend_Registry::get('db')->closeConnection(); + } + + /** + * Checks the database server version against the required minimum + * version. + * + * @see config/global.ini.php + * @since 0.4.4 + * @throws Exception if server version is less than the required version + */ + static public function checkDatabaseVersion() + { + Zend_Registry::get('db')->checkServerVersion(); + } + + /** + * Check database connection character set is utf8. + * + * @return bool True if it is (or doesn't matter); false otherwise + */ + static public function isDatabaseConnectionUTF8() + { + return Zend_Registry::get('db')->isConnectionUTF8(); + } + + /* * Global log object */ - /** - * Create log object - * @throws Exception - */ - static public function createLogObject() - { - $configAPI = Piwik_Config::getInstance()->log; - - $aLoggers = array( - 'logger_api_call' => new Piwik_Log_APICall, - 'logger_exception' => new Piwik_Log_Exception, - 'logger_error' => new Piwik_Log_Error, - 'logger_message' => new Piwik_Log_Message, - ); - - foreach($configAPI as $loggerType => $aRecordTo) - { - if(isset($aLoggers[$loggerType])) - { - $logger = $aLoggers[$loggerType]; - - foreach($aRecordTo as $recordTo) - { - switch($recordTo) - { - case 'screen': - $logger->addWriteToScreen(); - break; - - case 'database': - $logger->addWriteToDatabase(); - break; - - case 'file': - $logger->addWriteToFile(); - break; - - default: - throw new Exception("'$recordTo' is not a valid Log type. Valid logger types are: screen, database, file."); - break; - } - } - } - } - - foreach($aLoggers as $loggerType =>$logger) - { - if($logger->getWritersCount() == 0) - { - $logger->addWriteToNull(); - } - Zend_Registry::set($loggerType, $logger); - } - } - -/* + /** + * Create log object + * @throws Exception + */ + static public function createLogObject() + { + $configAPI = Piwik_Config::getInstance()->log; + + $aLoggers = array( + 'logger_api_call' => new Piwik_Log_APICall, + 'logger_exception' => new Piwik_Log_Exception, + 'logger_error' => new Piwik_Log_Error, + 'logger_message' => new Piwik_Log_Message, + ); + + foreach ($configAPI as $loggerType => $aRecordTo) { + if (isset($aLoggers[$loggerType])) { + $logger = $aLoggers[$loggerType]; + + foreach ($aRecordTo as $recordTo) { + switch ($recordTo) { + case 'screen': + $logger->addWriteToScreen(); + break; + + case 'database': + $logger->addWriteToDatabase(); + break; + + case 'file': + $logger->addWriteToFile(); + break; + + default: + throw new Exception("'$recordTo' is not a valid Log type. Valid logger types are: screen, database, file."); + break; + } + } + } + } + + foreach ($aLoggers as $loggerType => $logger) { + if ($logger->getWritersCount() == 0) { + $logger->addWriteToNull(); + } + Zend_Registry::set($loggerType, $logger); + } + } + + /* * Global config object */ - /** - * Create configuration object - */ - static public function createConfigObject() - { - // for backward compatibility - Zend_Registry::set('config', new Piwik_Config_Compat()); + /** + * Create configuration object + */ + static public function createConfigObject() + { + // for backward compatibility + Zend_Registry::set('config', new Piwik_Config_Compat()); - // instantiate the singleton - $config = Piwik_Config::getInstance(); - $config->init(); - } + // instantiate the singleton + $config = Piwik_Config::getInstance(); + $config->init(); + } -/* + /* * Global access object */ - /** - * Create access object - */ - static public function createAccessObject() - { - Zend_Registry::set('access', new Piwik_Access()); - } + /** + * Create access object + */ + static public function createAccessObject() + { + Zend_Registry::set('access', new Piwik_Access()); + } -/* + /* * User input validation */ - /** - * Returns true if the email is a valid email - * - * @param string $email - * @return bool - */ - static public function isValidEmailString( $email ) - { - return (preg_match('/^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9_.-]+\.[a-zA-Z]{2,7}$/D', $email) > 0); - } - - /** - * Returns true if the login is valid. - * Warning: does not check if the login already exists! You must use UsersManager_API->userExists as well. - * - * @param string $userLogin - * @throws Exception - * @return bool - */ - static public function checkValidLoginString( $userLogin ) - { - if(!self::isChecksEnabled() - && !empty($userLogin)) - { - return; - } - $loginMinimumLength = 3; - $loginMaximumLength = 100; - $l = strlen($userLogin); - if(!($l >= $loginMinimumLength - && $l <= $loginMaximumLength - && (preg_match('/^[A-Za-z0-9_.@+-]*$/D', $userLogin) > 0)) - ) - { - throw new Exception(Piwik_TranslateException('UsersManager_ExceptionInvalidLoginFormat', array($loginMinimumLength, $loginMaximumLength))); - } - } - - /** - * Should Piwik check that the login & password have minimum length and valid characters? - * - * @return bool True if checks enabled; false otherwise - */ - static public function isChecksEnabled() - { - return Piwik_Config::getInstance()->General['disable_checks_usernames_attributes'] == 0; - } - - /** - * Is GD php extension (sparklines, graphs) available? - * - * @return bool - */ - static public function isGdExtensionEnabled() - { - static $gd = null; - if(is_null($gd)) - { - $extensions = @get_loaded_extensions(); - $gd = in_array('gd', $extensions) && function_exists('imageftbbox'); - } - return $gd; - } - -/* + /** + * Returns true if the email is a valid email + * + * @param string $email + * @return bool + */ + static public function isValidEmailString($email) + { + return (preg_match('/^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9_.-]+\.[a-zA-Z]{2,7}$/D', $email) > 0); + } + + /** + * Returns true if the login is valid. + * Warning: does not check if the login already exists! You must use UsersManager_API->userExists as well. + * + * @param string $userLogin + * @throws Exception + * @return bool + */ + static public function checkValidLoginString($userLogin) + { + if (!self::isChecksEnabled() + && !empty($userLogin) + ) { + return; + } + $loginMinimumLength = 3; + $loginMaximumLength = 100; + $l = strlen($userLogin); + if (!($l >= $loginMinimumLength + && $l <= $loginMaximumLength + && (preg_match('/^[A-Za-z0-9_.@+-]*$/D', $userLogin) > 0)) + ) { + throw new Exception(Piwik_TranslateException('UsersManager_ExceptionInvalidLoginFormat', array($loginMinimumLength, $loginMaximumLength))); + } + } + + /** + * Should Piwik check that the login & password have minimum length and valid characters? + * + * @return bool True if checks enabled; false otherwise + */ + static public function isChecksEnabled() + { + return Piwik_Config::getInstance()->General['disable_checks_usernames_attributes'] == 0; + } + + /** + * Is GD php extension (sparklines, graphs) available? + * + * @return bool + */ + static public function isGdExtensionEnabled() + { + static $gd = null; + if (is_null($gd)) { + $extensions = @get_loaded_extensions(); + $gd = in_array('gd', $extensions) && function_exists('imageftbbox'); + } + return $gd; + } + + /* * Date / Timezone */ - /** - * Determine if this php version/build supports timezone manipulation - * (e.g., php >= 5.2, or compiled with EXPERIMENTAL_DATE_SUPPORT=1 for - * php < 5.2). - * - * @return bool True if timezones supported; false otherwise - */ - static public function isTimezoneSupportEnabled() - { - return - function_exists( 'date_create' ) && - function_exists( 'date_default_timezone_set' ) && - function_exists( 'timezone_identifiers_list' ) && - function_exists( 'timezone_open' ) && - function_exists( 'timezone_offset_get' ); - } - -/* + /** + * Determine if this php version/build supports timezone manipulation + * (e.g., php >= 5.2, or compiled with EXPERIMENTAL_DATE_SUPPORT=1 for + * php < 5.2). + * + * @return bool True if timezones supported; false otherwise + */ + static public function isTimezoneSupportEnabled() + { + return + function_exists('date_create') && + function_exists('date_default_timezone_set') && + function_exists('timezone_identifiers_list') && + function_exists('timezone_open') && + function_exists('timezone_offset_get'); + } + + /* * Database and table definition methods */ - /** - * Is the schema available? - * - * @return bool True if schema is available; false otherwise - */ - static public function isAvailable() - { - return Piwik_Db_Schema::getInstance()->isAvailable(); - } - - /** - * Get the SQL to create a specific Piwik table - * - * @param string $tableName - * @return string SQL - */ - static public function getTableCreateSql( $tableName ) - { - return Piwik_Db_Schema::getInstance()->getTableCreateSql($tableName); - } - - /** - * Get the SQL to create Piwik tables - * - * @return array array of strings containing SQL - */ - static public function getTablesCreateSql() - { - return Piwik_Db_Schema::getInstance()->getTablesCreateSql(); - } - - /** - * Create database - * - * @param string|null $dbName - */ - static public function createDatabase( $dbName = null ) - { - Piwik_Db_Schema::getInstance()->createDatabase($dbName); - } - - /** - * Drop database - */ - static public function dropDatabase() - { - Piwik_Db_Schema::getInstance()->dropDatabase(); - } - - /** - * Create all tables - */ - static public function createTables() - { - Piwik_Db_Schema::getInstance()->createTables(); - } - - /** - * Creates an entry in the User table for the "anonymous" user. - */ - static public function createAnonymousUser() - { - Piwik_Db_Schema::getInstance()->createAnonymousUser(); - } - - /** - * Truncate all tables - */ - static public function truncateAllTables() - { - Piwik_Db_Schema::getInstance()->truncateAllTables(); - } - - /** - * Drop specific tables - * - * @param array $doNotDelete Names of tables to not delete - */ - static public function dropTables( $doNotDelete = array() ) - { - Piwik_Db_Schema::getInstance()->dropTables($doNotDelete); - } - - /** - * Names of all the prefixed tables in piwik - * Doesn't use the DB - * - * @return array Table names - */ - static public function getTablesNames() - { - return Piwik_Db_Schema::getInstance()->getTablesNames(); - } - - /** - * Get list of tables installed - * - * @param bool $forceReload Invalidate cache - * @return array Tables installed - */ - static public function getTablesInstalled($forceReload = true) - { - return Piwik_Db_Schema::getInstance()->getTablesInstalled($forceReload); - } - - /** - * Returns all table names archive_* - * - * @return array - */ - static public function getTablesArchivesInstalled() - { - $archiveTables = array(); - $tables = Piwik::getTablesInstalled(); - foreach($tables as $table) - { - if(strpos($table, 'archive_') !== false) - { - $archiveTables[] = $table; - } - } - return $archiveTables; - } - - /** - * Batch insert into table from CSV (or other delimited) file. - * - * @param string $tableName Name of table - * @param array $fields Field names - * @param string $filePath Path name of a file. - * @param array $fileSpec File specifications (delimiter, line terminator, etc) - * @param book $throwException Should re-throw any exception, used in system check - * @return bool True if successful; false otherwise - */ - static public function createTableFromCSVFile($tableName, $fields, $filePath, $fileSpec) - { - // On Windows, MySQL expects forward slashes as directory separators - if (Piwik_Common::isWindows()) { - $filePath = str_replace('\\', '/', $filePath); - } - - $query = " + /** + * Is the schema available? + * + * @return bool True if schema is available; false otherwise + */ + static public function isAvailable() + { + return Piwik_Db_Schema::getInstance()->isAvailable(); + } + + /** + * Get the SQL to create a specific Piwik table + * + * @param string $tableName + * @return string SQL + */ + static public function getTableCreateSql($tableName) + { + return Piwik_Db_Schema::getInstance()->getTableCreateSql($tableName); + } + + /** + * Get the SQL to create Piwik tables + * + * @return array array of strings containing SQL + */ + static public function getTablesCreateSql() + { + return Piwik_Db_Schema::getInstance()->getTablesCreateSql(); + } + + /** + * Create database + * + * @param string|null $dbName + */ + static public function createDatabase($dbName = null) + { + Piwik_Db_Schema::getInstance()->createDatabase($dbName); + } + + /** + * Drop database + */ + static public function dropDatabase() + { + Piwik_Db_Schema::getInstance()->dropDatabase(); + } + + /** + * Create all tables + */ + static public function createTables() + { + Piwik_Db_Schema::getInstance()->createTables(); + } + + /** + * Creates an entry in the User table for the "anonymous" user. + */ + static public function createAnonymousUser() + { + Piwik_Db_Schema::getInstance()->createAnonymousUser(); + } + + /** + * Truncate all tables + */ + static public function truncateAllTables() + { + Piwik_Db_Schema::getInstance()->truncateAllTables(); + } + + /** + * Drop specific tables + * + * @param array $doNotDelete Names of tables to not delete + */ + static public function dropTables($doNotDelete = array()) + { + Piwik_Db_Schema::getInstance()->dropTables($doNotDelete); + } + + /** + * Names of all the prefixed tables in piwik + * Doesn't use the DB + * + * @return array Table names + */ + static public function getTablesNames() + { + return Piwik_Db_Schema::getInstance()->getTablesNames(); + } + + /** + * Get list of tables installed + * + * @param bool $forceReload Invalidate cache + * @return array Tables installed + */ + static public function getTablesInstalled($forceReload = true) + { + return Piwik_Db_Schema::getInstance()->getTablesInstalled($forceReload); + } + + /** + * Returns all table names archive_* + * + * @return array + */ + static public function getTablesArchivesInstalled() + { + $archiveTables = array(); + $tables = Piwik::getTablesInstalled(); + foreach ($tables as $table) { + if (strpos($table, 'archive_') !== false) { + $archiveTables[] = $table; + } + } + return $archiveTables; + } + + /** + * Batch insert into table from CSV (or other delimited) file. + * + * @param string $tableName Name of table + * @param array $fields Field names + * @param string $filePath Path name of a file. + * @param array $fileSpec File specifications (delimiter, line terminator, etc) + * @param book $throwException Should re-throw any exception, used in system check + * @return bool True if successful; false otherwise + */ + static public function createTableFromCSVFile($tableName, $fields, $filePath, $fileSpec) + { + // On Windows, MySQL expects forward slashes as directory separators + if (Piwik_Common::isWindows()) { + $filePath = str_replace('\\', '/', $filePath); + } + + $query = " '$filePath' REPLACE INTO TABLE - `".$tableName."`"; + `" . $tableName . "`"; - if(isset($fileSpec['charset'])) - { - $query .= ' CHARACTER SET '.$fileSpec['charset']; - } + if (isset($fileSpec['charset'])) { + $query .= ' CHARACTER SET ' . $fileSpec['charset']; + } - $fieldList = '('.join(',', $fields).')'; + $fieldList = '(' . join(',', $fields) . ')'; - $query .= " + $query .= " FIELDS TERMINATED BY - '".$fileSpec['delim']."' + '" . $fileSpec['delim'] . "' ENCLOSED BY - '".$fileSpec['quote']."' + '" . $fileSpec['quote'] . "' "; - if(isset($fileSpec['escape'])) - { - $query .= " ESCAPED BY '".$fileSpec['escape']."'"; - } - $query .= " + if (isset($fileSpec['escape'])) { + $query .= " ESCAPED BY '" . $fileSpec['escape'] . "'"; + } + $query .= " LINES TERMINATED BY - '".$fileSpec['eol']."' + '" . $fileSpec['eol'] . "' $fieldList "; - /* + /* * First attempt: assume web server and MySQL server are on the same machine; * this requires that the db user have the FILE privilege; however, since this is * a global privilege, it may not be granted due to security concerns */ - $keywords = array(''); + $keywords = array(''); - /* + /* * Second attempt: using the LOCAL keyword means the client reads the file and sends it to the server; * the LOCAL keyword may trigger a known PHP PDO_MYSQL bug when MySQL not built with --enable-local-infile * @see http://bugs.php.net/bug.php?id=54158 */ - $openBaseDir = ini_get('open_basedir'); - $safeMode = ini_get('safe_mode'); - if(empty($openBaseDir) && empty($safeMode)) - { - // php 5.x - LOAD DATA LOCAL INFILE is disabled if open_basedir restrictions or safe_mode enabled - $keywords[] = 'LOCAL '; - } - - $exceptions = array(); - foreach($keywords as $keyword) - { - try { - $queryStart = 'LOAD DATA '.$keyword.'INFILE '; - $sql = $queryStart.$query; - $result = @Piwik_Exec($sql); - if(empty($result) || $result < 0) - { - continue; - } - - return true; - } catch(Exception $e) { + $openBaseDir = ini_get('open_basedir'); + $safeMode = ini_get('safe_mode'); + if (empty($openBaseDir) && empty($safeMode)) { + // php 5.x - LOAD DATA LOCAL INFILE is disabled if open_basedir restrictions or safe_mode enabled + $keywords[] = 'LOCAL '; + } + + $exceptions = array(); + foreach ($keywords as $keyword) { + try { + $queryStart = 'LOAD DATA ' . $keyword . 'INFILE '; + $sql = $queryStart . $query; + $result = @Piwik_Exec($sql); + if (empty($result) || $result < 0) { + continue; + } + + return true; + } catch (Exception $e) { // echo $sql . ' ---- ' . $e->getMessage(); - $code = $e->getCode(); - $message = $e->getMessage() . ($code ? "[$code]" : ''); - if(!Zend_Registry::get('db')->isErrNo($e, '1148')) - { - Piwik::log(sprintf("LOAD DATA INFILE failed... Error was: %s", $message)); - } - $exceptions[] = "\n Try #" . (count($exceptions)+1) . ': ' . $queryStart .": ". $message; - } - } - if(count($exceptions)) - { - throw new Exception( implode( ",", $exceptions ) ); - } - return false; - } - - /** - * Performs a batch insert into a specific table using either LOAD DATA INFILE or plain INSERTs, - * as a fallback. On MySQL, LOAD DATA INFILE is 20x faster than a series of plain INSERTs. - * - * @param string $tableName PREFIXED table name! you must call Piwik_Common::prefixTable() before passing the table name - * @param array $fields array of unquoted field names - * @param array $values array of data to be inserted - * @param bool $throwException Whether to throw an exception that was caught while trying - * LOAD DATA INFILE, or not. - * @throws Exception - * @return bool True if the bulk LOAD was used, false if we fallback to plain INSERTs - */ - static public function tableInsertBatch($tableName, $fields, $values, $throwException = false) - { - $filePath = PIWIK_USER_PATH . '/' . Piwik_AssetManager::MERGED_FILE_DIR . $tableName . '-'.Piwik_Common::generateUniqId().'.csv'; - - if(Zend_Registry::get('db')->hasBulkLoader()) - { - try { + $code = $e->getCode(); + $message = $e->getMessage() . ($code ? "[$code]" : ''); + if (!Zend_Registry::get('db')->isErrNo($e, '1148')) { + Piwik::log(sprintf("LOAD DATA INFILE failed... Error was: %s", $message)); + } + $exceptions[] = "\n Try #" . (count($exceptions) + 1) . ': ' . $queryStart . ": " . $message; + } + } + if (count($exceptions)) { + throw new Exception(implode(",", $exceptions)); + } + return false; + } + + /** + * Performs a batch insert into a specific table using either LOAD DATA INFILE or plain INSERTs, + * as a fallback. On MySQL, LOAD DATA INFILE is 20x faster than a series of plain INSERTs. + * + * @param string $tableName PREFIXED table name! you must call Piwik_Common::prefixTable() before passing the table name + * @param array $fields array of unquoted field names + * @param array $values array of data to be inserted + * @param bool $throwException Whether to throw an exception that was caught while trying + * LOAD DATA INFILE, or not. + * @throws Exception + * @return bool True if the bulk LOAD was used, false if we fallback to plain INSERTs + */ + static public function tableInsertBatch($tableName, $fields, $values, $throwException = false) + { + $filePath = PIWIK_USER_PATH . '/' . Piwik_AssetManager::MERGED_FILE_DIR . $tableName . '-' . Piwik_Common::generateUniqId() . '.csv'; + + if (Zend_Registry::get('db')->hasBulkLoader()) { + try { // throw new Exception(''); - $fileSpec = array( - 'delim' => "\t", - 'quote' => '"', // chr(34) - 'escape' => '\\\\', // chr(92) - 'escapespecial_cb' => create_function('$str', 'return str_replace(array(chr(92), chr(34)), array(chr(92).chr(92), chr(92).chr(34)), $str);'), - 'eol' => "\r\n", - 'null' => 'NULL', - ); - - // hack for charset mismatch - if(!self::isDatabaseConnectionUTF8() && !isset(Piwik_Config::getInstance()->database['charset'])) - { - $fileSpec['charset'] = 'latin1'; - } - - self::createCSVFile($filePath, $fileSpec, $values); - - if(!is_readable($filePath)) - { - throw new Exception("File $filePath could not be read."); - } - - $rc = self::createTableFromCSVFile($tableName, $fields, $filePath, $fileSpec); - if($rc) { - unlink($filePath); - return true; - } - } catch(Exception $e) { - Piwik::log(sprintf("LOAD DATA INFILE failed or not supported, falling back to normal INSERTs... Error was: %s", $e->getMessage())); - - if ($throwException) - { - throw $e; - } - } - } - - // if all else fails, fallback to a series of INSERTs - @unlink($filePath); - self::tableInsertBatchIterate($tableName, $fields, $values); - return false; - } - - /** - * Performs a batch insert into a specific table by iterating through the data - * - * NOTE: you should use tableInsertBatch() which will fallback to this function if LOAD DATA INFILE not available - * - * @param string $tableName PREFIXED table name! you must call Piwik_Common::prefixTable() before passing the table name - * @param array $fields array of unquoted field names - * @param array $values array of data to be inserted - * @param bool $ignoreWhenDuplicate Ignore new rows that contain unique key values that duplicate old rows - */ - static public function tableInsertBatchIterate($tableName, $fields, $values, $ignoreWhenDuplicate = true) - { - $fieldList = '('.join(',', $fields).')'; - $ignore = $ignoreWhenDuplicate ? 'IGNORE' : ''; - - foreach($values as $row) { - $query = "INSERT $ignore - INTO ".$tableName." + $fileSpec = array( + 'delim' => "\t", + 'quote' => '"', // chr(34) + 'escape' => '\\\\', // chr(92) + 'escapespecial_cb' => create_function('$str', 'return str_replace(array(chr(92), chr(34)), array(chr(92).chr(92), chr(92).chr(34)), $str);'), + 'eol' => "\r\n", + 'null' => 'NULL', + ); + + // hack for charset mismatch + if (!self::isDatabaseConnectionUTF8() && !isset(Piwik_Config::getInstance()->database['charset'])) { + $fileSpec['charset'] = 'latin1'; + } + + self::createCSVFile($filePath, $fileSpec, $values); + + if (!is_readable($filePath)) { + throw new Exception("File $filePath could not be read."); + } + + $rc = self::createTableFromCSVFile($tableName, $fields, $filePath, $fileSpec); + if ($rc) { + unlink($filePath); + return true; + } + } catch (Exception $e) { + Piwik::log(sprintf("LOAD DATA INFILE failed or not supported, falling back to normal INSERTs... Error was: %s", $e->getMessage())); + + if ($throwException) { + throw $e; + } + } + } + + // if all else fails, fallback to a series of INSERTs + @unlink($filePath); + self::tableInsertBatchIterate($tableName, $fields, $values); + return false; + } + + /** + * Performs a batch insert into a specific table by iterating through the data + * + * NOTE: you should use tableInsertBatch() which will fallback to this function if LOAD DATA INFILE not available + * + * @param string $tableName PREFIXED table name! you must call Piwik_Common::prefixTable() before passing the table name + * @param array $fields array of unquoted field names + * @param array $values array of data to be inserted + * @param bool $ignoreWhenDuplicate Ignore new rows that contain unique key values that duplicate old rows + */ + static public function tableInsertBatchIterate($tableName, $fields, $values, $ignoreWhenDuplicate = true) + { + $fieldList = '(' . join(',', $fields) . ')'; + $ignore = $ignoreWhenDuplicate ? 'IGNORE' : ''; + + foreach ($values as $row) { + $query = "INSERT $ignore + INTO " . $tableName . " $fieldList - VALUES (".Piwik_Common::getSqlStringFieldsArray($row).")"; - Piwik_Query($query, $row); - } - } - - /** - * Generate advisory lock name - * - * @param int $idsite - * @param Piwik_Period $period - * @param Piwik_Segment $segment - * @return string - */ - static public function getArchiveProcessingLockName($idsite, $period, Piwik_Segment $segment) - { - $config = Piwik_Config::getInstance(); - - $lockName = 'piwik.' - . $config->database['dbname'] . '.' - . $config->database['tables_prefix'] . '/' - . $idsite . '/' - . (!$segment->isEmpty() ? $segment->getHash().'/' : '' ) - . $period->getId() . '/' - . $period->getDateStart()->toString('Y-m-d') . ',' - . $period->getDateEnd()->toString('Y-m-d'); - return $lockName .'/'. md5($lockName . Piwik_Common::getSalt()); - } - - /** - * Get an advisory lock - * - * @param int $idsite - * @param Piwik_Period $period - * @param Piwik_Segment $segment - * @return bool True if lock acquired; false otherwise - */ - static public function getArchiveProcessingLock($idsite, $period, $segment) - { - $lockName = self::getArchiveProcessingLockName($idsite, $period, $segment); - return Piwik_GetDbLock($lockName, $maxRetries = 30); - } - - /** - * Release an advisory lock - * - * @param int $idsite - * @param Piwik_Period $period - * @param Piwik_Segment $segment - * @return bool True if lock released; false otherwise - */ - static public function releaseArchiveProcessingLock($idsite, $period, $segment) - { - $lockName = self::getArchiveProcessingLockName($idsite, $period, $segment); - return Piwik_ReleaseDbLock($lockName); - } - - /** - * Cached result of isLockprivilegeGranted function. - * - * Public so tests can simulate the situation where the lock tables privilege isn't granted. - * - * @var bool - */ - static public $lockPrivilegeGranted = null; - - /** - * Checks whether the database user is allowed to lock tables. - * - * @return bool - */ - static public function isLockPrivilegeGranted() - { - if (is_null(self::$lockPrivilegeGranted)) - { - try - { - Piwik_LockTables(Piwik_Common::prefixTable('log_visit')); - Piwik_UnlockAllTables(); - - self::$lockPrivilegeGranted = true; - } - catch (Exception $ex) - { - self::$lockPrivilegeGranted = false; - } - } - - return self::$lockPrivilegeGranted; - } - - /** - * Utility function that checks if an object type is in a set of types. - * - * @param mixed $o - * @param array $types List of class names that $o is expected to be one of. - * @throws Exception if $o is not an instance of the types contained in $types. - */ - static public function checkObjectTypeIs( $o, $types ) - { - foreach ($types as $type) - { - if ($o instanceof $type) - { - return; - } - } - - $oType = is_object($o) ? get_class($o) : gettype($o); - throw new Exception("Invalid variable type '$oType', expected one of following: ".implode(', ', $types)); - } - - /** - * Returns true if an array is an associative array, false if otherwise. - * - * This method determines if an array is associative by checking that the - * first element's key is 0, and that each successive element's key is - * one greater than the last. - * - * @param array $array - * @return bool - */ - static public function isAssociativeArray( $array ) - { - reset($array); - if (!is_numeric(key($array)) - || key($array) != 0) // first key must be 0 - { - return true; - } - - // check that each key is == next key - 1 w/o actually indexing the array - while (true) - { - $current = key($array); - - next($array); - $next = key($array); - - if ($next === null) - { - break; - } - else if ($current + 1 != $next) - { - return true; - } - } - - return false; - } - - /** - * Checks if the filesystem Piwik stores sessions in is NFS or not. This - * check is done in order to avoid using file based sessions on NFS system, - * since on such a filesystem file locking can make file based sessions - * incredibly slow. - * - * Note: In order to figure this out, we try to run the 'df' program. If - * the 'exec' or 'shell_exec' functions are not available, we can't do - * the check. - * - * @return bool True if on an NFS filesystem, false if otherwise or if we - * can't use shell_exec or exec. - */ - public static function checkIfFileSystemIsNFS() - { - $sessionsPath = Piwik_Session::getSessionsDirectory(); - - // this command will display details for the filesystem that holds the $sessionsPath - // path, but only if its type is NFS. if not NFS, df will return one or less lines - // and the return code 1. if NFS, it will return 0 and at least 2 lines of text. - $command = "df -T -t nfs \"$sessionsPath\" 2>&1"; - - if (function_exists('exec')) // use exec - { - $output = $returnCode = null; - @exec($command, $output, $returnCode); - - // check if filesystem is NFS - if ($returnCode == 0 - && count($output) > 1) - { - return true; - } - } - else if (function_exists('shell_exec')) // use shell_exec - { - $output = @shell_exec($command); - if ($output) - { - $output = explode("\n", $output); - if (count($output) > 1) // check if filesystem is NFS - { - return true; - } - } - } - - return false; // not NFS, or we can't run a program to find out - } + VALUES (" . Piwik_Common::getSqlStringFieldsArray($row) . ")"; + Piwik_Query($query, $row); + } + } + + /** + * Generate advisory lock name + * + * @param int $idsite + * @param Piwik_Period $period + * @param Piwik_Segment $segment + * @return string + */ + static public function getArchiveProcessingLockName($idsite, $period, Piwik_Segment $segment) + { + $config = Piwik_Config::getInstance(); + + $lockName = 'piwik.' + . $config->database['dbname'] . '.' + . $config->database['tables_prefix'] . '/' + . $idsite . '/' + . (!$segment->isEmpty() ? $segment->getHash() . '/' : '') + . $period->getId() . '/' + . $period->getDateStart()->toString('Y-m-d') . ',' + . $period->getDateEnd()->toString('Y-m-d'); + return $lockName . '/' . md5($lockName . Piwik_Common::getSalt()); + } + + /** + * Get an advisory lock + * + * @param int $idsite + * @param Piwik_Period $period + * @param Piwik_Segment $segment + * @return bool True if lock acquired; false otherwise + */ + static public function getArchiveProcessingLock($idsite, $period, $segment) + { + $lockName = self::getArchiveProcessingLockName($idsite, $period, $segment); + return Piwik_GetDbLock($lockName, $maxRetries = 30); + } + + /** + * Release an advisory lock + * + * @param int $idsite + * @param Piwik_Period $period + * @param Piwik_Segment $segment + * @return bool True if lock released; false otherwise + */ + static public function releaseArchiveProcessingLock($idsite, $period, $segment) + { + $lockName = self::getArchiveProcessingLockName($idsite, $period, $segment); + return Piwik_ReleaseDbLock($lockName); + } + + /** + * Cached result of isLockprivilegeGranted function. + * + * Public so tests can simulate the situation where the lock tables privilege isn't granted. + * + * @var bool + */ + static public $lockPrivilegeGranted = null; + + /** + * Checks whether the database user is allowed to lock tables. + * + * @return bool + */ + static public function isLockPrivilegeGranted() + { + if (is_null(self::$lockPrivilegeGranted)) { + try { + Piwik_LockTables(Piwik_Common::prefixTable('log_visit')); + Piwik_UnlockAllTables(); + + self::$lockPrivilegeGranted = true; + } catch (Exception $ex) { + self::$lockPrivilegeGranted = false; + } + } + + return self::$lockPrivilegeGranted; + } + + /** + * Utility function that checks if an object type is in a set of types. + * + * @param mixed $o + * @param array $types List of class names that $o is expected to be one of. + * @throws Exception if $o is not an instance of the types contained in $types. + */ + static public function checkObjectTypeIs($o, $types) + { + foreach ($types as $type) { + if ($o instanceof $type) { + return; + } + } + + $oType = is_object($o) ? get_class($o) : gettype($o); + throw new Exception("Invalid variable type '$oType', expected one of following: " . implode(', ', $types)); + } + + /** + * Returns true if an array is an associative array, false if otherwise. + * + * This method determines if an array is associative by checking that the + * first element's key is 0, and that each successive element's key is + * one greater than the last. + * + * @param array $array + * @return bool + */ + static public function isAssociativeArray($array) + { + reset($array); + if (!is_numeric(key($array)) + || key($array) != 0 + ) // first key must be 0 + { + return true; + } + + // check that each key is == next key - 1 w/o actually indexing the array + while (true) { + $current = key($array); + + next($array); + $next = key($array); + + if ($next === null) { + break; + } else if ($current + 1 != $next) { + return true; + } + } + + return false; + } + + /** + * Checks if the filesystem Piwik stores sessions in is NFS or not. This + * check is done in order to avoid using file based sessions on NFS system, + * since on such a filesystem file locking can make file based sessions + * incredibly slow. + * + * Note: In order to figure this out, we try to run the 'df' program. If + * the 'exec' or 'shell_exec' functions are not available, we can't do + * the check. + * + * @return bool True if on an NFS filesystem, false if otherwise or if we + * can't use shell_exec or exec. + */ + public static function checkIfFileSystemIsNFS() + { + $sessionsPath = Piwik_Session::getSessionsDirectory(); + + // this command will display details for the filesystem that holds the $sessionsPath + // path, but only if its type is NFS. if not NFS, df will return one or less lines + // and the return code 1. if NFS, it will return 0 and at least 2 lines of text. + $command = "df -T -t nfs \"$sessionsPath\" 2>&1"; + + if (function_exists('exec')) // use exec + { + $output = $returnCode = null; + @exec($command, $output, $returnCode); + + // check if filesystem is NFS + if ($returnCode == 0 + && count($output) > 1 + ) { + return true; + } + } else if (function_exists('shell_exec')) // use shell_exec + { + $output = @shell_exec($command); + if ($output) { + $output = explode("\n", $output); + if (count($output) > 1) // check if filesystem is NFS + { + return true; + } + } + } + + return false; // not NFS, or we can't run a program to find out + } } |