nystudio107\webperf\controllers\MetricsController

Complexity

Total Complexity

21

Size/Duplication

Total Lines	97
Duplicated Lines	0 %

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
F	actionBeacon()	0	73	21

<?php
/**
 * Webperf plugin for Craft CMS 3.x
 *
 * Monitor the performance of your webpages through real-world user timing data
 *
 * @link      https://nystudio107.com

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c) 2018 nystudio107

@copyright tag must contain a year and the name of the copyright holder

 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

Missing @license tag in file comment

namespace {

    require_once __DIR__ . '/../lib/geoiploc.php';

File is being conditionally included; use "include_once" instead

}

namespace nystudio107\webperf\controllers {

    use nystudio107\webperf\helpers\MultiSite;
    use nystudio107\webperf\Webperf;
    use nystudio107\webperf\models\DataSample;

    use Jaybizzle\CrawlerDetect\CrawlerDetect;

The type Jaybizzle\CrawlerDetect\CrawlerDetect was not found. Maybe you did not declare it correctly or list all dependencies?

    use WhichBrowser\Parser;

The type WhichBrowser\Parser was not found. Maybe you did not declare it correctly or list all dependencies?

    use Craft;

The type Craft was not found. Maybe you did not declare it correctly or list all dependencies?

    use craft\errors\SiteNotFoundException;

The type craft\errors\SiteNotFoundException was not found. Maybe you did not declare it correctly or list all dependencies?

    use craft\web\Controller;

The type craft\web\Controller was not found. Maybe you did not declare it correctly or list all dependencies?

    use yii\base\InvalidConfigException;

The type yii\base\InvalidConfigException was not found. Maybe you did not declare it correctly or list all dependencies?

    /**

Missing short description in doc comment

     * @author    nystudio107

The tag in position 1 should be the @package tag

Content of the @author tag must be in the form "Display Name <username@example.com>"

Tag value indented incorrectly; expected 2 spaces but found 4

     * @package   Webperf

Tag value indented incorrectly; expected 1 spaces but found 3

     * @since     1.0.0

The tag in position 3 should be the @author tag

Tag value indented incorrectly; expected 3 spaces but found 5

     */

Missing @category tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

    class MetricsController extends Controller
    {
        // Public Properties
        // =========================================================================

        public $enableCsrfValidation = false;

        // Protected Properties
        // =========================================================================

        /**

Missing short description in doc comment

         * @var    bool|array Allows anonymous access to this controller's actions.
         *         The actions must be in 'kebab-case'
         * @access protected
         */
        protected $allowAnonymous = ['beacon'];


        // Public Methods
        // =========================================================================

        /**

Missing short description in doc comment

         * @return mixed
         */
        public function actionBeacon()
        {
            // Get the incoming params from the beacon
            try {
                $params = Craft::$app->getRequest()->getBodyParams();
            } catch (InvalidConfigException $e) {
                $params = [];
            }
            // Ensure the beacon has at least the URL parameter
            if (empty($params) || empty($params['u'])) {
                return;
            }
            // Filter out bot/spam requests via UserAgent
            if (Webperf::$settings->filterBotUserAgents) {
                $crawlerDetect = new CrawlerDetect;
                // Check the user agent of the current 'visitor'
                if ($crawlerDetect->isCrawler()) {
                    return;
                }
            }
            // Allocate a new DataSample, and fill it in
            $sample = new DataSample();
            $sample->url = $params['u'];
            // Get the site id
            try {
                $site = MultiSite::getSiteFromUrl($sample->url);
                $sample->siteId = $site->id;
            } catch (SiteNotFoundException $e) {
                $sample->siteId = null;
            }
            // Fill in all of the timing information that's available
            $sample->pageLoad = $params['t_done'] ?? null;
            if (!empty($params['nt_dns_end']) && !empty($params['nt_dns_st'])) {
                $sample->dns = $params['nt_dns_end'] - $params['nt_dns_st'];
            }
            if (!empty($params['nt_con_end']) && !empty($params['nt_con_st'])) {
                $sample->connect = $params['nt_con_end'] - $params['nt_con_st'];
            }
            if (!empty($params['t_resp'])) {
                $sample->firstByte = $params['t_resp'];
            }
            if (!empty($params['pt_fp'])) {
                $sample->firstPaint = $params['pt_fp'];
            }
            if (!empty($params['pt_fcp'])) {
                $sample->firstContentfulPaint = $params['pt_fcp'];
            }
            if (!empty($params['nt_domint']) && !empty($params['nt_nav_st'])) {
                $sample->domInteractive = $params['nt_domint'] - $params['nt_nav_st'];
            }
            if (!empty($params['nt_domcomp']) && !empty($params['nt_nav_st'])) {
                $sample->pageLoad = $params['nt_domcomp'] - $params['nt_nav_st'];
            }
            // Fill in information from the current request
            $request = Craft::$app->getRequest();
            $ip = $request->userIP;
            if ($ip) {
                $sample->countryCode = getCountryFromIP($ip);

The function getCountryFromIP was not found. Maybe you did not declare it correctly or list all dependencies?

                // getCountryFromIP returns 'ZZ' for unknown countries, map to '??'
                if ($sample->countryCode === 'ZZ') {
                    $sample->countryCode = '??';
                }
            }
            $userAgent = $request->userAgent;
            if ($userAgent) {
                $parser = new Parser($userAgent);
                $sample->browser = $parser->browser->name;
                $sample->os = $parser->os->name;
                $sample->mobile = $parser->isMobile();
            }
            // Save the data sample
            Craft::debug('Saving DataSample: '.print_r($sample, true), __METHOD__);
            Webperf::$plugin->dataSamples->addDataSample($sample);
        }
    }
}