org.safs.install

Class LibraryUpdate

java.lang.Object

org.safs.install.LibraryUpdate

public class LibraryUpdate
extends java.lang.Object

A generic customizable File directory updater for SAFS users wishing to update certain library assets with newer assets that might be available on the network in a central location.

For example, users can use this to grab centrally located build assets to update the SAFS\lib JAR files. Or, it can be used to update TCAFS libraries located in TCAFS\TCAFS\Script.

The support for this is narrowly focused to SAFS assets at this time.

Specifically, only the following file types are supported:

• .DAT
• .SVB
• .JAR
• .EXE

In addition, only source assets dated newer than Aug 01, 2012 are considered for update.

The class supports backing up older files into any specified directory. It also supports directory recursion, and an option to override the prompting for file replacement.

There are no SAFS dependencies in this class and can be packaged stand-alone in an executable JAR file.

Command-line options:

-q	(quiet mode, no prompt dialog), it should be put before other argument if present"
"-prompt:titlebar"	(alternate prompt title bar message) This parameter should appear before other parameters (at this time)
-b:backupdir	**(backup dir for replaced files)
-s:sourcedir	* (source dir containing newer files, or an HTTP URL to a ZIP) Supports HTTP URL to a ZIP file that would be downloaded and extracted into a temporary directory to be used as the sourcedir for the update. Note: Any spaces in the URL should be retained as spaces--not URLEncoded. The code will handle URL encoding of spaces. Ex: -s:http://sourceforge.net/projects/safsdev/files/SAFS Updates/SAFS.LIB Updates/SAFS.LIB.UPDATE.LATEST.ZIP
-t:targetdir	* (target dir receiving newer files)
-f	(force w/o prompting for each file)
-r	(recurse into sub-directories)
-a	(file of all types will be copy, default false)
-e:dir1;dir2	-e: followed by excluded folders separated by semi-colon, such as jre;Java;Java64 These folders can be relative to the target directory or can be absolute directory. These folders will be excluded when updating, which means they and their sub-folders will not be updated.
-nob	(no file backups required)
	* - required parameter.
	** - only required if -nob not provided.

Entry points are:

• Instance: processArgs
• Static: main

Author:

Carl Nagle Original Draft SEP 18 2013

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	_VERSION_ 1.0 current version
(package private) boolean	allfilecopy
static java.lang.String	ARG_PREFIX_A -a all file types; if not specified, only .JAR, .SVB, and .DAT will be updated, see fileIncluded(File)
static java.lang.String	ARG_PREFIX_B -b: followed by backup directory
static java.lang.String	ARG_PREFIX_E -e: followed by excluded folders (can be relative to target directory) separated by semi-colon, such as jre;Java;Java64
static java.lang.String	ARG_PREFIX_E_SEP
static java.lang.String	ARG_PREFIX_F -f Force Overwrite
static java.lang.String	ARG_PREFIX_NOB -nob Do NOT Backup older files
static java.lang.String	ARG_PREFIX_P -prompt: followed by Title
static java.lang.String	ARG_PREFIX_Q -q quiet mode
static java.lang.String	ARG_PREFIX_R -r Recurse Directories
static java.lang.String	ARG_PREFIX_S -s: followed by source (an URL or a file path)
static java.lang.String	ARG_PREFIX_T -t: followed by target directory
static java.lang.String	ARG_PREFIX_TOOLS -tools: followed by tools' name separated by semi-colon, such as GhostScript;Tool2;Tool3, to be updated or installed
(package private) java.io.File	backupdir
(package private) int	backupFiles
(package private) java.util.HashMap<java.io.File,java.io.File>	backups
boolean	canceled Gets set TRUE if the user cancelled the update from a dialog prompt.
java.lang.String	canceledMSG
(package private) java.io.PrintStream	console
(package private) boolean	dobackup
(package private) boolean	downloadDone If we need to download file from Internet in a separate thread, we need to set this field to false in the main thread.
(package private) java.io.PrintStream	errors
(package private) java.util.List<java.io.File>	excludedFolderList
(package private) java.lang.String	excludedFolderString
(package private) boolean	force
static java.lang.String	HELP_STRING
(package private) static java.lang.String	LC_DAT
(package private) static java.lang.String	LC_EXE
(package private) static java.lang.String	LC_JAR
(package private) static java.lang.String	LC_SVB
(package private) static java.lang.String	LC_TSCRIPT
(package private) int	modifiedFiles
static long	OLDEST_DATE
protected SePlusInstallInfo	productInfo Used to get the information of the current installed product.
(package private) int	progress
(package private) ProgressIndicator	progressor
(package private) java.lang.String	prompt
(package private) boolean	quiet quiet mode, if true then no dialog will prompt for confirmation, default is 'false'.
(package private) boolean	recurse
(package private) java.io.File	sourcedir
(package private) java.io.File	targetdir
(package private) java.lang.String[]	toolsToUpdate
(package private) boolean	unzipDone If we need to download zip file from Internet and unzip it in a separate thread, we need to set this field to false in the main thread.
protected FileUtilities.Predicate<java.lang.String>	unzipSkipPredicator Used to skip any files when un-zip file.

Constructor Summary

Constructors

Constructor and Description
LibraryUpdate() Default constructor using standard System.out and System.err console streams.
LibraryUpdate(java.io.PrintStream console, java.io.PrintStream errors) Alternate constructor provide different console and error output streams.

Method Summary

Modifier and Type	Method and Description
(package private) boolean	allFileIncluded(java.io.File file) Include all Files newer than OLDEST_DATE
(package private) void	backupFile(java.io.File targetfile, java.io.File backupdir) Uses copyFile to backup a targetfile to a backup directory.
protected void	close()
(package private) void	copyFile(java.io.File sourcefile, java.io.File targetfile) Copy a sourcefile to a targetfile location.
static boolean	download(java.lang.String url, java.io.File outfile)
(package private) void	downloadURL(java.lang.String url, java.io.File outfile)
(package private) boolean	fileIncluded(java.io.File file) Include only .JAR, .SVB, and .DAT Files newer than OLDEST_DATE
(package private) static void	help(java.io.PrintStream out)
protected void	init()
boolean	isQuiet()
static void	main(java.lang.String[] args) The main entry point for the application when invoked via the command-line.
(package private) java.io.File	prepareTempSourceDirectory() Prepare temporary directory for holding files downloaded from Internet.
boolean	processArgs(java.lang.String[] args) Main entry point for an instance of the class not executing from the command-line.
(package private) void	updateDirectory(java.io.File targetdir, java.io.File sourcedir, java.io.File backupdir) Re-entrant routine to process the provided directories.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_VERSION_

public static final java.lang.String _VERSION_

1.0 current version

See Also:

Constant Field Values

ARG_PREFIX_B

public static final java.lang.String ARG_PREFIX_B

-b: followed by backup directory

See Also:

Constant Field Values

ARG_PREFIX_NOB

public static final java.lang.String ARG_PREFIX_NOB

-nob Do NOT Backup older files

See Also:

Constant Field Values

ARG_PREFIX_P

public static final java.lang.String ARG_PREFIX_P

-prompt: followed by Title

See Also:

Constant Field Values

ARG_PREFIX_T

public static final java.lang.String ARG_PREFIX_T

-t: followed by target directory

See Also:

Constant Field Values

ARG_PREFIX_S

public static final java.lang.String ARG_PREFIX_S

-s: followed by source (an URL or a file path)

See Also:

Constant Field Values

ARG_PREFIX_R

public static final java.lang.String ARG_PREFIX_R

-r Recurse Directories

See Also:

Constant Field Values

ARG_PREFIX_F

public static final java.lang.String ARG_PREFIX_F

-f Force Overwrite

See Also:

Constant Field Values

ARG_PREFIX_A

public static final java.lang.String ARG_PREFIX_A

-a all file types; if not specified, only .JAR, .SVB, and .DAT will be updated, see fileIncluded(File)

See Also:

Constant Field Values

ARG_PREFIX_Q

public static final java.lang.String ARG_PREFIX_Q

-q quiet mode

See Also:

Constant Field Values

ARG_PREFIX_E

public static final java.lang.String ARG_PREFIX_E

-e: followed by excluded folders (can be relative to target directory) separated by semi-colon, such as jre;Java;Java64

See Also:

Constant Field Values

ARG_PREFIX_E_SEP

public static final java.lang.String ARG_PREFIX_E_SEP

ARG_PREFIX_TOOLS

public static final java.lang.String ARG_PREFIX_TOOLS

-tools: followed by tools' name separated by semi-colon, such as GhostScript;Tool2;Tool3, to be updated or installed

See Also:

Constant Field Values

OLDEST_DATE

public static final long OLDEST_DATE

console

java.io.PrintStream console

errors

java.io.PrintStream errors

prompt

java.lang.String prompt

recurse

boolean recurse

force

boolean force

quiet

boolean quiet

quiet mode, if true then no dialog will prompt for confirmation, default is 'false'.

dobackup

boolean dobackup

allfilecopy

boolean allfilecopy

canceled

public boolean canceled

Gets set TRUE if the user cancelled the update from a dialog prompt.

canceledMSG

public java.lang.String canceledMSG

targetdir

java.io.File targetdir

sourcedir

java.io.File sourcedir

backupdir

java.io.File backupdir

modifiedFiles

int modifiedFiles

backupFiles

int backupFiles

excludedFolderString

java.lang.String excludedFolderString

excludedFolderList

java.util.List<java.io.File> excludedFolderList

toolsToUpdate

java.lang.String[] toolsToUpdate

unzipDone

boolean unzipDone

If we need to download zip file from Internet and unzip it in a separate thread,
we need to set this field to false in the main thread. In the separate thread, when
unzip finishes, this field will be set to true. In the main thread, we can wait this
field becomes true before processing some actions like updateDirectory(File, File, File).

See Also:

updateDirectory(File, File, File)

downloadDone

boolean downloadDone

If we need to download file from Internet in a separate thread,
we need to set this field to false in the main thread.

See Also:

processArgs(String[])

progressor

final ProgressIndicator progressor

progress

int progress

unzipSkipPredicator

protected FileUtilities.Predicate<java.lang.String> unzipSkipPredicator

Used to skip any files when un-zip file. It is initialized in init().

See Also:

init()

productInfo

protected SePlusInstallInfo productInfo

Used to get the information of the current installed product.

HELP_STRING

public static final java.lang.String HELP_STRING

See Also:

Constant Field Values

LC_JAR

static final java.lang.String LC_JAR

See Also:

Constant Field Values

LC_SVB

static final java.lang.String LC_SVB

See Also:

Constant Field Values

LC_DAT

static final java.lang.String LC_DAT

See Also:

Constant Field Values

LC_EXE

static final java.lang.String LC_EXE

See Also:

Constant Field Values

LC_TSCRIPT

static final java.lang.String LC_TSCRIPT

See Also:

Constant Field Values

backups

java.util.HashMap<java.io.File,java.io.File> backups

Constructor Detail

LibraryUpdate

public LibraryUpdate()

Default constructor using standard System.out and System.err console streams.

LibraryUpdate

public LibraryUpdate(java.io.PrintStream console,
                     java.io.PrintStream errors)

Alternate constructor provide different console and error output streams.

Method Detail

init

protected void init()

close

protected void close()

processArgs

public boolean processArgs(java.lang.String[] args)
                    throws java.lang.Exception

Main entry point for an instance of the class not executing from the command-line.

Parameters:

args - command-line args

Returns:

true if the args processed OK and the updateDirectory process completed successfully. returns false if the user canceled the update or an error occurred in processing the args or performing the update.

Throws:

java.lang.Exception

help

static void help(java.io.PrintStream out)

fileIncluded

boolean fileIncluded(java.io.File file)

Include only .JAR, .SVB, and .DAT Files newer than OLDEST_DATE

Parameters:

file -

Returns:

true if file meets criteria

allFileIncluded

boolean allFileIncluded(java.io.File file)

Include all Files newer than OLDEST_DATE

Parameters:

file -

Returns:

true if file meets criteria

backupFile

void backupFile(java.io.File targetfile,
                java.io.File backupdir)
         throws java.lang.Exception

Uses copyFile to backup a targetfile to a backup directory. Retains a storage reference to every file backed up in the event that an attempt is made to roll-back the update following some type of update failure.

Parameters:

targetfile -

backupdir -

Throws:

java.lang.Exception

copyFile

void copyFile(java.io.File sourcefile,
              java.io.File targetfile)
       throws java.lang.Exception

Copy a sourcefile to a targetfile location. Will delete an existing file if it already exists before creating the replacement file.

Parameters:

sourcefile -

targetfile -

Throws:

java.lang.Exception

updateDirectory

void updateDirectory(java.io.File targetdir,
                     java.io.File sourcedir,
                     java.io.File backupdir)
              throws java.lang.Exception

Re-entrant routine to process the provided directories. If recurse is true, the routine will call itself with each new source subdirectory encountered.

Parameters:

targetdir -

sourcedir -

backupdir -

Throws:

java.lang.Exception

prepareTempSourceDirectory

java.io.File prepareTempSourceDirectory()
                                 throws java.io.FileNotFoundException,
                                        java.io.IOException

Prepare temporary directory for holding files downloaded from Internet.

Throws:

java.io.FileNotFoundException

java.io.IOException

downloadURL

void downloadURL(java.lang.String url,
                 java.io.File outfile)
          throws java.io.IOException

Throws:

java.io.IOException

isQuiet

public boolean isQuiet()

download

public static boolean download(java.lang.String url,
                               java.io.File outfile)

main

public static void main(java.lang.String[] args)

The main entry point for the application when invoked via the command-line.

Parameters:

args - Command-line options:

-q	(quiet mode, no prompt dialog), it should be put before other argument if present"
"-prompt:titlebar"	(alternate prompt title bar message) This parameter should appear before other parameters (at this time)
-b:backupdir	**(backup dir for replaced files)
-s:sourcedir	* (source dir containing newer files, or an HTTP URL to a ZIP) Supports HTTP URL to a ZIP file that would be downloaded and extracted into a temporary directory to be used as the sourcedir for the update. Note: Any spaces in the URL should be retained as spaces--not URLEncoded. The code will handle URL encoding of spaces. Ex: -s:http://sourceforge.net/projects/safsdev/files/SAFS Updates/SAFS.LIB Updates/SAFS.LIB.UPDATE.LATEST.ZIP
-t:targetdir	* (target dir receiving newer files)
-f	(force w/o prompting for each file)
-r	(recurse into sub-directories)
-a	(file of all types will be copy, default false)
-e:dir1;dir2	-e: followed by excluded folders separated by semi-colon, such as jre;Java;Java64 These folders can be relative to the target directory or can be absolute directory. These folders will be excluded when updating, which means they and their sub-folders will not be updated.
-nob	(no file backups required)
-tools:t1;t2	(tools to update or install, default "", example -tools:GHOSTSCRIPT;Tool2;Tool3)
	* - required parameter.
	** - only required if -nob not provided.