MDL-23489 auth plugins can specify own edit profile url - patch submi…

…tted by Jay Knight + tweaking change password url to use new moodle_url at the same time, it is backwards compatible, custom plugins may still use string url for now
BenKelada · Aug 18, 2010 · 99f9f85 · 99f9f85
1 parent 84deffa
commit 99f9f85
Show file tree

Hide file tree

Showing 15 changed files with 76 additions and 30 deletions.
diff --git a/auth/cas/auth.php b/auth/cas/auth.php
@@ -3,7 +3,7 @@
 /**
  * @author Martin Dougiamas
  * @author Jerome GUTIERREZ
- * @author Iñaki Arenaza
+ * @author I�aki Arenaza
  * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
  * @package moodle multiauth
  *
@@ -209,10 +209,10 @@ function config_form($config, $err, $user_fields) {
      * Returns the URL for changing the user's pw, or empty if the default can
      * be used.
      *
-     * @return string
+     * @return moodle_url
      */
     function change_password_url() {
-        return '';
+        return null;
     }
 
     /**

diff --git a/auth/db/auth.php b/auth/db/auth.php
@@ -597,15 +597,15 @@ function can_change_password() {
      * Returns the URL for changing the user's pw, or empty if the default can
      * be used.
      *
-     * @return string
+     * @return moodle_url
      */
     function change_password_url() {
         if ($this->config->passtype == 'internal') {
             // standard form
-            return '';
+            return null;
         } else {
             // use custom url
-            return $this->config->changepasswordurl;
+            return new moodle_url($this->config->changepasswordurl);
         }
     }
 

diff --git a/auth/email/auth.php b/auth/email/auth.php
@@ -173,10 +173,10 @@ function can_change_password() {
      * Returns the URL for changing the user's pw, or empty if the default can
      * be used.
      *
-     * @return mixed
+     * @return moodle_url
      */
     function change_password_url() {
-        return ''; // use dafult internal method
+        return null; // use default internal method
     }
 
     /**

diff --git a/auth/imap/auth.php b/auth/imap/auth.php
@@ -108,10 +108,10 @@ function can_change_password() {
      * Returns the URL for changing the user's pw, or empty if the default can
      * be used.
      *
-     * @return string
+     * @return moodle_url
      */
     function change_password_url() {
-        return $this->config->changepasswordurl;
+        return new moodle_url($this->config->changepasswordurl);
     }
 
     /**

diff --git a/auth/ldap/auth.php b/auth/ldap/auth.php
@@ -2,7 +2,7 @@
 
 /**
  * @author Martin Dougiamas
- * @author Iñaki Arenaza
+ * @author I�aki Arenaza
  * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
  * @package moodle multiauth
  *
@@ -1098,7 +1098,7 @@ function user_update($olduser, $newuser) {
             if (empty($user_entry)) {
                 $attribs = join (', ', $search_attribs);
                 error_log($this->errorlogtag.get_string('updateusernotfound', 'auth_ldap',
-                                                          array('userdn'=>$user_dn, 
+                                                          array('userdn'=>$user_dn,
                                                                 'attribs'=>$attribs)));
                 return false; // old user not found!
             } else if (count($user_entry) > 1) {
@@ -1493,13 +1493,13 @@ function can_change_password() {
      * Returns the URL for changing the user's password, or empty if the default can
      * be used.
      *
-     * @return string url
+     * @return moodle_url
      */
     function change_password_url() {
         if (empty($this->config->stdchangepassword)) {
-            return $this->config->changepasswordurl;
+            return new moodle_url($this->config->changepasswordurl);
         } else {
-            return '';
+            return null;
         }
     }
 

diff --git a/auth/manual/auth.php b/auth/manual/auth.php
@@ -89,10 +89,10 @@ function can_change_password() {
      * Returns the URL for changing the user's pw, or empty if the default can
      * be used.
      *
-     * @return string
+     * @return moodle_url
      */
     function change_password_url() {
-        return '';
+        return null;
     }
 
     /**

diff --git a/auth/mnet/auth.php b/auth/mnet/auth.php
@@ -565,10 +565,10 @@ function can_change_password() {
      * Returns the URL for changing the user's pw, or false if the default can
      * be used.
      *
-     * @return string
+     * @return moodle_url
      */
     function change_password_url() {
-        return '';
+        return null;
     }
 
     /**

diff --git a/auth/none/auth.php b/auth/none/auth.php
@@ -89,10 +89,10 @@ function can_change_password() {
      * Returns the URL for changing the user's pw, or empty if the default can
      * be used.
      *
-     * @return string
+     * @return moodle_url
      */
     function change_password_url() {
-        return '';
+        return null;
     }
 
     /**

diff --git a/auth/pop3/auth.php b/auth/pop3/auth.php
@@ -108,10 +108,10 @@ function can_change_password() {
      * Returns the URL for changing the user's pw, or false if the default can
      * be used.
      *
-     * @return bool
+     * @return moodle_url
      */
     function change_password_url() {
-        return $this->config->changepasswordurl;
+        return new moodle_url($this->config->changepasswordurl);
     }
 
     /**

diff --git a/auth/webservice/auth.php b/auth/webservice/auth.php
@@ -111,10 +111,10 @@ function can_change_password() {
      * Returns the URL for changing the user's pw, or empty if the default can
      * be used.
      *
-     * @return string
+     * @return moodle_url
      */
     function change_password_url() {
-        return '';
+        return null;
     }
 
     /**

diff --git a/lang/en/auth.php b/lang/en/auth.php
@@ -96,6 +96,7 @@
 $string['md5'] = 'MD5 hash';
 $string['nopasswordchange'] = 'Password can not be changed';
 $string['nopasswordchangeforced'] = 'You cannot proceed without changing your password, however there is no available page for changing it. Please contact your Moodle Administrator.';
+$string['noprofileedit'] = 'Profile can not be edited';
 $string['ntlmsso_attempting'] = 'Attempting Single Sign On via NTLM...';
 $string['ntlmsso_failed'] = 'Auto-login failed, try the normal login page...';
 $string['ntlmsso_isdisabled'] = 'NTLM SSO is disabled.';

diff --git a/lib/authlib.php b/lib/authlib.php
@@ -139,11 +139,36 @@ function can_change_password() {
      * This method is used if can_change_password() returns true.
      * This method is called only when user is logged in, it may use global $USER.
      *
-     * @return string
+     * @return moodle_url url of the profile page or null if standard used
      */
     function change_password_url() {
         //override if needed
-        return '';
+        return null;
+    }
+
+    /**
+     * Returns true if this authentication plugin can edit the users'
+     * profile.
+     *
+     * @return bool
+     */
+    function can_edit_profile() {
+        //override if needed
+        return true;
+    }
+
+    /**
+     * Returns the URL for editing the users' profile, or empty if the default
+     * URL can be used.
+     *
+     * This method is used if can_edit_profile() returns true.
+     * This method is called only when user is logged in, it may use global $USER.
+     *
+     * @return moodle_url url of the profile page or null if standard used
+     */
+    function edit_profile_url() {
+        //override if needed
+        return null;
     }
 
     /**

diff --git a/lib/navigationlib.php b/lib/navigationlib.php
@@ -3260,8 +3260,16 @@ protected function generate_user_settings($courseid, $userid, $gstitle='usercurr
                 $url = new moodle_url('/user/editadvanced.php', array('id'=>$user->id, 'course'=>$course->id));
                 $usersetting->add(get_string('editmyprofile'), $url, self::TYPE_SETTING);
             } else if ((has_capability('moodle/user:editprofile', $usercontext) && !is_siteadmin($user)) || ($currentuser && has_capability('moodle/user:editownprofile', $systemcontext))) {
-                $url = new moodle_url('/user/edit.php', array('id'=>$user->id, 'course'=>$course->id));
-                $usersetting->add(get_string('editmyprofile'), $url, self::TYPE_SETTING);
+				if (!empty($user->auth)) {
+					$userauth = get_auth_plugin($user->auth);
+					if ($userauth->can_edit_profile()) {
+						$url = $userauth->edit_profile_url();
+						if (empty($url)) {
+							$url = new moodle_url('/user/edit.php', array('id'=>$user->id, 'course'=>$course->id));
+						}
+						$usersetting->add(get_string('editmyprofile'), $url, self::TYPE_SETTING);
+					}
+				}
             }
         }
 

diff --git a/login/index.php b/login/index.php
@@ -194,7 +194,7 @@
         if (!empty($userauth->config->expiration) and $userauth->config->expiration == 1) {
             if ($userauth->can_change_password()) {
                 $passwordchangeurl = $userauth->change_password_url();
-                if(!$passwordchangeurl) {
+                if (!$passwordchangeurl) {
                     $passwordchangeurl = $CFG->httpswwwroot.'/login/change_password.php';
                 }
             } else {

diff --git a/user/edit.php b/user/edit.php
@@ -86,6 +86,18 @@
     redirect($CFG->wwwroot . "/user/view.php?course={$course->id}");
 }
 
+// load the appropriate auth plugin
+$userauth = get_auth_plugin($user->auth);
+
+if (!$userauth->can_edit_profile()) {
+    print_error('noprofileedit', 'auth');
+}
+
+if ($editurl = $userauth->edit_profile_url()) {
+    // this internal script not used
+    redirect($editurl);
+}
+
 if ($course->id == SITEID) {
     $coursecontext = get_context_instance(CONTEXT_SYSTEM);   // SYSTEM context
 } else {