dukt / analytics

src/controllers/SettingsController.php

<?php
/**
 * @link      https://dukt.net/analytics/
 * @copyright Copyright (c) 2022, Dukt
 * @license   https://github.com/dukt/analytics/blob/master/LICENSE.md
 */

namespace dukt\analytics\controllers;

use Craft;
use craft\errors\InvalidPluginException;
use craft\web\Controller;
use dukt\analytics\models\SiteView;
use dukt\analytics\models\View;
use dukt\analytics\web\assets\settings\SettingsAsset;
use dukt\analytics\Plugin as Analytics;
use Exception;
use Google_Service_Exception;
use League\OAuth2\Client\Provider\Exception\IdentityProviderException;
use yii\web\NotFoundHttpException;
use yii\web\Response;

class SettingsController extends Controller
{
    // Public Methods
    // =========================================================================

    /**
     * Index.
     *
     * @return Response
     * @throws \yii\base\InvalidConfigException
     */
    public function actionIndex(): Response
    {
        $isOauthProviderConfigured = Analytics::$plugin->getAnalytics()->isOauthProviderConfigured();

        if ($isOauthProviderConfigured) {
            $errors = [];

            try {
                $provider = Analytics::$plugin->oauth->getOauthProvider();
                $token = Analytics::$plugin->oauth->getToken();

                if ($token) {
                    $oauthAccount = Analytics::$plugin->cache->get(['getAccount', $token]);

                    if (!$oauthAccount) {
                        $oauthAccount = $provider->getResourceOwner($token);
                        Analytics::$plugin->cache->set(['getAccount', $token], $oauthAccount);
                    }

                    if ($oauthAccount) {
                        Craft::info("Account:\r\n".print_r($oauthAccount, true), __METHOD__);

Are you sure print_r($oauthAccount, true) of type string|true can be used in concatenation?

                        $plugin = Craft::$app->getPlugins()->getPlugin('analytics');
                        $settings = $plugin->getSettings();
                    }
                }
            } catch (Google_Service_Exception $e) {
                Craft::info('Couldn’t get OAuth account: '.$e->getMessage(), __METHOD__);

                foreach ($e->getErrors() as $error) {
                    $errors[] = $error['message'];
                }
            } catch (IdentityProviderException $e) {
                $error = $e->getMessage();
                $data = $e->getResponseBody();

                if (isset($data['error_description'])) {
                    $error = $data['error_description'];
                }

                $errors[] = $error;
            } catch (Exception $e) {
                if (method_exists($e, 'getResponse')) {
                    Craft::info('Couldn’t get OAuth account: '.$e->getResponse(), __METHOD__);
                } else {
                    Craft::info('Couldn’t get OAuth account: '.$e->getMessage(), __METHOD__);
                }

                $errors[] = $e->getMessage();
            }
        }

        Craft::$app->getView()->registerAssetBundle(SettingsAsset::class);

        return $this->renderTemplate('analytics/settings/_index', [
            'isOauthProviderConfigured' => $isOauthProviderConfigured,
            'errors' => $errors ?? null,
            'oauthAccount' => $oauthAccount ?? null,
            'settings' => $settings ?? null,
            'info' => Analytics::getInstance()->getInfo(),
            'googleIconUrl' => Craft::$app->assetManager->getPublishedUrl('@dukt/analytics/icons/google.svg', true),

The call to yii\web\AssetManager::getPublishedUrl() has too many arguments starting with true.

        ]);
    }

    /**
     * OAuth Settings.
     *
     * @return Response
     * @throws \craft\errors\SiteNotFoundException
     */
    public function actionOauth(): Response
    {
        return $this->renderTemplate('analytics/settings/_oauth', [
            'javascriptOrigin' => Analytics::$plugin->oauth->getJavascriptOrigin(),
            'redirectUri' => Analytics::$plugin->oauth->getRedirectUri(),
            'googleIconUrl' => Craft::$app->assetManager->getPublishedUrl('@dukt/analytics/icons/google.svg', true),

The call to yii\web\AssetManager::getPublishedUrl() has too many arguments starting with true.

            'settings' => Analytics::$plugin->getSettings(),
        ]);
    }

    /**
     * Saves the settings.
     *
     * @return null|Response
     * @throws InvalidPluginException
     * @throws \yii\base\InvalidConfigException
     * @throws \yii\web\BadRequestHttpException
     */
    public function actionSaveSettings()
    {
        $this->requirePostRequest();

        $pluginHandle = Craft::$app->getRequest()->getRequiredBodyParam('pluginHandle');
        $settings = Craft::$app->getRequest()->getBodyParam('settings');
        $plugin = Craft::$app->getPlugins()->getPlugin($pluginHandle);

        if (!$plugin) {
            throw new InvalidPluginException($pluginHandle);
        }

        $settings = Analytics::$plugin->getApis()->getAnalytics()->populateAccountExplorerSettings($settings);

        if (Craft::$app->getPlugins()->savePluginSettings($plugin, $settings)) {
            Craft::$app->getSession()->setNotice(Craft::t('analytics', 'Plugin settings saved.'));

            return $this->redirectToPostedUrl();
        }

        Craft::$app->getSession()->setError(Craft::t('analytics', 'Couldn’t save plugin settings.'));

        // Send the plugin back to the template
        Craft::$app->getUrlManager()->setRouteParams([
            'plugin' => $plugin
        ]);

        return null;
    }

    /**
     * Returns the account explorer data.
     *
     * @return Response
     * @throws \yii\base\InvalidConfigException
     */
    public function actionGetAccountExplorerData(): Response
    {
        $accountExplorerData = Analytics::$plugin->getApis()->getAnalytics()->getAccountExplorerData();

        Analytics::$plugin->cache->set(['accountExplorerData'], $accountExplorerData);

        return $this->asJson($accountExplorerData);
    }

    /**
     * Views index.
     *
     * @return Response
     * @throws \yii\base\InvalidConfigException
     */
    public function actionViews(): Response
    {
        $isOauthProviderConfigured = Analytics::$plugin->getAnalytics()->isOauthProviderConfigured();

        $variables = [
            'isConnected' => false
        ];

        try {
            $token = Analytics::$plugin->oauth->getToken();

            if ($isOauthProviderConfigured && $token) {
                $variables['isConnected'] = true;
                $variables['reportingViews'] = Analytics::$plugin->getViews()->getViews();
            }
        } catch (IdentityProviderException $e) {
            $variables['error'] = $e->getMessage();

            $data = $e->getResponseBody();

            if (isset($data['error_description'])) {
                $variables['error'] = $data['error_description'];
            }
        }

        return $this->renderTemplate('analytics/settings/views/_index', $variables);
    }

    /**
     * Edit a view.
     *
     * @param int|null  $viewId
     * @param View|null $reportingView
     *
     * @return Response
     * @throws NotFoundHttpException
     * @throws \yii\base\InvalidConfigException
     */
    public function actionEditView(int $viewId = null, View $reportingView = null): Response
    {
        $variables['isNewView'] = false;

$variables was never initialized. Although not strictly required by PHP, it is generally a good practice to add $variables = array(); before regardless.

        if ($viewId !== null) {
            if ($reportingView === null) {
                $reportingView = Analytics::$plugin->getViews()->getViewById($viewId);

                if (!$reportingView) {

$reportingView is of type dukt\analytics\models\View, thus it always evaluated to true.

                    throw new NotFoundHttpException('View not found');
                }
            }

            $variables['title'] = $reportingView->name;
            $variables['reportingView'] = $reportingView;
        } else {
            if ($reportingView === null) {
                $reportingView = new View();
                $variables['isNewView'] = true;
            }
            $variables['title'] = Craft::t('analytics', 'Create a new view');
        }

        $variables['reportingView'] = $reportingView;
        $variables['accountExplorerOptions'] = $this->getAccountExplorerOptions($reportingView);

        Craft::$app->getView()->registerAssetBundle(SettingsAsset::class);

        return $this->renderTemplate('analytics/settings/views/_edit', $variables);
    }

    /**
     * Saves a view.
     *
     * @return null|Response
     * @throws \dukt\analytics\errors\InvalidViewException
     * @throws \yii\base\InvalidConfigException
     * @throws \yii\web\BadRequestHttpException
     */
    public function actionSaveView()
    {
        $this->requirePostRequest();

        $request = Craft::$app->getRequest();
        $accountExplorer = $request->getBodyParam('accountExplorer');

        $reportingView = new View();
        $reportingView->id = $request->getBodyParam('viewId');
        $reportingView->name = $request->getBodyParam('name');
        $reportingView->gaAccountId = $accountExplorer['account'];
        $reportingView->gaPropertyId = $accountExplorer['property'];
        $reportingView->gaViewId = $accountExplorer['view'];

        $accountExplorerData = Analytics::$plugin->getApis()->getAnalytics()->getAccountExplorerData();

        foreach ($accountExplorerData['accounts'] as $dataAccount) {
            if ($dataAccount->id == $reportingView->gaAccountId) {
                $reportingView->gaAccountName = $dataAccount->name;
            }
        }

        foreach ($accountExplorerData['properties'] as $dataProperty) {
            if ($dataProperty->id == $reportingView->gaPropertyId) {
                $reportingView->gaPropertyName = $dataProperty->name;
            }
        }
        foreach ($accountExplorerData['views'] as $dataView) {
            if ($dataView->id == $reportingView->gaViewId) {
                $reportingView->gaViewName = $dataView->name;
                $reportingView->gaViewCurrency = $dataView->currency;
            }
        }

        // Save it
        if (!Analytics::$plugin->getViews()->saveView($reportingView)) {
            Craft::$app->getSession()->setError(Craft::t('analytics', 'Couldn’t save the view.'));

            // Send the view back to the template
            Craft::$app->getUrlManager()->setRouteParams([
                'reportingView' => $reportingView
            ]);

            return null;
        }

        Craft::$app->getSession()->setNotice(Craft::t('analytics', 'View saved.'));

        return $this->redirectToPostedUrl($reportingView);
    }

    /**
     * Deletes a view.
     *
     * @return Response
     * @throws \Throwable
     * @throws \yii\db\StaleObjectException
     * @throws \yii\web\BadRequestHttpException
     */
    public function actionDeleteView(): Response
    {
        $this->requirePostRequest();
        $this->requireAcceptsJson();

        $request = Craft::$app->getRequest();
        $viewId = $request->getRequiredBodyParam('id');

        Analytics::$plugin->getViews()->deleteViewById($viewId);

        return $this->asJson(['success' => true]);
    }

    /**
     * Sites index.
     *
     * @return Response
     * @throws \yii\base\InvalidConfigException
     */
    public function actionSites(): Response
    {
        $isOauthProviderConfigured = Analytics::$plugin->getAnalytics()->isOauthProviderConfigured();

        $variables = [
            'isConnected' => false
        ];

        try {
            $token = Analytics::$plugin->oauth->getToken();

            if ($isOauthProviderConfigured && $token) {
                $variables['isConnected'] = true;
                $variables['sites'] = Craft::$app->getSites()->getAllSites();
                $variables['siteViews'] = Analytics::$plugin->getViews()->getSiteViews();
            }
        } catch (IdentityProviderException $e) {
            $variables['error'] = $e->getMessage();

            $data = $e->getResponseBody();

            if (isset($data['error_description'])) {
                $variables['error'] = $data['error_description'];
            }
        }

        return $this->renderTemplate('analytics/settings/sites/_index', $variables);
    }

    /**
     * Edit a site.
     *
     * @param $siteId
     *
     * @return Response
     * @throws \yii\base\InvalidConfigException
     */
    public function actionEditSite($siteId): Response
    {
        $site = Craft::$app->getSites()->getSiteById($siteId);
        $siteView = Analytics::$plugin->getViews()->getSiteViewBySiteId($siteId);
        $reportingViews = Analytics::$plugin->getViews()->getViews();

        return $this->renderTemplate('analytics/settings/sites/_edit', [
            'site' => $site,
            'siteView' => $siteView,
            'reportingViews' => $reportingViews,
        ]);
    }

    /**
     * Saves a site.
     *
     * @return null|Response
     * @throws \yii\base\InvalidConfigException
     * @throws \yii\db\Exception
     * @throws \yii\web\BadRequestHttpException
     */
    public function actionSaveSite()
    {
        $this->requirePostRequest();

        $request = Craft::$app->getRequest();

        $siteView = new SiteView();
        $siteView->siteId = $request->getBodyParam('siteId');
        $siteView->viewId = $request->getBodyParam('viewId');

        // Save it
        if (!Analytics::$plugin->getViews()->saveSiteView($siteView)) {
            Craft::$app->getSession()->setError(Craft::t('analytics', 'Couldn’t save the site view.'));

            // Send the view back to the template
            Craft::$app->getUrlManager()->setRouteParams([
                'siteView' => $siteView
            ]);

            return null;
        }

        Craft::$app->getSession()->setNotice(Craft::t('analytics', 'Site view saved.'));

        return $this->redirectToPostedUrl($siteView);
    }

    // Private Methods
    // =========================================================================

    /**
     * @param View $reportingView
     *
     * @return array
     */
    private function getAccountExplorerOptions(View $reportingView): array
    {
        $accountExplorerData = Analytics::$plugin->cache->get(['accountExplorerData']);

        return [
            'accounts' => $this->getAccountOptions($accountExplorerData, $reportingView),
            'properties' => $this->getPropertyOptions($accountExplorerData, $reportingView),
            'views' => $this->getViewOptions($accountExplorerData, $reportingView),
        ];
    }

    /**
     * @param      $accountExplorerData
     * @param View $reportingView
     *
     * @return array
     */
    private function getAccountOptions($accountExplorerData, View $reportingView): array
    {
        $accountOptions = [];

        if (isset($accountExplorerData['accounts'])) {
            foreach ($accountExplorerData['accounts'] as $account) {
                $accountOptions[] = ['label' => $account->name, 'value' => $account->id];
            }
        } else {
            $accountOptions[] = ['label' => $reportingView->gaAccountName, 'value' => $reportingView->gaAccountId];
        }

        return $accountOptions;
    }

    /**
     * @param      $accountExplorerData
     * @param View $reportingView
     *
     * @return array
     */
    private function getPropertyOptions($accountExplorerData, View $reportingView): array
    {
        $propertyOptions = [];

        if (isset($accountExplorerData['properties'])) {
            foreach ($accountExplorerData['properties'] as $webProperty) {
                $propertyOptions[] = ['label' => $webProperty->name, 'value' => $webProperty->id];
            }
        } else {
            $propertyOptions[] = ['label' => $reportingView->gaPropertyName, 'value' => $reportingView->gaPropertyId];
        }

        return $propertyOptions;
    }

    /**
     * @param      $accountExplorerData
     * @param View $reportingView
     *
     * @return array
     */
    private function getViewOptions($accountExplorerData, View $reportingView): array
    {
        $viewOptions = [];

        if (isset($accountExplorerData['views'])) {
            foreach ($accountExplorerData['views'] as $dataView) {
                $viewOptions[] = ['label' => $dataView->name, 'value' => $dataView->id];
            }
        } else {
            $viewOptions[] = ['label' => $reportingView->gaViewName, 'value' => $reportingView->gaViewId];
        }

        return $viewOptions;
    }
}