Respondent::isEmailSurveyDuplicate() - Code Metrics - Inspection of "simplify email validation methods" - TonisOrmisson/yii2-survey-base-models - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( bfd5dc...4b301d )

by Tõnis

created 2018-06-04 08:38 UTC

Respondent::isEmailSurveyDuplicate() B

↳ Parent: Respondent

Complexity

Conditions	3
Paths	4

Size

Total Lines	26
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
eloc	15
nc	4
nop	2
dl	0
loc	26
rs	8.8571
c	0
b	0
f	0

<?php

namespace andmemasin\surveybasemodels;

use andmemasin\myabstract\MyActiveRecord;
use PascalDeVink\ShortUuid\ShortUuid;
use Ramsey\Uuid\Uuid;
use yii;

/**
 * This is the model class for a generic Respondent.
 *
 * @property int $respondent_id
 * @property int $survey_id
 * @property string $token
 * @property Survey $survey
 * @property string $email_address
 * @property string $alternative_email_addresses Inserted as CSV, stored as JSON
 * @property string $phone_number
 * @property string $alternative_phone_numbers Inserted as CSV, stored as JSON
 *
 * @property boolean $isRejected
 * @property string $shortToken If the token is uuid, then short-uuid will be returned
 */
class Respondent extends MyActiveRecord
{
    const MAX_ALTERNATIVE_CONTACTS = 20;
    /** @var bool $checkDSNForEmails whether email validation also used DSN records to check if domain exists */
    public static $checkDSNForEmails = true;

    /**
     * @var array $surveyIdentifyingColumns names of the columns that identify a respondent as unique inside a survey
     */
    public static $surveyIdentifyingColumns = ['phone_number','email_address'];

    public function init()
    {
        parent::init();
    }


    /**
     * {@inheritdoc}
     */
    public function rules()
    {
        return array_merge([
            [['survey_id','token'], 'required'],
            [['survey_id'], 'integer'],
            [['email_address'], 'validateEmail'],
            // email addresses always lowercase
            [['email_address','email_address'],'trim'],
            ['email_address','filter', 'filter' => 'strtolower'],
            [['alternative_email_addresses'], 'string'],
            [['alternative_email_addresses'], 'validateMultipleEmails'],
            [['phone_number','email_address'],'trim'],
            ['phone_number','filter', 'filter' => 'strtolower'],
            [['phone_number'],'string'],
            [['phone_number'],'validatePhoneNumber'],
            [['alternative_phone_numbers'], 'string'],
            [['alternative_phone_numbers'],'validateMultiplePhoneNumbers'],
            [['token'], 'unique'],
        ], parent::rules());
    }



    /**
     * @param string $attribute
     * @param string $address
     * @return bool
     */
    public function validateEmail($attribute,$address = null){

        if($this->validateEmailFormat($attribute, $address)
            && !$this->isSameAsMainAddress($attribute, $address)
            && !$this->isEmailSurveyDuplicate($attribute, $address)){
            return true;
        }
        return false;
    }

    /**
     * @param string $attribute
     * @param string $address
     * @return bool
     */
    private function validateEmailFormat($attribute, $address = null)
    {
        $validator = new yii\validators\EmailValidator();
        $validator->checkDNS = static::$checkDSNForEmails;
        if (!$validator->validate($address)) {
            $this->addError($attribute,
                Yii::t('app',
                    'Invalid email address "{0}"',[$address]
                ).' '.Yii::t('app','Reason: {0}',[Yii::t('app','Invalid email format')])
            );
            return false;
        }
        return true;
    }

    /**
     * @param string $attribute
     * @param string $address
     * @return bool
     */
    private function isSameAsMainAddress($attribute, $address = null)
    {
        if(!$address or empty($address)){
            return false;
        }
        $isSame = ($attribute=='email_address' ? false : $address == $this->email_address);
        if ($isSame) {
            $this->addError($attribute,
                Yii::t('app',
                    'Invalid email address "{0}"',[$address]
                ).' '.Yii::t('app','Reason: {0}',[Yii::t('app',$attribute. ' duplicates main address')])
            );
        }
        return $isSame;
    }


    public function validateMultipleEmails($attribute){
        $addresses = yii\helpers\Json::decode($this->alternative_email_addresses);
        if($this->alternative_email_addresses && !empty($addresses)){
            $cleanAddresses = [];
            if(!empty($addresses)){
                $i=0;
                foreach ($addresses as $key => $address){
                    if($address <> ""){
                        // check the alternative numbers of that model for duplicates
                        $checkItems = $addresses;
                        unset($checkItems[$key]);
                        if(in_array($address,$checkItems)){
                            $this->addError($attribute,Yii::t('app','Duplicate email in alternative email addresses'));
                        }

                        $i++;
                        if($i>=static::MAX_ALTERNATIVE_CONTACTS){
                            $this->addError($attribute,Yii::t('app','Maximum alternative addresses limit ({0}) reached for {1}',[static::MAX_ALTERNATIVE_CONTACTS,$this->email_address]));
                        }
                        $address = strtolower(trim($address));
                        if($this->validateEmail($attribute,$address)){
                            $cleanAddresses[]=$address;
                        }
                    }

                }
                if(!empty($cleanAddresses)){
                    $this->alternative_email_addresses = yii\helpers\Json::encode($cleanAddresses);
                } else {
                    $this->alternative_email_addresses = null;
                }
            }
        }
    }


    public function validatePhoneNumber($attribute, $phone_number = null){
        if(!$phone_number or empty($phone_number)){
            $phone_number = $this->phone_number;
            $isSameAsMain = false;
        }else{
            $isSameAsMain = ($attribute=='phone_number' ? false : $phone_number == $this->phone_number);
        }
        // TODO
        $isValidFormat = true;

        $isDuplicate = $this->isPhoneSurveyDuplicate($phone_number);

        if($isValidFormat && !$isSameAsMain && !$isDuplicate){
            return true;
        }else{
            $reason = '';
            if(!$isValidFormat){
                $reason = Yii::t('app','Invalid phone number format');
            } else if($isSameAsMain){
                $reason = Yii::t('app',$attribute. ' duplicates main phone number');
            } else if($isDuplicate) {
                $reason = Yii::t('app','Duplicate phone number');
            }

            $this->addError($attribute,
                Yii::t('app',
                    'Invalid phone number "{0}"',[$phone_number]
                ).' '.Yii::t('app','Reason: {0}',[$reason])
            );
        }
        return false;
    }

    public function validateMultiplePhoneNumbers($attribute){
        if($this->alternative_phone_numbers){
            $cleanItems = [];
            $items = yii\helpers\Json::decode($this->alternative_phone_numbers);

            if(!empty($items)){
                $i=0;
                foreach ($items as $key=> $item){
                    $item = strtolower(trim($item));
                    if($item <> ''){
                        $i++;
                        // check the alternative numbers of that model for duplicates
                        $checkItems = $items;
                        unset($checkItems[$key]);
                        if(in_array($item,$checkItems)){
                            $this->addError($attribute,Yii::t('app','Duplicate number in alternative phone numbers'));
                        }


                        if($i>=static::MAX_ALTERNATIVE_CONTACTS){
                            $this->addError($attribute,Yii::t('app','Maximum alternative phone numbers limit ({0}) reached for {1}',[static::MAX_ALTERNATIVE_CONTACTS,$this->phone_number]));
                        }
                        if($this->validatePhoneNumber($attribute,$item)){
                            $cleanItems[]=$item;
                        }

                    }
                }
                if(!empty($cleanItems)){
                    $this->alternative_phone_numbers = yii\helpers\Json::encode($cleanItems);
                } else {
                    $this->alternative_phone_numbers = null;
                }
            }
        }
    }



    /**
     * @param string $phone_number Phone number to check duplicates for
     * @return bool
     */
    public function isPhoneSurveyDuplicate($phone_number){
        $query = static::find();
        // check only this survey
        $query->andWhere(['survey_id'=>$this->survey_id]);

        if($this->respondent_id){
            // not itself
            $query->andWhere(['!=','respondent_id',$this->respondent_id]);
        }

        $condition = ['or',
            '`phone_number`=:phone_number',
            '`alternative_phone_numbers` LIKE :phone_number2',
        ];
        $query->andWhere($condition,[':phone_number'=>$phone_number,':phone_number2'=>'%\"'.$phone_number.'\"%']);
        if($query->count() > 0){
            return true;
        }
        return false;
    }


    /**
     * @param string $email_address Email address to check duplicates for
     * @return bool
     */
    public function isEmailSurveyDuplicate($attribute, $email_address){
        $query = static::find();
        // check only this survey
        $query->andWhere(['survey_id'=>$this->survey_id]);
        // not itself
        if($this->respondent_id){
            // not itself
            $query->andWhere(['!=','respondent_id',$this->respondent_id]);
        }

        $email_condition = ['or',
            '`email_address`=:email_address',
            '`alternative_email_addresses` LIKE :email_address2',
        ];
        $query->andWhere($email_condition,[':email_address'=>$email_address,':email_address2'=>'%\"'.$email_address.'\"%']);
        if($query->count() > 0){
            return true;
        }

        $this->addError($attribute,
            Yii::t('app',
                'Invalid email address "{0}"',[$email_address]
            ).' '.Yii::t('app','Reason: {0}',[Yii::t('app','Duplicates some other address')])
        );

        return false;
    }

    /**
     * {@inheritdoc}
     */
    public function attributeLabels()
    {
        return [
            'token' => Yii::t('app', 'Unique Token'),
        ];
    }

    /**
     * @param string $token Respondents token
     * @return static
     */
    public static function findByToken($token = null){
        if($token){
            $models = self::findByTokens([$token]);
            if (!empty($models)){
                return $models[0];
            }
        }
        return null;
    }

    /**
     * @param string[] $tokens Respondents tokens
     * @return static[]
     */
    public static function findByTokens($tokens){
        /** @var static[] $model */
        $models = static::find()
            ->andWhere(['in','token', $tokens])
            ->all();
        return $models;
    }

    /**
     * Check whether respondent has rejected this specific survey or has a hard bounce on e_mail address
     * @return bool
     */
    public function getIsRejected(){
        if(Rejection::rejectedByCode($this->token)){
            return true;
        }
        if(Rejection::bouncedByEmailAddress($this->email_address)){
            return true;
        }

        return false;
    }

    /**
     * Get the last respondent based on Email-address
     * @param string $email_address
     * @return static
     */
    public static function getLatestByEmail($email_address){
        /** @var static $model */
        $model = static::find()
            ->andWhere(['email_address'=>$email_address])
            ->orderBy([static::primaryKey()[0]=>SORT_DESC])
            ->one();
        return $model;
    }

    /**
     * @return string
     */
    public function getShortToken(){
        if(Uuid::isValid($this->token)){
            $uuid = Uuid::fromString($this->token);
            $shotUuid = new ShortUuid();
            return $shotUuid->encode($uuid);
        }
        return $this->token;
    }


}

1			<?php
2
3			namespace andmemasin\surveybasemodels;
4
5			use andmemasin\myabstract\MyActiveRecord;
6			use PascalDeVink\ShortUuid\ShortUuid;
7			use Ramsey\Uuid\Uuid;
8			use yii;
9
10			/**
11			* This is the model class for a generic Respondent.
12			*
13			* @property int $respondent_id
14			* @property int $survey_id
15			* @property string $token
16			* @property Survey $survey
17			* @property string $email_address
18			* @property string $alternative_email_addresses Inserted as CSV, stored as JSON
19			* @property string $phone_number
20			* @property string $alternative_phone_numbers Inserted as CSV, stored as JSON
21			*
22			* @property boolean $isRejected
23			* @property string $shortToken If the token is uuid, then short-uuid will be returned
24			*/
25			class Respondent extends MyActiveRecord
26			{
27			const MAX_ALTERNATIVE_CONTACTS = 20;
28			/** @var bool $checkDSNForEmails whether email validation also used DSN records to check if domain exists */
29			public static $checkDSNForEmails = true;
30
31			/**
32			* @var array $surveyIdentifyingColumns names of the columns that identify a respondent as unique inside a survey
33			*/
34			public static $surveyIdentifyingColumns = ['phone_number','email_address'];
35
36			public function init()
37			{
38			parent::init();
39			}
40
41
42			/**
43			* {@inheritdoc}
44			*/
45			public function rules()
46			{
47			return array_merge([
48			[['survey_id','token'], 'required'],
49			[['survey_id'], 'integer'],
50			[['email_address'], 'validateEmail'],
51			// email addresses always lowercase
52			[['email_address','email_address'],'trim'],
53			['email_address','filter', 'filter' => 'strtolower'],
54			[['alternative_email_addresses'], 'string'],
55			[['alternative_email_addresses'], 'validateMultipleEmails'],
56			[['phone_number','email_address'],'trim'],
57			['phone_number','filter', 'filter' => 'strtolower'],
58			[['phone_number'],'string'],
59			[['phone_number'],'validatePhoneNumber'],
60			[['alternative_phone_numbers'], 'string'],
61			[['alternative_phone_numbers'],'validateMultiplePhoneNumbers'],
62			[['token'], 'unique'],
63			], parent::rules());
64			}
65
66
67
68			/**
69			* @param string $attribute
70			* @param string $address
71			* @return bool
72			*/
73			public function validateEmail($attribute,$address = null){
74
75			if($this->validateEmailFormat($attribute, $address)
76			&& !$this->isSameAsMainAddress($attribute, $address)
77			&& !$this->isEmailSurveyDuplicate($attribute, $address)){
78			return true;
79			}
80			return false;
81			}
82
83			/**
84			* @param string $attribute
85			* @param string $address
86			* @return bool
87			*/
88			private function validateEmailFormat($attribute, $address = null)
89			{
90			$validator = new yii\validators\EmailValidator();
91			$validator->checkDNS = static::$checkDSNForEmails;
92			if (!$validator->validate($address)) {
93			$this->addError($attribute,
94			Yii::t('app',
95			'Invalid email address "{0}"',[$address]
96			).' '.Yii::t('app','Reason: {0}',[Yii::t('app','Invalid email format')])
97			);
98			return false;
99			}
100			return true;
101			}
102
103			/**
104			* @param string $attribute
105			* @param string $address
106			* @return bool
107			*/
108			private function isSameAsMainAddress($attribute, $address = null)
109			{
110			if(!$address or empty($address)){
111			return false;
112			}
113			$isSame = ($attribute=='email_address' ? false : $address == $this->email_address);
114			if ($isSame) {
115			$this->addError($attribute,
116			Yii::t('app',
117			'Invalid email address "{0}"',[$address]
118			).' '.Yii::t('app','Reason: {0}',[Yii::t('app',$attribute. ' duplicates main address')])
119			);
120			}
121			return $isSame;
122			}
123
124
125			public function validateMultipleEmails($attribute){
126			$addresses = yii\helpers\Json::decode($this->alternative_email_addresses);
127			if($this->alternative_email_addresses && !empty($addresses)){
128			$cleanAddresses = [];
129			if(!empty($addresses)){
130			$i=0;
131			foreach ($addresses as $key => $address){
132			if($address <> ""){
133			// check the alternative numbers of that model for duplicates
134			$checkItems = $addresses;
135			unset($checkItems[$key]);
136			if(in_array($address,$checkItems)){
137			$this->addError($attribute,Yii::t('app','Duplicate email in alternative email addresses'));
138			}
139
140			$i++;
141			if($i>=static::MAX_ALTERNATIVE_CONTACTS){
142			$this->addError($attribute,Yii::t('app','Maximum alternative addresses limit ({0}) reached for {1}',[static::MAX_ALTERNATIVE_CONTACTS,$this->email_address]));
143			}
144			$address = strtolower(trim($address));
145			if($this->validateEmail($attribute,$address)){
146			$cleanAddresses[]=$address;
147			}
148			}
149
150			}
151			if(!empty($cleanAddresses)){
152			$this->alternative_email_addresses = yii\helpers\Json::encode($cleanAddresses);
153			} else {
154			$this->alternative_email_addresses = null;
155			}
156			}
157			}
158			}
159
160
161			public function validatePhoneNumber($attribute, $phone_number = null){
162			if(!$phone_number or empty($phone_number)){
163			$phone_number = $this->phone_number;
164			$isSameAsMain = false;
165			}else{
166			$isSameAsMain = ($attribute=='phone_number' ? false : $phone_number == $this->phone_number);
167			}
168			// TODO
169			$isValidFormat = true;
170
171			$isDuplicate = $this->isPhoneSurveyDuplicate($phone_number);
172
173			if($isValidFormat && !$isSameAsMain && !$isDuplicate){
174			return true;
175			}else{
176			$reason = '';
177			if(!$isValidFormat){
178			$reason = Yii::t('app','Invalid phone number format');
179			} else if($isSameAsMain){
180			$reason = Yii::t('app',$attribute. ' duplicates main phone number');
181			} else if($isDuplicate) {
182			$reason = Yii::t('app','Duplicate phone number');
183			}
184
185			$this->addError($attribute,
186			Yii::t('app',
187			'Invalid phone number "{0}"',[$phone_number]
188			).' '.Yii::t('app','Reason: {0}',[$reason])
189			);
190			}
191			return false;
192			}
193
194			public function validateMultiplePhoneNumbers($attribute){
195			if($this->alternative_phone_numbers){
196			$cleanItems = [];
197			$items = yii\helpers\Json::decode($this->alternative_phone_numbers);
198
199			if(!empty($items)){
200			$i=0;
201			foreach ($items as $key=> $item){
202			$item = strtolower(trim($item));
203			if($item <> ''){
204			$i++;
205			// check the alternative numbers of that model for duplicates
206			$checkItems = $items;
207			unset($checkItems[$key]);
208			if(in_array($item,$checkItems)){
209			$this->addError($attribute,Yii::t('app','Duplicate number in alternative phone numbers'));
210			}
211
212
213			if($i>=static::MAX_ALTERNATIVE_CONTACTS){
214			$this->addError($attribute,Yii::t('app','Maximum alternative phone numbers limit ({0}) reached for {1}',[static::MAX_ALTERNATIVE_CONTACTS,$this->phone_number]));
215			}
216			if($this->validatePhoneNumber($attribute,$item)){
217			$cleanItems[]=$item;
218			}
219
220			}
221			}
222			if(!empty($cleanItems)){
223			$this->alternative_phone_numbers = yii\helpers\Json::encode($cleanItems);
224			} else {
225			$this->alternative_phone_numbers = null;
226			}
227			}
228			}
229			}
230
231
232
233			/**
234			* @param string $phone_number Phone number to check duplicates for
235			* @return bool
236			*/
237			public function isPhoneSurveyDuplicate($phone_number){
238			$query = static::find();
239			// check only this survey
240			$query->andWhere(['survey_id'=>$this->survey_id]);
241
242			if($this->respondent_id){
243			// not itself
244			$query->andWhere(['!=','respondent_id',$this->respondent_id]);
245			}
246
247			$condition = ['or',
248			'`phone_number`=:phone_number',
249			'`alternative_phone_numbers` LIKE :phone_number2',
250			];
251			$query->andWhere($condition,[':phone_number'=>$phone_number,':phone_number2'=>'%\"'.$phone_number.'\"%']);
252			if($query->count() > 0){
253			return true;
254			}
255			return false;
256			}
257
258
259			/**
260			* @param string $email_address Email address to check duplicates for
261			* @return bool
262			*/
263			public function isEmailSurveyDuplicate($attribute, $email_address){
264			$query = static::find();
265			// check only this survey
266			$query->andWhere(['survey_id'=>$this->survey_id]);
267			// not itself
268			if($this->respondent_id){
269			// not itself
270			$query->andWhere(['!=','respondent_id',$this->respondent_id]);
271			}
272
273			$email_condition = ['or',
274			'`email_address`=:email_address',
275			'`alternative_email_addresses` LIKE :email_address2',
276			];
277			$query->andWhere($email_condition,[':email_address'=>$email_address,':email_address2'=>'%\"'.$email_address.'\"%']);
278			if($query->count() > 0){
279			return true;
280			}
281
282			$this->addError($attribute,
283			Yii::t('app',
284			'Invalid email address "{0}"',[$email_address]
285			).' '.Yii::t('app','Reason: {0}',[Yii::t('app','Duplicates some other address')])
286			);
287
288			return false;
289			}
290
291			/**
292			* {@inheritdoc}
293			*/
294			public function attributeLabels()
295			{
296			return [
297			'token' => Yii::t('app', 'Unique Token'),
298			];
299			}
300
301			/**
302			* @param string $token Respondents token
303			* @return static
304			*/
305			public static function findByToken($token = null){
306			if($token){
307			$models = self::findByTokens([$token]);
308			if (!empty($models)){
309			return $models[0];
310			}
311			}
312			return null;
313			}
314
315			/**
316			* @param string[] $tokens Respondents tokens
317			* @return static[]
318			*/
319			public static function findByTokens($tokens){
320			/** @var static[] $model */
321			$models = static::find()
322			->andWhere(['in','token', $tokens])
323			->all();
324			return $models;
325			}
326
327			/**
328			* Check whether respondent has rejected this specific survey or has a hard bounce on e_mail address
329			* @return bool
330			*/
331			public function getIsRejected(){
332			if(Rejection::rejectedByCode($this->token)){
333			return true;
334			}
335			if(Rejection::bouncedByEmailAddress($this->email_address)){
336			return true;
337			}
338
339			return false;
340			}
341
342			/**
343			* Get the last respondent based on Email-address
344			* @param string $email_address
345			* @return static
346			*/
347			public static function getLatestByEmail($email_address){
348			/** @var static $model */
349			$model = static::find()
350			->andWhere(['email_address'=>$email_address])
351			->orderBy([static::primaryKey()[0]=>SORT_DESC])
352			->one();
353			return $model;
354			}
355
356			/**
357			* @return string
358			*/
359			public function getShortToken(){
360			if(Uuid::isValid($this->token)){
361			$uuid = Uuid::fromString($this->token);
362			$shotUuid = new ShortUuid();
363			return $shotUuid->encode($uuid);
364			}
365			return $this->token;
366			}
367
368
369			}

TonisOrmisson / yii2-survey-base-models

Push — master ( bfd5dc...4b301d )

Respondent::isEmailSurveyDuplicate() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like