plainblack.com
Username Password
search
Bookmark and Share

Asset Installer (beta 0.3.0)

Version 0.3.0

  • Added WRE integration so people using the WRE do not have to add the 3 settings to their site's config file, as before.

____________________________________________________
The following download is a beta version of an Asset installer for WebGUI.  It simplifies life for developers creating new Assets which need to be installed, upgraded, and uninstalled from WebGUI installations.

This download contains a sample Wobject which can be installed, upgraded, and uninstalled using the installer.  It is meant to be an example, and will not work.  This is not an actual working application and will cause errors in your WebGUI log if you leave the application installed.

The following is a brief description of the installer:

Assets using this installer will be archived with the following structure and extracted into <webguiroot>/docs/<Asset Name>

Folders:

bin
- contains the executable scripts for installing, upgrading, and uninstalling the asset, as well as a meta file containing information about

docs/install - contains the create scripts for installing the asset.  Create scripts must follow the syntax create-XXX.sql

docs/template - contains all the default templates for this asset.  One template per file.  Templates are saved as (.tmpl) files.

docs/uninstall - contains the drop scripts for uninstalling the asset.  Drop scripts must follow the syntax drop-XXX.sql

docs/upgrade - contains version upgrade SQL and PL scripts used to upgrade to the next version of the asset.  Upgrade scripts  must follow the syntax upgrade_x.x.x-y.y.y.sql or upgrade_x.x.x-y.y.y.pl, where x.x.x is the current version of the asset and y.y.y is the next version of the asset

lib - contains a WebGUI folder with the asset files.  The files should be stored in the directory that they should be copied to in the WebGUI root

Scripts:
setup.pl - the install and upgrade script used to install and upgrade assets.

This script not only installs and upgrades assets, but keeps track of installed versions of your asset in a database table, which will automatically be created on install if not found in the database.  The script does the following tasks:

If an installed version of the asset is not found:
- Creates a backup of the database in a folder specified in the config file
- Creates the database tables for the asset
- Imports templates to the Import Node of the Root Asset Folder
- Adds the asset class to the config file
- Copies all of the files to the webgui root

If a version of the asset is found:
- Creates a backup of the database in a folder specified in the config file
- Runs any upgrade database and perl scripts found in the docs/upgrade folder
- Updates/Creates templates in the Import Node of the Root Asset Folder
- Copies all of the files to the webgui root

uninstall.pl - the uninstall script used to remove the asset

This script will remove the asset completly from your WebGUI instance.  The script does the following tasks:
- Removes database tables for the asset
- Removes all templates (including custom created templates).
- Removes the asset class from the config file
- Removes all of the files from the webgui root (it will not clean up empty folders)

As I've said before, this is a beta version of the Asset installer.  I have done some limited testing, but everything seems to be in order.  Please report any bugs you find, suggestions, or feedback you have to frank@plainblack.com

Enjoy!

System RequirementsPlease be advised: this contribution was tested with something older than WebGUI 7.5. When this contribution was uploaded there was no field for the author to fill out regarding it's requirements.
Comments
DownloadAsset-Installer-0.3.0-beta.tar.gz Asset-Installer-0.3.0-beta.tar.gz
Asset-Installer-0.3.0-beta.zip Asset-Installer-0.3.0-beta.zip
LinksNo Support Offered
Statistics Downloads: 641
Views: 4143
Rating: 0
Updated: 3/18/2006
Keywords miscellaneous
NavigationBack to the Bazaar
© 2018 Plain Black Corporation | All Rights Reserved