review.el 16 KB
Newer Older
Linus Tolke's avatar
Linus Tolke committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
;;;;;
;;;;; $Id$
;;;;; Copyright (C) 1991  Lysator Academic Computer Association.
;;;;;
;;;;; This file is part of the LysKOM server.
;;;;; 
;;;;; LysKOM is free software; you can redistribute it and/or modify it
;;;;; under the terms of the GNU General Public License as published by 
;;;;; the Free Software Foundation; either version 1, or (at your option) 
;;;;; 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
25
26
27
28
29
30
31
32
33
34
35
36
37
;;;; ================================================================
;;;; ================================================================
;;;;
;;;; 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.
;;;;


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


43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

(defun lyskom-intersection (a b)
  "Returns as a list the intersection of list A and list B.
The order of the list a is kept."
  (let ((list (list)))
    (while a
      (if (memq (car a) b)
	  (setq list (cons (car a) list)))
      (setq a (cdr a)))
    (nreverse list)))

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


Per Cederqvist's avatar
.  
Per Cederqvist committed
59
60
61
62
63
64
;;; ================================================================
;;;              ]terse av, till - Review by X to Conference Y.

;;; Author: Linus Tolke


65

Per Cederqvist's avatar
.  
Per Cederqvist committed
66
67
68
69
70
71
72
73
74
75
76
77
(defun kom-review-by-to (&optional count)
  "Reviews all articles of author that is written to conference recipient.
If return is given instead of an author then all authors to that conference is
shown. If return is given instead of conference then all conferences for that
person is chosen.
If a positive numeric argument is given then only the last COUNT articles are 
chosen. If the argument is negative then the first -COUNT articles are chosen.
If the argument is zero the all articles are chosen.
No argument is equivalent to COUNT 1.
The defaults for this command is the conference that you are in."
  (interactive "p")
  (lyskom-start-of-command 'kom-review-by-to)
78
  (lyskom-tell-internat 'kom-tell-review)
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
  (unwind-protect
      (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 'everybody))
		     ((> count 0)
		      (lyskom-format 'latest-n count))
		     ((< count 0)
		      (lyskom-format 'first-n (- count))))))
	     (by (lyskom-read-conf-no (lyskom-format 'info-by-whom info)
				      'pers 'empty))
	     (to (lyskom-read-conf-no (lyskom-format 'info-to-conf info)
				      'all 
				      ;; If person is not given we must give
				      ;; conf
				      (not (zerop by))
				      (if (zerop lyskom-current-conf)
					  ""
					(conf-stat->name
					 (blocking-do 'get-conf-stat
						      lyskom-current-conf))))))

	; Since we fetch everything anyway we don't need to do this.
	; If we later choose to fetch all in small chunks we will have
	; to do this then.
	; (if (not (zerop to))
	;   (cache-del-conf-stat to))
	; (if (not (zerop by)) 
	;   (cache-del-pers-stat by))
113
114
115
116
117
118
119
120
121
122
	(let* ((info-by (if (zerop by) 
			    (lyskom-get-string 'anybody)
			  (blocking-do 'get-conf-stat by)))
	       (info-to (if (zerop to)
			    (lyskom-get-string 'all-confs)
			  (blocking-do 'get-conf-stat to))))
	  (lyskom-format-insert 'review-info-by-to
				info
				info-by
				info-to))
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

	;; Now we have 
	;; - the person number in by
	;; - the conf number in to
	;; - the number of interesting texts in count (if negative, then 
	;;   count from the beginning.
	;;
	;; What we have to do is fetch and merge the list of texts until we 
	;; have found count texts.

	;; Lets do the very simple thing: 
	;; - Fetch the whole lists. If its to slow, fix it!
	;;   (the calls wont get very big, at least not during get-map
	;;    because the initiate-get-map itself splits the call)

	(let* ((found-by (or (zerop by)
			     (lyskom-remove-zeroes
Linus Tolke's avatar
Linus Tolke committed
140
141
142
143
			      (append
			       (map->text-nos
				(blocking-do 'get-created-texts by
					     0 lyskom-max-int)) nil))))
144
145
	       (found-to (or (zerop to)
			     (lyskom-remove-zeroes
Linus Tolke's avatar
Linus Tolke committed
146
147
148
149
			      (append
			       (map->text-nos
				(blocking-do 'get-map to
					     0 lyskom-max-int)) nil))))
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
	       (list (cond
		      ((zerop by) found-to)
		      ((zerop to) found-by)
		      ;; This will get them in the correct order
		      (t (lyskom-intersection found-by found-to)))))
		     
	  (if list
	      (progn
		;; Cut out the part we want, the beginning or the end...
		(cond
		 ((> count 0)
		  (while (> (length list) count)
		    (setq list (cdr list))))
		 ((< count 0)
		  (setq list (nfirst (- count) list))))
		(read-list-enter-read-info
		 (lyskom-create-read-info
		  'REVIEW
		  nil
		  (lyskom-get-current-priority)
		  (lyskom-create-text-list list)
		  nil t)
		 lyskom-reading-list t))
	    (lyskom-insert-string 'no-such-text))))
    (lyskom-end-of-command)))

Per Cederqvist's avatar
.  
Per Cederqvist committed
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
	


(defun kom-review-backward ()
  "Toggles the reviewing order.
If reading forward then starts reading backward and the other way round."
  (interactive)
  (lyskom-start-of-command 'kom-review-backward)
  (cond
   ((and (not (read-list-isempty lyskom-reading-list))
	 (or (eq (read-info->type (read-list->first lyskom-reading-list))
		 'REVIEW)
	     (eq (read-info->type (read-list->first lyskom-reading-list))
		 'REVIEW-MARK)))
    (let* ((info (read-list->first lyskom-reading-list))
	   (list (read-info->text-list info))
	   (texts (cdr list))
	   (forward (read-info->forward info)))
      (setcdr list (nreverse (cdr list)))
      (set-read-info->forward info (not forward))
196
197
198
199
      (lyskom-format-insert 'you-review 
			    (lyskom-get-string (if (not forward)
						   'forward
						 'backward)))))
Per Cederqvist's avatar
.  
Per Cederqvist committed
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
   (t
    (lyskom-insert-string 'illegal-command)))
  (lyskom-end-of-command)) 


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

;;; Author: Linus Tolke


(defun kom-review-tree (&optional text-no)
  "Review all comments to this text.
Descends recursively in the comment-tree without marking the texts as read.
The tree is forgotten when a kom-go-to-next-conf command is issued.
If optional prefix argument TEXT-NO is present view tree from that text 
instead. In this case the text TEXT-NO is first shown." 
   (interactive (list
		(cond
		 ((null current-prefix-arg)
		  lyskom-current-text)
		 ((integerp current-prefix-arg)
		  current-prefix-arg)
		 (t
		  (signal 'lyskom-internat-error '(kom-review-tree))))))
  (lyskom-start-of-command 'kom-review-tree)
226
  (lyskom-tell-internat 'kom-tell-review)
Per Cederqvist's avatar
.  
Per Cederqvist committed
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
  (if text-no
      (progn
	(initiate-get-text-stat 'main 'lyskom-follow-comments text-no
				nil 'review
				(lyskom-get-current-priority)
				t)
	(lyskom-run 'mail 'lyskom-end-of-command))
    (lyskom-insert-string 'read-text-first)
    (lyskom-end-of-command)))


(defun kom-find-root ()
  "Finds the root text of the tree containing the text in lyskom-current-text."
  (interactive)
  (lyskom-start-of-command 'kom-find-root)
242
  (lyskom-tell-internat 'kom-tell-review)
Per Cederqvist's avatar
.  
Per Cederqvist committed
243
244
245
246
247
248
249
250
251
252
253
254
255
256
  (cond
   (lyskom-current-text 
    (lyskom-collect 'review)
    (initiate-get-text-stat 'review nil lyskom-current-text)
    (initiate-get-text-stat 'review nil lyskom-current-text)
    (lyskom-use 'review 'lyskom-find-root 'kom-find-root-2))
   (t
    (lyskom-insert-string 'read-text-first)
    (lyskom-end-of-command))))


(defun kom-find-root-2 (text-no)
  "Runs lyskom-view-text with the text-no that lyskom-find-root produced
and then runs lyskom-end-of-command."
257
258
  (lyskom-view-text text-no)
  (lyskom-end-of-command))
Per Cederqvist's avatar
.  
Per Cederqvist committed
259
260
261
262
263
264
265


(defun kom-find-root-review ()
  "Finds the root text of the tree containing the text in lyskom-current-text and
reviews the whole tree in deep-first order."
  (interactive)
  (lyskom-start-of-command 'kom-find-root-review)
266
  (lyskom-tell-internat 'kom-tell-review)
Per Cederqvist's avatar
.  
Per Cederqvist committed
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
  (cond
   (lyskom-current-text
    (lyskom-collect 'review)
    (initiate-get-text-stat 'review nil lyskom-current-text)
    (initiate-get-text-stat 'review nil lyskom-current-text)
    (lyskom-use 'review 'lyskom-find-root 'lyskom-review-tree))
   (t
    (lyskom-insert-string 'read-text-first)
    (lyskom-end-of-command))))


(defun lyskom-find-root (text-stat old-text-stat thendo)
  "Finds the root text of the tree containing the text TEXT-STAT.
Args: TEXT-STAT OLD-TEXT-STAT THENDO
If TEXT-STAT is nil and OLD-TEXT-STAT contains a text-stat
then this means that the parent of the text in OLD-TEXT-STAT is not readable
and the text in OLD-TEXT-STAT is to be used instead.
If both TEXT-STAT and OLD-TEXT-STAT is nil then this means we are not allowed
to read the text we are trying to find the root of. This just returns with a
message.
If the third argument THENDO is non-nil then call the function with the text-no
of the root text as argument."
  (let* ((ts text-stat)
	 (misclist (and ts (text-stat->misc-info-list ts)))
	 (todo t))
    (cond
     (ts				;+++ Smartare errorhantering hit.
      (while misclist
	(let* ((type (misc-info->type (car misclist)))
	       (comm (eq type 'COMM-TO))
	       (yes (or comm
			(eq type 'FOOTN-TO)))
	       (parent-no (if comm
			      (misc-info->comm-to (car misclist))
			    (misc-info->footn-to (car misclist)))))
	  (cond
	   (yes
	    (initiate-get-text-stat 'main 'lyskom-find-root
				    parent-no ts thendo)
	    (setq todo nil)
	    (setq misclist nil))))
	(setq misclist (cdr misclist)))
      (if todo (apply thendo (list (text-stat->text-no ts)))))
     (old-text-stat
      (apply thendo (list (text-stat->text-no old-text-stat))))
     (t
      (lyskom-insert-string 'cannot-get-last-text)
      (lyskom-end-of-command)))))


(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
320
Text is a text-no."
Per Cederqvist's avatar
.  
Per Cederqvist committed
321
322
  (cond
   ((integerp text)
323
    (lyskom-view-text text nil t nil (lyskom-get-current-priority) t))
Linus Tolke's avatar
Linus Tolke committed
324
325
326
327
328
   (t
    (signal 'lyskom-internal-error
	    (list 'lyskom-review-tree
		  "Called with incorrect argument."
		  text))))
329
  (lyskom-end-of-command))
Per Cederqvist's avatar
.  
Per Cederqvist committed
330
331
332
333
334
335
336
337
338
339
340
341
342
343


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

;;; Author: Linus Tolke


(defun kom-review-next ()
  "Resumes an interupted review by moving all review and review-tree entries in
the lyskom-reading-list to the beginning. i.e by moving all other types to the
end."
  (interactive)
  (lyskom-start-of-command 'kom-review-next)
344
  (lyskom-tell-internat 'kom-tell-review)
Per Cederqvist's avatar
.  
Per Cederqvist committed
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
  (let ((len (read-list-length lyskom-reading-list))
	(finished nil))
    (while (and (not finished)
		(> len 1))
      (let ((type (read-info->type (read-list->first lyskom-reading-list))))
	(if (and (not (eq type 'REVIEW))
		 (not (eq type 'REVIEW-TREE))
		 (not (eq type 'REVIEW-MARK)))
	    (read-list-rotate lyskom-reading-list)
	  (setq finished t)))
      (setq len (1- len))))
  (lyskom-end-of-command))


;;; ================================================================
;;;                    ]terse stacken - Review stack

;;; Author: Linus


(defun kom-review-stack ()
  "Displays the review-stack."
  (interactive)
  (lyskom-start-of-command 'kom-review-stack)
  (mapcar
   (function
    (lambda (info)
      (let ((un (length (cdr (read-info->text-list info))))
	    (type (read-info->type info))
	    (cto (read-info->comm-to info)))
	(cond
	 ((eq type 'REVIEW)
	  (lyskom-format-insert 'review-n-texts un))
	 ((eq type 'REVIEW-TREE)
	  ; +++ Hmmm. Pluralformer. Besv{rligt!
Linus Tolke's avatar
Linus Tolke committed
380
381
382
	  (if (= un 1)
	      (lyskom-format-insert 'review-one-comment cto)
	    (lyskom-format-insert 'review-many-comments cto un)))
Per Cederqvist's avatar
.  
Per Cederqvist committed
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
	 ((eq type 'REVIEW-MARK)
	  (lyskom-format-insert 'review-marked un))))))
   (read-list->all-entries lyskom-reading-list))
  (lyskom-end-of-command))


;;; ================================================================
;;;                      ]terse hoppa - review clear

;;; Author: Linus Tolke


(defun kom-review-clear ()
  "Deletes all review-types from the lyskom-reading-list and lyskom-to-do-list."
  (interactive)
  (lyskom-start-of-command 'kom-review-clear)
  (if (not (read-list-isempty lyskom-reading-list))
      (while (or (eq (read-info->type (read-list->first lyskom-reading-list))
		     'REVIEW)
		 (eq (read-info->type (read-list->first lyskom-reading-list))
		     'REVIEW-TREE)
		 (eq (read-info->type (read-list->first lyskom-reading-list))
		     'REVIEW-MARK))
	(set-read-list-del-first lyskom-reading-list)))
  (if (not (read-list-isempty lyskom-to-do-list))
      (while (or (eq (read-info->type (read-list->first lyskom-to-do-list))
		     'REVIEW)
		 (eq (read-info->type (read-list->first lyskom-to-do-list))
		     'REVIEW-TREE)
		 (eq (read-info->type (read-list->first lyskom-to-do-list))
		     'REVIEW-MARK))
	(set-read-list-del-first lyskom-to-do-list)))
  (lyskom-end-of-command))


;;; ================================================================
;;;          ]terse det kommenterade - View commented text

;;; Author: Inge Wallin


(defun kom-review-comments ()
  "View the comments to this text.
If the current text has comments in (footnotes in) some texts then the first
text is shown and a REVIEW list is built to shown the other ones."
  (interactive)
  (lyskom-start-of-command 'kom-review-comments)
430
  (lyskom-tell-internat 'kom-tell-review)
Per Cederqvist's avatar
.  
Per Cederqvist committed
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
  (initiate-get-text-stat 'read 'lyskom-review-comments
			  lyskom-current-text))


(defun lyskom-review-comments (text-stat)
  "Handles the return from the initiate-get-text-stat, displays and builds list."
  (let* ((misc-info-list (and text-stat
			      (text-stat->misc-info-list text-stat)))
	 (misc-infos (and misc-info-list
			  (append (lyskom-misc-infos-from-list 
				   'COMM-IN misc-info-list)
				  (lyskom-misc-infos-from-list 
				   'FOOTN-IN misc-info-list))))
	 (text-nos (and misc-infos
			(mapcar
			 (function
			  (lambda (misc-info)
			    (if (equal (misc-info->type misc-info)
				       'COMM-IN)
				(misc-info->comm-in misc-info)
			      (misc-info->footn-in misc-info))))
			 misc-infos))))
    (if text-nos
	(progn
	  (lyskom-format-insert 'review-text-no (car text-nos))
	  (if (cdr text-nos)
	      (read-list-enter-read-info
	       (lyskom-create-read-info
		'REVIEW nil (lyskom-get-current-priority)
		(lyskom-create-text-list (cdr text-nos))
		lyskom-current-text)
	       lyskom-reading-list t))
463
	  (lyskom-view-text (car text-nos)))
Per Cederqvist's avatar
.  
Per Cederqvist committed
464
465
      (lyskom-insert-string 'no-such-text)))
  (lyskom-run 'main 'lyskom-end-of-command))
466
467
468
469
470
471
472
473
474
475
476
477
478
479


;;; ================================================================
;;;          ]terse igen - kom-review-last-normally-read
;;;
;;; Author: Linus Tolke


(defun kom-review-last-normally-read (no)
  "Reviews the NO last normally read texts."
  (interactive 
   (list 
    (lyskom-read-number (lyskom-get-string 'read-normally-read) 1)))
  (lyskom-start-of-command 'kom-review-last-normally-read)
480
  (lyskom-tell-internat 'kom-tell-review)
481
482
483
484
485
486
487
488
489
490
491
  (let* ((text-nos (reverse (nfirst no lyskom-normally-read-texts))))
    (if text-nos
	(progn
	  (lyskom-format-insert 'review-text-no (car text-nos))
	  (if (cdr text-nos)
	      (read-list-enter-read-info
	       (lyskom-create-read-info
		'REVIEW nil (lyskom-get-current-priority)
		(lyskom-create-text-list (cdr text-nos))
		lyskom-current-text)
	       lyskom-reading-list t))
492
	  (lyskom-view-text (car text-nos)))
493
      (lyskom-format-insert 'no-such-text)))
494
  (lyskom-end-of-command))
495
496
497
498
499
500
      
(defun nfirst (n list)
  "Return a list of the N first elements of LIST."
  (if (or (<= n 0) (not list))
      nil
    (cons (car list) (nfirst (1- n) (cdr list)))))