vb.org Archive - [How-To] Walkthrough of hack development & Coding Tips: Thread Promotion System

I've wrote this tutorial @ other modding community i'm member on few days ago. I wanted to share it with this community as well, so members that don't visit there can benefit from it here as well.

This tutorial will provide complete walk-through of the development made to create "Thread Promotion system" modification (can be found @ https://vborg.vbsupport.ru/showthread.php?p=1808040)

So, lets get going:

This guide assumes the following:

You have installed a phpadmin on your server & have some basic knowlege of how to use it (or know basic MYSQL syntax & how ot add/delete fields into tables)
You have some knowledge of basic php coding. I will explain code as possible, but some basic syntax knowledge is required.

Development stages:

Have modification idea & understand the way you wish to implant it on the forum.
Prepare database structure required.
Place admincp into debug mode.
Create Product.
Add Plugins.
Testing of code - is it working way we wanted.
Add install/uninstall code.
Export & save final product.
Share back with community.

1. Modification Idea:
This modification was as reply to request made.
as request mentioned, he wanted a system that would allow him to set forum as being able to have "thread promotion" inside it. Which actually means once reply count passed XX it will automatically moved from forum A to B.
The above description tells us 2 things:

This "feature" should be per forum, as some forums may have it & some may not.
Possible "info" required to "drive logic" behind it is:
- Is it enabled for the selected forum ?
- What is the reply count (that once passed should be moved)
- What is the target forum that it should be moved to.

Analyze & Process Information:
(1) Mod appearance on admincp (& Hook Location):
With above said, right now the coder should "see" the modification in his mind. Knowing you'll add some section under "Forum Manager" as you want it to be intergated in way every new forum add or edit will allow you to set it. & you need some code to perform the check.
This will later on be "translated" to "forumadmin_edit_form" hook code.

(2) Mod Core Code (& Hook Location):
Since idea speaks of "if reply count > XXX" common sense suggest this should be implanted right after a person finished to post new reply. As right then we can "ask" what was the reply number & have we passed the mark we aimed for. And if we did - do your "magic".
This will later on be "translated" to "newreply_post_complete" hook code.

(3) Possible pitfalls & consideration points in code:

Reply has 2 seperate engines - add reply (own page) & quick reply (AJAX).
Once thread moved, the forum counters are no longer updated (link to last thrread on forum home, etc.)
Data Manager needs to be told of new fields we add to the forum, so they may be "recognized" by the forum engine.

(4) Lets discuss details & DB structure:
In general you should know the structure of your vbulletin (at least the common tables that construct it).
In our case: we are most likely to need some info (either fetch or set) from 3 tables : "forum", "thread", "post".
these tables have parent-child relationshionship structure similar to following: forum -> thread -> posts
(thread has forum parent id, post has thread parent id)

table "forum" holds the forums listing - there we will need to update the counters/stats (last post, last poster, thread/post count, etc.)
table "thread" holds the threads posted. Each thread has refrenced to his "parent forum". So any "move" operaton invovles replaced "parent id" from forum A to forum B".
table "post" will be needed to gather information about the last post made, as when we move the thread, we now want the source forum to link to the other most recent post. So any poster information should be in here.

2. Prepare DB Changes:
As reminder, we came to conclusion we will need the following information "present" for us:

Is it enabled for the selected forum ?
What is the reply count (that once passed should be moved)
What is the target forum that it should be moved to.

This "translates" to the following:
"Enable" filed that will act as BOOLEAN (true/falsE).
"Reply Count" field of int type.
"Forum ID" field of int type (says to us which is the target forum to be moved thereads onto.

Lets get to business, logon on your phpmyadmin, go to table "forum" & add 3 new fields:
http://img17.imageshack.us/img17/595...3newfields.jpg
And screen after fill these:
http://img22.imageshack.us/img22/9456/fixedwidth.jpg
Once made, you'll see this screen:
http://img27.imageshack.us/img27/2814/fixedwidth2.jpg
Please "save" the (copy & paste to some place, will be used later) the ALTER query, as we will need it to the install code:
The query should be like the following:

Code:

ALTER TABLE `forum` ADD `enable_thread_promotion` TINYINT( 1 ) NOT NULL ,

ADD `reply_count_for_promotion` INT NOT NULL ,

ADD `target_forum_id` INT NOT NULL

3. Configure admincp to debug mode:
This can be done either from config.php or install some plugin for it.
there are several debug mode hacks, just install one of them.

4. Create Product:
Go to Admincp, from side nav select "Plugin & Products" -> "Manage Products" :
http://img17.imageshack.us/img17/920...eproductvi.jpg
Select "Add/Import Product":
http://img17.imageshack.us/img17/344...newproduct.jpg
On the "Add New Product" screen fill the information as demonstrated in the following picture:
http://img27.imageshack.us/img27/209...productsde.jpg
When done, click "Save".
Once product added you should see following screen:
http://img27.imageshack.us/img27/981...productadd.jpg

5. Add Plugins:
As discussed @ section 1, we will have in this modification 4 plugins/hooks.

Admincp code - placed under the "forumadmin_edit_form" allowing the admin screen options.
Data Manger fields support - since we are adding new fields here, we need to tell the vbulletin we are using these fields. For that purpose we will be using the "forumdata_start" hook (see code below later on)
Main Core Code - placed under the "newreply_post_complete" hook. This will allow to place code logic there & check the reply count & perform changes accordingly.
Main Core Code (exact copy paste) for AJAX support - same code as above hook, just copied onto "newreply_post_ajax" to support AJAX.

So, lets start add them one by one:
Admincp hook:
From Admincp: "Plugins & Products" -> "Plugin Manager":
http://img17.imageshack.us/img17/969...ginmanager.jpg
Then select "Add new plugin":
http://img17.imageshack.us/img17/475...dnewplugin.jpg
Then we fill the fields as shown in this picture:
http://img17.imageshack.us/img17/8/a...newplugind.jpg

The code that was placed onto this hook is:

PHP Code:


		
			
// Header

print_table_header('Thread Promotion System');



// Enabled ?

print_yes_no_row('Enabled ?', 'forum[enable_thread_promotion]', $forum[enable_thread_promotion]);



// Reply Count Settings

print_input_row('Reply Count', 'forum[reply_count_for_promotion]', $forum[reply_count_for_promotion]);



// List all possible target forums (that are not this forum)

if ( $forum[forumid] == "")

{

    // List all - this is new forum add

    $query = "SELECT forumid, title FROM forum";  

}

else

{

   // This is edit - List all other than this forum id

    $query = "SELECT forumid, title FROM forum WHERE forumid<>$forum[forumid]";  

}





$qry=$db->query_read($query);

while ($result = $db->fetch_array($qry)) 

{ 

        $arr[$result ['forumid']] = $result ['title']; 

} 

print_select_row("Forum Target",'forum[target_forum_id]',$arr,$forum[target_forum_id]);

Notes Regarding Code:

In the above example i've also used function called print_select_row, which allow to create a "combo-box" (selection box). The function expect to be passed with array, holding key -> value pairs. In the above code, as you can see i'm performing SQL query to get list of all forum title & their id, while excluding the forum itself (as it make no sense to allow promote from forum to itself).
the $forum[forumid] check for null, is in case this is new forum add, then no forumid is available, in that case, we allow to list all currently available forums.

Click "Save" to save plugin.

Data Manger Field Support hook:
In the same way add another plugin, this time select "forumdata_start" as hook location.
In there add code as shown in the next picture:
http://img503.imageshack.us/img503/7...uginsaveda.jpg

Core Code hook:
In the same way add another plugin, this time select "newreply_post_complete" as hook location.
In there add code as shown in the next picture:
http://img503.imageshack.us/img503/2...ddmaincode.jpg
I dont want to make this "monster post", You can get full source on the modification, i'll just put the following notes:

First block fetch all information of forum this post was made on. Forum ID is located on $threadinfo[forumid].
Later on 2 condition are made: enabled & if current post count > what we configured. Note the current reply count is located on var $threadinfo[replycount] & that this is zero-based ! (first reply returns in there 0 !!)
I update the "thread" table, replacing "forumid" with new one.
Update stats counters on "forum" table (based on info gathering, made on several queries).
There are several checks to make sure numbers are indeed numbers. I used php function called is_numeric() that verify var holds numbers only.
Pay attention all string fields has qoute wrapping around them on query (used escape chars \" on query lines)

Core Code AJAX hook:
This is exact copy & paste of previosu hook, just place it on "newreply_post_ajax" as hook location.
http://img503.imageshack.us/img503/6...uginforaja.jpg

At this point all plugins should be complete:
http://img503.imageshack.us/img503/3...allplugins.jpg

6. Testing Code:
Check the code on your forum. Through it you'll find pitfall you didnt think about.
In this case for example the reply count was zero-based, so i had to add -1 factor on code. These sort of things can only be found while you "hands on" code & test it, so dont be afraid !

Also general tip, if certain code not working, try to place php die("soem text"); on certain key points to tell if the code executed till that point. That can help to debug certain things.

7. Add Install/Uninstall Code:
On Admincp go to "Plugin & Products" -> "Manage Products" & edit the current product we just did:
http://img503.imageshack.us/img503/6...nstallunin.jpg
Now we'll add the install/uninstall code, which is the db changes (add fields for install & drop fields for uninstall).
Now it's time to use that ALTER query we wrote while back.
Note the DROP query can be obtained from phpmyadmin as well.
http://img503.imageshack.us/img503/7...pfieldstog.jpg
Then you will see this:
http://img503.imageshack.us/img503/5...etequeryfo.jpg

When you have both MYSQL queries we can add it to product as shown here:
http://img503.imageshack.us/img503/4...nstallunin.jpg

All thats left now is to export & save :)

8. Export & save hack:
From "Product Manger" choose export as seen here:
http://img503.imageshack.us/img503/1...oneexportp.jpg

Then save it on your directory:
http://img503.imageshack.us/img503/7...hackandpos.jpg

That's it !! :)
Congratulations, if you followed all this (long) guide, you have now made your hack successfully :)
Don't forget to share back with community your work :)

I hope this guide has helped anyone out there that wanted to get into the modding & gets hands-on & start coding & was missing some pratical hand-on step-by-step tutorial..
If anyone has any further questions, post them here & i will help gladly.

Enjoy :cool:

X vBulletin 3.8.12 by vBS Debug Information
Page Generation 0.02513 seconds Memory Usage 1,823KB Queries Executed 10 (?)
More Information
Template Usage: (1)ad_footer_end (1)ad_footer_start (1)ad_header_end (1)ad_header_logo (1)ad_navbar_below (1)bbcode_code_printable (1)bbcode_php_printable (1)footer (1)gobutton (1)header (1)headinclude (6)option (1)post_thanks_navbar_search (1)printthread (16)printthreadbit (1)spacer_close (1)spacer_open Phrase Groups Available: global postbit showthread	Included Files: ./printthread.php ./global.php ./includes/init.php ./includes/class_core.php ./includes/config.php ./includes/functions.php ./includes/class_hook.php ./includes/modsystem_functions.php ./includes/class_bbcode_alt.php ./includes/class_bbcode.php ./includes/functions_bigthree.php Hooks Called: init_startup init_startup_session_setup_start init_startup_session_setup_complete cache_permissions fetch_threadinfo_query fetch_threadinfo fetch_foruminfo style_fetch cache_templates global_start parse_templates global_setup_complete printthread_start bbcode_fetch_tags bbcode_create bbcode_parse_start bbcode_parse_complete_precache bbcode_parse_complete printthread_post printthread_complete
Messages: