#
# 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 ::PackageDownloader {
  #
  # NOTE: This procedure emits a message to the package downloader client
  #       log.  The string argument is the content of the message to emit.
  #
  proc pkgLog { string } {
    catch {
      tclLog [appendArgs [pid] " : " [clock seconds] " : pkgd : " $string]
    }
  }

  #
  # NOTE: This procedure sets up the default values for all URN configuration
  #       parameters used by the package downloader client.  If the force
  #       argument is non-zero, any existing values will be overwritten and
  #       set back to their default values.
  #
  proc setupDownloadServerVars { force } {

    #       from the repository, etc?  By default, this is enabled.
    #
    variable quiet; # DEFAULT: true

    if {![info exists quiet]} then {
      set quiet true
    }

    #
    # NOTE: Emit diagnostic messages when a new temporary directory name is
    #       created.
    #
    variable verboseTemporaryDirectory; # DEFAULT: false

    if {![info exists verboseTemporaryDirectory]} then {
      set verboseTemporaryDirectory false
    }

    #
    # NOTE: The user name for the public account on the package file server.
    #       If this is an empty string, there is no public account.
    #
    variable publicUserName; # DEFAULT: public

  # NOTE: This procedure returns a unique temporary directory where one or
  #       more files may be saved.  The prefix argument is a prefix for the
  #       directory name and it may be an empty string.  There is no attempt
  #       to actually create the resulting directory.
  #
  proc getUniqueTempDirectory { {prefix ""} } {
    variable temporaryRootDirectory
    variable verboseTemporaryDirectory

    set suffix [::PackageRepository::getUniqueSuffix]

    if {[string length $prefix] > 0} then {
      set result [file join $temporaryRootDirectory \
          [appendArgs $prefix $suffix]]
    } else {
      set result [file join $temporaryRootDirectory \
          $suffix]
    }

    if {$verboseTemporaryDirectory} then {
      pkgLog [appendArgs \
          "returning temporary directory name \"" $result \
          "\" for prefix \"" $prefix \"...]
    }

    return $result
  }

  #
  # NOTE: This procedure checks if there is a higher version available of the
  #       specified package on the package file server.  The language argument
  #       must be one of the literal strings "eagle", "tcl", or "client".  The
  #       version argument must be one of the literal strings "8.4", "8.5", or