MINI INSTALLER 1.0.1 free!		see other Java utilities at: Yagga's Java pages!

A simple package to build self installating programs in Java. The process is script driven, the result is a unique JAR file that the user can double click to execute a wizard-like installation process.

From versin 1.0 MiniInstaller is distributed free (binaries and source code)
under GNU's General Public License!

• display graphics
• display text files
• display notes
• ask user to input values
• ask the user to choose directories /files
• unzip files
• execute java classes or (better) JARs to perform custom operations
• move back and forward during installation
• copy files

All this behaviour is controlled via a very simple script language. The user can then launch the resulting big JAR file, and move back and forth in the installation process, just like the Inst*llWiz*rd-like Windows app. The actual process of building the resulting self installing JAR file is done by copying MiniInstaller files in a directory, along with the application specific JARs and ZIPs and data files, modifying the script file, then launching from the command line a simple script. The script simply JARs everything up, along with a suitable manifest file, so all the final user has to do in order to launche the installation wizard is to double click the jar file, or type: java -jar install.jar!

a sample screenshot of the installer

In this project I use some other classes that I'm also publishing. These classes regards JAR based resource managers and class loaders, and even can be used form inside a JAR file that is class-loaded by a class enclosed in another JAR (or in the same JAR if the former JAR is jar-red long)..

See MetaJarUtilities for further infos..

Changes from 1.0

• Corrected glitch that made installation under JDK/JRE 1.4 go broke if path
  of install file contained spaces. Now the behaviour is corrected
  

 <base_dir> 
   |
   +- MiniInstaller.jar (main jar for installation utilities - Don't modify)
   |
   +- installer.mf (manifest file for self-installing jar - Don't modify)
   |
   +- sample.conf (config file for installatin  - Modify this file)
   |
   +- makeinst.bat (bacth file (WIN95) 4 jarring  process - Can modify)
   |
   +- makeinst.sh (bacth file (UNIX) 4 jarring process - Can modify)
   |
   +- data/
   |   |
   |   +- any file of data you like here .... (directory names are just a suggestion)
   |
   +- imgs/
   |   |
   |   +- any imgs you like here .... (you can use just one directory or many)
   |
   +- jars/
       |
       +- any jars you like here .... (just another name)

1. exit at any time, aborting the process.
2. move back/forward one step at a time, if the step has completed
3. terminate the installation if every step was executed

• TOP: title of the current step (with title of the installation)
• LEFT: list of all steps. The current step is highlighted
• RIGHT: the main panel. Displays infos, prompts the user, etc...
• BOTTOM: navigation buttons: Exit, Back and Forward.

_HIDE

hides the main window

_SHOW

displays the main window

_STEP_HIDE

hides the left step list

_STEP_SHOW

displays the left step list

_SEP_STR= <character>

set the separation character between parameters to <character>

_DIMS, <width>, <height>

set the dimension of the main panel (RIGHT) to <width> x <height> pixels. Please experiment a little with size before settling to a given dimension.

_SET_COL, <element>, <red> , <green>, <blue>

set the color of the specified <element> to (<red>, <green>, <blue>)

colors values can range from 0 to 255

<element> can be:

• BK background
• TITLE color of the title string (as written on the TOP panel)
• SMALL_TITLE title of textual panel, if any
• TEXT color of text in the RIGHT panel
• STEP color of steps names in the LEFT panel
• BTN button caption color (as in Bottom panel)

• TITLE main title
• SMALL_TITLE title of textual panel (if any), copy, unzip panels etc..
• TEXT generic text
• STEP steps names in the LEFT panel

• Dialog font used in dialog boxes
• SansSerif like Arial..
• Serif like Times New ROman
• DialogInput
• Monospaced like Courier

• 0 plain
• 1 bold
• 2 italic
• 3 bold and italic

SET, <var_name>, <value>

set the value of a variable to the one given. Please note that the variable name is specified without enclosing $s. As a special case, setting "DEBUG" to 1 or true enables console debugging

START, <step_name>, <title> , <text>

Defines a start state, with a title and a text

START_IMG, <step_name>, <text> , <img_path>

Defines a start state, with a caption and an image

 

Please note that even if no explicit START or START_IMG state is given, a default one is created.

SHOW, <step_name>, <image_file>

adds a step named <step_name> that display an image (JPG or GIF supported).The path to the image file can be absolute, or -better- relative to files packed inside the main JAR file.

DISPLAY, <step_name>, <text_file>

adds a step named <step_name> that display a scrollable text file. The path to the text file can be absolute, or -better- relative to files packed inside the main JAR file.

WRITE, <step_name>, <text>

adds a step named <step_name> that display a text string

INPUT, <STEP_NAME>, <TITLE>, <PROMPT TEXT>, <VAR_NAME> [, <DEFAULT_VALUE>]

adds a step named <STEP_NAME> that propmt the user to specify a value. The prompt has a text and a global title, and the value the user enters is stored in the variable named <VAR_NAME>. If there is a default value, this value is pre-inserted in the input field

INPUT_FILE, <STEP_NAME>, <TITLE>, <PROMPT TEXT>, <VAR_NAME> [, <DEFAULT_VALUE>]

adds a step named <STEP_NAME> that propmt the user to choose a directory. A convenience "Browse" button is provided. The prompt has a text and a global title, and the chosen directory is stored in the variable named <VAR_NAME>. If there is a default value, this value is pre-inserted in the input field

UNZIP, <STEP_NAME>, <TEXT>, <ZIP_FILE>, <DEST_DIR>

adds a step named <STEP_NAME> that unzip a file in the user file system. The zip file specified must be JARred in the install.jar file. The destination directory is a directory in the user file system. If the directory does not exists, MiniInstaller tries to create it.

COPY, <STEP_NAME>, <SRC_DIR>, <FILE_MASK/FILE_MASK_LIST>, <DEST_DIR>

Copy files from source dir to destination dir. Files copied are the one given by the file mask. If a file list is given, it is a list of files or files mask separated by a comma (so enclose the list in double quotes). Masks are in the very simpe form of: 1) * 2) *.* 3) foo* 4) *bat 5) Ast*.java. No serious things like a*b.foo* are allowed.

EXEC_JAR, <STEP_NAME>, <JAR_FILE>, <PARAM_1>, .., <PARAM_N>

adds a step named <STEP_NAME> that excutes a jar file with parameters. The JAR file specified must be JARred in the install.jar file. The JAR file must specify in its manifest the Main-Class attribute. When executing the Jar, the installer invokes the main class's (provided it is Public) "main" method with the given number of parameters, that can be zero or more. The STDOUT result is storer in the special variable $_$ and displayed on the page.
It is more or less formally eqivalent to writing:
EXEC_JAR_METHOD, <STEP_NAME>, <JAR_FILE>, main_class, "main", param1, .., paramN
with the differcence that here parameters are packed inside a String array (String[]) that is passed as the only parameter to the main method.

EXEC_JAR_METHOD, <STEP_NAME>, <JAR_FILE>, <CLASS_NAME>, <METHOD>, <PARAM_1>, .., <PARAM_N>

adds a step named <step_name> that excutes a method inside a jar file with parameters. The JAR file specified must be Jarred in the install.jar file. The installer looks for the STATIC PUBLIC method of the given CLASS (give the fully qualified name of the class!), and the method is invoked with the given parameters. The first method of the given class with the same number of parameters as the ones passed is invoked. Simple conversion is made from String to appropriate types. No conversion is possible to arrays, so avoid using arrays. Use this to build libraries of classes and methods. The result of the method invokation, if any, is converted to String using standard toString() methods, is displayed on the page and stored in the special variable $_$.
You can specify the actual path or relative path of the jar file inside the main JAR. If you experience problems try making the main Class public.
As an example:

EXEC_JAR_METHOD,executing,data/myarkive.jar,my.com.MyClass,myMethod,"hello, boy!"

EXEC_JAVA, <STEP_NAME>, class, method, arg1, .., argN

executes a java public static method on an object of the class given. The method must be static and public, along with the class. The .class must be jarred in the jar file plainly (i.e. not inside another jar file). It cannot reside in a separate direcvtory but must BE in the root directory. Or in directories that reflect the package the class belongs to, but starting from the root directopry.

So EXEC_JAVA, net.userlab.Test, doSelfTest, true looks for a public static method named "doSelfTet", in a class whose byte code should reside in a directory located UNDER the ROOT directory, and named net/userlab/. It is better if the class also be public.

The result of the method invokation, if any, is converted to String using standard toString() methods, is displayed on the page and stored in the special variable $_$.

FINAL, <STEP_NAME>, <TITLE>, <TEXT> [,<SHELL_COMMAND>, <SHELL_CAPTION>]

adds the final step named <step_name> that concludes the installation process. The <title> followed by <text> is displayed. If a a Shell command and a caption are given, ask user if they want to execute the given shell command. The caption of the button that enables user to chose to execute the program is SHELL_CAPTION. The program is executed AFTER the graphical user interface is shut down, and just before MiniInstaller exits. It is kinda spawned, and so it is not in the control of MiniInstaller.

The program is almost equivalent to typing at the shell/command prompt "SHELL_COMMAND", but please note that STD_IN, STD_ERR and STD_OUT are directed to MiniInstaller, so the are not seen/usable by the user. Try using graphicl programs.

To obtain a certain degree of portability I have defined the special variable $OS_SHELL$ that you can use in SHELL_COMMAND. If you are launching an external program you shouldn't need such varible, but if you plan to invoke system commands (like 'dir' in Windoze, which it is not a separate program) you have to prefix it with $OS_SHELL$. Moreover this variable evaluates correctly (and differently) in Win98 and WinNT. So "$OS_SHELL$ start data/info.txt" evaluates to "command.exe /C start data/info.txt" on my Win2K machine, and this brings up notepad showing the file data/info.txt.

• USER_NAME the name of the user running the installer
• USER_HOME the home directory oif the user
• JAVA_HOME home directory of currently running Java VM
• JAVA_VERSION Java version!
• OS_NAME name of the operating System
• OS_ARCH platform onto whcih the operating System is running
• OS_VERSION version of the operating System
• OS_SHELL a special prefix to put before shell-like comamnds you may want to execute on exit, and it evaluates to "sh -c" on Uni*, "command /c" or "cmd /C" on Windoze
• _ holds the textual results of the last EXEC_XXX command execution (use it as $_$)

How to build code

If you plan to buld your own code here is the flow-of-work I use:

install.jar
   |   
   +- MiniInstaller.jar
   |  
   +- sample.conf
   |  
   +- META-INF
   |    |
   |    +- manifest.mf 
   | 
   +- net/
   |   |
   |   +- yagga/
   |        |
   |        +-util/
   |            |
   |            +- BoostrapJarClassLoader.class  
   |   
   +- data/   (or whatever name you like)
   |    |
   |    +- any files.. 
   |
   +-imgs/ (or whatever name you like)
        |
        +- any img files.. 

TO-DOs

• Better deletion of installed files (and directories!!) upon abortion of installation
• Implementing simple IF THEN ELSE statements
• Adding check boxes/ radio button panels

BUGs

• many.. I'm sure..

Yagga's Java pages are copyright(C) 1999
Walter Gamba

Yagga server and PbML are copyright (C) 1999
of Marco Becchio and Walter Gamba