From b85eb11e113396490720572d11d30cd83c772ba1 Mon Sep 17 00:00:00 2001 From: Dries Buytaert Date: Fri, 23 Jan 2004 18:42:43 +0000 Subject: Patch 5287 by Stefan: multiline help texts should become inside a single $output. --- modules/user/user.module | 295 +++++++++++++++++++++++------------------------ 1 file changed, 145 insertions(+), 150 deletions(-) (limited to 'modules/user/user.module') diff --git a/modules/user/user.module b/modules/user/user.module index 4b15e2705..2048c6685 100644 --- a/modules/user/user.module +++ b/modules/user/user.module @@ -1595,12 +1595,12 @@ function user_help($section = "admin/help#user") { $output .= t("In this area you will define the permissions for each user role (role names are defined on the user roles page). Each permission describes a fine-grained logical operation, such as being able to access the administration pages, or adding/modifying a user account. You could say a permission represents access granted to a user to perform a set of operations.", array("%role" => url("admin/user/role"))); break; case 'admin/user/role': - $output .= "Roles allow you to fine tune the security and administration of drupal. A role defines a group of users that have certain privileges as defined in user permissions. Examples of roles include: anonymous user, authenticated user, moderator, administrator and so on. In this area you will define the names of the various roles. To delete a role choose \"edit role\".
By default, Drupal comes with two user roles:"; - $output .= ""; - $output = t($output, array("%permission" => url("admin/user/permission"))); + $output .= t(" + Roles allow you to fine tune the security and administration of drupal. A role defines a group of users that have certain privileges as defined in user permissions. Examples of roles include: anonymous user, authenticated user, moderator, administrator and so on. In this area you will define the names of the various roles. To delete a role choose \"edit role\".
By default, Drupal comes with two user roles: + ", array("%permission" => url("admin/user/permission"))); break; case 'admin/user/search': $output .= t("Enter a simple pattern ( '*' may be user as a wildcard match) to search for a username. For example, one may search for 'br' and Drupal might return 'brian', 'brad', and 'brenda'."); @@ -1614,11 +1614,10 @@ function user_help($section = "admin/help#user") { case 'user/help#user': $site = variable_get("site_name", "this website"); - $output .= "

Distributed authentication

"; - $output .= "

One of the more tedious moments in visiting a new website is filling out the registration form. Here at %site, you do not have to fill out a registration form if you are already a member of %help-links. This capability is called distributed authentication, and is unique to Drupal, the software which powers %site.

"; - $output .= "

Distributed authentication enables a new user to input a username and password into the login box, and immediately be recognized, even if that user never registered at %site. This works because Drupal knows how to communicate with external registration databases. For example, lets say that new user 'Joe' is already a registered member of Delphi Forums. Drupal informs Joe on registration and login screens that he may login with his Delphi ID instead of registering with %site. Joe likes that idea, and logs in with a username of joe@remote.delphiforums.com and his usual Delphi password. Drupal then contacts the remote.delphiforums.com server behind the scenes (usually using XML-RPC, HTTP POST, or SOAP) and asks: \"Is the password for user Joe correct?\". If Delphi replies yes, then we create a new %site account for Joe and log him into it. Joe may keep on logging into %site in the same manner, and he will always be logged into the same account.

"; - - $output = t($output, array("%help-links" => (implode(", ", user_auth_help_links())), "%site" => "$site", "%drupal" => "http://www.drupal.org", "%delphi-forums" => "http://www.delphiforums.com", "%xml" => "http://www.xmlrpc.com", "%http-post" => "http://www.w3.org/Protocols/", "%soap" => "http://www.soapware.org")); + $output .= t(" +

Distributed authentication

+

One of the more tedious moments in visiting a new website is filling out the registration form. Here at %site, you do not have to fill out a registration form if you are already a member of %help-links. This capability is called distributed authentication, and is unique to Drupal, the software which powers %site.

+

Distributed authentication enables a new user to input a username and password into the login box, and immediately be recognized, even if that user never registered at %site. This works because Drupal knows how to communicate with external registration databases. For example, lets say that new user 'Joe' is already a registered member of Delphi Forums. Drupal informs Joe on registration and login screens that he may login with his Delphi ID instead of registering with %site. Joe likes that idea, and logs in with a username of joe@remote.delphiforums.com and his usual Delphi password. Drupal then contacts the remote.delphiforums.com server behind the scenes (usually using XML-RPC, HTTP POST, or SOAP) and asks: \"Is the password for user Joe correct?\". If Delphi replies yes, then we create a new %site account for Joe and log him into it. Joe may keep on logging into %site in the same manner, and he will always be logged into the same account.

", array("%help-links" => (implode(", ", user_auth_help_links())), "%site" => "$site", "%drupal" => "http://www.drupal.org", "%delphi-forums" => "http://www.delphiforums.com", "%xml" => "http://www.xmlrpc.com", "%http-post" => "http://www.w3.org/Protocols/", "%soap" => "http://www.soapware.org")); foreach (module_list() as $module) { if (module_hook($module, "auth")) { @@ -1630,152 +1629,147 @@ function user_help($section = "admin/help#user") { case 'admin/help#user': // Start of user_help_admin - $output .= "

Introduction

Drupal offers a powerful access system that allows users to register, login, logout, maintain user profiles, etc. By using roles you can setup fine grained permissions allowing each role to do only what you want them to. Each user is assigned to a role. By default there are two roles \"anonymous\" - a user who has not logged in, and \"authorized\" a user who has signed up and who has been authorized. As anonymous users, participants suffer numerous disadvantages, for example they cannot sign their names to nodes, and their moderated posts beginning at a lower score.

"; - $output .= "

In contrast, those with a user account can use their own name or handle and are granted various privileges: the most important is probably the ability to moderate new submissions, to rate comments, and to fine-tune the site to their personal liking, with saved personal settings. Drupal themes make fine tuning quite a pleasure.

"; - $output .= "

Registered users need to authenticate by supplying either a local username and password, or a remote username and password such as a Jabber ID, DelphiForums ID, or one from a Drupal powered website. See the distributed authentication help for more information on this innovative feature."; - $output .= "The local username and password, hashed with Message Digest 5 (MD5), are stored in your database. When you enter a password it is also hashed with MD5 and compaired with what is in the database. If the hashes match, the username and password are correct. Once a user authenticated session is started, and until that session is over, the user won't have to re-authenticate. To keep track of the individual sessions, Drupal relies on PHP sessions. A visitor accessing your website is assigned an unique ID, the so-called session ID, which is stored in a cookie. For security's sake, the cookie does not contain personal information but acts as a key to retrieve the information stored on your server. When a visitor accesses your site, Drupal will check whether a specific session ID has been sent with the request. If this is the case, the prior saved environment is recreated.

"; - $output .= "

User preferences and profiles

Each Drupal user has a profile, and a set of preferences which may be edited by clicking on the \"my account\" link. Of course, a user must be logged into reach those pages. There, users will find a page for changing their preferred time zone, language, username, e-mail address, password, theme, signature, and distributed authentication names. Changes made here take effect immediately. Also, administrators may make profile and preferences changes in account administration on behalf of their users.

"; - $output .= "

Module developers are provided several hooks for adding custom fields to the user view/edit pages. These hooks are described in the Developer section of the developers guide. For an example, see the jabber_user() function in /modules/jabber.module.

"; - //end of user_help_admin - - //start of user_help_admin_da - $output .= "

Distributed authentication

"; - $output .= "

One of the more tedious moments in visiting a new website is filling out the registration form. The reg form provides helpful information to the website owner, but not much value for the user. The value for the end user is usually the ability to post a messages or receive personalized news, etc. Distributed authentication (DA) gives the user what they want without having to fill out the reg form. Removing this obstacle yields more registered and active users for the website.

"; - $output .= "

DA enables a new user to input a username and password into the login box and immediately be recognized, even if that user never registered on your site. This works because Drupal knows how to communicate with external registration databases. For example, lets say that your new user 'Joe' is already a registered member of Delphi Forums. If your Drupal has the delphi module installed, then Drupal will inform Joe on the registration and login screens that he may login with his Delphi ID instead of registering with your Drupal instance. Joe likes that idea, and logs in with a username of joe@remote.delphiforums.com and his usual Delphi password. Drupal then communicates with remote.delphiforums.com (usually using %xml, %http-post, or %soap) behind the scenes and asks "is this password for username=joe?" If Delphi replies yes, then Drupal will create a new local account for joe and log joe into it. Joe may keep on logging into your Drupal instance in the same manner, and he will be logged into the same joe@remote.delphiforums.com account.

"; - $output .= "

One key element of DA is the 'authmap' table, which maps a user's authname (e.g. joe@remote.delphiforums.com) to his local UID (i.e. user identification number). This map is checked whenever a user successfully logs into an external authentication source. Once Drupal knows that the current user is definately joe@remote.delphiforums.com (because Delphi says so), he looks up Joe's UID and logs Joe into that account.

"; - $output .= "

To disable distributed authentication, simply disable or remove all DA modules. For a virgin install, that means removing/disabling the jabber module and the drupal module.

"; - $output .= "

Drupal is setup so that it is very easy to add support for any external authentication source. You currently have the following authentication modules installed ...

"; - $output .= "%module-list"; - // end of user_help_admin_da - - // start of user_help_devel_da - $output .= "

Writing distributed authentication modules

Drupal is specifically architected to enable easy authoring of new authentication modules. I'll deconstruct the blogger authentication module, and hopefully provide all the details you'll need to write your own auth module. If you want to download the full text of this module, visit the module in the contributions repository.

"; - $output .= "

Code review

"; - $output .= "
function blogger_auth(\$name, \$pass, \$server) {
-  // user did not present a Blogger ID so don't bother trying.
-  if (\$server !== "blogger.com") {
-    return 0;
-  }
-  //provided to Drupal by Ev@Blogger
-  \$appkey = "6D4A2D6811A6E1F75148DC1155D33C0C958107BC"
+      $output .= t("
+      
Introduction

+      
Drupal offers a powerful access system that allows users to register, login, logout, maintain user profiles, etc. By using roles you can setup fine grained permissions allowing each role to do only what you want them to. Each user is assigned to a role. By default there are two roles \"anonymous\" - a user who has not logged in, and \"authorized\" a user who has signed up and who has been authorized. As anonymous users, participants suffer numerous disadvantages, for example they cannot sign their names to nodes, and their moderated posts beginning at a lower score.

+      
In contrast, those with a user account can use their own name or handle and are granted various privileges: the most important is probably the ability to moderate new submissions, to rate comments, and to fine-tune the site to their personal liking, with saved personal settings.  Drupal themes make fine tuning quite a pleasure.

+      
Registered users need to authenticate by supplying either a local username and password, or a remote username and password such as a Jabber ID, DelphiForums ID, or one from a Drupal powered website. See the distributed authentication help for more information on this innovative feature.
+      The local username and password, hashed with Message Digest 5 (MD5), are stored in your database. When you enter a password it is also hashed with MD5 and compaired with what is in the database. If the hashes match, the username and password are correct. Once a user authenticated session is started, and until that session is over, the user won't have to re-authenticate. To keep track of the individual sessions, Drupal relies on PHP sessions. A visitor accessing your website is assigned an unique ID, the so-called session ID, which is stored in a cookie. For security's sake, the cookie does not contain personal information but acts as a key to retrieve the information stored on your server. When a visitor accesses your site, Drupal will check whether a specific session ID has been sent with the request. If this is the case, the prior saved environment is recreated.

+      
User preferences and profiles
Each Drupal user has a profile, and a set of preferences which may be edited by clicking on the \"my account\" link. Of course, a user must be logged into reach those pages. There, users will find a page for changing their preferred time zone, language, username, e-mail address, password, theme, signature, and distributed authentication names. Changes made here take effect immediately. Also, administrators may make profile and preferences changes in account administration on behalf of their users.

+      
Module developers are provided several hooks for adding custom fields to the user view/edit pages. These hooks are described in the Developer section of the developers guide. For an example, see the jabber_user() function in /modules/jabber.module.

+
+      
Distributed authentication

+      
One of the more tedious moments in visiting a new website is filling out the registration form. The reg form provides helpful information to the website owner, but not much value for the user. The value for the end user is usually the ability to post a messages or receive personalized news, etc. Distributed authentication (DA) gives the user what they want without having to fill out the reg form. Removing this obstacle yields more registered and active users for the website.

+      
DA enables a new user to input a username and password into the login box and immediately be recognized, even if that user never registered on your site. This works because Drupal knows how to communicate with external registration databases. For example, lets say that your new user 'Joe' is already a registered member of Delphi Forums. If your Drupal has the delphi module installed, then Drupal will inform Joe on the registration and login screens that he may login with his Delphi ID instead of registering with your Drupal instance. Joe likes that idea, and logs in with a username of joe@remote.delphiforums.com and his usual Delphi password. Drupal then communicates with remote.delphiforums.com (usually using %xml, %http-post, or %soap) behind the scenes and asks "is this password for username=joe?" If Delphi replies yes, then Drupal will create a new local account for joe and log joe into it. Joe may keep on logging into your Drupal instance in the same manner, and he will be logged into the same joe@remote.delphiforums.com account.

+      
One key element of DA is the 'authmap' table, which maps a user's authname (e.g. joe@remote.delphiforums.com) to his local UID (i.e. user identification number). This map is checked whenever a user successfully logs into an external authentication source. Once Drupal knows that the current user is definately joe@remote.delphiforums.com (because Delphi says so), he looks up Joe's UID and logs Joe into that account.

+      
To disable distributed authentication, simply disable or remove all DA modules. For a virgin install, that means removing/disabling the jabber module and the drupal module.

+      
Drupal is setup so that it is very easy to add support for any external authentication source. You currently have the following authentication modules installed ...

+      %module-list
+
+      
Writing distributed authentication modules

+      
Drupal is specifically architected to enable easy authoring of new authentication modules. I'll deconstruct the blogger authentication module, and hopefully provide all the details you'll need to write your own auth module. If you want to download the full text of this module, visit the module in the contributions repository.

+      
Code review

+      
function blogger_auth(\$name, \$pass, \$server) {
+        // user did not present a Blogger ID so don't bother trying.
+        if (\$server !== "blogger.com") {
+          return 0;
+        }
+        //provided to Drupal by Ev@Blogger
+        \$appkey = "6D4A2D6811A6E1F75148DC1155D33C0C958107BC"
 
-  \$message = new xmlrpcmsg("blogger.getUsersBlogs",
+        \$message = new xmlrpcmsg("blogger.getUsersBlogs",
                            array(new xmlrpcval(\$appkey, "string"),
                            new xmlrpcval(\$name, "string"),
                            new xmlrpcval(\$pass, "string")));
-  \$client = new xmlrpc_client("/api/RPC2", "plant.blogger.com");
-  // \$client->setDebug(1);
-  \$result = \$client->send(\$message, 5);
-  // Since Blogger doesn't return a properly formed FaultCode, we just search for the string 'fault'.
-  if (\$result && !stristr(\$result->serialize(), "fault")) {
-    // watchdog(\"user\", \"Success Blogger Auth. Response: \" . \$result->serialize());
-    return 1;
-  }
-  else if (\$result) {
-    // watchdog(\"user\", \"Blogger Auth failure. Response was \" . \$result->serialize());
-    return 0;
-  }
-  else {
-    // watchdog(\"user\", \"Blogger Auth failure. Could not connect.\");
-    return 0;
-  }
-}
";
-      $output .= "
The _auth function is the heart of any authentication module. This function is called whenever a user is attempting to login using your authentication module. For successful authentications, this function returns TRUE. Otherwise, it returns FALSE. This function always accepts 3 parameters, as shown above. These parameters are passed by the user system (user module). The user system parses the username as typed by the user into 2 substrings - \$name and \$server. The parsing rules are:
";
-      $output .= "
_auth function parameters
\$nameThe substring before the final '@' character in the username field
\$passThe whole string submitted by the user in the password field
\$serverThe substring after the final '@' symbol in the username field
";
-      $output .= "
So now lets use that \$name, \$pass, and \$server which was passed to our _auth function. Blogger authenticates users via XML-RPC. Your module may authenticate using a different technique. Drupal doesn't reallly care how your module communicates with its registration source. It just trusts the module.
";
-      $output .= "
The lines above illustrate a typical XML-RPC method call. Here we build up a message and send it to Blogger, storing the response in a variable called \$response. The message we pass conforms to the published Blogger XML-RPC Application Programmers Interface (API). Your module will no doubt implement a different API. One peculiarity of this module is that we don't actually use the \$server parameter. Blogger only accepts authentication at plant.blogger.com, so we hard-code that value into the xmlrpc_client() function. A more typical example might be the jabber module, which uses the \$server parameter to determine where to send the authentication request. Also of note is the '5'th parameter in the \$client->send() call. This is a timeout value in seconds. All authentication modules should implement a timeout on their external calls. This makes sure to return control to the user module if your registration database has become inoperable or unreachable.
";
-      $output .= "
-  if (\$result && !stristr(\$result->serialize(), "fault")) {
-    // watchdog(\"user\", \"Success Blogger Auth. Response: \" . \$result->serialize());
-    return 1;
-  }
-  else if (\$result) {
-    // watchdog(\"user\", \"Blogger Auth failure. Response was \" . \$result->serialize());
-    return 0;
-  }
-  else {
-    // watchdog(\"user\", \"Blogger Auth failure. Could not connect.\");
-    return 0;
-  }
-
";
-      $output .= "
This second half of the _auth function examines the \$response from plant.blogger.com and returns a TRUE (1) or FALSE (0) as appropriate. This is a critical decision, so be sure that you have good logic here, and perform sufficient testing for all cases. In the case of Blogger, we search for the string 'fault' in the response. If that string is present, or there is no repsonse, our function returns FALSE. Otherwise, Blogger has returned valid data to our method request and we return TRUE. Note: Everything starting with \"//\" is a comment and is not executed.
";
-      $output .= "
function blogger_page() {
-
-  print theme("header");
-  print theme("box", "Blogger", blogger_help(\"user/help\"));
-  print theme("footer");
-}
";
-      $output .= "
The _page function is not currently used, but it might be in the future. For now, just copy what you see here, substituting your module name for blogger.
";
-      $output .= "
function blogger_help(\$section) {
-  \$output = "";
-
-  switch (\$section) {
-    case 'user/help':
-      \$site = variable_get("site_name", "this web site");

-      \$output .= "<p>You may login to %site using a <b>Blogger ID</b> and password. ";
-      \$output .= "A Blogger ID consists of your Blogger username followed by <i>@blogger.com</i>. ";
-      \$output .= "So a valid blogger ID is <i>mwlily</i>@<b>blogger.com</b>. If you are a Blogger member, go ahead and login now.</p>";
-      \$output .= "<p>Blogger offers you instant communication power by letting you post your thoughts to the web whenever the urge strikes. ";
-      \$output .= "Blogger will publish to your current web site or help you create one. ";
-      \$output .= "<a href=\"http://www.blogger.com/about.pyra\">Learn more about it</a>.";
-      \$output = t(\$output, array(\"%site\" => \"<i>\$site</i>\"));
-  }
-
-  return output;
-}
";
-      $output .= "
The _help function is prominently linked within Drupal, so you'll want to write the best possible user help here. You'll want to tell users what a proper username looks like and you may also want to advertise a bit about your service at the end. Note that your help text is passed through a t() function in the last line. This is Drupal's localization function. Translators may localize your help text just like any other text in Drupal.
";
-      $output .= "
Publishing your module
Once you've written and tested your authentication module, you'll usually want to share it with the world. The best way to do this is to add the module to the Drupal contributions CVS repository. You'll need to request priveleges to this repository - see the CVS README file for the details. Then you should announce your contribution on the drupal-devel and drupal-support mailing lists. You might also want to post a story on Drupal.org.
";
-      // end of user_help_devel_da
-
-      // start of user_help_devel_userhook
-      $output .= "
module_user()
The _user() hook provides a mechanism for inserting text and form fields into the registration, user account view/edit, and administer » accounts pages. This is useful if you want to add a custom field for your particular community. This is best illustrated by the profile module. The profile module is meant to be customized for your needs. Please download it and hack away until it does what you need.
";
-
-      $output .= "
Consider this simpler example from a fictional recipe community web site called Julia's Kitchen. Julia customizes her Drupal powered site by creating a new file called julia.module. That file does the following:
";
-      $output .= "
Julia achieves this with the following code. The comments below should help you understand what is going on.
";
-
-      $output .= "
-function julia_user(\$type, \$edit, &\$user) {
-    // What type of registration action are we taking?
-    switch (\$type) {
-      case t(\"register_form\"):
-        // Add two items to the resigtration form.
-        \$output .= form_item(\"Privacy Policy\",
-                             \"Julia would never sell your user information. She is just a nice \".
-                             \"old French chef who lives near me in Cambridge, Massachussetts USA.\");
-        \$output .= form_checkbox(\"Accept Julia's Kitchen privacy policy.\",
-                                 julia_accept, 1, \$edit[\"julia_accept\"]);
-        return \$output;
-      case t(\"register_validate\"):
-        // The user has filled out the form and checked the \"accept\" box.
-        if (\$edit[\"julia_accept\"] == \"1\") {
-          // on success return the values you want to store
-          return array(\"julia_accept\" => 1);
+        \$client = new xmlrpc_client("/api/RPC2", "plant.blogger.com");
+        // \$client->setDebug(1);
+        \$result = \$client->send(\$message, 5);
+        // Since Blogger doesn't return a properly formed FaultCode, we just search for the string 'fault'.
+        if (\$result && !stristr(\$result->serialize(), "fault")) {
+          // watchdog(\"user\", \"Success Blogger Auth. Response: \" . \$result->serialize());
+          return 1;
+        }
+        else if (\$result) {
+          // watchdog(\"user\", \"Blogger Auth failure. Response was \" . \$result->serialize());
+          return 0;
         }
         else {
-          // on error return an error message
-          return \"You must accept the Julia's Kitchen privacy policy to register.\";
+          // watchdog(\"user\", \"Blogger Auth failure. Could not connect.\");
+          return 0;
         }
-      case t(\"view_public\"):
-        // when others look at user data
-        return form_item(\"Favorite Ingredient\", \$user->julia_favingredient);
-      case t(\"view_private\"):
-        // when user tries to view his own user page.
-        return form_item(\"Favorite Ingredient\", \$user->julia_favingredient);
-      case t(\"edit_form\"):
-        // when user tries to edit his own user page.
-        return form_textfield(\"Favorite Ingredient\", \"julia_favingredient\",
-                             \$user->julia_favingredient, 50, 65,
-                             \"Tell everyone your secret spice\");
-      case t(\"edit_validate\"): // Make sure the data they edited is \"valid\".
-        return user_save(\$user, array(\"julia_favingredient\" => \$edit[\"julia_favingredient\"]));
-    }
-  }
-
";
-      // end of user_help_devel_userhook
-      $output = t($output, array("%user-role" => url("admin/user/role"), "%user-permission" => url("admin/user/permission"), "%jabber" => "http://www.jabber.org", "%delphiforums" => "http://www.delphiforums.com", "%drupal" => "http://www.drupal.org", "%da-auth" => url("user/help#da"), "%php-sess" => "http://www.php.net/manual/en/ref.session.php", "%user-prefs" => url("user/edit"), "%admin-user" => url("admin/user"), "%da-devel" => "http://www.drupal.org/node/view/316", "%xml" => "http://www.xmlrpc.org", "%http-post" => "http://www.w3.org/Protocols/", "%soap" => "http://www.soapware.org", "%dis-module" => url("admin/system/modules"), "%blogger" => "http://www.blogger.com", "%blogger-source" => "http://cvs.drupal.org/viewcvs.cgi/contributions/modules/authentication/Bloggar/?cvsroot=contrib", "%contrib-cvs" => "http://cvs.drupal.org/viewcvs/contributions/?cvsroot=contrib", "%blogger-api" => "http://plant.blogger.com/API", "%cvs" => "http://cvs.drupal.org/viewcvs.cgi/contributions/README?rev=HEAD&cvsroot=contrib&content-type=text/vnd.viewcvs-markup", "%drupal-lists" => "http://drupal.org/mailing-lists", "%drupal-org" => "http://www.drupal.org", "%registration" => url("user/register"), "%user-acct" => url("user"), "%user-admin" => url("admin/user"), "%profile-module" => "http://cvs.drupal.org/viewcvs/drupal/modules/profile.module"));
+      }
+

The _auth function is the heart of any authentication module. This function is called whenever a user is attempting to login using your authentication module. For successful authentications, this function returns TRUE. Otherwise, it returns FALSE. This function always accepts 3 parameters, as shown above. These parameters are passed by the user system (user module). The user system parses the username as typed by the user into 2 substrings - \$name and \$server. The parsing rules are:

+
_auth function parameters
\$nameThe substring before the final '@' character in the username field
\$passThe whole string submitted by the user in the password field
\$serverThe substring after the final '@' symbol in the username field
+

So now lets use that \$name, \$pass, and \$server which was passed to our _auth function. Blogger authenticates users via XML-RPC. Your module may authenticate using a different technique. Drupal doesn't reallly care how your module communicates with its registration source. It just trusts the module.

+

The lines above illustrate a typical XML-RPC method call. Here we build up a message and send it to Blogger, storing the response in a variable called \$response. The message we pass conforms to the published Blogger XML-RPC Application Programmers Interface (API). Your module will no doubt implement a different API. One peculiarity of this module is that we don't actually use the \$server parameter. Blogger only accepts authentication at plant.blogger.com, so we hard-code that value into the xmlrpc_client() function. A more typical example might be the jabber module, which uses the \$server parameter to determine where to send the authentication request. Also of note is the '5'th parameter in the \$client->send() call. This is a timeout value in seconds. All authentication modules should implement a timeout on their external calls. This makes sure to return control to the user module if your registration database has become inoperable or unreachable.

+ 
+      if (\$result && !stristr(\$result->serialize(), "fault")) {
+        // watchdog(\"user\", \"Success Blogger Auth. Response: \" . \$result->serialize());
+        return 1;
+      }
+      else if (\$result) {
+        // watchdog(\"user\", \"Blogger Auth failure. Response was \" . \$result->serialize());
+        return 0;
+      }
+      else {
+        // watchdog(\"user\", \"Blogger Auth failure. Could not connect.\");
+        return 0;
+      }
+
+

This second half of the _auth function examines the \$response from plant.blogger.com and returns a TRUE (1) or FALSE (0) as appropriate. This is a critical decision, so be sure that you have good logic here, and perform sufficient testing for all cases. In the case of Blogger, we search for the string 'fault' in the response. If that string is present, or there is no repsonse, our function returns FALSE. Otherwise, Blogger has returned valid data to our method request and we return TRUE. Note: Everything starting with \"//\" is a comment and is not executed.

+ 
function blogger_page() {
+        print theme("header");
+        print theme("box", "Blogger", blogger_help(\"user/help\"));
+        print theme("footer");
+      }
+

The _page function is not currently used, but it might be in the future. For now, just copy what you see here, substituting your module name for blogger.

+ 
function blogger_help(\$section) {
+        \$output = "";
+
+        switch (\$section) {
+          case 'user/help':
+          \$site = variable_get("site_name", "this web site");

+          \$output .= "<p>You may login to %site using a <b>Blogger ID</b> and password. ";
+          \$output .= "A Blogger ID consists of your Blogger username followed by <i>@blogger.com</i>. ";
+          \$output .= "So a valid blogger ID is <i>mwlily</i>@<b>blogger.com</b>. If you are a Blogger member, go ahead and login now.</p>";
+          \$output .= "<p>Blogger offers you instant communication power by letting you post your thoughts to the web whenever the urge strikes. ";
+          \$output .= "Blogger will publish to your current web site or help you create one. ";
+          \$output .= "<a href=\"http://www.blogger.com/about.pyra\">Learn more about it</a>.";
+          \$output = t(\$output, array(\"%site\" => \"<i>\$site</i>\"));
+        }
+
+        return output;
+      }
+

The _help function is prominently linked within Drupal, so you'll want to write the best possible user help here. You'll want to tell users what a proper username looks like and you may also want to advertise a bit about your service at the end. Note that your help text is passed through a t() function in the last line. This is Drupal's localization function. Translators may localize your help text just like any other text in Drupal.

+

Publishing your module

+

Once you've written and tested your authentication module, you'll usually want to share it with the world. The best way to do this is to add the module to the Drupal contributions CVS repository. You'll need to request priveleges to this repository - see the CVS README file for the details. Then you should announce your contribution on the drupal-devel and drupal-support mailing lists. You might also want to post a story on Drupal.org.

+ +

module_user()

+

The _user() hook provides a mechanism for inserting text and form fields into the registration, user account view/edit, and administer » accounts pages. This is useful if you want to add a custom field for your particular community. This is best illustrated by the profile module. The profile module is meant to be customized for your needs. Please download it and hack away until it does what you need.

+ +

Consider this simpler example from a fictional recipe community web site called Julia's Kitchen. Julia customizes her Drupal powered site by creating a new file called julia.module. That file does the following:

+

Julia achieves this with the following code. The comments below should help you understand what is going on.

+ + 
+      function julia_user(\$type, \$edit, &\$user) {
+        // What type of registration action are we taking?
+        switch (\$type) {
+          case t(\"register_form\"):
+            // Add two items to the resigtration form.
+            \$output .= form_item(\"Privacy Policy\", \"Julia would never sell your user information. She is just a nice \".
+                                  \"old French chef who lives near me in Cambridge, Massachussetts USA.\");
+            \$output .= form_checkbox(\"Accept Julia's Kitchen privacy policy.\",
+                                      julia_accept, 1, \$edit[\"julia_accept\"]);
+            return \$output;
+          case t(\"register_validate\"):
+            // The user has filled out the form and checked the \"accept\" box.
+            if (\$edit[\"julia_accept\"] == \"1\") {
+              // on success return the values you want to store
+              return array(\"julia_accept\" => 1);
+            }
+            else {
+              // on error return an error message
+              return \"You must accept the Julia's Kitchen privacy policy to register.\";
+            }
+          case t(\"view_public\"):
+            // when others look at user data
+            return form_item(\"Favorite Ingredient\", \$user->julia_favingredient);
+          case t(\"view_private\"):
+            // when user tries to view his own user page.
+            return form_item(\"Favorite Ingredient\", \$user->julia_favingredient);
+          case t(\"edit_form\"):
+            // when user tries to edit his own user page.
+            return form_textfield(\"Favorite Ingredient\", \"julia_favingredient\",
+                                  \$user->julia_favingredient, 50, 65,
+                                  \"Tell everyone your secret spice\");
+          case t(\"edit_validate\"): // Make sure the data they edited is \"valid\".
+            return user_save(\$user, array(\"julia_favingredient\" => \$edit[\"julia_favingredient\"]));
+        }
+      }
+
", array("%user-role" => url("admin/user/role"), "%user-permission" => url("admin/user/permission"), "%jabber" => "http://www.jabber.org", "%delphiforums" => "http://www.delphiforums.com", "%drupal" => "http://www.drupal.org", "%da-auth" => url("user/help#da"), "%php-sess" => "http://www.php.net/manual/en/ref.session.php", "%user-prefs" => url("user/edit"), "%admin-user" => url("admin/user"), "%da-devel" => "http://www.drupal.org/node/view/316", "%xml" => "http://www.xmlrpc.org", "%http-post" => "http://www.w3.org/Protocols/", "%soap" => "http://www.soapware.org", "%dis-module" => url("admin/system/modules"), "%blogger" => "http://www.blogger.com", "%blogger-source" => "http://cvs.drupal.org/viewcvs.cgi/contributions/modules/authentication/Bloggar/?cvsroot=contrib", "%contrib-cvs" => "http://cvs.drupal.org/viewcvs/contributions/?cvsroot=contrib", "%blogger-api" => "http://plant.blogger.com/API", "%cvs" => "http://cvs.drupal.org/viewcvs.cgi/contributions/README?rev=HEAD&cvsroot=contrib&content-type=text/vnd.viewcvs-markup", "%drupal-lists" => "http://drupal.org/mailing-lists", "%drupal-org" => "http://www.drupal.org", "%registration" => url("user/register"), "%user-acct" => url("user"), "%user-admin" => url("admin/user"), "%profile-module" => "http://cvs.drupal.org/viewcvs/drupal/modules/profile.module")); foreach (module_list() as $module) { if (module_hook($module, "auth")) { @@ -1795,3 +1789,4 @@ function user_help_page() { } ?> + -- cgit v1.2.3