[HTL] Hack Tracking Log

This Hack is released under an EverythingvB.com
FullAttribution-LimitedDerivs-LimitedTranslation License

Hack Tracking Log
Version: 1.00 Gold
vB-version: 3.0.0 RC 3
Developer: KuraFire
Install-difficulty: Easy
File-edits: 3
Template-edits: 0

[high]
Official Hack Tracking Log Product page:
www.everythingvb.com/products/htl/
[/high]


Brief Description of the Hack:
The Hack Tracking Log is an advanced system for maintaining all your vBulletin hacks. You use it to install and / or create hacks, and it will automate many processes for the Admin.

Last update: Tuesday, January 27 (03:33 am CET)
The earlier bug fix caused a new bug to arise. Yes, you may smack me with the cluebat. I f00ked up in my bugfix. *slaps self*
Anyhoo, to patch your install, just overwrite your admincp/hackadmin.php with the new version found in the NEW ZIPFILE, attached below.
I've improved the entire

Former update: Monday, January 26 (2:42 PM CET)
BUG FOUND! A minor, harmless bug was found in the Make vB.org Post section of /admincp/hackadmin.php - to upgrade, re-download the zipfile (clear your cache first!) and overwrite hackadmin.php on your server with the new one. If you haven't yet installed the HTL, make sure to get the latest download and you should be fine. Thanks Rein for the report ^_^


Information on the HTL:
The Hack Tracking Log is an advanced utility for vBulletin administrators (in particular). It allows you to create, manage, install and track vBulletin hacks in detail. For a full features overview, please see the HTL Features Overview on EverythingvB.com That place also holds the full official HTL Documentation, including a F.A.Q. and a Step by Step guide to making a new Hack.


For GENERAL QUESTIONS:
https://vborg.vbsupport.ru/showthread.php?t=60582


For BUGS and OTHER SUPPORT:
http://www.everythingvb.com/forumdisplay.php?f=4


IMPORTANT and/or USEFUL READS!
Advantages to using the HTL
How to Support the HTL
Why should I make HTL-only hacks?


HACK INSTALLATION DETAILS:
New files for this Hack:
/admincp/hackadmin.php
/cpstyles/vBulletin_3_Default/hacklog.gif
/cpstyles/vBulletin_3_Silver/hacklog.gif
/includes/adminfunctions_hacklog.php
/includes/adminfunctions_installroutine.php
/includes/config_htl.php
/hacklog.php

Files modified for this Hack:
/admincp/index.php
/includes/adminfunctions_navpanel.php
/includes/adminfunctions_template.php

New templates for this Hack:
HACKLOG
hacklog_overviewbit
hacklog_hack

New DB tables for this Hack:
hack
hacklog


Tutorial:
How to easily Upgrade your vBulletin using the Hack Tracking Log


PLANNED FOR 1.1:
- Uninstallation of Hacks (section is unfinished atm);
- Text file generators (for vB.org's policy);
- A more flexible List All Modifications page;
- More sensible template insertion (all styles at once)
- Select All link above File/template edit fields for easy selecting (src)
- new vBoption: Restrict hack access to the Allowed Userid's field (yes/no).
Things from these two threads:
http://everythingvb.com/showthread.php?t=27
http://everythingvb.com/showthread.php?t=33


Version 1.1 will come fairly soon, so make sure to Install this hack so that you will receive the update when it comes

Statistics:
- 4702 lines of code
- 616 lines of XML (phrases, templates, settings)
- 229 Kb worth of Hack data

Have fun


COMMON PITFALLS DURING INSTALL:
If you have problems, see the Help section of the Documentation


This post was generated by the Hack Tracking Log

[Andreas]

@KuraFire
Have you thought about adding check if a phrasegroup does already exist before trying to create it?
That might be useful for hack-updates.

[KuraFire]

Originally Posted by KirbyDE

@KuraFire
Have you thought about adding check if a phrasegroup does already exist before trying to create it?
That might be useful for hack-updates.

For suggestions, please use the Hack Tracking Log Suggestions thread - more organized (and a much greater chance that it will be in HTL 1.1)

most likely the new HTL with its improved features and checking for upgrades will have this, yes

[KuraFire]

Originally Posted by Link14716

I found a bug in the generation of phrase XML files.

When you have a set of phrases that use the hack prefix and the phrasetype prefix of your custom prefix, along with a group that only have your hack prefix (i.e. are meant to go into the custom grou), two sets of <phrasetype name="xxx"> would appear, and only the second group would be imported - thus meaning that a lot of phrases aren't installed properly.

Can you please give an example??

[Link14716]

phrasetype name="Shoutbox Hack">
<phrase name="shoutbox_add_new_shout">SHOUT! Add a New Shout!</phrase>
<phrase name="shoutbox_are_you_sure_you_want_to_x_this_message">Are you sure you want to {1} this message? {2}</phrase>
-
	<phrase name="shoutbox_copyright">
<b>Shoutbox {1} by <a href="https://vborg.vbsupport.ru/member.php?s=&action=getinfo&userid=15527">squall14716</a> for <a href="http://www.vggmn.com">VGGM</a>.<br>Templates (mostly) by <a href="http://www.movieforums.net/index.php?">TWTCommish</a> for the <a href="https://vborg.vbsupport.ru/showthread.php?s=&threadid=38698">vB2 Shoutbox 1.0</a>.</b>
</phrase>
<phrase name="shoutbox_delete">delete</phrase>
<phrase name="shoutbox_delete_a_shout">Delete a Shout</phrase>
-
	<phrase name="shoutbox_deleted_successfully">
<br>The shout has been deleted. You may still restore it, though...
</phrase>
<phrase name="shoutbox_disabled">Disabled</phrase>
<phrase name="shoutbox_edit_a_shout">Edit a Shout</phrase>
<phrase name="shoutbox_edited_successfully"><br>The shout has been edited...</phrase>
<phrase name="shoutbox_enabled">Enabled</phrase>
<phrase name="shoutbox_exclude_shouts_by_user">Exclude shouts by user:</phrase>
<phrase name="shoutbox_excluding">Excluding</phrase>
<phrase name="shoutbox_forumhome_last">Last</phrase>
<phrase name="shoutbox_forumhome_latest">Latest</phrase>
<phrase name="shoutbox_forumhome_shout">Shout</phrase>
<phrase name="shoutbox_forumhome_shoutbit">Posted {1} {2} by</phrase>
<phrase name="shoutbox_forumhome_shouts">Shouts</phrase>
<phrase name="shoutbox_forumhome_x_y_z">Shoutbox - {1} {2} {3}</phrase>
<phrase name="shoutbox_go">Go!</phrase>
<phrase name="shoutbox_hdelete">hard delete</phrase>
<phrase name="shoutbox_hdelete_a_shout">Hard Delete a Shout</phrase>

and it continues down to

<phrase name="shoutbox_shoutbit_edit">(edit)</phrase>
<phrase name="shoutbox_shoutbit_hdelete">(hard delete)</phrase>
<phrase name="shoutbox_shoutbit_ignored">This user is on your ignore list.</phrase>
<phrase name="shoutbox_shoutbit_incoventry">This user is in coventry...</phrase>
<phrase name="shoutbox_shoutbit_restore">(restore)</phrase>
<phrase name="shoutbox_shoutbox">Shoutbox</phrase>
<phrase name="shoutbox_shouted_in_the_last_x_days">Shouted in the last  {1} days</phrase>
<phrase name="shoutbox_shouts">shouts</phrase>
<phrase name="shoutbox_shouts_by_user">Shouts by user:</phrase>
<phrase name="shoutbox_shouts_per_page">Shouts per page:</phrase>
<phrase name="shoutbox_smilies_enabled_disabled">{1} Smilies {2} {3}</phrase>
<phrase name="shoutbox_the_shoutbox_at">The Shoutbox @</phrase>
<phrase name="shoutbox_vbcode_enabled_disabled">{1} vB Code {2} {3}</phrase>
</phrasetype>

Then, later into the XML file, you see this lovely block...

<phrasetype name="Shoutbox Hack">
<phrase name="shoutbox_shoutbox_leaderboard">Shoutbox Leaderboard</phrase>
<phrase name="shoutbox_shoutbox_options">Shoutbox Options</phrase>
<phrase name="shoutbox_shoutbox_stats">Shoutbox Stats</phrase>
<phrase name="shoutbox_shoutbox_stats_last_24_hours">Last 24 Hours</phrase>
<phrase name="shoutbox_shoutbox_stats_shouts_today">Shouts Today</phrase>
<phrase name="shoutbox_shoutbox_stats_total_shouts">Total Shouts</phrase>
<phrase name="shoutbox_shoutbox_stats_your_shouts">Your Shouts</phrase>
</phrasetype>

When ran through the installer, only the second, smaller block is actually inserted, leaving important phrases untouched. I've had to manually edit the XML file to put them all into one group. The prefix is shoutbox and the fieldname for the group I added is also shoutbox.

[KuraFire]

Can you send me your temporary phrases file, perhaps?

either by PM or by just emailing it to me, you can ask for my address on irc (i'd rather not put it public)

[Link14716]

Originally Posted by KuraFire

Can you send me your temporary phrases file, perhaps?

either by PM or by just emailing it to me, you can ask for my address on irc (i'd rather not put it public)

I'll just attach it here.

[KuraFire]

Yeah, okay, it's as I thought..

you're using varnames that start off with: shoutbox_shoutbox_... and that confuses the system, as there shouldn't actually yet BE a phrasetype "shoutbox".

I'll try and improve the code so that it checks only for vBulletin's own phrasetypes, and then matches on those, instead of checking for all EXISTING phrasetypes.

[adusei]

INSTALLATION TROUBLE--->

I always stuck in step 2/5.
What can I do?
I use vB3 RC4.
Files are surely uploaded in binary mode.
Don't know what to do now. :disappointed:
Please help.

TIA and regards,

adusei

[KuraFire]

Originally Posted by adusei

INSTALLATION TROUBLE--->

I always stuck in step 2/5.
What can I do?
I use vB3 RC4.
Files are surely uploaded in binary mode.
Don't know what to do now. :disappointed:
Please help.

TIA and regards,

adusei

If you don't get a Proceed button in step 2/5, go to your database and delete the column phrasegroup_hacklog on the language table.

[adusei]

Originally Posted by KuraFire

If you don't get a Proceed button in step 2/5, go to your database and delete the column phrasegroup_hacklog on the language table.

Hello KuraFire,
first of all thanks a lot for your reply!
Hope, I did understand you proper (since I'm a bloody beginner with dbs and vB...).
I tried to delete the tbls "hack" and "hacklog" to start the installation again. When I do the query:

ALTER TABLE post DROP hack;

I will get an error msg:

________________________________________________
An error occured while attempting to execute your query. The following information was returned.
error number: 1091
error desc: Can't DROP 'hack'. Check that column/key exists
________________________________________________

And now I stuck again. What is my mistake?

Regards,

adusei