Profile - Code Metrics - Inspection of "User notifications [3/3]" - phpffcms/ffcms - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 89df9c...7f6cde )

by Mihail

created 2016-07-08 15:02 UTC

Profile F

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	536
Duplicated Lines	5.6 %

Coupling/Cohesion

Components	1
Dependencies	23

Importance

Changes	14
Bugs	4	Features	0

Metric	Value
c	14
b	4
f	0
dl	30
loc	536
rs	1.5492
wmc	79
lcom	1
cbo	23

9 Methods

Rating	Name	Duplication	Size	Complexity
B	actionWallanswercount()	0	28	5
C	actionShowwallanswers()	0	38	8
C	actionSendwallanswer()	0	67	12
C	actionDeleteanswerowner()	0	37	8
C	actionListmessagedialog()	0	68	13
B	actionNotifications()	0	26	2
D	actionMessageList()	27	96	13
B	actionMessagesend()	0	31	6
C	actionChangerating()	3	66	12

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like Profile often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use Profile, and based on these observations, apply Extract Interface, too.

<?php

namespace Apps\Controller\Api;

use Apps\ActiveRecord\Blacklist;
use Apps\ActiveRecord\Message;
use Apps\ActiveRecord\ProfileRating;
use Apps\ActiveRecord\UserNotification;
use Apps\ActiveRecord\WallAnswer;
use Apps\ActiveRecord\WallPost;
use Apps\Model\Front\Profile\EntityAddNotification;
use Extend\Core\Arch\ApiController;
use Ffcms\Core\App;
use Ffcms\Core\Helper\Text;
use Ffcms\Core\Helper\Type\Arr;
use Ffcms\Core\Helper\Date;
use Ffcms\Core\Helper\Type\Obj;
use Ffcms\Core\Helper\Type\Str;
use Ffcms\Core\Interfaces\iUser;
use Illuminate\Database\Capsule\Manager as Capsule;
use Ffcms\Core\Exception\NativeException;
use Ffcms\Core\Exception\ForbiddenException;
use Ffcms\Core\Exception\NotFoundException;

class Profile extends ApiController
{
    const ITEM_PER_PAGE = 10;
    const ANSWER_DELAY = 60; // in seconds

    const MSG_USER_LIST = 10;
    const MSG_TEXT_LIST = 20;

    /**
     * Get wall answer's count by post-ids list
     * @param int $postIds
     * @throws NativeException
     * @return string
     */
    public function actionWallanswercount($postIds)
    {
        // set header
        $this->setJsonHeader();
        // check query length
        if (Str::likeEmpty($postIds)) {
            throw new NativeException('Wrong input count');
        }

        $list = explode(',', $postIds);
        $itemCount = count($list);
        // empty or is biggest then limit?
        if ($itemCount < 1 || $itemCount > self::ITEM_PER_PAGE) {
            throw new NativeException('Wrong input count');
        }

        // prepare response
        $response = [];
        foreach ($list as $post) {
            $response[$post] = WallAnswer::where('post_id', '=', $post)->count();
        }

        // display json data
        return json_encode([
            'status' => 1,
            'data' => $response
        ]);
    }

    /**
     * Show all answers for this post id
     * @param int $postId
     * @return string
     * @throws NativeException
     * @return string
     */
    public function actionShowwallanswers($postId)
    {
        // check input post id num
        if (!Obj::isLikeInt($postId) || $postId < 1) {
            throw new NativeException('Wrong input data');
        }

        // try to find this post
        $object = WallPost::find($postId);

        if ($object === null || $object === false) {
            throw new NativeException('Wrong input data');
        }

        $result = $object->getAnswer()->orderBy('id', 'DESC')->take(200)->get();
        $response = [];

        foreach ($result as $answer) {
            // get user object and profile
            $user = $answer->getUser();
            $profile = $user->getProfile();
            // check if user exist
            if ($user === null || $user->id < 1) {
                continue;
            }
            // generate response array
            $response[] = [
                'answer_id' => $answer->id,
                'user_id' => $answer->user_id,
                'user_nick' => App::$Security->strip_tags($profile->getNickname()),
                'user_avatar' => $profile->getAvatarUrl('small'),
                'answer_message' => App::$Security->strip_tags($answer->message),
                'answer_date' => Date::humanize($answer->created_at)
            ];
        }

        return json_encode(['status' => 1, 'data' => $response]);
    }

    /**
     * Add new post answer from AJAX post
     * @param int $postId
     * @return string
     * @throws ForbiddenException
     * @throws NativeException
     */
    public function actionSendwallanswer($postId)
    {
        // not auth? what are you doing there? ;)
        if (!App::$User->isAuth()) {
            throw new ForbiddenException('Auth required');
        }

        // no post id? wtf you doing man!
        if (!Obj::isLikeInt($postId) || $postId < 1) {
            throw new NativeException('Wrong input data');
        }

        // get current(sender) user object
        $viewer = App::$User->identity();

        // get message from post and validate minlength
        $message = App::$Request->get('message');
        $message = App::$Security->strip_tags($message);
        if (!Obj::isString($message) || Str::length($message) < 3) {
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
            throw new ForbiddenException('Wrong input data');
        }

        // try to find this post
        $wallPost = WallPost::where('id', '=', $postId);
        if ($wallPost->count() < 1) {
            throw new NativeException('Wrong input data');
        }

        $wallRow = $wallPost->first();
        $target_id = $wallRow->target_id;
        // check if in blacklist
        if (!Blacklist::check($viewer->id, $target_id)) {
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
            throw new ForbiddenException('User is blocked!');
        }

        // check delay between user last post and current
        $lastAnswer = WallAnswer::where('user_id', '=', App::$User->identity()->getId())->orderBy('created_at', 'DESC')->first();
        if (null !== $lastAnswer && false !== $lastAnswer) {
            $now = time();
            $answerTime = Date::convertToTimestamp($lastAnswer->created_at);
            $cfgs = \Apps\ActiveRecord\App::getConfigs('app', 'Profile');
            // hmm, maybe past less then delay required?
            if ($now - (int)$cfgs['delayBetweenPost'] < $answerTime) {
                throw new ForbiddenException('Delay between answers not pass');
            }
        }

        // make new row ;)
        $answers = new WallAnswer();
        $answers->post_id = $postId;
        $answers->user_id = $viewer->id;
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
        $answers->message = $message;
        $answers->save();

        // add notification for target user
        if ($viewer->id !== $target_id) {
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
            $notify = new EntityAddNotification($target_id);
            $notify->add('/profile/show/' . $target_id . '#wall-post-' . $wallRow->id, EntityAddNotification::MSG_ADD_WALLANSWER, [
                'snippet' => Text::snippet($message, 50),
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
                'post' => $wallRow->message
            ]);
        }

        // send "ok" response
        $this->setJsonHeader();
        return json_encode(['status' => 1, 'message' => 'ok']);
    }

    /**
     * Delete answer by answer owner or wall owner
     * @param $answerId
     * @return string
     * @throws ForbiddenException
     * @throws NativeException
     * @throws NotFoundException
     */
    public function actionDeleteanswerowner($answerId)
    {
        $this->setJsonHeader();
        // hello script kiddy, you must be auth ;)
        if (!App::$User->isAuth()) {
            throw new ForbiddenException('Auth required');
        }
        // answer id must be an unsigned integer
        if (!Obj::isLikeInt($answerId) || $answerId < 1) {
            throw new NativeException('Wrong input data');
        }

        $findAnswer = WallAnswer::find($answerId);

        // check if this answer id exist
        if (null === $findAnswer || false === $findAnswer) {
            throw new NotFoundException('Wrong input data');
        }

        // get current viewer
        $viewer = App::$User->identity();
        // get post info
        $postInfo = $findAnswer->getWallPost();

        // if not a target user of answer and not answer owner - lets throw exception
        if($postInfo->target_id !== $viewer->id && $findAnswer->user_id !== $viewer->id) {
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
            throw new ForbiddenException('Access declined!');
        }

        // all is ok, lets remove this answer ;)
        $findAnswer->delete();

        return json_encode([
           'status' => 1,
            'message' => 'ok'
        ]);
    }

    /**
     * Load user dialog list based on offset
     * @param int $offset
     * @param int $new
     * @return string
     * @throws ForbiddenException
     */
    public function actionListmessagedialog($offset = 0, $new = 0)
    {
        // check is user auth
        if (!App::$User->isAuth()) {
            throw new ForbiddenException('Auth required');
        }
        $this->setJsonHeader();

        // check is offset is int
        if ($offset !== 0 && !Obj::isLikeInt($offset)) {
            $offset = 0;
        }
        ++$offset;

        // get user person
        $user = App::$User->identity();

        $records = Message::select('*', Capsule::raw('max(created_at) as cmax'), Capsule::raw('min(readed) as tread'))
            ->where('target_id', '=', $user->id)
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
            ->orWhere('sender_id', '=', $user->id)
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
            ->orderBy('cmax', 'DESC')
            ->groupBy(['target_id', 'sender_id']) // group by ignore orderBy ... make some shit
            ->take($offset * self::MSG_USER_LIST)
            ->get();

        $userList = [];
        $unreadList = [];

        if (Obj::isLikeInt($new) && $new > 0 && App::$User->isExist($new)) {
            $userList[] = $new;
        }
        // there is 2 way of messages: me->user; user->me, try to parse it
        foreach ($records as $row) {
            // target is not myself? then i'm - sender (remote user is target: my->to_user)
            if ($row->target_id !== $user->id) {
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
                $userList[] = $row->target_id;
            }

            // sender is not myself? then i'm - target (remote user is sender user->to_me)
            if ($row->sender_id !== $user->id) {
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
                $userList[] = $row->sender_id;
                if ((int)$row->tread === 0) {
                    $unreadList[] = $row->sender_id;
                }
            }
        }

        // store only unique users in dialog
        $userList = array_unique($userList, SORT_NUMERIC);
        // generate json response based on userList and unreadList
        $response = [];
        foreach ($userList as $user_id) {
            $identity = App::$User->identity($user_id);
            if (null === $identity) {
                continue;
            }

            $response[] = [
                'user_id' => $user_id,
                'user_nick' => App::$Security->strip_tags($identity->getProfile()->getNickname()),
                'user_avatar' => $identity->getProfile()->getAvatarUrl('small'),
                'message_new' => Arr::in($user_id, $unreadList),
                'user_block' => !Blacklist::check($user->id, $identity->id)
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
            ];
        }

        return json_encode(['status' => 1, 'data' => $response]);
    }

    /**
     * Get user p.m and notifications count
     * @return string
     * @throws ForbiddenException
     */
    public function actionNotifications()
    {
        // check if authed
        if (!App::$User->isAuth()) {
            throw new ForbiddenException('Auth required');
        }
        $this->setJsonHeader();

        // get user object
        $user = App::$User->identity();

        // get messages count
        $messagesCount = Message::where('target_id', '=', $user->id)
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
            ->where('readed', '=', 0)->count();

        // get notifications count
        $notificationsCount = UserNotification::where('user_id', '=', $user->id)
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
            ->where('readed', '=', 0)->count();

        return json_encode([
            'status' => 1,
            'notify' => $notificationsCount,
            'messages' => $messagesCount,
            'summary' => $notificationsCount + $messagesCount
        ]);
    }

    /**
     * List messages with correspondent
     * @param $cor_id
     * @return string
     * @throws ForbiddenException
     * @throws NotFoundException
     * @throws NativeException
     */
    public function actionMessageList($cor_id)
    {
        if (!App::$User->isAuth()) {
            throw new ForbiddenException('Auth required');
        }

        if (!Obj::isLikeInt($cor_id) || $cor_id < 1) {
            throw new NotFoundException('Corresponded id is wrong');
        }

        // get special types for this action
        $queryType = App::$Request->get('type');
        $queryId = (int)App::$Request->get('id');
        // get current user object
        $user = App::$User->identity();

        if (Arr::in($queryType, ['before', 'after']) && (!Obj::isLikeInt($queryId) || $queryId < 1)) {

            throw new NativeException('Bad input data');
        }

        $messages = null;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        // sounds like a Hindi code, but we need more closures to organize where conditions
        // after raw: select * from `ffcms_messages` where `id` > ? and ((`target_id` = ? and `sender_id` = ?) or (`target_id` = ? and `sender_id` = ?)) order by `created_at` desc

        // before raw: select * from `ffcms_messages` where (`target_id` = ? and `sender_id` = ?) or (`target_id` = ? and `sender_id` = ?) order by `created_at` desc
        // default raw: select * from `ffcms_messages` where `id` < ? and ((`target_id` = ? and `sender_id` = ?) or (`target_id` = ? and `sender_id` = ?)) order by `created_at` desc

        switch ($queryType) {
            case 'after':

                $messages = Message::where('id', '>', $queryId)
                    ->where(function ($query) use ($cor_id, $user) {
                        $query->where(function ($q) use ($cor_id, $user){
                            $q->where('target_id', '=', $user->getId())
                                ->where('sender_id', '=', $cor_id);
                        })->orWhere(function ($q) use ($cor_id, $user){
                            $q->where('target_id', '=', $cor_id)
                                ->where('sender_id', '=', $user->getId());
                        });
                    });
                break;
            case 'before':

                $messages = Message::where('id', '<', $queryId)
                    ->where(function ($query) use ($cor_id, $user) {
                        $query->where(function ($q) use ($cor_id, $user){
                            $q->where('target_id', '=', $user->getId())
                                ->where('sender_id', '=', $cor_id);
                        })->orWhere(function ($q) use ($cor_id, $user){
                            $q->where('target_id', '=', $cor_id)
                                ->where('sender_id', '=', $user->getId());
                        });
                    });
                break;
            default:
                $messages = Message::where(function($query) use ($cor_id, $user) {
                    $query->where('target_id', '=', $user->getId())
                        ->where('sender_id', '=', $cor_id);
                })->orWhere(function($query) use ($cor_id, $user) {
                    $query->where('target_id', '=', $cor_id)
                        ->where('sender_id', '=', $user->getId());
                });
                break;
        }

        // set response header
        $this->setJsonHeader();

        $messages->orderBy('created_at', 'DESC')
            ->take(self::MSG_TEXT_LIST);

        // check if messages exist
        if ($messages->count() < 1) {
            return json_encode(['status' => 0, 'text' => 'No messages']);
            return;
function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}
        }

        // build response
        $response = null;
        foreach ($messages->get() as $msg) {
            $response[] = [
                'id' => $msg->id,
                'my' => $msg->sender_id === $user->id,
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
                'message' => App::$Security->strip_tags($msg->message),
                'date' => Date::convertToDatetime($msg->created_at, Date::FORMAT_TO_SECONDS),
                'readed' => $msg->readed
            ];
            // update status to readed
            if ($msg->readed !== 1 && $msg->sender_id !== $user->id) {
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
                $msg->readed = 1;
                $msg->save();
            }
        }

        return json_encode([
            'status' => 1,
            'data' => array_reverse($response),
            'blocked' => !Blacklist::check($user->id, $cor_id)
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
        ]);
    }

    /**
     * Send message via AJAX
     * @param $target_id
     * @return string
     * @throws ForbiddenException
     * @throws NativeException
     */
    public function actionMessagesend($target_id)
    {
        // check if user is auth
        if (!App::$User->isAuth()) {
            throw new ForbiddenException('Auth required');
        }

        // get current user object
        $user = App::$User->identity();

        if (!Blacklist::check($user->id, $target_id)) {
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
            throw new ForbiddenException('In blacklist');
        }

        // check input params
        $msg = App::$Security->strip_tags(App::$Request->get('message'));
        if (!Obj::isLikeInt($target_id) || $target_id < 1 || Str::length($msg) < 1) {
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
            throw new NativeException('Wrong input data');
        }

        $this->setJsonHeader();

        // try to save message
        $message = new Message();
        $message->target_id = $target_id;
        $message->sender_id = $user->id;
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
        $message->message = $msg;
        $message->save();

        return json_encode(['status' => 1]);
    }

    /**
     * Change user rating action
     * @throws ForbiddenException
     * @throws NativeException
     * @throws NotFoundException
     * @return string
     */
    public function actionChangerating()
    {
        if (!App::$User->isAuth()) {
            throw new ForbiddenException('Auth required');
        }

        $this->setJsonHeader();

        // get operation type and target user id
        $target_id = (int)App::$Request->get('target');
        $type = App::$Request->get('type');

        // check type of query
        if ($type !== '+' && $type !== '-') {
            throw new NativeException('Wrong data');
        }

        // check if passed user id is exist
        if (!Obj::isLikeInt($target_id) || $target_id < 1 || !App::$User->isExist($target_id)) {

            throw new NotFoundException('Wrong user info');
        }

        $cfg = \Apps\ActiveRecord\App::getConfigs('app', 'Profile');
        // check if rating is enabled for website
        if ((int)$cfg['rating'] !== 1) {
            throw new NativeException('Rating is disabled');
        }

        // get target and sender objects
        $target = App::$User->identity($target_id);
        $sender = App::$User->identity();

        // disable self-based changes ;)
        if ($target->getId() === $sender->getId()) {
            throw new ForbiddenException('Self change prevented');
        }

        // check delay
        $diff = Date::convertToTimestamp(time() - $cfg['ratingDelay'], Date::FORMAT_SQL_TIMESTAMP);


        $query = ProfileRating::where('target_id', '=', $target->getId())
            ->where('sender_id', '=', $sender->getId())
            ->where('created_at', '>=', $diff)
            ->orderBy('id', 'DESC');
        if ($query !== null && $query->count() > 0) {
            throw new ForbiddenException('Delay required');
        }

        // delay is ok, lets insert a row
        $record = new ProfileRating();
        $record->target_id = $target->getId();
        $record->sender_id = $sender->getId();
        $record->type = $type;
        $record->save();

        // update target profile
        $profile = $target->getProfile();
        if ($type === '+') {
            $profile->rating += 1;
        } else {
            $profile->rating -= 1;
        }
        $profile->save();

        return json_encode(['status' => 1, 'data' => 'ok']);
    }
}

Push — master ( 89df9c...7f6cde )

Profile F

Complexity

Size/Duplication

Coupling/Cohesion

Importance

9 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

phpffcms / ffcms

Push — master ( 89df9c...7f6cde )

Profile F

Complexity

Size/Duplication

Coupling/Cohesion

Importance

9 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like