diff options
Diffstat (limited to 'plugins/UserCountry/Controller.php')
| -rw-r--r-- | plugins/UserCountry/Controller.php | 390 |
1 files changed, 10 insertions, 380 deletions
diff --git a/plugins/UserCountry/Controller.php b/plugins/UserCountry/Controller.php index 97b5eadf92..5a980f5702 100644 --- a/plugins/UserCountry/Controller.php +++ b/plugins/UserCountry/Controller.php @@ -10,14 +10,9 @@ namespace Piwik\Plugins\UserCountry; use Exception; use Piwik\Common; -use Piwik\DataTable\Renderer\Json; -use Piwik\Http; -use Piwik\Date; use Piwik\IP; use Piwik\Piwik; use Piwik\Plugin\Manager; -use Piwik\Plugins\GeoIp2\GeoIP2AutoUpdater; -use Piwik\Plugins\UserCountry\LocationProvider\GeoIp; use Piwik\Plugins\GeoIp2\LocationProvider\GeoIp2; use Piwik\Plugins\UserCountry\LocationProvider\DefaultProvider; use Piwik\SettingsPiwik; @@ -48,15 +43,7 @@ class Controller extends \Piwik\Plugin\ControllerAdmin $view->locationProviders = $allProviderInfo; $view->currentProviderId = LocationProvider::getCurrentProviderId(); $view->thisIP = IP::getIpFromHeader(); - - if ($this->isGeoIp2Enabled()) { - $geoIPDatabasesInstalled = GeoIp2::isDatabaseInstalled(); - } else { - $geoIPDatabasesInstalled = GeoIp::isDatabaseInstalled(); - } - - $view->geoIPDatabasesInstalled = $geoIPDatabasesInstalled; - $view->updatePeriodOptions = $this->getPeriodUpdateOptions(); + $view->hasGeoIp2Provider = Manager::getInstance()->isPluginActivated('GeoIp2'); // check if there is a working provider (that isn't the default one) $isThereWorkingProvider = false; @@ -70,26 +57,14 @@ class Controller extends \Piwik\Plugin\ControllerAdmin } $view->isThereWorkingProvider = $isThereWorkingProvider; - $view->notUsingGeoIpPlugin = !Manager::getInstance()->isPluginActivated('GeoIp2') - && !Manager::getInstance()->isPluginActivated('GeoIp'); - - // if using either the Apache, Nginx or PECL module, they are working and there are no databases - // in misc, then the databases are located outside of Piwik, so we cannot update them - $view->showGeoIPUpdateSection = true; - $currentProviderId = LocationProvider::getCurrentProviderId(); - if (!$geoIPDatabasesInstalled - && in_array($currentProviderId, [GeoIp2\ServerModule::ID, GeoIp\ServerBased::ID, GeoIp\Pecl::ID]) - && $allProviderInfo[$currentProviderId]['status'] == LocationProvider::INSTALLED - ) { - $view->showGeoIPUpdateSection = false; + $configurations = $setUpGuides = ''; + foreach (LocationProvider::getAllProviders() as $provider) { + $configurations .= $provider->renderConfiguration(); + $setUpGuides .= $provider->renderSetUpGuide(); } - if ($view->notUsingGeoIpPlugin) { - $view->showGeoIPUpdateSection = false; - } - - $view->isInternetEnabled = SettingsPiwik::isInternetEnabled(); - $this->setUpdaterManageVars($view); + $view->configurations = $configurations; + $view->setUpGuides = $setUpGuides; $this->setBasicVariablesView($view); $this->setBasicVariablesAdminView($view); @@ -97,301 +72,6 @@ class Controller extends \Piwik\Plugin\ControllerAdmin } /** - * Starts or continues download of GeoLiteCity.dat. - * - * To avoid a server/PHP timeout & to show progress of the download to the user, we - * use the HTTP Range header to download one chunk of the file at a time. After each - * chunk, it is the browser's responsibility to call the method again to continue the download. - * - * Input: - * 'continue' query param - if set to 1, will assume we are currently downloading & use - * Range: HTTP header to get another chunk of the file. - * - * Output (in JSON): - * 'current_size' - Current size of the partially downloaded file on disk. - * 'expected_file_size' - The expected finished file size as returned by the HTTP server. - * 'next_screen' - When the download finishes, this is the next screen that should be shown. - * 'error' - When an error occurs, the message is returned in this property. - */ - public function downloadFreeGeoIPDB() - { - $this->dieIfGeolocationAdminIsDisabled(); - Piwik::checkUserHasSuperUserAccess(); - - if ($this->isGeoIp2Enabled()) { - return $this->downloadFreeDBIPLiteDB(); - } - - if ($_SERVER["REQUEST_METHOD"] == "POST") { - $this->checkTokenInUrl(); - Json::sendHeaderJSON(); - $outputPath = GeoIp::getPathForGeoIpDatabase('GeoIPCity.dat') . '.gz'; - try { - $result = Http::downloadChunk( - $url = GeoIp::GEO_LITE_URL, - $outputPath, - $continue = Common::getRequestVar('continue', true, 'int') - ); - - // if the file is done - if ($result['current_size'] >= $result['expected_file_size']) { - GeoIPAutoUpdater::unzipDownloadedFile($outputPath, $unlink = true); - - // setup the auto updater - GeoIPAutoUpdater::setUpdaterOptions(array( - 'loc' => GeoIp::GEO_LITE_URL, - 'period' => GeoIPAutoUpdater::SCHEDULE_PERIOD_MONTHLY, - )); - - // make sure to echo out the geoip updater management screen - $result['settings'] = GeoIPAutoUpdater::getConfiguredUrls(); - } - - return json_encode($result); - } catch (Exception $ex) { - return json_encode(array('error' => $ex->getMessage())); - } - } - } - - /** - * Starts or continues download of DBIP-City.mmdb. - * - * To avoid a server/PHP timeout & to show progress of the download to the user, we - * use the HTTP Range header to download one chunk of the file at a time. After each - * chunk, it is the browser's responsibility to call the method again to continue the download. - * - * Input: - * 'continue' query param - if set to 1, will assume we are currently downloading & use - * Range: HTTP header to get another chunk of the file. - * - * Output (in JSON): - * 'current_size' - Current size of the partially downloaded file on disk. - * 'expected_file_size' - The expected finished file size as returned by the HTTP server. - * 'next_screen' - When the download finishes, this is the next screen that should be shown. - * 'error' - When an error occurs, the message is returned in this property. - */ - public function downloadFreeDBIPLiteDB() - { - $this->dieIfGeolocationAdminIsDisabled(); - Piwik::checkUserHasSuperUserAccess(); - if ($_SERVER["REQUEST_METHOD"] == "POST") { - $this->checkTokenInUrl(); - Json::sendHeaderJSON(); - $outputPath = GeoIp2::getPathForGeoIpDatabase('DBIP-City.mmdb') . '.gz'; - try { - $result = Http::downloadChunk( - $url = GeoIp2::getDbIpLiteUrl(), - $outputPath, - $continue = Common::getRequestVar('continue', true, 'int') - ); - - // if the file is done - if ($result['current_size'] >= $result['expected_file_size']) { - try { - GeoIP2AutoUpdater::unzipDownloadedFile($outputPath, 'loc', $url, $unlink = true); - } catch (\Exception $e) { - // remove downloaded file on error - unlink($outputPath); - throw $e; - } - - // setup the auto updater - GeoIP2AutoUpdater::setUpdaterOptions(array( - 'loc' => GeoIp2::getDbIpLiteUrl(), - 'period' => GeoIP2AutoUpdater::SCHEDULE_PERIOD_MONTHLY, - )); - - $result['settings'] = GeoIP2AutoUpdater::getConfiguredUrls(); - } - - return json_encode($result); - } catch (Exception $ex) { - return json_encode(array('error' => $ex->getMessage())); - } - } - } - - private function getPeriodUpdateOptions() - { - return array( - 'month' => Piwik::translate('Intl_PeriodMonth'), - 'week' => Piwik::translate('Intl_PeriodWeek') - ); - } - - /** - * Sets some variables needed by the _updaterManage.twig template. - * - * @param View $view - */ - private function setUpdaterManageVars($view) - { - $view->isGeoIp2Available = $this->isGeoIp2Enabled(); - - if ($this->isGeoIp2Enabled()) { - // Get GeoIPLegacy Update information to show them - $urls = GeoIPAutoUpdater::getConfiguredUrls(); - $today = Date::today(); - - $view->geoIPLegacyLocUrl = $urls['loc']; - $view->geoIPLegacyIspUrl = $urls['isp']; - $view->geoIPLegacyOrgUrl = $urls['org']; - $view->geoIPLegacyUpdatePeriod = GeoIPAutoUpdater::getSchedulePeriod(); - - $urls = GeoIP2AutoUpdater::getConfiguredUrls(); - - $view->geoIPLocUrl = $urls['loc']; - $view->geoIPIspUrl = $urls['isp']; - $view->geoIPUpdatePeriod = GeoIP2AutoUpdater::getSchedulePeriod(); - - $view->dbipLiteUrl = GeoIp2::getDbIpLiteUrl(); - $view->dbipLiteFilename = "dbip-city-lite-{$today->toString('Y-m')}.mmdb"; - $view->dbipLiteDesiredFilename = "DBIP-City.mmdb"; - $view->nextRunTime = GeoIP2AutoUpdater::getNextRunTime(); - - $lastRunTime = GeoIP2AutoUpdater::getLastRunTime(); - } else { - $urls = GeoIPAutoUpdater::getConfiguredUrls(); - - $view->geoIPLocUrl = $urls['loc']; - $view->geoIPIspUrl = $urls['isp']; - $view->geoIPOrgUrl = $urls['org']; - $view->geoIPUpdatePeriod = GeoIPAutoUpdater::getSchedulePeriod(); - - $view->geoLiteUrl = GeoIp::GEO_LITE_URL; - $view->geoLiteFilename = 'GeoLiteCity.dat'; - $view->nextRunTime = GeoIPAutoUpdater::getNextRunTime(); - - $lastRunTime = GeoIPAutoUpdater::getLastRunTime(); - } - - if ($lastRunTime !== false) { - $view->lastTimeUpdaterRun = '<strong>' . $lastRunTime->toString() . '</strong>'; - } - } - - /** - * Sets the URLs used to download new versions of the installed GeoIP databases. - * - * Input (query params): - * 'loc_db' - URL for a GeoIP location database. - * 'isp_db' - URL for a GeoIP ISP database (optional). - * 'org_db' - URL for a GeoIP Org database (optional). - * 'period' - 'weekly' or 'monthly'. Determines how often update is run. - * - * Output (json): - * 'error' - if an error occurs its message is set as the resulting JSON object's - * 'error' property. - */ - public function updateGeoIPLinks() - { - $this->dieIfGeolocationAdminIsDisabled(); - Piwik::checkUserHasSuperUserAccess(); - if ($_SERVER["REQUEST_METHOD"] == "POST") { - Json::sendHeaderJSON(); - try { - $this->checkTokenInUrl(); - - if ($this->isGeoIp2Enabled()) { - GeoIP2AutoUpdater::setUpdaterOptionsFromUrl(); - } else { - GeoIPAutoUpdater::setUpdaterOptionsFromUrl(); - } - - // if there is a updater URL for a database, but its missing from the misc dir, tell - // the browser so it can download it next - $info = $this->getNextMissingDbUrlInfo(); - if ($info !== false) { - return json_encode($info); - } else { - $view = new View("@UserCountry/_updaterNextRunTime"); - if ($this->isGeoIp2Enabled()) { - $view->nextRunTime = GeoIP2AutoUpdater::getNextRunTime(); - } else { - $view->nextRunTime = GeoIPAutoUpdater::getNextRunTime(); - } - $nextRunTimeHtml = $view->render(); - return json_encode(array('nextRunTime' => $nextRunTimeHtml)); - } - } catch (Exception $ex) { - return json_encode(array('error' => $ex->getMessage())); - } - } - } - - /** - * Starts or continues a download for a missing GeoIP database. A database is missing if - * it has an update URL configured, but the actual database is not available in the misc - * directory. - * - * Input: - * 'url' - The URL to download the database from. - * 'continue' - 1 if we're continuing a download, 0 if we're starting one. - * - * Output: - * 'error' - If an error occurs this describes the error. - * 'to_download' - The URL of a missing database that should be downloaded next (if any). - * 'to_download_label' - The label to use w/ the progress bar that describes what we're - * downloading. - * 'current_size' - Size of the current file on disk. - * 'expected_file_size' - Size of the completely downloaded file. - */ - public function downloadMissingGeoIpDb() - { - $this->dieIfGeolocationAdminIsDisabled(); - Piwik::checkUserHasSuperUserAccess(); - if ($_SERVER["REQUEST_METHOD"] == "POST") { - try { - $this->checkTokenInUrl(); - - Json::sendHeaderJSON(); - - // based on the database type (provided by the 'key' query param) determine the - // url & output file name - $key = Common::getRequestVar('key', null, 'string'); - - if ($this->isGeoIp2Enabled()) { - $url = GeoIP2AutoUpdater::getConfiguredUrl($key); - $filename = GeoIP2AutoUpdater::getZippedFilenameToDownloadTo($url, $key, GeoIP2AutoUpdater::getGeoIPUrlExtension($url)); - $outputPath = GeoIp2::getPathForGeoIpDatabase($filename); - } else { - $url = GeoIPAutoUpdater::getConfiguredUrl($key); - $ext = GeoIPAutoUpdater::getGeoIPUrlExtension($url); - $filename = GeoIp::$dbNames[$key][0] . '.' . $ext; - - if (substr($filename, 0, 15) == 'GeoLiteCity.dat') { - $filename = 'GeoIPCity.dat' . substr($filename, 15); - } - $outputPath = GeoIp::getPathForGeoIpDatabase($filename); - } - - // download part of the file - $result = Http::downloadChunk( - $url, $outputPath, Common::getRequestVar('continue', true, 'int')); - - // if the file is done - if ($result['current_size'] >= $result['expected_file_size']) { - if ($this->isGeoIp2Enabled()) { - GeoIP2AutoUpdater::unzipDownloadedFile($outputPath, $key, $url, $unlink = true); - } else { - GeoIPAutoUpdater::unzipDownloadedFile($outputPath, $unlink = true); - } - - $info = $this->getNextMissingDbUrlInfo(); - if ($info !== false) { - return json_encode($info); - } - } - - return json_encode($result); - } catch (Exception $ex) { - return json_encode(array('error' => $ex->getMessage())); - } - } - } - - /** * Echo's a pretty formatted location using a specific LocationProvider. * * Input: @@ -402,6 +82,9 @@ class Controller extends \Piwik\Plugin\ControllerAdmin */ public function getLocationUsingProvider() { + $this->dieIfGeolocationAdminIsDisabled(); + Piwik::checkUserHasSuperUserAccess(); + $providerId = Common::getRequestVar('id'); $provider = LocationProvider::getProviderById($providerId); if (empty($provider)) { @@ -429,63 +112,10 @@ class Controller extends \Piwik\Plugin\ControllerAdmin return $this->renderView($view); } - /** - * Gets information for the first missing GeoIP database (if any). - * - * @return array|bool - */ - private function getNextMissingDbUrlInfo() - { - if ($this->isGeoIp2Enabled()) { - return $this->getNextMissingDbUrlInfoGeoIp2(); - } - - $missingDbs = GeoIPAutoUpdater::getMissingDatabases(); - if (!empty($missingDbs)) { - $missingDbKey = $missingDbs[0]; - $url = GeoIPAutoUpdater::getConfiguredUrl($missingDbKey); - - $link = '<a href="' . $url . '">' . $url . '</a>'; - - return array( - 'to_download' => $missingDbKey, - 'to_download_label' => Piwik::translate('UserCountry_DownloadingDb', $link) . '...', - ); - } - return false; - } - - /** - * Gets information for the first missing GeoIP2 database (if any). - * - * @return array|bool - */ - private function getNextMissingDbUrlInfoGeoIp2() - { - $missingDbs = GeoIP2AutoUpdater::getMissingDatabases(); - if (!empty($missingDbs)) { - $missingDbKey = $missingDbs[0]; - $url = GeoIP2AutoUpdater::getConfiguredUrl($missingDbKey); - - $link = '<a href="' . $url . '">' . $url . '</a>'; - - return array( - 'to_download' => $missingDbKey, - 'to_download_label' => Piwik::translate('UserCountry_DownloadingDb', $link) . '...', - ); - } - return false; - } - private function dieIfGeolocationAdminIsDisabled() { if (!UserCountry::isGeoLocationAdminEnabled()) { throw new \Exception('Geo location setting page has been disabled.'); } } - - private function isGeoIp2Enabled() - { - return Manager::getInstance()->isPluginActivated('GeoIp2'); - } } |