review.el 71 KB
Newer Older
David Byers's avatar
David Byers committed
1
;;;;; -*-coding: iso-8859-1;-*-
Linus Tolke's avatar
Linus Tolke committed
2
3
;;;;;
;;;;; $Id$
4
;;;;; Copyright (C) 1991-2002  Lysator Academic Computer Association.
Linus Tolke's avatar
Linus Tolke committed
5
;;;;;
6
;;;;; This file is part of the LysKOM Emacs LISP client.
Linus Tolke's avatar
Linus Tolke committed
7
8
9
;;;;; 
;;;;; LysKOM is free software; you can redistribute it and/or modify it
;;;;; under the terms of the GNU General Public License as published by 
10
;;;;; the Free Software Foundation; either version 2, or (at your option) 
Linus Tolke's avatar
Linus Tolke committed
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
;;;;; any later version.
;;;;; 
;;;;; LysKOM is distributed in the hope that it will be useful, but WITHOUT
;;;;; ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
;;;;; FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
;;;;; for more details.
;;;;; 
;;;;; You should have received a copy of the GNU General Public License
;;;;; along with LysKOM; see the file COPYING.  If not, write to
;;;;; Lysator, c/o ISY, Linkoping University, S-581 83 Linkoping, SWEDEN,
;;;;; or the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, 
;;;;; MA 02139, USA.
;;;;;
;;;;; Please mail bug reports to bug-lyskom@lysator.liu.se. 
;;;;;
Per Cederqvist's avatar
.    
Per Cederqvist committed
26
27
28
29
30
31
32
33
34
35
36
37
38
;;;; ================================================================
;;;; ================================================================
;;;;
;;;; File: review.el
;;;;
;;;; This file contains functions to review articles in different ways.
;;;; Both the review commands themselves, the functions called by them
;;;; and the underlying functions are here.
;;;;
;;;; Most, if not all, of these functions are written by Linus Tolke.
;;;;


39
40
41
42
(setq lyskom-clientversion-long 
      (concat lyskom-clientversion-long
	      "$Id$\n"))

43
44
45
(eval-when-compile
  (require 'lyskom-command "command"))

David Byers's avatar
David Byers committed
46
47
48
49
(put 'lyskom-cant-review-error 'error-conditions '(error lyskom-error lyskom-review-error))
(put 'lyskom-cant-review-error 'error-message "Can't review")
(put 'lyskom-review-error 'error-condiions '(error lyskom-error))
(put 'lyskom-review-error 'error-message "Review error")
50

51

David Byers's avatar
David Byers committed
52
53
54
;;; ======================================================================
;;; State-saving variables
;;;
55
;;; All these need to be buffer-local
David Byers's avatar
David Byers committed
56

57
58
59
60
61
62
63
64
65
66
67
(def-kom-var lyskom-last-review-by nil local)
(def-kom-var lyskom-last-review-to nil local)
(def-kom-var lyskom-last-review-num nil local)
(def-kom-var lyskom-last-review-pmark nil local)
(def-kom-var lyskom-last-review-cmark nil local)
(def-kom-var lyskom-last-review-saved-result-list nil local)
(def-kom-var lyskom-last-review-saved-by-list nil local)
(def-kom-var lyskom-last-review-saved-to-list nil local)
(def-kom-var lyskom-last-review-saved-result-size 0 local)
(def-kom-var lyskom-last-review-saved-smallest nil local)
(def-kom-var lyskom-last-review-saved-largest nil local)
David Byers's avatar
   
David Byers committed
68
(def-kom-var lyskom-last-review-comments nil local)
69
(def-kom-var lyskom-have-review nil local)
David Byers's avatar
David Byers committed
70

71
72
73
74
75
76
77
78
79
80
81
82
(def-kom-var lyskom-last-unread-by nil local)
(def-kom-var lyskom-last-unread-to nil local)
(def-kom-var lyskom-last-unread-num nil local)
(def-kom-var lyskom-last-unread-pmark nil local)
(def-kom-var lyskom-last-unread-cmark nil local)
(def-kom-var lyskom-last-unread-saved-result-list nil local)
(def-kom-var lyskom-last-unread-saved-by-list nil local)
(def-kom-var lyskom-last-unread-saved-to-list nil local)
(def-kom-var lyskom-last-unread-saved-result-size 0 local)
(def-kom-var lyskom-last-unread-saved-smallest nil local)
(def-kom-var lyskom-last-unread-saved-largest nil local)
(def-kom-var lyskom-have-unread nil local)
David Byers's avatar
David Byers committed
83

David Byers's avatar
David Byers committed
84

85
86
87
88
89
(defun lyskom-remove-zeroes (a)
  "Returns a copy of list where all zeroes are removed."
  (delq 0 (copy-sequence a)))


David Byers's avatar
David Byers committed
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
;;; ================================================================
;;; Temoporary change of mark-as-read

(defun kom-toggle-mark-as-read-prefix ()
  "Read one key sequence and run one command with state of
kom-review-marks-texts-as-read toggled."
  (interactive)
  (let* ((kom-review-marks-texts-as-read (not kom-review-marks-texts-as-read))
         (sequence (read-key-sequence
                    (format "%s: " 
                            (lyskom-get-string
                             (if kom-review-marks-texts-as-read 
                                 'review-marking-as-read
                               'review-not-marking-as-read)))))
         (command (lookup-key (current-local-map) sequence)))
    (when (commandp command)
      (call-interactively command))))

108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
(defun kom-toggle-cache-prefix ()
  "Read one key sequence and run one command with state of
kom-review-marks-texts-as-read toggled."
  (interactive)
  (let* ((kom-review-uses-cache (not kom-review-uses-cache))
         (sequence (read-key-sequence
                    (format "%s: " 
                            (lyskom-get-string
                             (if kom-review-uses-cache 
                                 'review-using-cache
                               'review-not-using-cache)))))
         (command (lookup-key (current-local-map) sequence)))
    (when (commandp command)
      (call-interactively command))))

David Byers's avatar
David Byers committed
123

Per Cederqvist's avatar
.    
Per Cederqvist committed
124
125
126
;;; ================================================================
;;;              ]terse av, till - Review by X to Conference Y.

David Byers's avatar
David Byers committed
127
;;; Author: David Byers
128

Per Cederqvist's avatar
.    
Per Cederqvist committed
129

130
(def-kom-command kom-review-all ()
131
  "Review all texts written by a particular author to a particular
132
133
134
135
conference. This can also be accomplished by using `kom-review-by-to'
and specifying zero texts.

See `kom-review-uses-cache', `kom-review-priority' and
136
`kom-review-marks-texts-as-read' for information on settings that affect
137
all review-related functions."
138
139
140
141
  (interactive)
  (lyskom-tell-internat 'kom-tell-review)
  (lyskom-review-by-to 0))

David Byers's avatar
David Byers committed
142
(def-kom-command kom-unread-all ()
143
  "Mark all texts written by a particular author to a particular
David Byers's avatar
David Byers committed
144
145
146
147
148
conference as unread. This can also be accomplished by using
`kom-unread-by-to' and specifying zero texts."
  (interactive)
  (lyskom-unread-by-to 0))

Per Cederqvist's avatar
.    
Per Cederqvist committed
149

150
(def-kom-command kom-review-more (count)
151
  "Review more texts using the same critera as the last review
152
153
154
155
performed with `kom-review-by-to'. The review will be resumed where
the previous review finished.

See `kom-review-uses-cache', `kom-review-priority' and
156
`kom-review-marks-texts-as-read' for information on settings that affect
157
all review-related functions."
Ulrik Haugen's avatar
Ulrik Haugen committed
158
  (interactive "P")
David Byers's avatar
David Byers committed
159
160
  (if (not lyskom-have-review)
      (lyskom-format-insert 'no-review-done)
161
162
163
164
    (let* ((count (or count
		      (lyskom-read-number
		       (lyskom-get-string 'review-how-many-more)
		       (abs lyskom-last-review-num))))
David Byers's avatar
David Byers committed
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
           (info (progn (if (and (listp count)
                                 (integerp (car count))
                                 (null (cdr count)))
                            (setq count (car count)))
                        (cond ((zerop count) 
                               (setq count nil)
                               (lyskom-get-string 'review-rest))
                              ((> count 0)
                               (lyskom-format (lyskom-get-string 'review-more)
                                              count)))))
           (by lyskom-last-review-by)
           (to lyskom-last-review-to))

      (lyskom-format-insert 'review-more-info-by-to
                            info
                            (if (zerop by)
                                (lyskom-get-string 'anybody)
                              by)
                            (if (zerop to)
                                (lyskom-get-string 'all-confs)
                              to))
    
      (condition-case arg
          (let ((list (lyskom-get-texts-by-to by to count t)))
            (setq lyskom-last-review-num 
                  (if (< lyskom-last-review-num 0)
                      (- count)
                    count))
            (if list
194
195
196
197
198
199
200
                (lyskom-review-enter-read-info
                 (lyskom-create-read-info
                  'REVIEW
                  nil
                  (lyskom-review-get-priority)
                  (lyskom-create-text-list list)
                  nil t) t)
David Byers's avatar
David Byers committed
201
202
203
204
205
              (lyskom-insert-string 'no-such-text)))
        (lyskom-review-error (if arg
                                 nil
                               (lyskom-insert-string 'no-such-text)))))))

David Byers's avatar
David Byers committed
206
(def-kom-command kom-unread-more (count)
207
  "Mark more texts unread using the same critera as the last 
David Byers's avatar
David Byers committed
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
mark unread performed with `kom-unread-by-to'."
  (interactive "P")
  (if (not lyskom-have-unread)
      (lyskom-format-insert 'no-unread-done)
    (let* ((count (or count
		      (lyskom-read-number
		       (lyskom-get-string 'unread-how-many-more)
		       (abs lyskom-last-unread-num))))
           (info (progn (if (and (listp count)
                                 (integerp (car count))
                                 (null (cdr count)))
                            (setq count (car count)))
                        (cond ((zerop count) 
                               (setq count nil)
                               (lyskom-get-string 'unread-rest))
                              ((> count 0)
                               (lyskom-format (lyskom-get-string 'unread-more)
                                              count)))))
           (by lyskom-last-unread-by)
           (to lyskom-last-unread-to))

      (lyskom-format-insert 'unread-more-info-by-to
                            info
                            (if (zerop by)
                                (lyskom-get-string 'anybody)
                              by)
                            (if (zerop to)
                                (lyskom-get-string 'all-confs)
                              to))
    
      (condition-case arg
239
          (let ((list (lyskom-get-texts-by-to by to count t t)))
David Byers's avatar
David Byers committed
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
            (setq lyskom-last-unread-num 
                  (if (< lyskom-last-unread-num 0)
                      (- count)
                    count))
            (if list
              (lyskom-traverse text-no list
                (unless (lyskom-mark-unread text-no)
                  (lyskom-format-insert 'cant-mark-text-unread
                                        text-no
                                        (lyskom-get-error-text lyskom-errno))))
              (lyskom-insert-string 'no-such-text)))
        (lyskom-review-error (if arg
                                 nil
                               (lyskom-insert-string 'no-such-text)))))))

255

David Byers's avatar
David Byers committed
256

257
(def-kom-command kom-review-first (&optional count)
258
  "Review the first N texts written by a particular author to some
259
260
261
262
263
264
265
conference. With no author specified, review texts by all authors.
With zero texts specified, review all text. With no conference
specified, review texts to all conferences. With a negative number of
texts, review the last N texts instead of the first (you can use
`kom-review-by-to' instead.

See `kom-review-uses-cache', `kom-review-priority' and
266
`kom-review-marks-texts-as-read' for information on settings that affect
267
all review-related functions."
268
  (interactive "P")
269
270
271
272
273
  (lyskom-tell-internat 'kom-tell-review)
  (lyskom-review-by-to (- (or count
                           (lyskom-read-number
                            (lyskom-get-string 'review-how-many) 1)))))

David Byers's avatar
David Byers committed
274
(def-kom-command kom-unread-first (&optional count)
275
  "Mark the first N texts written by a particular author to some
David Byers's avatar
David Byers committed
276
277
278
279
280
281
282
283
284
285
conference as unread. With no author specified, review texts by all 
authors. With zero texts specified, review all text. With no conference
specified, review texts to all conferences. With a negative number of
texts, review the last N texts instead of the first (you can use
`kom-unread-by-to' instead."
  (interactive "P")
  (lyskom-unread-by-to (- (or count
                           (lyskom-read-number
                            (lyskom-get-string 'unread-how-many) 1)))))

286

David Kågedal's avatar
David Kågedal committed
287
(def-kom-command kom-review-by-to (&optional count)
288
  "Review the last N texts written by a particular author to some
289
290
291
292
293
294
295
conference. With no author specified, review texts by all authors.
With zero texts specified, review all text. With no conference
specified, review texts to all conferences. With a negative number of
texts, review the last N texts instead of the first (you can use
`kom-review-first' instead.

See `kom-review-uses-cache', `kom-review-priority' and
296
`kom-review-marks-texts-as-read' for information on settings that affect
297
all review-related functions."
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
  (interactive "P")
  (lyskom-review-by-to (or count
                           (lyskom-read-number
                            (lyskom-get-string 'review-how-many) 1))))
  


(defun lyskom-review-by-to (count)
  "Common function for kom-review-by-to and kom-review-first"
  (let* ((info (progn (if (and (listp count)
                               (integerp (car count))
                               (null (cdr count)))
                          (setq count (car count)))
                      (cond ((zerop count) 
                             (setq count nil)
313
                             (lyskom-get-string 'everything))
314
315
316
317
318
                            ((> count 0)
                             (lyskom-format 'latest-n count))
                            ((< count 0)
                             (lyskom-format 'first-n
                                            (- count))))))
319
320
321
322
         (by (lyskom-read-conf-no `(review-by-whom ,info)
                                  '(pers) t nil t))
         (to (lyskom-read-conf-no `(review-to-conf ,info)
                                  '(all) t nil t)))
David Kågedal's avatar
David Kågedal committed
323
324

    (if (not (zerop to))
325
        (cache-del-conf-stat to))
David Kågedal's avatar
David Kågedal committed
326
    (if (not (zerop by)) 
327
        (cache-del-pers-stat by))
328

David Byers's avatar
David Byers committed
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
    (lyskom-format-insert 'review-info-by-to
                          info
                          (if (zerop by)
                              (lyskom-get-string 'anybody)
                            by)
                          (if (zerop to)
                              (lyskom-get-string 'all-confs)
                            to))

    (setq lyskom-last-review-by by)
    (setq lyskom-last-review-to to)
    (setq lyskom-last-review-num count)
    (setq lyskom-last-review-pmark nil)
    (setq lyskom-last-review-cmark nil)
    (setq lyskom-last-review-saved-result-list nil)
    (setq lyskom-last-review-saved-by-list nil)
    (setq lyskom-last-review-saved-to-list nil)
    (setq lyskom-last-review-saved-result-size 0)
    (setq lyskom-last-review-saved-smallest nil)
    (setq lyskom-last-review-saved-largest nil)
David Byers's avatar
   
David Byers committed
349
    (setq lyskom-have-review 'lyskom-review-by-to)
David Kågedal's avatar
David Kågedal committed
350

351
352
353
    (condition-case arg
        (let ((list (lyskom-get-texts-by-to by to count)))
          (if list
354
355
356
357
358
359
360
              (lyskom-review-enter-read-info
               (lyskom-create-read-info
                'REVIEW
                nil
                (lyskom-review-get-priority)
                (lyskom-create-text-list list)
                nil t) t)
361
362
363
364
            (lyskom-insert-string 'no-such-text)))
      (lyskom-review-error (if arg
                               nil 
                             (lyskom-insert-string 'no-such-text))))))
365

David Kågedal's avatar
David Kågedal committed
366

David Byers's avatar
David Byers committed
367
(def-kom-command kom-unread-by-to (&optional count)
368
  "Mark the last N texts written by a particular author to some
David Byers's avatar
David Byers committed
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
conference as unread. With no author specified, review texts by all 
authors. With zero texts specified, review all text. With no conference
specified, review texts to all conferences. With a negative number of
texts, review the last N texts instead of the first (you can use
`kom-unread-first' instead."
  (interactive "P")
  (lyskom-unread-by-to (or count
                           (lyskom-read-number
                            (lyskom-get-string 'unread-how-many) 1))))
  

(defun lyskom-unread-by-to (count)
  "Common function for kom-review-by-to and kom-review-first"
  (let* ((info (progn (if (and (listp count)
                               (integerp (car count))
                               (null (cdr count)))
                          (setq count (car count)))
                      (cond ((zerop count) 
                             (setq count nil)
                             (lyskom-get-string 'everything))
                            ((> count 0)
                             (lyskom-format 'latest-n count))
                            ((< count 0)
                             (lyskom-format 'first-n
                                            (- count))))))
394
395
396
397
         (by (lyskom-read-conf-no `(unread-by-whom ,info)
                                  '(pers) t nil t))
         (to (lyskom-read-conf-no `(unread-to-conf ,info)
                                  '(all) t nil t)))
David Byers's avatar
David Byers committed
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

    (if (not (zerop to))
        (cache-del-conf-stat to))
    (if (not (zerop by)) 
        (cache-del-pers-stat by))

    (lyskom-format-insert 'unread-info-by-to
                          info
                          (if (zerop by)
                              (lyskom-get-string 'anybody)
                            by)
                          (if (zerop to)
                              (lyskom-get-string 'all-confs)
                            to))

    (setq lyskom-last-unread-by by)
    (setq lyskom-last-unread-to to)
    (setq lyskom-last-unread-num count)
    (setq lyskom-last-unread-pmark nil)
    (setq lyskom-last-unread-cmark nil)
    (setq lyskom-last-unread-saved-result-list nil)
    (setq lyskom-last-unread-saved-by-list nil)
    (setq lyskom-last-unread-saved-to-list nil)
    (setq lyskom-last-unread-saved-result-size 0)
    (setq lyskom-last-unread-saved-smallest nil)
    (setq lyskom-last-unread-saved-largest nil)
    (setq lyskom-have-unread t)

    (condition-case arg
427
        (let ((list (lyskom-get-texts-by-to by to count nil t)))
David Byers's avatar
David Byers committed
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
          (if list
              (lyskom-traverse text-no list
                (unless (lyskom-mark-unread text-no)
                  (lyskom-format-insert 'cant-mark-text-unread
                                        text-no
                                        (lyskom-get-error-text lyskom-errno))))
            (lyskom-insert-string 'no-such-text)))
      (lyskom-review-error (if arg
                               nil 
                             (lyskom-insert-string 'no-such-text))))))






444
445
446
447
448
449
450
451
452
453
;;; ================================================================
;;; lyskom-get-texts-by-to
;;; Author: David Byers
;;;
;;; Call lyskom-get-texts-by, lyskom-get-texts-to or 
;;; lyskom-get-texts-by-and-to to get NUM texts by person 
;;; BY to conference TO.
;;;


454
(defun lyskom-get-texts-by-to (by to num &optional again do-unread)
David Byers's avatar
David Byers committed
455
  "Get NUM texts written by person number BY in conference number TO
456
Args: BY TO NUM AGAIN DO-UNREAD"
457
  (cond ((and (zerop by) 
458
              (zerop to)) (lyskom-get-texts-globally num again do-unread))
David Byers's avatar
David Byers committed
459
460
        ((zerop to) (lyskom-get-texts-by by num again))
        ((zerop by) (lyskom-get-texts-to to num again))
David Byers's avatar
David Byers committed
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
        ((and (eq by lyskom-pers-no)
              (not (eq to by))
              (let ((conf (blocking-do 'get-conf-stat to)))
                (and (conf-type->letterbox (conf-stat->conf-type conf))
                     (null (map->text-nos 
                            (blocking-do 'get-map
                                         (conf-stat->conf-no conf)
                                         (conf-stat->first-local-no conf)
                                         1))))))
         (lyskom-get-texts-by-generic 
          by num 
          (function 
           (lambda (x to)
             (let ((found nil))
               (lyskom-traverse misc (text-stat->misc-info-list x)
                 (setq found 
                       (or found
478
479
                           (and (memq (misc-info->type misc)
					lyskom-recpt-types-list)
David Byers's avatar
David Byers committed
480
481
482
483
484
                                (eq (misc-info->recipient-no misc) to)))))
               found)))
          (list to)
          again))
         (t (lyskom-get-texts-by-and-to by to num again))))
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


;;; ============================================================
;;; lyskom-check-review-access
;;; Author: David Byers
;;;
;;; Check that we can access the conference map. If we can't some
;;; review functions are just not much fun
;;;

(defun lyskom-check-review-access (conf pers)
  "Check that we can review texts to CONF by PERS.
CONF is a conf-stat or t if we know we can access that conference.
PERS is a pers-stat or t if we know we can access that person.
This function signals an error if review is impossible"
  (cond ((null conf) 
         (lyskom-format-insert 'review-conf-gone)
         (signal 'lyskom-cant-review-error t))
        ((null pers)
         (lyskom-format-insert 'review-pers-gone)
         (signal 'lyskom-cant-review-error t))
        ((lyskom-conf-stat-p conf)
         (cond ((= 0 (conf-stat->no-of-texts conf))
                (lyskom-format-insert 'review-cant-read-empty)
                (signal 'lyskom-cant-review-error t))
               ((null (map->text-nos 
                       (blocking-do 'get-map
                                    (conf-stat->conf-no conf)
                                    (conf-stat->first-local-no conf)
                                    1)))
                (if (conf-type->letterbox
                     (conf-stat->conf-type conf))
                    (lyskom-format-insert 'review-cant-read-letterbox)
                  (lyskom-format-insert 'review-cant-read-conf))
                (signal 'lyskom-cant-review-error t))))))

521
522


523
524
525
526
527
;;; ============================================================
;;; lyskom-get-texts-globally
;;; Author: Per Cederquist, David Byers
;;;

528
(defun lyskom-get-texts-globally (num &optional again do-unread)
David Byers's avatar
David Byers committed
529
530
531
532
533
534
535
  "Get the last NUM texts created in LysKOM. If AGAIN is non-nil, keep
going from where we were before."
  (cond ((and again (null num))
         (setq num lyskom-last-review-num))
        ((and again (< lyskom-last-review-num 0)) 
         (setq num (- num)))
        ((null num) 
536
537
         (lyskom-format-insert
          (if do-unread 'cant-unread-everything 'cant-review-everything))
David Byers's avatar
David Byers committed
538
539
         (signal 'lyskom-cant-review-error t)))

540
  (let ((result nil)
David Byers's avatar
David Byers committed
541
542
543
        (textno (cond (again lyskom-last-review-cmark)
                      ((< num 0) 1)
                      (t (lyskom-maxint))))
544
545
546
547
548
        (op (if (< num 0)
                'find-next-text-no
              'find-previous-text-no)))

    (while (and (not (eq textno 0))
David Byers's avatar
David Byers committed
549
                (not (null textno))
550
551
                (< (length result) (abs num)))
      (setq textno (blocking-do op textno))
David Byers's avatar
David Byers committed
552
553
554
      (if textno
          (setq result (cons textno result))))
    (setq lyskom-last-review-cmark textno)
555
556
557
558
    (if (< num 0)
        (nreverse result)
      result)))

559

560
561
562
563
564
565
566
567
568
569
570
571
;;; ================================================================
;;; lyskom-get-letters-to
;;; Author: David Byers
;;; 
;;; Get letters by self that have a specified letterbox as
;;; recipient. Do this by linearly searching selfs letterbox
;;; map and look as every single doggone text-stat. What a drag.
;;;
;;; +++ FIXME: This is just get-texts-by right now. Need to filter stuff.
;;;

(defun lyskom-get-letters-to (persno recipient num &optional again pstart)
David Byers's avatar
David Byers committed
572
573
574
  "Get NUM texts written by PERSNO. Args: persno num

Cannot be called from a callback."
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
  (let ((persstat (blocking-do 'get-pers-stat persno)))
    (lyskom-check-review-access t persstat)

    (cond ((and again (null num)) (setq num lyskom-last-review-num))
          ((and again (< lyskom-last-review-num 0)) (setq num (- num))))

    (let* ((plow (or pstart (pers-stat->first-created-text persstat)))
           (phigh (1- (+ plow (pers-stat->no-of-created-texts persstat))))
           (result (if again
                       lyskom-last-review-saved-result-list
                     nil))
           (increment (if num (abs num)))
           (mark (cond (again lyskom-last-review-pmark)
                        ((and num (< num 0)) plow)
                        (t phigh)))
           (collector nil)
           (found nil)
           (start nil)
           (data nil))
    

      (if (null num)
          (setq num (1+ phigh)
                mark phigh
                increment (1+ phigh)))

      (while (and (<= mark phigh)
                  (>= mark plow)
                  (> (abs num) (length result)))

        (setq increment (min lyskom-fetch-map-nos increment))
        (setq start (if (< num 0)
                        mark
                      (- mark (1- increment))))
        (if (< start 0)
            (progn
              (setq increment (- increment start))
              (setq start 0)))
      
        (setq data (lyskom-remove-zeroes
                    (listify-vector
                     (map->text-nos
                      (blocking-do 'get-created-texts
                                   persno
                                   start
                                   increment)))))

        (setq collector (make-collector))
        (mapcar
         (function
          (lambda (x)
            (initiate-get-text-stat 
             'main 
             (function
              (lambda (x collector pers-no)
                (if (and x
                         (lyskom-is-recipient x pers-no))
                    (collector-push (text-stat->text-no x) collector))))
             x
             collector
             recipient)))
         data)

        (lyskom-wait-queue 'main)
        (setq found (nreverse (collector->value collector)))

        (if (> num 0)
            (setq result (nconc found result)
                  mark (- mark increment))
          (setq result (nconc result found)
                mark (+ mark increment)))
        (if (null found)
            (setq increment (min lyskom-fetch-map-nos (* increment 2)))
          (setq increment (- (abs num) (length result)))))

      (setq lyskom-last-review-pmark mark)

      (if (> num 0)
          (progn
            (setq lyskom-last-review-saved-result-list 
655
                  (lyskom-nfirst (- (length result) num) result))
656
            (nthcdr (max 0 (- (length result) num)) result))
657
658
659
        (progn
          (setq lyskom-last-review-saved-result-list
                (nthcdr (- num) result))
660
          (lyskom-nfirst (- num)  result))))))
661
662
663
664
665
666






667
668
;;; ================================================================
;;; lyskom-get-texts-by-and-to
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
;;; Author: David Byers
;;;
;;; Note: We can't assume that the conference's map of texts is
;;; sorted. If we could, it would be possible to simplify this
;;; function considerably without making it slower. 
;;;
;;; Problem: Construct part of the intersection between the user's
;;; created texts (the by-list) and the texts in a conference (the
;;; to-list) without bogging down the client, server or network and
;;; do it quickly!
;;;
;;; Idea: Construct the intersection incrementally without doing more
;;; work comparing things than we would if we had the full maps to
;;; start with.
;;;
;;; Solution: Get one segment of the by-list (call the nth segment
;;; by_n) and to-list (call the nth segment to_n) at a time until we
;;; are done or until both are exhausted. 
;;;
;;; In each iteration do the following: Calculate the intersection
;;; between to_n with each of the previous by_i leaving r_n:
;;;         r_n = \prod_{i=1}^{n-1} by_i \cap to_n
;;; where \prod denotes list concatenation. Next calculate the
;;; intersection of by_n with each to_i 0<i<n in turn, concatenating
;;; the result to the corresponding r_i:
;;;         r_i \larrow r_i * (by_n \cap to_i) ; 0<i<n
;;; At this point, the concatenation of all r_n, \prod r_n, is the
;;; result of the intersection between the segments of the by-list and
Joel Rosdahl's avatar
Joel Rosdahl committed
697
;;; to-list we have retrieved so far.
698
699
700
701
702
703
704
705
706
707
708
;;;
;;; If the total size of the result equals or exceeds the size we
;;; requested, finish the loop and return the results.
;;;
;;;
;;; Althogh the solution may seem a bit complicated, it's really not
;;; that bad once you think about how it's done. The good thing about
;;; it is that it does as little work as possible comparing elements.
;;; The bad part is that it constructs a little too many new cons
;;; cells, although reversing most of the lists does help.
;;;
709
;;; The following optimisations have been implemented:
710
;;;
711
712
713
714
715
716
717
718
719
720
721
722
723
;;; - Exploit the fact that the user's map is sorted by aborting the
;;; search if we have the full conference map and the lowest number we
;;; have from the user's map is lower than the lowest number in the
;;; conference map. Highest numbers apply when we are searching from
;;; the front.

;;; +++ FIXME: For users that have written very little in high-traffic
;;; conferences, and where the request cannot be fulfilled (if num is
;;; too high) this function ends up scanning the entire conference
;;; map. At some point it is probably faster to get all the text-stats
;;; in the user's map (when we've retrieved the map we know how many
;;; there are) and look at the recipients rather than calculate the
;;; intersection. 
724
;;;
725

David Byers's avatar
David Byers committed
726
727
(defun lyskom-get-texts-by-and-to (persno confno num 
                                          &optional again pstart cstart)
728
  "Get NUM texts written by person PERSNO with conference CONFNO as a
David Byers's avatar
David Byers committed
729
730
recipient. If optional AGAIN is non-nil, continue from where we were.
Args: persno confno num &optional again pstart cstart"
731
732
  (blocking-do-multiple ((persstat (get-pers-stat persno))
                         (confstat (get-conf-stat confno)))
733
734
735
736
737
738
739
740
741
    (cond

     ;;
     ;; Special case: reviewing to a letterbox or conference we're not
     ;; a member of and have no access to.
     ;;

     ((and (eq lyskom-pers-no persno)
           confstat
742
743
           (or (conf-type->letterbox (conf-stat->conf-type confstat))
               (and (conf-type->rd_prot (conf-stat->conf-type confstat))
744
745
                    (null (map->text-nos 
                           (blocking-do 'get-map
David Byers's avatar
David Byers committed
746
747
                                        (conf-stat->conf-no confstat)
                                        (conf-stat->first-local-no confstat)
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
                                        1)))))
           (not (eq persno confno)))
      (lyskom-get-letters-to persno confno num again pstart))

     ;;
     ;; General case
     ;;

     (t
      (lyskom-check-review-access confstat persstat)
      (cond ((and again (null num)) (setq num lyskom-last-review-num))
            ((and again (< lyskom-last-review-num 0) (setq num (- num)))))
      (let* ((result-list (if again
                              lyskom-last-review-saved-result-list
                            nil))
             (by-list (if again
                          lyskom-last-review-saved-by-list
                        nil))
             (to-list (if again 
                          lyskom-last-review-saved-to-list 
                        nil))
             (result-size (if again
                              lyskom-last-review-saved-result-size
                            0))
             (by nil)
             (to nil)
             (increment lyskom-fetch-map-nos)
             (plow (or pstart (pers-stat->first-created-text persstat)))
             (phigh (1- (+ plow (pers-stat->no-of-created-texts persstat))))
             (pmark (cond (again lyskom-last-review-pmark)
                          ((and num (< num 0)) plow)
                          (t phigh)))
             (clow (or cstart (conf-stat->first-local-no confstat)))
             (chigh (1- (+ clow (conf-stat->no-of-texts confstat))))
             (cmark (cond (again lyskom-last-review-cmark)
                          ((and num (< num 0)) clow)
                          (t chigh)))
             (smallest (if again lyskom-last-review-saved-smallest nil))
             (largest (if again lyskom-last-review-saved-largest nil))
             (abort-loop nil))

        (if (null num)
            (setq num (1+ phigh)))

        (while (and (or (and (<= pmark phigh)
                             (>= pmark plow))
                        (and (<= cmark chigh)
                             (>= cmark clow)))
                    (> (abs num) result-size)
                    (not abort-loop))

          (setq by (and (<= pmark phigh)
                        (>= pmark plow)
                        (lyskom-remove-zeroes
                         (listify-vector
                          (map->text-nos
                           (blocking-do 'get-created-texts
                                        (pers-stat->pers-no persstat)
                                        (if (< num 0)
                                            pmark
                                          (max 0 (- pmark (1- increment))))
                                        increment)))))
                to (and (<= cmark chigh)
                        (>= cmark clow)
                        (lyskom-remove-zeroes
                         (listify-vector
                          (map->text-nos
                           (blocking-do 'get-map
                                        (conf-stat->conf-no confstat)
                                        (if (< num 0)
                                            cmark
                                          (max 0 (- cmark (1- increment))))
                                        increment))))))

          (if (> num 0)
              (if (and smallest by
                       (> smallest (car by)))
                  (setq abort-loop t))
            (if (and largest by
                     (< largest (car (nthcdr (1- (length by)) by))))
                (setq abort-loop t)))

          ;;
          ;;    Add intersection between new TO and old BYs
          ;;    to the results list.
          ;;

          (setq result-list
                (cons (apply 'nconc
                             (mapcar 
                              (function
                               (lambda (x)
                                 (lyskom-intersection to x)))
                              by-list))
                      result-list))

          ;;
          ;;    Add new BY and TO to the by-list and to-list
          ;;

          (setq by-list (cons by by-list)
                to-list (cons to to-list))
850
      
851

852
853
854
855
856
          ;;
          ;;    Add intersections between new BY and all TOs
          ;;

          (setq result-list
857
858
859
860
861
862
                (lyskom-mapcar2 (function
                                 (lambda (x y)
                                   (lyskom-intersection y
                                                        (nconc x by))))
                                result-list
                                to-list))
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914

          (setq result-size (apply '+ (mapcar 'length result-list)))

          ;;
          ;;    Adjust the marks
          ;;

          (if (> num 0)
              (setq pmark (- pmark increment)
                    cmark (- cmark increment))
            (setq pmark (+ pmark increment)
                  cmark (+ cmark increment)))


          ;;
          ;;  If we have exhausted the conference, calculate smallest and
          ;;  largest
          ;;

          (if (and (null smallest)
                   (null largest)
                   (or (> cmark chigh)
                       (< cmark clow)))
              (setq smallest 
                    (apply 'min
                           (mapcar (function (lambda (x)
                                               (if x
                                                   (apply 'min x)
                                                 (lyskom-maxint))))
                                   to-list))
                    largest
                    (apply 'max
                           (mapcar (function (lambda (x)
                                               (if x
                                                   (apply 'max x)
                                                 -1)))
                                   to-list))))


          ;;
          ;;    This is the end of the while loop
          ;;

          )

        (setq lyskom-last-review-pmark pmark)
        (setq lyskom-last-review-cmark cmark)
        (setq lyskom-last-review-saved-by-list by-list)
        (setq lyskom-last-review-saved-to-list to-list)
        (setq lyskom-last-review-saved-smallest smallest)
        (setq lyskom-last-review-saved-largest largest)

915
        ;;
916
        ;;  Extract results
917
        ;;
918

919
        (setq result-list
920
921
922
              (apply 'nconc (if (< num 0)
                                (nreverse result-list)
                              result-list)))
923

924
        ;;
925
        ;;  Save discarded results and return retained results
926
        ;;
927

928
        (if (> num 0)
929
930
            (progn
              (setq lyskom-last-review-saved-result-list
931
                    (lyskom-nfirst (- (length result-list) num) result-list))
932
933
934
935
936
              (setq lyskom-last-review-saved-result-size
                    (length  lyskom-last-review-saved-result-list))
              (setq lyskom-last-review-saved-result-list
                    (cons lyskom-last-review-saved-result-list
                          (make-list (- (length by-list) 1) nil)))
937
              (nthcdr (max 0 (- (length result-list) num)) result-list))
938

David Byers's avatar
David Byers committed
939
940
941
942
943
944
945
946
          (progn
            (setq lyskom-last-review-saved-result-list 
                  (nthcdr (- num) result-list))
            (setq lyskom-last-review-saved-result-size
                  (length lyskom-last-review-saved-result-list))
            (setq lyskom-last-review-saved-result-list
                  (cons lyskom-last-review-saved-result-list
                        (make-list (- (length by-list) 1) nil)))
947
            (lyskom-nfirst (- num) result-list))))))))
David Byers's avatar
David Byers committed
948

949

950
951

;;; ===============================================================
952
;;; lyskom-get-texts-by, lyskom-get-texts-to
953
954
;;; Author: David Byers
;;;
955
956
957
958
959
960
961
;;; These functions get data in chunks, starting with the number of
;;; texts requested. If they come up empty (which is common when
;;; scanning from the beginning of a map), the increment is
;;; exponentially increased up to a maximum of 150. 
;;;
;;; lyskom-get-texts-by is also careful to filter out those texts that
;;; are not readable, hence the added complexity in that function.
962
963
;;;

David Byers's avatar
David Byers committed
964
(defun lyskom-get-texts-by (persno num &optional again pstart)
965
  "Get NUM texts written by PERSNO. Args: persno num"
David Byers's avatar
David Byers committed
966
  (let* ((persstat (blocking-do 'get-pers-stat persno)))
967
    (lyskom-check-review-access t persstat)
David Byers's avatar
David Byers committed
968
969
970
971
    (lyskom-get-texts-by-generic persno num nil nil again pstart)))

(defun lyskom-get-texts-by-generic (persno num pred args 
                                           &optional again pstart)
David Byers's avatar
David Byers committed
972
973
974
  "Get NUM texts written by PERSNO. Args: persno num

Cannot be called from a callback."
David Byers's avatar
David Byers committed
975
976
  (let* ((persstat (blocking-do 'get-pers-stat persno))
         (user-area (pers-stat->user-area persstat)))
977

David Byers's avatar
David Byers committed
978
979
980
981
    (cond ((and again (null num)) (setq num lyskom-last-review-num))
          ((and again (< lyskom-last-review-num 0)) (setq num (- num))))

    (let* ((plow (or pstart (pers-stat->first-created-text persstat)))
982
           (phigh (1- (+ plow (pers-stat->no-of-created-texts persstat))))
David Byers's avatar
David Byers committed
983
984
985
           (result (if again
                       lyskom-last-review-saved-result-list
                     nil))
986
           (increment (if num (abs num)))
David Byers's avatar
David Byers committed
987
988
989
           (mark (cond (again lyskom-last-review-pmark)
                        ((and num (< num 0)) plow)
                        (t phigh)))
990
           (collector nil)
991
           (found nil)
992
           (start nil)
993
994
995
996
997
998
999
1000
1001
1002
1003
           (data nil))
    

      (if (null num)
          (setq num (1+ phigh)
                mark phigh
                increment (1+ phigh)))

      (while (and (<= mark phigh)
                  (>= mark plow)
                  (> (abs num) (length result)))
1004
1005
1006
1007
1008
1009
1010
1011
1012

        (setq increment (min lyskom-fetch-map-nos increment))
        (setq start (if (< num 0)
                        mark
                      (- mark (1- increment))))
        (if (< start 0)
            (progn
              (setq increment (- increment start))
              (setq start 0)))
1013
      
David Byers's avatar
David Byers committed
1014
1015
1016
1017
1018
1019
1020
1021
        (setq data (delq user-area
                         (lyskom-remove-zeroes
                          (listify-vector
                           (map->text-nos
                            (blocking-do 'get-created-texts
                                         persno
                                         start
                                         increment))))))
1022

1023
1024
1025
1026
1027
1028
        (setq collector (make-collector))
        (mapcar
         (function
          (lambda (x)
            (initiate-get-text-stat 'main 
                                    (function
David Byers's avatar
David Byers committed
1029
1030
1031
1032
1033
1034
                                     (lambda (x collector pred args)
                                       (when (and x
                                                  (or (null pred)
                                                      (apply pred
                                                             x
                                                             args)))
1035
1036
1037
                                           (collector-push 
                                            (text-stat->text-no x)
                                            collector))))
David Byers's avatar
David Byers committed
1038
                                    x collector pred args)))
1039
1040
         data)

1041
        (lyskom-wait-queue 'main)
1042
        (setq found (nreverse (collector->value collector)))
1043

1044
1045
        (if (> num 0)
            (setq result (nconc found result)
1046
                  mark (- mark increment))
1047
1048
1049
          (setq result (nconc result found)
                mark (+ mark increment)))
        (if (null found)
1050
1051
            (setq increment (min lyskom-fetch-map-nos (* increment 2)))
          (setq increment (- (abs num) (length result)))))
1052

David Byers's avatar
David Byers committed
1053
1054
      (setq lyskom-last-review-pmark mark)

1055
      (if (> num 0)
David Byers's avatar
David Byers committed
1056
1057
          (progn
            (setq lyskom-last-review-saved-result-list 
1058
                  (lyskom-nfirst (- (length result) num) result))
1059
            (nthcdr (max 0 (- (length result) num)) result))
David Byers's avatar
David Byers committed
1060
1061
1062
        (progn
          (setq lyskom-last-review-saved-result-list
                (nthcdr (- num) result))
1063
          (lyskom-nfirst (- num)  result))))))
1064

David Byers's avatar
David Byers committed
1065
(defun lyskom-get-texts-to (confno num &optional again cstart)
1066
  "From CONFNO get NUM texts."
1067
1068
1069
1070
  (let ((confstat (blocking-do 'get-conf-stat confno)))

    (lyskom-check-review-access confstat t)

David Byers's avatar
David Byers committed
1071
1072
1073
1074
    (cond ((and again (null num)) (setq num lyskom-last-review-num))
          ((and again (< lyskom-last-review-num 0)) (setq num (- num))))

    (let* ((clow (or cstart (conf-stat->first-local-no confstat)))
1075
           (chigh (1- (+ clow (conf-stat->no-of-texts confstat))))
David Byers's avatar
David Byers committed
1076
1077
1078
           (result (if again 
                       lyskom-last-review-saved-result-list
                     nil))
1079
           (start nil)
1080
           (increment (and num (abs num)))
David Byers's avatar
David Byers committed
1081
1082
1083
           (mark (cond (again lyskom-last-review-cmark)
                       ((and num (< num 0)) clow)
                       (t chigh))))
1084
1085
1086
1087
1088
1089
1090
1091
1092

      (if (null num)
          (setq num (1+ chigh)
                increment (1+ chigh)
                mark chigh))

      (while (and (<= mark chigh)
                  (>= mark clow)
                  (> (abs num) (length result)))
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102

        (setq increment (min lyskom-fetch-map-nos increment))
        (setq start (if (< num 0)
                        mark
                      (- mark (1- increment))))
        (if (< start 0)
            (progn
              (setq increment (- increment start))
              (setq start 0)))

1103
1104
1105
1106
1107
        (let ((found (lyskom-remove-zeroes
                      (listify-vector
                       (map->text-nos
                        (blocking-do 'get-map
                                     confno
1108
                                     start
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
                                     increment))))))
          (if (> num 0)
              (setq result (nconc found result)
                    mark (- mark increment)
                    increment (- (abs num) (length result)))
            (setq result (nconc result found)
                  mark (+ mark increment)))
          (if (null found)
              (setq increment (min lyskom-fetch-map-nos (* increment 2)))
            (setq increment (- (abs num) (length result))))))
1119

David Byers's avatar
David Byers committed
1120
1121
      (setq lyskom-last-review-cmark mark)

1122
      (if (> num 0)
David Byers's avatar
David Byers committed
1123
1124
          (progn
            (setq lyskom-last-review-saved-result-list 
1125
                  (lyskom-nfirst (- (length result) num) result))
1126
            (nthcdr (max 0 (- (length result) num)) result))
David Byers's avatar
David Byers committed
1127
1128
1129
        (progn
          (setq lyskom-last-review-saved-result-list
                (nthcdr (- num) result))
1130
          (lyskom-nfirst (- num)  result))))))
Per Cederqvist's avatar
.    
Per Cederqvist committed
1131
1132


David Byers's avatar
David Byers committed
1133
1134


David Byers's avatar
David Byers committed
1135
1136
1137
1138
1139
;;; ============================================================
;;;                 terse baklnges
;;;

(def-kom-command kom-review-backward ()
1140
1141
1142
1143
1144
  "Toggles the reviewing order. If you are currently reviewing texts
oldest to newest, review newest to oldest instead. When reviewing
newest to oldest, change to oldest to newest.

See `kom-review-uses-cache', `kom-review-priority' and
1145
`kom-review-marks-texts-as-read' for information on settings that affect
1146
all review-related functions."
Per Cederqvist's avatar
.    
Per Cederqvist committed
1147
1148
1149
  (interactive)
  (cond
   ((and (not (read-list-isempty lyskom-reading-list))
1150
	 (memq (read-info->type (read-list->first lyskom-reading-list))
1151
		 '(REVIEW REVIEW-MARK)))
Per Cederqvist's avatar
.    
Per Cederqvist committed
1152
1153
    (let* ((info (read-list->first lyskom-reading-list))
	   (list (read-info->text-list info))
1154
	   (texts (text-list->texts list))
Per Cederqvist's avatar
.    
Per Cederqvist committed
1155
	   (forward (read-info->forward info)))
David Byers's avatar
David Byers committed
1156
      (set-text-list->texts list (nreverse texts))
Per Cederqvist's avatar
.    
Per Cederqvist committed
1157
      (set-read-info->forward info (not forward))
1158
1159
1160
1161
      (lyskom-format-insert 'you-review 
			    (lyskom-get-string (if (not forward)
						   'forward
						 'backward)))))
Per Cederqvist's avatar
.    
Per Cederqvist committed
1162
   (t
David Byers's avatar
David Byers committed
1163
    (lyskom-insert-string 'illegal-command))))
Per Cederqvist's avatar
.    
Per Cederqvist committed
1164
1165
1166
1167
1168
1169
1170
1171


;;; ================================================================
;;;                   ]terse tr{det - review tree

;;; Author: Linus Tolke


David Kågedal's avatar
David Kågedal committed
1172
(def-kom-command kom-review-tree (&optional text-no)
1173
1174
1175
1176
1177
1178
1179
1180
1181
  "Recursively review all comments to the selected text.
This command will descend recursively in the comment tree, as when
reading texts normally. Unlike when reading normally, filters are
not applied and circular structures are not dealt with gracefully.

This command accepts text number prefix arguments \(see
`lyskom-read-text-no-prefix-arg').

See `kom-review-uses-cache', `kom-review-priority' and
1182
`kom-review-marks-texts-as-read' for information on settings that affect
1183
all review-related functions."
1184
  (interactive (list (lyskom-read-text-no-prefix-arg 'review-tree-q)))
David Kågedal's avatar
David Kågedal committed
1185
1186
  (lyskom-tell-internat 'kom-tell-review)
  (if text-no
1187
1188
1189
1190
1191
1192
1193
1194
1195
      (progn
        (unless kom-review-uses-cache
          (cache-del-text-stat text-no))
        
        (let ((ts (blocking-do 'get-text-stat text-no)))
          (lyskom-follow-comments ts
                                  nil 'review
                                  (lyskom-review-get-priority)
                                  t)))
David Kågedal's avatar
David Kågedal committed
1196
1197
1198
    (lyskom-insert-string 'read-text-first)))


David Byers's avatar
David Byers committed
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
(def-kom-command kom-unread-tree (text-no)
    "Recursively mark all comments to the selected text as unread.

This command accepts text number prefix arguments \(see
`lyskom-read-text-no-prefix-arg')."
  (interactive (list (lyskom-read-text-no-prefix-arg 'unread-tree-q)))
  (lyskom-unread-tree text-no nil))

(defun lyskom-unread-tree (text-no visited-list)
  "Perform the function of kom-unread-tree."
  (let* ((text-stat (blocking-do 'get-text-stat text-no))
         (worklist (and text-stat
                        (lyskom-text-comments text-stat))))
    (if (null (car worklist))
        (lyskom-format-insert 'no-such-text-no text-no)
      (while worklist
        (let ((cur (car worklist)))
          (setq worklist (cdr worklist))
          (unless (memq cur visited-list)
            (setq visited-list (cons cur visited-list)
                  cur (blocking-do 'get-text-stat cur))
            (when cur
              (when (delq nil (mapcar 'lyskom-get-membership
                                      (lyskom-text-recipients cur)))
                (lyskom-format-insert 'marking-text-unread
                                      (text-stat->text-no cur))
                (lyskom-report-command-answer
                 (lyskom-mark-unread (text-stat->text-no cur))))
              (lyskom-traverse text-no (lyskom-text-comments cur)
                (unless (or (memq text-no visited-list)
                            (memq text-no worklist)
                  (setq worklist (cons text-no worklist)))))))))))
  visited-list)



1235
(def-kom-command kom-find-root (text-no)
1236
1237
1238
1239
1240
1241
1242
1243
  "Finds the root text of the tree containing the selected text.
When there is more than one root, all will be included in a review
operation.

This command accepts text number prefix arguments \(see
`lyskom-read-text-no-prefix-arg').

See `kom-review-uses-cache', `kom-review-priority' and
1244
`kom-review-marks-texts-as-read' for information on settings that affect
1245
all review-related functions."
1246
  (interactive (list (lyskom-read-text-no-prefix-arg 'find-root-q)))
David Kågedal's avatar
David Kågedal committed
1247
1248
  (lyskom-tell-internat 'kom-tell-review)
  (cond
1249
   (text-no
1250
1251
    (unless kom-review-uses-cache
      (cache-del-text-stat text-no))
1252
    (let* ((ts (blocking-do 'get-text-stat text-no))
David Byers's avatar
David Byers committed
1253
1254
1255
	   (r (lyskom-find-root ts t)))
      (cond ((> (length r) 1)
             (lyskom-format-insert-before-prompt
1256
1257
1258
1259
1260
1261
1262
1263
              (lyskom-get-string 'more-than-one-root) ts)
             (lyskom-review-enter-read-info
              (lyskom-create-read-info
               'REVIEW
               nil
               (lyskom-review-get-priority)
               (lyskom-create-text-list r)
               nil t) t))
1264
1265
1266
            (r (unless kom-review-uses-cache
                 (cache-del-text-stat (car r)))
               (lyskom-view-text (car r)))
1267
            (t (lyskom-insert-string 'could-not-find-root)))
David Kågedal's avatar
David Kågedal committed
1268
1269
1270
      )
    )
   (t
1271
    (lyskom-insert-string 'confusion-what-to-find-root))))
Per Cederqvist's avatar
.    
Per Cederqvist committed
1272

David Byers's avatar
David Byers committed
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
(def-kom-command kom-unread-root (text-no)
  "Finds the root text of the tree containing the selected text
and marks it as unread.

This command accepts text number prefix arguments \(see
`lyskom-read-text-no-prefix-arg')."
  (interactive (list (lyskom-read-text-no-prefix-arg 'unread-root-q)))
  (if text-no
      (let* ((ts (blocking-do 'get-text-stat text-no))
             (r (lyskom-find-root ts t)))
1283
1284
1285
1286
1287
1288
        (if r
            (lyskom-traverse text-no r
              (lyskom-format-insert 'marking-text-unread text-no)
              (lyskom-report-command-answer
               (lyskom-mark-unread text-no)))
          (lyskom-insert-string 'could-not-find-root)))
David Byers's avatar
David Byers committed
1289
1290
    (lyskom-insert-string 'confusion-what-to-unread-root)))

Per Cederqvist's avatar
.    
Per Cederqvist committed
1291

1292
(def-kom-command kom-find-root-review (text-no)
1293
1294
1295
1296
1297
1298
1299
1300
1301
  "Finds the root of the comment tree containing the selected texts
and then recursively reviews all its comments. For texts with a single
root, this is equivalent to doing `kom-find-root' followed by
`kom-review-tree'.

This command accepts text number prefix arguments \(see
`lyskom-read-text-no-prefix-arg').

See `kom-review-uses-cache', `kom-review-priority' and
1302
`kom-review-marks-texts-as-read' for information on settings that affect
1303
all review-related functions."
1304
  (interactive (list (lyskom-read-text-no-prefix-arg 'find-root-review-q)))
1305
  (lyskom-tell-internat 'kom-tell-review)
Per Cederqvist's avatar
.    
Per Cederqvist committed
1306
  (cond
1307
   (text-no
1308
1309
    (unless kom-review-uses-cache
      (cache-del-text-stat text-no))
1310
    (let* ((ts (blocking-do 'get-text-stat text-no))
David Byers's avatar
David Byers committed
1311
1312
1313
1314
1315
1316
           (start (lyskom-find-root ts t)))
      (cond ((> (length start) 1)
             (lyskom-format-insert-before-prompt
              (lyskom-get-string 'more-than-one-root-review) ts)
             (lyskom-review-tree (car start)))
            (start (lyskom-review-tree (car start)))
1317
            (t (lyskom-insert-string 'could-not-find-root)))))
1318
   (t (lyskom-insert-string 'confusion-what-to-find-root-review))))
Per Cederqvist's avatar
.    
Per Cederqvist committed
1319

David Byers's avatar
David Byers committed
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
(def-kom-command kom-unread-root-review (text-no)
  "Finds the root of the comment tree containing the selected texts
and then recursively marks all its comments as unread. For texts with
a single root, this is equivalent to doing `kom-find-root' followed by
`kom-unread-tree'.

This command accepts text number prefix arguments \(see
`lyskom-read-text-no-prefix-arg')."
  (interactive (list (lyskom-read-text-no-prefix-arg 'unread-root-review-q)))
  (if text-no
      (let* ((ts (blocking-do 'get-text-stat text-no))
             (start (lyskom-find-root ts t))
             (marked nil))
        (lyskom-traverse text-no start
          (setq marked (lyskom-unread-tree text-no marked))))
    (lyskom-insert-string 'confusion-what-to-unread-root-review)))

Per Cederqvist's avatar
.    
Per Cederqvist committed
1337

David Byers's avatar
X    
David Byers committed
1338
(defun lyskom-find-root (text-stat &optional all)
Per Cederqvist's avatar
.    
Per Cederqvist committed
1339
  "Finds the root text of the tree containing the text TEXT-STAT.
David Byers's avatar
X    
David Byers committed
1340
1341
1342
1343
1344
1345
1346
Args: TEXT-STAT &optional ALL
If ALL is set, return a list of all root texts."  
  (cond (text-stat
         (let ((queue (list text-stat))
               (head nil)
               (misclist nil)
               (tmp nil)
1347
               (seen nil)
David Byers's avatar
X    
David Byers committed
1348
1349
1350
1351
1352
               (result nil))
           (while queue
             (setq head (car queue))
             (setq queue (cdr queue))
             (setq tmp nil)
1353

David Byers's avatar
X    
David Byers committed
1354
1355
1356
             ;;
             ;; For each parent, add it to the queue
             ;;
1357

David Byers's avatar
X    
David Byers committed
1358
1359
1360
             (setq misclist (text-stat->misc-info-list head))
             (while misclist
               (cond ((eq (misc-info->type (car misclist)) 'COMM-TO)
1361
1362
1363
1364
1365
1366
1367
1368
1369
                      (if (memq (misc-info->comm-to (car misclist)) seen)
                          (setq tmp (cons t tmp))
                        (unless kom-review-uses-cache
                          (cache-del-text-stat (misc-info->comm-to (car misclist))))
                        (setq seen (cons (misc-info->comm-to (car misclist)) seen)
                              tmp (cons
                                   (blocking-do 'get-text-stat
                                                (misc-info->comm-to (car misclist)))
                                   tmp))))
David Byers's avatar
X    
David Byers committed
1370
                     ((eq (misc-info->type (car misclist)) 'FOOTN-TO)
1371
1372
1373
1374
1375
1376
1377
1378
1379
                      (if (memq (misc-info->footn-to (car misclist)) seen)
                          (setq tmp (cons t tmp))
                        (unless kom-review-uses-cache
                          (cache-del-text-stat (misc-info->footn-to (car misclist))))
                        (setq seen (cons (misc-info->footn-to (car misclist)) seen)
                              tmp (cons
                                   (blocking-do 'get-text-stat
                                                (misc-info->footn-to (car misclist)))
                                   tmp)))))
David Byers's avatar
X    
David Byers committed
1380
               (setq misclist (cdr misclist)))
1381

1382
1383
1384
             ;;
             ;; Remove unreadable texts
             ;;
1385

1386
             (setq tmp (delq nil tmp))
1387

David Byers's avatar
X    
David Byers committed
1388
1389
1390
1391
1392
1393
             ;;
             ;; If no parents were found, this is is a top-level text
             ;;

             (when (null tmp)
               (setq result (cons head result))
1394
1395
1396
1397
1398
1399
1400
               (unless all (setq queue nil)))

             ;;
             ;; Remove "I visited this parent already" markers
             ;;

             (setq tmp (delq t tmp))
David Byers's avatar
X    
David Byers committed
1401
             (setq queue (nconc tmp queue)))
1402
1403
           (if all 
               (mapcar 'text-stat->text-no result)
David Byers's avatar
X    
David Byers committed
1404
1405
1406
1407
             (text-stat->text-no (car result)))))
        (t nil)))


Per Cederqvist's avatar
.    
Per Cederqvist committed
1408
1409
1410
1411
1412


(defun lyskom-review-tree (text)
  "Takes a TEXT as an arg, shows the text and the tree of all comments.
Does a lyskom-end-of-command.
Linus Tolke's avatar
Linus Tolke committed
1413
Text is a text-no."
Per Cederqvist's avatar
.    
Per Cederqvist committed
1414
1415
  (cond
   ((integerp text)
1416
1417
    (unless kom-review-uses-cache
      (cache-del-text-stat text))
1418
    (lyskom-view-text text nil t nil (lyskom-review-get-priority) t))
Linus Tolke's avatar
Linus Tolke committed
1419
1420
1421
1422
   (t
    (signal 'lyskom-internal-error
	    (list 'lyskom-review-tree
		  "Called with incorrect argument."
David Kågedal's avatar
David Kågedal committed
1423
		  text)))))
Per Cederqvist's avatar
.    
Per Cederqvist committed
1424
1425
1426
1427
1428
1429
1430
1431


;;; ================================================================
;;;                     ]terse n{sta -  review next

;;; Author: Linus Tolke


David Byers's avatar
David Byers committed
1432
(def-kom-command kom-review-next ()
1433