Subscribe::handlePostData() - Code Metrics - Inspection of "have all subscription handling in subscribe action" - splitbrain/dokuwiki - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — actionrefactor ( 0f9e19...272271 )

by Andreas

created 2017-05-18 11:09 UTC

Subscribe::handlePostData() C

↳ Parent: Subscribe

Complexity

Conditions	9
Paths	11

Size

Total Lines	51
Code Lines	32

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	9
eloc	32
nc	11
nop	1
dl	0
loc	51
rs	6.2727
c	0
b	0
f	0

How to fix Long Method

<?php

namespace dokuwiki\Action;

use dokuwiki\Action\Exception\ActionAbort;
use dokuwiki\Action\Exception\ActionDisabledException;

/**
 * Class Subscribe
 *
 * E-Mail subscription handling
 *
 * @package dokuwiki\Action
 */
class Subscribe extends AbstractUserAction {

    /** @inheritdoc */
    public function minimumPermission() {
        return AUTH_READ;
    }

    /** @inheritdoc */
    public function checkPermissions() {
        parent::checkPermissions();

        global $conf;
        if(isset($conf['subscribers']) && !$conf['subscribers']) throw new ActionDisabledException();
    }

    /** @inheritdoc */
    public function preProcess() {
        try {
            $this->handleSubscribeData();
        } catch(ActionAbort $e) {
            throw $e;
        } catch(\Exception $e) {
            msg($e->getMessage(), -1);
        }
    }

    /** @inheritdoc */
    public function tplContent() {
        tpl_subscribe();
    }

    /**
     * Handle page 'subscribe'
     *
     * @author Adrian Lang <[email protected]>
     * @throws \Exception if (un)subscribing fails
     * @throws ActionAbort when (un)subscribing worked
     */
    protected function handleSubscribeData() {
        global $lang;
        global $INFO;
        global $INPUT;

        // get and preprocess data.
        $params = array();
        foreach(array('target', 'style', 'action') as $param) {
            if($INPUT->has("sub_$param")) {
                $params[$param] = $INPUT->str("sub_$param");
            }
        }

        // any action given? if not just return and show the subscription page
        if(empty($params['action']) || !checkSecurityToken()) return;

        // Handle POST data, may throw exception.
        trigger_event('ACTION_HANDLE_SUBSCRIBE', $params, array($this, 'handlePostData'));

        $target = $params['target'];
        $style = $params['style'];
        $action = $params['action'];

        // Perform action.
        $sub = new \Subscription();
        if($action == 'unsubscribe') {
            $ok = $sub->remove($target, $INPUT->server->str('REMOTE_USER'), $style);
        } else {
            $ok = $sub->add($target, $INPUT->server->str('REMOTE_USER'), $style);
        }

        if($ok) {
            msg(
                sprintf(
                    $lang["subscr_{$action}_success"], hsc($INFO['userinfo']['name']),
                    prettyprint_id($target)
                ), 1
            );
            throw new ActionAbort('redirect');
        } else {
            throw new \Exception(
                sprintf(
                    $lang["subscr_{$action}_error"],
                    hsc($INFO['userinfo']['name']),
                    prettyprint_id($target)
                )
            );
        }
    }

    /**
     * Validate POST data
     *
     * Validates POST data for a subscribe or unsubscribe request. This is the
     * default action for the event ACTION_HANDLE_SUBSCRIBE.
     *
     * @author Adrian Lang <[email protected]>
     *
     * @param array &$params the parameters: target, style and action
     * @throws \Exception
     */
    public function handlePostData(&$params) {
        global $INFO;
        global $lang;
        global $INPUT;

        // Get and validate parameters.
        if(!isset($params['target'])) {
            throw new \Exception('no subscription target given');
        }
        $target = $params['target'];
        $valid_styles = array('every', 'digest');
        if(substr($target, -1, 1) === ':') {
            // Allow “list” subscribe style since the target is a namespace.
            $valid_styles[] = 'list';
        }
        $style = valid_input_set(
            'style', $valid_styles, $params,
            'invalid subscription style given'
        );
        $action = valid_input_set(
            'action', array('subscribe', 'unsubscribe'),
            $params, 'invalid subscription action given'
        );

        // Check other conditions.
        if($action === 'subscribe') {
            if($INFO['userinfo']['mail'] === '') {
                throw new \Exception($lang['subscr_subscribe_noaddress']);
            }
        } elseif($action === 'unsubscribe') {
            $is = false;
            foreach($INFO['subscribed'] as $subscr) {
                if($subscr['target'] === $target) {
                    $is = true;
                }
            }
            if($is === false) {
                throw new \Exception(
                    sprintf(
                        $lang['subscr_not_subscribed'],
                        $INPUT->server->str('REMOTE_USER'),
                        prettyprint_id($target)
                    )
                );
            }
            // subscription_set deletes a subscription if style = null.
            $style = null;
        }

        $params = compact('target', 'style', 'action');
    }

}


1			<?php
2
3			namespace dokuwiki\Action;
4
5			use dokuwiki\Action\Exception\ActionAbort;
6			use dokuwiki\Action\Exception\ActionDisabledException;
7
8			/**
9			* Class Subscribe
10			*
11			* E-Mail subscription handling
12			*
13			* @package dokuwiki\Action
14			*/
15			class Subscribe extends AbstractUserAction {
16
17			/** @inheritdoc */
18			public function minimumPermission() {
19			return AUTH_READ;
20			}
21
22			/** @inheritdoc */
23			public function checkPermissions() {
24			parent::checkPermissions();
25
26			global $conf;
27			if(isset($conf['subscribers']) && !$conf['subscribers']) throw new ActionDisabledException();
28			}
29
30			/** @inheritdoc */
31			public function preProcess() {
32			try {
33			$this->handleSubscribeData();
34			} catch(ActionAbort $e) {
35			throw $e;
36			} catch(\Exception $e) {
37			msg($e->getMessage(), -1);
38			}
39			}
40
41			/** @inheritdoc */
42			public function tplContent() {
43			tpl_subscribe();
44			}
45
46			/**
47			* Handle page 'subscribe'
48			*
49			* @author Adrian Lang <[email protected]>
50			* @throws \Exception if (un)subscribing fails
51			* @throws ActionAbort when (un)subscribing worked
52			*/
53			protected function handleSubscribeData() {
54			global $lang;
55			global $INFO;
56			global $INPUT;
57
58			// get and preprocess data.
59			$params = array();
60			foreach(array('target', 'style', 'action') as $param) {
61			if($INPUT->has("sub_$param")) {
62			$params[$param] = $INPUT->str("sub_$param");
63			}
64			}
65
66			// any action given? if not just return and show the subscription page
67			if(empty($params['action']) \|\| !checkSecurityToken()) return;
68
69			// Handle POST data, may throw exception.
70			trigger_event('ACTION_HANDLE_SUBSCRIBE', $params, array($this, 'handlePostData'));
71
72			$target = $params['target'];
73			$style = $params['style'];
74			$action = $params['action'];
75
76			// Perform action.
77			$sub = new \Subscription();
78			if($action == 'unsubscribe') {
79			$ok = $sub->remove($target, $INPUT->server->str('REMOTE_USER'), $style);
80			} else {
81			$ok = $sub->add($target, $INPUT->server->str('REMOTE_USER'), $style);
82			}
83
84			if($ok) {
85			msg(
86			sprintf(
87			$lang["subscr_{$action}_success"], hsc($INFO['userinfo']['name']),
88			prettyprint_id($target)
89			), 1
90			);
91			throw new ActionAbort('redirect');
92			} else {
93			throw new \Exception(
94			sprintf(
95			$lang["subscr_{$action}_error"],
96			hsc($INFO['userinfo']['name']),
97			prettyprint_id($target)
98			)
99			);
100			}
101			}
102
103			/**
104			* Validate POST data
105			*
106			* Validates POST data for a subscribe or unsubscribe request. This is the
107			* default action for the event ACTION_HANDLE_SUBSCRIBE.
108			*
109			* @author Adrian Lang <[email protected]>
110			*
111			* @param array &$params the parameters: target, style and action
112			* @throws \Exception
113			*/
114			public function handlePostData(&$params) {
115			global $INFO;
116			global $lang;
117			global $INPUT;
118
119			// Get and validate parameters.
120			if(!isset($params['target'])) {
121			throw new \Exception('no subscription target given');
122			}
123			$target = $params['target'];
124			$valid_styles = array('every', 'digest');
125			if(substr($target, -1, 1) === ':') {
126			// Allow “list” subscribe style since the target is a namespace.
127			$valid_styles[] = 'list';
128			}
129			$style = valid_input_set(
130			'style', $valid_styles, $params,
131			'invalid subscription style given'
132			);
133			$action = valid_input_set(
134			'action', array('subscribe', 'unsubscribe'),
135			$params, 'invalid subscription action given'
136			);
137
138			// Check other conditions.
139			if($action === 'subscribe') {
140			if($INFO['userinfo']['mail'] === '') {
141			throw new \Exception($lang['subscr_subscribe_noaddress']);
142			}
143			} elseif($action === 'unsubscribe') {
144			$is = false;
145			foreach($INFO['subscribed'] as $subscr) {
146			if($subscr['target'] === $target) {
147			$is = true;
148			}
149			}
150			if($is === false) {
151			throw new \Exception(
152			sprintf(
153			$lang['subscr_not_subscribed'],
154			$INPUT->server->str('REMOTE_USER'),
155			prettyprint_id($target)
156			)
157			);
158			}
159			// subscription_set deletes a subscription if style = null.
160			$style = null;
161			}
162
163			$params = compact('target', 'style', 'action');
164			}
165
166			}
167

splitbrain / dokuwiki

Push — actionrefactor ( 0f9e19...272271 )

Subscribe::handlePostData() C

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like