<?php
/**
 * Matomo - free/libre analytics platform
 *
 * @link https://matomo.org
 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
 *
 */

namespace Piwik\Plugins\WordPress;

use Exception;
use Piwik\Access;
use Piwik\API\Request;
use Piwik\Common;
use Piwik\Config;
use Piwik\Container\StaticContainer;
use Piwik\FrontController;
use Piwik\Option;
use Piwik\Piwik;
use Piwik\Plugin;
use Piwik\Plugin\Manager;
use Piwik\Plugins\CoreHome\SystemSummary\Item;
use Piwik\Plugins\WordPress\Html\PluginUrlReplacer;
use Piwik\Plugins\WordPress\Overrides\ProfessionalServices\PromoCustomizer;
use Piwik\Plugins\WordPress\Workaround\ProcessedReportForceShortDateFormat;
use Piwik\Plugins\WordPress\Workaround\ProcessedReportInnerCallHooks;
use Piwik\Scheduler\Task;
use Piwik\Url;
use Piwik\Version;
use Piwik\Widget\WidgetsList;
use WpMatomo;
use WpMatomo\Bootstrap;
use WpMatomo\Settings;
use WpOrg\Requests\Utility\CaseInsensitiveDictionary;

if (!defined( 'ABSPATH')) {
    exit; // if accessed directly
}

// undo the error_reporting(E_ALL) in app/core/bootstrap.php
// since we're not running Matomo in isolation, we don't want to
// override the user's configured error_reporting value, which
// may be set to hide errors from other WordPress plugins
if (isset($GLOBALS['MATOMO_WP_ORIGINAL_ERROR_REPORTING'])) {
    error_reporting($GLOBALS['MATOMO_WP_ORIGINAL_ERROR_REPORTING']);
}

class WordPress extends Plugin
{
	public static $is_archiving = false;

    /**
     * @see \Piwik\Plugin::registerEvents
     */
    public function registerEvents()
    {
        return array(
            'API.UsersManager.createAppSpecificTokenAuth' => 'disableApiIfNotBootstrapped',
            'Request.dispatch' => 'onDispatchRequest',
            'Request.dispatch.end' => 'onDispatchRequestEnd',
            'User.isNotAuthorized' => array('before' => true, 'function' => 'noAccess'),
            'Http.sendHttpRequest' => 'onSendHttpRequestBy',
            'Widget.filterWidgets' => 'filterWidgets',
            'System.filterSystemSummaryItems' => 'filterSystemSummaryItems',
            'CliMulti.supportsAsync' => 'supportsAsync',
            'Template.header' => 'onHeader',
            'AssetManager.makeNewAssetManagerObject' => 'makeNewAssetManagerObject',
            'ScheduledTasks.shouldExecuteTask' => 'shouldExecuteTask',
            'SitesManager.shouldPerformEmptySiteCheck' => 'shouldPerformEmptySiteCheck',
            'API.TagManager.getContainerInstallInstructions.end' => 'addInstallInstructions',
            'API.Tour.getChallenges.end' => 'modifyTourChallenges',
	          'API.ScheduledReports.generateReport.end' => 'onGenerateReportEnd',
            'API.CorePluginsAdmin.getSystemSettings.end' => 'onGetSystemSettingsEnd',
            'API.SitesManager.updateSite' => 'allowUpdateSiteForMeasurableSettings',
            'API.SitesManager.updateSite.end' => 'reDisableSitesAdmin',
            'Translate.getClientSideTranslationKeys' => 'getClientSideTranslationKeys',
            'CustomJsTracker.manipulateJsTracker' => 'updateHeatmapTrackerPath',
            'Visualization.beforeRender' => 'onBeforeRenderView',
            'AssetManager.getStylesheetFiles'  => 'getStylesheetFiles',
            'Controller.CorePluginsAdmin.safemode.end' => 'modifySafemodeHtml',
            'Tracker.setTrackerCacheGeneral' => ['function' => 'setTrackerCacheGeneral', 'after' => true],
            'Platform.initialized' => ['function' => 'onPlatformInitialized', 'before' => true],
            'Template.jsGlobalVariables' => 'addJsGlobalVariables',
            'API.Request.dispatch' => 'onApiRequestDispatch',
            'API.Request.dispatch.end' => 'onApiRequestDispatchEnd',
            'UsersManager.deleteUser' => 'onDeleteMatomoUser',
            ProcessedReportInnerCallHooks::PROCESSED_REPORT_INNER_END_EVENT => 'afterProcessedReportInner',
        );
    }

    /**
     * Delete login mappings when a Matomo user is deleted.
     *
     * @param string $userLogin
     */
    public function onDeleteMatomoUser($userLogin)
    {
        ( new WpMatomo\User() )->delete_mappings_for_matomo_login($userLogin);
    }

    public function shouldPerformEmptySiteCheck( &$shouldPerformEmptySiteCheck ) {
        $shouldPerformEmptySiteCheck = false;
    }

    public function onApiRequestDispatch(&$finalParameters, $pluginName, $methodName) {
        StaticContainer::get(ProcessedReportInnerCallHooks::class)->onDispatchStart($finalParameters, $pluginName, $methodName);
    }

    public function onApiRequestDispatchEnd(&$returnedValue, $extraInfo) {
        StaticContainer::get(ProcessedReportInnerCallHooks::class)->onDispatchEnd($returnedValue, $extraInfo);
    }

    public function afterProcessedReportInner(&$returnedValue, $extraInfo) {
        StaticContainer::get(ProcessedReportForceShortDateFormat::class)->replacePeriodsUsingCustomDateFormatIfRequested($returnedValue);
    }

    public function addJsGlobalVariables(&$output) {
        $output .= 'piwik.mwpHomeUrl = ' . json_encode(\home_url()) . ";\n";

        $settings = WpMatomo::$settings ?: new Settings();
        $isAiBotTrackingEnabledInMwp = $settings->is_ai_bot_tracking_enabled();
        $output .= 'piwik.isAiBotTrackingEnabledInMwp = ' . json_encode($isAiBotTrackingEnabledInMwp) . ";\n";
    }

    public function onPlatformInitialized()
    {
        // set language to WordPress locale
        if (is_admin()) {
            $languageCookieName = Config::getInstance()->General['language_cookie_name'];

            $locale = get_user_locale();
            $_COOKIE[$languageCookieName] = WpMatomo\User\Sync::get_matomo_lang_from_locale($locale);
        }
    }

    public function setTrackerCacheGeneral(&$cache)
    {
        $settings = WpMatomo::$settings ?: new Settings();
        Access::doAsSuperUser(function () use(&$cache, $settings) { // see SitesManager::setTrackerCacheGeneral
            $cache['global_excluded_user_agents'] = $settings->get_global_user_agent_exclusions();
        });
    }

    public function allowUpdateSiteForMeasurableSettings($finalParameters)
    {
        $filteredParameters = array_filter($finalParameters);
        if (count($filteredParameters) === 2
            && !empty($filteredParameters['settingValues'])
            && !empty($filteredParameters['idSite'])
        ) {
            Config::getInstance()->General['enable_sites_admin'] = true;
        }
    }

    public function reDisableSitesAdmin()
    {
        Config::getInstance()->General['enable_sites_admin'] = false;
    }

    public function modifySafemodeHtml(&$output)
    {
        // add iframeResizer.contentWindow.min.js so it will resize correctly when in an iframe
        $scriptUrl = plugins_url( 'assets/js/iframeResizer.contentWindow.min.js', MATOMO_ANALYTICS_FILE );
        $output = str_replace(
            '<title>',
            "<script src=\"$scriptUrl\" defer></script><title>",
            $output
        );

        // replace core version with MWP version so as to not confuse users
        $mwpInfo = get_plugin_data(MATOMO_ANALYTICS_FILE) ?: [];
        $mwpVersion = $mwpInfo['Version'] ?? null;
        if (!empty($mwpVersion)) {
            $output = str_replace('(v' . Version::VERSION . ')', '(v' . $mwpVersion . ')', $output);
        }
    }

    public function onBeforeRenderView(Plugin\ViewDataTable $view)
    {
    	if ($view->requestConfig->getApiModuleToRequest() === 'UserCountry' && $view->config->show_footer_message && strpos($view->config->show_footer_message, 'href') !== false) {
    		// dont suggest setting up geoip
    		$view->config->show_footer_message = '';
	    }
    }

    public function updateHeatmapTrackerPath(&$content)
    {
	    $webRootDirs = Manager::getInstance()->getWebRootDirectoriesForCustomPluginDirs();
	    if (!empty($webRootDirs['HeatmapSessionRecording'])) {
		    $baseUrl = trim($webRootDirs['HeatmapSessionRecording'], '/') . '/HeatmapSessionRecording/configs.php';
    	    $content = str_replace('plugins/HeatmapSessionRecording/configs.php', $baseUrl, $content);
	    }
    }

	public function getClientSideTranslationKeys(&$translationKeys)
	{
		$translationKeys[] = 'Feedback_SearchOnMatomo';
        $translationKeys[] = 'WordPress_UseShortCode';
        $translationKeys[] = 'WordPress_UseShortCodeDesc1';
        $translationKeys[] = 'WordPress_UseShortCodeDesc2';
        $translationKeys[] = 'WordPress_UseShortCodeOptionLanguage';
        $translationKeys[] = 'WordPress_Example';
        $translationKeys[] = 'WordPress_SaveChanges';
        $translationKeys[] = 'WordPress_NoMeasurableSettingsAvailable';
        $translationKeys[] = 'General_Confirm'; // this is not loaded client side by default for some reason
        $translationKeys[] = 'WordPress_AIBotTrackingIsNotEnabled';
	}

    public function modifyTourChallenges(&$challenges)
    {
    	foreach ($challenges as $index => $challenge) {
    		if ($challenge['id'] === 'track_data') {
    			$challenges[$index]['url'] = ''; // we can't generate menu url for tracking settings since we're not showing the menu
    			$challenges[$index]['description'] = __('In WordPress Admin go to Matomo Analytics => Settings => Tracking to embed the tracking code.', 'matomo');
		    } elseif ($challenge['id'] === 'custom_logo') {
				unset($challenges[$index]);
		    }
	    }
    }

    public function addInstallInstructions(&$instructions)
    {
	    $instructions[] = array(
		    'description' => __('Alternatively, simply go to "Tracking Settings" in your WordPress Admin and select "Tag Manager" as tracking mode or choose "Manually" and paste the above code into the tracking code field.', 'matomo'),
		    'embedCode' => '',
		    'helpUrl' => ''
	    );
    }

	/**
	 * @param $shouldExecuteTask
	 * @param Task $task
	 */
	public function shouldExecuteTask(&$shouldExecuteTask, $task)
	{
		if ($shouldExecuteTask && $task) {
			$blockedMethods = array(
				'updateSpammerBlacklist',
				'updateSpammerList',
				'updateSearchEngines',
				'updateSocials',
				'Piwik\Plugins\Referrers\Tasks.update', // just in case any of the tasks was renamed...
				'Piwik\Plugins\CoreAdminHome\Tasks.update' // just in case any of the tasks was renamed...
			);

			// don't ping github... we update these through new releases
			if (in_array($task->getMethodName(), $blockedMethods)) {
				$shouldExecuteTask = false;
				return;
			}

			$taskName = $task->getName();

			foreach ($blockedMethods as $blockedMethod) {
				if (stripos($taskName, $blockedMethod) !== false) {
					// just in case for some reason wasn't matched above
					$shouldExecuteTask = false;
					return;
				}
			}
		}
	}

    public function makeNewAssetManagerObject(&$assetManager)
    {
	    $assetManager = new WpAssetManager();
    }

    public function supportsAsync(&$supportsAsync)
    {
        if (is_multisite()
            || !empty($_SERVER['MATOMO_WP_ROOT_PATH'])
            || !matomo_has_compatible_content_dir()
            || WpMatomo::is_async_archiving_manually_disabled()
        ) {
            // console wouldn't really work in multi site mode... therefore we prefer to archive in the same request
            // WP_DEBUG also breaks things since it's logging things to stdout and then safe unserialise doesn't work
            // disabling it also when server environment variable is set as it's likely only set in web requests through web server
            // but not on the CLI
            $supportsAsync = false;
        }
    }

    public function onHeader(&$out)
    {
        $out .= '<style type="text/css">#header_message {display:none !important; }</style>';
    }

    /**
     * @param Item[] $systemSummaryItems
     */
    public function filterSystemSummaryItems(&$systemSummaryItems)
    {
        $blockedItems = array(
            'php-version', 'mysql-version', 'plugins', 'trackingfailures',
            'websites', 'users', 'piwik-version', 'matomo-version'
        );

        foreach ($systemSummaryItems as $index => $item) {
            if ($item && in_array($item->getKey(), $blockedItems, true)) {
                $systemSummaryItems[$index] = null;
            }
        }
    }

    public function filterWidgets(WidgetsList $list)
    {
        // it's fine if they are being viewed we just don't want to show them in the admin so much to keep things simple
        $list->remove('About Matomo', 'Installation_SystemCheck');
        $list->remove('About Matomo', 'CoreAdminHome_TrackingFailures');
        $list->remove('About Matomo', 'CoreHome_SystemSummaryWidget');
        $list->remove('About Matomo', 'CoreHome_QuickLinks');
        $list->remove('About Matomo', 'ProfessionalServices_WidgetPremiumServicesForPiwik');
    }

    public function isTrackerPlugin() {
        return true;
    }

    public function onSendHttpRequestBy($url, $params, &$response, &$status, &$headers)
    {
    	if (strpos($url, 'https://raw.github') === 0) {
    		// we don't want to ping github from wordpress since we're not disclosing connections to github in readme
		    // and/or UI. We could eventually allow this by adding an option into the UI and notifying users there
		    // that we send requests to github... We would then also allow the tasks in `shouldExecuteTask` method.
    		$status = 403;
		    $response = '';
    		return;
	    }

        if ((strpos($url, 'module=API&method=API.get') !== false
             && strpos($url, '&trigger=archivephp') !== false
             && Url::isValidHost(parse_url($url, PHP_URL_HOST)))
            ||
            (strpos($url, 'module=API&method=CoreAdminHome.archiveReports') !== false
             && strpos($url, '&trigger=archivephp') !== false
             && Url::isValidHost(parse_url($url, PHP_URL_HOST)))
        ) {
            // archiving query... we avoid issueing an http request for many reasons...
            // eg user might be using self signed certificate and request fails
            // eg http requests may not be allowed
            // eg because the WP user wouldn't be logged in the auth wouldn't work
            // etc.

            \Piwik\Access::doAsSuperUser(function () use ($url, &$response) {
            	WordPress::$is_archiving = true;
            	// refs #118 because there is no actual user when archiving there is also no token etc
                $urlQuery = parse_url($url, PHP_URL_QUERY);
                $request = new Request($urlQuery, array('serialize' => 1));
                $response = $request->process();
	            WordPress::$is_archiving = false;
            });
            $status = 200;
            return;
        }

        $headers = $params['headers'];
        $rawHeaders = array();
        foreach ($headers as $header) {
            if (!empty($header) && strpos($header, ':') !== false) {
                $parts = explode(':', $header);
                $rawHeaders[trim($parts[0])] = trim($parts[1]);
            }
        }
        $args = array(
            'method'              => $params['httpMethod'],
            'timeout'             => $params['timeout'],
            'headers'             => $rawHeaders,
            'body'                => $params['body'],
            'sslverify'           => true,
        );
        if (defined( 'MATOMO_LOCAL_ENVIRONMENT' ) && MATOMO_LOCAL_ENVIRONMENT) {
            $args['timeout'] = max($args['timeout'], 8);
        }
        if (!empty($params['userAgent'])) {
            $args['user-agent'] = $params['userAgent'];
        }
        if (!empty($params['destinationPath'])) {
            $args['filename'] = $params['destinationPath'];
            $args['stream'] = true;
        }
	    if (isset($params['verifySsl']) && !$params['verifySsl']) {
		    // by default we want to reuse WP default value unless someone specifically disabled it for Matomo
		    $args['sslverify'] = false;
	    }
        $wpResponse = wp_remote_request($url, $args);

        if (is_object($wpResponse) && is_wp_error($wpResponse)) {
            throw new Exception("Error while fetching data: " . $wpResponse->get_error_message());
        }

        $status = wp_remote_retrieve_response_code($wpResponse);
        $headers = wp_remote_retrieve_headers($wpResponse);
        if ($headers instanceof CaseInsensitiveDictionary) {
            $headers = $headers->getAll();
        }
        $response = wp_remote_retrieve_body($wpResponse);
    }

    public function onGenerateReportEnd()
    {
    	if (Request::isCurrentApiRequestTheRootApiRequest() && !headers_sent()) {
    		// fix https://github.com/matomo-org/matomo-for-wordpress/issues/98
		    // When some plugin does an ob_start before the API is being executed then the following happens:
		    // * PDF is generated and sent
		    // * We send the application/pdf content-type header
		    // * The api call finishes
		    // * The response builder sends text/xml header and because the headers haven't been send yet, this actually overwrites the application/pdf header
		    // * An XML error is shown in the UI.
		    // The workaround is basically to make sure to flush the API call between API call finished and the response builder trying to send the text/xml header
		    // It seems mostly an issue for the Scheduled Reports renderer as this is basically using an API call, it is basically using the XML renderer, but sending a different content type
		    if (ob_get_length()) {
			    ob_end_flush();
		    }
	    }
    }

    public function onGetSystemSettingsEnd(&$settings)
    {
        // users are synced from wordpress, so we don't display matomo user settings anywhere
        $settings = array_filter($settings, function ($pluginSettings) {
            return $pluginSettings['pluginName'] !== 'UsersManager';
        });
    }

    public function onDispatchRequestEnd(&$result, $module, $action, $parameters)
    {
    	if (!empty($result) && is_string($result)) {
    		// https://wordpress.org/support/topic/bugged-favicon/#post-12995669
    		$result = str_replace('<link rel="mask-icon"', '<link rel="ignore-mask-icon-ignore"', $result);
    		$result = str_replace('plugins/CoreHome/images/applePinnedTab.svg', '', $result);

            $pluginUrlReplacer = new PluginUrlReplacer();
            $result = $pluginUrlReplacer->replaceThirdPartyPluginUrls( $result );

            if ($module === 'ProfessionalServices') {
                $promoCustomizer = new PromoCustomizer();
                $result = $promoCustomizer->customizePromoHtml($result);
            }
        }
    }

    public function onDispatchRequest(&$module, &$action, &$parameters)
    {
        if ($module === 'Proxy' && in_array($action, array('getNonCoreJs', 'getCoreJs', 'getCss'))) {
            remove_action( 'shutdown', 'wp_ob_end_flush_all', 1 );
        } else {
	        if (function_exists('ini_get') && @ini_get('zlib.output_compression') === '1') {
		        remove_action( 'shutdown', 'wp_ob_end_flush_all', 1 );
	        }
        }

        $requestedModule = !empty($module) ? Common::mb_strtolower($module) : '';
        $requestedAction = !empty($action) ? Common::mb_strtolower($action) : '';

        $isAppPasswordUsed = !empty($_SERVER['PHP_AUTH_USER']);
        if (!WordPress::$is_archiving
            && !Common::isPhpCliMode()
            && $requestedModule === 'api'
            && (empty($requestedAction) || $requestedAction === 'index')
            && !$isAppPasswordUsed
        ) {
            $tokenRequest = Common::getRequestVar('token_auth', false, 'string');
            $tokenUser = Piwik::getCurrentUserTokenAuth();

            if (!$tokenRequest) {
                throw new Exception(Piwik::translate('Wordpress_TokenAuthMissing'));
            }

            if ($tokenRequest !== $tokenUser) {
                throw new Exception(Piwik::translate('Wordpress_ExceptionInvalidToken'));
            }
        }

        if (strtolower($requestedModule) === 'login') {
            if ($action === 'ajaxNoAccess' || $action === 'bruteForceLog') {
                return; // allowed
            }
	        throw new Exception( 'This feature '.$requestedModule. ' / ' .$requestedAction .' is not available' );
        }

        if (($requestedModule === 'corepluginsadmin' && $action !== 'safemode')
            || $requestedModule === 'installation'
            || $requestedModule === 'coreupdater') {
	        throw new Exception( 'This feature '.$requestedModule. ' / ' .$requestedAction .' is not available' );
        }

        $blockedActions = array(
            array('coreadminhome', 'trackingcodegenerator'),
            array('usersmanager', 'index'),
            array('usersmanager', ''),
            array('usersmanager', 'addnewtoken'),
            array('usersmanager', 'deletetoken'),
            array('usersmanager', 'usersecurity'),
	        array('sitesmanager', ''),
            array('sitesmanager', 'globalsettings'),
            array('feedback', ''),
            array('feedback', 'index'),
            array('diagnostics', 'configfile'),
            array('api', 'listallapi'),
        );

        foreach ($blockedActions as $blockedAction) {
            if ($requestedModule === $blockedAction[0] && $requestedAction == $blockedAction[1]) {
	            throw new Exception( 'This feature '.$requestedModule. ' / ' .$requestedAction .' is not available' );
            }
        }

        if ($requestedModule === 'sitesmanager' && $requestedAction === 'sitewithoutdata') {
            // we don't want the no data message to appear as it contains integration instructions which aren't needed
            // and links to not existing sites
            $module = 'CoreHome';
            $action = 'index';
        }
    }

    public static function getWpLoginUrl()
    {
    	$forceFrontPage = defined('MATOMO_LOGIN_REDIRECT') && MATOMO_LOGIN_REDIRECT === 'frontpage';
    	$forceLoginUrl = defined('MATOMO_LOGIN_REDIRECT') && MATOMO_LOGIN_REDIRECT === 'login';

	    if (!$forceLoginUrl &&
	        ($forceFrontPage
	            || is_plugin_active('wps-hide-login/wps-hide-login.php'))) {
		    $redirect_url = home_url();
	    } else {
		    $redirect_url = wp_login_url(\WpMatomo\Admin\Menu::get_reporting_url());
	    }

	    return $redirect_url;
    }

    public function noAccess(Exception $exception)
    {
        if (Common::isXmlHttpRequest()) {
            // copied code from Login.ajaxNoAccess to avoid infinite recursion caused by User.isNotAuthorized event
            $errorMessage = $exception->getMessage();
            echo sprintf(
                '<div class="alert alert-danger">
                    <p><strong>%s:</strong> %s</p>
                    <p><a href="%s">%s</a></p>
                </div>',
                Piwik::translate('General_Error'),
                htmlentities($errorMessage, Common::HTML_ENCODING_QUOTE_STYLE, 'UTF-8', $doubleEncode = \false),
                'index.php?module=' . Piwik::getLoginPluginName(),
                Piwik::translate('Login_LogIn')
            );
            exit; // exit required to avoid infinite recursion
        }

	    $redirect_url = WordPress::getWpLoginUrl();
	    wp_safe_redirect($redirect_url);
        exit;
    }

    public function disableApiIfNotBootstrapped()
    {
        if (!Bootstrap::is_bootstrapped()) {
            throw new \Exception('This feature is not available');
        }
    }

    public function throwNotAvailableException()
    {
        throw new \Exception('This feature is not available');
    }

    public function getStylesheetFiles(&$files)
    {
        $files[] = "../plugins/WordPress/stylesheets/user.css";
        $files[] = "../plugins/WordPress/stylesheets/optout.css";
        $files[] = "../plugins/WordPress/stylesheets/export.css";
        $files[] = "../plugins/WordPress/stylesheets/blogselection.css";
        $files[] = "../plugins/WordPress/vue/src/PluginMeasurableSettings/PluginMeasurableSettings.less";
        $files[] = "../plugins/WordPress/stylesheets/overrides.css";
    }
}
