Product Release Information

Product:	phpBB3 Forum Module for CRELoaded
Release Number:	1.0.1
Release Date:	Aug 2, 2008
Customer Support:	For more information or support, please visit our website or contact us from the online form

Introduction

This document describes how to install and get started with phpBB3 Forum Module. The phpBB3 Forum Module allows customer Login and Sign Out Synchronization between CRE Loaded and phpBB3 Forum.

Features of the phpBB3 Forum Module:

• Shared account creation. Accounts created in CRE Loaded are mirrored in phpBB3
• Shared login/logoff. Users who log into the shopping cart are also logged into phpBB3. Logging off from phpBB3 or CRE Loaded logs you out of both systems
• Customer can set forum login name in the registration step
• All phpBB3 features are kept
• Fully integrated with CRE Loaded, easy to install, with details in the installation doc

Minimal System Requirements

System requirements are described in the release notes.

Installation

What other software must be installed first?

Before you can install this product, you must obtain access to a web server with the following:

• PHP 4.x with :
• GD Library
• mCrypt
• Register Globals set to On via httpd.conf, php.ini or .htaccess
• The Apache Webserver
• MySQL database
• The Linux / Unix Operating System
• CRE Loaded 6.2

How do I install CRE Loaded : phpBB3 Forum Module?

Please follow these steps:

1. Upload the files to your catalog directory on the webserver.


2. Open includes/configure.php file, before
   ?>
   add
   define('PHPBB_ROOT_PATH', "./forum/"); define('PHPBB_CP_KEY', "f65a326a");
   (note: the string "f65a326a" should be replaced by others.)


3. Open includes/filenames.php file, before
   ?>
   add
   define('CONTENT_PHPBB_USERCP', 'phpbb_usercp'); define('FILENAME_PHPBB_USERCP', CONTENT_PHPBB_USERCP . '.php');


4. Open includes/functions/general.php file, before
   ?>
   add
   function tep_get_customer_login_name($email_address, $customer_id = '') { if ($email_address) { $customer_info_query = tep_db_query("select login_name from " . TABLE_CUSTOMERS . " where customers_email_address = '" . tep_db_input($email_address) . "'"); } else { $customer_info_query = tep_db_query("select login_name from " . TABLE_CUSTOMERS . " where customers_id = '" . (int)$customer_id . "'"); } $customer_info = tep_db_fetch_array($customer_info_query); return $customer_info['login_name']; } function tep_get_customer_email($customer_id) { $customer_info_query = tep_db_query("select customers_email_address from " . TABLE_CUSTOMERS . " where customers_id = '" . (int)$customer_id . "'"); $customer_info = tep_db_fetch_array($customer_info_query); return $customer_info['customers_email_address']; } function tep_phpbb_redirect($data, $forward) { ksort($data); $verify_names = array('action', 'email', 'password', 'user_name'); $verify_strs = ''; $get_vars = ''; foreach ($data as $key_name => $value) { if (in_array($key_name, $verify_names)) { if ($key_name == 'password') { $value = phpbb_password_encrypt($value, PHPBB_CP_KEY); } $verify_strs .= $key_name . '=' . $value . '&'; } $get_vars .= $key_name . '=' . urlencode($value) . '&'; } $verify_strs = substr($verify_strs, 0, -1); $get_vars = substr($get_vars, 0, -1); /*if (isset($_GET[tep_session_name()]) && $jumpto != '') { $jumpto = $jumpto . (strstr($jumpto, '?') ? '&' : '?') . 'cresn=' . tep_session_name() . '&cresid=' . tep_session_id(); } $goto = $forward ? $forward : $jumpto;*/ if (isset($_SESSION['phpbb_forward']) && $_SESSION['phpbb_forward'] != '') { $goto = $_SESSION['phpbb_forward']; $_SESSION['phpbb_forward'] = ''; unset($_SESSION['phpbb_forward']); } else { $goto = $forward; } tep_redirect(tep_href_link(FILENAME_PHPBB_USERCP, $get_vars . '&verify=' . urlencode(md5($verify_strs . PHPBB_CP_KEY)) . '&forward=' . urlencode($goto))); exit; } function phpbb_password_encrypt($text, $key) { if (function_exists('mcrypt_get_iv_size')) { $key = md5($key); $iv_size = mcrypt_get_iv_size(MCRYPT_RIJNDAEL_256, MCRYPT_MODE_ECB); $iv = mcrypt_create_iv($iv_size, MCRYPT_RAND); $crypttext = mcrypt_encrypt(MCRYPT_RIJNDAEL_256, $key, $text, MCRYPT_MODE_ECB, $iv); } else { $crypttext = $text; } return base64_encode($crypttext); } function phpbb_password_decrypt($enc, $key) { $enc =base64_decode($enc); if (function_exists('mcrypt_get_iv_size')) { $key = md5($key); $iv_size = mcrypt_get_iv_size(MCRYPT_RIJNDAEL_256, MCRYPT_MODE_ECB); $iv = mcrypt_create_iv($iv_size, MCRYPT_RAND); $decrypttext = mcrypt_decrypt(MCRYPT_RIJNDAEL_256, $key, $enc, MCRYPT_MODE_ECB, $iv); $decrypttext1 = trim($decrypttext); } else { $decrypttext1 = $enc; } return $decrypttext1; }


5. Open login.php file, change
   if (sizeof($navigation->snapshot) > 0) { $origin_href = tep_href_link($navigation->snapshot['page'], tep_array_to_string($navigation->snapshot['get'], array(tep_session_name())), $navigation->snapshot['mode']); $navigation->clear_snapshot(); tep_redirect($origin_href); } else { tep_redirect(tep_href_link(FILENAME_DEFAULT, '', 'NONSSL')); }
   to
   $phpbb_action_data = array( 'user_name' => tep_get_customer_login_name($email_address), 'email' => $email_address, 'password' => $password, 'is_admin' => 'false', 'action' => 'login' ); if (isset($_GET[tep_session_name()]) && $_GET[tep_session_name()] != '') { $phpbb_action_data['cresn'] = tep_session_name(); $phpbb_action_data['cresid'] = tep_session_id(); } if (isset($_POST['viewonline'])) { $phpbb_action_data['viewonline'] = $_POST['viewonline']; } if (sizeof($navigation->snapshot) > 0) { $origin_href = tep_href_link($navigation->snapshot['page'], tep_array_to_string($navigation->snapshot['get'], array(tep_session_name())), $navigation->snapshot['mode']); $navigation->clear_snapshot(); tep_phpbb_redirect($phpbb_action_data, $origin_href); } else { tep_phpbb_redirect($phpbb_action_data, tep_href_link(FILENAME_DEFAULT, '', 'NONSSL')); }


6. Open logoff.php file, before
   $content = CONTENT_LOGOFF;
   add
   if (!$_GET['phpbb_logoff'] || $_GET['phpbb_logoff'] != 'yes') { tep_phpbb_redirect(array('action' => 'logout'), str_replace('&', '&', tep_href_link(FILENAME_LOGOFF, 'phpbb_logoff=yes', 'NONSSL'))); }


7. Open templates/content/create_account.tpl.php file, before
   <?php if (ACCOUNT_DOB == 'true') { ?>
   add
   <tr> <td class="main"><?php echo ENTRY_LOGIN_NAME; ?></td> <td class="main"><?php echo tep_draw_input_field('login_name') . ' ' . (tep_not_null(ENTRY_LOGIN_NAME_TEXT) ? '<span class="inputRequirement">' . ENTRY_LOGIN_NAME_TEXT . '</span>': ''); ?></td> </tr>


8. Open includes/languages/english.php file, after
   define('ENTRY_LAST_NAME_TEXT', '*');
   add
   define('ENTRY_LOGIN_NAME','Forum Login Name:'); define('ENTRY_LOGIN_NAME_ERROR','Your Forum Login Name must contain a minimum of 2 characters.'); define('ENTRY_LOGIN_NAME_EXIST_ERROR', 'Your Forum Login Name already exists in our records.'); define('ENTRY_LOGIN_NAME_TEXT','*'); define('ENTRY_FORUM', 'Forum');


9. Open includes/javascript/form_check.js.php file, after
   check_input("lastname", <?php echo ENTRY_LAST_NAME_MIN_LENGTH; ?>, "<?php echo ENTRY_LAST_NAME_ERROR; ?>");
   add
   check_input("login_name", 2, "<?php echo ENTRY_LOGIN_NAME_ERROR; ?>");


10. Open create_account.php file, change
    echo $cre_RCI->get('createaccount', 'check');
    to
    echo $cre_RCI->get('createaccount', 'check', false);
    change
    tep_redirect(tep_href_link(FILENAME_CREATE_ACCOUNT_SUCCESS, '', 'SSL'));
    to
    $loginname = tep_db_prepare_input($_POST['login_name']); tep_db_query("UPDATE " . TABLE_CUSTOMERS . " SET login_name = '" . $loginname . "' WHERE customers_id = '" . $customer_id . "'"); $phpbb_action_data = array( 'user_name' => tep_get_customer_login_name($email_address), 'password' => $password, 'email' => $email_address, 'action' => 'register' ); tep_phpbb_redirect($phpbb_action_data, tep_href_link(FILENAME_CREATE_ACCOUNT_SUCCESS, '', 'SSL'));


11. Open account_edit.php file, after
    if ($check_email['total'] > 0) { $error = true; $messageStack->add('account_edit', ENTRY_EMAIL_ADDRESS_ERROR_EXISTS); }
    add
    $login_name = tep_db_prepare_input($_POST['login_name']); if (strlen($login_name) < 2) { $error = true; $messageStack->add('account_edit', ENTRY_LOGIN_NAME_ERROR); } $check_login_name_query = tep_db_query("select count(*) as total from " . TABLE_CUSTOMERS . " where login_name = '" . tep_db_input($login_name) . "' and customers_id != '" . (int)$_SESSION['customer_id'] . "'"); $check_login_name = tep_db_fetch_array($check_login_name_query); if ($check_login_name['total'] > 0) { $error = true; $messageStack->add('account_edit', ENTRY_LOGIN_NAME_EXIST_ERROR); } $account_query = tep_db_query("select login_name from " . TABLE_CUSTOMERS . " where customers_id = '" . (int)$_SESSION['customer_id'] . "'"); $account = tep_db_fetch_array($account_query);
    after
    'customers_lastname' => $lastname,
    add
    'login_name' => $login_name,
    change
    $messageStack->add_session('account', SUCCESS_ACCOUNT_UPDATED, 'success'); tep_redirect(tep_href_link(FILENAME_ACCOUNT, '', 'SSL'));
    to
    if (!$_SESSION['phpbb_forward']) { $messageStack->add_session('account', SUCCESS_ACCOUNT_UPDATED, 'success'); } $phpbb_action_data = array( 'user_name' => tep_get_customer_login_name($email_address), 'email' => $email_address, 'old_username' => $account['login_name'], 'action' => 'edit' ); tep_phpbb_redirect($phpbb_action_data, tep_href_link(FILENAME_ACCOUNT, '', 'SSL'));


12. Open account_password.php file, change
    $messageStack->add_session('account', SUCCESS_PASSWORD_UPDATED, 'success'); tep_redirect(tep_href_link(FILENAME_ACCOUNT, '', 'SSL'));
    to
    $phpbb_action_data = array( 'user_name' => tep_get_customer_login_name('', $customer_id), 'email' => tep_get_customer_email($customer_id), 'password' => $password_new, 'action' => 'edit' ); tep_phpbb_redirect($phpbb_action_data, tep_href_link(FILENAME_ACCOUNT, '', 'SSL'));


13. Install phpbb3 on to your site.
    Follow the following steps:
    1. Down phpbb3 form here.
    2. Unzip the file, and then upload the whole forder "forum" to your catalog directory on the webserver.
    3. Follow the direction of forum/docs/INSTALL.html file to filish your install.


14. After phpBB3 Forum install, use admin account login, click the link "Administration Control Panel" at the forum's bottom, use the same account login again, then the page redriect to the amdin control panel, goto "general"->"Server configuration"->"Security settings", set "Allow persistent logins" option to "No", then save the option change.


15. Use admin account login, click the link "Administration Control Panel" at the forum's bottom, use the same account login again, then the page redriect to the amdin control panel, goto "general"->"Server configuration"->"Cookie settings", set "Cookie secure" option to "Disabled", then save the option change.


16. Open forum/includes/functions.php file, change
    'S_LOGIN_ACTION' => ((!defined('ADMIN_START')) ? append_sid("{$phpbb_root_path}ucp.$phpEx", 'mode=login') : append_sid("index.$phpEx", false, true, $user->session_id)),
    to
    'S_LOGIN_ACTION' => (!defined('ADMIN_START')) ? '../login.php?action=process&phpbb_forward=true' : append_sid("index.$phpEx", false, true, $user->session_id),
    change
    $u_login_logout = append_sid("{$phpbb_root_path}ucp.$phpEx", 'mode=logout', true, $user->session_id);
    to
    $u_login_logout = $phpbb_root_path . '../logoff.php?phpbb_forward=true'; if (request_var($config['cookie_name'] . '_cresn', '', false, true) && request_var($config['cookie_name'] . '_cresid', '', false, true)) { $u_login_logout .= (strstr($u_login_logout, '?') ? '&' : '?') . request_var($config['cookie_name'] . '_cresn', '', false, true) . '=' . request_var($config['cookie_name'] . '_cresid', '', false, true); }
    change
    $u_login_logout = append_sid("{$phpbb_root_path}ucp.$phpEx", 'mode=login');
    to
    $u_login_logout = $phpbb_root_path . '../login.php?phpbb_forward=true';
    change
    'U_REGISTER' => append_sid("{$phpbb_root_path}ucp.$phpEx", 'mode=register'),
    to
    'U_REGISTER' => $phpbb_root_path . '../create_account.php?phpbb_forward=true',


17. Open forum/ucp.php file, before
    define('IN_PHPBB', true);
    add
    if ($_GET['i'] == 'profile' && $_GET['mode'] == 'reg_details') { $current_url = (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] != 'off') ? 'https' : 'http' . '://' . $_SERVER['SERVER_NAME'] . ($_SERVER["SERVER_PORT"] == 80 ? '' : ':' . $_SERVER["SERVER_PORT"]) . $_SERVER["REQUEST_URI"]; $temp_url = strstr($current_url, '?') ? substr($current_url, 0, strpos($current_url, '?')) : $current_url; $temp_url = strstr($temp_url, basename($_SERVER['PHP_SELF'])) ? substr($temp_url, 0, -1 * strlen(basename($_SERVER['PHP_SELF']))) : $temp_url . '/'; header('Location: ' . $temp_url . '../account.php?phpbb_forward=true'); }


18. Open forum/index.php file, change
    'S_LOGIN_ACTION' => append_sid("{$phpbb_root_path}ucp.$phpEx", 'mode=login'),
    add
    'S_LOGIN_ACTION' => '../login.php?action=process&phpbb_forward=true',


19. Run SQL statement in phpMyAdmin:
    ALTER TABLE `customers` ADD `login_name` VARCHAR( 255 ) NULL ; UPDATE `customers` SET `login_name` = `customers_email_address` ; ALTER TABLE `customers` ADD UNIQUE ( `login_name` )


20. Register an account in your store, at create account page(http://your_web_site/create_account.php), the filed "Forum Login Name" and "Password" should be same with the forum's admin's name and admin's password which are used in installing the forum. The account just your created is bound with forum's admin account.

How can I uninstall CRE Loaded : phpBB3 Forum Module?

    1. Delete all files that you added

    2. Change all modified files back.

    3. Drop the tables which created by phpBB.

    4. Run SQL statement in phpMyAdmin:
        ALTER TABLE `customers` DROP `login_name`;

What if I encounter problems?

    Please see the troubleshooting section in the FAQ.