Changes On Branch 1b8b52e27d57656d
Not logged in

Changes In Branch pkgdSelfUpdate Through [1b8b52e27d] Excluding Merge-Ins

This is equivalent to a diff from 7e7cba65fa to 1b8b52e27d

2016-08-19
20:13
Refactor and add code to permit the package repository and downloader clients to be self-updated. check-in: 090817ba13 user: mistachkin tags: trunk
19:14
The package downloader client is now working again. check-in: e31d9b486a user: mistachkin tags: pkgdSelfUpdate
04:51
Refactoring work-in-progress on the package downloader client. check-in: 1b8b52e27d user: mistachkin tags: pkgdSelfUpdate
02:55
Move all package client files into a '1.0' sub-directory. check-in: 7e7cba65fa user: mistachkin tags: trunk
02:48
Remove the duplicated 'maybeReadSettingsFile' procedure as it is no longer necessary. check-in: 89022f2b30 user: mistachkin tags: trunk

Modified client/1.0/pkgd.eagle from [39534dc0c9] to [d48f797d43].

21
22
23
24
25
26
27
28










29
30
31
32
33
34
35
#
namespace eval ::PackageDownloader {
  #
  # NOTE: This procedure sets up the default values for all configuration
  #       parameters used by the package downloader client.  There are no
  #       arguments.
  #
  proc setupDownloadVars {} {










    #
    # NOTE: Prevent progress messages from being displayed while downloading
    #       from the repository, etc?  By default, this is enabled.
    #
    variable quiet; # DEFAULT: true

    if {![info exists quiet]} then {







|
>
>
>
>
>
>
>
>
>
>







21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
#
namespace eval ::PackageDownloader {
  #
  # NOTE: This procedure sets up the default values for all configuration
  #       parameters used by the package downloader client.  There are no
  #       arguments.
  #
  proc setupDownloadVars { script } {
    #
    # NOTE: What is the fully qualified path to the directory containing the
    #       package downloader client?
    #
    variable clientDirectory

    if {![info exists clientDirectory]} then {
      set clientDirectory [file dirname $script]
    }

    #
    # NOTE: Prevent progress messages from being displayed while downloading
    #       from the repository, etc?  By default, this is enabled.
    #
    variable quiet; # DEFAULT: true

    if {![info exists quiet]} then {
74
75
76
77
78
79
80














































81
82
83
84
85
86
87
    #
    # NOTE: Return a directory parallel to the one containing the library
    #       directory.
    #
    return [file join [file dirname [info library]] pkgd]
  }















































  #
  # NOTE: This procedure adds a directory to the auto-path of the specified
  #       language (i.e. native Tcl or Eagle).  The directory will not be
  #       added if it is already present.  The language argument must be the
  #       literal string "eagle" or the literal string "tcl".  The directory
  #       argument is the fully qualified path for the directory to add to
  #       the auto-path.







>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>







84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
    #
    # NOTE: Return a directory parallel to the one containing the library
    #       directory.
    #
    return [file join [file dirname [info library]] pkgd]
  }

  #
  # NOTE: This procedure returns non-zero if the specified file seems to be
  #       an OpenPGP signature file.  The fileName argument is the name of
  #       the file to check, which may or may not exist.
  #
  proc isPgpSignatureFileName { fileName } {
    if {[string length $fileName] == 0} then {
      return false
    }

    set extension [file extension]

    if {$extension eq ".asc"} then {
      if {[file exists $fileName]} then {
        return [::PackageRepository::isPgpSignature [readFile $fileName]]
      } else {
        return true
      }
    } else {
      return false
    }
  }

  #
  # NOTE: This procedure returns non-zero if the specified file seems to be
  #       a Harpy script certificate file.  The fileName argument is the name
  #       of the file to check, which may or may not exist.
  #
  proc isHarpyCertificateFileName { fileName } {
    if {[string length $fileName] == 0} then {
      return false
    }

    set extension [file extension]

    if {$extension eq ".harpy"} then {
      if {[file exists $fileName]} then {
        return [::PackageRepository::isHarpyCertificate [readFile $fileName]]
      } else {
        return true
      }
    } else {
      return false
    }
  }

  #
  # NOTE: This procedure adds a directory to the auto-path of the specified
  #       language (i.e. native Tcl or Eagle).  The directory will not be
  #       added if it is already present.  The language argument must be the
  #       literal string "eagle" or the literal string "tcl".  The directory
  #       argument is the fully qualified path for the directory to add to
  #       the auto-path.
123
124
125
126
127
128
129
130


















































131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150

151

152
153
154


155
156
157
158
159
160
161
162
163
164

165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185






186




187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206



207
208
209
210
211
212

213

214
215
216
217
218
219
220
221
222
223
224
225
226

227
228
229

230
231
232
233
234
235
236
237
238
239
240

241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256

257
258
259
260
261
262
263
        }
      }
    } else {
      error "unsupported language, no idea how to modify auto-path"
    }
  }

  #


















































  # NOTE: This procedure attempts to download a list of files, optionally
  #       persistening them for subsequent uses by the target language.
  #       The language argument must be the literal string "eagle" or the
  #       literal string "tcl".  The version argument must be the literal
  #       string "8.4", "8.5", or "8.6" when the language is "tcl" -OR-
  #       the literal string "1.0" when the language is "eagle".  The
  #       fileNames argument must be a well-formed list of file names to
  #       download, each one relative to the language/version-specific
  #       directory on the package file server.  The persistent argument
  #       should be non-zero if the downloaded files should be saved to
  #       permanent storage for subsequent use.  The usePgp argument
  #       should be non-zero when an OpenPGP signature file needs to be
  #       downloaded and verified for each downloaded file.  The
  #       useAutoPath argument should be non-zero to modify the auto-path
  #       to include the temporary or persistent directories containing
  #       the downloaded files.
  #
  # <public>
  proc downloadFiles {
          language version fileNames persistent usePgp useAutoPath } {

    variable baseUri

    variable downloadUri
    variable persistentDirectory
    variable quiet



    if {[string length $language] == 0 || $language eq "eagle"} then {
      if {$version ne "1.0"} then {
        error "unsupported Eagle version"
      }
    } elseif {$language eq "tcl"} then {
      if {$version ne "8.4" && $version ne "8.5" && $version ne "8.6"} then {
        error "unsupported Tcl version"
      }
    } else {

      error "unsupported language"
    }

    if {$persistent} then {
      set downloadRootDirectory $persistentDirectory
    } else {
      set directoryNameOnly [appendArgs \
          pkgd_ [string trim [pid] -] _ [string trim [clock seconds] -]]

      global env

      if {[info exists env(PKGD_TEMP)]} then {
        set downloadRootDirectory $env(PKGD_TEMP)
      } elseif {[info exists env(TEMP)]} then {
        set downloadRootDirectory $env(TEMP)
      } elseif {[info exists env(TMP)]} then {
        set downloadRootDirectory $env(TMP)
      } else {
        error "please set PKGD_TEMP (via environment) to temporary directory"
      }







      set downloadRootDirectory [file join \




          $downloadRootDirectory $directoryNameOnly]
    }

    set downloadDirectories [list]

    foreach fileName $fileNames {
      if {[string length $fileName] == 0 || \
          [file pathtype $fileName] ne "relative"} then {
        error [appendArgs \
            "bad file name \"" $fileName "\", not relative"]
      }

      set directoryParts [file split [file dirname $fileName]]

      if {[llength $directoryParts] == 0} then {
        error [appendArgs \
            "bad file name \"" $fileName "\", no directory parts"]
      }

      set downloadDirectory [file normalize [eval file join \



          [list $downloadRootDirectory] $directoryParts]]

      set downloadFileName [file normalize [file join \
          $downloadDirectory [file tail $fileName]]]

      if {!$persistent} then {

        catch {file delete $downloadFileName}

      }

      file mkdir [file dirname $downloadFileName]

      set savedFileName $fileName
      set fileName [file join $language $version $fileName]
      set uri [subst $downloadUri]
      set fileName $savedFileName

      if {[isEagle]} then {
        writeFile $downloadFileName \
            [interp readorgetscriptfile -- "" $uri]
      } else {

        writeFile $downloadFileName \
            [::PackageRepository::getFileViaHttp $uri 10 stdout $quiet]
      }


      if {$usePgp} then {
        set downloadSignatureFileName [appendArgs $downloadFileName .asc]

        set savedFileName $fileName
        set fileName [file join \
            $language $version [appendArgs $fileName .asc]]

        set uri [subst $downloadUri]
        set fileName $savedFileName


        if {[isEagle]} then {
          writeFile $downloadSignatureFileName \
              [interp readorgetscriptfile -- "" $uri]
        } else {
          writeFile $downloadSignatureFileName \
              [::PackageRepository::getFileViaHttp $uri 10 stdout $quiet]
        }

        if {![::PackageRepository::verifyPgpSignature \
            $downloadSignatureFileName]} then {
          error [appendArgs \
              "bad PGP signature \"" $downloadSignatureFileName \"]
        }
      }

      lappend downloadDirectories $downloadDirectory

    }

    set downloadDirectories [lsort -unique $downloadDirectories]

    if {$useAutoPath} then {
      foreach downloadDirectory $downloadDirectories {
        addToAutoPath $language $downloadDirectory








>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>


|
|
|
|
|
|
|
|
|
|
|







>

>



>
>









|
>
|
|

|
<

|
<
|
<

|
|
|
|
|
|
|
|
|

>
>
>
>
>
>
|
>
>
>
>
|


|















|
>
>
>
|


|

|
>
|
>




<
|
|
|

|
|
<
<
>
|
<
|
>
|
<
<
|
<
<
<

|
<

>
|
<
<
<
<
<
|

<
<
<
<
|
|
|
|
>







179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279

280
281

282

283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340

341
342
343
344
345
346


347
348

349
350
351


352



353
354

355
356
357





358
359




360
361
362
363
364
365
366
367
368
369
370
371
        }
      }
    } else {
      error "unsupported language, no idea how to modify auto-path"
    }
  }

  #
  # NOTE: This procedure downloads a single file from the package file server,
  #       writing its contents to the specified local file name.  It can also
  #       verify the PGP signatures.  When a PGP signature file is
  #       downloaded, this procedure assumes the corresponding data file was
  #       already downloaded (i.e. since OpenPGP needs both to perform the
  #       signature checks).  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 "8.6" when the
  #       language is "tcl" -OR- the literal string "1.0" when the language
  #       is either "eagle" or "client".  The fileName argument is a file
  #       name relative to the language and version-specific directory on the
  #       package file server.  The localFileName argument is the file name
  #       where the downloaded file should be written.  The usePgp argument
  #       should be non-zero when an OpenPGP signature file needs to be
  #       downloaded and verified for the downloaded file.
  #
  proc downloadOneFile { language version fileName localFileName usePgp } {
    variable baseUri
    variable downloadUri
    variable quiet

    #
    # NOTE: First, build the full relative file name to download from the
    #       remote package repository.
    #
    set fileName [file join $language $version $fileName]
    set uri [subst $downloadUri]

    if {[isEagle]} then {
      writeFile $localFileName [interp readorgetscriptfile -- "" $uri]
    } else {
      writeFile $localFileName \
          [::PackageRepository::getFileViaHttp $uri 10 stdout $quiet]
    }

    #
    #
    #
    if {$usePgp && [isPgpSignatureFileName $localFileName]} then {
      #
      #
      #
      if {![::PackageRepository::verifyPgpSignature $localFileName]} then {
        error [appendArgs \
            "bad PGP signature \"" $localFileName \"]
      }
    }
  }

  #
  # NOTE: This procedure attempts to download a list of files, optionally
  #       persistening them for subsequent uses by the target language.
  #       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 "8.6" when the language is "tcl"
  #       -OR- the literal string "1.0" when the language is either "eagle"
  #       or "client".  The fileNames argument must be a well-formed list
  #       of file names to download, each one relative to the language and
  #       version-specific directory on the package file server.  The
  #       persistent argument should be non-zero if the downloaded files
  #       should be saved to permanent storage for subsequent use.  The
  #       usePgp argument should be non-zero when an OpenPGP signature file
  #       needs to be downloaded and verified for each downloaded file.  The
  #       useAutoPath argument should be non-zero to modify the auto-path
  #       to include the temporary or persistent directories containing
  #       the downloaded files.
  #
  # <public>
  proc downloadFiles {
          language version fileNames persistent usePgp useAutoPath } {
    global env
    variable baseUri
    variable clientDirectory
    variable downloadUri
    variable persistentDirectory
    variable quiet

    set client false

    if {[string length $language] == 0 || $language eq "eagle"} then {
      if {$version ne "1.0"} then {
        error "unsupported Eagle version"
      }
    } elseif {$language eq "tcl"} then {
      if {$version ne "8.4" && $version ne "8.5" && $version ne "8.6"} then {
        error "unsupported Tcl version"
      }
    } elseif {$language eq "client"} then {
      if {$version ne "1.0"} then {
        error "unsupported client version"
      }

      set client true

    } else {
      error "unsupported language"

    }


    if {[info exists env(PKGD_TEMP)]} then {
      set temporaryRootDirectory $env(PKGD_TEMP)
    } elseif {[info exists env(TEMP)]} then {
      set temporaryRootDirectory $env(TEMP)
    } elseif {[info exists env(TMP)]} then {
      set temporaryRootDirectory $env(TMP)
    } else {
      error "please set PKGD_TEMP (via environment) to temporary directory"
    }

    set temporaryDirectory [file join $temporaryRootDirectory \
        [appendArgs pkgd_ [string trim [pid] -] _ [string trim \
        [clock seconds] -]]]

    if {$persistent} then {
      if {$client} then {
        set downloadRootDirectory $clientDirectory
      } else {
        set downloadRootDirectory $persistentDirectory
      }
    } else {
      set downloadRootDirectory $temporaryDirectory
    }

    set downloadedFileNames [list]

    foreach fileName $fileNames {
      if {[string length $fileName] == 0 || \
          [file pathtype $fileName] ne "relative"} then {
        error [appendArgs \
            "bad file name \"" $fileName "\", not relative"]
      }

      set directoryParts [file split [file dirname $fileName]]

      if {[llength $directoryParts] == 0} then {
        error [appendArgs \
            "bad file name \"" $fileName "\", no directory parts"]
      }

      set downloadDirectory(temporary) [file normalize [eval \
          file join [list $temporaryDirectory] $directoryParts]]

      set downloadDirectory(persistent) [file normalize [eval \
          file join [list $downloadRootDirectory] $directoryParts]]

      set downloadFileName [file normalize [file join \
          $downloadDirectory(temporary) [file tail $fileName]]]

      if {[file exists $downloadFileName]} then {
        error [appendArgs \
            "temporary file name \"" $downloadFileName \
            "\" already exists"]
      }

      file mkdir [file dirname $downloadFileName]


      downloadOneFile $language $version $fileName $downloadFileName $usePgp

      lappend downloadedFileNames $downloadFileName

      if {$usePgp && ![isPgpSignatureFileName $downloadFileName] && \
          ![isHarpyCertificateFileName $downloadFileName]} then {


        downloadOneFile $language $version [appendArgs $fileName .asc] \
            [appendArgs $downloadFileName .asc] $usePgp


        lappend downloadedFileNames [appendArgs $downloadFileName .asc]
      }


    }




    set downloadDirectories [list]


    foreach downloadedFileName $downloadedFileNames {
      if {$persistent} then {













      } else {
        lappend downloadDirectories [file dirname $downloadedFileName]
      }
    }

    set downloadDirectories [lsort -unique $downloadDirectories]

    if {$useAutoPath} then {
      foreach downloadDirectory $downloadDirectories {
        addToAutoPath $language $downloadDirectory
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
  #       one or more of the variable setup in the next step.
  #
  ::PackageRepository::maybeReadSettingsFile [info script]

  #
  # NOTE: Setup the variables, within this namespace, used by this script.
  #
  setupDownloadVars

  #
  # NOTE: Provide the package to the interpreter.
  #
  package provide Eagle.Package.Downloader \
    [expr {[isEagle] ? [info engine PatchLevel] : "1.0"}]
}







|







385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
  #       one or more of the variable setup in the next step.
  #
  ::PackageRepository::maybeReadSettingsFile [info script]

  #
  # NOTE: Setup the variables, within this namespace, used by this script.
  #
  setupDownloadVars [info script]

  #
  # NOTE: Provide the package to the interpreter.
  #
  package provide Eagle.Package.Downloader \
    [expr {[isEagle] ? [info engine PatchLevel] : "1.0"}]
}