auth_plugin_ws::process_config() - Code Metrics - Inspection of "update to moodle 3.3" - danielneis/moodle-auth_ws - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( ca0837...9b6ea4 )

by Daniel Neis

created 2018-02-14 01:15 UTC

auth_plugin_ws::process_config() F

↳ Parent: Project

Complexity

Conditions	11
Paths	1024

Size

Total Lines	45
Code Lines	32

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	45
rs	3.1764
cc	11
eloc	32
nc	1024
nop	1

How to fix Complexity

<?php

// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/**
 * Authentication Plugin: External Webservice Authentication
 *
 * Checks against an external webservice.
 *
 * @package    auth_ws
 * @author     Daniel Neis Araujo
 * @license    http://www.gnu.org/copyleft/gpl.html GNU Public License
 */

defined('MOODLE_INTERNAL') || die();

require_once($CFG->libdir.'/authlib.php');

/**
 * External webservice authentication plugin.
 */
class auth_plugin_ws extends auth_plugin_base {
namespace YourVendor;

class YourClass { }

    /**
     * Constructor.
     */
    public function __construct() {
        $this->authtype = 'ws';
        $this->config = get_config('auth_ws');

        if (isset($this->config->default_params) && !empty($this->config->default_params)) {
            $params = explode(',', $this->config->default_params);
            $defaultparams = array();
            foreach ($params as $p) {
                list($paramname, $value) = explode(':', $p);
                $defaultparams[$paramname] = $value;
            }
            $this->config->ws_default_params = $defaultparams;
        } else {
            $this->config->ws_default_params = array();
        }
    }

    /**
     * Returns true if the username and password work and false if they are
     * wrong or don't exist.
     *
     * @param string $username The username
     * @param string $password The password
     * @return bool Authentication success or failure.
     */
    public function user_login($username, $password) {

        $functionname = $this->config->auth_function;
        $params  = array($this->config->auth_function_username_paramname => $username,
                         $this->config->auth_function_password_paramname => $password);

        $result = $this->call_ws($this->config->auth_serverurl, $functionname, $params);

        return ($result[$this->config->auth_function_resultClass][$this->config->auth_function_resultField] == true);
    }

    /**
     * This plugin is intended only to authenticate users.
     * User synchronization must be done by external service,
     * using Moodle's webservices.
     *
     * @param progress_trace $trace
     * @param bool $do_updates  Optional: set to true to force an update of existing accounts
     * @return int 0 means success, 1 means failure
     */
    public function sync_users(progress_trace $trace, $do_updates=false) {
        return true;
    }

    public function get_userinfo($username) {
        return array();
    }

    private function call_ws($serverurl, $functionname, $params = array()) {

        $serverurl = $serverurl . '?wsdl';

        $params = array_merge($this->config->ws_default_params, $params);

        $client = new SoapClient($serverurl);
        try {
            $resp = $client->__soapCall($functionname, array($params));

            return $resp;
        } catch (Exception $e) {
            echo "Exception:\n";
            echo $e->getMessage();
            echo "===\n";
            return false;
        }
    }

    public function prevent_local_passwords() {
        return true;
    }

    /**
     * Returns true if this authentication plugin is "internal".
     *
     * Internal plugins use password hashes from Moodle user table for authentication.
     *
     * @return bool
     */
    public function is_internal() {
        return false;
    }

    /**
     * Indicates if moodle should automatically update internal user
     * records with data from external sources using the information
     * from auth_plugin_base::get_userinfo().
     * The external service is responsible to update user records.
     *
     * @return bool true means automatically copy data from ext to user table
     */
    public function is_synchronised_with_external() {
        return false;
    }

    /**
     * Returns true if this authentication plugin can change the user's
     * password.
     *
     * @return bool
     */
    public function can_change_password() {
        return false;
    }

    /**
     * Returns the URL for changing the user's pw, or empty if the default can
     * be used.
     *
     * @return moodle_url
     */
    public function change_password_url() {
        if (isset($this->config->changepasswordurl) && !empty($this->config->changepasswordurl)) {
            return new moodle_url($this->config->changepasswordurl);
        } else {
            return null;
        }
    }

    /**
     * Returns true if plugin allows resetting of internal password.
     *
     * @return bool
     */
    public function can_reset_password() {
        return false;
    }
}


1			<?php
			0 ignored issues – show Coding Style Compatibility introduced 2016-08-10 22:36 UTC by Report Bug Copy Issue Report 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 34 and the first side effect is on line 27. The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file. The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place. To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1. Loading history...
2			// This file is part of Moodle - http://moodle.org/
3			//
4			// Moodle is free software: you can redistribute it and/or modify
5			// it under the terms of the GNU General Public License as published by
6			// the Free Software Foundation, either version 3 of the License, or
7			// (at your option) any later version.
8			//
9			// Moodle is distributed in the hope that it will be useful,
10			// but WITHOUT ANY WARRANTY; without even the implied warranty of
11			// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12			// GNU General Public License for more details.
13			//
14			// You should have received a copy of the GNU General Public License
15			// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
16
17			/**
18			* Authentication Plugin: External Webservice Authentication
19			*
20			* Checks against an external webservice.
21			*
22			* @package auth_ws
23			* @author Daniel Neis Araujo
24			* @license http://www.gnu.org/copyleft/gpl.html GNU Public License
25			*/
26
27			defined('MOODLE_INTERNAL') \|\| die();
28
29			require_once($CFG->libdir.'/authlib.php');
30
31			/**
32			* External webservice authentication plugin.
33			*/
34			class auth_plugin_ws extends auth_plugin_base {
			0 ignored issues – show Coding Style Compatibility introduced 2015-12-03 18:01 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...
35
36			/**
37			* Constructor.
38			*/
39			public function __construct() {
40			$this->authtype = 'ws';
41			$this->config = get_config('auth_ws');
42
43			if (isset($this->config->default_params) && !empty($this->config->default_params)) {
44			$params = explode(',', $this->config->default_params);
45			$defaultparams = array();
46			foreach ($params as $p) {
47			list($paramname, $value) = explode(':', $p);
48			$defaultparams[$paramname] = $value;
49			}
50			$this->config->ws_default_params = $defaultparams;
51			} else {
52			$this->config->ws_default_params = array();
53			}
54			}
55
56			/**
57			* Returns true if the username and password work and false if they are
58			* wrong or don't exist.
59			*
60			* @param string $username The username
61			* @param string $password The password
62			* @return bool Authentication success or failure.
63			*/
64			public function user_login($username, $password) {
65
66			$functionname = $this->config->auth_function;
67			$params = array($this->config->auth_function_username_paramname => $username,
68			$this->config->auth_function_password_paramname => $password);
69
70			$result = $this->call_ws($this->config->auth_serverurl, $functionname, $params);
71
72			return ($result[$this->config->auth_function_resultClass][$this->config->auth_function_resultField] == true);
73			}
74
75			/**
76			* This plugin is intended only to authenticate users.
77			* User synchronization must be done by external service,
78			* using Moodle's webservices.
79			*
80			* @param progress_trace $trace
81			* @param bool $do_updates Optional: set to true to force an update of existing accounts
82			* @return int 0 means success, 1 means failure
83			*/
84			public function sync_users(progress_trace $trace, $do_updates=false) {
85			return true;
86			}
87
88			public function get_userinfo($username) {
89			return array();
90			}
91
92			private function call_ws($serverurl, $functionname, $params = array()) {
93
94			$serverurl = $serverurl . '?wsdl';
95
96			$params = array_merge($this->config->ws_default_params, $params);
97
98			$client = new SoapClient($serverurl);
99			try {
100			$resp = $client->__soapCall($functionname, array($params));
101
102			return $resp;
103			} catch (Exception $e) {
104			echo "Exception:\n";
105			echo $e->getMessage();
106			echo "===\n";
107			return false;
108			}
109			}
110
111			public function prevent_local_passwords() {
112			return true;
113			}
114
115			/**
116			* Returns true if this authentication plugin is "internal".
117			*
118			* Internal plugins use password hashes from Moodle user table for authentication.
119			*
120			* @return bool
121			*/
122			public function is_internal() {
123			return false;
124			}
125
126			/**
127			* Indicates if moodle should automatically update internal user
128			* records with data from external sources using the information
129			* from auth_plugin_base::get_userinfo().
130			* The external service is responsible to update user records.
131			*
132			* @return bool true means automatically copy data from ext to user table
133			*/
134			public function is_synchronised_with_external() {
135			return false;
136			}
137
138			/**
139			* Returns true if this authentication plugin can change the user's
140			* password.
141			*
142			* @return bool
143			*/
144			public function can_change_password() {
145			return false;
146			}
147
148			/**
149			* Returns the URL for changing the user's pw, or empty if the default can
150			* be used.
151			*
152			* @return moodle_url
153			*/
154			public function change_password_url() {
155			if (isset($this->config->changepasswordurl) && !empty($this->config->changepasswordurl)) {
156			return new moodle_url($this->config->changepasswordurl);
157			} else {
158			return null;
159			}
160			}
161
162			/**
163			* Returns true if plugin allows resetting of internal password.
164			*
165			* @return bool
166			*/
167			public function can_reset_password() {
168			return false;
169			}
170			}
171

danielneis / moodle-auth_ws

Push — master ( ca0837...9b6ea4 )

auth_plugin_ws::process_config() F

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like