File API/src/Middleware/AnalyticsMiddleware.php | BEdita API doc

  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153

<?php
/**
 * BEdita, API-first content management framework
 * Copyright 2017 ChannelWeb Srl, Chialab Srl
 *
 * This file is part of BEdita: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * See LICENSE.LGPL or <http://gnu.org/licenses/lgpl-3.0.html> for more details.
 */
namespace BEdita\API\Middleware;

use BEdita\Core\State\CurrentApplication;
use BEdita\Core\Utility\LoggedUser;
use Cake\Event\EventDispatcherTrait;
use Cake\Log\Log;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;

/**
 * Middleware to trace analytics data
 *
 * @since 4.0.0
 */
class AnalyticsMiddleware
{
    use EventDispatcherTrait;

    /**
     * Request start time
     *
     * @var float
     */
    protected $startTime = null;

    /**
     * Analytics data
     *
     * @var array
     */
    protected $data = [];

    /**
     * Configure analytics logger if not configured yet
     */
    public function __construct()
    {
        $this->startTime = microtime(true);
        if (defined('TIME_START')) {
            $this->startTime = TIME_START;
        }

        if (!in_array('analytics', Log::configured())) {
            Log::setConfig('analytics', [
                'className' => 'File',
                'path' => LOGS,
                'scopes' => ['analytics'],
                'file' => 'analytics',
            ]);
        }
    }

    /**
     * Getter for $startTime
     *
     * @return float
     * @codeCoverageIgnore
     */
    public function getStartTime()
    {
        return $this->startTime;
    }

    /**
     * Getter for $data
     *
     * @return array
     * @codeCoverageIgnore
     */
    public function getData()
    {
        return $this->data;
    }

    /**
     * Get analytics custom data from event listeners
     *
     * @param \Psr\Http\Message\ServerRequestInterface $request The request.
     * @param \Psr\Http\Message\ResponseInterface $response The response.
     * @return array
     */
    protected function readCustomData(ServerRequestInterface $request, ResponseInterface $response)
    {
        $event = $this->dispatchEvent('Analytics.custom', [$request, $response]);
        if (empty($event->getResult())) {
            return [];
        }

        return (array)$event->getResult();
    }

    /**
     * Read custom error code
     *
     * @param \Psr\Http\Message\ResponseInterface $response The response.
     * @return string|null
     */
    public function getAppErrorCode(ResponseInterface $response)
    {
        if ($response->getStatusCode() < 400) {
            return null;
        }
        $body = json_decode($response->getBody(), true);
        if (empty($body['error']['code'])) {
            return null;
        }

        return $body['error']['code'];
    }

    /**
     * The middleware action.
     *
     * @param \Psr\Http\Message\ServerRequestInterface $request The request.
     * @param \Psr\Http\Message\ResponseInterface $response The response.
     * @param callable $next The next middleware to call.
     * @return \Psr\Http\Message\ResponseInterface A response.
     */
    public function __invoke(ServerRequestInterface $request, ResponseInterface $response, callable $next)
    {
        $response = $next($request, $response);

        $this->data = [
            'r' => $request->getEnv('REQUEST_TIME'),
            'a' => CurrentApplication::getApplicationId(),
            'usr' => LoggedUser::id(),
            'm' => $request->getMethod(),
            'url' => $request->getUri()->getPath(),
            'q' => $request->getUri()->getQuery(),
            's' => $response->getStatusCode(),
            'c' => $this->getAppErrorCode($response),
            'x' => $this->readCustomData($request, $response),
        ];
        $this->data['e'] = round(microtime(true) - $this->startTime, 4, PHP_ROUND_HALF_EVEN);

        Log::info(json_encode($this->data), 'analytics');

        return $response;
    }
}

Namespaces

Classes