lyskom-rest.el 81.7 KB
Newer Older
Linus Tolke's avatar
Linus Tolke committed
1
2
;;;;;
;;;;; $Id$
3
;;;;; Copyright (C) 1991, 1996  Lysator Academic Computer Association.
Linus Tolke's avatar
Linus Tolke committed
4
5
6
7
8
;;;;;
;;;;; 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 
9
;;;;; the Free Software Foundation; either version 2, or (at your option) 
Linus Tolke's avatar
Linus Tolke committed
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
;;;;; 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
38
39
40
41
42
43
44
;;;; ================================================================
;;;; ================================================================
;;;;
;;;; File: lyskom-rest.el
;;;;
;;;; This is the rest of what was once the entire source code of the
;;;; client. Now most of the source resides in other files. Eventually
;;;; the functions in here will be distributed out to other files.
;;;; Below follows the original header of the LysKOM elisp client:
;;;;
;;;; ================================================================
;;;;
;;;; Simple LysKOM elisp client.
;;;;
;;;; Originally written by Per Cederqvist.
;;;;
;;;; Heavily hacked by:
;;;;    Thomas Bellman
;;;;    Linus Tolke
;;;;    Inge Wallin
45
46
;;;;    David K}gedal
;;;;    David Byers
Per Cederqvist's avatar
.  
Per Cederqvist committed
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
;;;;   and others.
;;;;
;;;; Some ideas stolen from lpmud.el written by Lars Willf|r and Thomas Bellman
;;;;
;;;; Conventions:
;;;;
;;;;    All functions, variables etc follow one of these conventions:
;;;;		lyskom-		general functions.
;;;;		cache-		cache-routines.
;;;;		initiate-	call a service. (Might look up in cache)
;;;;		kom-		user kommands.
;;;;		lyskom-parse-	parse (part of) a reply from the server.
;;;;				these are found in parse.el
;;;;		lyskom-edit-	Things related to the editing of texts.
;;;;		{lyskom,kom}-edit-options-
;;;;				things related to editing options
;;;;				(found in flags.el)
;;;;		{lyskom,kom}-prioritize-
;;;;				things related to the prioritize
;;;;				buffer. The file is prioritize.el
;;;;		{lyskom,kom}-{completing-read,completing,complete}-
;;;;				things related to
;;;;				lyskom-completing-read. Found in
;;;;				completing-read.el 
;;;;		lyskom-*-hook   hooks.
;;;;
;;;;    Three plus-signs (+++) in the code marks a place where more
;;;;    work is needed.
;;;;

77
78
79
80
81
(setq lyskom-clientversion-long 
      (concat lyskom-clientversion-long
	      "$Id$\n"))


Per Cederqvist's avatar
.  
Per Cederqvist committed
82
83
84
85
86
87
88
89
90
91
92
93
94
95
;;;; ================================================================
;;;;                             New errors.


(put 'lyskom-protocol-error 'error-conditions
     '(error lyskom-error lyskom-protocol-error))
(put 'lyskom-protocol-error 'error-message
     "LysKOM protocol error:")

(put 'lyskom-internal-error 'error-conditions
     '(error lyskom-error lyskom-internal-error))
(put 'lyskom-internal-error 'error-message
     "Internal LysKOM error.")

David Kågedal's avatar
David Kågedal committed
96
97
98
99
100
(put 'lyskom-format-error 'error-conditions
     '(error lyskom-error lyskom-format-error))
(put 'lyskom-internal-error 'error-message
     "Internal LysKOM format error.")

Per Cederqvist's avatar
.  
Per Cederqvist committed
101

102
103
104
105
106
107
;;; ================================================================
;;;             Global variables
;;;

(defvar lyskom-unread-mode-line nil)

Per Cederqvist's avatar
.  
Per Cederqvist committed
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
;;; ================================================================
;;;             Error reporting from a number of commands.
;;;

;;; Author: Inge Wallin



(defun lyskom-get-error-text (errno)
  "Get a string which is the error ERRNO in plain text."
  (let ((pair (assoc errno lyskom-error-texts)))
    (if pair 
	(cdr pair)
      (lyskom-format 'error-not-found errno))))

123
(defun lyskom-report-command-answer (answer)
Per Cederqvist's avatar
.  
Per Cederqvist committed
124
125
126
127
128
129
  "Handles a void return from call to the server."
  (if answer 
      (lyskom-insert-string 'done)
    (lyskom-insert-string 'nope)
    (lyskom-format-insert 'error-code
			  (lyskom-get-error-text lyskom-errno)
130
			  lyskom-errno)))
Per Cederqvist's avatar
.  
Per Cederqvist committed
131
132
133
134
135
136
137
138
139
140
141
142
143


;;; ----------------------------------------------------------------
;;; Author: Aronsson

(defun lyskom-tell-string (key)
  "Retrieve the phrase indexed by the key from the kom-tell-phrases
assoc list."
  (car (cdr (assoc key kom-tell-phrases))))


(defun lyskom-tell-internat (key)
  "Same as lyskom-tell-server, but use a key to a list of phrases."
David Kågedal's avatar
David Kågedal committed
144
145
146
  ;; The server at Lysator produces a lot of network traffic. The
  ;; solution should to be less verbose. This is very interesting
  ;; anymore, anyway.
Per Cederqvist's avatar
.  
Per Cederqvist committed
147
148
149
150
151
152
153
154
155
156
  (lyskom-tell-server (lyskom-tell-string key)))



;;;; ================================================================
;;;;                User-level commands and functions.


(defun lyskom-command-name (command)
  "Get the command name for the command COMMAND"
157
  (lyskom-get-string command 'lyskom-command)) 
Per Cederqvist's avatar
.  
Per Cederqvist committed
158

Linus Tolke's avatar
Linus Tolke committed
159
(defun lyskom-ok-command (alternative administrator)
160
161
  "Returns non-nil if it is ok to do such a command right now."
  (if administrator
162
163
      (not (memq (cdr alternative) lyskom-admin-removed-commands))
    (not (memq (cdr alternative) lyskom-noadmin-removed-commands))))
164
165


Per Cederqvist's avatar
.  
Per Cederqvist committed
166
167
168
(defun kom-extended-command ()
  "Read a LysKOM function name and call the function."
  (interactive)
David Byers's avatar
David Byers committed
169
170
  (let ((fnc (lyskom-read-extended-command)))
    (cond
171
172
     (fnc (call-interactively fnc))
     (t (kom-next-command)))) )
David Byers's avatar
David Byers committed
173
174

(defun lyskom-read-extended-command ()
175
  "Reads and returns a command"
Per Cederqvist's avatar
.  
Per Cederqvist committed
176
  (let* ((completion-ignore-case t)
177
	 (alternatives (mapcar (function (lambda (pair)
178
					   (cons (cdr pair) (car pair))))
179
			       (lyskom-get-strings lyskom-commands 'lyskom-command)))
Per Cederqvist's avatar
.  
Per Cederqvist committed
180
	 (name (completing-read (lyskom-get-string 'extended-command)
181
				alternatives 
Linus Tolke's avatar
Linus Tolke committed
182
183
184
185
				;; lyskom-is-administrator is buffer-local and
				;; must be evalled before the call to 
				;; completing-read
				;; Yes, this is not beautiful
186
187
188
189
190
191
192
				;;(list 'lambda '(alternative)	     
				;;	(list 'lyskom-ok-command 'alternative
				;;	      lyskom-is-administrator))
				(` (lambda (alternative)
				     (lyskom-ok-command
				      alternative
				      (, lyskom-is-administrator))))
193
				t nil)))
194
    (cdr (assoc name alternatives))))
Per Cederqvist's avatar
.  
Per Cederqvist committed
195
196
197

;;; Resume operation after a crash.

David Kågedal's avatar
David Kågedal committed
198
199
200
201
(defun kom-recover (&optional refetch)
  "Try to recover from an error.
If the optional argument REFETCH is non-nil, `lyskom-refetch' is called."
  (interactive "p")
David Kågedal's avatar
Bugfix    
David Kågedal committed
202
  (lyskom-init-parse lyskom-buffer)
Per Cederqvist's avatar
.  
Per Cederqvist committed
203
204
  (setq lyskom-call-data nil)
  (setq lyskom-pending-calls nil)
David Kågedal's avatar
David Kågedal committed
205
206
207
208
209
  (setq lyskom-output-queues (make-vector 10 nil))
  (let ((i 0))
    (while (< i 10)
      (aset lyskom-output-queues i (lyskom-queue-create))
      (++ i)))
Per Cederqvist's avatar
.  
Per Cederqvist committed
210
211
  (setq lyskom-number-of-pending-calls 0)
  (setq lyskom-is-parsing nil)
David Kågedal's avatar
David Kågedal committed
212
  (if refetch (lyskom-refetch))
Per Cederqvist's avatar
.  
Per Cederqvist committed
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
  (lyskom-tell-internat 'kom-tell-recover)
  (lyskom-end-of-command))


;;; ================================================================
;;;                      Run default command.


;;; Author: Tommy Persson

(defun kom-page-next-command ()
  "Scroll the bottom to the top and run the next command if it should be run"
  (interactive)
  (if (pos-visible-in-window-p (point-max))
      (progn
228
	(goto-char (point-max))
Per Cederqvist's avatar
.  
Per Cederqvist committed
229
	(recenter 0)
Lars Willför's avatar
Lars Willför committed
230
	(lyskom-next-command))
Per Cederqvist's avatar
.  
Per Cederqvist committed
231
232
    (recenter 0)
    (move-to-window-line -1)
Lars Willför's avatar
Lars Willför committed
233
    (lyskom-set-last-viewed)))
Per Cederqvist's avatar
.  
Per Cederqvist committed
234
235


236
;;; Author: Lars Willf|r
Per Cederqvist's avatar
.  
Per Cederqvist committed
237
238
239
240

(defun kom-next-command ()
  "Run next command or scroll one page."
  (interactive)
Lars Willför's avatar
Lars Willför committed
241
242
243
244
245
  (if (pos-visible-in-window-p (point-max))
      (lyskom-next-command)
    (move-to-window-line -1)
    (lyskom-set-last-viewed)
    (lyskom-scroll)))
Per Cederqvist's avatar
.  
Per Cederqvist committed
246
247
248
249
250

  
(defun kom-line-next-command ()
  "Run next command or scroll one line."
  (interactive)
Lars Willför's avatar
Lars Willför committed
251
252
253
254
255
  (if (pos-visible-in-window-p (point-max))
      (lyskom-next-command)
    (move-to-window-line 1)
    (lyskom-set-last-viewed)
    (lyskom-scroll)))
Per Cederqvist's avatar
.  
Per Cederqvist committed
256
257


258
259
;;; Author: Per Cederqvist

Lars Willför's avatar
Lars Willför committed
260
(defun lyskom-next-command ()
261
  "Run next command."
262
  (let ((lyskom-doing-default-command t))
263
264
265
266
267
268
269
270
271
272
273
274
    (cond
     ((eq lyskom-command-to-do 'next-pri-text)
      (lyskom-view-priority-text))
     ((eq lyskom-command-to-do 'next-text)
      (kom-view-next-text))
     ((eq lyskom-command-to-do 'next-conf)
      (kom-go-to-next-conf))
     ((eq lyskom-command-to-do 'next-pri-conf)
      (lyskom-go-to-pri-conf))
     ((eq lyskom-command-to-do 'when-done)
      (let ((command (lyskom-what-to-do-when-done)))
	(cond
David Byers's avatar
David Byers committed
275
276
	 ((or (stringp command)
              (vectorp command))
277
278
279
280
281
282
	  (execute-kbd-macro command))
	 (t (call-interactively command)))))
     ((eq lyskom-command-to-do 'unknown)
      (lyskom-insert
       (lyskom-get-string 'wait-for-server)))
     (t (signal 'lyskom-internal-error '(kom-next-command))))))
Per Cederqvist's avatar
.  
Per Cederqvist committed
283
284
285
286
287
288
289
290


;;; ================================================================
;;;                              View text.


(defun kom-initial-digit-view ()
  (interactive)
291
292
  (setq unread-command-events (cons last-command-event
                                    unread-command-events))
Per Cederqvist's avatar
.  
Per Cederqvist committed
293
294
295
296
297
298
  (call-interactively 'kom-view nil))


(defun kom-view (text-no)
  "View text number TEXT-NO."
  (interactive "P")
299
300
301
302
303
304
305
306
307
308
309
310
311
312
  (unwind-protect
      (progn
	(let ((kom-page-before-command nil))
	  (lyskom-start-of-command 'kom-view)
	  (lyskom-tell-internat 'kom-tell-review)
	  )
	(if (setq text-no (cond ((null text-no) nil)
				((listp text-no) (car text-no))
				(t text-no)))
	    nil
	  (setq text-no (lyskom-read-number (lyskom-get-string 'review-text-q)
					    lyskom-current-text)))
	(if (or (not (listp kom-page-before-command))
		(memq 'kom-view kom-page-before-command))
David Kågedal's avatar
David Kågedal committed
313
	    (recenter 1))
314
315
316
317
	(lyskom-tell-internat 'kom-tell-review)
	(lyskom-format-insert 'review-text-no text-no)
	(lyskom-view-text text-no))
    (lyskom-end-of-command)))
Per Cederqvist's avatar
.  
Per Cederqvist committed
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345


;;;; ================================================================
;;;;                         View next text.


(defun kom-view-next-new-text ()
  "Display next new text (putting all review constructs at the end of this conf)."
  (interactive)
  (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))))
	(cond 
	 ((or (eq type 'REVIEW)
	      (eq type 'REVIEW-TREE)
	      (eq type 'REVIEW-MARK))
	  (read-list-rotate lyskom-reading-list))
	 ((or (eq type 'COMM-IN)
	      (eq type 'FOOTN-IN))
	  (set-read-list-del-first lyskom-reading-list))
	 (t 
	  (setq finished t))))
      (-- len)))
  (kom-view-next-text))


346
347
;;; Modified to handle filters

David Kågedal's avatar
David Kågedal committed
348
(def-kom-command kom-view-next-text ()
Per Cederqvist's avatar
.  
Per Cederqvist committed
349
350
  "Display next text (from lyskom-reading-list)."
  (interactive)
David Kågedal's avatar
David Kågedal committed
351
352
353
354
355
356
357
358
359
  (lyskom-tell-internat 'kom-tell-read)
  (let ((action 'next-text))
    (while (eq action 'next-text)
      (if (read-list-isempty lyskom-reading-list)
	  (progn
	    (if (/= 0 lyskom-current-conf)
		(lyskom-insert-string 'completely-read-conf)
	      (lyskom-insert-string 'not-in-any-conf))
	    (setq action nil))
360
	      
David Kågedal's avatar
David Kågedal committed
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
	(progn
	  (let* ((tri (read-list->first lyskom-reading-list))
		 (text-no (car (cdr (read-info->text-list tri))))
		 (type (read-info->type tri))
		 (priority (read-info->priority
			    (read-list->first lyskom-reading-list)))
		 (is-review-tree (eq type 'REVIEW-TREE))
		 (is-review (or (eq type 'REVIEW)
				(eq type 'REVIEW-MARK)
				is-review-tree))
		 (mark-as-read (not is-review)))
	    (if is-review
		(delq text-no 
		      (read-info->text-list tri))) ;First entry only
	    (setq action
		  (lyskom-view-text text-no mark-as-read 
				    (and kom-read-depth-first
					 (not is-review))
				    (read-info->conf-stat
				     (read-list->first
				      lyskom-reading-list))
				    priority
				    is-review-tree
David Kågedal's avatar
David Kågedal committed
384
385
386
387
388
				    (not is-review)))
	    (if mark-as-read
		(lyskom-is-read text-no)
	      (read-list-delete-text nil lyskom-reading-list)
	      (read-list-delete-text nil lyskom-to-do-list))))))))
389
  
Per Cederqvist's avatar
.  
Per Cederqvist committed
390

391
;;; Modified to handle filters
Per Cederqvist's avatar
.  
Per Cederqvist committed
392

David Kågedal's avatar
David Kågedal committed
393
;; This is horribly ugly. It acts like a user command, but it isn't.
Per Cederqvist's avatar
.  
Per Cederqvist committed
394
395
396
(defun lyskom-view-priority-text ()
  "Display the first text from the next conference on the lyskom-to-do-list."
  (lyskom-start-of-command 'kom-view-next-text)
David Kågedal's avatar
David Kågedal committed
397
398
399
400
401
402
403
404
405
406
407
408
  (unwind-protect
      (progn
	(lyskom-tell-internat 'kom-tell-read)
	(let* ((tri (read-list->first lyskom-to-do-list))
	       (priority (read-info->priority
			  (read-list->first lyskom-reading-list)))
	       (text-no (car (text-list->texts (read-info->text-list tri)))))
	  (lyskom-is-read text-no)
	  (lyskom-view-text text-no t nil (read-info->conf-stat tri) 
			    priority nil t))
	(lyskom-wait-queue 'main))
    (lyskom-end-of-command)))
Per Cederqvist's avatar
.  
Per Cederqvist committed
409
410
411


(defun lyskom-is-read (text-no)
Per Cederqvist's avatar
Per Cederqvist committed
412
  "Remove TEXT-NO from the list of texts to read.
Per Cederqvist's avatar
.  
Per Cederqvist committed
413
Deletes TEXT-NO from lyskom-reading-list and lyskom-to-do-list.
Per Cederqvist's avatar
Per Cederqvist committed
414
415
416
Adds info in lyskom-membership.

This function only modifies the internal state of the client. It does
Per Cederqvist's avatar
Per Cederqvist committed
417
418
not mark the text as read in the server. That function is performed by
lyskom-mark-as-read."
Per Cederqvist's avatar
.  
Per Cederqvist committed
419
420
  (read-list-delete-text text-no lyskom-reading-list)
  (read-list-delete-text text-no lyskom-to-do-list)
David Byers's avatar
David Byers committed
421
  (initiate-get-text-stat 'main 'lyskom-is-read-handler text-no)
422
  (setq lyskom-normally-read-texts (cons text-no lyskom-normally-read-texts)))
Per Cederqvist's avatar
.  
Per Cederqvist committed
423
424
425
426
427


(defun lyskom-is-read-handler (text-stat)
  "Update lyskom-membership for all recipients to TEXT-STAT."
  (lyskom-traverse
428
429
430
      misc (text-stat->misc-info-list text-stat)
    (if (or (eq 'RECPT (misc-info->type misc))
	    (eq 'CC-RECPT (misc-info->type misc)))
431
432
	(let ((membership (lyskom-try-get-membership
			   (misc-info->recipient-no misc))))
433
434
435
436
437
	  (if membership
	      (set-membership->read-texts
	       membership
	       (vconcat (vector (misc-info->local-no misc))
			(membership->read-texts membership))))))))
Per Cederqvist's avatar
.  
Per Cederqvist committed
438
439
440
441
442
443


;;; ================================================================
;;;                        Go to next conf.


444
(def-kom-command kom-go-to-next-conf ()
Per Cederqvist's avatar
.  
Per Cederqvist committed
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
  "Go to next conf.
Take first conf from lyskom-to-do-list and copy it to lyskom-reading-list.
Tell server what the user is doing. If the user is reading a conf it is
moved last on lyskom-to-do-list, with priority 0."
  (interactive)
  (lyskom-maybe-move-unread t)
  (lyskom-go-to-next-conf))


(defun lyskom-go-to-pri-conf ()
  "Go to the conf with higher priority.
This differs from kom-go-to-next-conf only in the place where the yet unread 
in the current conf is placed."
  (lyskom-start-of-command 'kom-go-to-next-conf)
  (lyskom-maybe-move-unread nil)
460
461
  (lyskom-go-to-next-conf)
  (lyskom-end-of-command))
Per Cederqvist's avatar
.  
Per Cederqvist committed
462
463
464
465
466
467
468
469
470
471
472
473


(defun lyskom-go-to-next-conf ()
  "Actually go to the next conference on the lyskom-to-do-list"
  ;; Copy first element on lyskom-to-do-list to lyskom-reading-list.
  (if (not (read-list-isempty lyskom-to-do-list))
      (progn
	(read-list-enter-first
	   (read-list->first lyskom-to-do-list)
	   lyskom-reading-list)

	;; Tell server which conf the user is reading.
474
475
476
477
478
479
480
	(let ((conf-stat (read-info->conf-stat
			  (read-list->first lyskom-reading-list))))
	  (when conf-stat
	    (lyskom-enter-conf
	     conf-stat 
	     (read-list->first lyskom-reading-list))
	    (lyskom-set-mode-line conf-stat))))
Per Cederqvist's avatar
.  
Per Cederqvist committed
481
    (lyskom-insert-string 'all-conf-unread-r)
482
    (lyskom-set-mode-line (lyskom-get-string 'all-conf-unread-s))))
Per Cederqvist's avatar
.  
Per Cederqvist committed
483
484


485
(defun lyskom-maybe-move-unread (bury)
Linus Tolke's avatar
Linus Tolke committed
486
  "Empty the reading list.
487
If the argument BURY is non-nil and there are unread artilces left in the
Linus Tolke's avatar
Linus Tolke committed
488
reading list then the conf is inserted last in the to do list."
Per Cederqvist's avatar
.  
Per Cederqvist committed
489
490
  (if (not (read-list-isempty lyskom-reading-list))
      (progn
491
	(if bury
Per Cederqvist's avatar
.  
Per Cederqvist committed
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
	    (let ((conf-no nil)
		  (r 0))
	      (while (and (not conf-no)
			  (< r (read-list-length lyskom-reading-list)))
		(if (eq (read-info->type (read-list->nth lyskom-reading-list 
							 r))
			'CONF)
		    (setq conf-no (conf-stat->conf-no 
				   (read-info->conf-stat
				    (read-list->nth lyskom-reading-list r))))
		  (++ r)))
	      (if conf-no
		  (progn
		    (read-list-delete-read-info conf-no lyskom-to-do-list)
		    (read-list-enter-first (read-list->nth lyskom-reading-list
							   r)
					   lyskom-to-do-list)
		    (read-list-rotate lyskom-to-do-list)))))
	(set-read-list-empty lyskom-reading-list))))


(defun lyskom-enter-conf (conf-stat read-info)
  "Tell server which conf the user is reading.
Prints the name and amount of unread in the conference we just went to 
according to the value of kom-print-number-of-unread-on-entrance.
Args: CONF-STAT READ-INFO"
  (initiate-pepsi 'main nil (conf-stat->conf-no conf-stat))
  (setq lyskom-current-conf (conf-stat->conf-no conf-stat))
520
  (let ((num-unread (length (text-list->texts
Per Cederqvist's avatar
.  
Per Cederqvist committed
521
522
			     (read-info->text-list
			      read-info)))))
523
524
525
526
527
528
529
    (lyskom-format-insert (if (not kom-print-number-of-unread-on-entrance)
			      'enter-conf
			    (if (= num-unread 1)
				'one-unread
			      'several-unread))
			  conf-stat
			  num-unread)))
Per Cederqvist's avatar
.  
Per Cederqvist committed
530
531
532
533
534
535
  



;;;================================================================

536
537
538
;;; in vars.el:
;(defvar lyskom-sessions-with-unread nil
;  "Global variable. List of lyskom-sessions with unread articles.")
539
540
541
542
543
544
545
;;;Must be called after lyskom-get-string is defined. Also after running 
;;;load hooks.
;;;(or (assq 'lyskom-sessions-with-unread minor-mode-alist)
;;;    (setq minor-mode-alist (cons (list 'lyskom-sessions-with-unread 
;;;			       		  (lyskom-get-string 'mode-line-unread))
;;;				 minor-mode-alist)))

Per Cederqvist's avatar
.  
Per Cederqvist committed
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561

(defun lyskom-set-mode-line (&optional conf)
  "Sets mode-line-conf-name to the name of the optional argument conf CONF.
CONF can be a a conf-stat or a string."
  (let ((name (cond
	       ((null conf) 
		(if (zerop lyskom-current-conf)
		    (lyskom-get-string 'not-present-anywhere)
		  (initiate-get-conf-stat 'modeline 'lyskom-set-mode-line
					  lyskom-current-conf)
		  nil))
	       ((stringp conf) conf)
	       ((lyskom-conf-stat-p conf)
		(conf-stat->name conf))
	       (t "")))
	(unread -1)
562
	(total-unread 0)
563
	(letters 0)
564
	(len 0)
Per Cederqvist's avatar
.  
Per Cederqvist committed
565
566
567
	(read-info-list nil))

    (if (null name)
568
569
570
571
572
573
574
575
	nil				; We didn't have the name.

      ;; Set unread to the number of unread texts in CONF.
      (if (lyskom-conf-stat-p conf)
	  (progn
	    (setq read-info-list 
		  (read-list->all-entries lyskom-to-do-list))

David Kågedal's avatar
David Kågedal committed
576
577
	    ;; This was weird. Someone had begun to write an if, but
	    ;; this was all there was: (if 
578
579
580
581
582
583
584
585
586
587
	    (while read-info-list
	      (if (read-info->conf-stat (car read-info-list))
		  (progn
		    (setq len (length (text-list->texts 
				       (read-info->text-list 
					(car read-info-list)))))
		    (if (= (conf-stat->conf-no conf)
			   (conf-stat->conf-no 
			    (read-info->conf-stat (car read-info-list))))
			(setq unread len))
588
589
590
591
		    (if (= lyskom-pers-no
			   (conf-stat->conf-no 
			    (read-info->conf-stat (car read-info-list))))
			(setq letters len))
592
		    (setq total-unread (+ total-unread len))))
David Kågedal's avatar
David Kågedal committed
593
	      (setq read-info-list (cdr read-info-list)))))
594
595
      (if (= unread -1)
	  (setq unread 0))
David Kågedal's avatar
David Kågedal committed
596
      
597
598
599
      (if (null name)
	  nil
	(setq mode-line-conf-name 
David Kågedal's avatar
David Kågedal committed
600
601
602
603
604
605
606
607
608
609
	      (substring (concat
			  (if (lyskom-conf-stat-p conf)
			      (if (> lyskom-session-priority 0)
				  (format "(%d/%d:%d) "
					  unread total-unread
					  lyskom-session-priority)
				(format "(%d/%d) " unread total-unread))
			    "")
			  name
			  (make-string 27 ? ))
610
			 0 27)))
David Kågedal's avatar
David Kågedal committed
611
      
612
613
      (if (zerop total-unread)
	  (setq lyskom-sessions-with-unread
614
615
		(delq lyskom-buffer lyskom-sessions-with-unread))
	(or (memq lyskom-buffer lyskom-sessions-with-unread)
616
	    (setq lyskom-sessions-with-unread
617
		  (cons lyskom-buffer lyskom-sessions-with-unread))))
618
619
      (if (zerop letters)
	  (setq lyskom-sessions-with-unread-letters
620
621
		(delq lyskom-buffer lyskom-sessions-with-unread-letters))
	(or (memq lyskom-buffer lyskom-sessions-with-unread-letters)
622
	    (setq lyskom-sessions-with-unread-letters
623
		  (cons lyskom-buffer lyskom-sessions-with-unread-letters)))))
David Kågedal's avatar
David Kågedal committed
624
    (force-mode-line-update)))
Per Cederqvist's avatar
.  
Per Cederqvist committed
625
626
627
628
629
630
631


;;; ================================================================

;;; +++Where should this be moved???


632
(defun lyskom-try-get-membership (conf-no)
Per Cederqvist's avatar
.  
Per Cederqvist committed
633
  "Returns non-nil if conference CONF-NO is present on lyskom-membership.
634
635
636
637
638
639
The value is actually the membership for the conference.

For foreground functions, lyskom-get-membership should probably be used
instead.

This function does not use blocking-do."
Per Cederqvist's avatar
.  
Per Cederqvist committed
640
641
642
643
644
645
646
647
648
  (let ((list lyskom-membership)
	(found nil))
    (while (and (not found) (not (null list)))
      (if (= conf-no (membership->conf-no (car list)))
	  (setq found (car list)))
      (setq list (cdr list)))
    found))


649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
(defun lyskom-get-membership (conf-no)
  "Get the membership for CONF-NO, or nil if the user is not a member of
CONF-NO.

If the membership list is not fully prefetched and the membership can't be
found inlyskom-membership, a blocking call to the server is made."
  (or (lyskom-try-get-membership conf-no)
      (and (not (lyskom-membership-is-read))
	   (let ((membership
		  (blocking-do 'query-read-texts lyskom-pers-no conf-no)))
	     (if (and membership (lyskom-visible-membership membership))
		 (lyskom-add-membership membership conf-no))
	     membership))))


Per Cederqvist's avatar
.  
Per Cederqvist committed
664
665
666
667
;;;; ================================================================
;;;;                   Scrolling and text insertion.


David Kågedal's avatar
David Kågedal committed
668
669
670
671
672
(defun lyskom-trim-buffer ()
  "Trim the size of a lyskom buffer to lyskom-max-buffer-size"
  (save-excursion
    (if (and kom-max-buffer-size
	     (> (buffer-size) kom-max-buffer-size))
673
674
	(let ((delchars (- (buffer-size) kom-max-buffer-size))
	      (inhibit-read-only t))
David Kågedal's avatar
David Kågedal committed
675
676
677
678
679
	  (goto-char (point-min))
	  (while (< (point) delchars)
	    (forward-line 1))
	  (delete-region (point-min) (point))))))

Per Cederqvist's avatar
.  
Per Cederqvist committed
680
681
682
683
684
685
686
687
688
689
690
(defun lyskom-scroll ()
  "Scroll screen if necessary.
The position lyskom-last-viewed will always remain visible."
  ;; Find a window to scroll. Scroll the selected window if that shows LysKOM.
  ;; Otherwise scroll any window currently showing LysKOM.
  (let ((win
	 (cond
	  ((eq (window-buffer (selected-window)) (current-buffer))
	   (selected-window))
	  (t				;(get-buffer-window (current-buffer))
	   nil))))
Lars Willför's avatar
Lars Willför committed
691
692
693
694
695
696
697
698
699
700
701
702
    (if (and win			;Do nothing if no window showed LysKOM.
	     (not (pos-visible-in-window-p (point-max))))
	(progn
	  (goto-char (point-max))
	  (recenter -1)
	  (if (not (pos-visible-in-window-p lyskom-last-viewed))
	      (progn
		(set-window-start win lyskom-last-viewed)
		(move-to-window-line -1)
		(vertical-motion 1)
		(if (not (pos-visible-in-window-p))
		    (forward-char -1))))))))
Per Cederqvist's avatar
.  
Per Cederqvist committed
703
704
705
706
	

(defun lyskom-insert (string)
  "Insert STRING last in current buffer.
707
708
709
710
Leaves the point at the end of the buffer if possible without
scrolling past lyskom-last-viewed (generally the most recent prompt.)
Leaves the point at the end of the window if not possible. If buffer
is not on screen then doesn't move point.
711
The text is converted according to the value of kom-emacs-knows-iso-8859-1."
David Kågedal's avatar
David Kågedal committed
712
713
714
  (let ((was-at-max (= (save-excursion (end-of-line) (point)) (point-max))))
    (save-excursion
      (goto-char (point-max))
715
      (let ((inhibit-read-only t))
716
	(insert string))
David Kågedal's avatar
David Kågedal committed
717
718
719
720
721
722
      (lyskom-trim-buffer))
    (let ((window (get-buffer-window (current-buffer))))
      (if (and window was-at-max)
	  (if (pos-visible-in-window-p (point-max) window)
	      (goto-char (point-max))
	    (and kom-continuous-scrolling (lyskom-scroll)))))))
723

Per Cederqvist's avatar
.  
Per Cederqvist committed
724

725
726
727
728
729
(defun lyskom-insert-at-point (string)
  "Insert STRING in the current buffer at point.
The text is converted according to the value of
kom-emacs-knows-iso-8859-1."
  (let ((buffer-read-only nil))
730
    (insert string))
731
732
  (lyskom-trim-buffer))  

Per Cederqvist's avatar
.  
Per Cederqvist committed
733
734
735
736

(defun lyskom-insert-before-prompt (string)
  "Insert STRING just before the prompt of if no prompt then just buffers.
If prompt on screen then do the scroll if necessary.
737
The strings buffered are printed before the prompt by lyskom-update-prompt."
738
739
740
741
742
743
744
745
746
747
748
749
  ;;
  ;; This is the policy for moving point:
  ;;
  ;; old-point-max is the point-max before the text is inserted
  ;; new-point-max is the point-max after the text is inserted
  ;;
  ;; If point /= old-point-max, leave the point where it is, and don't
  ;; scroll the window.
  ;;
  ;; If point = old-point-max, set it to new-point-max, and if the
  ;; buffer is in a window, make sure that point is visible.
  ;;
Per Cederqvist's avatar
.  
Per Cederqvist committed
750
751
  (cond
   ((and lyskom-executing-command
752
         (not (eq lyskom-is-waiting t)))
Per Cederqvist's avatar
Per Cederqvist committed
753
754
    ;; Don't insert the string until the current command is finished.
    (if (null lyskom-to-be-printed-before-prompt)
755
        (setq lyskom-to-be-printed-before-prompt (lyskom-queue-create)))
756
    (lyskom-queue-enter lyskom-to-be-printed-before-prompt 
757
                        (list string)))
758
   (t
759
760
    ;; For some reaseon save-excursion doesn't work as expected
    (let ((oldpoint (point-marker)))
Per Cederqvist's avatar
.  
Per Cederqvist committed
761
      (goto-char (point-max))
762
763
      (beginning-of-line)
      (let ((inhibit-read-only t))
764
	(insert string))
765
      (goto-char oldpoint))
766
767
768
769
    (let ((window (get-buffer-window (current-buffer))))
      (if (and window
	       (not (pos-visible-in-window-p (point) window)))
	  ;; This mease that the prompt has been pushed off the bottom
770
771
772
	  (save-selected-window
	    (select-window window)
	    (recenter -1)))))))
773
      
Per Cederqvist's avatar
.  
Per Cederqvist committed
774
775
776
777
778

(defun lyskom-message (format-string &rest args)
  "Like message, but converts iso-8859/1 texts to swascii if necessary.
Args: FORMAT-STRING &rest ARGS"
  (let ((str (apply 'format format-string args)))
779
    (message "%s" str)))
Per Cederqvist's avatar
.  
Per Cederqvist committed
780
781


782
783
784
785
(defun lyskom-error (format-string &rest args)
  "Like error, but converts iso-8859/1 texts to swascii if necessary.
Args: FORMAT-STRING &rest ARGS"
  (let ((str (apply 'format format-string args)))
786
    (error "%s" str)))
787
788


Lars Willför's avatar
Lars Willför committed
789
790
791
792
793
794
(defun lyskom-set-last-viewed ()
  (save-excursion
    (vertical-motion 0)
    (setq lyskom-last-viewed (point))))


Per Cederqvist's avatar
.  
Per Cederqvist committed
795
796
797
;;; ================================================================
;;;                  Extended string formatting

798
799
800
;;; Author: David Byers
;;; Original code: Inge Wallin

Per Cederqvist's avatar
.  
Per Cederqvist committed
801

802
803
804
(defvar lyskom-format-format
  "%\\(=\\)?\\(-?[0-9]+\\)?\\(#\\([0-9]+\\)\\)?\\(:\\)?\\([][@MmPpnrtsdoxc]\\)"
  "regexp matching format string parts.")
Per Cederqvist's avatar
.  
Per Cederqvist committed
805
806
807
808
809

(defun lyskom-insert-string (atom)
 "Find the string corresponding to ATOM and insert it into the LysKOM buffer." 
  (lyskom-insert (lyskom-get-string atom)))

810
811
812
813
814
815
816
817
818
819
;;(defun lyskom-get-string (atom &optional assoc-list)
;;  "Get the string corresponding to ATOM and return it."
;;  (if (stringp atom)
;;	atom
;;    (let ((format-pair (assoc atom (or assoc-list lyskom-strings))))
;;	(if (null format-pair)
;;	    (signal 'lyskom-internal-error 
;;		    (list 'lyskom-get-string
;;			  (list atom ": string not found")))
;;	  (cdr format-pair)))))
820
821
822


(defun lyskom-format (format-string &rest argl)
823
  (format-state->result (lyskom-do-format format-string argl)))
824
825

(defun lyskom-format-insert (format-string &rest argl)
826
827
  "Format and insert a string according to FORMAT-STRING.
The string is inserted at the end of the buffer with `lyskom-insert'."
828
  (let* ((state (lyskom-do-format format-string argl t))
David Kågedal's avatar
David Kågedal committed
829
830
831
	 ;; We have to use a marker, because lyskom-insert may trim
	 ;; the buffer size.
	 (start (point-max-marker))
832
	 (deferred (format-state->delayed-content state)))
833
    (lyskom-insert (format-state->result state))
834
835
836
837
838
839
    (while deferred
      (let ((defer-info (car deferred))
	    (m (make-marker)))
	(set-marker m (+ start (defer-info->pos defer-info)))
	(set-defer-info->pos defer-info m)			     
	(lyskom-defer-insertion defer-info)
David Kågedal's avatar
David Kågedal committed
840
841
	(setq deferred (cdr deferred))))
    (set-marker start nil)))
842

843
844
845
846
847
(defun lyskom-format-insert-at-point (format-string &rest argl)
  "Format and insert a string according to FORMAT-STRING.
The string is inserted at point."
  (let* ((state (lyskom-do-format format-string argl t))
	 (start (point))
848
	 (deferred (format-state->delayed-content state)))
849
    (lyskom-insert-at-point (format-state->result state))
850
851
852
853
854
855
856
    (while deferred
      (let ((defer-info (car deferred))
	    (m (make-marker)))
	(set-marker m (+ start (defer-info->pos defer-info)))
	(set-defer-info->pos defer-info m)			     
	(lyskom-defer-insertion defer-info)
	(setq deferred (cdr deferred))))))
857

858
(defun lyskom-format-insert-before-prompt (format-string &rest argl)
David Kågedal's avatar
David Kågedal committed
859
860
861
862
863
864
865
866
  "Format and insert a string according to FORMAT-STRING.
The string is inserted just before the prompt, and if the prompt is not
currently visible the text is queued to be inserted when the prompt
reappears.

Note that it is not allowed to use deferred insertions in the text."
  (lyskom-insert-before-prompt
   (format-state->result (lyskom-do-format format-string argl))))
867
868


David Kågedal's avatar
David Kågedal committed
869
(defun lyskom-do-format (format-string &optional argl allow-defer)
870
  "Do the actual formatting and return the resulting format-state."
871
872
873
874
875
876
877
878
  (let ((fmt (cond ((stringp format-string) format-string)
		   ((symbolp format-string) (lyskom-get-string 
					     format-string))))
	(state nil))
    (if (null fmt)
        (signal 'lyskom-internal-error (list 'lyskom-format-insert
                                             ": bad format string"))
      (save-excursion
David Kågedal's avatar
Bugfix    
David Kågedal committed
879
880
        (if (and (boundp 'lyskom-buffer)
		 lyskom-buffer)
David Kågedal's avatar
David Kågedal committed
881
            (set-buffer lyskom-buffer))
David Kågedal's avatar
David Kågedal committed
882
883
884
885
886
	(condition-case error
	    (setq state (lyskom-format-aux (make-format-state
					    fmt
					    0
					    argl
887
					    "")
David Kågedal's avatar
David Kågedal committed
888
					   allow-defer))
David Kågedal's avatar
David Kågedal committed
889
890
891
	  (lyskom-format-error
	   (error "LysKOM internal error formatting %s: %s%s"
		  format-string (nth 1 error) (nth 2 error))))))
892
    state))
893
894
895
896
897





David Kågedal's avatar
David Kågedal committed
898
(defun lyskom-format-aux (format-state allow-defer)
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
  (let ((format-length (length (format-state->format-string format-state)))
        (arg-no nil)
        (pad-length nil)
        (format-letter nil)
        (colon-flag nil)
        (equals-flag nil)
        (abort-format nil))

    ;;
    ;;  Eat the format string bit by bit
    ;;

    (while (and (not abort-format)
                (< (format-state->start format-state)
                   format-length))

      ;;
      ;;    Look for a format letter. If there is none, finish up,
      ;;    otherwise handle each letter separately
      ;;

      (if (null (string-match lyskom-format-format
                              (format-state->format-string format-state)
                              (format-state->start format-state)))
          (progn
            (set-format-state->result 
             format-state
             (concat (format-state->result format-state)
                     (substring (format-state->format-string format-state)
                                (format-state->start format-state))))
            (set-format-state->start format-state
                                     (length (format-state->format-string
                                              format-state))))

        ;;
        ;; A format letter has been found
        ;;

        (set-format-state->result 
         format-state
         (concat (format-state->result format-state)
                 (substring (format-state->format-string format-state)
                            (format-state->start format-state)
                            (match-beginning 0))))

        (set-format-state->start format-state
                                 (match-end 0))

	(setq equals-flag (match-beginning 1)
948
949
950
951
952
953
954
	      pad-length (if (match-beginning 2)
			     (string-to-int (substring 
					     (format-state->format-string
					      format-state)
					     (match-beginning 2)
					     (match-end 2)))
			   nil)
955
	      arg-no (if (match-beginning 4)
956
957
958
959
960
			 (string-to-int (substring (format-state->format-string
						    format-state)
						   (match-beginning 4)
						   (match-end 4)))
		       nil)
961
962
	      colon-flag (match-beginning 5)
	      format-letter (if (match-beginning 6)
963
964
965
966
967
968
969
				(aref (format-state->format-string 
				       format-state)
				      (match-beginning 6))
			      (signal 'lyskom-internal-error
				      (list 'lyskom-format-aux 
					    (format-state->format-string
					     format-state)))))
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993

    ;;
    ;;  If the format letter is an end-of-group letter, abort
    ;;  formatting and return to the caller.
    ;;

	(if (= ?\] format-letter)
	    (progn 
	      (setq abort-format t)
	      (set-format-state->start format-state (match-end 0)))

	  (setq format-state 
            (lyskom-format-aux-help 
             format-state
             pad-length
             arg-no
             format-letter
             equals-flag
             colon-flag
             (if (and (match-beginning 2)
                      (eq (aref (format-state->format-string format-state)
                                (match-beginning 2))
                          ?0))
                 ?0
994
               ? )
David Kågedal's avatar
David Kågedal committed
995
	     allow-defer))))))
996
997
998
999
1000
  (lyskom-tweak-format-state format-state))


(defun lyskom-format-aux-help (format-state
                               pad-length
For faster browsing, not all history is shown. View entire blame