# NOTE: Use our own namespace here because even though we do not directly
#       support namespaces ourselves, we do not want to pollute the global
#       namespace if this script actually ends up being evaluated in Tcl.
#
namespace eval ::PackageUploader {
  #
  # NOTE: This procedure sets up the default values for all configuration
  #       parameters used by the package uploader client.  If the force
  #       argument is non-zero, any existing values will be overwritten
  #       and set back to their default values.
  #
  proc setupUploadVars { force } {
    #
    # NOTE: This variable must exist and must be the fully qualified path
    #       of the directory containing this script.
    #
    variable pkgr_path

    if {![info exists pkgr_path]} then {
      error [appendArgs \
          "required namespace variable \"" [namespace current] \
          "::pkgr_path\" does not exist"]
    }

    #
    # NOTE: The project code for the Fossil repository.  This will be checked
    #       prior to staging or committing any files.
    #
    variable projectCode; # DEFAULT: 9ceada8dbb8678898e5b2c05386e73b3ff2c2dec

    if {$force || ![info exists projectCode]} then {
      set projectCode 9ceada8dbb8678898e5b2c05386e73b3ff2c2dec
    }

    #
    # NOTE: What is the fully qualified path to the directory containing
    #       package client toolset?
    #
    variable scriptDirectory; # DEFAULT: <scriptDir>

    if {$force || ![info exists scriptDirectory]} then {
      set scriptDirectory $pkgr_path
    }

    #
    # NOTE: This is the name of the executable file used to invoke Fossil,
    #       possibly without a file extension.
    #
    variable fossilFileNameOnly; # DEFAULT: <unset>

    if {$force || ![info exists fossilFileNameOnly]} then {
      if {[isWindows]} then {
        set fossilFileNameOnly fossil.exe
      } else {
        set fossilFileNameOnly fossil
      }
    }

    #
    # NOTE: The command to use when attempting to verify that Fossil is
    #       available for use.
    #
    variable fossilVersionCommand; # DEFAULT: fossil version

    if {$force || ![info exists fossilVersionCommand]} then {
      set fossilVersionCommand {{${fossilFileNameOnly}} version}
    }

    #
    # NOTE: The regular expression pattern used when attempting to verify
    #       that Fossil is installed.
    #
    variable fossilVersionPattern; # DEFAULT: {^This is fossil version [12]... }

    if {$force || ![info exists fossilVersionPattern]} then {
      set fossilVersionPattern {^This is fossil version [12]\.\d+ }
    }

    #
    # NOTE: The command to use when attempting to check for changes prior to
    #       staging files using Fossil.
    #
    variable fossilChangesCommand; # DEFAULT: fossil changes ...

    if {$force || ![info exists fossilChangesCommand]} then {
      set fossilChangesCommand \
          {{${fossilFileNameOnly}} changes --chdir {${directory}}}
    }

    #
    # NOTE: The regular expression pattern used when attempting to verify
    #       that the Fossil checkout has no changes staged.  Generally, this
    #       pattern should only match an empty string.
    #
    variable fossilChangesPattern; # DEFAULT: {^$}

    if {$force || ![info exists fossilChangesPattern]} then {
      set fossilChangesPattern {^$}
    }

    #
    # NOTE: The command to use when attempting to check the checkout status
    #       prior to staging files using Fossil.
    #
    variable fossilInfoCommand; # DEFAULT: fossil info ...

    if {$force || ![info exists fossilInfoCommand]} then {
      set fossilInfoCommand \
          {{${fossilFileNameOnly}} info --chdir {${directory}}}
    }

    #
    # NOTE: The regular expression pattern used when attempting to extract
    #       the current check-in identifier for the Fossil checkout.
    #
    variable fossilInfoCheckoutPattern; # DEFAULT: {^checkout:\s+... UTC$}

    if {$force || ![info exists fossilInfoCheckoutPattern]} then {
      set fossilInfoCheckoutPattern \
          {^checkout:\s+([0-9a-f]{40}) \d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2} UTC$}
    }

    #
    # NOTE: The regular expression pattern used when attempting to extract
    #       the root directory for the Fossil checkout.
    #
    variable fossilInfoLocalRootPattern; # DEFAULT: {^local-root:\s+(.*?)$}

    if {$force || ![info exists fossilInfoLocalRootPattern]} then {
      set fossilInfoLocalRootPattern {^local-root:\s+(.*?)$}
    }

    #
    # NOTE: The regular expression pattern used when attempting to verify
    #       that the Fossil checkout belongs to the correct project.
    #
    variable fossilInfoProjectCodePattern; # DEFAULT: {^project-code:\\s+...\$}

    if {$force || ![info exists fossilInfoProjectCodePattern]} then {
      set fossilInfoProjectCodePattern [appendArgs \
          {^project-code:\\s+${projectCode}\$}]
    }

    #
    # NOTE: The regular expression pattern used when attempting to verify
    #       that the Fossil checkout is sitting on the correct branch.
    #
    variable fossilInfoTagsPattern; # DEFAULT: {^tags:\s+trunk(?:,|$)}

    if {$force || ![info exists fossilInfoTagsPattern]} then {
      set fossilInfoTagsPattern {^tags:\s+trunk(?:,|$)}
    }

    #
    # NOTE: The command to use when attempting to reset the checkout to the
    #       default branch prior to staging files using Fossil.
    #
    variable fossilUpdateCommand; # DEFAULT: fossil update trunk ...

    if {$force || ![info exists fossilUpdateCommand]} then {
      set fossilUpdateCommand \
          {{${fossilFileNameOnly}} update trunk --chdir {${directory}}}
    }

    #
    # NOTE: The command to use when attempting to stage package files using
    #       Fossil.
    #
    variable fossilAddCommand; # DEFAULT: fossil add ...

    if {$force || ![info exists fossilAddCommand]} then {
      set fossilAddCommand \
          {{${fossilFileNameOnly}} add --chdir {${directory}} {${fileName}}}
    }

    #
    # NOTE: The command to use when attempting to commit package files using
    #       Fossil.
    #
    variable fossilCommitCommand; # DEFAULT: fossil commit ...

    if {$force || ![info exists fossilCommitCommand]} then {
      set fossilCommitCommand \
          {{${fossilFileNameOnly}} commit -m {${comment}}\
          --branch {${branch}} --user anonymous --chdir\
          {${directory}} --no-prompt}
    }

    #
    # NOTE: The regular expression pattern used when attempting to verify
    #       that Fossil committed a set of files.
    #
    variable fossilCommitPattern; # DEFAULT: {^New_Version: ([0-9a-f]{40,64})$}

    if {$force || ![info exists fossilCommitPattern]} then {
      set fossilCommitPattern {^New_Version: ([0-9a-f]{40,64})$}
    }

    #
    # NOTE: Emit diagnostic messages when a new package is submitted?
    #
    variable verboseMetadataSubmit; # DEFAULT: false

    if {$force || ![info exists verboseMetadataSubmit]} then {
      set verboseMetadataSubmit false
    }
  }

  #
  # NOTE: This procedure sets up the default values for all configuration
  #       parameters used by the package uploader client that require the
  #       location of the checkout directory.  If the force argument is
  #       non-zero, any existing values will be overwritten and set back
  #       to their default values.
  #
  proc setupCheckoutVars { force } {
    #
    # NOTE: What is the fully qualified path to the root directory of the
    #       Fossil checkout containing the package client toolset?  This
    #       procedure may raise script errors.
    #
    variable checkoutDirectory; # DEFAULT: <checkoutDir>

    if {$force || ![info exists checkoutDirectory]} then {
      set checkoutDirectory [getCheckoutDirectory]
    }
  }

  #
  # NOTE: This procedure returns a string value, formatted for use within a
  #       script block being processed by the [string map] command.  The

  #       one or more of the variable setup in the next step.
  #
  ::PackageRepository::maybeReadSettingsFiles [info script]

  #
  # NOTE: Setup the variables, within this namespace, used by this package.
  #
  setupUploadVars false
  setupCheckoutVars false

  #
  # NOTE: Provide the package to the interpreter.
  #
  package provide Eagle.Package.Uploader 1.0.9
}