Administrative and Maintenance Tools - Template Modification System

Template Modification System
Description
This modification allows easy management of template modifications.
Hack authors can define the necessary template modifications for their products.
When exporting a product, all template modifications assigned to this product
in MASTER style will be embedded into the product XML and imported on the
end-user vBulletin installation automatically if TMS is available.
Alternatively, it is also possible to create separate XML files for template modifications.
This way, 3rd parties can provide Template-Modification XML files for existing hacks.
Hack authors can also export standard template modification instructions as
textfiles to package them with their hacks, which allows users that do not
have TMS to also install them

In case the author defined modifications do not work (eg. the user uses a custom style),
the users can easily customize the modifications for their style(s).

TMS modified templates transparently, e.g. all Templates can still be modified
manually in style manager - they will appear unchanged there.


System Requirements
This Modification requires MySQL 4.1 or higher - it does not work with MySQL 4.0!
If you use MySQL 4.1 series, MySQL 4.1.10 or higher is required
If you use MySQL 5.0 series, MySQL 5.0.3 or higher is required
TMS 1.2.0 Beta 1 or higher requires vBulletin 4.1.5 or higher

vBulletin Compatibility
Versions up to and including 1.1.5 are compatible with vBulletin 3.6.X, 3.7.X and 3.8.X
Version 1.1.5 is partly compatible with vBulletin 4.0.X and 4.1.X
Version 1.2.0 Beta 1 or higher is compatible with vBulletin 4.1.5 or higher
vBulletin 4.1.11 or higher is currently not fully supported by TMS. If you use this version please apply the following patch: tms_patch120b4.zip

Branding:
Please note that TMS puts a small branding/copyright notice in footer - see readme.txt for further details.

Version History
1.2.0 Beta 4

• Bugfix: Database error when trying to add a template modification (this bug was introduced in TMS 1.2.0 Beta 3)

1.2.0 Beta 3

• Changed: Converted hardcoded text to phrases
• New Feature: Added doubleclick for editing style variables
• Bugfix: Database error when trying to add a template modification with an existing varname to a different style
• Changed: Fixed formatting of templateedits.php
• Bugfix: Fixed erors when manually modifying a template with template modifications

1.2.0 Beta 2

• Bugfix: Fixed errors in style variable editing code

1.2.0 Beta 1

• Changed: Ported to vBulletin 4.1
• New Feature: If an error occurs while trying to compile a template this error is now being disaplayed when trying to save the template modification
• New Feature: Styles variables used in templates can be edited via AJAX from the modify template screen

1.1.5

• Fixed Bug: Fixed incorrect variable type
• New Feature: Box 'Template-Modifications' (shown on editing a template) can now be collapsed/expanded

1.1.4

• Fixed Bug: Fixed HTML error/XSS in Template Modifications Manager

1.1.3

• Fixed Bug: Added missing phrase on ACP home

1.1.1

• Fixed Bug: Fixed Error with conflicting Template Modifications when importing a product
• Fixed Bug: Removed Pre-Selection of processing mode when adding new modifications
• Fixed Bug: Fixed Bug with zlib.output_compression AND vBulletin internal gzip being both turned on
• Fixed Bug: Display search results correctly
• Fixed Bug: Added missing phrase 'varname_x_already_exists'
• New Feature: Automatically rebuild template modifications after vBulletin Upgrade

1.0.0

• Changed: Several files renamed
• Fixed Bug: Fixed incorrect handling of product ids that contain only numbers
• New Feature: Search text can be search in template when editing a Template-Modification in Style Manager
• Changed: Multiple Template-Modifications can be loaded via AJAX
• First Release on vBulletin.org

1.0.0 RC 1

• Fixed Bug: All Bugs reported for Beta 4 have been fixed
• Changed: Display of modified Templates with HTML comments has been modified
• Changed: Debug-Mode is no longer required
• New Feature: It is now possible to export/import style-specific Template-Modifications

1.0.0 Beta 4

• Fixed Bug: All Bugs reported for Beta 3 have been fixed
• Changed: Sorting in Template Modifications Manager has been changed
• New Feature: When adding or editing a Template-Modification, the Template can now be displayed and searched via AJAX
• Changed: When exporting as Text, the original instructions (eg. insert below/above) are retained
• New Feature: It is now possible to test each Template-Modification
• New Feature: Testing improved. It is now being display if a Template is OK after applying a Template Modification
• New Feature: When editing a Template, it is possible to activate/deactvate multiple Template-Modifications
• New Feature: Template-Modifications can now also be exported and tested from withing Product Manager
• New Feature: Function to display a template with all Modifications applied.
  This function can also display embedded comments to make it easier to identify changed parts

1.0.0 Beta 3

• Fixed Bug: All Bugs reported for Beta 2 have been fixed
• New Feature: Simplified adding Template-Modifications by allowing to select how to handle replacement text (eg. replace or insert above/below)
• New Feature: Each Template-Modification can now be disabled
• Changed: Testing Template-Modifications has been reworked:
  Column ordering can now be set through vBulletin Options; column headers are clickable to sort results
  Output has been separated by styles
  It is now possible to test only selcted products
• New Feature: TMS now integrates with 'Style Manager' and 'Product Manager'
• New Feature: The language can be selected when exporting Template-Modifications
• New Feature: Weh TMS gets deactivated, all Template-Modifications will be deactivated too
• New Feature: Display of Template-Modifications while editing a Template in Style Manager has been improved:
  It is now being display if a Template-Modification could be applied
  Template-Modifications can be edited via AJAX

1.0.0 Beta 2
First public Beta

[TaMpE]

Originally Posted by Black Tiger

You can choose one you like.
For example you could make varname "cybfruleslink" so thatway you know, when searching the templates later, for which mod you made the entry.

Thank you mate, now it works better. I got a DB error when I tried to guess lol

[Videx]

Over the weekend I changed every single table to latin1_swedish_ci manually. The db is set to latin1_swedish_ci. So why am I still getting the same error?

Database error in vBulletin 3.8.1:

Invalid SQL:

SELECT templateid, searchstrregex, replacestr
FROM templateedit AS templateedit
INNER JOIN templateeditlocation AS templateeditlocation ON (templateeditlocation.varname=templateedit.varname )
INNER JOIN template AS template ON (template.title=templateeditlocation.template)
LEFT JOIN style AS style ON (style.styleid=template.styleid AND FIND_IN_SET(templateedit.templateeditid, style.templateeditlist))
LEFT JOIN product AS product ON (product.productid=templateeditlocation.product)
WHERE (NOT ISNULL(style.styleid) OR (templateedit.styleid=-1 AND template.styleid=-1))
AND (product.active=1 OR templateeditlocation.product='vbulletin')
AND templateedit.active = 1
AND template.title IN ('footer')

ORDER BY searchorder ASC;

MySQL Error : Illegal mix of collations (latin1_general_ci,IMPLICIT) and (latin1_swedish_ci,IMPLICIT) for operation '='
Error Number : 1267
Request Date : Monday, February 23rd 2009 @ 11:01:11 PM
Error Date : Monday, February 23rd 2009 @ 11:01:12 PM
Script : admincp/plugin.php?do=productimport
Referrer : admincp/plugin.php?do=productadd
Classname : vB_Database
MySQL Version : 4.1.22-standard-log

[Andreas]

So why am I still getting the same error?

Check the collations for

• templateeditlocation.varname
• templateedit.varname
• template.title
• templateeditlocation.template
• product.productid
• templateeditlocation.product

Are they all the same?

[Videx]

All the varnames are latin1.bin. template.title and product.productid is still general, despite the table itself now being swedish. Silly me, thinking changing a table would of course change it's contents!

So, should I try changing yet more items manually?

[Andreas]

Make sure the columns used in the conditions are compatible (eg. templateeditlocation.varname=templateedit.varname, template.title=templateeditlocation.template and product.productid=templateeditlocation.product)

[Videx]

Done, but I still get an error:

Database error in vBulletin 3.8.1:

Invalid SQL:

SELECT plugin.*,
IF(product.productid IS NULL, 0, 1) AS foundproduct,
IF(plugin.product = 'vbulletin', 1, product.active) AS productactive
FROM plugin AS plugin
LEFT JOIN product AS product ON(product.productid = plugin.product)
WHERE plugin.active = 1
AND plugin.phpcode <> ''
ORDER BY plugin.executionorder ASC;

MySQL Error : Illegal mix of collations (latin1_swedish_ci,IMPLICIT) and (latin1_general_ci,IMPLICIT) for operation '='

Worse, when I checked my inbox a whole slew of cron errors were there, so I've set product.productid back to general:

Invalid SQL:

SELECT cron.*
FROM cron AS cron
LEFT JOIN product AS product ON (cron.product = product.productid)
WHERE cron.nextrun <= 1235509743 AND cron.active = 1
AND (product.productid IS NULL OR product.active = 1)
ORDER BY cron.nextrun
LIMIT 1;

MySQL Error : Illegal mix of collations (latin1_general_ci,IMPLICIT) and (latin1_swedish_ci,IMPLICIT) for operation '='

I wonder if I shouldn't be thinking more in terms of converting this entire db to something? But what? And how?

[Andreas]

Well, all I can say is: Fix your database.

product.productid must be the compatible with plugin.product and cron.product (and phrase.product, setting.product, productcode.productid, faq.product, ... you get the idea?)
All those standard fields really should already be the same (otherwise you would have gotten errors earlier).
With a standard MySQL installation they will most likely be latin1_swedish_ci

I suggest to export your DB schema and attach it here, that would make it a lot easier to point out which fields/tables do have the wrong collation.

[redraider]

Hi andreas, Thanks for this great modification. I have suddenly started getting a strange problem - There are a few template modifications that do not show inside "Master Style", but only in my customized styles, but when I click on the modification I get this error:

"The Template-Modification called 'Remove Navbar' can not be customized in this style because the template 'VBDRUPAL' is not customized in this style."

BUT my master style doesnt have a REMOVE NAVBAR modification listed ... how do I edit this ??

Please help!

[Videx]

I finally managed to fix my illegal mix of collations. I posted the solution here.

[TheSupportForum]

is therea tutorials to add own template edits to work with thisa program