Integration of SMF 2.0 forum and CMS Livestreet 0.4.2
The article describes the option of integrating the SMF 2.0 forum and CMS Livestreet 0.4.2, in which user authorization / authentication is conducted via the Livestreet user database.
The background of the problem is as follows. There was a site on the Livestreet engine, everything is fine in it, but once the users wanted a forum. Just need it, take it out. Simply installing and setting up a new engine is not an option, since each registered user will have to register again in the forum, and each new user will register in both CMS. Registration / login through social. there was no network for historical reasons. And therefore the task stood before me:
In the SMF engine, the hook mechanism is implemented with which you can change the behavior of the system. Based on the above tasks, we need to redefine the behavior of the system using the following hooks:
In order for SMF to find out that we want to redefine its behavior, we need to create an installer script in the root folder of the forum engine, call it add_livestreetAuth_hook.php , with the following contents:
$ sourcedir - global variable containing the path to the Sources directory of the SMF engine
add_integration_function is a function implemented in the engine that binds your function (2nd parameter) to the hook (1st parameter). The third parameter of the function is TRUE or FALSE - determines whether the binding is stored in the database and cache or not.
')
The first call to the add_integration_function function ('integrate_pre_include', "$ sourcedir / Subs-LivestreetAuth.php") tells the engine the path to the file in which the functions described below are implemented.
Next, in the Sources directory of the engine, create the Subs-LivestreetAuth.php file, in which we implement all the functions that are associated with hooks.
After that, from the browser run the script www.mysite.com/forum/add_livestreetAuth_hook.php . If you saw a white screen without any errors, then the binding occurred successfully. Moreover, to calm the nerves, you can check the contents of the smf_settings table of the database. Towards the end of the table there should be entries with your hooks and the functions that are attached to them.
A couple of points when implementing the functions in the file Sources / Subs-LivestreetAuth.php .
The main integration work falls on the livestreet_verify_user_add_hook () function that we tied to the integrate_verify_user hook and implemented in the Sources / Subs-LivestreetAuth.php file.
I would also like to mention the livestreet_integrate_menu_buttons_hook hook. With it, you can override the main menu items engine. For example, in my case it was necessary:
Actually, the implementation of the function:
A multidimensional array containing all items of the main menu is passed to the function by reference.
Removing hooks.
In order to remove the binding of functions to the hooks, you must create a file in the root directory of the forum engine (say remove_livestreet_auth_hook.php ), in which you can call the function remove_integration_function in turn . Sample file content:
Further, as in the case of installation, it is necessary to run the script from the browser for execution.
The background of the problem is as follows. There was a site on the Livestreet engine, everything is fine in it, but once the users wanted a forum. Just need it, take it out. Simply installing and setting up a new engine is not an option, since each registered user will have to register again in the forum, and each new user will register in both CMS. Registration / login through social. there was no network for historical reasons. And therefore the task stood before me:
- Expand the SMF forum (Simple Machines Forum) 2.0 so that it is available at www.mysite.com/forum
- When a user enters the forum, check whether he is authorized to check via the Livestreet database.
- Users are registered only in CMS Livestreet
- Checking login and password only through CMS Livestreet
In the SMF engine, the hook mechanism is implemented with which you can change the behavior of the system. Based on the above tasks, we need to redefine the behavior of the system using the following hooks:
- integrate_verify_user
- integrate_verify_password
- integrate_validate_login
- integrate_login
- integrate_logout
- integrate_reset_pass
- integrate_register
- integrate_change_member_data
In order for SMF to find out that we want to redefine its behavior, we need to create an installer script in the root folder of the forum engine, call it add_livestreetAuth_hook.php , with the following contents:
<?php // If SSI.php is in the same place as this file, and SMF isn't defined, this is being run standalone. if (file_exists(dirname(__FILE__) . '/SSI.php') && !defined('SMF')) require_once(dirname(__FILE__) . '/SSI.php'); // Hmm... no SSI.php and no SMF? elseif (!defined('SMF')) die('<b>Error:</b> Cannot install - please verify you put this in the same place as SMF\'s index.php.'); add_integration_function('integrate_pre_include', "$sourcedir/Subs-LivestreetAuth.php"); add_integration_function('integrate_verify_user', 'livestreet_verify_user_add_hook',TRUE); add_integration_function('integrate_validate_login ', 'livestreet_validate_login_add_hook',TRUE); add_integration_function('integrate_login', 'livestreet_integrate_login_add_hook',TRUE); add_integration_function('integrate_logout', 'livestreet_integrate_logout_add_hook',TRUE); add_integration_function('integrate_reset_pass', 'livestreet_integrate_reset_pass_add_hook',TRUE); add_integration_function('integrate_register', 'livestreet_integrate_register_add_hook',TRUE); add_integration_function('integrate_change_member_data', 'livestreet_integrate_change_member_data_add_hook',TRUE); add_integration_function('integrate_menu_buttons', 'livestreet_integrate_menu_buttons_hook',TRUE); ?> $ sourcedir - global variable containing the path to the Sources directory of the SMF engine
add_integration_function is a function implemented in the engine that binds your function (2nd parameter) to the hook (1st parameter). The third parameter of the function is TRUE or FALSE - determines whether the binding is stored in the database and cache or not.
')
The first call to the add_integration_function function ('integrate_pre_include', "$ sourcedir / Subs-LivestreetAuth.php") tells the engine the path to the file in which the functions described below are implemented.
Next, in the Sources directory of the engine, create the Subs-LivestreetAuth.php file, in which we implement all the functions that are associated with hooks.
After that, from the browser run the script www.mysite.com/forum/add_livestreetAuth_hook.php . If you saw a white screen without any errors, then the binding occurred successfully. Moreover, to calm the nerves, you can check the contents of the smf_settings table of the database. Towards the end of the table there should be entries with your hooks and the functions that are attached to them.
A couple of points when implementing the functions in the file Sources / Subs-LivestreetAuth.php .
- The first line of the file should contain the following code to prevent direct access to the file from the browser:
if (! defined ('SMF')) die ('Hacking attempt ...'); - To work with the database inside each function, declare a global variable: global $ smcFunc;
This variable contains an array of functions for working with the database. I will give a small example of the work of this layer:$res=$smcFunc['db_query']('',"SELECT id_member FROM {db_prefix}members WHERE member_name=\"user1\"",array()); if($smcFunc['db_num_rows']($res)>0) { $smf_user_row=$smcFunc['db_fetch_assoc']($res); return $smf_user_row['id_member']; }
{db_prefix} - The prefix of the database tables specified when installing the engine.
Read more in the documentation . - It should be noted that the transfer of parameters in the function is carried out by reference. For example:
function livestreet_validate_login_add_hook(&$username,&$hashedPass=NULL,&$cookieLifetime) { return 'ok';// retry|ok }
Carefully read the manual that should return the function associated with a particular hook.
The main integration work falls on the livestreet_verify_user_add_hook () function that we tied to the integrate_verify_user hook and implemented in the Sources / Subs-LivestreetAuth.php file.
- The first thing she should do is check the $ _COOKIE ['key'], which installs CMS Livestreet. If it does not exist, or it is incorrect, then return 0 (zero), thereby indicating that the logged in user is a Guest.
- Further, the function of $ _COOKIE ['key'] selects the user_id from the table {$ prefix} session of the Livestreet database, and then according to the received user_id from the table {$ prefix} user selects all the information about the user.
- It checks in the table {db_prefix} members of the SMF database if there is a user with such a login, if not, he enters
- Returns the id_member of the table {db_prefix} members SMF DB
I would also like to mention the livestreet_integrate_menu_buttons_hook hook. With it, you can override the main menu items engine. For example, in my case it was necessary:
- Add link to home page
- so that by clicking on the "Login" link the user is sent to the CMS Livestreet login and password input page
- When you click on the "Register" link, the user is sent to the CMS Livestreet registration page.
Actually, the implementation of the function:
function livestreet_integrate_menu_buttons_hook(&$buttons) { //print_r($buttons);exit;// if($config=getLivestreetConfig()) { $new_buttons=array( 'login'=>array( 'href'=>'http://mysite.com/login/', ), 'register'=>array( 'href'=>'http://mysite.com/registration/', ), ); foreach($new_buttons as $key=>$val) { if(isset($buttons[$key])) { //unset($buttons[$val]); $buttons[$key]['href']=$val['href']; } } // $buttons=array( 'mainpage'=>array( 'title'=>' ', 'href'=>'http://mysite.com/', 'show'=>1, 'sub_buttons'=>array() ) )+$buttons; } } A multidimensional array containing all items of the main menu is passed to the function by reference.
Removing hooks.
In order to remove the binding of functions to the hooks, you must create a file in the root directory of the forum engine (say remove_livestreet_auth_hook.php ), in which you can call the function remove_integration_function in turn . Sample file content:
<?php // If SSI.php is in the same place as this file, and SMF isn't defined, this is being run standalone. if (file_exists(dirname(__FILE__) . '/SSI.php') && !defined('SMF')) require_once(dirname(__FILE__) . '/SSI.php'); // Hmm... no SSI.php and no SMF? elseif (!defined('SMF')) die('<b>Error:</b> Cannot install - please verify you put this in the same place as SMF\'s index.php.'); remove_integration_function('integrate_pre_include', "$sourcedir/Subs-YourAction.php"); remove_integration_function('integrate_verify_user ', 'livestreet_verify_user_add_hook'); remove_integration_function('integrate_validate_login ', 'livestreet_validate_login_add_hook'); remove_integration_function('integrate_login', 'livestreet_integrate_login_add_hook'); remove_integration_function('integrate_logout', 'livestreet_integrate_logout_add_hook'); remove_integration_function('integrate_reset_pass', 'livestreet_integrate_reset_pass_add_hook'); remove_integration_function('integrate_register', 'livestreet_integrate_register_add_hook'); remove_integration_function('integrate_change_member_data', 'livestreet_integrate_change_member_data_add_hook'); Further, as in the case of installation, it is necessary to run the script from the browser for execution.
Source: https://habr.com/ru/post/127236/
All Articles