MailgunEventRepository::getEventCount() - Code Metrics - Inspection of "Command for checking if ip is in blacklist" - azine/AzineMailgunWebhooksBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#30)

unknown

created 2017-11-21 00:45 UTC

MailgunEventRepository::getEventCount() A

↳ Parent: MailgunEventRepository

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	6
ccs	0
cts	3
cp	0
rs	9.4285
cc	1
eloc	3
nc	1
nop	1
crap	2

<?php

namespace Azine\MailgunWebhooksBundle\Entity\Repositories;

use Azine\MailgunWebhooksBundle\Entity\MailgunEvent;
use Doctrine\ORM\QueryBuilder;
use Doctrine\ORM\EntityRepository;

/**
 * MailgunEventRepository
 *
 * This class was generated by the Doctrine ORM. Add your own custom
 * repository methods below.
 */
class MailgunEventRepository extends EntityRepository
{
    public function getEventCount($criteria)
    {
        $result = $this->getEventsQuery($criteria)->getQuery()->execute();

        return sizeof($result);
    }

    public function getEvents($criteria, $orderBy, $limit, $offset)
    {
        $qb = $this->getEventsQuery($criteria);
        $orderField = key($orderBy);
        $orderDirection = $orderBy[$orderField];
        $qb->orderBy("e.".$orderField, $orderDirection);
        if ($limit != -1) {
            $qb->setMaxResults($limit);
            $qb->setFirstResult($offset);
        }

        $result = $qb->getQuery()->execute();

        return $result;
    }

    /**
     * @param  array        $criteria
     * @return QueryBuilder
     */
    private function getEventsQuery($criteria)
    {
        $lookForUnopened = array_key_exists("eventType", $criteria) && $criteria["eventType"] == "unopened";
        if ($lookForUnopened) {
            unset($criteria["eventType"]);
        }

        $qb = $this->createQueryBuilder("e");
        if (array_key_exists('domain', $criteria) && $criteria['domain'] != "") {
            $qb->andWhere("e.domain = :domain")
                ->setParameter("domain", $criteria['domain']);
        }

        if (array_key_exists('recipient', $criteria) && $criteria['recipient'] != "") {
            $qb->andWhere("e.recipient like :recipient")
                ->setParameter("recipient", "%".$criteria['recipient']."%");
        }

        if (array_key_exists('eventType', $criteria) && $criteria['eventType'] != "all") {
            $qb->andWhere("e.event = :eventType")
                ->setParameter("eventType", $criteria['eventType']);
        }

        if (array_key_exists('search', $criteria) && $criteria['search'] != "") {
            $qb->andWhere("(e.messageHeaders like :search OR e.description like :search OR e.notification like :search OR e.reason like :search OR e.errorCode like :search OR e.ip like :search OR e.error like :search OR e.country like :search OR e.city like :search OR e.campaignId like :search OR e.campaignName like :search OR e.clientName like :search OR e.clientOs like :search OR e.clientType like :search OR e.deviceType like :search OR e.mailingList like :search OR e.messageId like :search OR e.tag like :search OR e.userAgent like :search OR e.url like :search)")
                ->setParameter("search", "%".$criteria['search']."%");
        }

        if ($lookForUnopened) {
            $qb->andWhere("NOT EXISTS (SELECT o.id FROM AzineMailgunWebhooksBundle:MailgunEvent o WHERE o.messageId like e.messageId AND o.event in ('opened', 'clicked', 'unsubscribed', 'complained'))");
        }

        return $qb;
    }

    public function getEventTypes()
    {
        $q = $this->getEntityManager()->createQueryBuilder()
            ->select("e.event as event")
            ->from($this->getEntityName(), "e")
            ->distinct()
            ->orderBy('e.event ', 'asc')
            ->getQuery();
        $result = array();
        foreach ($q->execute() as $next) {
            $result[] = $next['event'];
        }

        return $result;
    }

    public function getDomains()
    {
        $q = $this->getEntityManager()->createQueryBuilder()
            ->select("e.domain as domain")
            ->from($this->getEntityName(), "e")
            ->distinct()
            ->orderBy('e.domain ', 'asc')
            ->getQuery();

        $result = array();
        foreach ($q->execute() as $next) {
            $result[] = $next['domain'];
        }

        return $result;
    }

    public function getRecipients()
    {
        $q = $this->getEntityManager()->createQueryBuilder()
            ->select("e.recipient as recipient")
            ->from($this->getEntityName(), "e")
            ->distinct()
            ->orderBy('e.recipient ', 'asc')
            ->getQuery();

        $result = array();
        foreach ($q->execute() as $next) {
            $result[] = $next['recipient'];
        }

        return $result;
    }

    /**
     * Get last known sender IP based on stored events list
     * @return string|null
     */
    public function getLastKnownSenderIp()
    {
        $q = $this->getEntityManager()->createQueryBuilder()
            ->select('e.messageHeaders as mh')
            ->from($this->getEntityName(), 'e')
            ->orderBy('e.timestamp', 'desc')
            ->where('e.event IN (:events)')
            ->setParameter('events', array('opened', 'delivered', 'bounced', 'dropped', 'complained'))
            ->setMaxResults(50)
            ->getQuery();
        
        foreach($q->execute() as $next) {
            if ($next['mh']){
                foreach ($next['mh'] as $nextHeader) {
                    if ($nextHeader[0] == 'X-Mailgun-Sending-Ip') {
                        return $nextHeader[1];
                    }
                }
            }
        }
        return null;
    }

    public function getFieldsToOrderBy()
    {
        return array(
                'campaignId',
                'campaignName',
                'city',
                'clientName',
                'clientOs',
                'clientType',
                'country',
                'description',
                'deviceType',
                'domain',
                'error',
                'errorCode',
                'event',
                'ip',
                'mailingList',
                'messageHeaders',
                'messageId',
                'notification',
                'reason',
                'recipient',
                'region',
                'tag',
                'timestamp',
                'type',
                'userAgent',
                'url',
            );
    }

    /**
     * Get the most important events in the following priority
     * 1. Errors (rejected, failed)
     * 2. Warnings (complained, unsubscribed)
     * 3. Infos (accepted, delivered, opened, clicked, stored)
     *
     * @param integer $count max number of events to fetch
     */
    public function getImportantEvents($count)
    {
        $errors = $this->getEventsBySeverity(MailgunEvent::SEVERITY_ERROR, $count);
        $results = $errors;

        $getMoreCounter = $count - sizeof($errors);

        if ($getMoreCounter > 0) {

            $warnings = $this->getEventsBySeverity(MailgunEvent::SEVERITY_WARN, $count);
            $getMoreCounter = $getMoreCounter - sizeof($warnings);
            $results = array_merge($results, $warnings);
        }

        if ($getMoreCounter > 0) {

            $infos = $this->getEventsBySeverity(MailgunEvent::SEVERITY_INFO, $count);
            $results = array_merge($results, $infos);

        }

        return $results;
    }

    /**
     * Get events by severity/type
     * @param  string   $severity [info, warning, error]
     * @return Ambigous <multitype:, unknown>
     */
    public function getEventsBySeverity($severity = MailgunEvent::SEVERITY_INFO, $maxResults = 0)
    {
        if ($severity == MailgunEvent::SEVERITY_INFO) {
            $criteria = "e.event = 'accepted' or e.event = 'delivered' or e.event = 'opened' or e.event = 'clicked' or e.event = 'stored'";

        } elseif ($severity == MailgunEvent::SEVERITY_WARN) {
            $criteria = "e.event = 'complained' or e.event = 'unsubscribed'";

        } elseif ($severity == MailgunEvent::SEVERITY_ERROR) {
            $criteria = "e.event = 'rejected' or e.event = 'failed' or e.event = 'dropped' or e.event = 'bounced'";

        } else {
            return null;
        }

        $qb = $this->createQueryBuilder("e")
            ->where($criteria)
            ->orderBy('e.timestamp ', 'desc');

        if ($maxResults > 0) {
            $qb->setMaxResults($maxResults);
        }

        $q = $qb->getQuery();
        $results = $q->execute();

        return $results;
    }

    /**
     * Get last MailgunEvent
     *
     * @return MailgunEvent
     */
    public function getLastEvent()
    {
        $q = $this->getEntityManager()->createQueryBuilder()
            ->setMaxResults( 1 )
            ->select('e')
            ->from($this->getEntityName(), "e")
            ->orderBy('e.timestamp ', 'desc');

        try {

            return $q->getQuery()->getSingleResult();
        }
        catch(\Doctrine\ORM\NoResultException $e) {

            return null;
        }
    }
}


1		<?php
2
3		namespace Azine\MailgunWebhooksBundle\Entity\Repositories;
4
5		use Azine\MailgunWebhooksBundle\Entity\MailgunEvent;
6		use Doctrine\ORM\QueryBuilder;
7		use Doctrine\ORM\EntityRepository;
8
9		/**
10		* MailgunEventRepository
11		*
12		* This class was generated by the Doctrine ORM. Add your own custom
13		* repository methods below.
14		*/
15		class MailgunEventRepository extends EntityRepository
16		{
17		public function getEventCount($criteria)
18		{
19		$result = $this->getEventsQuery($criteria)->getQuery()->execute();
20
21		return sizeof($result);
22		}
23
24		public function getEvents($criteria, $orderBy, $limit, $offset)
25		{
26		$qb = $this->getEventsQuery($criteria);
27		$orderField = key($orderBy);
28		$orderDirection = $orderBy[$orderField];
29		$qb->orderBy("e.".$orderField, $orderDirection);
30		if ($limit != -1) {
31		$qb->setMaxResults($limit);
32		$qb->setFirstResult($offset);
33		}
34
35		$result = $qb->getQuery()->execute();
36
37		return $result;
38		}
39
40		/**
41		* @param array $criteria
42		* @return QueryBuilder
43		*/
44		private function getEventsQuery($criteria)
45		{
46		$lookForUnopened = array_key_exists("eventType", $criteria) && $criteria["eventType"] == "unopened";
47		if ($lookForUnopened) {
48		unset($criteria["eventType"]);
49		}
50
51		$qb = $this->createQueryBuilder("e");
52		if (array_key_exists('domain', $criteria) && $criteria['domain'] != "") {
53		$qb->andWhere("e.domain = :domain")
54		->setParameter("domain", $criteria['domain']);
55		}
56
57	View Code Duplication	if (array_key_exists('recipient', $criteria) && $criteria['recipient'] != "") {
58		$qb->andWhere("e.recipient like :recipient")
59		->setParameter("recipient", "%".$criteria['recipient']."%");
60		}
61
62		if (array_key_exists('eventType', $criteria) && $criteria['eventType'] != "all") {
63		$qb->andWhere("e.event = :eventType")
64		->setParameter("eventType", $criteria['eventType']);
65		}
66
67	View Code Duplication	if (array_key_exists('search', $criteria) && $criteria['search'] != "") {
68		$qb->andWhere("(e.messageHeaders like :search OR e.description like :search OR e.notification like :search OR e.reason like :search OR e.errorCode like :search OR e.ip like :search OR e.error like :search OR e.country like :search OR e.city like :search OR e.campaignId like :search OR e.campaignName like :search OR e.clientName like :search OR e.clientOs like :search OR e.clientType like :search OR e.deviceType like :search OR e.mailingList like :search OR e.messageId like :search OR e.tag like :search OR e.userAgent like :search OR e.url like :search)")
69		->setParameter("search", "%".$criteria['search']."%");
70		}
71
72		if ($lookForUnopened) {
73		$qb->andWhere("NOT EXISTS (SELECT o.id FROM AzineMailgunWebhooksBundle:MailgunEvent o WHERE o.messageId like e.messageId AND o.event in ('opened', 'clicked', 'unsubscribed', 'complained'))");
74		}
75
76		return $qb;
77		}
78
79	View Code Duplication	public function getEventTypes()
80		{
81		$q = $this->getEntityManager()->createQueryBuilder()
82		->select("e.event as event")
83		->from($this->getEntityName(), "e")
84		->distinct()
85		->orderBy('e.event ', 'asc')
86		->getQuery();
87		$result = array();
88		foreach ($q->execute() as $next) {
89		$result[] = $next['event'];
90		}
91
92		return $result;
93		}
94
95	View Code Duplication	public function getDomains()
96		{
97		$q = $this->getEntityManager()->createQueryBuilder()
98		->select("e.domain as domain")
99		->from($this->getEntityName(), "e")
100		->distinct()
101		->orderBy('e.domain ', 'asc')
102		->getQuery();
103
104		$result = array();
105		foreach ($q->execute() as $next) {
106		$result[] = $next['domain'];
107		}
108
109		return $result;
110		}
111
112	View Code Duplication	public function getRecipients()
113		{
114		$q = $this->getEntityManager()->createQueryBuilder()
115		->select("e.recipient as recipient")
116		->from($this->getEntityName(), "e")
117		->distinct()
118		->orderBy('e.recipient ', 'asc')
119		->getQuery();
120
121		$result = array();
122		foreach ($q->execute() as $next) {
123		$result[] = $next['recipient'];
124		}
125
126		return $result;
127		}
128
129		/**
130		* Get last known sender IP based on stored events list
131		* @return string\|null
132		*/
133		public function getLastKnownSenderIp()
134		{
135		$q = $this->getEntityManager()->createQueryBuilder()
136		->select('e.messageHeaders as mh')
137		->from($this->getEntityName(), 'e')
138		->orderBy('e.timestamp', 'desc')
139		->where('e.event IN (:events)')
140		->setParameter('events', array('opened', 'delivered', 'bounced', 'dropped', 'complained'))
141		->setMaxResults(50)
142		->getQuery();
143
144		foreach($q->execute() as $next) {
145		if ($next['mh']){
146		foreach ($next['mh'] as $nextHeader) {
147		if ($nextHeader[0] == 'X-Mailgun-Sending-Ip') {
148		return $nextHeader[1];
149		}
150		}
151		}
152		}
153		return null;
154		}
155
156		public function getFieldsToOrderBy()
157		{
158		return array(
159		'campaignId',
160		'campaignName',
161		'city',
162		'clientName',
163		'clientOs',
164		'clientType',
165		'country',
166		'description',
167		'deviceType',
168		'domain',
169		'error',
170		'errorCode',
171		'event',
172		'ip',
173		'mailingList',
174		'messageHeaders',
175		'messageId',
176		'notification',
177		'reason',
178		'recipient',
179		'region',
180		'tag',
181		'timestamp',
182		'type',
183		'userAgent',
184		'url',
185		);
186		}
187
188		/**
189		* Get the most important events in the following priority
190		* 1. Errors (rejected, failed)
191		* 2. Warnings (complained, unsubscribed)
192		* 3. Infos (accepted, delivered, opened, clicked, stored)
193		*
194		* @param integer $count max number of events to fetch
195		*/
196		public function getImportantEvents($count)
197		{
198		$errors = $this->getEventsBySeverity(MailgunEvent::SEVERITY_ERROR, $count);
199		$results = $errors;
200
201		$getMoreCounter = $count - sizeof($errors);
202
203		if ($getMoreCounter > 0) {
204
205		$warnings = $this->getEventsBySeverity(MailgunEvent::SEVERITY_WARN, $count);
206		$getMoreCounter = $getMoreCounter - sizeof($warnings);
207		$results = array_merge($results, $warnings);
208		}
209
210		if ($getMoreCounter > 0) {
211
212		$infos = $this->getEventsBySeverity(MailgunEvent::SEVERITY_INFO, $count);
213		$results = array_merge($results, $infos);
214
215		}
216
217		return $results;
218		}
219
220		/**
221		* Get events by severity/type
222		* @param string $severity [info, warning, error]
223		* @return Ambigous <multitype:, unknown>
224		*/
225		public function getEventsBySeverity($severity = MailgunEvent::SEVERITY_INFO, $maxResults = 0)
226		{
227		if ($severity == MailgunEvent::SEVERITY_INFO) {
228		$criteria = "e.event = 'accepted' or e.event = 'delivered' or e.event = 'opened' or e.event = 'clicked' or e.event = 'stored'";
229
230		} elseif ($severity == MailgunEvent::SEVERITY_WARN) {
231		$criteria = "e.event = 'complained' or e.event = 'unsubscribed'";
232
233		} elseif ($severity == MailgunEvent::SEVERITY_ERROR) {
234		$criteria = "e.event = 'rejected' or e.event = 'failed' or e.event = 'dropped' or e.event = 'bounced'";
235
236		} else {
237		return null;
238		}
239
240		$qb = $this->createQueryBuilder("e")
241		->where($criteria)
242		->orderBy('e.timestamp ', 'desc');
243
244		if ($maxResults > 0) {
245		$qb->setMaxResults($maxResults);
246		}
247
248		$q = $qb->getQuery();
249		$results = $q->execute();
250
251		return $results;
252		}
253
254		/**
255		* Get last MailgunEvent
256		*
257		* @return MailgunEvent
258		*/
259		public function getLastEvent()
260		{
261		$q = $this->getEntityManager()->createQueryBuilder()
262		->setMaxResults( 1 )
263		->select('e')
264		->from($this->getEntityName(), "e")
265		->orderBy('e.timestamp ', 'desc');
266
267		try {
268
269		return $q->getQuery()->getSingleResult();
270		}
271		catch(\Doctrine\ORM\NoResultException $e) {
272
273		return null;
274		}
275		}
276		}
277

azine / AzineMailgunWebhooksBundle

Pull Request — master (#30)

MailgunEventRepository::getEventCount() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like