MailgunEventRepository::getLastKnownSenderIp() - Code Metrics - Inspection of "Implemented Mailgun-Cockpit with a set of useful l..." - azine/AzineMailgunWebhooksBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#6)

unknown

created 2017-07-25 13:34 UTC

MailgunEventRepository::getLastKnownSenderIp() A

↳ Parent: MailgunEventRepository

Complexity

Conditions	2
Paths	2

Size

Total Lines	11
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	11
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	8
nc	2
nop	0

<?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.ip as ip')
            ->from($this->getEntityName(), 'e')
            ->orderBy('e.timestamp', 'desc')
            ->setMaxResults(1)
            ->getQuery();
        
        return count($q->getResult()) ? $q->getResult()[0]['ip'] : 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;
    }
}


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.ip as ip')
137		->from($this->getEntityName(), 'e')
138		->orderBy('e.timestamp', 'desc')
139		->setMaxResults(1)
140		->getQuery();
141
142		return count($q->getResult()) ? $q->getResult()[0]['ip'] : null;
143		}
144
145		public function getFieldsToOrderBy()
146		{
147		return array(
148		'campaignId',
149		'campaignName',
150		'city',
151		'clientName',
152		'clientOs',
153		'clientType',
154		'country',
155		'description',
156		'deviceType',
157		'domain',
158		'error',
159		'errorCode',
160		'event',
161		'ip',
162		'mailingList',
163		'messageHeaders',
164		'messageId',
165		'notification',
166		'reason',
167		'recipient',
168		'region',
169		'tag',
170		'timestamp',
171		'type',
172		'userAgent',
173		'url',
174		);
175		}
176
177		/**
178		* Get the most important events in the following priority
179		* 1. Errors (rejected, failed)
180		* 2. Warnings (complained, unsubscribed)
181		* 3. Infos (accepted, delivered, opened, clicked, stored)
182		*
183		* @param integer $count max number of events to fetch
184		*/
185		public function getImportantEvents($count)
186		{
187		$errors = $this->getEventsBySeverity(MailgunEvent::SEVERITY_ERROR, $count);
188		$results = $errors;
189
190		$getMoreCounter = $count - sizeof($errors);
191
192		if ($getMoreCounter > 0) {
193
194		$warnings = $this->getEventsBySeverity(MailgunEvent::SEVERITY_WARN, $count);
195		$getMoreCounter = $getMoreCounter - sizeof($warnings);
196		$results = array_merge($results, $warnings);
197		}
198
199		if ($getMoreCounter > 0) {
200
201		$infos = $this->getEventsBySeverity(MailgunEvent::SEVERITY_INFO, $count);
202		$results = array_merge($results, $infos);
203
204		}
205
206		return $results;
207		}
208
209		/**
210		* Get events by severity/type
211		* @param string $severity [info, warning, error]
212		* @return Ambigous <multitype:, unknown>
213		*/
214		public function getEventsBySeverity($severity = MailgunEvent::SEVERITY_INFO, $maxResults = 0)
215		{
216		if ($severity == MailgunEvent::SEVERITY_INFO) {
217		$criteria = "e.event = 'accepted' or e.event = 'delivered' or e.event = 'opened' or e.event = 'clicked' or e.event = 'stored'";
218
219		} elseif ($severity == MailgunEvent::SEVERITY_WARN) {
220		$criteria = "e.event = 'complained' or e.event = 'unsubscribed'";
221
222		} elseif ($severity == MailgunEvent::SEVERITY_ERROR) {
223		$criteria = "e.event = 'rejected' or e.event = 'failed' or e.event = 'dropped' or e.event = 'bounced'";
224
225		} else {
226		return null;
227		}
228
229		$qb = $this->createQueryBuilder("e")
230		->where($criteria)
231		->orderBy('e.timestamp ', 'desc');
232
233		if ($maxResults > 0) {
234		$qb->setMaxResults($maxResults);
235		}
236
237		$q = $qb->getQuery();
238		$results = $q->execute();
239
240		return $results;
241		}
242		}
243

azine / AzineMailgunWebhooksBundle

Pull Request — master (#6)

MailgunEventRepository::getLastKnownSenderIp() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like