From 4e2f7e0cd85dd19bb19e1f2fbc608d378210a510 Mon Sep 17 00:00:00 2001
From: Juan Leyva <juanleyvadelgado@gmail.com>
Date: Thu, 22 Sep 2016 16:25:37 +0100
Subject: [PATCH] MDL-56092 auth_email: New WS auth_email_get_signup_settings

---
 auth/email/classes/external.php    | 178 +++++++++++++++++++++++++++++
 auth/email/db/services.php         |  38 ++++++
 auth/email/tests/external_test.php |  80 +++++++++++++
 auth/email/version.php             |   2 +-
 lang/en/error.php                  |   1 +
 5 files changed, 298 insertions(+), 1 deletion(-)
 create mode 100644 auth/email/classes/external.php
 create mode 100644 auth/email/db/services.php
 create mode 100644 auth/email/tests/external_test.php

diff --git a/auth/email/classes/external.php b/auth/email/classes/external.php
new file mode 100644
index 00000000000..b7c46c7a85c
--- /dev/null
+++ b/auth/email/classes/external.php
@@ -0,0 +1,178 @@
+<?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/>.
+
+/**
+ * Auth e-mail external API
+ *
+ * @package    auth_email
+ * @category   external
+ * @copyright  2016 Juan Leyva <juan@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since      Moodle 3.2
+ */
+
+defined('MOODLE_INTERNAL') || die;
+
+require_once($CFG->libdir . '/externallib.php');
+require_once($CFG->libdir . '/authlib.php');
+require_once($CFG->dirroot . '/user/editlib.php');
+require_once($CFG->dirroot . '/user/profile/lib.php');
+
+/**
+ * Auth e-mail external functions
+ *
+ * @package    auth_email
+ * @category   external
+ * @copyright  2016 Juan Leyva <juan@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since      Moodle 3.2
+ */
+class auth_email_external extends external_api {
+
+    /**
+     * Check if registration is enabled in this site.
+     *
+     * @throws moodle_exception
+     * @since Moodle 3.2
+     */
+    protected static function check_signup_enabled() {
+        global $CFG;
+
+        if (empty($CFG->registerauth) or $CFG->registerauth != 'email') {
+            throw new moodle_exception('registrationdisabled', 'error');
+        }
+    }
+
+    /**
+     * Describes the parameters for get_signup_settings.
+     *
+     * @return external_external_function_parameters
+     * @since Moodle 3.2
+     */
+    public static function get_signup_settings_parameters() {
+        return new external_function_parameters(array());
+    }
+
+    /**
+     * Get the signup required settings and profile fields.
+     *
+     * @return array settings and possible warnings
+     * @since Moodle 3.2
+     * @throws moodle_exception
+     */
+    public static function get_signup_settings() {
+        global $CFG, $PAGE;
+
+        $context = context_system::instance();
+        // We need this to make work the format text functions.
+        $PAGE->set_context($context);
+
+        self::check_signup_enabled();
+
+        $result = array();
+        $result['namefields'] = useredit_get_required_name_fields();
+
+        if (!empty($CFG->passwordpolicy)) {
+            $result['passwordpolicy'] = print_password_policy();
+        }
+        if (!empty($CFG->sitepolicy)) {
+            $result['sitepolicy'] = $CFG->sitepolicy;
+        }
+        if (!empty($CFG->defaultcity)) {
+            $result['defaultcity'] = $CFG->defaultcity;
+        }
+        if (!empty($CFG->country)) {
+            $result['country'] = $CFG->country;
+        }
+
+        if ($fields = profile_get_signup_fields()) {
+            $result['profilefields'] = array();
+            foreach ($fields as $field) {
+                $fielddata = $field->object->get_field_config_for_external();
+                $fielddata['categoryname'] = external_format_string($field->categoryname, $context->id);
+                $fielddata['name'] = external_format_string($fielddata['name'], $context->id);
+                list($fielddata['defaultdata'], $fielddata['defaultdataformat']) =
+                    external_format_text($fielddata['defaultdata'], $fielddata['defaultdataformat'], $context->id);
+
+                $result['profilefields'][] = $fielddata;
+            }
+        }
+
+        if (signup_captcha_enabled()) {
+            require_once($CFG->libdir . '/recaptchalib.php');
+            // We return the public key, maybe we want to use the javascript api to get the image.
+            $result['recaptchapublickey'] = $CFG->recaptchapublickey;
+            list($result['recaptchachallengehash'], $result['recaptchachallengeimage'], $result['recaptchachallengejs']) =
+                recaptcha_get_challenge_hash_and_urls(RECAPTCHA_API_SECURE_SERVER, $CFG->recaptchapublickey);
+        }
+
+        $result['warnings'] = array();
+        return $result;
+    }
+
+    /**
+     * Describes the get_signup_settings return value.
+     *
+     * @return external_single_structure
+     * @since Moodle 3.2
+     */
+    public static function get_signup_settings_returns() {
+
+        return new external_single_structure(
+            array(
+                'namefields' => new external_multiple_structure(
+                     new external_value(PARAM_NOTAGS, 'The order of the name fields')
+                ),
+                'passwordpolicy' => new external_value(PARAM_RAW, 'Password policy', VALUE_OPTIONAL),
+                'sitepolicy' => new external_value(PARAM_URL, 'Site policy url', VALUE_OPTIONAL),
+                'defaultcity' => new external_value(PARAM_NOTAGS, 'Default city', VALUE_OPTIONAL),
+                'country' => new external_value(PARAM_ALPHA, 'Default country', VALUE_OPTIONAL),
+                'profilefields' => new external_multiple_structure(
+                    new external_single_structure(
+                        array(
+                            'id' => new external_value(PARAM_INT, 'Profile field id', VALUE_OPTIONAL),
+                            'shortname' => new external_value(PARAM_ALPHANUM, 'Password policy', VALUE_OPTIONAL),
+                            'name' => new external_value(PARAM_TEXT, 'Profield field name', VALUE_OPTIONAL),
+                            'datatype' => new external_value(PARAM_ALPHANUMEXT, 'Profield field datatype', VALUE_OPTIONAL),
+                            'description' => new external_value(PARAM_RAW, 'Profield field description', VALUE_OPTIONAL),
+                            'descriptionformat' => new external_format_value('description'),
+                            'categoryid' => new external_value(PARAM_INT, 'Profield field category id', VALUE_OPTIONAL),
+                            'categoryname' => new external_value(PARAM_TEXT, 'Profield field category name', VALUE_OPTIONAL),
+                            'sortorder' => new external_value(PARAM_INT, 'Profield field sort order', VALUE_OPTIONAL),
+                            'required' => new external_value(PARAM_INT, 'Profield field required', VALUE_OPTIONAL),
+                            'locked' => new external_value(PARAM_INT, 'Profield field locked', VALUE_OPTIONAL),
+                            'visible' => new external_value(PARAM_INT, 'Profield field visible', VALUE_OPTIONAL),
+                            'forceunique' => new external_value(PARAM_INT, 'Profield field unique', VALUE_OPTIONAL),
+                            'signup' => new external_value(PARAM_INT, 'Profield field in signup form', VALUE_OPTIONAL),
+                            'defaultdata' => new external_value(PARAM_RAW, 'Profield field default data', VALUE_OPTIONAL),
+                            'defaultdataformat' => new external_format_value('defaultdata'),
+                            'param1' => new external_value(PARAM_RAW, 'Profield field settings', VALUE_OPTIONAL),
+                            'param2' => new external_value(PARAM_RAW, 'Profield field settings', VALUE_OPTIONAL),
+                            'param3' => new external_value(PARAM_RAW, 'Profield field settings', VALUE_OPTIONAL),
+                            'param4' => new external_value(PARAM_RAW, 'Profield field settings', VALUE_OPTIONAL),
+                            'param5' => new external_value(PARAM_RAW, 'Profield field settings', VALUE_OPTIONAL),
+                        )
+                    ), 'Required profile fields', VALUE_OPTIONAL
+                ),
+                'recaptchapublickey' => new external_value(PARAM_RAW, 'Recaptcha public key', VALUE_OPTIONAL),
+                'recaptchachallengehash' => new external_value(PARAM_RAW, 'Recaptcha challenge hash', VALUE_OPTIONAL),
+                'recaptchachallengeimage' => new external_value(PARAM_URL, 'Recaptcha challenge <noscript> image', VALUE_OPTIONAL),
+                'recaptchachallengejs' => new external_value(PARAM_URL, 'Recaptcha challenge js url', VALUE_OPTIONAL),
+                'warnings'  => new external_warnings(),
+            )
+        );
+    }
+}
diff --git a/auth/email/db/services.php b/auth/email/db/services.php
new file mode 100644
index 00000000000..2978a87a3c4
--- /dev/null
+++ b/auth/email/db/services.php
@@ -0,0 +1,38 @@
+<?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/>.
+
+/**
+ * Auth email webservice definitions.
+ *
+ * @package    auth_email
+ * @copyright  2016 Juan Leyva
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+$functions = array(
+
+    'auth_email_get_signup_settings' => array(
+        'classname'   => 'auth_email_external',
+        'methodname'  => 'get_signup_settings',
+        'description' => 'Get the signup required settings and profile fields.',
+        'type'        => 'read',
+        'ajax'          => true,
+        'loginrequired' => false,
+    ),
+);
+
diff --git a/auth/email/tests/external_test.php b/auth/email/tests/external_test.php
new file mode 100644
index 00000000000..d8b20b55c0f
--- /dev/null
+++ b/auth/email/tests/external_test.php
@@ -0,0 +1,80 @@
+<?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/>.
+
+/**
+ * Auth email external functions tests.
+ *
+ * @package    auth_email
+ * @category   external
+ * @copyright  2016 Juan Leyva
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since      Moodle 3.2
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+global $CFG;
+
+require_once($CFG->dirroot . '/webservice/tests/helpers.php');
+
+/**
+ * External auth email API tests.
+ *
+ * @package     auth_email
+ * @copyright   2016 Juan Leyva
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since       Moodle 3.2
+ */
+class auth_email_external_testcase extends externallib_advanced_testcase {
+
+    /**
+     * Set up for every test
+     */
+    public function setUp() {
+        global $CFG, $DB;
+
+        $this->resetAfterTest(true);
+        $CFG->registerauth = 'email';
+
+        $categoryid = $DB->insert_record('user_info_category', array('name' => 'Cat 1', 'sortorder' => 1));
+        $field = $DB->insert_record('user_info_field', array(
+                'shortname' => 'frogname', 'name' => 'Name of frog', 'categoryid' => $categoryid,
+                'datatype' => 'text', 'signup' => 1, 'visible' => 1));
+    }
+
+    public function test_get_signup_settings() {
+        global $CFG;
+
+        $CFG->defaultcity = 'Bcn';
+        $CFG->country = 'ES';
+        $CFG->sitepolicy = 'https://moodle.org';
+
+        $result = auth_email_external::get_signup_settings();
+        $result = external_api::clean_returnvalue(auth_email_external::get_signup_settings_returns(), $result);
+
+        // Check expected data.
+        $this->assertEquals(array('firstname', 'lastname'), $result['namefields']);
+        $this->assertEquals($CFG->defaultcity, $result['defaultcity']);
+        $this->assertEquals($CFG->country, $result['country']);
+        $this->assertEquals($CFG->sitepolicy, $result['sitepolicy']);
+        $this->assertEquals(print_password_policy(), $result['passwordpolicy']);
+        $this->assertNotContains('recaptchachallengehash', $result);
+        $this->assertNotContains('recaptchachallengeimage', $result);
+        $this->assertCount(1, $result['profilefields']);
+        $this->assertEquals('text', $result['profilefields'][0]['datatype']);
+    }
+
+}
diff --git a/auth/email/version.php b/auth/email/version.php
index 61fdaa2f3fb..75de5270287 100644
--- a/auth/email/version.php
+++ b/auth/email/version.php
@@ -24,6 +24,6 @@
 
 defined('MOODLE_INTERNAL') || die;
 
-$plugin->version   = 2016052300;        // The current plugin version (Date: YYYYMMDDXX)
+$plugin->version   = 2016052301;        // The current plugin version (Date: YYYYMMDDXX)
 $plugin->requires  = 2016051900;        // Requires this Moodle version
 $plugin->component = 'auth_email';      // Full name of the plugin (used for diagnostics)
diff --git a/lang/en/error.php b/lang/en/error.php
index 93db2e57ee6..689d27a8e9c 100644
--- a/lang/en/error.php
+++ b/lang/en/error.php
@@ -462,6 +462,7 @@ $string['querystringcannotbeempty'] = 'The query string cannot be empty.';
 $string['redirecterrordetected'] = 'Unsupported redirect detected, script execution terminated';
 $string['refoundto'] = 'Can be refunded to {$a}';
 $string['refoundtoorigi'] = 'Refunded to original amount: {$a}';
+$string['registrationdisabled'] = 'Registration is disabled on this site';
 $string['remotedownloaderror'] = '<p>The download of the component to your server failed. Please verify proxy settings; the PHP cURL extension is highly recommended.</p>
 <p>You must download the <a href="{$a->url}">{$a->url}</a> file manually, copy it to "{$a->dest}" in your server and unzip it there.</p>';
 $string['remotedownloadnotallowed'] = 'Download of components to your server isn\'t allowed (allow_url_fopen is disabled).<br /><br />You must download the <a href="{$a->url}">{$a->url}</a> file manually, copy it to "{$a->dest}" in your server and unzip it there.';