MySociety\TheyWorkForYou\AlertView\Standard

Complexity

Total Complexity

84

Size/Duplication

Total Lines	363
Duplicated Lines	0 %

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
D	addAlert()	0	43	10
A	setUserData()	0	11	4
A	display()	0	19	4
C	formatSearchMemberData()	0	34	7
A	formatSearchTerms()	0	6	2
C	prettifyCriteria()	0	24	8
B	checkForCommonMistakes()	0	22	6
B	getBasicData()	0	26	5
C	processAction()	0	35	11
B	getUsersAlerts()	0	29	4
D	searchForConstituenciesAndMembers()	0	35	10
A	__construct()	0	3	1
D	checkInput()	0	43	12

<?php

For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 12 and the first side effect is on line 5.

namespace MySociety\TheyWorkForYou\AlertView;

include_once '../../../www/includes/easyparliament/init.php';
include_once INCLUDESPATH . "easyparliament/people.php";

The constant MySociety\TheyWorkForYou\AlertView\INCLUDESPATH was not found. Maybe you did not declare it correctly or list all dependencies?

include_once INCLUDESPATH . "easyparliament/member.php";
include_once INCLUDESPATH . "easyparliament/searchengine.php";
include_once INCLUDESPATH . '../../commonlib/phplib/auth.php';
include_once INCLUDESPATH . '../../commonlib/phplib/crosssell.php';

class Standard extends \MySociety\TheyWorkForYou\AlertView {
    public $data;

    public function __construct($THEUSER = NULL) {
        parent::__construct($THEUSER);
        $this->data = array();
    }

    public function display() {
        global $this_page;

Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

        $this_page = "alert";

        $this->processAction();
        $this->getBasicData();
        $this->checkInput();
        $this->searchForConstituenciesAndMembers();

        if (!sizeof($this->data['errors']) && ($this->data['keyword'] || $this->data['pid'])) {
            $this->addAlert();
        }

        $this->formatSearchTerms();
        $this->checkForCommonMistakes();
        $this->formatSearchMemberData();
        $this->setUserData();

        return $this->data;
    }

    private function processAction() {
        $token = get_http_var('t');
        $alert = $this->alert->check_token($token);

        $this->data['results'] = false;
        if ($action = get_http_var('action')) {
            $success = true;
            if ($action == 'Confirm') {
                $success = $this->confirmAlert($token);
                if ($success) {
                    $this->data['results'] = 'alert-confirmed';
                    $this->data['criteria'] = $this->prettifyCriteria($this->alert->criteria);
                }
            } elseif ($action == 'Suspend') {
                $success = $this->suspendAlert($token);
                if ($success) {
                    $this->data['results'] = 'alert-suspended';
                }
            } elseif ($action == 'Resume') {
                $success = $this->resumeAlert($token);
                if ($success) {
                    $this->data['results'] = 'alert-resumed';
                }
            } elseif ($action == 'Delete') {
                $success = $this->deleteAlert($token);
                if ($success) {
                    $this->data['results'] = 'alert-deleted';
                }
            }
            if (!$success) {
                $this->data['results'] = 'alert-fail';
            }
        }

        $this->data['alert'] = $alert;
    }


    private function getBasicData() {
        global $this_page;

Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

        if ($this->user->loggedin()) {
            $this->data['email'] = $this->user->email();
            $this->data['email_verified'] = true;
        } elseif ($this->data['alert']) {
            $this->data['email'] = $this->data['alert']['email'];
            $this->data['email_verified'] = true;
        } else {
            $this->data["email"] = trim(get_http_var("email"));
            $this->data['email_verified'] = false;
        }
        $this->data['keyword'] = trim(get_http_var("keyword"));
        $this->data['pid'] = trim(get_http_var("pid"));
        $this->data['alertsearch'] = trim(get_http_var("alertsearch"));
        $this->data['pc'] = get_http_var('pc');
        $this->data['submitted'] = get_http_var('submitted') || $this->data['pid'] || $this->data['keyword'];
        $this->data['token'] = get_http_var('t');
        $this->data['sign'] = get_http_var('sign');
        $this->data['site'] = get_http_var('site');
        $this->data['message'] = '';

        $ACTIONURL = new \MySociety\TheyWorkForYou\Url($this_page);
        $ACTIONURL->reset();
        $this->data['actionurl'] = $ACTIONURL->generate();
    }

    private function checkInput() {
        global $SEARCHENGINE;

Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

        $errors = array();

        // Check each of the things the user has input.
        // If there is a problem with any of them, set an entry in the $errors array.
        // This will then be used to (a) indicate there were errors and (b) display
        // error messages when we show the form again.

        // Check email address is valid and unique.
        if (!$this->data['email']) {
            $errors["email"] = "Please enter your email address";
        } elseif (!validate_email($this->data["email"])) {
            // validate_email() is in includes/utilities.php
            $errors["email"] = "Please enter a valid email address";
        }

        if ($this->data['pid'] && !ctype_digit($this->data['pid'])) {
            $errors['pid'] = 'Invalid person ID passed';
        }

        $text = $this->data['alertsearch'];
        if (!$text) $text = $this->data['keyword'];

        if ($this->data['submitted'] && !$this->data['pid'] && !$text) {
            $errors['alertsearch'] = 'Please enter what you want to be alerted about';
        }

        if (strpos($text, '..')) {
            $errors['alertsearch'] = 'You probably don’t want a date range as part of your criteria, as you won’t be alerted to anything new!';
        }

        $se = new \SEARCHENGINE($text);
        if (!$se->valid) {
            $errors['alertsearch'] = 'That search appears to be invalid - ' . $se->error . ' - please check and try again.';
        }

        if (strlen($text) > 255) {
            $errors['alertsearch'] = 'That search is too long for our database; please split it up into multiple smaller alerts.';
        }

        $this->data['errors'] = $errors;
    }

    private function searchForConstituenciesAndMembers() {
        // Do the search
        if ($this->data['alertsearch']) {
            $this->data['members'] = \MySociety\TheyWorkForYou\Utility\Search::searchMemberDbLookupWithNames($this->data['alertsearch'], true);
            list ($this->data['constituencies'], $this->data['valid_postcode']) = \MySociety\TheyWorkForYou\Utility\Search::searchConstituenciesByQuery($this->data['alertsearch']);
        }

        # If the above search returned one result for member or constituency search,
        # use it immediately

        if (isset($this->data['members']) && $this->data['members']->rows() == 1) {
            $this->data['pid'] = $this->data['members']->field(0, 'person_id');
            unset($this->data['members']);
            $this->data['alertsearch'] = '';
        }

        if (isset($this->data['constituencies']) && count($this->data['constituencies']) == 1 && $this->data['valid_postcode']) {
            $MEMBER = new \MEMBER(array('constituency' => $this->data['constituencies'][0], 'house' => 1));
            $this->data['pid'] = $MEMBER->person_id();
            $this->data['pc'] = $this->data['alertsearch'];
            unset($this->data['constituencies']);
            $this->data['alertsearch'] = '';
        }

        if (isset($this->data['constituencies'])) {
            $cons = array();
            foreach ($this->data['constituencies'] as $constituency) {
                try {
                    $MEMBER = new \MEMBER(array('constituency'=>$constituency, 'house' => 1));
                    $cons[$constituency] = $MEMBER;
                } catch ( \MySociety\TheyWorkForYou\MemberException $e ) {
                    // do nothing
                }
            }
            $this->data['constituencies'] = $cons;
        }
    }

    private function addAlert() {
        $external_auth = auth_verify_with_shared_secret($this->data['email'], OPTION_AUTH_SHARED_SECRET, get_http_var('sign'));

The constant MySociety\TheyWorkForYou\AlertView\OPTION_AUTH_SHARED_SECRET was not found. Maybe you did not declare it correctly or list all dependencies?

        if ($external_auth) {
            $confirm = false;
        } elseif ($this->data['email_verified']) {
            $confirm = false;
        } else {
            $confirm = true;
        }

        // If this goes well, the alert will be added to the database and a confirmation email
        // will be sent to them.
        $success = $this->alert->add( $this->data, $confirm );

        if ($success>0 && !$confirm) {
            $result = 'alert-added';
        } elseif ($success>0) {
            $result = 'alert-confirmation';
        } elseif ($success == -2) {
            // we need to make sure we know that the person attempting to sign up
            // for the alert has that email address to stop people trying to work
            // out what alerts they are signed up to
            if ( $this->data['email_verified'] || ( $this->user->loggedin && $this->user->email() == $this->data['email'] ) ) {
                $result = 'alert-exists';
            } else {
                // don't throw an error message as that implies that they have already signed
                // up for the alert but instead pretend all is normal but send an email saying
                // that someone tried to sign them up for an existing alert
                $result = 'alert-already-signed';
                $this->alert->send_already_signedup_email($this->data);
            }
        } else {
            $result = 'alert-fail';
        }

        // don't need these anymore so get rid of them
        $this->data['keyword'] = '';
        $this->data['pid'] = '';
        $this->data['alertsearch'] = '';
        $this->data['pc'] = '';

        $this->data['results'] = $result;
        $this->data['criteria'] = $this->prettifyCriteria($this->alert->criteria);
    }


    private function formatSearchTerms() {
        if ( $this->data['alertsearch'] ) {
            $this->data['alertsearch_pretty'] = $this->prettifyCriteria($this->data['alertsearch']);
            $this->data['search_text'] = $this->data['alertsearch'];
        } else {
            $this->data['search_text'] = $this->data['keyword'];
        }
    }

    private function prettifyCriteria($alert_criteria) {
        $text = '';
        if ( $alert_criteria ) {
            $criteria = explode(' ', $alert_criteria);
            $words = array();
            $spokenby = array_values(\MySociety\TheyWorkForYou\Utility\Search::speakerNamesForIDs($alert_criteria));

            foreach ($criteria as $c) {
                if (!preg_match('#^speaker:(\d+)#',$c,$m)) {
                    $words[] = $c;
                }
            }
            if ( $spokenby && count($words) ) {

The expression $spokenby of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

                $text = implode(' or ', $spokenby) . ' mentions [' . implode(' ', $words) . ']';
            } else if ( count( $words ) ) {
                $text = '[' . implode(' ', $words) . ']' . ' is mentioned';
            } else if ( $spokenby ) {

The expression $spokenby of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

                $text = implode(' or ', $spokenby) . " speaks";
            }

            return $text;
        }

        return $text;
    }

    private function checkForCommonMistakes() {
        $mistakes = array();
        if (strstr($this->data['alertsearch'], ',') > -1) {
            $mistakes['multiple'] = 1;
        }

        if (
                preg_match('#([A-Z]{1,2}\d+[A-Z]? ?\d[A-Z]{2})#i', $this->data['alertsearch'], $m) &&
                strlen($this->data['alertsearch']) > strlen($m[1]) &&
                validate_postcode($m[1])
        ) {
            $this->data['postcode'] = $m[1];
            $this->data['scottish_text'] = '';
            $this->data['mp_display_text'] = '';
            if (\MySociety\TheyWorkForYou\Utility\Postcode::postcodeIsScottish($m[1])) {
                $this->data['mp_display_text'] = 'your MP, ';
                $this->data['scottish_text'] = ' or MSP';
            }
            $mistakes['postcode_and'] = 1;
        }

        $this->data['mistakes'] = $mistakes;
    }

    private function formatSearchMemberData() {
        if ( isset($this->data['postcode']) ) {
            try {
                $postcode = $this->data['postcode'];

                $MEMBER = new \MEMBER( array('postcode' => $postcode) );
                // move the postcode to the front just to be tidy
                $tidy_alertsearch = $postcode . " " . trim(str_replace("$postcode", "", $this->data['alertsearch']));
                $alertsearch_display = str_replace("$postcode ", "", $tidy_alertsearch);

                $this->data['member_alertsearch'] = str_replace("$postcode", "speaker:" . $MEMBER->person_id, $tidy_alertsearch);
                $this->data['member_displaysearch'] = $alertsearch_display;
                $this->data['member'] = $MEMBER;

                if ( $this->data['scottish_text'] ) {
                    $constituencies = \MySociety\TheyWorkForYou\Utility\Postcode::postcodeToConstituencies($postcode);
                    if ( isset($constituencies['SPC']) ) {
                        $MEMBER = new \MEMBER(array('constituency' => $constituencies['SPC'], 'house' => 4));
                        $this->data['scottish_alertsearch'] = str_replace("$postcode", "speaker:" . $MEMBER->person_id, $tidy_alertsearch);
                        $this->data['scottish_member'] = $MEMBER;
                    }
                }
            } catch ( \MySociety\TheyWorkForYou\MemberException $e ) {
                $this->data['member_error'] = 1;
            }
        }

        if ( $this->data['pid'] ) {
            $MEMBER = new \MEMBER( array('person_id' => $this->data['pid']) );
            $this->data['pid_member'] = $MEMBER;
        }

        if ( $this->data['keyword'] ) {
            $this->data['display_keyword'] = $this->prettifyCriteria($this->data['keyword']);
        }
    }

    private function setUserData() {
        $this->data['current_mp'] = false;
        $this->data['alerts'] = array();
        if ($this->data['email_verified']) {
            if ($this->user->postcode()) {
                $current_mp = new \MEMBER(array('postcode' => $this->user->postcode()));
                if (!$this->alert->fetch_by_mp($this->user->email(), $current_mp->person_id())) {
                    $this->data['current_mp'] = $current_mp;
                }
            }
            $this->data['alerts'] = $this->getUsersAlerts();
        }
    }

    private function getUsersAlerts() {
        $q = $this->db->query('SELECT * FROM alerts WHERE email = :email
            AND deleted != 1 ORDER BY created', array(
                ':email' => $this->data['email']
            ));

        $alerts = array();
        $num_alerts = $q->rows();
        for ($i = 0; $i < $num_alerts; $i++) {
            $row = $q->row($i);
            $criteria = $this->prettifyCriteria($row['criteria']);
            $token = $row['alert_id'] . '-' . $row['registrationtoken'];

            $status = 'confirmed';
            if ( !$row['confirmed'] ) {
                $status = 'unconfirmed';
            } elseif ( $row['deleted'] == 2 ) {
                $status = 'suspended';
            }

            $alerts[] = array(
                'token' => $token,
                'status' => $status,
                'criteria' => $criteria,
                'raw' => $row['criteria']
            );
        }

        return $alerts;
    }

}