New client with better Explain support and nice icons.
[ir-tcl-moved-to-github.git] / client2 / explain.tcl
1 proc debug-window {} {
2         set w .debug-window
3     toplevel $w
4
5     wm title $w "Debug Window" 
6     
7     top-down-window $w
8         scrollbar $w.top.s -command [list $w.top.t yview]
9     text $w.top.t -width 60 -height 10 -wrap word -relief flat -borderwidth 0 \
10         -font fixed -yscroll [list $w.top.s set]
11     pack $w.top.s -side right -fill y
12     pack $w.top.t -expand yes -fill both -expand y
13 }
14 debug-window
15
16 #Procedure get-attributeDetails
17 #If the target supports explain the Attribute Details are extracted here.
18 #The number 1.2.840.10003.3.1 is Bib1 and 1.2.840.10003.3.2 is Gils.
19 proc get-attributeDetails {target base} {
20         global profile
21         set index 1
22         if {[info commands z39.attributeDetails] == "z39.attributeDetails"} {
23                 foreach arrayname [array names profile] {
24                         if {[string first $target,AttributeDetails, $arrayname ] != -1} {
25                                 unset profile($arrayname)
26                         }
27                 }
28                 .debug-window.top.t insert end "Explain\n"
29                 while {![catch {set rec [z39.attributeDetails getExplain $index attributeDetails]}]} {
30                         set db [lindex [lindex $rec 1] 1]
31                         foreach tagset [lrange [lindex $rec 2] 1 end] {
32                                 if {[lindex [lindex $tagset 0] 1] == "1.2.840.10003.3.1"} {
33                                         foreach attributeType [lindex $tagset 1] {
34                                                 if {[lindex [lindex $attributeType 0] 1] == 1} {
35                                                         foreach attributeValues [lrange [lindex $attributeType 2] 1 end] {
36                                                                 lappend profile($target,AttributeDetails,$db,Bib1Use) [lindex [lindex [lindex $attributeValues 0] 1] 1]
37                                                         }
38                                                 }                                               
39                                         }
40                                 }
41                         }       
42                         incr index
43                 }
44         } else {
45                 .debug-window.top.t insert end "Ingen explain\n"
46         }
47 }
48
49 #Procedure change-queryInfo {target base}
50 #The queryInfo array is set according to the attributes obtained by explain.
51 proc change-queryInfo {target base} {
52         global queryInfo profile bib1
53         foreach tag $profile($target,AttributeDetails,$base,Bib1Use) {
54                 if {$tag < 1037} {
55                         lappend tempList [list $bib1($tag) 1=$tag]
56                 }
57         }
58         set queryInfo [lreplace $queryInfo 2 2 $tempList]
59 }
60
61
62 # Procedure explain-search
63 #  Issue search request with explain-attribute set and specific
64 #  category.
65 proc explain-search-request {target zz category finish response fresponse} {
66     z39 callback [list explain-search-response $target $zz $category $finish \
67             $response $fresponse]
68     ir-set $zz z39
69     $zz databaseNames IR-Explain-1
70     $zz preferredRecordSyntax explain
71     $zz search "@attrset exp1 @attr 1=1 @attr 2=3 @attr 3=3 @attr 4=3 $category"
72 }
73
74 # Procedure explain-search-response
75 #  Deal with search response.
76 proc explain-search-response {target zz category finish response fresponse} {
77     global cancelFlag
78
79     apduDump
80     if {$cancelFlag} {
81         close-target
82         return
83     }
84     set status [$zz responseStatus]
85     if {![string compare [lindex $status 0] NSD]} {
86         $fresponse $target $zz $category $finish
87         return
88     }
89     set cnt [$zz resultCount]
90     if {$cnt <= 0} {
91         $fresponse $target $zz $category $finish
92         return
93     }
94     set rr [$zz numberOfRecordsReturned]
95     set cnt [expr $cnt - $rr]
96     if {$cnt <= 0} {
97         explain-present-response $target $zz $category $finish $response $fresponse
98         return
99     }
100     z39 callback [list explain-present-response $target $zz $category $finish \
101                 $response $fresponse]
102     incr rr
103     $zz present $rr $cnt
104 }
105
106 # Procedure explain-present-response
107 #  Deal with explain present response.
108 proc explain-present-response {target zz category finish response fresponse} {
109     global cancelFlag
110
111     apduDump
112     if {$cancelFlag} {
113         close-target
114         return
115     }
116     set cnt [$zz resultCount]
117     ir-log debug "cnt=$cnt"
118     for {set i 1} {$i <= $cnt} {incr i} {
119                 if {[string compare [$zz type $i] DB]} {
120                     $fresponse $target $zz $category $finish
121                     return
122                 }
123                 if {[string compare [$zz recordType $i] Explain]} {
124                     $fresponse $target $zz $category $finish
125                     return
126                 }
127     }
128     $response $target $zz $category $finish
129 }
130
131
132 # Procedure explain-check-0
133 #  Phase 0: CategoryList
134 proc explain-check-0 {target zz category finish} {
135     show-status Explaining 1 0
136     show-message CategoryList
137     explain-search-request $target z39.categoryList CategoryList $finish \
138                 explain-check-5 explain-check-fail
139 }
140
141 # Procedure explain-check-5
142 #  TargetInfo
143 proc explain-check-5 {target zz category finish} {
144     show-status Explaining 1 0
145     show-message TargetInfo
146
147     explain-search-request $target z39.targetInfo TargetInfo $finish \
148                 explain-check-10 explain-check-fail
149 }
150
151 # Procedure explain-check-10
152 #  DatabaseInfo
153 proc explain-check-10 {target zz category finish} {
154     show-status Explaining 1 0
155     show-message DatabaseInfo
156     explain-search-request $target z39.databaseInfo DatabaseInfo \
157                 $finish explain-check-15 explain-check-fail
158 }
159
160 # Procedure explain-check-15
161 #  AttributeDetails
162 proc explain-check-15 {target zz category finish} {
163     show-status Explaining 1 0
164     show-message AttributeDetails
165     explain-search-request $target z39.attributeDetails AttributeDetails \
166                 $finish explain-check-ok explain-check-ok
167 }
168
169 # Proedure explain-check-fail
170 #  Deal with explain check failure - call finish handler
171 proc explain-check-fail {target zz category finish} {
172     eval $finish [list $target]
173 }
174
175 proc prettyDump {x} {
176     foreach y $x {
177                 prettyDumpR $y 0
178     }
179 }
180
181 proc prettyDumpR {x ind} {
182     for {set i 0} {$i < $ind} {incr i} {
183                 puts -nonewline " "
184     }
185     set i 0
186     foreach y $x {
187                 if {$i == 0} {
188                     if {![string compare $y text]} {
189                                 puts $x
190                                 return
191                     }
192                     puts $y
193                 } else {
194                     prettyDumpR $y [expr $ind + 2]
195                 }
196                 incr i
197     }
198 }
199
200 # Procedure explain-check-ok
201 proc explain-check-ok {target zz category finish} {
202     global profile settingsChanged
203
204     puts ""
205     puts ""
206     puts ""
207     puts ""
208     set crec [z39.categoryList getExplain 1 categoryList]
209     puts "--- categoryList"
210     puts $crec
211
212     set rec [z39.targetInfo getExplain 1]
213
214     set trec [z39.targetInfo getExplain 1 targetInfo]
215     puts "--- targetInfo"
216     puts $rec
217
218     set no 1
219     while {1} {
220         if {
221                 [catch {set rec [z39.databaseInfo getExplain $no databaseInfo]}]
222         } break
223         puts "--- databaseInfo $no"
224                 puts $rec
225         lappend dbRecs $rec
226         set db [lindex [lindex $rec 1] 1]
227                 if {![string length $db]} break
228         lappend dbList $db
229         incr no
230     }
231     if {[info exists dbList]} {
232         set profile($target,databases) $dbList
233     }
234     cascade-target-list
235
236     set no 1
237     while {1} {
238         if {
239                 [catch {set rec [z39.attributeDetails getExplain $no attributeDetails]}]
240                 } break
241         puts "--- attributeDetails $no"
242                 puts $rec
243         incr no
244     }
245     set data [lindex [lindex [lindex [lindex [lindex $trec 12] 1] 1] 1] 1]
246     if {[string length $data]} {
247         set profile($target,descripton) $data
248     }
249
250     set profile($target,namedResultSets) [lindex [lindex $trec 4] 1]
251     set profile($target,timeLastExplain) [clock seconds]
252     set profile($target,targetInfoName) [lindex [lindex $trec 1] 1]
253     set profile($target,recentNews) [lindex [lindex $trec 2] 1]
254     set profile($target,maxResultSets) [lindex [lindex $trec 6] 1]
255     set profile($target,maxResultSize) [lindex [lindex $trec 7] 1]
256     set profile($target,maxTerms) [lindex [lindex $trec 8] 1]
257     set profile($target,multipleDatabases) [lindex [lindex $trec 5] 1]
258     set profile($target,welcomeMessage) \
259                 [lindex [lindex [lindex [lindex [lindex $trec 10] 1] 1] 1] 1]
260     
261     set settingsChanged 1
262
263     eval $finish [list $target]
264 }
265
266 # Procedure explain-refresh
267 proc explain-refresh {target finish} {
268     explain-check-0 $target {} {} $finish
269 }
270
271 # Procedure explain-check
272 #   Checks target for explain database.
273 #   Evals "$finish $target" on finish.
274 proc explain-check {target finish} {
275     global profile
276     
277     set refresh 0
278     set time [clock seconds]
279     set etime $profile($target,timeLastExplain)
280     if {[string length $etime]} {
281         # Check last explain. If 1 day since last explain do explain egain.
282         # 1 day = 86400
283         if {$time > [expr 0 + $etime]} {
284                 set refresh 1
285         }
286     } else {
287         # Check last init. If never init or 1 week after do explain anyway.
288         # 1 week = 604800
289         set etime $profile($target,timeLastInit)
290         if {![string length $etime]} {
291                 set refresh 1
292         } elseif {$time > [expr 604800 + $etime]} {
293                 set refresh 1
294         }
295     }
296     if {$refresh} {
297                 explain-refresh $target $finish
298     } else {
299                 eval $finish [list $target]
300     }
301 }