add piwik installation
This commit is contained in:
coderkun
parent
90aa4ef157
commit
8c5d4f0c31
3197 changed files with 563902 additions and 0 deletions
372
www/analytics/core/SettingsPiwik.php
Normal file
372
www/analytics/core/SettingsPiwik.php
Normal file
|
|
@ -0,0 +1,372 @@
|
|||
<?php
|
||||
/**
|
||||
* Piwik - Open source web analytics
|
||||
*
|
||||
* @link http://piwik.org
|
||||
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
|
||||
*
|
||||
*/
|
||||
namespace Piwik;
|
||||
|
||||
use Exception;
|
||||
|
||||
/**
|
||||
* Contains helper methods that can be used to get common Piwik settings.
|
||||
*
|
||||
*/
|
||||
class SettingsPiwik
|
||||
{
|
||||
const OPTION_PIWIK_URL = 'piwikUrl';
|
||||
/**
|
||||
* Get salt from [General] section
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public static function getSalt()
|
||||
{
|
||||
static $salt = null;
|
||||
if (is_null($salt)) {
|
||||
$salt = @Config::getInstance()->General['salt'];
|
||||
}
|
||||
return $salt;
|
||||
}
|
||||
|
||||
/**
|
||||
* Should Piwik check that the login & password have minimum length and valid characters?
|
||||
*
|
||||
* @return bool True if checks enabled; false otherwise
|
||||
*/
|
||||
public static function isUserCredentialsSanityCheckEnabled()
|
||||
{
|
||||
return Config::getInstance()->General['disable_checks_usernames_attributes'] == 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* @see getKnownSegmentsToArchive
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
public static $cachedKnownSegmentsToArchive = null;
|
||||
|
||||
/**
|
||||
* Returns every stored segment to pre-process for each site during cron archiving.
|
||||
*
|
||||
* @return array The list of stored segments that apply to all sites.
|
||||
*/
|
||||
public static function getKnownSegmentsToArchive()
|
||||
{
|
||||
if (self::$cachedKnownSegmentsToArchive === null) {
|
||||
$segments = Config::getInstance()->Segments;
|
||||
$segmentsToProcess = isset($segments['Segments']) ? $segments['Segments'] : array();
|
||||
|
||||
/**
|
||||
* Triggered during the cron archiving process to collect segments that
|
||||
* should be pre-processed for all websites. The archiving process will be launched
|
||||
* for each of these segments when archiving data.
|
||||
*
|
||||
* This event can be used to add segments to be pre-processed. If your plugin depends
|
||||
* on data from a specific segment, this event could be used to provide enhanced
|
||||
* performance.
|
||||
*
|
||||
* _Note: If you just want to add a segment that is managed by the user, use the
|
||||
* SegmentEditor API._
|
||||
*
|
||||
* **Example**
|
||||
*
|
||||
* Piwik::addAction('Segments.getKnownSegmentsToArchiveAllSites', function (&$segments) {
|
||||
* $segments[] = 'country=jp;city=Tokyo';
|
||||
* });
|
||||
*
|
||||
* @param array &$segmentsToProcess List of segment definitions, eg,
|
||||
*
|
||||
* array(
|
||||
* 'browserCode=ff;resolution=800x600',
|
||||
* 'country=jp;city=Tokyo'
|
||||
* )
|
||||
*
|
||||
* Add segments to this array in your event handler.
|
||||
*/
|
||||
Piwik::postEvent('Segments.getKnownSegmentsToArchiveAllSites', array(&$segmentsToProcess));
|
||||
|
||||
self::$cachedKnownSegmentsToArchive = array_unique($segmentsToProcess);
|
||||
}
|
||||
|
||||
return self::$cachedKnownSegmentsToArchive;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the list of stored segments to pre-process for an individual site when executing
|
||||
* cron archiving.
|
||||
*
|
||||
* @param int $idSite The ID of the site to get stored segments for.
|
||||
* @return string The list of stored segments that apply to the requested site.
|
||||
*/
|
||||
public static function getKnownSegmentsToArchiveForSite($idSite)
|
||||
{
|
||||
$segments = array();
|
||||
|
||||
/**
|
||||
* Triggered during the cron archiving process to collect segments that
|
||||
* should be pre-processed for one specific site. The archiving process will be launched
|
||||
* for each of these segments when archiving data for that one site.
|
||||
*
|
||||
* This event can be used to add segments to be pre-processed for one site.
|
||||
*
|
||||
* _Note: If you just want to add a segment that is managed by the user, you should use the
|
||||
* SegmentEditor API._
|
||||
*
|
||||
* **Example**
|
||||
*
|
||||
* Piwik::addAction('Segments.getKnownSegmentsToArchiveForSite', function (&$segments, $idSite) {
|
||||
* $segments[] = 'country=jp;city=Tokyo';
|
||||
* });
|
||||
*
|
||||
* @param array &$segmentsToProcess List of segment definitions, eg,
|
||||
*
|
||||
* array(
|
||||
* 'browserCode=ff;resolution=800x600',
|
||||
* 'country=JP;city=Tokyo'
|
||||
* )
|
||||
*
|
||||
* Add segments to this array in your event handler.
|
||||
* @param int $idSite The ID of the site to get segments for.
|
||||
*/
|
||||
Piwik::postEvent('Segments.getKnownSegmentsToArchiveForSite', array(&$segments, $idSite));
|
||||
return $segments;
|
||||
}
|
||||
|
||||
/**
|
||||
* Number of websites to show in the Website selector
|
||||
*
|
||||
* @return int
|
||||
*/
|
||||
public static function getWebsitesCountToDisplay()
|
||||
{
|
||||
$count = max(Config::getInstance()->General['site_selector_max_sites'],
|
||||
Config::getInstance()->General['autocomplete_min_sites']);
|
||||
return (int)$count;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the URL to this Piwik instance, eg. **http://demo.piwik.org/** or **http://example.org/piwik/**.
|
||||
*
|
||||
* @return string
|
||||
* @api
|
||||
*/
|
||||
public static function getPiwikUrl()
|
||||
{
|
||||
$url = Option::get(self::OPTION_PIWIK_URL);
|
||||
|
||||
$isPiwikCoreDispatching = defined('PIWIK_ENABLE_DISPATCH') && PIWIK_ENABLE_DISPATCH;
|
||||
if (Common::isPhpCliMode()
|
||||
// in case archive.php is triggered with domain localhost
|
||||
|| SettingsServer::isArchivePhpTriggered()
|
||||
// When someone else than core is dispatching this request then we return the URL as it is read only
|
||||
|| !$isPiwikCoreDispatching
|
||||
) {
|
||||
return $url;
|
||||
}
|
||||
|
||||
$currentUrl = Common::sanitizeInputValue(Url::getCurrentUrlWithoutFileName());
|
||||
|
||||
if (empty($url)
|
||||
// if URL changes, always update the cache
|
||||
|| $currentUrl != $url
|
||||
) {
|
||||
if (strlen($currentUrl) >= strlen('http://a/')) {
|
||||
self::overwritePiwikUrl($currentUrl);
|
||||
}
|
||||
$url = $currentUrl;
|
||||
}
|
||||
|
||||
if(ProxyHttp::isHttps()) {
|
||||
$url = str_replace("http://", "https://", $url);
|
||||
}
|
||||
return $url;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return true if Piwik is installed (installation is done).
|
||||
* @return bool
|
||||
*/
|
||||
public static function isPiwikInstalled()
|
||||
{
|
||||
$config = Config::getInstance()->getLocalConfigPath();
|
||||
$exists = file_exists($config);
|
||||
|
||||
// Piwik is installed if the config file is found
|
||||
return $exists;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns `true` if segmentation is allowed for this user, `false` if otherwise.
|
||||
*
|
||||
* @return bool
|
||||
* @api
|
||||
*/
|
||||
public static function isSegmentationEnabled()
|
||||
{
|
||||
return !Piwik::isUserIsAnonymous()
|
||||
|| Config::getInstance()->General['anonymous_user_enable_use_segments_API'];
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns true if unique visitors should be processed for the given period type.
|
||||
*
|
||||
* Unique visitor processing is controlled by the `[General] enable_processing_unique_visitors_...`
|
||||
* INI config options. By default, unique visitors are processed only for day/week/month periods.
|
||||
*
|
||||
* @param string $periodLabel `"day"`, `"week"`, `"month"`, `"year"` or `"range"`
|
||||
* @return bool
|
||||
* @api
|
||||
*/
|
||||
public static function isUniqueVisitorsEnabled($periodLabel)
|
||||
{
|
||||
$generalSettings = 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;
|
||||
}
|
||||
|
||||
/**
|
||||
* If Piwik uses per-domain config file, also make tmp/ folder per-domain
|
||||
* @param $path
|
||||
* @return string
|
||||
* @throws \Exception
|
||||
*/
|
||||
public static function rewriteTmpPathWithHostname($path)
|
||||
{
|
||||
$tmp = '/tmp/';
|
||||
$path = self::rewritePathAppendHostname($path, $tmp);
|
||||
return $path;
|
||||
}
|
||||
|
||||
/**
|
||||
* If Piwik uses per-domain config file, make sure CustomLogo is unique
|
||||
* @param $path
|
||||
* @return mixed
|
||||
*/
|
||||
public static function rewriteMiscUserPathWithHostname($path)
|
||||
{
|
||||
$tmp = 'misc/user/';
|
||||
$path = self::rewritePathAppendHostname($path, $tmp);
|
||||
return $path;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns true if the Piwik server appears to be working.
|
||||
*
|
||||
* @param $piwikServerUrl
|
||||
* @return bool
|
||||
*/
|
||||
static public function checkPiwikServerWorking($piwikServerUrl, $acceptInvalidSSLCertificates = false)
|
||||
{
|
||||
// Now testing if the webserver is running
|
||||
try {
|
||||
$fetched = Http::sendHttpRequestBy('curl',
|
||||
$piwikServerUrl,
|
||||
$timeout = 45,
|
||||
$userAgent = null,
|
||||
$destinationPath = null,
|
||||
$file = null,
|
||||
$followDepth = 0,
|
||||
$acceptLanguage = false,
|
||||
$acceptInvalidSSLCertificates
|
||||
);
|
||||
} catch (Exception $e) {
|
||||
$fetched = "ERROR fetching: " . $e->getMessage();
|
||||
}
|
||||
$expectedString = 'plugins/CoreHome/images/favicon.ico';
|
||||
|
||||
if (strpos($fetched, $expectedString) === false) {
|
||||
throw new Exception("\nPiwik should be running at: "
|
||||
. $piwikServerUrl
|
||||
. " but this URL returned an unexpected response: '"
|
||||
. $fetched . "'\n\n");
|
||||
}
|
||||
}
|
||||
|
||||
public static function getCurrentGitBranch()
|
||||
{
|
||||
$file = PIWIK_INCLUDE_PATH . '/.git/HEAD';
|
||||
if(!file_exists($file)) {
|
||||
return '';
|
||||
}
|
||||
$firstLineOfGitHead = file($file);
|
||||
if (empty($firstLineOfGitHead)) {
|
||||
return '';
|
||||
}
|
||||
$firstLineOfGitHead = $firstLineOfGitHead[0];
|
||||
$parts = explode('/', $firstLineOfGitHead);
|
||||
if (empty($parts[2])) {
|
||||
return '';
|
||||
}
|
||||
$currentGitBranch = trim($parts[2]);
|
||||
return $currentGitBranch;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param $pathToRewrite
|
||||
* @param $leadingPathToAppendHostnameTo
|
||||
* @param $hostname
|
||||
* @return mixed
|
||||
* @throws \Exception
|
||||
*/
|
||||
protected static function rewritePathAppendHostname($pathToRewrite, $leadingPathToAppendHostnameTo)
|
||||
{
|
||||
$hostname = self::getConfigHostname();
|
||||
if (empty($hostname)) {
|
||||
return $pathToRewrite;
|
||||
}
|
||||
|
||||
if (($posTmp = strrpos($pathToRewrite, $leadingPathToAppendHostnameTo)) === false) {
|
||||
throw new Exception("The path $pathToRewrite was expected to contain the string $leadingPathToAppendHostnameTo");
|
||||
}
|
||||
|
||||
$tmpToReplace = $leadingPathToAppendHostnameTo . $hostname . '/';
|
||||
|
||||
// replace only the latest occurrence (in case path contains twice /tmp)
|
||||
$pathToRewrite = substr_replace($pathToRewrite, $tmpToReplace, $posTmp, strlen($leadingPathToAppendHostnameTo));
|
||||
return $pathToRewrite;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return bool|string
|
||||
*/
|
||||
protected static function getConfigHostname()
|
||||
{
|
||||
$configByHost = false;
|
||||
try {
|
||||
$configByHost = Config::getInstance()->getConfigHostnameIfSet();
|
||||
return $configByHost;
|
||||
} catch (Exception $e) {
|
||||
// Config file not found
|
||||
}
|
||||
return $configByHost;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param $currentUrl
|
||||
*/
|
||||
public static function overwritePiwikUrl($currentUrl)
|
||||
{
|
||||
Option::set(self::OPTION_PIWIK_URL, $currentUrl, $autoLoad = true);
|
||||
}
|
||||
|
||||
/**
|
||||
* @return bool
|
||||
*/
|
||||
public static function isHttpsForced()
|
||||
{
|
||||
return Config::getInstance()->General['force_ssl'] == 1;
|
||||
}
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue