Connector API for vBulletin

[Noodles24]

What it does
Allows you to access vBulletin functions and data through an API. This is useful if you want to tie vBulletin into a larger site and allow the users to only have 1 login for site/forum.

Allows other applications to edit data in vBulletin

Warning
This API opens up a lot of the internal functions of vBulletin, use it carefully and do not trust any input from the browser. Clean and validate your inputs!

Installation
Unzip the files into your the root of your forum
You may need to change

/* User changable options */
// change this to your forum path.
$forumroot = $_SERVER['DOCUMENT_ROOT']."forum";
/* end of User changable options */

in the connector.class.php if your forum doesn't sit in /forum/ on your site.

[0.02]
Added addUser function
Added delUser function
Added getUser function
Added editUser function
Cleaned up code
Added comments
Fixed warnings in 3.5.4
Fixed PHP4 incompatability

[0.01]
Initial quick dirty release.
Includes basic API
Allows login/logout through API

TODO:
Error checking function(s)
Forum listings
Topic/Post listings

[Connector]

what can i use this for ?

[Noodles24]

So far you can use it to log users in and out from your webpage, outside of vbulletin

I'm still expanding it to do more though

[DeMiNe0]

Could you post an example of how someone would do that with this hack?

[Floris]

yourstuff.php <-APIplugin-> vBulletin
(login)-------------^------(login)

^-- mental screenshot

[Paul M]

yourstuff.php <-APIplugin-> vBulletin
(login)-------------^------(login)
Huh ?

[Snake]

I'm not sure what's the use of this. :ermm:

[Blaine0002]

external login for your webpage that ISNT vbulletin.

[Noodles24]

Today I'm adding:

- edit user
- delete user
- add user

To come:
- list forums
- latest posts

Any requests?

[akanevsky]

public function...
This will only work with php5. I recommend you make it compatible w/ php4, else it won't prove useful to most users.

[Noodles24]

Ok thanks, I'll look into that

[eXaulz]

I think functions like:

list forums
list posts in x forum
list new posts in either all forums or by id
etc..

should just return an Array. Echo'ing or return'ing a table/pre-desgined design wouldn't really be useful. Returning a fetched_array would be MUCH better.

[[email protected] vbmenu_register("postmenu_969884", true);]

is it working with 3.54? anyone made it work?

Its returning lots of errors with previous declared constants and such.

[[email protected] vbmenu_register("postmenu_970056", true);]

Sorry, now i have a full detailed error
Upon configuration and run this script on 3.54 i got the following.


Notice: Undefined index: HTTP_REFERER in /forum/includes/class_core.php on line 1574
Notice: Undefined index: charset in /connector/connector.class.php on line 54
Notice: Undefined variable: specialtemplates in /connector/connector.class.php on line 65
Notice: Undefined index: url in /forum/includes/class_core.php on line 1992
Notice: Undefined index: HTTP_REFERER in /forum/includes/class_core.php on line 1998
Notice: Constant IPADDRESS already defined in /forum/includes/class_core.php on line 1542
Notice: Constant ALT_IP already defined in /forum/includes/class_core.php on line 1546
Notice: Constant SCRIPTPATH already defined in /forum/includes/class_core.php on line 1550
Notice: Constant SCRIPT already defined in /forum/includes/class_core.php on line 1562
Notice: Constant WOLPATH already defined in /forum/includes/class_core.php on line 1566
Notice: Constant SESSION_IDHASH already defined in /forum/includes/class_core.php on line 1569
Notice: Constant SESSION_HOST already defined in /forum/includes/class_core.php on line 1570
Notice: Constant USER_AGENT already defined in /forum/includes/class_core.php on line 1573
Notice: Undefined index: HTTP_REFERER in /forum/includes/class_core.php on line 1574
Notice: Constant REFERRER already defined in /forum/includes/class_core.php on line 1574
Notice: Undefined variable: show in /connector/connector.class.php on line 121
Notice: Undefined index: HTTPS in /forum/includes/functions.php on line 1517
Notice: Undefined index: HTTPS in /forum/includes/functions.php on line 1517
Notice: Undefined index: membergroupids in /forum/includes/functions.php on line 278
Notice: Undefined index: forumpermissions in /forum/includes/functions.php on line 3272
Notice: Undefined index: 1 in /forum/includes/functions.php on line 3281
Notice: Undefined index: 2 in /forum/includes/functions.php on line 3281
Notice: Undefined index: hasaccessmask in /forum/includes/functions.php on line 3286
Notice: Undefined index: HTTPS in /forum/includes/functions.php on line 1517
Notice: Undefined index: HTTPS in /forum/includes/functions.php on line 1517
Notice: Undefined index: HTTPS in /forum/includes/functions.php on line 1517
Notice: Undefined index: HTTPS in /forum/includes/functions.php on line 1517
Notice: Undefined index: HTTPS in /forum/includes/functions.php on line 1517
Notice: Undefined index: HTTPS in /forum/includes/functions.php on line 1517
Notice: Undefined index: forumpermissions in /forum/includes/functions.php on line 3272
Notice: Undefined index: 1 in /forum/includes/functions.php on line 3281
Notice: Undefined index: 2 in /forum/includes/functions.php on line 3281
Notice: Undefined index: hasaccessmask in /forum/includes/functions.php on line 3286
success
Notice: Use of undefined constant VB_AREA - assumed 'VB_AREA' in /forum/includes/functions.php on line 4414
Notice: Use of undefined constant VB_AREA - assumed 'VB_AREA' in /forum/includes/functions.php on line 4414
Notice: Undefined index: badlocation in /forum/includes/functions.php on line 4421
Notice: Undefined index: badlocation in /forum/includes/functions.php on line 4446


Anyone has a fixed version that works fine on 3.54 ?

[Noodles24]

Updated to work with 3.5.4 and added user functions.

[[email protected] vbmenu_register("postmenu_972160", true);]

kewl, thanks

[ronoxQ]

Can you use this to bridge to other programs?

[Noodles24]

Can you use this to bridge to other programs?

Yes it can be used as a bridge. You could use it sync users between an app and vbulletin, or you can use vbulletin as the user source. What you can't do is use another app as the user source for vbulletin

[cristianmerz]

How i can use this in a subdomain....example...my forum is in forum.xxx.com y the website is in www.xxx.com...
I can login form the www.xxx.com, and i see it in forum.xxx.com...but if i try to check the status from www.xxx.com, i can?t.

[Noodles24]

You just need to change your cookie settings in vbulletin to cover .xxx.com rather than forum.xxx.com

[Alan @ CIT]

Good job Noodles, looks like it could be handy.

Thanks,
Alan.

[cristianmerz]

The checkloggedin.php don?t work....the login.php is success but the checkloggedin.php sais "you are not logged in" :(

With the login.php and logout.php i can login correctly...i check it in the forum home and is fine..but i can?t check the login status with the checkloggedin.php. My VB is 3.5.4...Any idea?

[Noodles24]

If you do:


print_r($_COOKIE);


Does it return values for bbsessionhash, bblastvisit, bblastactivity etc?

[Cheertobi]

What is the best way to use this with another app?

Create a new user in the other app right after the registration user addUser?!

Tobi

[cristianmerz]

If you do:


print_r($_COOKIE);


Does it return values for bbsessionhash, bblastvisit, bblastactivity etc?
Yes...

In the checkloggedin.php file...

Array ( [panel] => a6f27d70e8e57c021cdae26984d7f232 [PHPSESSID] => 0a2fd7dc2169e9cd63065e4d31f4xxxx [bblastvisit] => 1147717890 [bblastactivity] => 0 [bbuserid] => 348 [bbpassword] => 2eb747ede87107257bac080bxxxxxxxx [bbsessionhash] => d3cf58a53dd98e657028aa9fb05594be [bbthread_lastview] => 54355fc31b0b2eb1e1f86bd672764313a-1-{i-12114_i-1147718592_} [vbulletin_collapse] => [bbreferrerid] => 0 [bbthreadedmode] => [bbstyleid] => 0 [bblanguageid] => 0 )

[GrendelKhan{TSU]

does the site need to be on the same host provider? or would this work with ANY site, so to speak?

[cristianmerz]

Yes. My webhosting is www.xmundo.net

[Noodles24]

does the site need to be on the same host provider? or would this work with ANY site, so to speak?

At the moment, yes. It needs to be included directly into the file you want to use the API with.

I may include some SOAP interaction later on.

[Noodles24]

Yes...

In the checkloggedin.php file...

Array ( [panel] => a6f27d70e8e57c021cdae26984d7f232 [PHPSESSID] => 0a2fd7dc2169e9cd63065e4d31f4xxxx [bblastvisit] => 1147717890 [bblastactivity] => 0 [bbuserid] => 348 [bbpassword] => 2eb747ede87107257bac080bxxxxxxxx [bbsessionhash] => d3cf58a53dd98e657028aa9fb05594be [bbthread_lastview] => 54355fc31b0b2eb1e1f86bd672764313a-1-{i-12114_i-1147718592_} [vbulletin_collapse] => [bbreferrerid] => 0 [bbthreadedmode] => [bbstyleid] => 0 [bblanguageid] => 0 )

I'm unsure why it's not working. It uses the same code as vbulletin to intialize.

Try clearing your cookies and try logging in again

[Noodles24]

What is the best way to use this with another app?

Create a new user in the other app right after the registration user addUser?!

Tobi

You can maintain two user tables if you want. The application I'm building at the moment is just going to use vbulletin as it's user base, then any extra information i need for a user will be stored in a seperate table against their userid

[K1ng0e]

List product add product del product and all same for templates ;) !

[dvanwijk]

I have installed this on vb3.5.4 and it works great.

Is there an update for 3.6.1?

Thanks,
Dan

[Noodles24]

I'm working on an update at the moment

Will also be looking at a way to seperate the code from vbulletin as much as possible

[EdKohlwey]

I've been pretty disappointed by vB's lack of an API, and otherwise sometimes sloppy and poorly documented codebase (I know I may get some major boo-hiss on that comment, but I'm a Java and .Net programmer).

That having been said though, major props on this! It would be good to see the addition of methods for all major vBulletin functions, like subscribe to thread(s), post/reply (actually submitting a post/reply), account maintainence, etc. Lots of people already have sites/CMS'es that do a pretty darn good job of profile management, and it doesn't make sense for a user to maintain two profiles.

[tassoman]

Hi, after I've updated to 3.5.7 I still recieve a fatal error:

Fatal error: Call to a member function unlock_tables() on a non-object in /var/www/virtual/domain.tld/forum/htdocs/includes/functions.php on line 4488

Seems an object isn't initiated.

[tassoman]

I have also encountered errors evalutating usernames with special chars.

Into my DB i have registered an user called &lt;~^_ Th? T?s7 _^~&gt; so if i try a $obj->doLogin('<~^_ Th? T?s7 _^>', 'hispasswd'); i can't get the user logged.

Is there some VB API class/method who correctly converts special chars ?

[licinio]

Hi,

I´m using vbulletin 3.6.4

login works correctly for me,
but checkloggedin doesn´t work

any idea? I´m desperated

thanks

[chubba]

works fine on 3.6.4, however i had to make one change to class_core.php

line 2381 from

define('TABLE_PREFIX', trim($this->config['Database']['tableprefix']));

to

define('TABLE_PREFIX', trim($config['Database']['dbname'].".".$this->config['Database']['tableprefix']));

i think its probably to do with my code, not yours, but it may help some one else out ;-0)

[axe70]

Great! Thank to you boy!
Please, take your work always updated. Big thank to you!

[toneill2000]

Hi Noodles,
I've installed the API and I have a few questions. Is there any documentation on the classes? For example, what does the third parameter on the doLogin mean? It's called "$cookiesend" but I don't really know what it does.

Have said that, there are other simple questions I have which could be easily answered with some documentation. Is there any documentation? thanks.
Todd

[imizz]

Hi!
i've installed API and i've this error:
Fatal error: Call to a member function unlock_tables() on a non-object in /usr/local/apache2php/htdocs/forum/includes/functions.php on line 5189

could someone help me?
..and great API!!of course :D

[treelovinhippie]

hey mate

Does this work for v3.6.8?

I'm not getting anything when trying to add a new user

[suraev]

Thank you very much for this hack! It was very useful for me and I hope that its development will continue.

[prawn]

Same for me. Thank you very much as it is a good base for my needs.

[satjoe2003]

Brilliant add-on! Thanks a lot!

[columbusgeek]

Agreed, can anybody verify thsi working 3.6.8

[jamoss]

I'm on 3.6.8 and login and adduser works great... I'll keep you posted!

One snag I did run across is that BIRTHDAY is required for adduser. You need to pass username, password, email, day, month, year (where day, month, year are birthday).

[jamoss]

I am using this on 3.6.8 and it's working really well! I appreciate this, as I needed to integrate my site login with the boards.

Thanks again!
~ Jennifer

:up:

[dionsis]

Its appears PHP5 throws up a lock_tables error when trying to do a logout on this

Would love to see further development and updates on this as its a fantastic mod

[jamoss]

I agree (about updates). This script has been a lifesaver and couldn't find anything similar anywhere else.

I also sometimes get a redeclare error:

Fatal error: Cannot redeclare iif() (previously
declared in
.....functions.php:51) in
....functions.php on line 51

I'm using include_once instead of include.. hoping to alleviate that, but nothing seems to work.

[korbn]

I don't if this nice Mod still updated but, I have the error of lock_tables.
<b>Fatal error</b>: Call to a member function unlock_tables() on a non-object in <b>/var/www/dev.jardipedia.com/forum/includes/functions.php</b> on line <b>5218</b>

[gdll]

Hi !

I also want to ask about the cookiesend. I installed on latest vbulletin ( 3.6.8) and the doLogin function appears to be working: I see a session created in the session table in the database, but the client browser does not receive any cookie from the forum....

Could anyone tell me where is the code that should send the cookie to the client browser ?

cheers

hmm it was an issue with IE... works!

[papaschloss]

My problem is that no changes are made to the session table in the database when a user logs in *and* no cookies get sent. I think I'm close to getting this to work but I need some help.

Thanks.

[papaschloss]

I can get session info to be written to the database now in the goLogin function. After the call to processNewLogin(), I had to insert the code:

$vbulletin->session->save()

I'm still having problems with cookies though. In my browser, when I print out $_SERVER I see the expected cookies; however, when I inspect cookies using my browser, they are not there. Still working on it.

[fredang85]

Is there anything similiar for 3.7?

[CGhostGroup]

Should it be possible to get Data like:
Read/Unread PM's, Unread (new) Postings?

[sknight]

Hi!
i've installed API and i've this error:
Fatal error: Call to a member function unlock_tables() on a non-object in /usr/local/apache2php/htdocs/forum/includes/functions.php on line 5189

could someone help me?
..and great API!!of course :D

Same problem here, that's 3 of use using 3.7

[CGhostGroup]

Just add an error_reporting(0); :p

[dcolumbus]

So far all I seem to be able to get is connector.class.php printed out to the page...
This is what I've done:
1) uploaded to the server
2) changed the forum root path
3) uploaded the createuser.php sample script
3) run the script directly

Am I missing something?

[Burgy]

First of all, I don´t need the functions with the user integration, because I use already Mediwiki Bridge to vBulletin and facebook login. In combination very powerfull and works great.

BUT: The API is the only way to make our little aplications in the net work together, and that apreache - clearly it comes from a c develloper - is absolutly great.

What nearly everbody could need in this api.
Use vBulletin an comment engine for any given page, meaning to syndicate and to write from some content and have the vbulletin discussion be syndicated below or beside the outside content. Let it be comments, or let it be advice or what ever is semantic and interaction data of human conversation could be syndicated in any given content on the same or with securety mesures on any given page. That would make vBulletin to much more, than it is.

Thank you very much for this project, and I hope development is not to difficult considering the vB Code.

=> Every function is apreaciated
Sincerely yours
Burgy

[Jeff@Mutant]

Hello

I'm running vB 3.8 and I 'm getting the following error when trying to use the Connector API


Fatal error: Call to a member function unlock_tables() on a non-object in /var/www/forums/includes/functions.php on line 5772



Any idea what's going on?

[g.gadaleta]

Me too, same error. Any idea?

Hello

I'm running vB 3.8 and I 'm getting the following error when trying to use the Connector API


Fatal error: Call to a member function unlock_tables() on a non-object in /var/www/forums/includes/functions.php on line 5772



Any idea what's going on?

[xilefen]

Has somebody an example for the dbConnector?

// make database connection

$db->connect(
$this->config['Database']['dbname'],
$this->config['MasterServer']['servername'],
$this->config['MasterServer']['port'],
$this->config['MasterServer']['username'],
$this->config['MasterServer']['password'],
$this->config['MasterServer']['usepconnect'],
$this->config['SlaveServer']['servername'],
$this->config['SlaveServer']['port'],
$this->config['SlaveServer']['username'],
$this->config['SlaveServer']['password'],
$this->config['SlaveServer']['usepconnect'],
$this->config['Mysqli']['ini_file'],
$this->config['Mysqli']['charset']
);

[rruchte]

Me too, same error. Any idea?

I just got this working in vB 3.5.8. In connector.class.php, lines 99-116 do the same thing as lines 233-252 in include/init.php. In vB 3.5.8, most of those lines are commented out. Starting at line 106 in connector.class.php, change

define('SAPI_NAME', php_sapi_name());
if (!defined('NOSHUTDOWNFUNC'))
{
if (PHP_VERSION < '5' OR ((SAPI_NAME == 'cgi' OR SAPI_NAME == 'cgi-fcgi') AND $this->options['gzipoutput'] AND strpos($_SERVER['SERVER_SOFTWARE'], 'Microsoft-IIS') !== false))
{
define('NOSHUTDOWNFUNC', true);
}
else
{
vB_Shutdown::add('exec_shut_down');
}
}


To:


/*
if (!defined('NOSHUTDOWNFUNC'))
{
if (PHP_VERSION < '5' OR ((SAPI_NAME == 'cgi' OR SAPI_NAME == 'cgi-fcgi') AND $this->options['gzipoutput'] AND strpos($_SERVER['SERVER_SOFTWARE'], 'Microsoft-IIS') !== false))
{
define('NOSHUTDOWNFUNC', true);
}
else
{
vB_Shutdown::add('exec_shut_down');
}
}
*/
define('NOSHUTDOWNFUNC', true);

[xilefen]

Hi,

I use the vConnector API to create and/or authenticate Users and skip login.

include ('includes/connector/connector.class.php');
$connector = new vbConnector();

// get CASUser
$casuser = phpCAS::getUser();

// get UserID if present
$result = $connector->getUserID($casuser);

// check, if user is allready registered
if(empty($result)){
// edit/save new user
$user = array('username' => $casuser, 'password' => 'default', 'email' => 'test@test.com');
$result = $connector->addUser($user);
}

// Login user
session_start();
$result = $connector->doLogin($casuser, "default", 1);


I 'm getting the following error:

Fatal error: Cannot redeclare class vBulletinHook in C:\xampp\htdocs\forums\includes\init.php on line 288

Any idea to fix this?

Thanks Felix

[Clayton]

this was so ahead of its time

[Lysekoid]

Where do I find something similar for vBulletin 4, since this example is from 2006 I guess it doesn't work for the new vBulletin 4.

[kamilkurczak]

I am waiting for post/thread adding system

[c0der]

nice

but have alot of errors