CodeSnip Old Code (SVN)

{
 * EventHandlers.ps
 *
 * Pascal script for use in [Code] Section of CodeSnip's Install.iss.
 *
 * Implements all event handlers that hook into Setup program to perform
 * required customisations.
 *
 * $Rev$
 * $Date$
 *
 * ***** BEGIN LICENSE BLOCK *****
 *
 * Version: MPL 1.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with the
 * License. You may obtain a copy of the License at http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for
 * the specific language governing rights and limitations under the License.
 *
 * The Original Code is EventHandlers.ps.
 *
 * The Initial Developer of the Original Code is Peter Johnson
 * (http://www.delphidabbler.com/).
 *
 * Portions created by the Initial Developer are Copyright (C) 2008-2012 Peter
 * Johnson. All Rights Reserved.
 *
 * Contributors:
 *    NONE
 *
 * ***** END LICENSE BLOCK *****
}


var
  // Reference to custom wizard page that gets info from user about whether to
  // preserve config data and database. Whether page is displayed depends on
  // whether we can update config files and database.
  gConfigPage: TInputOptionWizardPage;

  // Flag true if user wants to bring forward a copy of the main database
  gDatabaseCopyingRequested: Boolean;

// Called during Setup's initialization. Initialises global variables that
// provide information location of data folders and database and about any
// earlier installation that has been detected.
function InitializeSetup: Boolean;
begin
  InitGlobals;
  gDatabaseCopyingRequested := False;
  Result := True;
end;

// Called when wizard is initialising. Creates custom page used to inform
// whether existing old-style config files and database should be preserved.
procedure InitializeWizard;
begin
  // Create custom page
  gConfigPage := CreateInputOptionPage(
    wpSelectProgramGroup,
    'Code Snippets Online Database',
    'Should Setup make a copy of your old installation''s online database?',
    'Setup has detected that no copy of the Code Snippets online database is '
      + 'available to this new installation. However a copy from an an older '
      + 'version of CodeSnip has been detected and can be installed. Clear the '
      + 'check box below if you prefer not to do this.'
      + #13#10#13#10
      + 'NOTE: This does not copy any user defined database you may have. '
      + 'You will be given an opportunity to do that when you run your new '
      + 'version of CodeSnip for the first time.',
    False,
    False
  );
  gConfigPage.Add('Copy existing database');
  gConfigPage.Values[0] := True;
end;

// Called to determine whether page specified by PageID should be displayed.
// Display of custom page is inhibited only if no data conversion is necessary.
function ShouldSkipPage(PageID: Integer): Boolean;
begin
  Result := False;
  if PageID = gConfigPage.ID then
  begin
    if not DataConversionRequired or MainDatabaseExists then
      Result := True;
  end;
end;

// Called when "Next" button is clicked on page specified by CurPageID. Used to
// record state of check boxes on custom page.
function NextButtonClick(CurPageID: Integer): Boolean;
begin
  Result := True;
  if CurPageID = gConfigPage.ID then
    gDatabaseCopyingRequested := gConfigPage.Values[0];
end;

// Helper routine for UpdateReadyMemo. Appends text to a string followed by two
// newlines (per NewLine parameter) providing text is not an empty string.
// Returns updated string in Res.
procedure AddTextToMemo(Text: string; var Res: string; NewLine: string);
begin
  if Text <> '' then
    Res := Res + Text + NewLine + NewLine;
end;

// Called to determine text to be displayed on "Ready to install" wizard page.
// We use all given information and add information about any data conversion to
// be carried out.
// See Inno Setup docs for details of parameters.
function UpdateReadyMemo(Space, NewLine, MemoUserInfoInfo, MemoDirInfo,
  MemoTypeInfo, MemoComponentsInfo, MemoGroupInfo,
  MemoTasksInfo: String): String;
begin
  Result := '';
  // Use all given info: empty strings ignored
  AddTextToMemo(MemoUserInfoInfo, Result, NewLine);
  AddTextToMemo(MemoDirInfo, Result, NewLine);
  AddTextToMemo(MemoTypeInfo, Result, NewLine);
  AddTextToMemo(MemoComponentsInfo, Result, NewLine);
  AddTextToMemo(MemoGroupInfo, Result, NewLine);
  AddTextToMemo(MemoTasksInfo, Result, NewLine);
  // Add custom information
  if DataConversionRequired and not MainDatabaseExists then
  begin
    Result := Result +  'Database preservation:';
    Result := Result + NewLine + Space;
    if gDatabaseCopyingRequested then
      Result := Result + 'Copy existing Code Snippets database'
    else
      Result := Result + 'Don''t copy database'
        + NewLine + Space + Space
        + 'The database can still be downloaded when CodeSnip is run';
    Result := Result + NewLine + Space;
  end;
end;

// Called to perform pre-install and post-install tasks. We performs any
// required data conversion at the post-install stage.
procedure CurStepChanged(CurStep: TSetupStep);
begin
  // We perform ini file post-install
  if CurStep <> ssPostInstall then
    Exit;

  // Update config file and copy database if necessary
  if DataConversionRequired then
  begin
    // Check if user has requested data conversion
    case gPrevInstallID of
      piOriginal:
        {Do nothing: per user config files only};
      piV1_9:
      begin
        CopyCommonConfigFile(piV1_9);
        if gDatabaseCopyingRequested then
          CopyMainDatabase(piV1_9);
      end;
      piV2V3:
      begin
        CopyCommonConfigFile(piV2V3);
        if gDatabaseCopyingRequested then
          CopyMainDatabase(piV2V3);
      end;
    end;
  end;

  // Ensure common config has correct config file and program version
  // information. This creates the config file if it doesn't exist
  StampCommonConfigFile;

  // Display message if no database is installed
  if not MainDatabaseExists then
    MsgBox(
      'The Code Snippets database is not currently installed. '
        + 'Therefore when you first start CodeSnip no snippets will be '
        + 'displayed.'#10#10
        + 'You can download the database using the program''s "Database | '
        + 'Update From Web" menu option.',
      mbInformation,
      MB_OK
    );
end;