ParaChat Integration & Authentication Integration v1.7

      Supported ParaChat Version: 7.0 and above
      Integration Version: 2.0 (this document)
      Support for phpBB: v2.0.1x
      Release Date: 2-22-2006

    Overview

      This document explains the process for seamlessly integrating ParaChat Java™ Chat Rooms within your phpbb 2.0.1x forum. Although both free and paid ParaChat services alike can be integrated, only the ParaChat Professional and Enterprise service levels provide full functionality.

      Installation will require 10 to 15 minutes, depending upon your proficiency with installing add-ons to phpBB. Scroll down to "Installation Instructions" to get started immediately, or continue reading to learn about the features included (and see screenshots of the add-on).

      [Return to top of page]
    Features

    • Chat room may be placed in it's own phpbb page.



    • Automatic user login.
    • Show number of users chatting.



    • [Return to top of page]
    Installation Instructions

    Step 1.

      As with any phpbb mod, you should first make a complete backup of your forum.

    Step 2.
      Your ParaChat room is available for free or for control and to have adminstrative options you can license our hosted service from http://www.parachat.com. A ParaChat Professional account is neccesary to take full advantage of all included features, but is not required.

      Edit and save the included chat.tpl file using your favorite text editor. Instructions are included within the file. You will need to know your ParaChat Site ID and Room Name (provided when registering for ParaChat service)

    Step 3.
      Upload (using FTP or similar) or copy the included files listed below to the base directory of your phpBB forum.

      • copy chat.php to (phpbb root directory) chat.php
      • copy chatauth.php to (phpbb root directory) chatauth.php
      • copy chat.tpl to templates/subSilver/chat.tpl

    Step 4

      Open faq.php

      Scroll to (or use your browser Find feature) find the following code:

      switch( $HTTP_GET_VARS['mode'] )
      {
      case 'bbcode':
           $lang_file = 'lang_bbcode';
           $l_title = $lang['BBCode_guide'];
           break;



      Just below the above code, add the following:

      <!-- START NEW PARACHAT CODE -->
      case 'chat':
           $lang_file = 'lang_chat';
           $l_title = $lang['Chat_FAQ'];
           break;
      <!-- STOP NEW PARACHAT CODE -->

      Save and close file

    Step 5

      Open admin/index.php

      Scroll to (or use your browser Find feature) find the following code:

      case PAGE_FAQ:
           $location = $lang['Viewing_FAQ'];
           $location_url = "index.$phpEx?pane=right";
           break;



      Just below the above code, add the following:

      <!-- START NEW PARACHAT CODE -->
      case PAGE_CHAT:
           $location = $lang['Chat'];
           $location_url = "chat.$phpEx?pane=right";
           break;
      <!-- STOP NEW PARACHAT CODE -->

    Step 6

      Continue working with admin/index.php

      Scroll to (or use your browser Find feature) find the following code:

      case PAGE_FAQ:
           $location = $lang['Viewing_FAQ'];
           $location_url = "index.$phpEx?pane=right";
           break;



      Just below the above code, add the following:

      <!-- START NEW PARACHAT CODE -->
      case PAGE_CHAT:
           $location = $lang['Chat'];
           $location_url = "chat.$phpEx?pane=right";
           break;
      <!-- STOP NEW PARACHAT CODE -->

      Save and close file

    Step 7

      Open includes/constants.php

      Scroll to (or use your browser Find feature) find the following code:

      define('PAGE_GROUPCP', -11);



      Just below the above code, add the following:

      // -- Embed ParaChat: Begin ----------
      // Add -------------------------------
      define('PAGE_CHAT', -1185);
      // -- Embed ParaChat: End ------------

      Save and close file

    Step 8

      Open includes/page_header.php

      Scroll to (or use your browser Find feature) find the following code:

      d'L_USERGROUPS' => $lang['Usergroups'],



      Just below the above code, add the following:

      // -- Embed ParaChat: Begin ---------
      // Add ------------------------------
      'L_CHAT' => $lang['Chat'],
      // -- Embed ParaChat: End ----------->

    Step 9

      Continue working with includes/page_header.php

      Scroll to (or use your browser Find feature) find the following code:

      'U_GROUP_CP' => append_sid('groupcp.'.$phpEx),



      Just below the above code, add the following:

      // -- Embed ParaChat: Begin --------
      // Add -----------------------------
      'U_CHAT' => append_sid('chat.'.$phpEx),
      // -- Embed ParaChat: End ----------

      Save and close file

    Step 10

      Open language/lang_english/lang_main.php

      Scroll to (or use your browser Find feature) find the following code:

      $lang['BBCode_guide'] = 'BBCode Guide';



      Just below the above code, add the following:

      // -- Embed ParaChat: Begin --------
      // Add -----------------------------
      $lang['Chat'] = 'Chat';
      $lang['Chat_FAQ'] = 'Chat FAQ';
      // -- Embed ParaChat: End -----------

      Save and close file

    Step 11

      Open templates/subSilver/overall_header.tpl

      Scroll to (or use your browser Find feature) find the following code:

      # Note: This is a partial match. The actual line is much longer.

      <table cellspacing="0" cellpadding="2" border="0">
      <tr><br> <td align="center" valign="top" nowrap="nowrap"><span class="mainmenu">&nbsp;<a href="{U_FAQ}" class="mainmenu"><img src="templates/subSilver/images/icon_mini_faq.gif" width="12" height="13" border="0" alt="{L_FAQ}" hspace="3" />{L_FAQ}</a</span><br>


      in this line find the following code:

      {L_USERGROUPS}</a>&nbsp;


      Just below the above code, add the following:

      &nbsp;<a href="{U_CHAT}" class="mainmenu"><img src="templates/subSilver/images/icon_mini_profile.gif" width="12" height="13" border="0" alt="{L_CHAT}" hspace="3" />{L_CHAT}</a>&nbsp;

      Save and close file

    Optional Step 12 - Number of Users Chatting

      These modifications will only work with ParaChat Professional and above.
      This modification is to add the number of users chatting in the chat room
      The overall_header.tpl template is modified

      The example code provided will need to be modified to match your ParaChat Site ID
      In the <param name="query.Site" value="xxx"> where
      "xxx" = your Site ID provided to you by ParaChat

      Open templates/subSilver/overall_header.tpl

      Scroll to (or use your browser Find feature) find the following code:


      # Note: This is a partial match. The actual line is much longer.

      <td height="25" align="center" valign="top" nowrap="nowrap"><span class="mainmenu">&nbsp;<a href="{U_PROFILE}" class="mainmenu"><img src="templates/subSilver/images/icon_mini_profile.gif" width="12" height="13" border="0" alt="{L_PROFILE}" hspace="3" />{L_PROFILE}</a>&nbsp; &nbsp;<a href="{U_PRIVATEMSGS}" class="mainmenu"><img src="templates/subSilver/images/icon_mini_message.gif" width="12" height="13" border="0" alt="{PRIVATE_MESSAGE_INFO}" hspace="3" />{PRIVATE_MESSAGE_INFO}</a>&nbsp; &nbsp;<a href="{U_LOGIN_LOGOUT}" class="mainmenu"><img src="templates/subSilver/images/icon_mini_login.gif" width="12" height="13" border="0" alt="{L_LOGIN_LOGOUT}" hspace="3" />{L_LOGIN_LOGOUT}</a>&nbsp;</span></td>


      Just below the above code, add the following:

      </tr>
      <tr>
      <td height="25" align="center" valign="top" nowrap="nowrap">
      <span class="mainmenu">
      <a href="{U_CHAT}" class="mainmenu">Number Of Users Chatting</a>
      </span>
      <!-- Begin Counter Code -->
      <applet codebase="http://host7.parachat.com/pchat/applet"
      archive=counter.jar code="count.ChatCounter.class" width=10 height=9>
      <param name="query.Site" value="xxx">
      <param name="ui.bg" value="FFFFFF">
      <param name="ui.fg" value="0000FF">
      <param name="ui.FontSize" value="11">
      <param name="ui.FontName" value="Helvetica">
      </applet>
      <!-- End Counter Code -->
      </td></tr>

      Save and close file

    Optional Step 13 - Adding Profile URL

      This modification will only work with ParaChat Professional and above.
      You can add the ability to have a user's profile URL displayed in the chat room.
      This modification must be enabled in your ParaChat Service Administration Pages

      More information can be found in the link below:

      http://www.parachat.com/documentation/hosted7/Hosted_Solutions_v7.htm#Web_Administration/site/member_profile.htm
      You must enter the static part of your URL in the Service Administration Pages. This static URL
      is simlar to the one below:

      Example: http://www.<yourdomain>.com/<phpbb directory>/profile.php?mode=viewprofile&u=

      <yourdomain> = your site domain

      <phpbb directory> is the root of your phpbb directory. If your phpbb forum is installed in the root
      directory of your site, the static profile URL could look like this:

      Example: http://www.<yourdomain>.com/profile.php?mode=viewprofile&u=

    Optional Step 14 - Who's Chatting
      This modification will only work with ParaChat Professional and above.
      You can add Who's Currently Chatting in the Who is Online area.
      The index_body.tpl template is modified

      The example code provided will need to be modified to match your ParaChat Site ID
      In the code below make sure to replace site=XXXX with
      "xxx" = your Site ID provided to you by ParaChat

      Open templates/subSilver/index_body.tpl

      Scroll to (or use your browser Find feature) find the following code:


      <td class="row1" align="left"><span class="gensmall">{TOTAL_USERS_ONLINE} &nbsp; [ {L_WHOSONLINE_ADMIN} ] &nbsp; [ {L_WHOSONLINE_MOD} ]<br />{RECORD_USERS}<br />{LOGGED_IN_USER_LIST}</span></td>


      Place the code below between "{LOGGED_IN_USER_LIST} <place code here> </span></td>

      <br>Who's Currently Chatting:<br>
      <!-- Begin Who's Chatting Code -->
      <iframe src='http://host7.parachat.com/pchat/applet/userlist.php?site=XXXX&font=arial&bg=EFEFEF&fcolor=000000&fsize=10' framespacing='0' frameborder='no' scrolling='yes' width='100%' height='100'>
      You do not have iframes enabled.
      <a href="http://direct.parachat.com/iframe.html">More Info</a></iframe>
      <!-- End Who's Chatting Code -->

      Save and close file

    Optional Step 15 - Authenticate Off Your phpBB Database

      This modification will only work with ParaChat Advanced, Professional and above.

      You can authenticate against your phpBB database. This should be used if you are going to create a room for members AND non-members.

      Log into your service admin pages and navigate to Site Settings >>> Database Options >>> External Database Connection

      Enable "Use HTTP User Authentication"

      Under "URL of Web Authentication" enter the entire URL string to the chatauth.php file located in your phpBB root directory.
        example: http://www.webpage.com/chatauth.php
      Save your setting and you are done.