User::isPartnerEnabled() - Code Metrics - Inspection of "WIP: Rip out score" - CorWatts/fasterscale - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Pull Request — master (#163)

by Corey
created 2019-02-10 16:20 UTC
User::isPartnerEnabled() A

↳ Parent: User::cleanExportData()
Complexity

Conditions	6
Paths	2
Size

Total Lines	9
Code Lines	7
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
eloc	7
dl	0
loc	9
c	0
b	0
f	0
rs	9.2222
cc	6
nc	2
nop	0
<?php
namespace common\models;

use yii;
use yii\base\NotSupportedException;
use yii\db\Query;
use yii\web\IdentityInterface;
use \common\components\ActiveRecord;
use \common\interfaces\UserInterface;
use \common\interfaces\UserBehaviorInterface;
use \common\interfaces\QuestionInterface;
use \common\interfaces\TimeInterface;

/**
 * User model
 *
 * @property integer $id
 * @property string $password_hash
 * @property string $password_reset_token
 * @property string $verify_email_token
 * @property string $email
 * @property string $auth_key
 * @property integer $role
 * @property integer $status
 * @property integer $created_at
 * @property integer $updated_at
 * @property string $password write-only password
 * @property string $timezone
 * @property boolean $send_email
 * @property string $partner_email1
 * @property string $partner_email2
 * @property string $partner_email3
 * @property string $desired_email
 * @property string $change_emaiL_token
 */
class User extends ActiveRecord implements IdentityInterface, UserInterface
{
  const STATUS_DELETED = 0;
  const STATUS_ACTIVE = 10;

  const ROLE_USER = 10;

  const CONFIRMED_STRING = '_confirmed';

  public $user_behavior;
  public $question;
  public $time;

  public function __construct(UserBehaviorInterface $user_behavior, QuestionInterface $question, TimeInterface $time, $config = []) {
    $this->user_behavior = $user_behavior;
    $this->question = $question;
    $this->time = $time;
    parent::__construct($config);
  }

  public function afterFind() {
    $this->time = new \common\components\Time($this->timezone);
    parent::afterFind();
  }

  public function afterRefresh() {
    $this->time = new \common\components\Time($this->timezone);
    parent::afterRefresh();
  }

  //public function afterSave() {
  //  $this->time = new \common\components\Time($this->timezone);
  //  parent::afterSave();
  //}

  /**
   * @inheritdoc
   */

  public function behaviors()
  {
    return [
      'timestamp' => [
        'class' => yii\behaviors\TimestampBehavior::class,
        'attributes' => [
          ActiveRecord::EVENT_BEFORE_INSERT => ['created_at', 'updated_at'],
          ActiveRecord::EVENT_BEFORE_UPDATE => ['updated_at'],
        ],
      ],
    ];
  }

  /**
   * @inheritdoc
   */
  public function rules()
  {
    return [
      ['status', 'default', 'value' => self::STATUS_ACTIVE],
      ['status', 'in', 'range' => [self::STATUS_ACTIVE, self::STATUS_DELETED]],

      ['role', 'default', 'value' => self::ROLE_USER],
      ['role', 'in', 'range' => [self::ROLE_USER]],
    ];
  }

  public function getPartnerEmails() {
    return [
      $this->partner_email1,
      $this->partner_email2,
      $this->partner_email3,
    ];
  }

  /**
   * @inheritdoc
   */
  public static function findIdentity($id)
  {
    return static::findOne($id);
interface HasName {
    /** @return string */
    public function getName();
}

class Name {
    public $name;
}

class User implements HasName {
    /** @return string|Name */
    public function getName() {
        return new Name('foo'); // This is a violation of the ``HasName`` interface
                                // which only allows a string value to be returned.
    }
}
  }

  /**
   * @inheritdoc
   */
  public static function findIdentityByAccessToken($token, $type = null)
  {
    throw new NotSupportedException('"findIdentityByAccessToken" is not implemented.');
  }

  /**
   * Finds user by email
   *
   * @param  string      $email
   * @return static|null
   */
  public function findByEmail($email)
  {
    return $this->findOne(['email' => $email, 'status' => self::STATUS_ACTIVE]);
  }

  /**
   * Finds user by password reset token
   *
   * @param  string      $token password reset token
   * @return static|null
   */
  public function findByPasswordResetToken($token)
  {
    if(!$this->isTokenCurrent($token)) {
      return null;
    }

    return $this->findOne([
      'password_reset_token' => $token,
      'status' => self::STATUS_ACTIVE,
    ]);
  }

  /**
   * Finds user by email verification token
   *
   * @param  string      $token email verification token
   * @return static|null
   */
  public function findByVerifyEmailToken($token)
  {
    if($this->isTokenConfirmed($token)) return null;

    $user = $this->findOne([
      'verify_email_token' => [$token, $token . self::CONFIRMED_STRING],
      'status' => self::STATUS_ACTIVE,
    ]);

    if($user) {

      if(!$this->isTokenConfirmed($token) &&
         !$this->isTokenCurrent($token, 'user.verifyAccountTokenExpire')) {
        return null;
      }
    }

    return $user;
  }

  /**
   * Finds user by email change token
   *
   * @param  string      $token email change token
   * @return static|null
   */
  public function findByChangeEmailToken($token)
  {
    $user = static::findOne([
      'change_email_token' => $token,
      'status' => self::STATUS_ACTIVE,
    ]);

    if($user) {

      if(!$user->isTokenCurrent($token, 'user.verifyAccountTokenExpire')) {
        return null;
      }
    }

    return $user;
  }

  /**
   * Finds out if a token is current or expired
   *
   * @param  string      $token verification token
   * @param  string      $paramPath Yii app param path
   * @return boolean
   */
  public function isTokenCurrent($token, String $paramPath = 'user.passwordResetTokenExpire') {
    $expire = \Yii::$app->params[$paramPath];
    $parts = explode('_', $token);
    $timestamp = (int) end($parts);
    if ($timestamp + $expire < time()) {
      // token expired
      return false;
    }
    return true;
  }

  /*
   * Checks if $token ends with the $match string
   *
   * @param string    $token verification token (the haystack)
   * @param string    $match the needle to search for
   */
  public function isTokenConfirmed($token = null, String $match = self::CONFIRMED_STRING) {
    if(is_null($token)) $token = $this->verify_email_token;
    return substr($token, -strlen($match)) === $match;
  }

  /**
   * @inheritdoc
   */
  public function getId()
  {
    return $this->getPrimaryKey();

  }

  /**
   * @inheritdoc
   */
  public function getAuthKey()
  {
    return $this->auth_key;
  }

  public function getTimezone() {
    return $this->timezone;
  }

  public function isVerified() {
    if(is_null($this->verify_email_token)) {

      // for old users who verified their accounts before the addition of
      // '_confirmed' to the token
      return true;
    } else {
      return !!$this->verify_email_token && $this->isTokenConfirmed($this->verify_email_token);
    }
  }

  /**
   * @inheritdoc
   */
  public function validateAuthKey($authKey)
  {
    return $this->getAuthKey() === $authKey;
  }

  /**
   * Validates password
   *
   * @param  string  $password password to validate
   * @return boolean if password provided is valid for current user
   */
  public function validatePassword($password)
  {
    return Yii::$app
      ->getSecurity()
      ->validatePassword($password, $this->password_hash);
  }

  /**
   * Generates password hash from password and sets it to the model
   *
   * @param string $password
   */
  public function setPassword($password)
  {
    $this->password_hash = Yii::$app
      ->getSecurity()
      ->generatePasswordHash($password);
  }

  /**
   * Generates email verification token
   */
  public function generateVerifyEmailToken()
  {
    $this->verify_email_token = $this->getRandomVerifyString();
  }

  /**
   * Confirms email verification token
   */
  public function confirmVerifyEmailToken()
  {
    $this->verify_email_token .= self::CONFIRMED_STRING;
  }

  /**
   * Removes email verification token
   */
  public function removeVerifyEmailToken()
  {
    $this->verify_email_token = null;
  }

  /**
   * Generates email change tokens
   */
  public function generateChangeEmailToken() {
    $this->change_email_token = $this->getRandomVerifyString();

  }

  /**
   * Removes change email token
   */
  public function removeChangeEmailToken()
  {
    $this->change_email_token = null;

  }

  /**
   * Generates "remember me" authentication key
   */
  public function generateAuthKey()
  {
    $this->auth_key = Yii::$app
      ->getSecurity()
      ->generateRandomString();
  }

  /**
   * Generates new password reset token
   */
  public function generatePasswordResetToken()
  {
    $this->password_reset_token = $this->getRandomVerifyString();
  }

  /**
   * Removes password reset token
   */
  public function removePasswordResetToken()
  {
    $this->password_reset_token = null;
  }

  public function sendEmailReport($date) {
    if(!$this->send_email) return false; // no partner emails set
    list($start, $end) = $this->time->getUTCBookends($date);

    $user_behaviors   = $this->getUserBehaviors($date);
    $user_questions = $this->getUserQuestions($date);

    $messages = [];
    foreach($this->getPartnerEmails() as $email) {
      if($email) {
        $messages[] = Yii::$app->mailer->compose('checkinReport', [
          'user'          => $this,
          'email'         => $email,
          'date'          => $date,
          'user_behaviors'  => $user_behaviors,
          'questions'     => $user_questions,
          'categories'    => \common\models\Category::$categories,
          'behaviors_list'  => \common\models\Behavior::$behaviors,
        ])->setFrom([Yii::$app->params['supportEmail'] => Yii::$app->name])
        ->setReplyTo($this->email)
        ->setSubject($this->email." has completed a Faster Scale check-in")
        ->setTo($email);
      }
    }

    return Yii::$app->mailer->sendMultiple($messages);
  }

  public function getExportData() {
    $query = (new Query)
      ->select(
      'l.id,        
       l.date      AS "date",
       l.behavior_id AS "behavior_id",
       (SELECT q1.answer
        FROM question q1
        WHERE q1.question = 1
          AND q1.user_behavior_id = l.id) AS "question1",
       (SELECT q1.answer
        FROM question q1
        WHERE q1.question = 2
          AND q1.user_behavior_id = l.id) AS "question2",
       (SELECT q1.answer
        FROM question q1
        WHERE q1.question = 3
          AND q1.user_behavior_id = l.id) AS "question3"')
      ->from('user_behavior_link l')
      ->join("LEFT JOIN", "question q", "l.id = q.user_behavior_id")
      ->where('l.user_id=:user_id', ["user_id" => Yii::$app->user->id])
      ->groupBy('l.id,
          l.date,
          "question1",
          "question2",
          "question3"')
      ->orderBy('l.date DESC');

    return $query
      ->createCommand()
      ->query();

/* Plaintext Query
SELECT l.id,
       l.date      AS "date",
       l.behavior_id AS "behavior_id",
       (SELECT q1.answer
        FROM question q1
        WHERE q1.question = 1
          AND q1.user_behavior_id = l.id) AS "question1",
       (SELECT q1.answer
        FROM question q1
        WHERE q1.question = 2
          AND q1.user_behavior_id = l.id) AS "question2",
       (SELECT q1.answer
        FROM question q1
        WHERE q1.question = 3
          AND q1.user_behavior_id = l.id) AS "question3"
FROM   user_behavior_link l
       LEFT JOIN question q
         ON l.id = q.user_behavior_id
WHERE  l.user_id = 1
GROUP  BY l.id,
          l.date,
          "question1",
          "question2",
          "question3",
ORDER  BY l.date DESC;
*/
  }

  public function sendSignupNotificationEmail() {
    return \Yii::$app->mailer->compose('signupNotification')
      ->setFrom([\Yii::$app->params['supportEmail'] => \Yii::$app->name])
      ->setTo(\Yii::$app->params['adminEmail'])
      ->setSubject('A new user has signed up for '.\Yii::$app->name)
      ->send();
  }

  public function sendVerifyEmail() {
    return \Yii::$app->mailer->compose('verifyEmail', ['user' => $this])
      ->setFrom([\Yii::$app->params['supportEmail'] => \Yii::$app->name])
      ->setTo($this->email)
      ->setSubject('Please verify your '.\Yii::$app->name .' account')
      ->send();
  }

  public function sendDeleteNotificationEmail() {
    $messages = [];
    foreach(array_merge([$this->email], $this->getPartnerEmails()) as $email) {
      if($email) {
        $messages[] = Yii::$app->mailer->compose('deleteNotification', [
          'user' => $this,
          'email' => $email
        ])->setFrom([Yii::$app->params['supportEmail'] => Yii::$app->name])
        ->setReplyTo($this->email)
        ->setSubject($this->email." has deleted their The Faster Scale App account")
        ->setTo($email);
      }
    }

    return Yii::$app->mailer->sendMultiple($messages);
  }

  public function getUserQuestions($local_date = null) {
    if(is_null($local_date)) $local_date = $this->time->getLocalDate();
    $questions = $this->getQuestionData($local_date);
    return $this->parseQuestionData($questions);
  }

  public function getUserBehaviors($local_date = null) {
    if(is_null($local_date)) $local_date = $this->time->getLocalDate();

    $behaviors = $this->getBehaviorData($local_date);
    $behaviors = $this->user_behavior::decorateWithCategory($behaviors);
    return $this->parseBehaviorData($behaviors);
  }

  public function parseQuestionData($questions) {
    if(!$questions) return [];

    $question_answers = [];
    foreach($questions as $question) {
      $behavior = $question['behavior'];

      $question_answers[$behavior['id']]['question'] = [
        "id" => $behavior['id'],
        "title" => $behavior['name']
      ];

      $question_answers[$behavior['id']]["answers"][] = [
        "title" => $this->question::$QUESTIONS[$question['question']],

        "answer" => $question['answer']
      ];
    }

    return $question_answers;
  }
 
  public function parseBehaviorData($behaviors) {
    if(!$behaviors) return [];

    $opts_by_cat = [];
    foreach($behaviors as $behavior) {
      $indx = $behavior['behavior']['category_id'];

      $opts_by_cat[$indx]['category_name'] = $behavior['behavior']['category']['name'];
      $opts_by_cat[$indx]['behaviors'][] = [
        "id" => $behavior['behavior_id'],
        "name"=>$behavior['behavior']['name']];
    }

    return $opts_by_cat;
  }

  public function getQuestionData($local_date) {
    list($start, $end) = $this->time->getUTCBookends($local_date);

    $questions = $this->question->find()
      ->where("user_id=:user_id 
      ->where(/** @scrutinizer ignore-type */ "user_id=:user_id 
      AND date > :start_date 
      AND date < :end_date", 
    [
      ->/** @scrutinizer ignore-call */ where("user_id=:user_id 
      "user_id" => Yii::$app->user->id, 
      ':start_date' => $start, 
      ":end_date" => $end
    ])
    ->asArray()
    ->all();

    $questions = $this->user_behavior::decorate($questions);
    $questions = $this->user_behavior::decorate($questions);

    return $questions;
  }

  public function getBehaviorData($local_date) {
    list($start, $end) = $this->time->getUTCBookends($local_date);

    return $this->user_behavior->find()
      ->where("user_id=:user_id 
      ->where(/** @scrutinizer ignore-type */ "user_id=:user_id 
      AND date > :start_date 
      AND date < :end_date", 
    [
      ->/** @scrutinizer ignore-call */ where("user_id=:user_id 
      "user_id" => Yii::$app->user->id, 
      ':start_date' => $start, 
      ":end_date" => $end
    ])
    ->asArray()
    ->all();
  }

  public function cleanExportData($data) {
   $order = array_flip(["date", "behavior", "category", "question1", "question2", "question3"]);

   $ret = array_map(
     function($row) use ($order) {
       // change timestamp to local time (for the user)
       $row['date'] = $this->time->convertUTCToLocal($row['date'], false);
       
       // clean up things we don't need
       $row['category'] = $row['behavior']['category']['name'];
       $row['behavior'] = $row['behavior']['name'];
       unset($row['id']);
       unset($row['behavior_id']);

       // sort the array into a sensible order
       uksort($row, function($a, $b) use ($order) {
        return $order[$a] <=> $order[$b];
       });
       return $row;
     }, 
     $data
   );
   return $ret;
  }

  /*
   * getIdHash()
   *
   * @return String a user-identifying hash
   *
   * After generating the hash, we run it through a url-safe base64 encoding to
   * shorten it. This generated string is currently used as an identifier in
   * URLs, so the shorter the better. the url-safe version has been ripped from
   * https://secure.php.net/manual/en/function.base64-encode.php#103849
   *
   * It does NOT take into account the user's email address. The email address
   * is changeable by the user. If that was used for this function, the
   * returned hash would change when the user updates their email. That would
   * obviously not be desirable.
   */
  public function getIdHash() {
    return rtrim(
      strtr(
        base64_encode(
          hash('sha256', $this->id."::".$this->created_at, true)
        ),
      '+/', '-_'),
    '=');
  }

  /*
   * getRandomVerifyString()
   * 
   * @return String a randomly generated string with a timestamp appended
   *
   * This is generally used for verification purposes: verifying an email, password change, or email address change.
   */
  private function getRandomVerifyString() {
    return Yii::$app
      ->getSecurity()
      ->generateRandomString() . '_' . time();
  }
}

CorWatts / fasterscale

Pull Request — master (#163)

User::isPartnerEnabled() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
