[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

[KuraFire]

Originally Posted by VeoMorphine

so this is like a vbhacker on crack? I like it. i'll install it when i get home. This would make a great satandard for vb hacking. Since it will make installs so much easier.

Yup, except this does _not_ do automatic file edits, you still have to edit your files BY HAND!

most people prefer it that way, anyway

[Kohhal]

Originally Posted by KuraFire

Ummmm.....

What you CAN do, for instance:

1. develop all hacks and install all hacks on your test board using the HTL
2. install the HTL on the live board (very simple and light-weight) and install all of the hacks using the HTL Installers on your live board
3. this works for both file AND template edits that you've tracked using the HTL. If you make any changes of your own without logging them into the HTL then you'll have to look them up on your own, too...

Nice one, will do

[Link14716]

Yeah, vbHacker on crack, except this puts the hack in the database and files, and is generally a whole lot better. None of my vB2 hacks were made for vbHacker, though all of my hacks will have HTL compatible versions.

[KuraFire]

Originally Posted by Link14716

Yeah, vbHacker on crack, except this puts the hack in the database and files, and is generally a whole lot better. None of my vB2 hacks were made for vbHacker, though all of my hacks will have HTL compatible versions.

Always nice to see people be happy with my work

[KuraFire]

I'm writing HTL 1.05 at the moment, and adding some of the features planned for HTL 1.1 already.

If there's anything you'd like to see in the HTL real soon, tell me now please.

[Link14716]

Upgrade scripts - they require that the hack that it upgrades has been imported (at least) and the upgrade .htl just updates whatever needs to be updated in the hack information and runs its own set of steps. I don't know if this can be done already, but if it cannot, it would be something that is needed.

[KuraFire]

Originally Posted by Link14716

Upgrade scripts - they require that the hack that it upgrades has been imported (at least) and the upgrade .htl just updates whatever needs to be updated in the hack information and runs its own set of steps. I don't know if this can be done already, but if it cannot, it would be something that is needed.

I'm looking into ways how I can do this.

What I'm CURRENTLY thinking of:


Adding an extra option for each hack (along with Show on front-end, is finished, is installed, etc. etc.) that says: Is Upgrade Script.

Then, if people run that 'hack' (which is labelled Is Upgrade Script) and attempt to install it (thus, attempt to upgrade their existing hack), the HTL will do:

1) a check on the system to see if the hack exists, if not it will STOP THE UPGRADE with an error page.
2) if the hack DOES exist but the version of the existing one is higher or equal to the one from the Upgrade, it will STOP THE UPGRADE with an error page.
3) if the hack exists and is a lower version, then it will first see if the existing hack has any phrases (by checking the `phrasevarnames` column of the hack in the database - this column already holds ALL varnames of ALL imported phrases for each hack). Also, it will check to see if this upgrade has the IMPORT PHRASES step as part of the upgrade. If so, and if the hack has existing phrases, it will remove all phrases and the database columns / rows made for those phrases, rebuild all languages, and then during the IMPORT PHRASES step it will import all phrases again, in an orderly fashion as usual.
4) next, the same for templates. If the upgrade .htl has the import templates step, it will check for the existance of templates for the old version of the hack, and if they exist, remove them first and then reimport the new ones.
5) same for settings;
6) now, we are still actually _before_ step 1 of the HTL install routine at this point, the only thing we may have had happen is that things were removed in preparation of being re-added later on in the 'install' (upgrade) of this hack. So at this point, we will do a REPLACE INTO query on the hack table to update our hack with the newest version. THEN we will continue with the rest of the installation, and if there is nothing else to do, we just forward straight away to the Upgrade Complete page.


Does that sound good, people?

[Link14716]

Sounds good to me. One more suggestion: it seems all new templates go to styleid 1 (or maybe the default style), correct? Can you make that an option? I want all new templates to go to styleid 2, which is a fake "Global Style" and is not user selectable (so isn't the default).

[Natch]

KuraFire - can u check out my HTL compatible hacka nd tell me why my one of installers (not I tho) is getting an SQL error?

https://vborg.vbsupport.ru/showpost....9&postcount=11

mysql error: Unknown column 'changetype' in 'field list'

mysql error number: 1054

[KuraFire]

Originally Posted by Link14716

Sounds good to me. One more suggestion: it seems all new templates go to styleid 1 (or maybe the default style), correct? Can you make that an option? I want all new templates to go to styleid 2, which is a fake "Global Style" and is not user selectable (so isn't the default).

That's currently an issue with the HTL, yes. It will insert them into your default style.

I'm looking into ways to improve this situation. For instance, not everyone will want the templates added to EVERY style, yet some people do. However, I can't just have them be imported into the MASTER style unless people are okay with having to manually re-import all templates for Each hack after every vBulletin upgrade they do (vb upgrades delete the master style first and then recreate it).

Maybe I should hold a poll about that.... and see if I can create some sort of feature (like List All Modifications) that reiterates over step 3 for ALL the hacks in one single sitting (ie. it will do the Import Templates step for every hack that has templates to import).

If I can make the latter, and import templates into the master style.... the only thing people would no longer have is having their templates appear in red (== non-default template) in the Style Manager.

*sigh* choices choices...

Anyhoo, as you can see, I'm going over many various possibilities to solve that...