PDF rausgenommen

msd2/tracking/piwik/plugins/UserCountry/Columns/Base.php

@@ -0,0 +1,92 @@
+<?php
+/**
+ * Piwik - free/libre analytics platform
+ *
+ * @link http://piwik.org
+ * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
+ *
+ */
+namespace Piwik\Plugins\UserCountry\Columns;
+
+use Piwik\Common;
+use Piwik\Exception\InvalidRequestParameterException;
+use Piwik\Network\IPUtils;
+use Piwik\Plugin\Dimension\VisitDimension;
+use Piwik\Plugins\UserCountry\VisitorGeolocator;
+use Piwik\Plugins\PrivacyManager\Config as PrivacyManagerConfig;
+use Piwik\Tracker\Visitor;
+use Piwik\Tracker\Request;
+
+abstract class Base extends VisitDimension
+{
+    /**
+     * @var VisitorGeolocator
+     */
+    private $visitorGeolocator;
+
+    protected function getUrlOverrideValueIfAllowed($urlParamToOverride, Request $request)
+    {
+        $value = Common::getRequestVar($urlParamToOverride, false, 'string', $request->getParams());
+
+        if (!empty($value)) {
+            if (!$request->isAuthenticated()) {
+                Common::printDebug("WARN: Tracker API '$urlParamToOverride' was used with invalid token_auth");
+                throw new InvalidRequestParameterException("Tracker API '$urlParamToOverride' was used, requires valid token_auth");
+            }
+            return $value;
+        }
+
+        return false;
+    }
+
+    public function getRequiredVisitFields()
+    {
+        return array('location_ip', 'location_browser_lang');
+    }
+
+    protected function getLocationDetail($userInfo, $locationKey)
+    {
+        $useLocationCache = empty($GLOBALS['PIWIK_TRACKER_LOCAL_TRACKING']);
+        $location = $this->getVisitorGeolocator()->getLocation($userInfo, $useLocationCache);
+
+        if (!isset($location[$locationKey])) {
+            return false;
+        }
+
+        return $location[$locationKey];
+    }
+
+    protected function getVisitorGeolocator()
+    {
+        if ($this->visitorGeolocator === null) {
+            $this->visitorGeolocator = new VisitorGeolocator();
+        }
+
+        return $this->visitorGeolocator;
+    }
+
+    protected function getUserInfo(Request $request, Visitor $visitor)
+    {
+        $ipAddress = $this->getIpAddress($visitor->getVisitorColumn('location_ip'), $request);
+        $language  = $request->getBrowserLanguage();
+
+        $userInfo  = array('lang' => $language, 'ip' => $ipAddress);
+
+        return $userInfo;
+    }
+
+    private function getIpAddress($anonymizedIp, \Piwik\Tracker\Request $request)
+    {
+        $privacyConfig = new PrivacyManagerConfig();
+
+        $ip = $request->getIp();
+
+        if ($privacyConfig->useAnonymizedIpForVisitEnrichment) {
+            $ip = $anonymizedIp;
+        }
+
+        $ipAddress = IPUtils::binaryToStringIP($ip);
+
+        return $ipAddress;
+    }
+}

msd2/tracking/piwik/plugins/UserCountry/Columns/City.php

@@ -0,0 +1,67 @@
+<?php
+/**
+ * Piwik - free/libre analytics platform
+ *
+ * @link http://piwik.org
+ * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
+ *
+ */
+namespace Piwik\Plugins\UserCountry\Columns;
+
+use Piwik\Plugins\UserCountry\LocationProvider;
+use Piwik\Tracker\Request;
+use Piwik\Tracker\Visitor;
+use Piwik\Tracker\Action;
+
+class City extends Base
+{
+    protected $columnName = 'location_city';
+    protected $columnType = 'varchar(255) DEFAULT NULL';
+    protected $type = self::TYPE_TEXT;
+    protected $segmentName = 'city';
+    protected $nameSingular = 'UserCountry_City';
+    protected $namePlural = 'UserCountryMap_Cities';
+    protected $acceptValues = 'Sydney, Sao Paolo, Rome, etc.';
+    protected $category = 'UserCountry_VisitLocation';
+
+    /**
+     * @param Request $request
+     * @param Visitor $visitor
+     * @param Action|null $action
+     * @return mixed
+     */
+    public function onNewVisit(Request $request, Visitor $visitor, $action)
+    {
+        $value = $this->getUrlOverrideValueIfAllowed('city', $request);
+
+        if ($value !== false) {
+            return $value;
+        }
+
+        $userInfo = $this->getUserInfo($request, $visitor);
+
+        return $this->getLocationDetail($userInfo, LocationProvider::CITY_NAME_KEY);
+    }
+
+    /**
+     * @param Request $request
+     * @param Visitor $visitor
+     * @param Action|null $action
+     * @return int
+     */
+    public function onExistingVisit(Request $request, Visitor $visitor, $action)
+    {
+        return $this->getUrlOverrideValueIfAllowed('city', $request);
+    }
+
+    /**
+     * @param Request $request
+     * @param Visitor $visitor
+     * @param Action|null $action
+     * @return mixed
+     */
+    public function onAnyGoalConversion(Request $request, Visitor $visitor, $action)
+    {
+        return $visitor->getVisitorColumn($this->columnName);
+    }
+}

msd2/tracking/piwik/plugins/UserCountry/Columns/Continent.php

@@ -0,0 +1,37 @@
+<?php
+/**
+ * Piwik - free/libre analytics platform
+ *
+ * @link http://piwik.org
+ * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
+ *
+ */
+namespace Piwik\Plugins\UserCountry\Columns;
+
+use Piwik\Columns\Dimension;
+use Piwik\Common;
+use Piwik\Metrics\Formatter;
+
+class Continent extends Dimension
+{
+    protected $dbTableName = 'log_visit';
+    protected $columnName = 'location_country';
+    protected $type = self::TYPE_TEXT;
+    protected $category = 'UserCountry_VisitLocation';
+    protected $nameSingular = 'UserCountry_Continent';
+    protected $namePlural = 'UserCountry_Continents';
+    protected $segmentName = 'continentCode';
+    protected $acceptValues = 'eur, asi, amc, amn, ams, afr, ant, oce';
+    protected $sqlFilter = 'Piwik\Plugins\UserCountry\UserCountry::getCountriesForContinent';
+
+    public function groupValue($value, $idSite)
+    {
+        return Common::getContinent($value);
+    }
+
+    public function formatValue($value, $idSite, Formatter $formatter)
+    {
+        return \Piwik\Plugins\UserCountry\continentTranslate($value);
+    }
+
+}

msd2/tracking/piwik/plugins/UserCountry/Columns/Country.php

@@ -0,0 +1,147 @@
+<?php
+/**
+ * Piwik - free/libre analytics platform
+ *
+ * @link http://piwik.org
+ * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
+ *
+ */
+namespace Piwik\Plugins\UserCountry\Columns;
+
+use Piwik\Common;
+use Piwik\Config;
+use Piwik\Container\StaticContainer;
+use Piwik\Intl\Data\Provider\RegionDataProvider;
+use Piwik\Metrics\Formatter;
+use Piwik\Network\IP;
+use Piwik\Plugin\Manager;
+use Piwik\Plugins\Provider\Provider as ProviderProvider;
+use Piwik\Plugins\UserCountry\LocationProvider;
+use Piwik\Tracker\Visit;
+use Piwik\Tracker\Visitor;
+use Piwik\Tracker\Action;
+use Piwik\Tracker\Request;
+
+require_once PIWIK_INCLUDE_PATH . '/plugins/UserCountry/functions.php';
+
+class Country extends Base
+{
+    protected $columnName = 'location_country';
+    protected $columnType = 'CHAR(3) NULL';
+    protected $type = self::TYPE_TEXT;
+
+    protected $category =  'UserCountry_VisitLocation';
+    protected $nameSingular = 'UserCountry_Country';
+    protected $namePlural = 'UserCountryMap_Countries';
+    protected $segmentName = 'countryCode';
+    protected $acceptValues = 'de, us, fr, in, es, etc.';
+
+    public function formatValue($value, $idSite, Formatter $formatter)
+    {
+        return \Piwik\Plugins\UserCountry\countryTranslate($value);
+    }
+
+    /**
+     * @param Request $request
+     * @param Visitor $visitor
+     * @param Action|null $action
+     * @return mixed
+     */
+    public function onNewVisit(Request $request, Visitor $visitor, $action)
+    {
+        $value = $this->getUrlOverrideValueIfAllowed('country', $request);
+
+        if ($value !== false) {
+            return $value;
+        }
+
+        $userInfo = $this->getUserInfo($request, $visitor);
+        $country  = $this->getLocationDetail($userInfo, LocationProvider::COUNTRY_CODE_KEY);
+
+        if (!empty($country) && $country != Visit::UNKNOWN_CODE) {
+            return strtolower($country);
+        }
+
+        $country = $this->getCountryUsingProviderExtensionIfValid($userInfo['ip']);
+
+        if (!empty($country)) {
+            return $country;
+        }
+
+        return Visit::UNKNOWN_CODE;
+    }
+
+    private function getCountryUsingProviderExtensionIfValid($ipAddress)
+    {
+        if (!Manager::getInstance()->isPluginInstalled('Provider')) {
+            return false;
+        }
+
+        $hostname = $this->getHost($ipAddress);
+        $hostnameExtension = ProviderProvider::getCleanHostname($hostname);
+
+        $hostnameDomain = substr($hostnameExtension, 1 + strrpos($hostnameExtension, '.'));
+        if ($hostnameDomain == 'uk') {
+            $hostnameDomain = 'gb';
+        }
+
+        /** @var RegionDataProvider $regionDataProvider */
+        $regionDataProvider = StaticContainer::get('Piwik\Intl\Data\Provider\RegionDataProvider');
+
+        if (array_key_exists($hostnameDomain, $regionDataProvider->getCountryList())) {
+            return $hostnameDomain;
+        }
+
+        return false;
+    }
+
+    /**
+     * Returns the hostname given the IP address string
+     *
+     * @param string $ipStr IP Address
+     * @return string hostname (or human-readable IP address)
+     */
+    private function getHost($ipStr)
+    {
+        $ip = IP::fromStringIP($ipStr);
+
+        $host = $ip->getHostname();
+        $host = ($host === null ? $ipStr : $host);
+
+        return trim(strtolower($host));
+    }
+
+    /**
+     * @param Request $request
+     * @param Visitor $visitor
+     * @param Action|null $action
+     * @return int
+     */
+    public function onExistingVisit(Request $request, Visitor $visitor, $action)
+    {
+        return $this->getUrlOverrideValueIfAllowed('country', $request);
+    }
+
+    /**
+     * @param Request $request
+     * @param Visitor $visitor
+     * @param Action|null $action
+     * @return mixed
+     */
+    public function onAnyGoalConversion(Request $request, Visitor $visitor, $action)
+    {
+        $country = $visitor->getVisitorColumn($this->columnName);
+
+        if (isset($country) && false !== $country) {
+            return $country;
+        }
+
+        $browserLanguage = $request->getBrowserLanguage();
+        $enableLanguageToCountryGuess = Config::getInstance()->Tracker['enable_language_to_country_guess'];
+        $locationIp = $visitor->getVisitorColumn('location_ip');
+
+        $country = Common::getCountry($browserLanguage, $enableLanguageToCountryGuess, $locationIp);
+
+        return $country;
+    }
+}

msd2/tracking/piwik/plugins/UserCountry/Columns/Latitude.php

@@ -0,0 +1,69 @@
+<?php
+/**
+ * Piwik - free/libre analytics platform
+ *
+ * @link http://piwik.org
+ * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
+ *
+ */
+namespace Piwik\Plugins\UserCountry\Columns;
+
+use Piwik\Plugins\UserCountry\LocationProvider;
+use Piwik\Tracker\Request;
+use Piwik\Tracker\Visitor;
+use Piwik\Tracker\Action;
+
+class Latitude extends Base
+{
+    protected $columnName = 'location_latitude';
+    protected $columnType = 'decimal(9, 6) DEFAULT NULL';
+    protected $type = self::TYPE_TEXT;
+    protected $category = 'UserCountry_VisitLocation';
+    protected $segmentName = 'latitude';
+    protected $nameSingular = 'UserCountry_Latitude';
+    protected $namePlural = 'UserCountry_Latitudes';
+    protected $acceptValues = '-33.578, 40.830, etc.<br/>You can select visitors within a lat/long range using &segment=lat&gt;X;lat&lt;Y;long&gt;M;long&lt;N.';
+
+    /**
+     * @param Request $request
+     * @param Visitor $visitor
+     * @param Action|null $action
+     * @return mixed
+     */
+    public function onNewVisit(Request $request, Visitor $visitor, $action)
+    {
+        $value = $this->getUrlOverrideValueIfAllowed('lat', $request);
+
+        if ($value !== false) {
+            return $value;
+        }
+
+        $userInfo = $this->getUserInfo($request, $visitor);
+
+        $latitude = $this->getLocationDetail($userInfo, LocationProvider::LATITUDE_KEY);
+
+        return $latitude;
+    }
+
+    /**
+     * @param Request $request
+     * @param Visitor $visitor
+     * @param Action|null $action
+     * @return int
+     */
+    public function onExistingVisit(Request $request, Visitor $visitor, $action)
+    {
+        return $this->getUrlOverrideValueIfAllowed('lat', $request);
+    }
+
+    /**
+     * @param Request $request
+     * @param Visitor $visitor
+     * @param Action|null $action
+     * @return mixed
+     */
+    public function onAnyGoalConversion(Request $request, Visitor $visitor, $action)
+    {
+        return $visitor->getVisitorColumn($this->columnName);
+    }
+}

msd2/tracking/piwik/plugins/UserCountry/Columns/Longitude.php

@@ -0,0 +1,69 @@
+<?php
+/**
+ * Piwik - free/libre analytics platform
+ *
+ * @link http://piwik.org
+ * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
+ *
+ */
+namespace Piwik\Plugins\UserCountry\Columns;
+
+use Piwik\Plugins\UserCountry\LocationProvider;
+use Piwik\Tracker\Request;
+use Piwik\Tracker\Visitor;
+use Piwik\Tracker\Action;
+
+class Longitude extends Base
+{
+    protected $columnName = 'location_longitude';
+    protected $columnType = 'decimal(9, 6) DEFAULT NULL';
+    protected $type = self::TYPE_TEXT;
+    protected $category = 'UserCountry_VisitLocation';
+    protected $acceptValues = '-70.664, 14.326, etc.';
+    protected $segmentName = 'longitude';
+    protected $nameSingular = 'UserCountry_Longitude';
+    protected $namePlural = 'UserCountry_Longitudes';
+
+    /**
+     * @param Request $request
+     * @param Visitor $visitor
+     * @param Action|null $action
+     * @return mixed
+     */
+    public function onNewVisit(Request $request, Visitor $visitor, $action)
+    {
+        $value = $this->getUrlOverrideValueIfAllowed('long', $request);
+
+        if ($value !== false) {
+            return $value;
+        }
+
+        $userInfo = $this->getUserInfo($request, $visitor);
+
+        $longitude = $this->getLocationDetail($userInfo, LocationProvider::LONGITUDE_KEY);
+
+        return $longitude;
+    }
+
+    /**
+     * @param Request $request
+     * @param Visitor $visitor
+     * @param Action|null $action
+     * @return int
+     */
+    public function onExistingVisit(Request $request, Visitor $visitor, $action)
+    {
+        return $this->getUrlOverrideValueIfAllowed('long', $request);
+    }
+
+    /**
+     * @param Request $request
+     * @param Visitor $visitor
+     * @param Action|null $action
+     * @return mixed
+     */
+    public function onAnyGoalConversion(Request $request, Visitor $visitor, $action)
+    {
+        return $visitor->getVisitorColumn($this->columnName);
+    }
+}

msd2/tracking/piwik/plugins/UserCountry/Columns/Provider.php

@@ -0,0 +1,58 @@
+<?php
+/**
+ * Piwik - free/libre analytics platform
+ *
+ * @link http://piwik.org
+ * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
+ *
+ */
+namespace Piwik\Plugins\UserCountry\Columns;
+
+use Piwik\Plugin\Manager;
+use Piwik\Plugins\UserCountry\LocationProvider;
+use Piwik\Tracker\Visitor;
+use Piwik\Tracker\Action;
+use Piwik\Tracker\Request;
+
+class Provider extends Base
+{
+    protected $columnName = 'location_provider';
+    protected $type = self::TYPE_TEXT;
+    protected $category = 'UserCountry_VisitLocation';
+
+    /**
+     * @param Request $request
+     * @param Visitor $visitor
+     * @param Action|null $action
+     * @return mixed
+     */
+    public function onNewVisit(Request $request, Visitor $visitor, $action)
+    {
+        if (!Manager::getInstance()->isPluginInstalled('Provider')) {
+            return false;
+        }
+
+        $userInfo = $this->getUserInfo($request, $visitor);
+
+        $isp = $this->getLocationDetail($userInfo, LocationProvider::ISP_KEY);
+        $org = $this->getLocationDetail($userInfo, LocationProvider::ORG_KEY);
+
+        // if the location has provider/organization info, set it
+        if (!empty($isp)) {
+            $providerValue = $isp;
+
+            // if the org is set and not the same as the isp, add it to the provider value
+            if (!empty($org) && $org != $providerValue) {
+                $providerValue .= ' - ' . $org;
+            }
+
+            return $providerValue;
+        }
+
+        if (!empty($org)) {
+            return $org;
+        }
+
+        return false;
+    }
+}

msd2/tracking/piwik/plugins/UserCountry/Columns/Region.php

@@ -0,0 +1,66 @@
+<?php
+/**
+ * Piwik - free/libre analytics platform
+ *
+ * @link http://piwik.org
+ * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
+ *
+ */
+namespace Piwik\Plugins\UserCountry\Columns;
+
+use Piwik\Plugins\UserCountry\LocationProvider;
+use Piwik\Tracker\Request;
+use Piwik\Tracker\Visitor;
+use Piwik\Tracker\Action;
+
+class Region extends Base
+{
+    protected $columnName = 'location_region';
+    protected $type = self::TYPE_TEXT;
+    protected $category = 'UserCountry_VisitLocation';
+    protected $segmentName = 'regionCode';
+    protected $nameSingular = 'UserCountry_Region';
+    protected $namePlural = 'UserCountryMap_Regions';
+    protected $acceptValues = '01 02, OR, P8, etc.<br/>eg. region=BFC;country=fr';
+
+    /**
+     * @param Request $request
+     * @param Visitor $visitor
+     * @param Action|null $action
+     * @return mixed
+     */
+    public function onNewVisit(Request $request, Visitor $visitor, $action)
+    {
+        $value = $this->getUrlOverrideValueIfAllowed('region', $request);
+
+        if ($value !== false) {
+            return $value;
+        }
+
+        $userInfo = $this->getUserInfo($request, $visitor);
+
+        return $this->getLocationDetail($userInfo, LocationProvider::REGION_CODE_KEY);
+    }
+
+    /**
+     * @param Request $request
+     * @param Visitor $visitor
+     * @param Action|null $action
+     * @return int
+     */
+    public function onExistingVisit(Request $request, Visitor $visitor, $action)
+    {
+        return $this->getUrlOverrideValueIfAllowed('region', $request);
+    }
+
+    /**
+     * @param Request $request
+     * @param Visitor $visitor
+     * @param Action|null $action
+     * @return mixed
+     */
+    public function onAnyGoalConversion(Request $request, Visitor $visitor, $action)
+    {
+        return $visitor->getVisitorColumn($this->columnName);
+    }
+}