[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

[PiotrasG]

Originally Posted by KuraFire

Whe?

yea, i dont know why it does it :tired:
i checked the db and there is no tables, for some reason it cant insert them :ermm:

[KuraFire]

Originally Posted by PiotrasG

yea, i dont know why it does it :tired:
i checked the db and there is no tables, for some reason it cant insert them :ermm:

OK, so even during installation, when you try to install the Hack Tracking Log, you can't get the tables created?

Do you have a table prefix?

[PiotrasG]

i get this in step 1 of 5 when i go to install it.

[KuraFire]

Originally Posted by PiotrasG

i get this in step 1 of 5 when i go to install it.

*clueless*

I'll try and look into it tonight or tomorrow, seems real strange though... :/

[Zelda-King]

EDITED: I got a scare for a moment. The new templates were only added to the default of my 8 styles so I was seeing a blank page for hacklog.php.

[Nikidala]

Originally Posted by KuraFire

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...

The only ideas I can think of are:
1) This may be a pain in the butt (especialy for those with it already installed), but have the HTL, upon installation:
- create a non-visible to users global "HTL Global Templates (do not remove)" style
- iterate through all available styles and make "upper level" templates (i.e. - no parents) have the parent of the "HTL Global Templates" style

Then, each "install" would apply the new templates to the "HTL Global Templates" style and all style underneath would have the new templates available to them. Since changed templates are done "by hand", the admin / installer person could choose to either apply the template changes to the "HTL Global Templates" for every template to inherit (except ones that have those templates already changed) and / or specific templates only.


2) Have the importing of new templates display a page with all styles (user selectable and not) list like:

• Parent Style 1
  • Sub 1 Style 1
  • Sub 1 Style 2
• Parent Style 2
  • Sub 2 Style 1
• etc.

Each style (whether user selectable or not, or parent or sub) would have a checkbox where the admin / installer person would select as many (or few) styles to apply the new templates to. On second thought, maybe just have the parent styles with checkboxes (but still show sub styles), since the code would probably error out if the new templates weren't available.


3) Automatically apply the new templates to all parent (or all styles, although that may be overkill).


4) Apply all new templates to built-in master style and provide a utility to reapply all new templates from all hacks marked as installed.


The problem that I see with option 2 and option 3, is if a new "parent" style is created. There would need to be a way to apply each hacks new templates to new parent styles, or else users could run into problems and not realize what the issue really is.


The only time "new" templates would ever come into play is when a file specifically loads and either it "calls" the template, or one of the modified, already existing templates "calls" the template. If a file is having to load the template, then it should be available in every style that a user can choose (by either applying it to one master parent style, each parent style, or each style period).


Personally, my fav is option 1 (probably why it is 1 ). The only thing that would make that cooler, is to have the functionality of "disappearing" (like the "master style") when the forum is not in debug mode. That would be good for the non-technical admins, so they don't get confused, but it could be bad for applying hacks (so maybe not). Reasoning for not would be that logically if one wanted to truely make a hack "global" then, rather than creating another "global" style, the changed templates should be changed in the "HTL Global Templates" style. Then all new and all changed tempaltes are available to child styles (i.e. - all styles), except in the case of the actual template being customized in the child style.


Actually, makes me think of another idea (don't you hate me yet )... No matter what option you choose, a good tool for the HTL would be a child "checker" for changed templates. The "checker" would go through each "parent" and their children and make sure that "customized" templates in the parent aren't being overriden in the child (or maybe just on a per hack basis, and just go through the "changed templates" list). That way, if you have say 20 children and you had to customize a certain template on maybe one or two of them, but the new hack you installed changed that template (which would have been applied to the parent), then you could get a list of the children that may also need to be "hacked" as well (rather than just hoping you didn't miss one)...

[Zelda-King]

I found some other issues.

1) This could be just me. Probably is, but in spite of selecting 'yes' for 'show hack on front-end' I'm not seeing the hacks listed in hacklog.php (see 1st attachment. There should be 15 hacks showing). I can view the hack in the admin CP but is more supposed to show than what I'm seeing (see 2nd attachment)?

2) You have an extra query for uncached templates. I'll try and locate it in a while. Note: I can see you've cached your custom templates. Excuse me while I try some debugging...

3) You don't have hacklog.php accounted for in Who's Online, resulting in the Unknown Location Syndrome.

[Zelda-King]

OK, these are the templates involved. Not all of them are 'actual' templates of course...;

headinclude, header, spacer_open, navbar, navbar_link, gobutton, footer, spacer_close, option.

EDIT: Hmph! I'm still getting the extra query. But I checked EVERY occurance of BEGIN TEMPLATE and END TEMPLATE. Weird...

[KuraFire]

Originally Posted by Zelda-King

I found some other issues.

1) This could be just me. Probably is, but in spite of selecting 'yes' for 'show hack on front-end' I'm not seeing the hacks listed in hacklog.php (see 1st attachment. There should be 15 hacks showing). I can view the hack in the admin CP but is more supposed to show than what I'm seeing (see 2nd attachment)?

2) You have an extra query for uncached templates. I'll try and locate it in a while. Note: I can see you've cached your custom templates. Excuse me while I try some debugging...

3) You don't have hacklog.php accounted for in Who's Online, resulting in the Unknown Location Syndrome.

1) then something went wrong for you, possibly during install or elsewhere. I don't know why, but others aren't having a problem. Did you check to see that the sub-templates (ie. hacklog_hack and hacklog_overviewbit) are added to all of the styles as well?

2) I think issue number 2 will disappear once you've discovered that, yes, two templates ARE indeed not added to the style you're viewing it in. That's why it gives an uncached template query - if it can't find the template in the cache (caused by it not existing for this style), it will do a query for it in the database (but it won't find it there either cos it doesn't exist for this style).

3) That's on purpose. I'm building an advanced Add Who's Online Locations hack that allows you to add WOL locations from the Admin CP. Instead of forcing people to do 2 additional file modifications for the HTL, I chose to let people wait for this new hack. Also, I made this choice because not everyone will want/use the front-end, and only the front-end will be relevant for the WOL issue.

[KuraFire]

Originally Posted by Nikidala

4) Apply all new templates to built-in master style and provide a utility to reapply all new templates from all hacks marked as installed.

Unless vB3 proves to have a Styleid=0 option that I can use as that "HTL Global Templates" style, in effect, I will probably be going for option 4. It's the easiest to implement and will take the least time to write. It's also the most userfriendly option, imo.

Styleid=0 would, btw, mean that it's effectively another MASTER STYLE but one that doesn't get deleted. If I recall correctly, the vB3 language system has a languageid=0 that works -somewhat- the same...