summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/scripts/tlshell/tlshell.tcl
blob: a46d1b4bab94627cfd01b4a3d8066f9fedf99a78 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
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
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
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
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
#!/usr/bin/env wish

# Copyright 2017 Siep Kroonenberg

# This file is licensed under the GNU General Public License version 2
# or any later version.

package require Tk

# searchpath:
# windows: most scripts run via [w]runscript, which adjusts the searchpath
# for the current process.
# unix/linux: tlshell.tcl should  be run via a symlink in a directory
# which also contains (a symlink to) kpsewhich.
# This directory will be prepended to the searchpath.
# kpsewhich will disentangle symlinks.

##### general housekeeping #####

# security: disable send
catch {rename send {}}

set ddebug 0
proc do_debug {s} {
  if {$::ddebug} {
    puts stderr $s
    # catch in case the widget concerned has not yet been created
    catch {.lw.dbg.tx configure -state normal; .lw.dbg.tx insert end "$s\n"}
  }
}

proc get_stacktrace {} {
  set level [info level]
  set s ""
  for {set i 1} {$i < $level} {incr i} {
    append s [format "Level %u: %s\n" $i [info level $i]]
  }
  return $s
}

proc maketemp {ext} {
  set fname ""
  foreach i {0 1 2 3 4 5 6 7 8 9} { ; # ten tries
    set fname [file join $::tempsub "[expr int(10000.0*rand())]$ext"]
    if {[file exist $fname]} {set fname ""; continue}
    # create empty file. although we just want a name,
    # we must make sure that it can be created.
    set fid [open $fname w]
    close $fid
    if {! [file exists $fname]} {error "Cannot create temporary file"}
    if {$::tcl_platform(platform) eq "unix"} {
      file attributes $fname -permissions 0600
    }
    break
  }
  if {$fname eq ""} {error "Cannot create temporary file"}
  return $fname
} ; # maketemp

set tempsub "" ; # subdir for temp files, set during initialization

##### tl global status variables #####

set progname [info script]
regexp {^.*[\\/]([^\\/\.]*)(?:\....)?$} $progname dummy progname
set procid [pid]

# package repository
set repo ""

# the stderr and stdout of tlmgr are each read into a list of strings
set err_log {}
set out_log {}

# dict of (local and global) package dicts
set pkgs [dict create]

set have_remote 0 ; # remote packages info loaded
set need_update_self 0
set n_updates 0
set tlshell_updatable 0

##### handling tlmgr via pipe and stderr tempfile #####

set prmpt "tlmgr>"
set busy 0

# TODO:
# replace messagebox with a custom toplevel with a text widget
# in case there is a lot of text
proc err_exit {} {
  do_debug "error exit"
  read_err
  tk_messageBox -message [join $::err_log "\n"] -type ok -icon error
  exit
}

proc read_err {} {
  #do_debug "read_err"
  set len 0
  while 1 {
    set len [chan gets $::err l]
    if {$len >= 0} {
      lappend ::err_log $l
    } else {
      break
    }
  }
}

# about [chan] gets:
# if a second parameter, in this case l, is supplied
# then this variable receives the result, with EOL stripped,
# and the return value is the string length, possibly 0
# EOF is indicated by a return value of -1.

# a caller of run_cmd needs to explicitly invoke 'vwait ::done_waiting'
# if it wants to wait for the command to finish
proc read_line {} {
  incr ::lnum
  set l "" ; # will contain the line to be read
  if {([catch {chan gets $::tlshl l} len] || [chan eof $::tlshl])} {
    do_debug "read_line: failing to read"
    catch {chan close $::tlshl}
    err_exit
    # note. the right way to terminate is terminating the shell
  } elseif {$len >= 0} {
    # do_debug "read: $l"
    if $::ddebug {puts $::flid $l}
    if {[string first $::prmpt $l] == 0} {
      # prompt line: done with command
      enable_widgets 1 ; # this may have to be redone later
      read_err
      if {$::pipe_cb ne ""} {
        do_debug "$::lnum: prompt found, $l"
        $::pipe_cb "finish"
      }
      set ::done_waiting 1
    } else {
      lappend ::out_log $l
      if {$::pipe_cb ne ""} {$::pipe_cb "line" "$l"}
    }
  }
} ; # read_line

##### displaying stuff in GUI #####

## stderr ##

# copy error strings to error log page, which is sent to top.
# This by itself does not map the logs toplevel .lw
proc show_err_log {} {
  #do_debug "show_err_log"
  .lw.err.tx configure -state normal
  .lw.err.tx delete 1.0 end
  if {[llength $::err_log] > 0} {
    foreach l $::err_log {.lw.err.tx insert end "$l\n"}
    .lw.err.tx yview moveto 1
    .lw.logs select .lw.err
  }
  if {$::tcl_platform(os) ne "Darwin"} {
    # os x: text widget disabled => no selection possible
    .lw.err.tx configure -state disabled
  }
} ; # show_err_log

##### callbacks for file events of tlmgr pipe ::tlshl (names *_cb) #####

# callback for reading tlmgr pipe
set pipe_cb ""
set lnum -1

## template for pipe callback:
#proc template_cb {mode {l ""}} {
#  if {$mode eq "line"} {
#    # do something
#  } elseif {$mode eq "init"} {
#    # do something
#  } elseif {$mode eq "finish"} {
#    # do something BUT DO NOT TRIGGER ANOTHER EVENT LOOP
#  } else {
#    lappend ::err_log "Illegal call of whatever_cb"
#    err_exit
#  }
#}

proc log_widget_cb {mode {l ""}} {
  if {$mode eq "line"} {
    .lw.log.tx configure -state normal
    .lw.log.tx insert end "$l\n"
  } elseif {$mode eq "init"} {
    .lw.log.tx configure -state normal
    .lw.log.tx delete 1.0 end
    .lw.status configure -text "Running"
    .lw.close configure -state disabled
    wm state .lw normal
  } elseif {$mode eq "finish"} {
    .lw.log.tx yview moveto 1
    .lw.logs select .lw.log
    # error log on top if it contains anything
    show_err_log
    if {$::tcl_platform(os) ne "Darwin"} {
      .lw.log.tx configure -state disabled
    }
    .lw.status configure -text ""
    .lw.close configure -state !disabled
  } else {
    lappend ::err_log "Illegal call of log_widget_cb"
    err_exit
  }
} ; # log_widget_cb

##### running tlmgr commands #####

## general and various:

proc run_cmd {cmd {cb ""}} {
  set ::pipe_cb $cb
  do_debug "run_cmd \"$cmd\""
  if $::ddebug {puts $::flid "\n$cmd"}
  .topf.lcmd configure -text $cmd
  enable_widgets 0
  set ::out_log {}
  set ::err_log {}
  set ::lnum 0
  unset -nocomplain ::done_waiting
  if {$::pipe_cb ne ""} {$::pipe_cb "init"}
  chan puts $::tlshl $cmd
  chan flush $::tlshl
}

proc run_cmd_waiting {cmd} {
  run_cmd $cmd ; # "waiting_cb"
  vwait ::done_waiting
}

proc run_entry {} {
  # TODO: some validation of $cmd
  do_debug "run_entry"
  set cmd [.ent.e get]
  if {$cmd eq ""} return
  do_debug $cmd
  .ent.e delete 0 end
  #.ent.prv configure -text $cmd
  run_cmd $cmd log_widget_cb
}

proc get_repo {} {
  run_cmd_waiting "option repository"
  set re {repository\t(.*)$}
  foreach l $::out_log {
    if [regexp $re $l m ::repo] break
  }
} ; # get_repo

## package-related:

proc package_popup {itm} {
  run_cmd_waiting "info $itm"
  tk_messageBox -message [join $::out_log "\n"]
}

proc check_tlmgr_updatable {} {
  run_cmd_waiting "update --self --list"
  foreach l $::out_log {
    if [regexp {^total-bytes[ \t]+([0-9]+)$} $l m b] {
      do_debug "matches, $b"
      set ::need_update_self [expr {$b > 0} ? 1 : 0]
      return
    }
  }
  do_debug "check_tlmgr_uptodate: should not get here"
} ; # check_tlmgr_uptodate

proc update_globals {} {
  if {! $::have_remote} return
  set ::n_updates 0
  foreach nm [dict keys $::pkgs] {
    if [is_updatable $nm] {incr ::n_updates}
  }
  check_tlmgr_updatable
  set ::tlshell_updatable [is_updatable tlshell]
}

# get fresh package list
# some local packages may not be available online.
# to test, create local dual-platform installation from dvd, try to update
# from more recent linux-only installation

# local: start from scratch
proc get_packages_info_local {} {
  foreach nm [dict keys $::pkgs] {
    dict unset ::pkgs $nm
  }
  set ::have_remote 0
  set ::need_update_self 0
  set ::updatable 0
  set ::tlshell_updatable 0

  run_cmd_waiting \
      "info --only-installed --data name,localrev,category,shortdesc"
  set re {^([^,]+),([0-9]+),([^,]*),(.*)$}
  foreach l $::out_log {
    if [regexp $re $l m nm lrev catg pdescr] {
      # double-quotes: remove outer, unescape inner
      if {[string index $pdescr 0] eq "\""} {
        set pdescr [string range $pdescr 1 end-1]
      }
      set pdescr [regsub -all "\\\"" $pdescr "\""]
      dict set ::pkgs $nm \
          [list "localrev" $lrev "remoterev" 0 \
               "category" $catg shortdesc $pdescr]
    }
  }
} ; # get_packages_info_local

# remote: preserve information on installed packages
proc get_packages_info_remote {} {
  # remove non-local database entries
  foreach k [dict keys $::pkgs] {
    if {! [dict get $::pkgs $k localrev]} {
      dict unset ::pkgs $k
    }
  }
  set ::need_update_self 0
  set ::updatable 0
  set ::tlshell_updatable 0

  run_cmd_waiting "info --data name,localrev,remoterev,category,shortdesc"
  set re {^([^,]+),([0-9]+),([0-9]+),([^,]*),(.*)$}
  foreach l $::out_log {
    if [regexp $re $l m nm lrev rrev catg pdescr] {
      # double-quotes in short description: remove outer, unescape inner
      if {[string index $pdescr 0] eq "\""} {
        set pdescr [string range $pdescr 1 end-1]
      }
      set pdescr [regsub -all "\\\"" $pdescr "\""]
      if [catch {dict get $::pkgs $nm} pk] {
        # package entry does not exist
        dict set ::pkgs $nm [dict create  "localrev" 0 \
                  "remoterev" $rrev "category" $catg shortdesc $pdescr]
      } else {
        dict set ::pkgs $nm "remoterev" $rrev
        dict set ::pkgs $nm "category" $catg
        dict set ::pkgs $nm "shortdesc" $pdescr
      }
    }
  }
  set ::have_remote 1
  update_globals
} ; # get_packages_info_remote

## update ::pkgs after installing packages without going online.
## this should be considered a shortcut version of get_packages_info_xxx,
## and should similarly take care of the globals; see above
proc update_local_revnumbers {} {
  run_cmd_waiting "info --only-installed --data name,localrev"
  set re {^([^,]+),([0-9]+)$}
  foreach nm [dict keys $::pkgs] {
    dict set ::pkgs $nm "localrev" 0
  }
  foreach l $::out_log {
    if [regexp $re $l m nm lr] {
      dict set ::pkgs $nm "localrev" $lr
    }
  }
  update_globals
} ; # update_local_revnumbers

proc update_self {} {
  if {! $::need_update_self} {
    tk_messageBox -message "Nothing to do!"
    return
  }
  run_cmd "update --self" log_widget_cb
  vwait ::done_waiting
  # tlmgr restarts itself automatically, reload remote
  get_packages_info_remote
  set ::sel_opt "inst"
  display_packages_info is_local
} ; # update_self

proc update_all {} {
  if $::need_update_self {
    tk_messageBox -message "Update self first!"
    return
  } elseif {! $::n_updates} {
    tk_messageBox -message "Nothing to do!"
    return
  }
  run_cmd "update --all" log_widget_cb
  vwait ::done_waiting
  #wm withdraw .lw
  update_local_revnumbers
  set ::sel_opt "inst"
  display_packages_info is_local
} ; # update_all

##### building GUI #####

# dummy widgets for vertical spacing within $w
set idummy -1
proc spacing {w} {
  incr ::idummy
  pack [label $w.$::idummy -text " "]
}

proc pgrid {wdg args} { ; # grid command with padding
  set l [list grid $wdg -padx 3 -pady 3 -sticky w]
  foreach v $args {lappend l $v}
  eval [join $l " "]
}

proc ppack {wdg args} { ; # pack command with padding
  set l [list pack $wdg -padx 3 -pady 3]
  foreach v $args {lappend l $v}
  eval [join $l " "]
}

proc make_widgets {} {

  wm title . "$::progname $::procid"

  # width of '0', as a rough estimate of average character width
  set cw [font measure TkTextFont "0"]

  # various info
  frame .topf

  pgrid [label .topf.llrepo -text Repository -anchor w] -row 0 -column 0
  pgrid [label .topf.lrepo -textvariable ::repo] -row 0 -column 1

  pgrid [label .topf.lluptodate -text "TL Manager up to date?" -anchor w] \
      -row 1 -column 0
  label .topf.luptodate -anchor w
  pgrid .topf.luptodate -row 1 -column 1

  pgrid [label .topf.llcmd -anchor w -text "Last command: "] \
      -row 2 -column 0
  pgrid [label .topf.lcmd -anchor w] -row 2 -column 1
  pack .topf -side top -anchor w

  # some buttons
  spacing .
  frame .butf
  ttk::button .butf.all -text "Update all" -command update_all
  ppack .butf.all -side left
  .butf.all configure -state disabled
  ttk::button .butf.self -text "Update self" -command update_self
  .butf.self configure -state disabled
  ppack .butf.self -side left
  pack .butf -side top -anchor w

  # command entry
  spacing .
  frame .ent
  ppack [label .ent.l -text "Type command:"] -side left
  ppack [entry .ent.e -width 40] -side left -padx 3
  ppack [ttk::button .ent.b -text Go -command run_entry] -side left
  bind .ent.e <Return> run_entry
  pack .ent -fill x -side top -expand 1

  spacing .

  # controlling package list
  ttk::frame .fp_ctrl
  ppack [ttk::label .fp_ctrl.pkgl -text "Show packages:"] -side left
  ttk::radiobutton .fp_ctrl.inst -text Installed -value inst \
      -variable ::sel_opt -command show_packages_info
  ttk::radiobutton .fp_ctrl.all -text All -value all \
      -variable ::sel_opt -command show_packages_info
  ttk::radiobutton .fp_ctrl.upd -text Updatable -value upd \
      -variable ::sel_opt -command show_packages_info
  ttk::radiobutton .fp_ctrl.coll -text Collections -value coll \
      -variable ::sel_opt -command show_packages_info
  ppack .fp_ctrl.inst -side left
  ppack .fp_ctrl.all -side left
  ppack .fp_ctrl.upd -side left
  ppack .fp_ctrl.coll -side left
  set ::sel_opt inst
  pack .fp_ctrl -side top -fill x

  # packages list (tlmgrgui uses an old HList widget)
  frame .fpkg
  ttk::treeview .pkglist -columns \
      {mk name localrev remoterev shortdesc} \
      -show headings -height 8 -selectmode extended \
      -xscrollcommand {.pkhsb set} -yscrollcommand {.pkvsb set}
  foreach \
      col {mk name localrev remoterev shortdesc} \
      nm {"" Name "Local Rev." "Remote Rev." Description} {
    .pkglist heading $col -text $nm -anchor w
  }
  .pkglist column mk -width [expr $cw * 3]
  .pkglist column name -width [expr $cw * 25]
  .pkglist column localrev -width [expr $cw * 12]
  .pkglist column remoterev -width [expr $cw * 12]
  .pkglist column shortdesc -width [expr $cw * 50]

  ttk::scrollbar .pkhsb -orient horizontal -command {.pkglist xview}
  ttk::scrollbar .pkvsb -orient vertical -command {.pkglist yview}
  pgrid .pkglist -in .fpkg -row 0 -column 0 -sticky news
  grid .pkvsb -in .fpkg -row 0 -column 1 -sticky ns
  grid .pkhsb -in .fpkg -row 1 -column 0 -sticky ew
  grid columnconfigure .fpkg 0 -weight 1
  pack .fpkg -side top -expand 1

  bind .pkglist <space> {toggle_marked [.pkglist focus] "#1"}
  bind .pkglist <Return> {toggle_marked [.pkglist focus] "#1"}
  bind .pkglist <ButtonRelease-1> {toggle_marked \
      [.pkglist identify item %x %y] [.pkglist identify column %x %y]}
  bind .pkglist <ButtonRelease-2> \
      {popup_focused [.pkglist identify item %x %y]}
  bind .pkglist <ButtonRelease-2> \
      {popup_focused [.pkglist identify item %x %y]}
  bind .pkglist <ButtonRelease-3> \
      {popup_focused [.pkglist identify item %x %y]}
  bind .pkglist <Control-ButtonRelease-1> \
      {popup_focused [.pkglist identify item %x %y]}

  # bottom of main window
  frame .endbuttons
  label .busy -textvariable ::busy -font TkHeadingFont -anchor w
  ppack .busy -in .endbuttons -side left
  ppack [ttk::button .q -text Quit -command exit] \
      -in .endbuttons -side right
  ppack [ttk::button .r -text "Restart self" -command restart_self] \
      -in .endbuttons -side right
  ppack [ttk::button .t -text "Restart tlmgr" -command restart_tlmgr] \
      -in .endbuttons -side right
  ttk::button .showlogs -text "Show logs" -command {wm state .lw normal}
  ppack .showlogs -in .endbuttons -side right
  pack .endbuttons -side bottom -fill x -expand 1

  # log displays: new toplevel
  toplevel .lw
  frame .lw.log
  pack [ttk::scrollbar .lw.log.scroll -command ".lw.log.tx yview"] \
      -side right -fill y
  ppack [text .lw.log.tx -height 10 -bd 2 -relief groove -wrap word \
      -yscrollcommand ".lw.log.scroll set"] \
      -expand 1 -fill both
  .lw.log.tx yview moveto 1

  frame .lw.err
  pack [ttk::scrollbar .lw.err.scroll -command ".lw.err.tx yview"] \
      -side right -fill y
  ppack [text .lw.err.tx -height 10 -bd 2 -relief groove -wrap word \
      -yscrollcommand ".lw.err.scroll set"] \
      -expand 1 -fill both
  .lw.err.tx yview moveto 1

  if $::ddebug {
    frame .lw.dbg
    pack [ttk::scrollbar .lw.dbg.scroll -command ".lw.dbg.tx yview"] \
        -side right -fill y
    ppack [text .lw.dbg.tx -height 10 -bd 2 -relief groove -wrap word \
        -yscrollcommand ".lw.dbg.scroll set"] \
        -expand 1 -fill both
    .lw.dbg.tx yview moveto 1
  }

  ttk::notebook .lw.logs
  .lw.logs add .lw.log -text "Output"
  .lw.logs add .lw.err -text "Errors"
  if $::ddebug {
    .lw.logs add .lw.dbg -text "Debug"
    raise .lw.dbg .lw.logs
  }
  raise .lw.err .lw.logs
  raise .lw.log .lw.logs
  pack .lw.logs -in .lw -side top -fill both -expand 1

  frame .lw.bottom
  ttk::button .lw.close -text close -command {wm withdraw .lw}
  ppack .lw.close -in .lw.bottom -side right -anchor e
  ppack [label .lw.status -anchor w] -in .lw.bottom -side left
  pack .lw.bottom -side top -expand 1 -fill x

  wm withdraw .lw
} ; # make_widgets

proc enable_update_buttons {yesno} {
  if {! $yesno || ! $::n_updates} {
    .butf.all configure -state disabled
    .butf.self configure -state disabled
  } elseif $::need_update_self {
    .butf.all configure -state disabled
    .butf.self configure -state !disabled
  } else {
    .butf.all configure -state !disabled
    .butf.self configure -state disabled
  }
}

proc enable_widgets {yesno} {
  if $yesno {
    set st normal
    set ttk_st !disabled
    set ::busy "IDLE"
  } else {
    set st disabled
    set ttk_st disabled
    set ::busy "BUSY"
  }

  enable_update_buttons $yesno

  # command entry
  .ent.b configure -state $st
  .ent.e configure -state $st

  # final buttons
  .q configure -state $ttk_st
  .r configure -state $ttk_st
  .t configure -state $ttk_st
  .showlogs configure -state $ttk_st

  .lw.close configure -state $ttk_st
  if $yesno {
    .lw.status configure -text "Done"
  } else {
    .lw.status configure -text "Please wait..."
  }
} ; # enable_widgets

## single-package info ##

proc popup_focused {itm} {
  run_cmd_waiting "info $itm"
  tk_messageBox -message [join $::out_log "\n"]
}

# filter procs; parameter is package name

proc is_local {p} {
  return [dict get $::pkgs $p localrev]
}

proc is_collection {p} {
  set c [dict get $::pkgs $p "category"]
  return [expr \"$c\" eq \"Collection\"]
}

proc is_updatable {p} {
  #do_debug "Is $p updatable"
  if [catch {dict get $::pkgs $p} pk] {
    return 0
  } else {
    if [catch {dict get $::pkgs $p localrev} lr] {set lr 0}
    if [catch {dict get $::pkgs $p remoterev} rr] {set rr 0}
    # do_debug "Revisions $p are local $lr and remote $rr"
    return [expr $lr > 0 && $rr > 0 && $rr > $lr]
  }
}

# display packages: always display both local and remote revision columns.
# ::pkgs should already be up to date

# manual selection tags: unicode chars as tags are resolution-independent.
# ATM we only display tags but do not use them otherwise.
set mrk [format %c 0x25a3] ; # 'white square containing black small square'
set nomrk [format %c 0x25a1] ; # 'white square'

# sel_opt: which packages to show from package list;
# after updates it will always be set to "inst", after installations "all"
set sel_opt inst

proc toggle_marked {itm cl} {
  # if toggle_marked is triggered by a mouse click
  # then it should do nothing unless it was a click in column #1
  if {$cl ne "#1"} {
    return
  }
  if [.pkglist tag has marked $itm] {
    .pkglist tag remove marked $itm
    .pkglist set $itm mk $::nomrk
  } else {
    .pkglist tag add marked $itm
    .pkglist set $itm mk $::mrk
  }
} ; # toggle_marked

proc display_packages_info {{filt ""}} {
  do_debug "display_packages_info with remote $::have_remote and filt >$filt<"
  .pkglist delete [.pkglist children {}]

  foreach nm [lsort [dict keys $::pkgs]] {
    if {$filt eq "" || [$filt $nm]} {
      # collect data to be displayed for $nm in vl
      set vl [list $::nomrk $nm]
      foreach k {localrev remoterev shortdesc} {
        set vv [dict get $::pkgs $nm $k]
        if {$vv eq "0" || $vv == 0} {set vv ""}
        lappend vl $vv
      }
      .pkglist insert {} end -id $nm -values $vl
    } ; # else do not display
  }
  # also update displayed status info
  if {$::have_remote && $::need_update_self} {
    .topf.luptodate configure -text "Needs updating"
  } elseif $::have_remote {
    .topf.luptodate configure -text "Up to date"
  } else {
    .topf.luptodate configure -text "Unknown"
  }
  # ... and status of update buttons
  enable_update_buttons 1
} ; # display_packages_info

# selection tags in package list
# 1. selections themselves get lost too easily
# 2. the -image option for ttk::treeview tags does not look right
# Therefore a do-it-yourself implementation with column #1 reserved for
# a marker, package name in column #2, and column #0 not displayed at all.
# the marker could have been prefixed to the package name in column #0,
# but I think a separate marker column is a cleaner solution.

# display packages, invoking get_packages_info if necessary.
# called at end of initialization and when a selection radio button
# is clicked. Otherwise, get_packages_info_... and display_packages_info
# are invoked separately.
proc show_packages_info {} {
  switch $::sel_opt {
    "inst" {
      if {! [llength [dict keys $::pkgs]]} {get_packages_info_local}
      set filt "is_local"
    }
    "all" {
      if {! $::have_remote} {get_packages_info_remote}
      set filt ""
    }
    "upd" {
      if {! $::have_remote} {get_packages_info_remote}
      set filt "is_updatable"
    }
    "coll" {
      if {! $::have_remote} {get_packages_info _remote}
      set filt "is_collection"
    }
  }
  display_packages_info $filt
} ; # show_packages_info

##### (re)initialization procs #####

proc start_tlmgr {} {
  # start the TeX Live Manager shell interface
  # capture stdout into the pipe, stderr into a temp file
  # below, vwait ::done_waiting forces tlshell
  # to process initial tlmgr output before continuing
  unset -nocomplain ::done_waiting
  set ::tlshl [open "|tlmgr --machine-readable shell 2>>$::err_file" w+]
  set ::err [open $::err_file r]
  chan configure $::tlshl -buffering line -blocking 0
  chan event $::tlshl readable read_line
  vwait ::done_waiting
  #get_repo
  #if {$::argc && [lindex $::argv 0] eq "remote"} {
  #  show_packages_info 0 is_local
  #} else {
  #  show_packages_info 1 is_local
  #}
}

proc restart_tlmgr {} {
  catch {chan close $::tlshl}
  catch {chan close $::err}
  start_tlmgr
  get_packages_info_remote
  display_packages_info
}

proc restart_self {{param ""}} {
  do_debug "trying to restart"
  if {$::progname eq ""} {
    tk_messageBox -message "progname not found; not restarting"
    return
  }
  catch {chan close $::tlshl}
  catch {chan close $::err}
  exec $::progname &
  # on windows, it may take several seconds before
  # the old tlshell disappears.
  # oh well, windows is still windows....
  exit
}

proc initialize {} {
  # prepend TL to process searchpath (not needed on windows)
  if {$::tcl_platform(platform) ne "windows"} {
    set texbin [file dirname [info script]]
    set savedir [pwd]
    cd $texbin
    set texbin [pwd]
    cd $savedir
    # prepend texbin to PATH, unless it is already the _first_
    # path component
    if {$::tcl_platform(platform) eq "unix"} {
      set pathsep ":"
    } else {
      set pathsep ";"
    }
    set dirs [split $::env(PATH) $pathsep]
    if {[lindex $dirs 0] ne $texbin} {
      set ::env(PATH) "$texbin$pathsep$::env(PATH)"
    }
  }
  # directory for temp files
  set attemptdirs {}
  foreach tmp {TMPDIR TEMP TMP} {
    if {[lsearch [array names ::env] $tmp] >= 0} {
      lappend attemptdirs $::env($tmp)
    }
  }
  if {$::tcl_platform(os) eq "Darwin"} {
    lappend attemptdirs "/private/tmp"
  }
  if {$::tcl_platform(platform) eq "unix"} {
    lappend attemptdirs "/tmp"
  }
  lappend attemptdirs [pwd]
  set ::tempsub ""
  foreach tmp $attemptdirs {
    if {$::tcl_platform(platform) eq "windows"} {
      regsub -all {\\} $tmp {/} tmp
    }
    if {[file isdirectory $tmp]} {
      # no real point in randomizing directory name itself
      if {$::tcl_platform(platform) eq "unix"} {
        set ::tempsub [file join $tmp $::env(USER)]
      } else {
        set ::tempsub [file join $tmp $::env(USERNAME)]
      }
      append ::tempsub "-tlshell"
      if {! [catch {file mkdir $::tempsub}]} {break} ;# success
    }
  }

  if {$::tempsub eq "" || [file isdirectory $::tempsub] == 0} {
    error "Cannot create directory for temporary files"
  }
  # temp file for stderr
  set ::err_file [maketemp ".err_tlshl"]

  # logfile
  set fname [file join $::tempsub \
      [clock format [clock seconds] -format {%H:%M}]]
  set ::flid [open $fname w]

  make_widgets

  start_tlmgr
  get_repo
  set ::sel_opt "inst"
  show_packages_info
}; # initialize

initialize