COMMENTREPORT::resolve() - Code Metrics - Inspection of "Ignore dot in URL, so e.g. index.php not matched." - mysociety/theyworkforyou - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Branch — master (3ce7e2)

by Nick

created 2018-06-21 14:13 UTC

COMMENTREPORT::resolve() B

↳ Parent: COMMENTREPORT

Complexity

Conditions	6
Paths	7

Size

Total Lines	68
Code Lines	34

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	6
eloc	34
c	0
b	0
f	0
nc	7
nop	2
dl	0
loc	68
rs	8.5748

How to fix Long Method

<?php

/*	Comment reports are when a user complains about a comment.
    A report is logged and an admin user can then either approve or reject
    the report. If they approve, the associated comment is deleted.


    To create a new comment report:
        $REPORT = new COMMENTREPORT;
        $REPORT->create($data);

    To view info about an existing report:
        $REPORT = new COMMENTREPORT($report_id);
        $REPORT->display();

    You can also do $REPORT->lock() and $REPORT->unlock() to ensure only
    one person can process a report at a time.

    And finally you can $REPORT->resolve() to approve or reject the report.

*/

class COMMENTREPORT {
namespace YourVendor;

class YourClass { }

    public $report_id = '';
    public $comment_id = '';
    public $firstname = '';
    public $lastname = '';
    public $body = '';
    public $reported = NULL;	// datetime
    public $resolved = NULL; 	// datetime
    public $resolvedby = ''; 	// user_id
    public $locked = NULL; 	// datetime
    public $lockedby = '';		// user_id
    public $upheld = ''; 		// boolean

    // If the user was logged in, this will be set:
    public $user_id = '';
    // If the user wasn't logged in, this will be set:
    public $email = '';


    public function __construct($report_id='') {
        // Pass it a report id and it gets and sets this report's data.

        $this->db = new ParlDB;


        if (is_numeric($report_id)) {

            $q = $this->db->query("SELECT commentreports.comment_id,
                                    commentreports.user_id,
                                    commentreports.body,
                                    DATE_FORMAT(commentreports.reported, '" . SHORTDATEFORMAT_SQL . ' ' . TIMEFORMAT_SQL . "') AS reported,
                                    DATE_FORMAT(commentreports.resolved, '" . SHORTDATEFORMAT_SQL . ' ' . TIMEFORMAT_SQL . "') AS resolved,
                                    commentreports.resolvedby,
                                    commentreports.locked,
                                    commentreports.lockedby,
                                    commentreports.upheld,
                                    commentreports.firstname,
                                    commentreports.lastname,
                                    commentreports.email,
                                    users.firstname AS u_firstname,
                                    users.lastname AS u_lastname
                            FROM	commentreports,
                                    users
                            WHERE	commentreports.report_id = :report_id
                            AND		commentreports.user_id = users.user_id
                            ", array(
                                ':report_id' => $report_id
                            ));

            if ($q->rows() > 0) {
                $this->report_id		= $report_id;
                $this->comment_id 		= $q->field(0, 'comment_id');
                $this->body 			= $q->field(0, 'body');
                $this->reported 		= $q->field(0, 'reported');
                $this->resolved 		= $q->field(0, 'resolved');
                $this->resolvedby 		= $q->field(0, 'resolvedby');
                $this->locked 			= $q->field(0, 'locked');
                $this->lockedby			= $q->field(0, 'lockedby');
                $this->upheld 			= $q->field(0, 'upheld');

                if ($q->field(0, 'user_id') == 0) {
                    // The report was made by a non-logged-in user.
                    $this->firstname = $q->field(0, 'firstname');
                    $this->lastname = $q->field(0, 'lastname');
                    $this->email = $q->field(0, 'email');
                } else {
                    // The report was made by a logged-in user.
                    $this->firstname = $q->field(0, 'u_firstname');
                    $this->lastname = $q->field(0, 'u_lastname');
                    $this->user_id = $q->field(0, 'user_id');
                }
            } else {
                $q = $this->db->query("SELECT commentreports.comment_id,
                                    commentreports.user_id,
                                    commentreports.body,
                                    DATE_FORMAT(commentreports.reported, '" . SHORTDATEFORMAT_SQL . ' ' . TIMEFORMAT_SQL . "') AS reported,
                                    DATE_FORMAT(commentreports.resolved, '" . SHORTDATEFORMAT_SQL . ' ' . TIMEFORMAT_SQL . "') AS resolved,
                                    commentreports.resolvedby,
                                    commentreports.locked,
                                    commentreports.lockedby,
                                    commentreports.upheld,
                                    commentreports.firstname,
                                    commentreports.lastname,
                                    commentreports.email
                            FROM	commentreports
                            WHERE	commentreports.report_id = :report_id", array(
                                ':report_id' => $report_id
                            ));

                if ($q->rows() > 0) {
                $this->report_id		= $report_id;
                $this->comment_id 		= $q->field(0, 'comment_id');
                $this->body 			= $q->field(0, 'body');
                $this->reported 		= $q->field(0, 'reported');
                $this->resolved 		= $q->field(0, 'resolved');
                $this->resolvedby 		= $q->field(0, 'resolvedby');
                $this->locked 			= $q->field(0, 'locked');
                $this->lockedby			= $q->field(0, 'lockedby');
                $this->upheld 			= $q->field(0, 'upheld');
                $this->firstname = $q->field(0, 'firstname');
                $this->lastname = $q->field(0, 'lastname');
                $this->email = $q->field(0, 'email');
                }
            }
        }
    }


    public function report_id() { return $this->report_id; }
    public function comment_id() { return $this->comment_id; }
    public function user_id() { return $this->user_id; }
    public function user_name() { return $this->firstname . ' ' . $this->lastname; }
    public function firstname() { return $this->firstname; }
    public function lastname() { return $this->lastname; }
    public function email() { return $this->email; }
    public function body() { return $this->body; }
    public function reported() { return $this->reported; }
    public function resolved() { return $this->resolved; }
    public function resolvedby() { return $this->resolvedby; }
    public function locked() { return $this->locked; }
    public function lockedby() { return $this->lockedby; }
    public function upheld() { return $this->upheld; }

    public function create($COMMENT, $reportdata) {
        // For when a user posts a report on a comment.
        // $reportdata is an array like:
        //	array (
        //		'body' => 'some text',

        //		'firstname'	=> 'Billy',

        //		'lastname'	=> 'Nomates',

        //		'email'		=> '[email protected]'

        //	)
        // But if the report was made by a logged-in user, only the
        // 'body' element should really contain anything, because
        // we use $THEUSER's id to get the rest.

        // $COMMENT is an existing COMMENT object, needed for setting
        // its modflag and comment_id.

        global $THEUSER, $PAGE;
function myFunction($a, $b) {
    // Do something
}

        if (!$THEUSER->is_able_to('reportcomment')) {
            $PAGE->error_message ("Sorry, you are not allowed to post reports.");
            return false;
        }

        if (is_numeric($THEUSER->user_id()) && $THEUSER->user_id() > 0) {
            // Flood check - make sure the user hasn't just posted a report recently.
            // To help prevent accidental duplicates, among other nasty things.
            // (Non-logged in users are all id == 0.)

            $flood_time_limit = 20; // How many seconds until a user can post again?

            $q = $this->db->query("SELECT report_id
                            FROM	commentreports
                            WHERE	user_id = '" . $THEUSER->user_id() . "'
                            AND		reported + 0 > NOW() - $flood_time_limit");

            if ($q->rows() > 0) {
                $PAGE->error_message("Sorry, we limit people to posting one report per $flood_time_limit seconds to help prevent duplicate reports. Please go back and try again, thanks.");
                return false;
            }
        }


        // Tidy up body.
        $body = filter_user_input($reportdata['body'], 'comment'); // In utility.php

        $time = gmdate("Y-m-d H:i:s");

        if ($THEUSER->isloggedin()) {
            $sql = "INSERT INTO commentreports
                                    (comment_id, body, reported, user_id)
                            VALUES	(:comment_id,
                                    :body,
                                    :time,
                                    :user_id
                                    )
                        ";
            $params = array(
                ':comment_id' => $COMMENT->comment_id(),
                ':body' => $body,
                ':time' => $time,
                ':user_id' => $THEUSER->user_id()
            );
        } else {
            $sql = "INSERT INTO commentreports
                                    (comment_id, body, reported, firstname, lastname, email)
                            VALUES	(:comment_id,
                                    :body,
                                    :time,
                                    :firstname,
                                    :lastname,
                                    :email
                                    )
                        ";
            $params = array(
                ':comment_id' => $COMMENT->comment_id(),
                ':body' => $body,
                ':time' => $time,
                ':firstname' => $reportdata['firstname'],
                ':lastname' => $reportdata['lastname'],
                ':email' => $reportdata['email'],
            );
        }

        $q = $this->db->query($sql, $params);

        if ($q->success()) {
            // Inserted OK, so set up this object's variables.
            $this->report_id 	= $q->insert_id();
            $this->comment_id 	= $COMMENT->comment_id();
            $this->body			= $body;
            $this->reported		= $time;

            if ($THEUSER->isloggedin()) {
                $this->user_id		= $THEUSER->user_id();
                $this->firstname	= $THEUSER->firstname();
                $this->lastname		= $THEUSER->lastname();
            } else {
                $this->email		= $reportdata['email'];
                $this->firstname 	= $reportdata['firstname'];
                $this->lastname		= $reportdata['lastname'];
            }


            // Set the comment's modflag to on.
            $COMMENT->set_modflag('on');


            // Notify those who need to know that there's a new report.

            $URL = new \MySociety\TheyWorkForYou\Url('admin_commentreport');
            $URL->insert(array(
                'rid'=>$this->report_id,
                'cid'=>$this->comment_id
            ));

            $emailbody = "A new comment report has been filed by " . $this->user_name() . ".\n\n";
            $emailbody .= "COMMENT:\n" . $COMMENT->body() . "\n\n";
            $emailbody .= "REPORT:\n" . $this->body . "\n\n";
            $emailbody .= "To manage this report follow this link: https://" . DOMAIN . $URL->generate('none') . "\n";


            send_email(REPORTLIST, 'New comment report', $emailbody);



            // Send an email to the user to thank them.

            if ($THEUSER->isloggedin()) {
                $email = $THEUSER->email();
            } else {
                $email = $this->email();
            }

            $data = array (
                'to' 			=> $email,
                'template' 		=> 'report_acknowledge'
            );
            $merge = array (
                'FIRSTNAME' 	=> $this->firstname(),
                'LASTNAME' 		=> $this->lastname(),
                'COMMENTURL' 	=> "https://" . DOMAIN . $COMMENT->url(),
                'REPORTBODY' 	=> strip_tags($this->body())
            );


            // send_template_email in utility.php.
            send_template_email($data, $merge);

            return true;
        } else {
            return false;
        }

    }


    public function display() {

        $data = array();

        if (is_numeric($this->report_id)) {
            $data = array (
                'report_id' 	=> $this->report_id(),
                'comment_id' 	=> $this->comment_id(),
                'user_id' 		=> $this->user_id(),
                'user_name' 	=> $this->user_name(),
                'body' 			=> $this->body(),
                'reported' 		=> $this->reported(),
                'resolved' 		=> $this->resolved(),
                'resolvedby' 	=> $this->resolvedby(),
                'locked' 		=> $this->locked(),
                'lockedby'		=> $this->lockedby(),
                'upheld'	 	=> $this->upheld()
            );
        }

        $this->render($data);
    }



    public function render($data) {
        global $PAGE;
function myFunction($a, $b) {
    // Do something
}

        $PAGE->display_commentreport($data);

    }


    public function lock() {
        // Called when an admin user goes to examine a report, so that
        // only one person can edit at once.

        global $THEUSER, $PAGE;
function myFunction($a, $b) {
    // Do something
}

        if ($THEUSER->is_able_to('deletecomment')) {
            $time = gmdate("Y-m-d H:i:s");

            $q = $this->db->query ("UPDATE commentreports
                            SET		locked = '$time',
                                    lockedby = '" . $THEUSER->user_id() . "'
                            WHERE	report_id = '" . $this->report_id . "'
                            ");

            if ($q->success()) {
                $this->locked = $time;
                $this->lockedby = $THEUSER->user_id();
                return true;
            } else {
                $PAGE->error_message ("Sorry, we were unable to lock this report.");
                return false;
            }
        } else {
            $PAGE->error_message ("You are not authorised to delete annotations.");
            return false;
        }
    }


    public function unlock() {
        // Unlock a comment so it can be examined by someone else.

        $q = $this->db->query ("UPDATE commentreports
                        SET		locked = NULL,
                                lockedby = NULL
                        WHERE	report_id = '" . $this->report_id . "'
                        ");

        if ($q->success()) {
            $this->locked = NULL;
            $this->lockedby = NULL;
            return true;
        } else {
            return false;
        }
    }



    public function resolve($upheld, $COMMENT) {
        // Resolve a report.
        // $upheld is true or false.

        // $COMMENT is an existing COMMENT object - we need this so
        // that we can set its modflagged to off and/or delete it.
        global $THEUSER, $PAGE;
function myFunction($a, $b) {
    // Do something
}

        $time = gmdate("Y-m-d H:i:s");

        if ($THEUSER->is_able_to('deletecomment')) {
            // User is allowed to do this.

            if (!$this->resolved) {
                // Only if this report hasn't been previously resolved.

                if ($upheld) {

                    $success = $COMMENT->delete();

                    if (!$success) {
                        // Abort!
                        return false;
                    }

                    $upheldsql = 1;

                } else {
                    $upheldsql = 0;

                    // Report has been removed, so un-modflag this comment.
                    $COMMENT->set_modflag('off');
                }

                $q = $this->db->query("UPDATE commentreports
                                SET 	resolved = :time,
                                        resolvedby = :resolved_by,
                                        locked = NULL,
                                        lockedby = NULL,
                                        upheld = :upheld
                                WHERE 	report_id = :report_id
                                ", array(
                                    ':time' => $time,
                                    ':resolved_by' => $THEUSER->user_id(),
                                    ':upheld' => $upheldsql,
                                    ':report_id' => $this->report_id
                                ));

                if ($q->success()) {

                    $this->resolved = $time;
                    $this->resolvedby = $THEUSER->user_id();
                    $this->locked = NULL;
                    $this->lockedby = NULL;
                    $this->upheld = $upheld;

                    return true;
                } else {
                    $PAGE->error_message ("Sorry, we couldn't resolve this report.");
                    return false;
                }
            } else {
                $PAGE->error_message ("This report has already been resolved (on " . $this->resolved . ")");
                return false;
            }

        } else {
            $PAGE->error_message ("You are not authorised to resolve reports.");
            return false;
        }
    }



}


Branch — master (3ce7e2)

COMMENTREPORT::resolve() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1			<?php
2
3			/* Comment reports are when a user complains about a comment.
4			A report is logged and an admin user can then either approve or reject
5			the report. If they approve, the associated comment is deleted.
6
7
8			To create a new comment report:
9			$REPORT = new COMMENTREPORT;
10			$REPORT->create($data);
11
12			To view info about an existing report:
13			$REPORT = new COMMENTREPORT($report_id);
14			$REPORT->display();
15
16			You can also do $REPORT->lock() and $REPORT->unlock() to ensure only
17			one person can process a report at a time.
18
19			And finally you can $REPORT->resolve() to approve or reject the report.
20
21			*/
22
23			class COMMENTREPORT {
			0 ignored issues – show Coding Style Compatibility introduced 2017-07-12 14:20 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
24
25			public $report_id = '';
26			public $comment_id = '';
27			public $firstname = '';
28			public $lastname = '';
29			public $body = '';
30			public $reported = NULL; // datetime
31			public $resolved = NULL; // datetime
32			public $resolvedby = ''; // user_id
33			public $locked = NULL; // datetime
34			public $lockedby = ''; // user_id
35			public $upheld = ''; // boolean
36
37			// If the user was logged in, this will be set:
38			public $user_id = '';
39			// If the user wasn't logged in, this will be set:
40			public $email = '';
41
42
43			public function __construct($report_id='') {
44			// Pass it a report id and it gets and sets this report's data.
45
46			$this->db = new ParlDB;
			0 ignored issues – show Bug Best Practice introduced 2018-06-21 14:28 UTC by Report Bug Copy Issue Report The property `db` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
47
48			if (is_numeric($report_id)) {
49
50			$q = $this->db->query("SELECT commentreports.comment_id,
51			commentreports.user_id,
52			commentreports.body,
53			DATE_FORMAT(commentreports.reported, '" . SHORTDATEFORMAT_SQL . ' ' . TIMEFORMAT_SQL . "') AS reported,
54			DATE_FORMAT(commentreports.resolved, '" . SHORTDATEFORMAT_SQL . ' ' . TIMEFORMAT_SQL . "') AS resolved,
55			commentreports.resolvedby,
56			commentreports.locked,
57			commentreports.lockedby,
58			commentreports.upheld,
59			commentreports.firstname,
60			commentreports.lastname,
61			commentreports.email,
62			users.firstname AS u_firstname,
63			users.lastname AS u_lastname
64			FROM commentreports,
65			users
66			WHERE commentreports.report_id = :report_id
67			AND commentreports.user_id = users.user_id
68			", array(
69			':report_id' => $report_id
70			));
71
72			if ($q->rows() > 0) {
73			$this->report_id = $report_id;
74			$this->comment_id = $q->field(0, 'comment_id');
75			$this->body = $q->field(0, 'body');
76			$this->reported = $q->field(0, 'reported');
77			$this->resolved = $q->field(0, 'resolved');
78			$this->resolvedby = $q->field(0, 'resolvedby');
79			$this->locked = $q->field(0, 'locked');
80			$this->lockedby = $q->field(0, 'lockedby');
81			$this->upheld = $q->field(0, 'upheld');
82
83			if ($q->field(0, 'user_id') == 0) {
84			// The report was made by a non-logged-in user.
85			$this->firstname = $q->field(0, 'firstname');
86			$this->lastname = $q->field(0, 'lastname');
87			$this->email = $q->field(0, 'email');
88			} else {
89			// The report was made by a logged-in user.
90			$this->firstname = $q->field(0, 'u_firstname');
91			$this->lastname = $q->field(0, 'u_lastname');
92			$this->user_id = $q->field(0, 'user_id');
93			}
94			} else {
95			$q = $this->db->query("SELECT commentreports.comment_id,
96			commentreports.user_id,
97			commentreports.body,
98			DATE_FORMAT(commentreports.reported, '" . SHORTDATEFORMAT_SQL . ' ' . TIMEFORMAT_SQL . "') AS reported,
99			DATE_FORMAT(commentreports.resolved, '" . SHORTDATEFORMAT_SQL . ' ' . TIMEFORMAT_SQL . "') AS resolved,
100			commentreports.resolvedby,
101			commentreports.locked,
102			commentreports.lockedby,
103			commentreports.upheld,
104			commentreports.firstname,
105			commentreports.lastname,
106			commentreports.email
107			FROM commentreports
108			WHERE commentreports.report_id = :report_id", array(
109			':report_id' => $report_id
110			));
111
112			if ($q->rows() > 0) {
113			$this->report_id = $report_id;
114			$this->comment_id = $q->field(0, 'comment_id');
115			$this->body = $q->field(0, 'body');
116			$this->reported = $q->field(0, 'reported');
117			$this->resolved = $q->field(0, 'resolved');
118			$this->resolvedby = $q->field(0, 'resolvedby');
119			$this->locked = $q->field(0, 'locked');
120			$this->lockedby = $q->field(0, 'lockedby');
121			$this->upheld = $q->field(0, 'upheld');
122			$this->firstname = $q->field(0, 'firstname');
123			$this->lastname = $q->field(0, 'lastname');
124			$this->email = $q->field(0, 'email');
125			}
126			}
127			}
128			}
129
130
131			public function report_id() { return $this->report_id; }
132			public function comment_id() { return $this->comment_id; }
133			public function user_id() { return $this->user_id; }
134			public function user_name() { return $this->firstname . ' ' . $this->lastname; }
135			public function firstname() { return $this->firstname; }
136			public function lastname() { return $this->lastname; }
137			public function email() { return $this->email; }
138			public function body() { return $this->body; }
139			public function reported() { return $this->reported; }
140			public function resolved() { return $this->resolved; }
141			public function resolvedby() { return $this->resolvedby; }
142			public function locked() { return $this->locked; }
143			public function lockedby() { return $this->lockedby; }
144			public function upheld() { return $this->upheld; }
145
146			public function create($COMMENT, $reportdata) {
147			// For when a user posts a report on a comment.
148			// $reportdata is an array like:
149			// array (
150			// 'body' => 'some text',
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-07-12 14:20 UTC by Report Bug Copy Issue Report `58%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
151			// 'firstname' => 'Billy',
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-07-12 14:20 UTC by Report Bug Copy Issue Report `58%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
152			// 'lastname' => 'Nomates',
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-07-12 14:20 UTC by Report Bug Copy Issue Report `58%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
153			// 'email' => '[email protected]'
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-07-12 14:20 UTC by Report Bug Copy Issue Report `50%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
154			// )
155			// But if the report was made by a logged-in user, only the
156			// 'body' element should really contain anything, because
157			// we use $THEUSER's id to get the rest.
158
159			// $COMMENT is an existing COMMENT object, needed for setting
160			// its modflag and comment_id.
161
162			global $THEUSER, $PAGE;
			0 ignored issues – show Compatibility Best Practice introduced 2017-07-12 14:20 UTC by Report Bug Copy Issue Report Use of `global` functionality is not recommended; it makes your code harder to test, and less reusable. Instead of relying on `global` state, we recommend one of these alternatives: 1. Pass all data via parameters function myFunction($a, $b) { // Do something } 2. Create a class that maintains your state class MyClass { private $a; private $b; public function __construct($a, $b) { $this->a = $a; $this->b = $b; } public function myFunction() { // Do something } } Loading history...
163
164			if (!$THEUSER->is_able_to('reportcomment')) {
165			$PAGE->error_message ("Sorry, you are not allowed to post reports.");
166			return false;
167			}
168
169			if (is_numeric($THEUSER->user_id()) && $THEUSER->user_id() > 0) {
170			// Flood check - make sure the user hasn't just posted a report recently.
171			// To help prevent accidental duplicates, among other nasty things.
172			// (Non-logged in users are all id == 0.)
173
174			$flood_time_limit = 20; // How many seconds until a user can post again?
175
176			$q = $this->db->query("SELECT report_id
177			FROM commentreports
178			WHERE user_id = '" . $THEUSER->user_id() . "'
179			AND reported + 0 > NOW() - $flood_time_limit");
180
181			if ($q->rows() > 0) {
182			$PAGE->error_message("Sorry, we limit people to posting one report per $flood_time_limit seconds to help prevent duplicate reports. Please go back and try again, thanks.");
183			return false;
184			}
185			}
186
187
188			// Tidy up body.
189			$body = filter_user_input($reportdata['body'], 'comment'); // In utility.php
190
191			$time = gmdate("Y-m-d H:i:s");
192
193			if ($THEUSER->isloggedin()) {
194			$sql = "INSERT INTO commentreports
195			(comment_id, body, reported, user_id)
196			VALUES (:comment_id,
197			:body,
198			:time,
199			:user_id
200			)
201			";
202			$params = array(
203			':comment_id' => $COMMENT->comment_id(),
204			':body' => $body,
205			':time' => $time,
206			':user_id' => $THEUSER->user_id()
207			);
208			} else {
209			$sql = "INSERT INTO commentreports
210			(comment_id, body, reported, firstname, lastname, email)
211			VALUES (:comment_id,
212			:body,
213			:time,
214			:firstname,
215			:lastname,
216			:email
217			)
218			";
219			$params = array(
220			':comment_id' => $COMMENT->comment_id(),
221			':body' => $body,
222			':time' => $time,
223			':firstname' => $reportdata['firstname'],
224			':lastname' => $reportdata['lastname'],
225			':email' => $reportdata['email'],
226			);
227			}
228
229			$q = $this->db->query($sql, $params);
230
231			if ($q->success()) {
232			// Inserted OK, so set up this object's variables.
233			$this->report_id = $q->insert_id();
234			$this->comment_id = $COMMENT->comment_id();
235			$this->body = $body;
236			$this->reported = $time;
237
238			if ($THEUSER->isloggedin()) {
239			$this->user_id = $THEUSER->user_id();
240			$this->firstname = $THEUSER->firstname();
241			$this->lastname = $THEUSER->lastname();
242			} else {
243			$this->email = $reportdata['email'];
244			$this->firstname = $reportdata['firstname'];
245			$this->lastname = $reportdata['lastname'];
246			}
247
248
249			// Set the comment's modflag to on.
250			$COMMENT->set_modflag('on');
251
252
253			// Notify those who need to know that there's a new report.
254
255			$URL = new \MySociety\TheyWorkForYou\Url('admin_commentreport');
256			$URL->insert(array(
257			'rid'=>$this->report_id,
258			'cid'=>$this->comment_id
259			));
260
261			$emailbody = "A new comment report has been filed by " . $this->user_name() . ".\n\n";
262			$emailbody .= "COMMENT:\n" . $COMMENT->body() . "\n\n";
263			$emailbody .= "REPORT:\n" . $this->body . "\n\n";
264			$emailbody .= "To manage this report follow this link: https://" . DOMAIN . $URL->generate('none') . "\n";
			1 ignored issue – show Bug introduced 2018-06-21 14:28 UTC by Report Bug Copy Issue Report The constant `DOMAIN` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
265
266			send_email(REPORTLIST, 'New comment report', $emailbody);
			1 ignored issue – show Bug introduced 2018-06-21 14:28 UTC by Report Bug Copy Issue Report The constant `REPORTLIST` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
267
268
269			// Send an email to the user to thank them.
270
271			if ($THEUSER->isloggedin()) {
272			$email = $THEUSER->email();
273			} else {
274			$email = $this->email();
275			}
276
277			$data = array (
278			'to' => $email,
279			'template' => 'report_acknowledge'
280			);
281			$merge = array (
282			'FIRSTNAME' => $this->firstname(),
283			'LASTNAME' => $this->lastname(),
284			'COMMENTURL' => "https://" . DOMAIN . $COMMENT->url(),
285			'REPORTBODY' => strip_tags($this->body())
286			);
287
288
289			// send_template_email in utility.php.
290			send_template_email($data, $merge);
291
292			return true;
293			} else {
294			return false;
295			}
296
297			}
298
299
300			public function display() {
301
302			$data = array();
303
304			if (is_numeric($this->report_id)) {
305			$data = array (
306			'report_id' => $this->report_id(),
307			'comment_id' => $this->comment_id(),
308			'user_id' => $this->user_id(),
309			'user_name' => $this->user_name(),
310			'body' => $this->body(),
311			'reported' => $this->reported(),
312			'resolved' => $this->resolved(),
313			'resolvedby' => $this->resolvedby(),
314			'locked' => $this->locked(),
315			'lockedby' => $this->lockedby(),
316			'upheld' => $this->upheld()
317			);
318			}
319
320			$this->render($data);
321			}
322
323
324
325			public function render($data) {
326			global $PAGE;
			0 ignored issues – show Compatibility Best Practice introduced 2017-07-12 14:20 UTC by Report Bug Copy Issue Report Use of `global` functionality is not recommended; it makes your code harder to test, and less reusable. Instead of relying on `global` state, we recommend one of these alternatives: 1. Pass all data via parameters function myFunction($a, $b) { // Do something } 2. Create a class that maintains your state class MyClass { private $a; private $b; public function __construct($a, $b) { $this->a = $a; $this->b = $b; } public function myFunction() { // Do something } } Loading history...
327
328			$PAGE->display_commentreport($data);
329
330			}
331
332
333			public function lock() {
334			// Called when an admin user goes to examine a report, so that
335			// only one person can edit at once.
336
337			global $THEUSER, $PAGE;
			0 ignored issues – show Compatibility Best Practice introduced 2017-07-12 14:20 UTC by Report Bug Copy Issue Report Use of `global` functionality is not recommended; it makes your code harder to test, and less reusable. Instead of relying on `global` state, we recommend one of these alternatives: 1. Pass all data via parameters function myFunction($a, $b) { // Do something } 2. Create a class that maintains your state class MyClass { private $a; private $b; public function __construct($a, $b) { $this->a = $a; $this->b = $b; } public function myFunction() { // Do something } } Loading history...
338
339			if ($THEUSER->is_able_to('deletecomment')) {
340			$time = gmdate("Y-m-d H:i:s");
341
342			$q = $this->db->query ("UPDATE commentreports
343			SET locked = '$time',
344			lockedby = '" . $THEUSER->user_id() . "'
345			WHERE report_id = '" . $this->report_id . "'
346			");
347
348			if ($q->success()) {
349			$this->locked = $time;
350			$this->lockedby = $THEUSER->user_id();
351			return true;
352			} else {
353			$PAGE->error_message ("Sorry, we were unable to lock this report.");
354			return false;
355			}
356			} else {
357			$PAGE->error_message ("You are not authorised to delete annotations.");
358			return false;
359			}
360			}
361
362
363			public function unlock() {
364			// Unlock a comment so it can be examined by someone else.
365
366			$q = $this->db->query ("UPDATE commentreports
367			SET locked = NULL,
368			lockedby = NULL
369			WHERE report_id = '" . $this->report_id . "'
370			");
371
372			if ($q->success()) {
373			$this->locked = NULL;
374			$this->lockedby = NULL;
375			return true;
376			} else {
377			return false;
378			}
379			}
380
381
382
383			public function resolve($upheld, $COMMENT) {
384			// Resolve a report.
385			// $upheld is true or false.
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-07-12 14:20 UTC by Report Bug Copy Issue Report `37%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
386			// $COMMENT is an existing COMMENT object - we need this so
387			// that we can set its modflagged to off and/or delete it.
388			global $THEUSER, $PAGE;
			0 ignored issues – show Compatibility Best Practice introduced 2017-07-12 14:20 UTC by Report Bug Copy Issue Report Use of `global` functionality is not recommended; it makes your code harder to test, and less reusable. Instead of relying on `global` state, we recommend one of these alternatives: 1. Pass all data via parameters function myFunction($a, $b) { // Do something } 2. Create a class that maintains your state class MyClass { private $a; private $b; public function __construct($a, $b) { $this->a = $a; $this->b = $b; } public function myFunction() { // Do something } } Loading history...
389
390			$time = gmdate("Y-m-d H:i:s");
391
392			if ($THEUSER->is_able_to('deletecomment')) {
393			// User is allowed to do this.
394
395			if (!$this->resolved) {
396			// Only if this report hasn't been previously resolved.
397
398			if ($upheld) {
399
400			$success = $COMMENT->delete();
401
402			if (!$success) {
403			// Abort!
404			return false;
405			}
406
407			$upheldsql = 1;
408
409			} else {
410			$upheldsql = 0;
411
412			// Report has been removed, so un-modflag this comment.
413			$COMMENT->set_modflag('off');
414			}
415
416			$q = $this->db->query("UPDATE commentreports
417			SET resolved = :time,
418			resolvedby = :resolved_by,
419			locked = NULL,
420			lockedby = NULL,
421			upheld = :upheld
422			WHERE report_id = :report_id
423			", array(
424			':time' => $time,
425			':resolved_by' => $THEUSER->user_id(),
426			':upheld' => $upheldsql,
427			':report_id' => $this->report_id
428			));
429
430			if ($q->success()) {
431
432			$this->resolved = $time;
433			$this->resolvedby = $THEUSER->user_id();
434			$this->locked = NULL;
435			$this->lockedby = NULL;
436			$this->upheld = $upheld;
437
438			return true;
439			} else {
440			$PAGE->error_message ("Sorry, we couldn't resolve this report.");
441			return false;
442			}
443			} else {
444			$PAGE->error_message ("This report has already been resolved (on " . $this->resolved . ")");
445			return false;
446			}
447
448			} else {
449			$PAGE->error_message ("You are not authorised to resolve reports.");
450			return false;
451			}
452			}
453
454
455
456			}
457

mysociety / theyworkforyou

Branch — master (3ce7e2)

COMMENTREPORT::resolve() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

Duplication Side-by-Side

Filter issues like