[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

[Rein Masamuri]

Originally Posted by KuraFire

Gonna be? as far as the hack itself goes, it's already much bigger


Faranth: I wouldn't call it "just fine" when we're forced to use workarounds for some issues. Just like how you shouldn't call the way IE renders pages "just fine".

Fine then, if you want to be literal:
1) Its a bigger hack both by both code size, and scope
2) The code is more efficient (partially from vB3's optimizations now)
3) It makes more sense than vBHacker
4) Can you say Joygasm?

[KuraFire]

Originally Posted by Rein Masamuri

...
4) Can you say Joygasm?

ROFL!

Originally Posted by squawell

im running 4.32 on that server.tomorrow ill use another computer to test this

if have any result ill post it here let u know!! thankz..

Thanks... I don't really know what's going wrong, but I'm guessing it's a newlines issue on the .htl file on your server.. Either that, or your PHP 4.3.2 is giving problems on Windows, and you may want to upgrade that...

[Mephisteus]

almost 1000 posts btw Kura Let me be the first to congratulate with you

PS
Hackers, make use of this

[Princeton]

here are some issues relating to the htl:
In the EXPORT YOUR SETTINGS TO XML page...
Upon clicking CREATE XML FILE, the sites' style is switched to the first option on the STYLE dropdown (which in my case is not the default style).

On the file edit section, there should exist an option to order the edits. For example, if a permissions based hack is being created the first step introduced should be init.php. This will produce a visual flow to the edits.

I would also recommend ...
Adding a dropdown with a predefined "Difficulty rating to install this Hack".

An alternative to allow hackers to create a non-htl installer (a standalone) - for users who prefer not to save this type of data in the database; and, for users who prefer not to install/use the htl. Yes, there will be people that will not want to use the htl - for some people the htl will be to complicated. Never assume anything.

Other than the above, the HTML is a nice piece of software.:up:

[Princeton]

one more thing that I forgot to mention ...
the ability to view XML FILES before installing (within the installer). This will allow users to visually confirm that there is nothing harmful in phrases/templates/etc.

I like to view all files before adding/installing into my site.

[KuraFire]

Originally Posted by princeton

here are some issues relating to the htl:
In the EXPORT YOUR SETTINGS TO XML page...
Upon clicking CREATE XML FILE, the sites' style is switched to the first option on the STYLE dropdown (which in my case is not the default style).

I'm not sure what exactly you mean... Do you mean that it somehow changed the style setting for you when you went to create an XML file?

Originally Posted by princeton

On the file edit section, there should exist an option to order the edits. For example, if a permissions based hack is being created the first step introduced should be init.php. This will produce a visual flow to the edits.

File edits are currently ordered alphabetically from root perspective, and then linenumber. Adding a display order for file edits is possible, but unlikely to appear in the 1.1 version (because all 1.0 HTL hacks might become incompatible with that, then).
I think alphabetical makes the most sense, too. Changeid's are relevant, that way, and they can help you search out file edits for hacks.

Originally Posted by princeton

I would also recommend ...
Adding a dropdown with a predefined "Difficulty rating to install this Hack".

An alternative to allow hackers to create a non-htl installer (a standalone) - for users who prefer not to save this type of data in the database; and, for users who prefer not to install/use the htl. Yes, there will be people that will not want to use the htl - for some people the htl will be to complicated. Never assume anything.

A drop-down was considered, but I decided against it because I'd have to cater to too many variations. Plus, I figured that sometimes people would want to make some mini-comment in there, like "Easiest ever!" or "well, good luck!". This gives them the freedom for that.

A non-HTL installer would defeat half the purpose of the HTL, so there will never be one. Installing non-HTL hacks will make upgrading your vBulletin difficult; using HTL-hacks only will ensure that you won't have any problems upgrading to the next version of vB.
The HTL was made to bring order in the chaos of installer textfiles. Having an option to make those would be extremely counterproductive.

People who don't want to use the HTL, for whatever purposes, will just be at a loss with all of my hacks. But so far, nobody has found the HTL complicated, in fact, I've been surprised at how userfriendly people have found it. During development, I often figured that "oh damn I'll be answering a lot of questions about this part..." but so far, none of that! On top of that, there is not a single good reason not to use the HTL, and there are dozens of reasons why it's much better to use the HTL exclusively.

Originally Posted by princeton

Other than the above, the HTML is a nice piece of software.:up:

psst, HTL



The ability to view XML files is one that I'll have to look into. It would require the writing of a `stripped-down` XML parser for each of the XML types...
I'll think about it

[Zachery]

Originally Posted by KuraFire

I'm not sure what exactly you mean... Do you mean that it somehow changed the style setting for you when you went to create an XML file?


File edits are currently ordered alphabetically from root perspective, and then linenumber. Adding a display order for file edits is possible, but unlikely to appear in the 1.1 version (because all 1.0 HTL hacks might become incompatible with that, then).
I think alphabetical makes the most sense, too. Changeid's are relevant, that way, and they can help you search out file edits for hacks.


A drop-down was considered, but I decided against it because I'd have to cater to too many variations. Plus, I figured that sometimes people would want to make some mini-comment in there, like "Easiest ever!" or "well, good luck!". This gives them the freedom for that.

A non-HTL installer would defeat half the purpose of the HTL, so there will never be one. Installing non-HTL hacks will make upgrading your vBulletin difficult; using HTL-hacks only will ensure that you won't have any problems upgrading to the next version of vB.
The HTL was made to bring order in the chaos of installer textfiles. Having an option to make those would be extremely counterproductive.

People who don't want to use the HTL, for whatever purposes, will just be at a loss with all of my hacks. But so far, nobody has found the HTL complicated, in fact, I've been surprised at how userfriendly people have found it. During development, I often figured that "oh damn I'll be answering a lot of questions about this part..." but so far, none of that! On top of that, there is not a single good reason not to use the HTL, and there are dozens of reasons why it's much better to use the HTL exclusively.


psst, HTL



The ability to view XML files is one that I'll have to look into. It would require the writing of a `stripped-down` XML parser for each of the XML types...
I'll think about it

while i belive it makes it slightly more diffucult i dont belive it makes it so much harder

to update my hack vBXirc all that was needed to do was run the upgrade process in the file it self which was 2 clicks :P

[KuraFire]

Originally Posted by Faranth

while i belive it makes it slightly more diffucult i dont belive it makes it so much harder

to update my hack vBXirc all that was needed to do was run the upgrade process in the file it self which was 2 clicks :P

So your vBXirc hack does not have any file- or template edits, then?

[Princeton]

yes, it actually changed my style settings. Upon logging-out, it reverts back to the default.

about the dropdown ... that was my point you don't want people to put anything in there; if you want to allow people to include an optional note then you should include an additional option (input). It is easier to view EASY/MEDIUM/HARD.

yea, I didn't think you would make an option for a standalone installer. The question now is would a hacker create two versions of their hacks - a non-htl and a htl version. If a hacker wishes for their hack to be installed by as many users they would be smart to create a non-htl version. Not everyone will install the HTL especially if it's not needed.

Anyway, I do agree with Faranth. the htl would make it more diffucult (more work) for some hacks.

[Zachery]

Originally Posted by KuraFire

So your vBXirc hack does not have any file- or template edits, then?

it has 1 if not 2 file edits and no template edits all my templates are stand alone