/**
  * $Id: INSTALL 25 2005-08-10 17:45:00Z planetwork $  
  * isso-2idi for WordPress
  * Copyright (C) 2005 Michael Mell.  All Rights Reserved.
  *   http://public.xdi.org/=michael.mell
  * See LICENSE.html for licensing details
  */

ISSO (I-Name Single Sign On) for WordPress

This installation guide is certain to work with 
  wordpress-1.5.1.3
  
INSTALLATIION GUIDE
  
  INSTALL WORDPRESS
  ~ follow the WordPress instructions. This guide assumes wordpress-1.5.1.3
      The following instructions will refer to the installation directory as ~/wordpress
  
  INSTALL SPIT
  ~ Install the 2idi SPIT module, step 1 only according to these instructions: 
    http://wiki.idcommons.net/moin.cgi/HowTo_2fInstallSingleSignOn
    2idi SPIT may require CURL and xmlrpc compiled into PHP
  
  From this point, installation should require less than 20 minutes.
  
  ENABLE I-NAME REGISTRATION
  ~ until we can convince WordPress to add a couple of new plugin hooks we need 
    to add two lines to ~/wordpress/wp-register.php ourselves
    1) replace
>>>
  $user_login = $_POST['user_login'];
  $user_email = $_POST['user_email'];
<<<
    with 
>>>  
  $user_login = $_POST['user_login'];
  $user_email = $_POST['user_email'];
  
  do_action('user_register_login_name', array(&$user_login, &$user_email)); 
<<<

    2) replace
>>>
default:
<<<
    with 
>>>
default:
  do_action('user_register_default', array()); 
<<<
    
    These do_action() hooks are spread throughout the WordPress application to provide plugin support, 
      so they are harmless until they are used by a plugin.

  INSTALL PLUGIN
  ~ download and unpack the wp-isso-2idi.tar file
  ~ copy the contents of the wp-isso-2idi.tar whose names begin with "isso-2idi" 
      into ~/wordpress/wp-content/plugins/
  ~ copy wp-isso-2idi-associate.php to ~/wordpress/wp-isso-2idi-associate.php
  ~ edit and adjust the ISSO CONFIG values in ~/wordpress/wp-content/plugins/isso-2idi.php as needed. 
      See comments there for documentation.
    if you want to use an @name other than @freeid to register new i-names, change the @name. 
      Note, the i-name status of a newly created i-name must be ok since wp-isso-2idi does not 
      currently have the capability to manipulate the i-name status
  
  ACTIVATE PLUGIN AND REQUIRE REGISTRATION
  ~ login to WordPress using the old-style login and the admin account
  ~ click the Options tab
    ~ check both boxes in Membership:
        [X] Anyone can register
        [X] Users must be registered and logged in to comment
  ~ click the Plugins tab
    ~ before you take the next step, **be sure you have a valid i-name that you can use to log in with**
    ~ click "Activate" for ISSO 2idi
  
  CONVERT THE ADMIN ACCOUNT
  ~ logout of WordPress
  ~ click the WordPress login link
  ~ click the "Convert existing account to i-name" link
  ~ enter your valid i-name and click the "Step 1 of 2" button. (Your i-broker may ask for your password)
  ~ when you return to the WordPress page, continue with "Step 2 of 2" by entering "admin" 
      for Username and your admin password for Password and click the Step 2 button.
    

  The ISSO_ENABLE_OLD_ACCOUNT_ASSOCIATION CONFIG SWITCH
  If 
    1) this is a new WordPress installation or 
    2) all of the accounts in wp_users.user_login field are set to i-names or 
    3) you want to force those old style logins to register a new account with an i-name
  then set ISSO_ENABLE_OLD_ACCOUNT_ASSOCIATION value to 'false' in the wp-content/plugins/isso-2idi.php config area. 
  
  Setting ISSO_ENABLE_OLD_ACCOUNT_ASSOCIATION to false will hide the link to the ~/wordpress/wp-isso-2idi-associate.php page.
    It can be hidden at any time in the future.
  
  DONE

UNINSTALL GUIDE
  Once this plugin has been installed, if you wish to uninstall it but for some reason can't login in to the wp-admin
    area plugins page, you can disable the plugin by removing the wp-content/plugins/isso* files.
    
NOTES
  ~ /wp-admin/users.php will allow an admin to create new users with "Nickname" that is not valid a i-name. 
    If the nickname is not a valid registered i-name, it can't be used to log in.
  
  ~ i-names are limited to 50 characters in WordPress since the wp_users.user_nickname database table is limited to 50 chars
    If you wish to increase the allowed length of i-names:
      ~ change the maxlength value of the login_iname field in the register form in isso-2idi.php and 
      ~ change the definition of the wp_users.user_nickname field:
        ALTER TABLE wp_users CHANGE user_nickname user_nickname VARCHAR(255);
  
Enjoy and send feedback.
http://public.xdi.org/=michael.mell