[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 princeton

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

Hmmm... that might be due to the HTL using 'styleid' as the varname, and that that somehow changes a setting.... weird though, shouldn't happen in the Admin CP..
I'll look into it.

Originally Posted by princeton

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.

Maybe. If I were to implement that change now, I'd have to make HTL 1.1 be compatible with 2 versions of .htl files.... :|

Originally Posted by princeton

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.

Everyone, -everyone-, is better off using HTL-hacks only. There is no reason for people who want to hack up their vBulletin to not install the HTL. Even for the tiniest hack, it makes things easier. To create, but also to use the hack.

The HTL was made and designed to make things easier, and it works perfectly for that. Creating a non-HTL installer would not only defeat the purpose, but also mean a lot of needless work for the Hack creator.

There is no real harm in making people install the HTL, it's only a few clicks and 3 simple file edits away. And then, once they've done that, a whole new world will open up for them. If people go release HTL-hacks only for a while, now, pretty soon there will be no need for this entire discussion anymore, and suddenly we'll have much more hacks because everyone has to spend far less time on each hack, and thus has more time to spare for new / other hacks

Originally Posted by princeton

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

I disagree. For the simplest, tiniest hack, the HTL is a better choice. For the huge, highly intricate hacks, the HTL is a better choice. For everything in-between, the HTL is still a better choice.

No matter the size of the hack, using the HTL for it is easier and faster.

[Zachery]

Originally Posted by KuraFire

Hmmm... that might be due to the HTL using 'styleid' as the varname, and that that somehow changes a setting.... weird though, shouldn't happen in the Admin CP..
I'll look into it.


Maybe. If I were to implement that change now, I'd have to make HTL 1.1 be compatible with 2 versions of .htl files.... :|


Everyone, -everyone-, is better off using HTL-hacks only. There is no reason for people who want to hack up their vBulletin to not install the HTL. Even for the tiniest hack, it makes things easier. To create, but also to use the hack.

The HTL was made and designed to make things easier, and it works perfectly for that. Creating a non-HTL installer would not only defeat the purpose, but also mean a lot of needless work for the Hack creator.

There is no real harm in making people install the HTL, it's only a few clicks and 3 simple file edits away. And then, once they've done that, a whole new world will open up for them. If people go release HTL-hacks only for a while, now, pretty soon there will be no need for this entire discussion anymore, and suddenly we'll have much more hacks because everyone has to spend far less time on each hack, and thus has more time to spare for new / other hacks


I disagree. For the simplest, tiniest hack, the HTL is a better choice. For the huge, highly intricate hacks, the HTL is a better choice. For everything in-between, the HTL is still a better choice.

No matter the size of the hack, using the HTL for it is easier and faster.

unless you only want to install one hack :P

[KuraFire]

Originally Posted by Faranth

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

Then it could still be done easier with the HTL

right now it may be slightly tricky, but I'm looking into ways for HTL 1.1 so that you can just install a new version of an already installed hack right on top of the existing one. So that would be easiest of all ways... sadly that's not in HTL 1.0 yet though, but hey, 1.1 won't be too long.. ^_^

[KuraFire]

Originally Posted by Faranth

unless you only want to install one hack :P

Really, how many people in this community install only one tiny simple hack, and never touch any other hack?

That percentage is minimal, and certainly negligable if you ask me. Even for them it would be easier, cos the HTL, no matter how you look at it, is the easiest way to upgrade your vBulletin and instantly re-apply your hacks. Whether it's one hack or one hundred.

[Zachery]

Originally Posted by KuraFire

Then it could still be done easier with the HTL

right now it may be slightly tricky, but I'm looking into ways for HTL 1.1 so that you can just install a new version of an already installed hack right on top of the existing one. So that would be easiest of all ways... sadly that's not in HTL 1.0 yet though, but hey, 1.1 won't be too long.. ^_^

not really, im my installer is ezier for this one alone but like ive stated it will be released for both.

all you need to do , upload files, run install, click button 2-3 times and your done

also only one file edit is truely nessary and thats only if you use CSS as a file

[eXtremeTim]

Originally Posted by KuraFire

Upload the .htl file to your htlfiles/ directory, then go to Install Hack, choose the Nowplaying hack that should now be there, hit Install, and on the next screen, you will have 4 radio buttons at the bottom:

Import into database only - no changes
Do a complete, Real Install
Do a test run (shows file- and template edits)
Do a verbose test run (shows exact contents of each step)

Choose the first one (Import into database only) and it will add it to your database

Thats no good tho. It just shows me that i have a hack waiting to install. I cant edit any of the hacks stuff or anything. Like say that its installed on the hacklog.php page or anything. I got around the problems by just skipping over step 5, but not everybody is going to think about that. And with some hacks there might be new queries and stuff.

[KuraFire]

Originally Posted by eXtremeTim

Thats no good tho. It just shows me that i have a hack waiting to install. I cant edit any of the hacks stuff or anything. Like say that its installed on the hacklog.php page or anything. I got around the problems by just skipping over step 5, but not everybody is going to think about that. And with some hacks there might be new queries and stuff.

That's probably residue from you doing an incomplete installation.

Try manually removing the hack from your database, table hack. Look at what hackid it has and then remove all rows in table hacklog that belong to that hackid.

Then try to import again.

[KuraFire]

Originally Posted by Faranth

not really, im my installer is ezier for this one alone but like ive stated it will be released for both.

all you need to do , upload files, run install, click button 2-3 times and your done

also only one file edit is truely nessary and thats only if you use CSS as a file

That's because you've already had your installer. That isn't the case for 95% of the rest, they would still have to handcraft an installer on their own, first. But not if they choose to go the HTL-way.

[eXtremeTim]

Originally Posted by KuraFire

That's probably residue from you doing an incomplete installation.

Try manually removing the hack from your database, table hack. Look at what hackid it has and then remove all rows in table hacklog that belong to that hackid.

Then try to import again.

No see the problem is that i have already installed the hack before the htl and alot of other people have installed hack before the htl. So there will be problems bringing hacks into the htl at first for poeple. There will also be problems with upgrades up hack from what i can tell. Your hack appears to not compare the new version with the old version and detect what to run and not run. If you could manage to add that in this hack would be god.

[buro9]

Loads of hype to be sure... but are there screenshots?

I personally am from the camp that I don't trust anything like this to manage my hacks... and I wonder how it will keep track of all the hacks I make to my own code that I don't release.

To this end, amid the cries of "lovely UI", is possible to have a series of screen shots showing how this all looks and as an overview for how it hangs together.

The killer thing that I'm waiting for is not the management of file changes, but the management of template changes (diff tool for updated templates compared to customised templates for example... phrase manager to show the non-default phrases and and the customised values after upgradem, etc).

As such... as overwhelming as the docs and this thread is... put me in the skeptical camp until I've seen convincing screenies and believe that this will manage my own private hacks too.

Awaiting the gif's or links

Cheers

David K

PS: Don't flame me for being a cynic... I really want this to work... it sounds dreamy... but I'm elderly (30) and have grown far too cynical to just install a big hack and hope that it fills my dreams so easily