[How-To] Product Managament (vBulletin 3.5 RC 1 and up) [Archive]

Andreas

07-25-2005, 10:00 PM

This How-To is mainly meant for Hack-Developers, if you are only planning to use Hacks just read the End-User section.

Developers
vBulletin 3.5.0 RC1 introduces a new concept for customizing/modifying vBulletin: Products.
With Products, you can manage Plugins, Phrases, Settings and Templates in just one XML File.
Furthermore it supports Install/Uninstall Codes (for running queries, etc.), it also covers updating existing Hacks as you can add Codes for different Versions.

To start, you first have to turn on debug mode:
Put

$config['Misc']['debug'] = true;

in config.php.

Then go to ACP / Plugin System / Manage Products.
Click Add/Import Product.
In the second Form (Add New Product) fill in the Details for your Hack:

Product ID should be a unique ID for you Hack; it must not start with vb and should be lowercase only, not contain spaces or other special characters.
Attention: The Product ID must not be longer then 15 characters.
Title should be the Title for your Hack
Version should be the Version.
The Format shoud be Mainversion Subversion Subrelease
Example: Myhack 1.0.0 Beta 1
Description should be a short description for you Hack, eg. what it does.

Afterwards, create all the Plugins, Phrases, Templates and Settings your Hack requires and make sure you select the Product you just created.
Important: Templates must be placed in the MASTER Style, Phrases in the MASTER Language

When you are finished, go to ACP / Plugin System / Manage Products and select Edit from the Dropdown next to your Product.

In the Form (Add New Install/Uninstall Code) add all Code necessary to install/uninstall your Hack (eg, Queries, etc.).
If you are updating an existing Hack, add new Install/Uninstall Codes for the new Version that just make the changes necessary to upgrade the previous Version; Product Management will make sure that all necessary Codes will be run.

If your Hack includes Usergroup Permissions/Bitfields, add the following Code to Install and Uninstall to rebuild the Bitfield cache:

if (is_newer_version('3.5.1', $vbulletin->options['templateversion']))
{
// Rebuild Bitfields
// Do this for vBulletin < 3.5.1 *ONLY*; later versions rebuild
// automatically and calling the builder in install code causes
// the bitfields NOT to be rebuild correctly
require_once(DIR . '/includes/class_bitfield_builder.php');
vB_Bitfield_Builder::save($db);
build_forum_permissions();
}

When everything is done, go to ACP / Plugin System / Manage Products again and export the Product as XML; this will then include all Plugins, Templates, Phrases, Settings and Install/Uninstall Codes required.

End-Users
Go to ACP / Plugin System / Manage Products.
Click Add/Import Product, select the product XML File for the Hack you want to install.
If you are upgrading an existing Hack, make sure that Allow Overwrite is set to Yes

This How-To is (C) 2005 by KirbyDE and you are not allowed to redistribute it in any way without my explicit consent.

Dream

07-26-2005, 08:03 PM

ohh thanks you are fast :P

edit: so the product ID is not a number, right? do all installations of the product will have the same product ID?

akanevsky

07-26-2005, 08:13 PM

Thanks, Kirby, for this useful HowTo :)

Andreas

07-26-2005, 08:18 PM

edit: so the product ID is not a number, right? do all installations of the product will have the same product ID?
The Product ID is an Identifier for your Product like myhack, welcomepm or profileviews (those are IDs of my Hacks).

They will be the same on every Installation.

akanevsky

07-26-2005, 08:19 PM

The Product ID is an Identifier for your Product like myhack, welcomepm or profileviews (those are IDs of my Hacks).

They will be the same on every Installation.

What if two different people make a mod that server the same function and therefore uses the same ID?

Andreas

07-26-2005, 08:24 PM

That would not work, the user trying to install this would get a warning that this Product is already installed (if Allow Overwrite isn't selected).

akanevsky

07-26-2005, 08:27 PM

Oh. So the product ID becomes the actual filename?

EDIT: Oh, and why turn on debug?

Andreas

07-26-2005, 08:33 PM

You can enter just any Filename you want. But yes, it will use the Product ID as default.

You must turn on Debug Mode as you can only select Products and Master Style/Language when this is turned on.

Dream

07-26-2005, 08:39 PM

well I guess its good to use "kirbydeWelcomePM" or "darkvisorMod" as product IDs, im gonna use that if I make something

are they case-sensitive?

akanevsky

07-26-2005, 08:45 PM

Oh, and another question - why mustn't it contain "vb"?

Andreas

07-26-2005, 08:46 PM

Doesn't seem to be case-sensitive.

It must not start with vb as this Prefix is reserved for Jelsoft :)

Logikos

07-26-2005, 09:17 PM

Why do they get the vB Prefix, what makes them so darn special! ^^. Great how-to. This will help alot!

Christine

07-26-2005, 09:20 PM

Thanks Kirby! :)

uae

07-27-2005, 09:39 AM

First came the Plug-In system, took me a while to recreate an installation php files for my hacks.

Here comes the product thingy :(

It's not that I hate it or something, in fact I love it, but what about the time I have spent, gone for nothing ... nothing :cry: waaa

Andreas

07-27-2005, 09:43 AM

Well, you could have waited until Gold ;)

loneranger

07-28-2005, 07:05 PM

hi can somebody help me i have got this code from doing this tut but when i install this app it don't add the database please help me here also i think i need to build the phrases can anyone tell me what file i need to include and function to call in 3.5.0 think it's build_languages() don't know if it's changed

<?xml version="1.0" encoding="ISO-8859-1"?>

<product productid="imghost" title="Image Hosting final" description="Image Hosting" version="2.1 beta 2" active="1">
<codes>
<code version="2.1 beta 2">
<installcode><![CDATA[$db->query('CREATE TABLE '. TABLE_PREFIX .'image_host (
id INT NOT NULL PRIMARY KEY AUTO_INCREMENT,
userid INT NOT NULL,
img_file VARCHAR(225) NOT NULL,
img_name VARCHAR(255) NOT NULL,
file_size INT NOT NULL,
img_width INT NOT NULL,
img_height INT NOT NULL
)TYPE=MyISAM;');

$db->query("ALTER TABLE ".TABLE_PREFIX ."usergroup ADD imghost INT( 10 ) UNSIGNED NOT NULL ;");

$db->query("ALTER TABLE ".TABLE_PREFIX ."usergroup ADD imghostset INT( 10 ) UNSIGNED NOT NULL ;");

$db->query("ALTER TABLE ".TABLE_PREFIX ."usergroup ADD imghost_width INT( 10 ) DEFAULT '100' NOT NULL ;");

$db->query("ALTER TABLE ".TABLE_PREFIX ."usergroup ADD imghost_height INT( 10 ) DEFAULT '100' NOT NULL ;");

$db->query("ALTER TABLE ".TABLE_PREFIX ."usergroup ADD imghost_files INT( 10 ) DEFAULT '100' NOT NULL ;");]]></installcode>

Andreas

07-28-2005, 07:23 PM

The attached Product XML works fine for me.

Phrases, Templates, Settings will be installed/uninstalled automatically - you don't have to do anything for that (except assigning them to your Product of course).
Please keep in mind that they must be in MASTER Style/MASTER Language!

MrNase

07-29-2005, 02:05 AM

Custom vBulletin settings must be added with a query? Or is there a function available with adds them without using a query?

Erwin

07-29-2005, 03:01 AM

This is an amazing new feature for vB - this means that installing hacks can all be done via Admin CP with no need to edit files, run queries, add templates or phrases. :D

Guest190829

07-29-2005, 03:26 AM

Another great 3.5 tutorial, Kirby! :)

Paul M

07-29-2005, 04:49 AM

Now all we need is the ability for this to upload new files (extensions) edit templates & edit files. Then it will be a complete installation system.

Andreas

07-29-2005, 08:17 AM

Custom vBulletin settings must be added with a query? Or is there a function available with adds them without using a query?
Assign them to your Product, then Product Management will take care of Installing/Uninstalling :)

Andreas

07-29-2005, 08:18 AM

Now all we need is the ability for this to upload new files (extensions) edit templates & edit files. Then it will be a complete installation system.
I for one wouldn't like that. Especially editing Templates can be tricky, as you never know for sure how they will loke like.

Logikos

07-29-2005, 08:46 AM

I for one wouldn't like that. Especially editing Templates can be tricky, as you never know for sure how they will loke like.

Editing templates should be the users task only. Due to style customizations. But uploading files from the admincp would complete this! :)

MrNase

07-29-2005, 10:39 AM

Assign them to your Product, then Product Management will take care of Installing/Uninstalling :)

That must be done in the debug mode? Because all other things can be done without it..

Andreas

07-29-2005, 10:50 AM

Templates, Phrases, Settings and Plugins must be created in Debug Mode - as stated in the first Post.

Erwin

07-29-2005, 11:44 AM

Now all we need is the ability for this to upload new files (extensions) edit templates & edit files. Then it will be a complete installation system.

I agree. And add a file editor to that, and you have everything. ;) Better yet, have ALL of the code in XML format. No more file edits... ever.

Andreas

07-29-2005, 11:46 AM

I have to disagree. File and especially Template Edits should stay a User task, as they can be quite complicated keeping customized Styles and different Versions in mind.

deathemperor

07-29-2005, 04:07 PM

Thanks Kirby, you should write books for vbulletin.

Dream

08-01-2005, 11:43 AM

can I use version numbers like 1.0 or 1.9.5

Andreas

08-01-2005, 11:48 AM

Yes. Version Numbers can have up to 3 dots, eg. 1.2.3.4

akanevsky

08-01-2005, 12:09 PM

Thanks Kirby, you should write books for vbulletin.

Yeah, uhm, actually it's a good idea...
Kirby.. How about making a CHM collection of all the HowTO's you've written so far? :P That would be really useful.

Andreas

08-01-2005, 12:12 PM

If you could enlighten me what CHM is and how to create that - why not.
Hmm ... I could create a PDF.

akanevsky

08-01-2005, 12:18 PM

If you could enlighten me what CHM is and how to create that - why not.
Hmm ... I could create a PDF.

CHM is the file extension for Microsoft compressed HTML help files, in the other words it is the standard Windows format for storing help files. There are special software programs that allow you to create those CHM files...

As long as you make a table of contents, a PDF file would also be good. CHM files are usually neater and cleaner though...

This is an example of a CHM manual:
http://us3.php.net/get/php_manual_chm.zip/from/a/mirror

Andreas

08-01-2005, 12:27 PM

I thought the standard Windows Helpfile-Format was .hlp?
As this is what I ship my Applications with ...

Anyway, I think PDF would be better then a "proprietary" Format that doesn't work on all Platforms.

akanevsky

08-01-2005, 12:38 PM

I thought the standard Windows Helpfile-Format was .hlp?
As this is what I ship my Applications with ...

A HLP format is old and generally deprecated. Read about it here:
http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dnwue/html/ch13g.asp

Concerning platform compatibility: In Windows it is integrated, Linux has KchmViewer, Macintosh X a CHMViewer1.1... I am sure other major platforms also have a viewer for such a common filetype, otherwise it wouldn't be used in so many eBooks.

P.S. I just looked in the HowTo forum, and discovered that there are also HowTo's by other authors. Therefore, in your compilation, could you please include these other HowTo's as well? Thanks :)

Revan

08-01-2005, 12:40 PM

pdf is balls, Adobe is a bloated program when it just comes to reading pdf's. Also, it's very hard (I havent discovered how to) copy/paste something from a .pdf.
I'd like to see in chm too, that way I could even integrate it into Dreamweaver :D

Andreas

08-01-2005, 12:43 PM

Sorry, no CHM from me.
And with this post I am also denying anybody else the right to pack my How-TOs into a CHM.

But I might do a PDF :)

akanevsky

08-01-2005, 12:47 PM

And with this post I am also denying anybody else the right to pack my How-TOs into a CHM.

Ah.. I see. I was just going to ask you about it :)
What's the reason for the denying, if not a secret?
Revan is right - Adobe Viewer for PDF is too bloated.. :(

Andreas

08-01-2005, 12:49 PM

Reason = I don't like MS too much :)

akanevsky

08-01-2005, 12:52 PM

Reason = I don't like MS too much
Jeez...
Anyway, how about this: make two versions, a PDF and a CHM, to satisfy both those who like and those who dislike MS. Please thanks :)

Revan

08-01-2005, 04:15 PM

Reason = I don't like MS too much :)That's really anal. That's like saying "I refuse to zip my hacks because I hate the WinZip program. I am blatantly ignoring the fact that WinRar/WinAce/[insert name of unpacking software for Mac/Linux/Unix] can unpack these files."
Making the How-to's HARDER to use is IMHO completely against the point of making them. I consider this a kick in the nuts to the community. This paragraph (and only this) will be retracted if someone can show me a way to copy/paste from Adobe Reader. I refuse to install any other piece of software to be able to copy/paste from a .pdf document, as I do not feel the need to clutter my computer with crap that will be used 1 or 2 times.
At any rate, see if you can stop me from making CHM files on my own computer (not to distribute).

Now to get back on the actual topic:
Ive learned the hard way that settings have to be volatile for them to be able to export properly, but won't this erase them on upgrade? The code in the xml_import_settings() makes me think that if you are trying to re-import settings that are marked as volatile, it will recreate these settings. This is not a desired effect, so I hope someone can prove me wrong :p

Andreas

08-01-2005, 04:29 PM

Copying from PDF (if copying is permitted): Just use the Text Selection Tool, select the Text and click Edit/Copy.

At any rate, see if you can stop me from making CHM files on my own computer (not to distribute).

Feel free to do that for your own. But as said, I do not allow distributing CHMs.

Volatile Settings will be deleted upon update. However, vBulletin only deletes its own (eg. produvt=vbulletin) Settings.

akanevsky

08-01-2005, 04:55 PM

That's really anal. That's like saying "I refuse to zip my hacks because I hate the WinZip program. I am blatantly ignoring the fact that WinRar/WinAce/[insert name of unpacking software for Mac/Linux/Unix] can unpack these files."
Making the How-to's HARDER to use is IMHO completely against the point of making them. I consider this a kick in the nuts to the community. This paragraph (and only this) will be retracted if someone can show me a way to copy/paste from Adobe Reader. I refuse to install any other piece of software to be able to copy/paste from a .pdf document, as I do not feel the need to clutter my computer with crap that will be used 1 or 2 times.
At any rate, see if you can stop me from making CHM files on my own computer (not to distribute).

I agree. "Reason = I dont like MS" is a very lame statememnt...

Copying from PDF (if copying is permitted): Just use the Text Selection Tool, select the Text and click Edit/Copy.

That means I have to install Adobe PDF Editor, which is a bloated program that takes up a lot of space in my computer, and that is the reason why I do not have it installed. I'd rather just read the HowTo's from this site rather than from a PDF file...

Oh. And how can you restrict distrubting the CHM's? It's not like it is a copyrighted material. As long as your name is stated - there is no reason behind not distributing them, as well as there is no way you can "not allow it"...

Andreas

08-01-2005, 05:00 PM

That means I have to install Adobe PDF Editor, which is a bloated program that takes up a lot of space in my computer, and that is the reason why I do not have it installed.
No, just Arcobat Reader.

You don't like PDF, I don't like CHM and therefor I just don't support it.
So where is the Problem?

You can read the How-TOs here, build a CHM on your own or use the PDF (when there is one, which currently isn't the case anyway).

And how can you restrict distrubting the CHM's? It's not like it is a copyrighted material. As long as your name is stated - there is no reason behind not distributing them...
It is copyrighted material. Everything one writes is automatically copyrighted if not stated otherwise.
(Although this might not always be the case considering general small talk and german copyright laws).

But if you feel happy, I can explicitly point this out too.

akanevsky

08-01-2005, 05:07 PM

No, just Arcobat Reader.
"just Acrobat Reader" is bloated enough itself... I prefer to use Easy PDF Reader, which consumes much less memory and therefore is easier to use. It, however, does not allow copying of the contents.

You don't like PDF, I don't like CHM and therefor I just don't support it.
So where is the Problem?

The problem is that you are a minority on this case... The majority does prefer CHM. That's called being selfish. If you don't do it for other people, then why do it at all? I don't think anybody wants it in PDF format at all.

It is copyrighted material. Everything one writes is automatically copyrighted if not stated otherwise.
(Although this might not always be the case considering general small talk and german copyright laws).

But if you feel happy, I can explicitly point this out too.

Ok. You are right - it is copyrighted. But as long as something is free and accessible by everyone, distribution in an easy-to-use-for-people format should be promoted. Because it will just make your name more known to other people. Besides, if I am stating your name in every article, I am not breaking the copyright. Prove me wrong.

Andreas

08-01-2005, 05:12 PM

Besides, if I am stating your name in every article, I am not breaking the copyright. Prove me wrong.

Don't know for other contries, but german copyright laws do only permit personal usage and short ecerpts if you are publishing smth., you can't quote the whole document.

PDF is easy to use and available on multiple Platforms.

I am not going to support CHM.

EOD

Dream

08-03-2005, 03:51 PM

are product phrases considered orphan phrases?

tehste

08-03-2005, 04:05 PM

I like the product/hook thing I found it intuitive enough. Though it was always nice to read what you had to say about it, oh and this thread has provided some good amusement...

Princeton

08-28-2005, 07:14 PM

Just starting to get into 3.5 - excellent tutorial :up:

thank you

EDIT: Is there any way to add a new hook without editing the xml file?

Andreas

08-28-2005, 07:19 PM

You can add your own hooks_xxx.xml File.

Princeton

08-28-2005, 07:27 PM

it doesn't show under HOOK LOCATION

thank you

Andreas

08-28-2005, 08:02 PM

Due to the way it is currently implemented (http://www.vbulletin.com/forum/bugs35.php?do=view&bugid=1150), your XML must define at least 2 Hooktypes:

<?xml version="1.0" encoding="ISO-8859-1"?>

<hooks>

<hooktype type="custom">
<hook>custom1</hook>
<hook>custom2</hook>
<hook>custom3</hook>
</hooktype>

<hooktype type="custom2">
<hook>custom2_1</hook>
<hook>custom2_2</hook>
<hook>custom2_3</hook>
</hooktype>

</hooks>

The Filename should match your Product ID.
Also, there should be hooktype_xyz Phrases in Phrasegroup Plugin System for all your Hooktypes.

Princeton

08-28-2005, 08:45 PM

aha, thank you ... I got the phrasegroup and phrases all figured out also.

Paul M

08-28-2005, 10:30 PM

Reason = I don't like MS too much :rolleyes:

PDF is easy to use and available on multiple Platforms.

I am not going to support CHM.What has you not supporting it got to do with denying anyone else the right to produce a CHM version, you wouldn't be supporting it if someone else did it :confused:

Boofo

08-29-2005, 11:40 AM

How do you cache a template in a product file?

Andreas

08-29-2005, 11:52 AM

@Paul M
If I did so, I would support CHM to be a succesful Format.
Thank you for your understanding that I am not going to do this.

@boofo
This Question doesn't make sense.
However, you can cache Templates in Hook cache_templates.

Boofo

08-29-2005, 01:03 PM

@boofo
This Question doesn't make sense.
However, you can cache Templates in Hook cache_templates.

What doesn't make sense? I wanted to cache a template in the product xml of my hack. And I was informed about the cache_templates hook right after I posted this request. I missed it before. ;)

Paul M

08-29-2005, 02:31 PM

@Paul M
If I did so, I would support CHM to be a succesful Format.
Thank you for your understanding that I am not going to do this.
No need to thank me. :) You don't actually have my understanding - I find your logic very odd. :ermm:

Andreas

08-29-2005, 02:38 PM

@Boofo
It doesn't make sense because you can't "cache Templates in a Product XML"

Boofo

08-29-2005, 04:26 PM

@Boofo
It doesn't make sense because you can't "cache Templates in a Product XML"

You know what I mean, Kirby. The code and hook to cache it. ;)

Andreas

08-29-2005, 04:33 PM

Well, that's possible :)

Boofo

08-29-2005, 05:15 PM

And done! ;)

Evercraft

09-08-2005, 03:15 PM

Great how to. answered some questions for me :)

One thing id like to know, or have more info on (cant find anything using search or browsing here or google), is about the option type (i.e textarea, yesno) and default values.

For example:

I would like to use a yesno box, but i cant seem to get the default to switch to yes. What default values do i use here?
Also id like to use a single line textfield rather than a text area. How do i do that?

I know maybe this should be answered in the questions forum, but I think this info would contribute to the howto as well :)

Andreas

09-08-2005, 04:45 PM

Default for Yesno yes = 1

Albus

09-24-2005, 05:46 PM

Kirby, can you clear up some things for me? I have set my test installation of 3.5RC3 to debug mode and I now see the "Add New Setting Group" and "Add New Setting" things, but I see nothing that corresponds to "Add New Phrase Group" or "Add New Template Group". I want to be able to totally segregate my product from the rest of vB. Does that make sense? Thanks in advance for your assistance and speedy reply.

Andreas

09-24-2005, 05:51 PM

Albus

09-24-2005, 06:01 PM

Adding Phrase Groups has to be done manually as there is no GUI for it.
1) Locate the maximum phrasetypeid in table phrasetype that is < 1000
2) Insert a new record into this table that has phrasetypeid=this value+1
3) Add a new colume phrasegroup_fieldname to table language
4) Rebuild languages
Then you can add Phrases to youre Phrasgegroup

Grouping Templates is done with a Plugin on Hook template_groups

$only['prefix'] = 'Prefix';

If I do items 1-4, make the grouping plugin as directed and export the product, will the resulting xml file automatically set these up on a client? In other words, will the client installation show the new template group and phrasegroups as intended?

Andreas

09-24-2005, 06:09 PM

Yes it will.

Albus

09-24-2005, 06:18 PM

Yes it will.

Thanks, I have on last question then regarding the grouping plugin. Given the following statement, the named templates are still not grouped. Am I missing something?

$only['prefix'] = 'test_product_';

test_product_header
test_product_footer

This should wrap up my queries for a bit. Thanks for your assistance Kirby.

Andreas

09-24-2005, 06:25 PM

The Code should be

$only['test_product'] = 'Test-Product';

Then it would show up as Test-Product Templates in Stlye Manager.

Marco van Herwaarden

09-24-2005, 06:34 PM

Don't use the last underscore.

Albus

09-24-2005, 06:53 PM

The Code should be

$only['test_product'] = 'Test-Product';

Then it would show up as Test-Product Templates in Stlye Manager.

Thanks!

In review, just to make sure I have the process down:

1) Enable debug mode.
2) Enable plugin system.
3) Add your product using the manager.
4) Create custom setting groups.
5) Create custom settings.
6) Create custom phrasegroups.
- A) SELECT MAX(phrasetypeid) + 1 AS newid FROM phrasetype WHERE phrasetypeid < 1000
- B) INSERT INTO phrasetype (phrasetypeid, ...) VALUES ('$newid', ...)
- C) ALTER TABLE language ADD phrasegroup_whatever MEDIUMTEXT NOT NULL
- D) Rebuild languages
7) Create custom phrases.
8) Create custom templates beginning with a unique prefix in lowercase, such as poduct_name.
9) Tweak existing templates if needed.
10) Create the $only['product_name'] = 'Product Name'; plugin for your product using the template_groups hook.
11) Create any other hooks plugins your product needs.
12) Write new files.
13) Hack old files if needed.
14) Export your product to xml.
15) Package it with a small script to install the tables and explain manual tweaking of existing templates and files.

Done. Right?

Marco van Herwaarden

09-24-2005, 06:57 PM

Installation of new tables can be handled from the Product Manager, no need for installation scripts.

Andreas

09-24-2005, 07:09 PM

Albus

09-24-2005, 07:21 PM

@Albus
That's it - yes. But as Marco already pointed out, creating/altering tables can (and should be) handeled with product install/uninstall codes.
Also there is a function to create custom phrasetypes: add_phrase_type() in adminfunctions_language.php
Just the GUI is missing :(
I pointed this out @ .com, but the Devs don't seem to see a need for it.
For my needs, I ported this Hack (https://vborg.vbsupport.ru/showthread.php?t=59755) - makes it easy to handle Phrasegroups :)
I've contacted the author if he plans to release it, but did not get a reply so far.

Hm, so technically I can create it all online and use the install/uninstall code boxes to make the call to add_phrase_type() and handle the table work? I see there's a version number field there too. This raises two questions.

1) How does the version number affect rollbacks to a previous version, should the user wish to do so? I realize that you'd have two install codes and two uninstall codes.

2) How does this affect the order the product is installed in? In other words, what's the order of things? Install code, settings, phrases, templates, etc...

Sorry for the all the questions, but I want to make absolutely sure I know what I'm doing.

One more thing...is the 'vb' product name prefix still in effect? If so, how do things like vbadvanced name their products? I ask because I recently registered a development domain that starts with vb and would like my products to bear that prefix.

Andreas

09-24-2005, 07:26 PM

Once you've created a product XML you don't have to take care of phrase and phrasetype stuff, vBulletin will handle that itself.
I was only babbling about initially creating the phrasgroup on your developement machine.

A rollback is not possible (yet?), the User can only uninstall.

Installation order is
- Install-Code
- Templates
- Plugins
- Phrases
- Settings

On uninstall, uninstall codes will be called in reversed order (og. newest version first).

Prefix vb is reserved for Jelsoft use, yes.

Albus

09-24-2005, 07:29 PM

JJR512

09-29-2005, 02:55 AM

Where is writing the actual XML for a product covered?

Adrian Schneider

09-29-2005, 03:02 AM

Where is writing the actual XML for a product covered?

Take a look at some other products... most of the time you can generate them (export product), but sometimes you may have to go and edit the XML yourself.

Andreas

09-29-2005, 11:58 AM

Athough you can edit the XML manually (if you really know what you are doing), but in 99,9999% of all situations this is not necessary.

JJR512

09-29-2005, 01:22 PM

OK, I must have the wrong concept in my head. Or I'm confused about something.

I thought that with this new system you would have to write the XML file essentially from scratch.

Andreas

09-29-2005, 01:24 PM

You can ... but i'd not suggest doing that, could give major headaches ;)

- Create a Product
- Create all the necessary Phrases / Settings / Plugins / Templates and make sure you select the product
- Add necessary Install/Uninstall code
- Export it

Done.

akanevsky

10-01-2005, 02:24 PM

For some reason, it won't export vbulletin options for me...
It does export the vbulletin option phrases, but the option category itself (<options></options>) is blank... why?

Adrian Schneider

10-01-2005, 02:26 PM

For some reason, it won't export vbulletin options for me...
It does export the vbulletin option phrases, but the option category itself (<options></options>) is blank... why?

Did you set the setting group + setting as vBulletin default?

akanevsky

10-01-2005, 02:28 PM

No, I set it as non-default... I thought that it will prevent the setting to be deleted on vbulletin upgrade. Or no?

Adrian Schneider

10-01-2005, 02:29 PM

That's what I thought too, set them all to default otherwise it won't export. They should rephrase that...

akanevsky

10-01-2005, 02:53 PM

Ok thanx.

Boofo

10-01-2005, 03:48 PM

Ok thanx.

As long as the setting it attached to a product, it will be fine.

Cap'n Steve

10-05-2005, 06:22 AM

Actually, it's not fine. It seems if you add settings to one of the default groups, they won't export unless "vBulletin Default" is set to yes. It also seems to not even save the title and description of the setting. Is this the way it's supposed to be?

Boofo

10-05-2005, 06:46 AM

I have added settings and they show up like normal even after an upgrade. yes, you need to have it set to yes for "vBulletin Default" but if it is still attached to a product, it is there. And mine saved the title and description also. I'm not sure why it isn't working for you. :(

Cap'n Steve

10-05-2005, 06:56 AM

So what's the vBulletin Default setting do? The description is misleading, to say the least.

Boofo

10-05-2005, 06:59 AM

Kirby could probably answer that better than I could. I was just told in order to export it and have it retain the settings you entered, you must have it set to yes and attached to a product.

Marco van Herwaarden

10-05-2005, 06:42 PM

The term 'vBulletin Default' is something that is inherited from older versions. The phrase should be changed to somehting that more fits the current situation.

Andreas

10-05-2005, 08:03 PM

As already pointed out, "vBulletin Default" is misleading.
The correct meaning would be smth. like "Default Setting<dfn>This setting will be replaced during upgrades of the Product this setting does belong to</dfn>"

Cap'n Steve

10-06-2005, 03:15 AM

That would help, but I still don't understand why this setting exists. If you set it no, it's almost like the setting isn't attached to your product. It won't export or uninstall with the product it's part of unless vBulletin Default is set to yes.

Andreas

10-06-2005, 08:34 AM

Yes. That's was this option is for:
Making custom settings that won't be affected by upgrades.
And as they are custom settings, they won't be exported with the product.

buro9

10-06-2005, 09:35 AM

Oh my... I should've read this... I crafted the secret admirer one by hand, poking around in the code trying to determine what it wanted, and guessing bits as I went along!

Well, I don't think I did badly :D

Jenta

10-07-2005, 04:26 PM

Something peculiar I've discovered.

If your product involves templates and they are edited after installation, when an upgrade takes place, the modified template stays in use. Admins need to be made aware to click revert just like stock templates on vb upgrades.

I think also in one instance, I edited the product xml file by hand but didn't change the timestamp of when the template was authored. Not done testing this but I think if the dates are the same you may wind up with the same situation even though the templates have changed.

Almost forgot...
If they install a product, edit the template and then uninstall the product the template will not be uninstallled. It will move up to custom templates in the template list.

Andreas

10-07-2005, 09:09 PM

Templates behave the same way like standard vBulletin Templates:
Customizations will not be affected by Updates; If customized Templates are no longer compatible they will be reverted.
Also, if you have customized Templates and these Templates no longer exist in the MASTER style of upcoming vBulletin Versions, they will show up as custom.
I don't think that this is a big issue - it just wastes some table space.
The timestamp does not matter - whenever you import a product XML all master style templates with the productid will be deleted first.

Andreas

11-02-2005, 01:33 AM

<font size="3">Important change in vBulletin 3.5.1</font>

Product install code is now executed before the product gets inserted into the database; this way you can run any necessary pre-installation checks (mySQL Version, files are in place, etc.) and abort the instalation if necessary.

Code Monkey

11-13-2005, 07:40 PM

What's the best way to go about updating a product?

Say you add a new field to a table with an update.

Do you just put an alter table?

Will it just skip it in future updates if they already have the field?

Or should you just have a seperate upgrade script?

Marco van Herwaarden

11-13-2005, 07:58 PM

Just put the alter statement for the new version upgrade code.

timetunnel

12-01-2005, 03:25 AM

This is a wonderful thread...

This is my introduction to this feature. It sure puts a whole new light on the extent to what this software can do!

QUESTION: is it ok to leave the debug enabled or should it be disabled after the product is created, or does it matter? Is there any security issue to consider if left enabled 'permanently'?

Thanks in advance.

DaveAK

01-01-2006, 06:06 AM

That's really anal. That's like saying "I refuse to zip my hacks because I hate the WinZip program. I am blatantly ignoring the fact that WinRar/WinAce/[insert name of unpacking software for Mac/Linux/Unix] can unpack these files."
Making the How-to's HARDER to use is IMHO completely against the point of making them. I consider this a kick in the nuts to the community. This paragraph (and only this) will be retracted if someone can show me a way to copy/paste from Adobe Reader. I refuse to install any other piece of software to be able to copy/paste from a .pdf document, as I do not feel the need to clutter my computer with crap that will be used 1 or 2 times.
At any rate, see if you can stop me from making CHM files on my own computer (not to distribute).

Now to get back on the actual topic:
Ive learned the hard way that settings have to be volatile for them to be able to export properly, but won't this erase them on upgrade? The code in the xml_import_settings() makes me think that if you are trying to re-import settings that are marked as volatile, it will recreate these settings. This is not a desired effect, so I hope someone can prove me wrong :p
Ever tried the "Select Text" tool in Adobe Reader? The one where you can highlight text, and copy it to the clipboard for pasting into other applications? Try it and then you can retract your paragraph. :)

monotreme

01-20-2006, 08:23 PM

is this the only way to export your plugins?

echamberlain

11-03-2006, 04:37 PM

Is there a way to bundle php code within the product installation process?

It would be nice if the install was one xml file import and not an import, plus an upload.

Cap'n Steve

11-03-2006, 10:06 PM

When you edit a product, there's a place to put install and uninstall code.

diades

03-01-2007, 03:23 PM

Hi

I am in the process of converting any hacks etc., to do this, I read the manual for any info and then looked at the xml files that came with the installation and some of the product hacks that are around.
I then wrote a basic product, imoported it and then exported it to see if there were any changes in the file.
This led to more research and that is the reason that I am posting here.

This is the basic "product" xml file (without values) that I have gleaned thus far:
<?xml version="1.0" encoding="UTF-8"?>
<product xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="D:\Inetpub\wwwroot\webxpertz_net\products\product. xsd">
<title></title>
<description></description>
<version></version>
<url></url>
<versioncheckurl></versioncheckurl>
<dependencies maxversion="" minversion="" dependencytype=""></dependencies>
<codes>
<code version="">
<installcode></installcode>
<uninstallcode></uninstallcode>
</code>
</codes>
<templates>
<template date="" username="" name="" templatetype="" version=""></template>
</templates>
<plugins>
<plugin executionorder="" active="">
<title date="" username="" executionorder="" active="" version=""></title>
<hookname></hookname>
<phpcode></phpcode>
</plugin>
</plugins>
<phrases>
<phrasetype fieldname="" name="">
<phrase date="" username="" name="" version=""></phrase>
</phrasetype>
</phrases>
<options displayorder="" name="">
<settinggroup varname="" displayorder="">
<setting varname="" displayorder="">
<datatype></datatype>
</setting>
</settinggroup>
</options>
<helptopics hasphrases="" product="" vbversion="">
<helpscript name="">
<helptopic disp="">
<title date="" username="" version=""></title>
<text date="" username="" version=""></text>
</helptopic>
</helpscript>
</helptopics>
<cronentries>
<cron></cron>
</cronentries>
<faqentries>
<faqtype>
<faq></faq>
</faqtype>
</faqentries>
</product>
No I am trying to find out if the attributes are correct and, what, if any, are the attributes, child elements for the elements in red.
There does not seem to be a gui for that data in th cp (although I may have missed it) so, if someone can shed some light, I would be grateful.
I have written a schema for the file (as it is above) as I prefer to write the product offline as an xml file and then just import it. Thiat is also the reason for the schema, it makes life easier.
Thanks for any help.