TCynthesisAppUpdate

 The TCynthesisAppUpdate component provides an application with the capability of automatically checking the web for updates to your application, and automatically downloading and installing the update if one is found. This page provides more detail on the component.

Download TCynthesisAppUpdate Now! (430K ZIP File)

Download ZipMaster Now! (500K ZIP File; used by the TCynthesisAppUpdate component)
Note: I have made some small changes to the ZipMstr.pas file - you should use the one that comes with the AppUpdate component, or make the equivalent changes in the ZipMstr.pas source in the ZIP file above.

Date:	12/1/1999
Version:	2.1.0.0
Author:	James Waletzky
E-Mail:	cynthesis@home.com

Contents

Requirements

• Delphi 4.x (apply Update Pack #2 or later)
• The TNMHTTP & TNMFTP components (provided with Delphi 4.x) must be installed.
• ZipMaster component (included as DelphiZipUnzip.zip)

History

Coming real soon: Delphi 5 support!

Known Problems (as of Version 2.1.0.0)

• Cancelling the download of the Update information file during the actual download in FTP mode can cause problems. I am currently looking into this.
• The browse button in the sample application is not working as expected. I have yet to look into this. Again, if you have any ideas, please e-mail me. For now, just type in the path to the DCU file.
• If you get a message that there is a new component update available, you cannot change tabs in the test application until you've downloaded the update. If you don't want the update, simply quit the test app and reload to once again experiement with the sample.

File Contents

• Readme.html: this file
• AppUpdateTest.dpr: sample application project file.
• AppUpdateTest.res: resource file for sample application.
• AppUpdateTest.ico - icon file for the test application.
• AppUpdateMessages.res: resource file containing message strings (for component and helper).
• AppUpdateTst.dfm: main form file for the test application.
• AppUpdateTst.pas: source code for the main form file.
• CynthesisAppUpdate.dcu: compiled AppUpdate component.
• CynthesisAppUpdateHTTP.dcu: compiled AppUpdate HTTP wrapper (used by main AppUpdate class).
• CynthesisAppUpdateFTP.dcu: compiled AppUpdate FTP wrapper (used by main AppUpdate class).
• CynthesisAppUpdateLANWAN.dcu: compiled AppUpdate LAN/WAN wrapper (used by main AppUpdate class).
• CynthesisAppUpdateInfo.dcu: compiled AppUpdate information helper class.
• CynthesisAppUpdateInfoConsts.dcu: compiled AppUpdate constants file used by Info class.
• CynthesisAppUpdateMessages.dcu: compiled AppUpdate message handling (resource) class.
• CynthesisMessages.dcu: compiled helper class for managing resource files (for localization).
• CynthUtl.dcu: compiled misc. utility functions.
• CynthesisAppUpdate.dcr: component resource file.
• CynthesisAppUpdateTypes.pas: Various types used by the AppUpdate component
• Update.exe: companion helper application that takes care of installing the update.
• UnzDLL.DLL - Helper DLL used for unzipping files from the update archive.
• SampleAppUpdate.ini - Sample update information file.
• German\AppUpdateDE.DLL - German resource DLL.
• Italian\AppUpdateIT.DLL - Italian resource DLL.
• Bare source files for the ZipMaster component (get the full component here)

What is the TCynthesisAppUpdate Component?

The TCynthesisAppUpdate component provides the functionality to an application of automatically checking for new versions when on-line (via a HTTP web connection, FTP connection, or network connection), and downloading and installing application updates. The component can handle the entire update process using its own user interface, or you can capture a few simple events and handle the update process manually. Dropping the component on your application's main form, setting some properties, creating a simple INI file, and placing both the INI file and the zipped update on a web server, FTP server, or network drive are all that's required for your application to update itself!

Other features include:

• get updates via HTTP, FTP, or network drive
• different modes of update, including the options of having the component provide the update UI, providing your own update UI, or having the entire update process run without any UI.
• version information in executable compared to version information on remote server
• support for network configurations with proxy servers on particular proxy ports
• support for username and password information when retrieving updates
• distribute your binary files in a ZIP file and have the component handle the update; or
• distribute your update as an executable (EXE) that is run once the download process has completed.
• specify which versions of your application that the udpate is compatible with (you may not want to install a v5.01 update over a v1.0 binary) using smart version comparison.
• easy localization to any language (English is the default; German and Italian resource DLLs included).
• the Update helper application will close the application to be updated before applying the update
• the Update helper application will list the files that have been updated (when distributing your update using the ZIP method).
• the Update helper application will offer to run the updated application with its original command-line parameters.
• events are fired to your application for all important actions.

Limitations of Use

The TCynthesisAppUpdate component (and its various pieces) is free for non-commercial use . All I ask is that you send me an e-mail telling me that you are using the component. For use in a commercial application , please contact me (James Waletzky) via e-mail at cynthesis@home.com for licensing details. Cynthesis software has the right to charge a fee for use of this component in a commercial application. Please contact me for commercial licensing and I will forward the license agreement to you via e-mail.

The source code for this component is available from Cynthesis Software for a suggested cost of $10 (US Funds). Higher denominations are encouraged, however, to fund future development. The source code may be modified for your use but may not be redistributed. You may include the source code in any non-commercial applications that you develop without royalty. To purchase the source code please remit a cheque or money order payable to Cynthesis Software Inc. to the following address:

Cynthesis Software Inc.
408 - 260 Newport Drive
Port Moody, BC
Canada
V3H 5C6

If you decide to make use of this component, I would like to hear from you as to your comments about the component, or suggestions for improvement.

Usage

1. Install the ZipMaster component by adding the ZipMstr.pas file to a package of your choice.
2. Install the TCynthesisAppUpdate into a package of your choice such that it is available on the component palette. If you have trouble, try this: open or create a new package in the IDE. Right-click on the Contains folder in the package tree view and select "Add...". Add the DCU file to the package. Compile the package. Right-click the Contains folder once again and click Install.
3. Drop the component on your application's main form.
4. Decide what online mode (HTTP, FTP or LANWAN) you want the component to use.
5. Determine whether you want the component to handle the entire update or you want to do it manually via events (set the UpdateMode property).
6. Fill in the current version of the product, or ensure that the version information in the project settings is up-to-date.
7. Fill in the URL (for HTTP), FTP host name, or network location that will point to the update information INI file, and any other properties you desire..
8. [Optional] Fill in the ResourceDLL property to point to the DLL that contains your string resources (path information not required if the resource DLL is in the same directory as your application executable). If you are distributing your application and want to use English messages, this field may be left blank.
9. Distribute your application (don't forget to include UPDATE.EXE in your distribution package in the -same directory- as your application executable). You should also install UnzDLL.DLL in the Windows directory.
10. When it comes time for an update to your application, create an INI file as described below.
11. Prepare the update information INI file.
12. Upload the INI file and the update file to a web server as indiciated by the UpdateInfoURL property.

About the Sample Application

The sample application illustrates how to use the TCynthesisAppUpdate component in a couple of different ways. It consists of two tabs - one that allows you to update the sample application itself using one of the specified protocols, and another tab to update this component package. The first tab takes a modal dialog approach and informs the user when the update is available, asks to download, etc. via dialog boxes. The second tab updates the component package via a changing button state (run it to see what I mean). When an update is available you will be presented with an edit box where you fill in the path where your component files reside. The update will unzip the new version over top. For full details on how this works, check out the source. I have tried to comment it fairly thoroughly.

Note: The sample application has not been translated to languages other than English. Therefore, if you set the ResourceDLL property on any of the AppUpdate components on the sample form, some messages will remain in English.

Update Info INI File Format

The Update Info INI File describes the most recent application update that is sitting on the web server. The TCynthesisAppUpdate component first downloads this INI file to determine whether an update is necessary before downloading the update itself. You will need to create an INI file and upload it to the location specified in the UpdateInfoURL property of the component every time an update is available.

The format of the INI file is as follows (anything that appears in angle brackets <> should be replaced):

[UpdateInfo]

Name	Value
Name	[string] any string that describes the application (usually just the name of the application).
Version	[string] version number of the update; usually in the following format: w.x.y.z
InstallAction	[enumeration] see the InstallAction property on the component for details.
UpdateURL	[string] Location of the zip or executable file that represents the update. When the OnlineMode property of the component is set to olHTTP, this must be a URL (example: http://www.npsnet.com/waletzky/samples/sampleappupdate.zip) URL to the zip or executable file that represents the update. When OnlineMode is olFTP the UpdateURL must be in a special format of host/path/filename or be a complete FTP URL. (example: ftp.npsnet.com/waletzky/samples/appupdate.zip or ftp://ftp.npsnet.com/waletzky/samples/appupdate.zip ) When OnlineMode is olLANWAN this must be in one of two formats: standard Windows path format: d:\path\filename OR \\machine\sharename\path\filename (UNC Format) (examples: c:\waletzky\samples\appupdate.zip or \\waletzky\sharedir\samples\appupdate.zip )  Note: all lowercase is recommended for this value as well as the actual name of the file and directories on the server when OnlineMode is olFTP to avoid case sensitivity issues.
Details	[string] any text used to describe the update; could be an abbreviated list of changes. This is not used by the component other than to be made available to your event handlers via the property INIDetails.
SmartCompare	[boolean]Indicates the type of comparison that is performed when comparing version information. When SmartCompare is False (default), the version strings are compared alphanumerically. With SmartCompare True then at each segment of the version number (dot-delimited segments), comparison is done numerically if and only if that segment of both version numbers is comprised entirely of numeric digits. Also when SmartCompare is True you can use '*' as a segment wildcard in the INI variable CompatibleVersions (see below). Wildcards are NOT allowed in the INI variable "Version" or in the component property "CurrentVersion". (Any asterisk present in those two values is treated as a literal character.) SmartCompare is especially useful when the component's CurrentVersion property is left blank to cause CurrentVersion to be extracted from the exe's embedded version number. Examples: With SmartCompare True: '2.22.4c' is newer than '2.5.4c' (because numerically, 22 > 5) '2.2a.4c' is older than '2.20.4c (because alphanumerically, '22.2a' > '22.20') '2.22.*' is SAME as '2.22.4c.3' (only when 2.22.* is from the compatibilty list) '2.22.4*' is older than '2.22.4c' (because '4*' < '4c', '4*' is never a wildcard!) With SmartCompare False: '2.22.4c' is older than '2.5.4c' (because alphanumerically, '2.22' < '2.5') '2.22.*' is older than '2.22.4c.3' (because '*' is less than '4') '2.22.4*.#' is older than '2.22.4.#' (because '*' is less than '.') Regardless of SmartCompare setting: '2.2a.4c' is older than '2.5.4c'. (because '2a' < '5') '2.22.blah' is newer than '2.22'
CaseSensitiveCompare	[boolean] The default value is False, no case sensitivity in version comparison. Applies to comparison of CompatibleVersions and Version INI variables with component property CurrentVersion.
CompatibleVersions	[string; comma-delimited] A list of versions (in the same format as the version field) that this update can be applied over top of. If the user has, say, version 1.0.0.0 of your application installed, the patch may not apply. You may only want to patch 2.0.0.0 clients. Any person with a 1.0.0.0 client will have to upgrade to 2.0.0.0 before applying the update. If the SmartCompare INI variable is True, then you can use "wildcards" here. For example, CompatibleVersions=1.9.*,2.* would update all versions begining with '1.9.' or '2.'. Note that the '*' must be the only character of the segment in order to be considered a wildcard, and if it's not the last segment, then and trailing segments will be ignored. There is no wild card in '2.2*.3' or '2.*2.3'. Also, '2.*' is the same as '2.*.1'. This INI variable is optional. If missing, it is assumed that any version is compatible with the update, if its version compares older than the update.

Creating the Update ZIP File

When using the install action iaUseUpdate, you need to create a ZIP file containing the update and place that file on a web server for retrieval. This file should take on the same directory structure as your application. For example, if your directory structure looks like this:

MyApp (where your main executable is stored)
+ Samples
+ Help
+ Doc

then your update ZIP file should have the same structure so that you can place updated files directly over top of the currently installed versions. You may want to place a CHANGES.TXT file inside your update so that the user can view the release notes for the update some time after the update has been applied.

Localizing Message Strings

The AppUpdate component is easily localized to different languages. By default, the component has English messages linked into the component. If a different language is desired, the following actions must be performed:

1. Create a new DLL that basically contains nothing but a resource file containing a string table.
   Open the AppUpdateDE.DLL in a resource editor (like the Visual C++ IDE) and check out the string table that resides within that DLL for reference. If you would like the source to the AppUpdateDE.DLL file, e-mail me .
2. Open the AppUpdateMessages.RES file in a resource editor (to be used for comparison).
3. In the new string table, perform a one-to-one translation of all of the strings listed in the string table in AppUpdateMessages.RES. Each translated string should have the same resource ID as in the AppUpdateMessages.RES file.
   For example, translate the string "Update progress", which has a string ID of 100, to the equivalent foreign-language string, and give it the same string ID of 100.
4. Also copy the strings in the appropriate ZipMsgXX file into the new string table.
   For example, the german resource DLL AppUpdateDE.DLL contains within it the contents of the ZipMsgDE.RES file. You can get resource files for many different languages in the full version of the ZipMaster component, which you can download here.
5. Build the DLL and include it with your application distribution. Name the file "AppUpdateXX.DLL", where "XX" is the two character country code.
   For example, AppUpdateDE.DLL is for German translations.
6. Set the "ResourceDLL" property on the AppUpdate component that is contained within your form to the name of the DLL you just built.
7. Build your application and you're done!

Shortcut: A shortcut to the above procedure would be to copy one of the sample resource DLLs included with the AppUpdate component (e.g. AppUpdateDE.DLL) to a new file. Open the DLL in a resource editor and replace the resources in the DLL with your own translations.

Note: This technique of localization even allows you to change languages dynamically at run-time simply by shipping the appropriate resource DLLs with your application and setting the ResourceFilename property on the component.

Note: Unfortunately, the strings that are defined within the HTTP component and FTP component that are used by the AppUpdate component are not localized. Therefore, some rarely seen error messages may in fact appear in English even though you have localized the component for a different language. I will do my best to find a better, cross-language, HTTP and FTP helper component in the near future.

Component Properties

PUBLISHED (Design-time/Run-time):

PUBLIC (Run-time):

Component Methods

Method Signature	Description
Initialize;	Make sure that this method is called before using the component within an application. If you want to override any design-time values you assigned to the component properties, assign the override values prior to calling this method. For example, your application may prompt the user for UserName, UserPassword, ProxyServer, and ProxyPort.
CheckForUpdate: TCynthesisAppUpdateError;	Call this method to check the web, FTP, or LAN/WAN server for an update. Note that for mode umAutoWithUI and umAutoNoUI, you call only Initialize and then this method. A good place to call this method is when your application is initializing. Another possible spot is when the user chooses a menu item in your application like "Check For Updates". Note that if you call CheckForUpdate and you are not on-line, the standard Windows dial-up networking dialog box will appear asking you to dial in to your Internet service provider. You may want to have your application check the on-line status and only call CheckForUpdate if you are on-line. If there is demand for this feature, I may add the check to the component itself.
DownloadUpdate: TCynthesisAppUpdateError;	Call this method once it has been determined that an update is available and the user has decided to apply it. This method should be called from the OnUpdateAvailable event handler in the case of a manual update.  Note that the "auto" UpdateModes will call this method for you.
InstallUpdate: TCynthesisAppUpdateError;	Call this method once the update file has been successfully downloaded and the user wishes to apply the update. This method should be called from the OnDownloadComplete event handler in the case of a manual update.  Calling InstallUpdate will trigger the update of the UPDATE.EXE helper application and resource DLL (if one is being used). The update of these files are necessary at this point as updating the helper application while it is running is not possible due to the files being loaded in memory. Note that the "auto" UpdateModes will call this method for you.
CancelUpdate: TCynthesisAppUpdateError;	Call this if for some reason you want to abort the update process once it has been started.

* For a definition of the TCynthesisAppUpdateError structure, see the file CynthesisAppUpdateTypes.pas

Component Events

Event Signature	Description
OnUpdateAvailable( Sender: TObject; Version: String)	This event is fired by the update component when an update has been found. The Version string indicates the version of the update that was found on the web server. This event allows the application to prompt the user to download the update, or dismiss the update until some later time. You should call DownloadUpdate once it is determined that the update should be downloaded. If you are using umAutoWithUI mode and you do not furnish this event handler, the component will automatically prompt to download the update or cancel.
OnNoUpdateAvailable( Sender: TObject)	This event is fired when it is determined that no update exists on the web server. This may be because either an update info file does not exist, or because the version on the web server is the same or earlier than the one currently installed. This type of event is required since the whole update checking sequence is asynchronous. If it was synchronous, you could simply wait for a result code from the CheckForUpdate method. If you are using umAutoWithUI mode and have not supplied this event handler and no update is available, a messagebox 'No Update Available' will be presented to the user.
OnDownloadProgress( Sender: TObject; Progress: Integer; Msg: String)	This event is fired by the update component periodically to indicate the current progress and status of the update file download. The Progress parameter indicates a percentage complete, and the message is a status string that you may want to display in a status bar. This is a good place to update a progress bar based on the value, and display the message on a status bar. If you are using umAutoWithUI mode and have not supplied this event, the component will present a progress window with progress text and a progress bar for both downloads (info file and update).
OnDownloadComplete( Sender: TObject)	Called when the download of the update is complete. This is a good spot to warn the user that the application will now be closed and that the update will now be applied. You should call InstallUpdate once it is determined that the update is to be applied.
OnUpdateAborted(Sender: TObject; eReason: TUpdateAbortReasons)	This event is called when an error occurs when attempting to download the update or the update file. The error message will indicate the problem so you should display it to the user.. If you are using umAutoWithUI mode and have not suppied this event handler, the component will suppy its own and present appropriate error messages.
OnError( Sender: TObject; ErrorInfo: TCynthesisAppUpdateError)	This event is called when an error occurs when attempting to download the update or the update file. The error message will indicate the problem so you should display it to the user. - See AppUpdateTypes.pas for details on the TCynthesisAppUpdateError s structure

Tips and Tricks

Here are some tips and tricks to help you out when using the component:

• Check out the sample application called AppUpdateTest - it will give you a good idea as to how the component works and what to do in the case of a manual update. - The TCynthesisAppUpdate component will close your application automatically once the InstallUpdate method is invoked. This is to ensure that none of the application files are in use when the update is applied. Your application should be coded to expect this situation.
  
• The TCynthesisAppUpdate component will close your application automatically once the InstallUpdate method is invoked. This is to ensure that none of the application files are in use when the update is applied. Your application should be coded to expect this situation.
  
• Use the iaUseUpdate install action when you simply want to update certain files that have been installed to some file hierarchy in or under where your application's executable file is located. If you need to apply new registry settings, or install files to a different directory (e.g. under the Windows system directory), it is recommended that you write a small install program (e.g. using InstallShield) that does not permit any user interaction, but simply installs the files to the appropriate locations and adjusts the registry, etc. as required.
  
• It is recommended that every time you distribute an update for your application you update the main executable whether it needs it or not. This has the effect of updating the version number used by the update component to determine if an update on the web is newer than the one currently installed.
  
• When OnlineMode is set to olFTP, watch out for case sensitivity. The UpdateURL variable in the INI file, the INIUpdateURL property of the component, and the actual names of the file AND DIRECTORIES on the FTP server have to match perfectly, including upper-/lower-case.
  
• The update information file's extension does not have to be '.INI'. INI files tend to invite curious people to open them with Notepad. People are less apt to edit a file that is not obviously (by its extension) editable. You might want to use INF, DAT, UPD, etc.
  
• When using OnlineMode set to olLANWAN you can use a normal DOS-style path format (e.g. d:\path\filename) for the UpdateInfoURL property and a UNC format (\\machine\sharename\path\filename) for the UpdateURL INI variable, or vice-versa, or both values can be of the same format. Any UserName or UserPassword supplied will be used only with the UNC-formatted value.
  
• Localization of the AppUpdate component is very easy if you have the source! Simply add a new value to the TLanguageTypes enumerated type in CynthesisAppUpdateMessages.pas. Note the offset from the English value (English offset = 0). Next, open the AppUpdateMessages.res file in your favorite Resource editor. Add your translations of the English strings to the string table with an ID equal to the English ID + Offset. For example, if English is currently the only supported language and I want to add German, I would add the type ltGerman to the TLanguageTypes enumeration, and for a message with a string ID of 100, I would add the German translation with an ID of 101. Then, set the language for the component on your form and go!

Testimonials

• "The CynthesisAppUpdate component has saved me hours of work and gives my applications that professional look. I'll be using it on all my Delphi projects from now on." --Michael Holligan
  
• "I recently discovered your magnificent AppUpdate Component for Delphi. It saved me hours of development and it really works great for me!" -- Timo Goebel

Acknowledgements

• Thanks to Timo Goebel for providing the German translations and Renato Portello for providing the Italian translations that are distributed as of v2.1.0.0.
  
• Extremely Special Thanks go to Shakya Jones for laying the groundwork and implementing a significant portion of the new features in v2.0.0.0. The list of new features would not have been this substantial if it weren't for his valuable help. Great job Shakya!
  
• Thanks to Chris Vleghert and Eric W. Engler for creating the Delphi ZipMaster component that this component leverages.

 James Waletzky,
cynthesis@home.com