######################################################################
# phpBB2 port to PHP-NUKE
# =======================
#                                                                      
# Copyright (c) 2002 by Tom Nitzschner (tom@toms-home.com)
# http://bbtonuke.sourceforge.net (or http://www.toms-home.com)
#
# Bugfixes provided by:
# hangdog (hangdog@yahoo.com)
#
# This program 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 2 of the License.       
#
# The only condition is that all original copyright messages must be 
# maintained in a clear, readable manner.
#
######################################################################


Important Notice:

As always, make a backup before messing with anything. All code
release by me is considered sample code only. It may be fully
functional, but you use it at your own risk, if you break it,
you get to keep both halfs. No warranty is given or implied.

----> To repeat:  MAKE A BACKUP BEFORE CHANGING ANYTHING!!!!


Porting method comment:

There is 101 ways to do a port. The method I have chosen has left all
table structures in place for both Nuke and phpBB, with 2 exceptions.
One phpBB table had to be renamed because it's name conflicted with an 
active nuke table and it contained different data. The user table is 
merged from both systems, with any fields required by phpBB added to 
the Nuke _users table. The only time the field sequence is important 
is during Nuke signup, because at this time it blindly writes values 
in a certain order, instead of using the field names to place the data 
in the right spot. 



Warings and Reqirements:

First up, please note that this will break the existing forum that comes
with nuke 5.5. At this time I don't have any way to import that into the 
new system. Also, the table build for phpBB2 WILL drop any existing tables
that are in it's way when it builds it own structure. If you have any data 
in there you want to keep, you better stop now and back it up!

This has been tesed on Nuke 5.5 ONLY. I know that due to the user table 
changes that were done from previous version, if you try and use this on 
an older version, you WILL screw up your site and it will not work. 
			You have been warned!!

You should have a fully functional stock PHP-Nuke 5.5 site up and running
without any regular nuke problems or errors. Your should have your admin 
account and a regular user account, all working.

You should know how to import a SQL file into your database. If not, this 
release is NOT! for you. Whatever method you used to create the PHPNuke
site initially should be fine to import the data required for this forum.

Please don't just drop these files in and expect an existing phpBB2 site to 
be turned into a module. There is some database changes required for that
to work and details about that will be posted shortly. Right now, this is 
ONLY a new Forum module for PHP-Nuke 5.5!


Included files:

1)  The entire directory structure for all parts required. I think it's 
    obvious why that is there. :)
2)  An updated modules.php. This version gets the nuke cookie data and 
    passes it to the phpBB forum code via a global statement.
3)  An updated "Your_Account" index file. Since we now have additional 
    fields in the nuke_users table, I had to change it to allow for that, 
    otherwise new user signup will fail.
4)  An updated "Who's online block. This will take the data required to
    show the unread message count from the phpBB2 private message system.
5)  A replacement for the old Members_list. This realy only links via a 
    "header" call to the memberlist in phpBB2. If you have this as an 
    active module, the forum must also be an active module.
6)  A replacement "Private_Messages". Again, this only links to the 
    private message system from phpBB2. If you have this as an active 
    module, the forum must also be an active module.


How to install:

1)  Copy all files into the right area. I left the tree structure in place,
    so that should be obvious where they go. Please make sure the webserver
    can write to the Forums directory, as during startup it will write a 
    config.php in the Forums directory.

2)  Import the "update-users.sql" and the "phpBB2.sql" into your nuke database. 
    The first sql alters the structure for the nuke_users table to work with the 
    phpBB2 requirements. To be specific, no existing fields get dropped or 
    changed, but quite a few new ones get added. The phpBB2 sql file generates
    the Forum tables and populates it with required data.

3)  In your regular Nuke admin menu, turn on the new forum and make it visible,
    or if you want to play it safe, as long as you are logged in with your admin
    account and have your regular user account active, you can use the inactive
    modules tree visible only to the admin to finish the setup.

4)  You should now log into nuke with your regular user account and be able to
    enter the forum. If it is run for the first time, you will be asked to confirm 
    the sitename and define the Forum Site Admin user. Once that is complete, the 
    forum should load within a few seconds. There should be a link at the bottom 
    that points to the admin menu of phpBB. Via "Forum Admin", Management, you can 
    create all the forums you want to have on your site. The Forum admin menu is 
    still in the default phpBB2 format. Use their help system if you get stuck.

That's it. Hopefully you can now use the new forum. 


Standard closing comments:

All code release by me is considered sample code only. It may be 
fully functional, but you use it at your own risk, if you break 
it, you get to keep both halfs. No warranty is given or implied.
 
If you use it and you feel generous you can send me a postcard,
the paper version. Just e-mail me for the address.
Hey, I collect them from places I haven't visited. lol

Tom	    
