PageWelcomeTemplateManagement::getSecurityConfiguration() - Code Metrics - Inspection of "Fix two XSS vulns" - enwikipedia-acc/waca - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — newinternal ( 65a0f5...5b021c )

by Simon

created 2020-04-26 13:09 UTC

PageWelcomeTemplateManagement::getSecurityConfiguration() B

↳ Parent: Project

Complexity

Conditions	6
Paths	6

Size

Total Lines	16
Code Lines	11

Duplication

Lines	16
Ratio	100 %

Code Coverage

Tests	0
CRAP Score	42

Importance

Changes

Metric	Value
cc	6
eloc	11
nc	6
nop	0
dl	16
loc	16
rs	8.8571
c	0
b	0
f	0
ccs	0
cts	14
cp	0
crap	42

<?php
/******************************************************************************
 * Wikipedia Account Creation Assistance tool                                 *
 *                                                                            *
 * All code in this file is released into the public domain by the ACC        *
 * Development Team. Please see team.json for a list of contributors.         *
 ******************************************************************************/

namespace Waca\Pages;

use Exception;
use Waca\DataObjects\User;
use Waca\DataObjects\WelcomeTemplate;
use Waca\Exceptions\ApplicationLogicException;
use Waca\Helpers\Logger;
use Waca\SessionAlert;
use Waca\Tasks\InternalPageBase;
use Waca\WebRequest;

class PageWelcomeTemplateManagement extends InternalPageBase
{
    /**
     * Main function for this page, when no specific actions are called.
     * @return void
     */
    protected function main()
    {
        $templateList = WelcomeTemplate::getAll($this->getDatabase());

        $this->assignCSRFToken();

        $user = User::getCurrent($this->getDatabase());
        $this->assign('canEdit', $this->barrierTest('edit', $user));
        $this->assign('canAdd', $this->barrierTest('add', $user));

        $this->assign('templateList', $templateList);
        $this->setTemplate('welcome-template/list.tpl');
    }

    /**
     * Handles the requests for selecting a template to use.
     *
     * @throws ApplicationLogicException
     */
    protected function select()
    {
        // get rid of GETs
        if (!WebRequest::wasPosted()) {
            $this->redirect('welcomeTemplates');
        }

        $this->validateCSRFToken();

        $user = User::getCurrent($this->getDatabase());

        if (WebRequest::postBoolean('disable')) {
            $user->setWelcomeTemplate(null);
            $user->save();

            SessionAlert::success('Disabled automatic user welcoming.');
            $this->redirect('welcomeTemplates');

            return;
        }

        $database = $this->getDatabase();

        $templateId = WebRequest::postInt('template');
        /** @var false|WelcomeTemplate $template */
        $template = WelcomeTemplate::getById($templateId, $database);

        if ($template === false || $template->isDeleted()) {
            throw new ApplicationLogicException('Unknown template');
        }

        $user->setWelcomeTemplate($template->getId());
        $user->save();

        SessionAlert::success("Updated selected welcome template for automatic welcoming.");

        $this->redirect('welcomeTemplates');
    }

    /**
     * Handles the requests for viewing a template.
     *
     * @throws ApplicationLogicException
     */
    protected function view()
    {
        $database = $this->getDatabase();

        $templateId = WebRequest::getInt('template');

        /** @var WelcomeTemplate $template */
        $template = WelcomeTemplate::getById($templateId, $database);

        if ($template === false) {
            throw new ApplicationLogicException('Cannot find requested template');
        }

        $templateHtml = $this->getWikiTextHelper()->getHtmlForWikiText($template->getBotCode());

        $this->assign('templateHtml', $templateHtml);
        $this->assign('template', $template);
        $this->setTemplate('welcome-template/view.tpl');
    }

    /**
     * Handler for the add action to create a new welcome template
     *
     * @throws Exception
     */
    protected function add()
    {
        if (WebRequest::wasPosted()) {
            $this->validateCSRFToken();
            $database = $this->getDatabase();

            $userCode = WebRequest::postString('usercode');
            $botCode = WebRequest::postString('botcode');

            $this->validate($userCode, $botCode);

            $template = new WelcomeTemplate();
            $template->setDatabase($database);
            $template->setUserCode($userCode);
            $template->setBotCode($botCode);
            $template->save();

            Logger::welcomeTemplateCreated($database, $template);

            $this->getNotificationHelper()->welcomeTemplateCreated($template);

            SessionAlert::success("Template successfully created.");

            $this->redirect('welcomeTemplates');
        }
        else {
            $this->assignCSRFToken();
            $this->setTemplate("welcome-template/add.tpl");
        }
    }

    /**
     * Hander for editing templates
     */
    protected function edit()
    {
        $database = $this->getDatabase();

        $templateId = WebRequest::getInt('template');

        /** @var WelcomeTemplate $template */
        $template = WelcomeTemplate::getById($templateId, $database);

        if ($template === false) {
            throw new ApplicationLogicException('Cannot find requested template');
        }

        if ($template->isDeleted()) {
            throw new ApplicationLogicException('The specified template has been deleted');
        }

        if (WebRequest::wasPosted()) {
            $this->validateCSRFToken();

            $userCode = WebRequest::postString('usercode');
            $botCode = WebRequest::postString('botcode');

            $this->validate($userCode, $botCode);

            $template->setUserCode($userCode);
            $template->setBotCode($botCode);
            $template->setUpdateVersion(WebRequest::postInt('updateversion'));
            $template->save();

            Logger::welcomeTemplateEdited($database, $template);

            SessionAlert::success("Template updated.");

            $this->getNotificationHelper()->welcomeTemplateEdited($template);

            $this->redirect('welcomeTemplates');
        }
        else {
            $this->assignCSRFToken();
            $this->assign('template', $template);
            $this->setTemplate('welcome-template/edit.tpl');
        }
    }

    protected function delete()
    {
        $this->redirect('welcomeTemplates');

        if (!WebRequest::wasPosted()) {
            return;
        }

        $this->validateCSRFToken();

        $database = $this->getDatabase();

        $templateId = WebRequest::postInt('template');
        $updateVersion = WebRequest::postInt('updateversion');

        /** @var WelcomeTemplate $template */
        $template = WelcomeTemplate::getById($templateId, $database);

        if ($template === false || $template->isDeleted()) {
            throw new ApplicationLogicException('Cannot find requested template');
        }

        // set the update version to the version sent by the client (optimisticly lock from initial page load)
        $template->setUpdateVersion($updateVersion);

        $database
            ->prepare("UPDATE user SET welcome_template = NULL WHERE welcome_template = :id;")
            ->execute(array(":id" => $templateId));

        Logger::welcomeTemplateDeleted($database, $template);

        $template->delete();

        SessionAlert::success(
            "Template deleted. Any users who were using this template have had automatic welcoming disabled.");
        $this->getNotificationHelper()->welcomeTemplateDeleted($templateId);
    }

    private function validate($userCode, $botCode)
    {
        if ($userCode === null) {
            throw new ApplicationLogicException('User code cannot be null');
        }

        if ($botCode === null) {
            throw new ApplicationLogicException('Bot code cannot be null');
        }
    }
}


1			<?php
2			/******************************************************************************
3			* Wikipedia Account Creation Assistance tool *
4			* *
5			* All code in this file is released into the public domain by the ACC *
6			* Development Team. Please see team.json for a list of contributors. *
7			******************************************************************************/
8
9			namespace Waca\Pages;
10
11			use Exception;
12			use Waca\DataObjects\User;
13			use Waca\DataObjects\WelcomeTemplate;
14			use Waca\Exceptions\ApplicationLogicException;
15			use Waca\Helpers\Logger;
16			use Waca\SessionAlert;
17			use Waca\Tasks\InternalPageBase;
18			use Waca\WebRequest;
19
20			class PageWelcomeTemplateManagement extends InternalPageBase
21			{
22			/**
23			* Main function for this page, when no specific actions are called.
24			* @return void
25			*/
26			protected function main()
27			{
28			$templateList = WelcomeTemplate::getAll($this->getDatabase());
29
30			$this->assignCSRFToken();
31
32			$user = User::getCurrent($this->getDatabase());
33			$this->assign('canEdit', $this->barrierTest('edit', $user));
34			$this->assign('canAdd', $this->barrierTest('add', $user));
35
36			$this->assign('templateList', $templateList);
37			$this->setTemplate('welcome-template/list.tpl');
38			}
39
40			/**
41			* Handles the requests for selecting a template to use.
42			*
43			* @throws ApplicationLogicException
44			*/
45			protected function select()
46			{
47			// get rid of GETs
48			if (!WebRequest::wasPosted()) {
49			$this->redirect('welcomeTemplates');
50			}
51
52			$this->validateCSRFToken();
53
54			$user = User::getCurrent($this->getDatabase());
55
56			if (WebRequest::postBoolean('disable')) {
57			$user->setWelcomeTemplate(null);
58			$user->save();
59
60			SessionAlert::success('Disabled automatic user welcoming.');
61			$this->redirect('welcomeTemplates');
62
63			return;
64			}
65
66			$database = $this->getDatabase();
67
68			$templateId = WebRequest::postInt('template');
69			/** @var false\|WelcomeTemplate $template */
70			$template = WelcomeTemplate::getById($templateId, $database);
71
72			if ($template === false \|\| $template->isDeleted()) {
73			throw new ApplicationLogicException('Unknown template');
74			}
75
76			$user->setWelcomeTemplate($template->getId());
77			$user->save();
78
79			SessionAlert::success("Updated selected welcome template for automatic welcoming.");
80
81			$this->redirect('welcomeTemplates');
82			}
83
84			/**
85			* Handles the requests for viewing a template.
86			*
87			* @throws ApplicationLogicException
88			*/
89			protected function view()
90			{
91			$database = $this->getDatabase();
92
93			$templateId = WebRequest::getInt('template');
94
95			/** @var WelcomeTemplate $template */
96			$template = WelcomeTemplate::getById($templateId, $database);
97
98			if ($template === false) {
99			throw new ApplicationLogicException('Cannot find requested template');
100			}
101
102			$templateHtml = $this->getWikiTextHelper()->getHtmlForWikiText($template->getBotCode());
103
104			$this->assign('templateHtml', $templateHtml);
105			$this->assign('template', $template);
106			$this->setTemplate('welcome-template/view.tpl');
107			}
108
109			/**
110			* Handler for the add action to create a new welcome template
111			*
112			* @throws Exception
113			*/
114			protected function add()
115			{
116			if (WebRequest::wasPosted()) {
117			$this->validateCSRFToken();
118			$database = $this->getDatabase();
119
120			$userCode = WebRequest::postString('usercode');
121			$botCode = WebRequest::postString('botcode');
122
123			$this->validate($userCode, $botCode);
124
125			$template = new WelcomeTemplate();
126			$template->setDatabase($database);
127			$template->setUserCode($userCode);
128			$template->setBotCode($botCode);
129			$template->save();
130
131			Logger::welcomeTemplateCreated($database, $template);
132
133			$this->getNotificationHelper()->welcomeTemplateCreated($template);
134
135			SessionAlert::success("Template successfully created.");
136
137			$this->redirect('welcomeTemplates');
138			}
139			else {
140			$this->assignCSRFToken();
141			$this->setTemplate("welcome-template/add.tpl");
142			}
143			}
144
145			/**
146			* Hander for editing templates
147			*/
148			protected function edit()
149			{
150			$database = $this->getDatabase();
151
152			$templateId = WebRequest::getInt('template');
153
154			/** @var WelcomeTemplate $template */
155			$template = WelcomeTemplate::getById($templateId, $database);
156
157			if ($template === false) {
158			throw new ApplicationLogicException('Cannot find requested template');
159			}
160
161			if ($template->isDeleted()) {
162			throw new ApplicationLogicException('The specified template has been deleted');
163			}
164
165			if (WebRequest::wasPosted()) {
166			$this->validateCSRFToken();
167
168			$userCode = WebRequest::postString('usercode');
169			$botCode = WebRequest::postString('botcode');
170
171			$this->validate($userCode, $botCode);
172
173			$template->setUserCode($userCode);
174			$template->setBotCode($botCode);
175			$template->setUpdateVersion(WebRequest::postInt('updateversion'));
176			$template->save();
177
178			Logger::welcomeTemplateEdited($database, $template);
179
180			SessionAlert::success("Template updated.");
181
182			$this->getNotificationHelper()->welcomeTemplateEdited($template);
183
184			$this->redirect('welcomeTemplates');
185			}
186			else {
187			$this->assignCSRFToken();
188			$this->assign('template', $template);
189			$this->setTemplate('welcome-template/edit.tpl');
190			}
191			}
192
193			protected function delete()
194			{
195			$this->redirect('welcomeTemplates');
196
197			if (!WebRequest::wasPosted()) {
198			return;
199			}
200
201			$this->validateCSRFToken();
202
203			$database = $this->getDatabase();
204
205			$templateId = WebRequest::postInt('template');
206			$updateVersion = WebRequest::postInt('updateversion');
207
208			/** @var WelcomeTemplate $template */
209			$template = WelcomeTemplate::getById($templateId, $database);
210
211			if ($template === false \|\| $template->isDeleted()) {
212			throw new ApplicationLogicException('Cannot find requested template');
213			}
214
215			// set the update version to the version sent by the client (optimisticly lock from initial page load)
216			$template->setUpdateVersion($updateVersion);
217
218			$database
219			->prepare("UPDATE user SET welcome_template = NULL WHERE welcome_template = :id;")
220			->execute(array(":id" => $templateId));
221
222			Logger::welcomeTemplateDeleted($database, $template);
223
224			$template->delete();
225
226			SessionAlert::success(
227			"Template deleted. Any users who were using this template have had automatic welcoming disabled.");
228			$this->getNotificationHelper()->welcomeTemplateDeleted($templateId);
229			}
230
231			private function validate($userCode, $botCode)
232			{
233			if ($userCode === null) {
234			throw new ApplicationLogicException('User code cannot be null');
235			}
236
237			if ($botCode === null) {
238			throw new ApplicationLogicException('Bot code cannot be null');
239			}
240			}
241			}
242

enwikipedia-acc / waca

Push — newinternal ( 65a0f5...5b021c )

PageWelcomeTemplateManagement::getSecurityConfiguration() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like