Merge branch 'MDL-55188-master' of git://github.com/abgreeve/moodle
[moodle.git] / auth / shibboleth / settings.php
1 <?php
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/>.
17 /**
18  * Admin settings and defaults.
19  *
20  * @package    auth_shibboleth
21  * @copyright  2017 Stephen Bourget
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 defined('MOODLE_INTERNAL') || die;
27 if ($ADMIN->fulltree) {
28     // We use a couple of custom admin settings since we need to massage the data before it is inserted into the DB.
29     require_once($CFG->dirroot.'/auth/shibboleth/classes/admin_setting_special_wayf_select.php');
30     require_once($CFG->dirroot.'/auth/shibboleth/classes/admin_setting_special_idp_configtextarea.php');
32     // Introductory explanation.
33     $settings->add(new admin_setting_heading('auth_shibboleth/pluginname', '',
34             new lang_string('auth_shibbolethdescription', 'auth_shibboleth')));
36     // Username.
37     $settings->add(new admin_setting_configtext('auth_shibboleth/user_attribute', get_string('username'),
38             get_string('auth_shib_username_description', 'auth_shibboleth'), '', PARAM_RAW));
40     // COnvert Data configuration file.
41     $settings->add(new admin_setting_configfile('auth_shibboleth/convert_data',
42             get_string('auth_shib_convert_data', 'auth_shibboleth'),
43             get_string('auth_shib_convert_data_description', 'auth_shibboleth'), ''));
45     // WAYF.
46     $settings->add(new auth_shibboleth_admin_setting_special_wayf_select());
48     // Organization_selection.
49     $settings->add(new auth_shibboleth_admin_setting_special_idp_configtextarea());
51     // Logout handler.
52     $settings->add(new admin_setting_configtext('auth_shibboleth/logout_handler',
53             get_string('auth_shib_logout_url', 'auth_shibboleth'),
54             get_string('auth_shib_logout_url_description', 'auth_shibboleth'), '', PARAM_URL));
56     // Logout return URL.
57     $settings->add(new admin_setting_configtext('auth_shibboleth/logout_return_url',
58             get_string('auth_shib_logout_return_url', 'auth_shibboleth'),
59             get_string('auth_shib_logout_return_url_description', 'auth_shibboleth'), '', PARAM_URL));
61     // Authentication method name.
62     $settings->add(new admin_setting_configtext('auth_shibboleth/login_name',
63             get_string('auth_shib_auth_method', 'auth_shibboleth'),
64             get_string('auth_shib_auth_method_description', 'auth_shibboleth'), 'Shibboleth Login', PARAM_RAW_TRIMMED));
66     // Authentication method logo.
67     $settings->add(new admin_setting_configstoredfile('auth_shibboleth/auth_logo',
68                 get_string('auth_shib_auth_logo', 'auth_shibboleth'),
69                 get_string('auth_shib_auth_logo_description', 'auth_shibboleth'), 'logo', 0, ['accepted_types' => ['image']]));
71     // Login directions.
72     $settings->add(new admin_setting_configtextarea('auth_shibboleth/auth_instructions',
73             get_string('auth_shib_instructions_key', 'auth_shibboleth'),
74             get_string('auth_shib_instructions_help', 'auth_shibboleth', $CFG->wwwroot.'/auth/shibboleth/index.php'),
75             get_string('auth_shib_instructions', 'auth_shibboleth', $CFG->wwwroot.'/auth/shibboleth/index.php'), PARAM_RAW_TRIMMED));
77     // Password change URL.
78     $settings->add(new admin_setting_configtext('auth_shibboleth/changepasswordurl',
79             get_string('auth_shib_changepasswordurl', 'auth_shibboleth'),
80             get_string('changepasswordhelp', 'auth'), '', PARAM_URL));
82     // Display locking / mapping of profile fields.
83     $authplugin = get_auth_plugin('shibboleth');
84     display_auth_lock_options($settings, $authplugin->authtype, $authplugin->userfields,
85             '', true, false, $authplugin->get_custom_user_profile_fields());
87 }