MongoDbProfilerStorage::parseDsn() - Code Metrics - Inspection of "Code Styling" - Sitetheory/ProfilerStorageBundle - Measure and Improve Code Quality continuously with Scrutinizer

Test Setup Failed

Push — master ( 2c3741...78c16b )

by Alex

created 2018-07-03 22:20 UTC

MongoDbProfilerStorage::parseDsn() A

↳ Parent: MongoDbProfilerStorage

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
nc	2
nop	1
dl	0
loc	19
rs	9.6333
c	0
b	0
f	0

<?php

/*
 * This file is part of the Symfony package.
 *
 * (c) Fabien Potencier <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Sitetheory\Bundle\ProfilerStorageBundle\Profiler;

use Symfony\Component\HttpKernel\Profiler\Profile;

/**
 * MongoDbProfilerStorage stores profiling information in a Mongo database.
 *
 * Class MongoDbProfilerStorage
 *
 * @author Fabien Potencier <[email protected]>
 * @author Alex Gurrola <[email protected]>
 */
class MongoDbProfilerStorage implements ProfilerStorageInterface
{
    /**
     * @var string
     */
    protected $dsn;

    /**
     * @var int
     */
    protected $lifetime;

    /**
     * @var \MongoDB\Collection
     */
    private $mongo;

    /**
     * Constructor.
     *
     * @param string $dsn      A data source name
     * @param string $username Not used
     * @param string $password Not used
     * @param int    $lifetime The lifetime to use for the purge
     */
    public function __construct($dsn, $username = '', $password = '', $lifetime = 86400)
    {
        $this->dsn = $dsn;
        $this->lifetime = (int) $lifetime;
    }

    /**
     * {@inheritdoc}
     */
    public function find($ip, $url, $limit, $method, $start = null, $end = null, $statusCode = null)
    {
        $cursor = $this->getMongo()->find(
            $this->buildQuery($ip, $url, $method, $start, $end, $statusCode),
            array('data' => 0, 'sort' => array('time' => -1), 'limit' => intval($limit))
        );

        $tokens = array();
        foreach ($cursor as $profile) {
            $tokens[] = $this->getData($profile);
        }

        return $tokens;
    }

    /**
     * {@inheritdoc}
     */
    public function purge()
    {
        return $this->getMongo()->deleteMany(array());
    }

    /**
     * {@inheritdoc}
     */
    public function read($token)
    {
        $profile = $this->getMongo()->findOne(array('_id' => $token, 'data' => array('$exists' => true)));

        if (null !== $profile) {
            $profile = $this->createProfileFromData($this->getData($profile));
        }

        return $profile;
    }

    /**
     * {@inheritdoc}
     */
    public function write(Profile $profile)
    {
        $this->cleanup();

        $record = array(
            '_id' => $profile->getToken(),
            'parent' => $profile->getParentToken(),
            'data' => base64_encode(serialize($profile->getCollectors())),
            'ip' => $profile->getIp(),
            'method' => $profile->getMethod(),
            'url' => $profile->getUrl(),
            'time' => $profile->getTime(),
            'status_code' => $profile->getStatusCode(),
        );

        $result = $this->getMongo()->updateOne(array('_id' => $profile->getToken()), array(
            '$set' => array_filter($record, function ($v) {
                return !empty($v);
            }),
        ), array('upsert' => true));

        return $result->isAcknowledged();
    }

    /**
     * Internal convenience method that returns the instance of the MongoDB Collection.
     *
     * @return \MongoDB\Collection
     */
    protected function getMongo()
    {
        if (null !== $this->mongo) {
            return $this->mongo;
        }

        if (!$parsedDsn = $this->parseDsn($this->dsn)) {
            throw new \RuntimeException(sprintf('Please check your configuration. You are trying to use MongoDB with an invalid dsn "%s". The expected format is "mongodb://[user:pass@]host/database/collection"', $this->dsn));
        }

        list($server, $database, $collection) = $parsedDsn;

        $client = new \MongoDB\Client('mongodb://'.$server.'/'.$database);

        return $this->mongo = $client->selectCollection($database, $collection);
    }

    /**
     * @param array $data
     *
     * @return Profile
     */
    protected function createProfileFromData(array $data)
    {
        $profile = $this->getProfile($data);

        if ($data['parent']) {
            $parent = $this->getMongo()->findOne(array('_id' => $data['parent'], 'data' => array('$exists' => true)));
            if ($parent) {
                $profile->setParent($this->getProfile($this->getData($parent)));
            }
        }

        $profile->setChildren($this->readChildren($data['token']));

        return $profile;
    }

    /**
     * @param string $token
     *
     * @return Profile[] An array of Profile instances
     */
    protected function readChildren($token)
    {
        $profiles = array();

        $cursor = $this->getMongo()->find(array('parent' => $token, 'data' => array('$exists' => true)));
        foreach ($cursor as $d) {
            $profiles[] = $this->getProfile($this->getData($d));
        }

        return $profiles;
    }

    protected function cleanup()
    {
        $this->getMongo()->deleteMany(array('time' => array('$lt' => time() - $this->lifetime)));
    }

    /**
     * @param string $ip
     * @param string $url
     * @param string $method
     * @param int    $start
     * @param int    $end
     * @param int    $statusCode
     *
     * @return array
     */
    private function buildQuery($ip, $url, $method, $start, $end, $statusCode)
    {
        $query = array();

        if (!empty($ip)) {
            $query['ip'] = $ip;
        }

        if (!empty($url)) {
            $query['url'] = $url;
        }

        if (!empty($method)) {
            $query['method'] = $method;
        }

        if (!empty($start) || !empty($end)) {
            $query['time'] = array();
        }

        if (!empty($start)) {
            $query['time']['$gte'] = $start;
        }

        if (!empty($end)) {
            $query['time']['$lte'] = $end;
        }

        if (!empty($statusCode)) {
            $query['status_code'] = $statusCode;
        }

        return $query;
    }

    /**
     * @param $data
     *
     * @return array
     */
    private function getData($data)
    {
        $data = $data instanceof \MongoDB\Model\BSONDocument ? $data->getArrayCopy() : $data;
        if (!is_array($data)) {
            throw new \InvalidArgumentException('$data is not a valid BSONDocument or array.');
        }

        return array(
            'token' => $data['_id'],
            'parent' => isset($data['parent']) ? $data['parent'] : null,
            'ip' => isset($data['ip']) ? $data['ip'] : null,
            'method' => isset($data['method']) ? $data['method'] : null,
            'url' => isset($data['url']) ? $data['url'] : null,
            'time' => isset($data['time']) ? $data['time'] : null,
            'data' => isset($data['data']) ? $data['data'] : null,
            'status_code' => isset($data['status_code']) ? $data['status_code'] : null,
        );
    }

    /**
     * @param array $data
     *
     * @return Profile
     */
    private function getProfile(array $data)
    {
        $profile = new Profile($data['token']);
        $profile->setIp($data['ip']);
        $profile->setMethod($data['method']);
        $profile->setUrl($data['url']);
        $profile->setTime($data['time']);
        $profile->setCollectors(unserialize(base64_decode($data['data'])));

        return $profile;
    }

    /**
     * @param string $dsn
     *
     * @return null|array Array($server, $database, $collection)
     */
    private function parseDsn($dsn)
    {
        if (!preg_match('#^mongodb://(.*)/(.*)/(.*)$#', $dsn, $matches)) {
            return;
        }

        $server = $matches[1];
        $database = $matches[2];
        $collection = $matches[3];

        /* FIXME: This adds backwards compatibility but cannot function for modern implementations *
        preg_match('#^mongodb://(([^:]+):?(.*)(?=@))?@?([^/]*)(.*)$#', $server, $matchesServer);

        if ('' == $matchesServer[5] && '' != $matches[2]) {
            $server .= '/'.$matches[2];
        }
        /* */

        return array($server, $database, $collection);
    }
}


1			<?php
2
3			/*
4			* This file is part of the Symfony package.
5			*
6			* (c) Fabien Potencier <[email protected]>
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace Sitetheory\Bundle\ProfilerStorageBundle\Profiler;
13
14			use Symfony\Component\HttpKernel\Profiler\Profile;
15
16			/**
17			* MongoDbProfilerStorage stores profiling information in a Mongo database.
18			*
19			* Class MongoDbProfilerStorage
20			*
21			* @author Fabien Potencier <[email protected]>
22			* @author Alex Gurrola <[email protected]>
23			*/
24			class MongoDbProfilerStorage implements ProfilerStorageInterface
25			{
26			/**
27			* @var string
28			*/
29			protected $dsn;
30
31			/**
32			* @var int
33			*/
34			protected $lifetime;
35
36			/**
37			* @var \MongoDB\Collection
38			*/
39			private $mongo;
40
41			/**
42			* Constructor.
43			*
44			* @param string $dsn A data source name
45			* @param string $username Not used
46			* @param string $password Not used
47			* @param int $lifetime The lifetime to use for the purge
48			*/
49			public function __construct($dsn, $username = '', $password = '', $lifetime = 86400)
50			{
51			$this->dsn = $dsn;
52			$this->lifetime = (int) $lifetime;
53			}
54
55			/**
56			* {@inheritdoc}
57			*/
58			public function find($ip, $url, $limit, $method, $start = null, $end = null, $statusCode = null)
59			{
60			$cursor = $this->getMongo()->find(
61			$this->buildQuery($ip, $url, $method, $start, $end, $statusCode),
62			array('data' => 0, 'sort' => array('time' => -1), 'limit' => intval($limit))
63			);
64
65			$tokens = array();
66			foreach ($cursor as $profile) {
67			$tokens[] = $this->getData($profile);
68			}
69
70			return $tokens;
71			}
72
73			/**
74			* {@inheritdoc}
75			*/
76			public function purge()
77			{
78			return $this->getMongo()->deleteMany(array());
79			}
80
81			/**
82			* {@inheritdoc}
83			*/
84			public function read($token)
85			{
86			$profile = $this->getMongo()->findOne(array('_id' => $token, 'data' => array('$exists' => true)));
87
88			if (null !== $profile) {
89			$profile = $this->createProfileFromData($this->getData($profile));
90			}
91
92			return $profile;
93			}
94
95			/**
96			* {@inheritdoc}
97			*/
98			public function write(Profile $profile)
99			{
100			$this->cleanup();
101
102			$record = array(
103			'_id' => $profile->getToken(),
104			'parent' => $profile->getParentToken(),
105			'data' => base64_encode(serialize($profile->getCollectors())),
106			'ip' => $profile->getIp(),
107			'method' => $profile->getMethod(),
108			'url' => $profile->getUrl(),
109			'time' => $profile->getTime(),
110			'status_code' => $profile->getStatusCode(),
111			);
112
113			$result = $this->getMongo()->updateOne(array('_id' => $profile->getToken()), array(
114			'$set' => array_filter($record, function ($v) {
115			return !empty($v);
116			}),
117			), array('upsert' => true));
118
119			return $result->isAcknowledged();
120			}
121
122			/**
123			* Internal convenience method that returns the instance of the MongoDB Collection.
124			*
125			* @return \MongoDB\Collection
126			*/
127			protected function getMongo()
128			{
129			if (null !== $this->mongo) {
130			return $this->mongo;
131			}
132
133			if (!$parsedDsn = $this->parseDsn($this->dsn)) {
134			throw new \RuntimeException(sprintf('Please check your configuration. You are trying to use MongoDB with an invalid dsn "%s". The expected format is "mongodb://[user:pass@]host/database/collection"', $this->dsn));
135			}
136
137			list($server, $database, $collection) = $parsedDsn;
138
139			$client = new \MongoDB\Client('mongodb://'.$server.'/'.$database);
140
141			return $this->mongo = $client->selectCollection($database, $collection);
142			}
143
144			/**
145			* @param array $data
146			*
147			* @return Profile
148			*/
149			protected function createProfileFromData(array $data)
150			{
151			$profile = $this->getProfile($data);
152
153			if ($data['parent']) {
154			$parent = $this->getMongo()->findOne(array('_id' => $data['parent'], 'data' => array('$exists' => true)));
155			if ($parent) {
156			$profile->setParent($this->getProfile($this->getData($parent)));
157			}
158			}
159
160			$profile->setChildren($this->readChildren($data['token']));
161
162			return $profile;
163			}
164
165			/**
166			* @param string $token
167			*
168			* @return Profile[] An array of Profile instances
169			*/
170			protected function readChildren($token)
171			{
172			$profiles = array();
173
174			$cursor = $this->getMongo()->find(array('parent' => $token, 'data' => array('$exists' => true)));
175			foreach ($cursor as $d) {
176			$profiles[] = $this->getProfile($this->getData($d));
177			}
178
179			return $profiles;
180			}
181
182			protected function cleanup()
183			{
184			$this->getMongo()->deleteMany(array('time' => array('$lt' => time() - $this->lifetime)));
185			}
186
187			/**
188			* @param string $ip
189			* @param string $url
190			* @param string $method
191			* @param int $start
192			* @param int $end
193			* @param int $statusCode
194			*
195			* @return array
196			*/
197			private function buildQuery($ip, $url, $method, $start, $end, $statusCode)
198			{
199			$query = array();
200
201			if (!empty($ip)) {
202			$query['ip'] = $ip;
203			}
204
205			if (!empty($url)) {
206			$query['url'] = $url;
207			}
208
209			if (!empty($method)) {
210			$query['method'] = $method;
211			}
212
213			if (!empty($start) \|\| !empty($end)) {
214			$query['time'] = array();
215			}
216
217			if (!empty($start)) {
218			$query['time']['$gte'] = $start;
219			}
220
221			if (!empty($end)) {
222			$query['time']['$lte'] = $end;
223			}
224
225			if (!empty($statusCode)) {
226			$query['status_code'] = $statusCode;
227			}
228
229			return $query;
230			}
231
232			/**
233			* @param $data
234			*
235			* @return array
236			*/
237			private function getData($data)
238			{
239			$data = $data instanceof \MongoDB\Model\BSONDocument ? $data->getArrayCopy() : $data;
240			if (!is_array($data)) {
241			throw new \InvalidArgumentException('$data is not a valid BSONDocument or array.');
242			}
243
244			return array(
245			'token' => $data['_id'],
246			'parent' => isset($data['parent']) ? $data['parent'] : null,
247			'ip' => isset($data['ip']) ? $data['ip'] : null,
248			'method' => isset($data['method']) ? $data['method'] : null,
249			'url' => isset($data['url']) ? $data['url'] : null,
250			'time' => isset($data['time']) ? $data['time'] : null,
251			'data' => isset($data['data']) ? $data['data'] : null,
252			'status_code' => isset($data['status_code']) ? $data['status_code'] : null,
253			);
254			}
255
256			/**
257			* @param array $data
258			*
259			* @return Profile
260			*/
261			private function getProfile(array $data)
262			{
263			$profile = new Profile($data['token']);
264			$profile->setIp($data['ip']);
265			$profile->setMethod($data['method']);
266			$profile->setUrl($data['url']);
267			$profile->setTime($data['time']);
268			$profile->setCollectors(unserialize(base64_decode($data['data'])));
269
270			return $profile;
271			}
272
273			/**
274			* @param string $dsn
275			*
276			* @return null\|array Array($server, $database, $collection)
277			*/
278			private function parseDsn($dsn)
279			{
280			if (!preg_match('#^mongodb://(.)/(.)/(.*)$#', $dsn, $matches)) {
281			return;
282			}
283
284			$server = $matches[1];
285			$database = $matches[2];
286			$collection = $matches[3];
287
288			/* FIXME: This adds backwards compatibility but cannot function for modern implementations *
289			preg_match('#^mongodb://(([^:]+):?(.)(?=@))?@?([^/])(.*)$#', $server, $matchesServer);
290
291			if ('' == $matchesServer[5] && '' != $matches[2]) {
292			$server .= '/'.$matches[2];
293			}
294			/* */
295
296			return array($server, $database, $collection);
297			}
298			}
299

Sitetheory / ProfilerStorageBundle

Push — master ( 2c3741...78c16b )

MongoDbProfilerStorage::parseDsn() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like