Plug-in Installation

plumpbustlingInternet και Εφαρμογές Web

4 Δεκ 2013 (πριν από 3 χρόνια και 6 μήνες)

100 εμφανίσεις

CB Connec
tor v2.0.0 Plugin

for Community Builder 1.
2.
x


Written by Greg Effland, and Martijn de Jong

Version 2.0.0 release
d

on
9
-
20
-
2008

Page
1

of
10

Visit our project website at:
http://cbconnector.com



Table of Contents

Introduction

................................
................................
................................
................................

1

Before you begin

................................
................................
................................
........................

1

Licensing

................................
................................
................................
................................
....

1

Minimum Requirements

................................
................................
................................
.............

2

Recommended Options

................................
................................
................................
..............

2

Plug
-
in Features

................................
................................
................................
..........................

3

General

................................
................................
................................
................................
...

3

Registration and Management

................................
................................
................................

3

User Synchronization

................................
................................
................................
.............

3

User Profile

................................
................................
................................
............................

4

Supported Accessories

................................
................................
................................
...........

4

Plug
-
in Installation

................................
................................
................................
.....................

5

Front
-
end Plug
-
in Usage

................................
................................
................................
............

7

Admin Back
-
end Plug
-
in Usage

................................
................................
................................
.

8

Detailed Change

Log

................................
................................
................................
................

10

I
ntroduction

Thank you for downloading the
CB Connector

plug
-
in

written for
Community Builder 1.
2.
x

or newer
. This
plug
-
in

will create a connection between your Joomla website and your forum.

Currently this
plug
-
in

s
upports
Categories Hierarchy,
php
BB
2 and phpBB3
. In the future this
plug
-
in

may support other forums as well.
This
plug
-
in

won’t edit core files, hack the user
database or in any other way change either of these applications to make this connection
possi
ble.

Before you begin

We recommend that you test this
plug
-
in

on a test system before using on your live site.
Use
this code at your own risk, we are not responsible for any damage this guide, codes, or a
combination of both can do on your system. Always

backup you entire database and file
structure before you install
the
work of others.
N
ote that the creators of this
plug
-
in

are not
professional PHP
or

M
y
SQL
developers.


T
h
is

means that there could be things in the code
that are not compliant with curre
nt standards.

If you run into trouble or think something in
our code can be done
better
, please go to our website

(
cbconnector.com
)
.

We also watch the

PHPBB Plugin
-
Connector
” forum at
http://www.joomlapolis.com
.

Licensing

Currently this software is licensed under the
“GNU LESSER GENERAL PUBLIC LICENSE,
Version 2.1,

February 1999
.


As such this software is provided free of charge for personal,
public, or commercial use and can be included as part of proprietary software, although we
prefer that it be included with free software.
CB Connec
tor v2.0.0 Plugin

for Community Builder 1.
2.
x


Written by Greg Effland, and Martijn de Jong

Version 2.0.0 release
d

on
9
-
20
-
2008

Page
2

of
10

Visit our project website at:
http://cbconnector.com


Minimum
R
equirements



Joomla Version 1
.0.x must be already installed




Community Builder (CB) 1.
2
.x

or higher must be already

installed



The CB
login module
must
be

installed and published
.



Categories Hierarchy,
phpBB
2 or phpBB3

is already installed

and working properly
.



Your
web server

must hav
e
PHP
4.x or newer



Your
web server

must have MySQL 4.1.x or newer



The xAjax Mambot must be installed
BEFORE you install

the
CB Connector
.

Use the one from our site as the standard one from Phil Taylor does not yet load xAjax
files for CB plugins.

Recommen
ded Options



Disable registration on your phpBB Forum
.
It is
highly

recommended that you
disable the registration on your phpBB forum. This is because when users register
t
h
rough
the forum

they won’t be added to Joomla or Community Builder.


o

To disable reg
istrations
for phpBB2
you can



hack the core fil
es of phpBB. To hack the core files simply edit the
profile.php file and delete the part that says “
|| $mode == 'register'


not including the outer quotes. This will make it so that when the user
tries to

register they will see the index page. This combined with some
minor template work to remove the “Register” link from the header
should stop phpBB registrations and avoid confusing the users with a
link that doesn’t work.



O
r

you can
use a MOD called “Reg
istration stopper”. The MOD and
the instructions on how to hack the core files can both be found at
cbconnector.com
.

o

To disable registrations for phpBB3 you can simply select “Disable” for the

Account Activation
” se
tting in “User registration settings.”



Disable registration thru Joomla
.

o

For current versions of Joomla! you can disable registrations in the Site
Configuration area. Then enable registrations in the Community Builder
Configuration area to allow registr
ations regardless of Joomla! settings.

o

For older versions of Joomla! t
his can easily be done by installing the mambot

Disable Joomla Registratio
n
-
Force CB Registration
” available on the Joomla
Extensions website.

This makes it so a
user

must register thru Community
Builder instead of directly thru Joomla by typing in the URL.



Install
CB Captcha
Plug
-
in
... yet another method to help reduce spammers.



Consider making your CB profiles only viewable by registered users
.

This also
should help reduce spammers getting user information from your
website.

CB Connec
tor v2.0.0 Plugin

for Community Builder 1.
2.
x


Written by Greg Effland, and Martijn de Jong

Version 2.0.0 release
d

on
9
-
20
-
2008

Page
3

of
10

Visit our project website at:
http://cbconnector.com


Plug
-
in

Features

General



The
plug
-
in

has Multi
-
language support.

Currently we include the English
,
Dutch
,
Italian, and German

language files. Hopefully we will include more as this releases
final.



The
plug
-
in

automatically publishes itself durin
g installation.



The forum directory can be set in
the
plug
-
in

parameters.



This plug
-
in currently supports
Categories Hierarchy,
phpBB2
or

phpBB3

forums
.



In the future additional forums may be supported
.

Registration

and

M
anagement



When registering

in CB
, u
ser
s

will be validated
against existing CB and
forum

users,
and inserted into
forum user tables
also
.

NOTE: Community Builder v1.2 includes
AJAX username checking routings. At the time of the release of this plugin it was not
possible to have
CB Connecto
r

respond to the AJAX username checking routines. I
am working with Beat to allow this interaction in future Community Builder versions.



When the user profile gets edited

in CB
changes
to usernames, passwords, or e
-
mail
addresses
will
also
be made in

foru
m
.



The user can Edit their phpBB profile settings from their CB Profile.

(phpBB2 only)



When
the
user gets
confirmed

and/or approved
the
ir

forum

account will be activated.



Administrators
may choose
between “D
elet
e

only the

U
ser


or
“D
elet
e

U
ser and
everythi
ng from User,” which includes
all of their topics, posts, poll votes, bans and
private messages.



If the “Delete o
nly
the
User” option is selected the username will have a * added to the
front and the user will be made inactive. This keeps the users post i
n the database and
makes sure topics from others are not hidden. phpBB apparently does not show topics
when any of the posts came from a user_id which does not exist. In the future we will
also add a “Deleted” rank and tag the user with that rank.



When a

user is deleted in CB the plug
-
in does some general cleanup to the Joomla
tables to delete remaining user data th
at

Joomla
!

does not delete with the user.



The plug
-
in also

allows
a
manual
forum

user ID

value
to be entered in
the
admin back
-
end

User Manage
ment screen
of C
ommunity Builder
.



Joomla
!

1.0.13 introduced a new password encryption which differs from some
forums. The plug
-
in now has a way to reset the forum’s password to the correct
encryption upon logging into Joomla
!
/CB.

User
Synchronization



Admi
nistrators
can view a list of the currently synchronized users.



Administrators
can Un
-
synchronize
currently synchronized users.



Administrators
can Synchronize matching users in Joomla
!

and
the forum
.



Administrators
can
E
xport users
already registered in
Jo
omla
!

to
the forum
.

CB Connec
tor v2.0.0 Plugin

for Community Builder 1.
2.
x


Written by Greg Effland, and Martijn de Jong

Version 2.0.0 release
d

on
9
-
20
-
2008

Page
4

of
10

Visit our project website at:
http://cbconnector.com




Administrators
can
Im
port users
already registered in

the forum
to Joomla
!
.



Administrators
can view a list of the current users which interfere between Joomla
!

and
the forum
. These users have matching usernames but different passwords
.



The
plug
-
in

has a unique control panel to help
administrators
manage synchronization
.

User
Profile



To the right of the user picture you can see the Forum Ranking and Total posts of the
user.



A

“Forum”
tab
is shown
in
the
user profile that lists
the curren
t
topic
subscriptions and
the
posts that user
has
made.


o

Current subscriptions are only available when looking at your own CB Profile

o

A
list of Forum Posts is filtered based on the viewing user’s
forum
privileges… SO those hidden posts can stay hidden fr
om unauthorized eyes!



A “Forum Profile” tab is shown in the user profile the shows all of the phpBB profile
settings for the user. These can be edited
(phpBB2 only)

in the CB profile by using
the Edit


Update Your Profile menu near the top of the CB Prof
ile. They are then
found on the Forum Profile tab. Changes to this information go directly to the phpBB
database and are not duplicated in the CB or Joomla tables, minimizing duplicate data.

Supported Accessories

The following Accessories are supported a
nd available for download from
cbconnector.com

and
joomlapolis.com
.



CBC Wrapper
. This is a modified version of the Joomla
!

Wrapper which allows for
the forum to be viewed insi
de a wrapper in your main site. The CBC Wrapper also
integrates with the
CB Connector

and the other accessories to allow links to forum
posts to also open within the CBC Wrapper. The CBC Wrapper can also open forum
links in a separate window. By using t
his feature, the CBC Wrapper can append the
valid SID for the user onto the link and help eliminate cases where the users are
logged in but the forum appears to not have them logged in.

The CBC Wrapper now
also includes the ability to Dynamically Modify F
orum Links.



CBC Query Module
. This module connects directly to the
CB Connector

and
integrates with the CBC Wrapper if installed. By default its links will open where
CB
Connector

says to open them but it can be adjusted to open in a specific location (s
ame
as CBC Wrapper). This module can show Last Created Topics, Last Answered
Topics, Most Viewed Topics, Most Replied Topics, Last Posts, Most Active Forum
Users, Least Active Forum Users, Newest User to Forum, Last Visiting Users to
Forum, My Last Posts,

My Last Answered Posts, My Received Private Messages (thru
phpBB), and My Sent Private Messages (thru phpBB). For an up to date list of
features refer to its documentation



CBC Searchbot
.

This searchbot allows searching of forum posts and topics thru the
normal Joomla Search mechanism. Since this connects directly to the
CB Connector

it
does not require any separate database settings, and it only returns posts that the
CB Connec
tor v2.0.0 Plugin

for Community Builder 1.
2.
x


Written by Greg Effland, and Martijn de Jong

Version 2.0.0 release
d

on
9
-
20
-
2008

Page
5

of
10

Visit our project website at:
http://cbconnector.com


viewing user has authorization to view.

It can also integrate with the CBC Wrapper
for

forum links
.

Plug
-
in

Installation

This
plug
-
in

is installed in the same manner as any other C
ommunity Builder

Plug
-
in
.

1.

Carefully read the Minimum Requirements section earlier in this document.

2.

Download the Install ZIP File from
www.joomlapolis.com

or
cbconnector.com
.

3.

G
o to the

Components
-

Community Builder
-

Plug
-
in

Management


screen as shown
in Figure 1.



Figure
1


4.

From that screen look near the

bottom at the ‘
Install New
Plugin
’ section as shown in
Figure 2.



Figure
2


5.

Click the ‘
Browse

button

and go to the directory which contains the install ZIP file
and select the ZIP file and click ‘Open’ (or double click on the f
ile itself)

6.

Click the ‘
Upload File & Install
’ button. This will install the
plug
-
in
. After installing
you will see a ‘Success’ message indicating that the install finished successfully.

If
CB Connec
tor v2.0.0 Plugin

for Community Builder 1.
2.
x


Written by Greg Effland, and Martijn de Jong

Version 2.0.0 release
d

on
9
-
20
-
2008

Page
6

of
10

Visit our project website at:
http://cbconnector.com


you have previously installed the phpBB connector you will also
see some notes about
the migration of data from the phpBB connector to the
CB Connector
.

7.

Click on ‘
Continue



[continued on next page]

8.

Now from the
Plug
-
in

Management

screen click on ‘
CB Connector
’. This will take
you to the Parameters Screen for the
plug
-
in

as shown in Figure 3.



Figure
3


9.

Now from this screen make sure the parameters are set as desired.

10.

Starting with the ‘
Locate Forum By
’ make sure this indicates the desired method for
locating the forum directory. The defau
lt is ‘
Based on DOCUMENT_ROOT
’. Some
IIS servers have an issue with this variable so we have added alternate methods to
locate the forum directory.
On those IIS Servers

Based on DOCUMENT_ROOT


will
not be shown as an option.
Refer to Figure 4 for furthe
r options.

CB Connec
tor v2.0.0 Plugin

for Community Builder 1.
2.
x


Written by Greg Effland, and Martijn de Jong

Version 2.0.0 release
d

on
9
-
20
-
2008

Page
7

of
10

Visit our project website at:
http://cbconnector.com




Figure
4


11.

Now enter the ‘
Directory for
the Forum
’ based on the method entered for ‘
Locate
Forum By
’. When this path is correct is will indicate so under the forum path as
shown in Figure 5. Figure 6 shows what the m
essage will look like if incorrect.



Figure
5



Figure
6


12.

Go through the other parameters and set them as desired.

13.

After getting the other parameters set as desired Click the ‘
Apply
’ button in the uppe
r
right.

14.

It is suggested to go through the
Plug
-
in

Control Panel and synchronize some users.
Users which are not synchronized should not break the
plug
-
in

but they will not be
automatically logged into or out of phpBB.

15.

Start using the
plug
-
in
.

Front
-
end
P
lug
-
in

Usage

From the front
-
end the plug
-
in
-
in is accessible from the user’s CB profile. The menu item
may vary its name based on the admin’s settings when they set up the menu.


To the right of the User’s
A
vatar or image the “Forum Ranking” and “Total Po
sts” will be
shown.


Below the User’s Avatar you will see 2 tabs from this plug
-
in,
Forum

and
Forum Profile
.


The
Forum

Tab shows the User’s Forum Posts. If the viewer is the user then it shows all of
the user’s posts and all of the user’s subscriptions.

If the viewer is not the user then it does
not show the subscriptions and only shows the user’s post which the viewer is allowed to
CB Connec
tor v2.0.0 Plugin

for Community Builder 1.
2.
x


Written by Greg Effland, and Martijn de Jong

Version 2.0.0 release
d

on
9
-
20
-
2008

Page
8

of
10

Visit our project website at:
http://cbconnector.com


view. From this tab you may click on any of the shown posts or subscriptions and be
forwarded to the desired thread or po
st.


The
Forum Profile

tab shows the users profile setting for the forum
. This tab may also
contain a link to the forum’s page where they can edit these settings.

Admin Back
-
end
Plug
-
in Usage

On the admin back
-
end there are 2 sides to the plug
-
in’s parame
ters.


The left side, “Plug
-
in Common Settings,” shows all of the standard Joomla/CB settings.
Refer to the Joomla or CB instructions for more information.


The right side, “Parameters,” shows the plug
-
in settings specific to the
CB Connector
.


Forum S
ettings



Debug Mode:

o

This setting will enable some extra debugging tools to help find issues on your
site. NOTE: Some servers do not allow re
-
entry to the plugin parameters
screen with Debug Mode Enabled… To solve this click on the ‘Reset Params’
link nex
t to the CB Connector title in the CB Plugin Management screen.



Website Character Encoding:

o

This is the character encoding that your site uses. Default is ISO
-
8859
-
1



Website Database Character Encoding:

o

This is the character encoding that your site’s data
base uses. Default is ISO
-
8859
-
1



Forum Database Character Encoding:

o

This is the character encoding that your Forum’s database uses. Default is
ISO
-
8859
-
1 for CH or phpBB2, and is UTF
-
8 for phpBB3



Plug
-
in to Use:

o

This setting indicates which type of forum

the connector is to connect with.

Currently
CH,
phpBB2 and phpBB3 are the options



Locate Forum By:

o

This setting indicates how the
CB Connector

is to define the forum directory.
Current options include Based on DOCUMENT_ROOT, Joomla Install Root,
and an
Absolute Path.



Directory for the Forum:

o

This setting, following the directions of the
Locate Forum By

setting tells the
CB Connector

the directory of the forum files



Forum URL Override:

o

This setting tells the
CB Connector

what URL to use for forum links.
It can be
useful when using absolute paths, or when you desire a subdomain link to the
forum.



Auto Login
-
Logout Forum:

CB Connec
tor v2.0.0 Plugin

for Community Builder 1.
2.
x


Written by Greg Effland, and Martijn de Jong

Version 2.0.0 release
d

on
9
-
20
-
2008

Page
9

of
10

Visit our project website at:
http://cbconnector.com


o

This setting indicates whether the
CB Connector

is to automatically log the
user in and out of the forum when they log in and out of Joom
la/CB



Allow Persistent Forum Logins:

o

This setting tells CBC whether to pass the ‘remember me’ flag to the forum
when ‘remember me’ is selected for a site login.



Check Forum Usernames:

o

This setting indicates whether to check the Joomla/CB usernames when
reg
istering or changing, against the valid usernames already in the forum
user’s table



Register Forum User Settings:

o

This setting indicates if the
CB Connector

should register user in the forum
when new users register in Joomla/CB



Avatar Sync Settings:

o

This s
etting is currently ignored



Delete Forum User Settings:

o

This setting indicates how users are to be deleted from the forum when they
are deleted in Joomla/CB



Joomla Delete Cleanup:

o

This setting indicates if the
CB Connector

should cleanup the Joomla DB
tabl
es when a user is deleted in Joomla/CB.


Synchronization



Users per page:

o

This setting indicates how many users to show at one time when using the
control panel



Plugin control panel:

o

This link opens the
CB Connector

control panel



View README.PDF
:

o

This link
shows the README.PDF (this file)



Visit Project Website
:

o

This link opens a browser window showing the project website
(cbconnector.com)


Hyperlink and Menu Options



Hyperlink Target
:

o

This setting determines the target for forum links shown in the CB profile
.

Current options include Open in New Window, Open in Same Window, Open
in CBC Wrapper (an optional wrapper component). Some modules like the
CBC Query Module also can use this setting to determine the target of their
forum links.



CBC Wrapper Menu Item:

CB Connec
tor v2.0.0 Plugin

for Community Builder 1.
2.
x


Written by Greg Effland, and Martijn de Jong

Version 2.0.0 release
d

on
9
-
20
-
2008

Page
10

of
10

Visit our project website at:
http://cbconnector.com


o

T
his selects which CBC Wrapper Menu item is used when linking to the CBC
Wrapper. This is handy for cases where multiple menu items exist for the
CBC Wrapper (i.e. one in a new window, one in same window, etc.)


User Profile Options



Show Forum Ranking
:

o

Thi
s setting indicates whether to show the Forum Ranking on the CB Profile.



Show Post Stats
:

o

This setting indicates whether to show the Post Stats on the CB Profile.
Currently the post stats include the Total Posts



Show Subscriptions
:

o

This setting indicates
whether to show the Forum Subscriptions on the users
own CB Profile.



Posts per page
:

o

This setting indicates how many Forum Posts to show at one time on the CB
Profile.



Show forum posts with paging:

o

This setting indicates whether to paginate the Forum Posts

or only show a
limited amount



Allow search function:

o

This setting indicates whether to show the Search Box on the CB Profile
Forum Posts.


Admin Manual Synchronization of Users

Users may also be manually synchronized from the admin back
-
end. First go to
“Components


Community Builder


User Management”. Then click on the desired user. On their
“Forum” tab you will see a
Forum ID
. This
Forum ID

is the user number of that user in the
forum. You may need to manually check the forum’s user tables to dete
rmine what the
correct
Forum ID

should be.

Detailed
C
hange

L
og

A

non
-
exhaustive
, but detailed

change

log for the
CB Connector

plug
-
in

can be found at
http://cbconnector.com/tracker/changelog
_page.php

This includes change log items for
supported
accessories

but does not include change log history prior to version 2.0.0 Alpha 1
.
T
hanks to all of those people who have contributed suggestions, bug reports, and code fixes.