lyskom-rest.el 166 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
39
40
41
42
43
44
45
;;;; ================================================================
;;;; ================================================================
;;;;
;;;; 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
46
47
;;;;    David K}gedal
;;;;    David Byers
Per Cederqvist's avatar
.  
Per Cederqvist committed
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
;;;;   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.
;;;;

78
79
80
81
(eval-when-compile
  (require 'lyskom-command "command")
  (require 'lyskom-menus "menus")
  (require 'lyskom-clienttypes "clienttypes.el"))
David Kågedal's avatar
David Kågedal committed
82
83


84
85
86
87
(setq lyskom-clientversion-long 
      (concat lyskom-clientversion-long
	      "$Id$\n"))

88
89
(lyskom-external-function find-face)

90

Per Cederqvist's avatar
.  
Per Cederqvist committed
91
92
93
94
95
96
97
;;;; ================================================================
;;;;                             New errors.


(put 'lyskom-protocol-error 'error-conditions
     '(error lyskom-error lyskom-protocol-error))
(put 'lyskom-protocol-error 'error-message
98
     "LysKOM protocol error")
Per Cederqvist's avatar
.  
Per Cederqvist committed
99
100
101
102

(put 'lyskom-internal-error 'error-conditions
     '(error lyskom-error lyskom-internal-error))
(put 'lyskom-internal-error 'error-message
103
     "Internal LysKOM error")
Per Cederqvist's avatar
.  
Per Cederqvist committed
104

David Kågedal's avatar
David Kågedal committed
105
(put 'lyskom-format-error 'error-conditions
David Byers's avatar
David Byers committed
106
    '(error lyskom-error lyskom-format-error))
David Kågedal's avatar
David Kågedal committed
107
(put 'lyskom-internal-error 'error-message
108
     "Internal LysKOM format error")
David Kågedal's avatar
David Kågedal committed
109

David Byers's avatar
David Byers committed
110
111
112
113
114
(put 'lyskom-error 'error-conditions
     '(error))
(put 'lyskom-error 'error-message
     "LysKOM error")

Per Cederqvist's avatar
.  
Per Cederqvist committed
115

116
117
118
119
120
;;; ================================================================
;;;             Global variables
;;;

(defvar lyskom-unread-mode-line nil)
121
(defvar lyskom-unread-title-format nil)
122

Per Cederqvist's avatar
.  
Per Cederqvist committed
123
124
125
126
127
128
129
130
;;; ================================================================
;;;             Error reporting from a number of commands.
;;;

;;; Author: Inge Wallin



David Byers's avatar
David Byers committed
131
(defun lyskom-get-error-text (errno &optional error-descriptions)
Per Cederqvist's avatar
.  
Per Cederqvist committed
132
  "Get a string which is the error ERRNO in plain text."
David Byers's avatar
David Byers committed
133
134
135
136
137
138
139
  (let ((custom-error
         (or (cdr (assq errno error-descriptions))
             (cdr (assq (car (rassq errno lyskom-error-codes))
                        error-descriptions)))))
    (if custom-error
        (lyskom-get-string custom-error)
      (or
140
141
142
       (lyskom-try-get-string (intern (concat "error-"
                                              (number-to-string errno)))
                              'lyskom-error-texts)
David Byers's avatar
David Byers committed
143
144
145
       (lyskom-format 'error-not-found errno)))))

(defun lyskom-report-command-answer (answer &optional errno error-descriptions)
Per Cederqvist's avatar
.  
Per Cederqvist committed
146
147
148
149
  "Handles a void return from call to the server."
  (if answer 
      (lyskom-insert-string 'done)
    (lyskom-insert-string 'nope)
David Byers's avatar
David Byers committed
150
    (lyskom-insert-error errno nil error-descriptions))
David Byers's avatar
David Byers committed
151
  answer)
Per Cederqvist's avatar
.  
Per Cederqvist committed
152

David Byers's avatar
David Byers committed
153
(defun lyskom-insert-error (&optional errno err-stat error-descriptions)
Per Cederqvist's avatar
Per Cederqvist committed
154
155
156
  "Insert an error message describing ERRNO and ERR-STAT.
If ERRNO and ERR-STAT are not supplied, use lyskom-errno and
lyskom-err-stat instead.  If only ERRNO is supplied, use the empty
David Byers's avatar
David Byers committed
157
158
159
160
161
string for ERR-STAT.

If ERROR-DESCRIPTIONS is supplied, it should be an alist with error numbers
as the cars and error descriptions (symbols) as the cdr. The symbol will
be used to get a description of the corresponding error."
Per Cederqvist's avatar
Per Cederqvist committed
162
  (lyskom-format-insert 'error-code
David Byers's avatar
David Byers committed
163
164
165
166
                        (lyskom-get-error-text (or errno lyskom-errno)
                                               error-descriptions)
                        (or errno lyskom-errno)
                        (or err-stat (if errno "" lyskom-err-stat))))
Per Cederqvist's avatar
Per Cederqvist committed
167

168
169
(defun lyskom-current-error ()
  "Return a string describing the current error"
Per Cederqvist's avatar
Per Cederqvist committed
170
171
172
173
  (lyskom-format 'error-code
		 (lyskom-get-error-text lyskom-errno)
		 lyskom-errno
		 lyskom-err-stat))
174

Per Cederqvist's avatar
.  
Per Cederqvist committed
175
176
177
178
179
180

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

(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
181
182
183
  ;; 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
184
185
186
187
188
189
  (lyskom-tell-server (lyskom-tell-string key)))



;;; Resume operation after a crash.

David Kågedal's avatar
David Kågedal committed
190
191
(defun kom-recover (&optional refetch)
  "Try to recover from an error.
192
If the optional argument REFETCH is non-nil, all caches are cleared and
David Byers's avatar
David Byers committed
193
194
195
196
`lyskom-refetch' is called. Note that when called interactively, 
REFETCH is always non-nil, regardless of the prefix argument. This is
by design."
  (interactive (list t))
David Kågedal's avatar
Bugfix    
David Kågedal committed
197
  (lyskom-init-parse lyskom-buffer)
Per Cederqvist's avatar
.  
Per Cederqvist committed
198
199
  (setq lyskom-call-data nil)
  (setq lyskom-pending-calls nil)
David Kågedal's avatar
David Kågedal committed
200
201
202
203
204
  (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
205
206
  (setq lyskom-number-of-pending-calls 0)
  (setq lyskom-is-parsing nil)
207
208
209
  (when refetch
    (clear-all-caches)
    (lyskom-refetch))
Per Cederqvist's avatar
.  
Per Cederqvist committed
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
  (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
225
	(goto-char (point-max))
Per Cederqvist's avatar
.  
Per Cederqvist committed
226
	(recenter 0)
227
        (sit-for 0)                     ; FIXME: emacs-21.0.94 workaround
Lars Willför's avatar
Lars Willför committed
228
	(lyskom-next-command))
Per Cederqvist's avatar
.  
Per Cederqvist committed
229
    (recenter 0)
230
    (sit-for 0)                     ; FIXME: emacs-21.0.94 workaround
Per Cederqvist's avatar
.  
Per Cederqvist committed
231
    (move-to-window-line -1)
Lars Willför's avatar
Lars Willför committed
232
    (lyskom-set-last-viewed)))
Per Cederqvist's avatar
.  
Per Cederqvist committed
233
234


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

(defun kom-next-command ()
  "Run next command or scroll one page."
  (interactive)
Lars Willför's avatar
Lars Willför committed
240
241
242
243
  (if (pos-visible-in-window-p (point-max))
      (lyskom-next-command)
    (move-to-window-line -1)
    (lyskom-set-last-viewed)
244
245
    (lyskom-scroll)
    (if (< (window-start) lyskom-last-viewed)
David Byers's avatar
David Byers committed
246
247
248
249
250
251
252
        (lyskom-xemacs-or-gnu
         (let ((overlay (make-extent 
                         lyskom-last-viewed
                         (save-excursion (goto-char lyskom-last-viewed)
                                         (end-of-line)
                                         (forward-char 1)
                                         (point)))))
253
           (set-extent-priority overlay 1000)
254
           (set-extent-face overlay kom-mark-face)
David Byers's avatar
David Byers committed
255
256
257
258
259
260
261
262
263
           (add-timeout 2 
                        'delete-extent
                        overlay))
         (let ((overlay (make-overlay 
                         lyskom-last-viewed
                         (save-excursion (goto-char lyskom-last-viewed)
                                         (end-of-line)
                                         (forward-char 1)
                                         (point)))))
264
           (overlay-put overlay 'face kom-mark-face)
265
           (overlay-put overlay 'priority 1000)
David Byers's avatar
David Byers committed
266
267
268
           (run-at-time 2 nil
                        'delete-overlay
                        overlay))))))
Per Cederqvist's avatar
.  
Per Cederqvist committed
269
270
271
272
273

  
(defun kom-line-next-command ()
  "Run next command or scroll one line."
  (interactive)
Lars Willför's avatar
Lars Willför committed
274
275
276
277
278
  (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
279
280


281
282
;;; Author: Per Cederqvist

Lars Willför's avatar
Lars Willför committed
283
(defun lyskom-next-command ()
284
  "Run next command."
David Byers's avatar
David Byers committed
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
  (let ((saved-buffer (current-buffer)))
    (unwind-protect 
        (progn
          (setq lyskom-doing-default-command t)
          (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 'reedit-text)
            (kom-re-edit-next-text))
           ((eq lyskom-command-to-do 'next-pri-session)
            (kom-go-to-pri-session))
           ((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
               ((or (stringp command)
                    (vectorp command))
                (execute-kbd-macro command))
               ((commandp command) (call-interactively command))
               (t (lyskom-start-of-command nil) (lyskom-end-of-command)))))
           ((eq lyskom-command-to-do 'unknown)
            (lyskom-insert
             (lyskom-get-string 'wait-for-server)))
           (t (signal 'lyskom-internal-error '(kom-next-command)))))
      (condition-case nil
          (save-excursion
            (set-buffer saved-buffer)
            (setq lyskom-doing-default-command nil))
        (error nil)))))
Per Cederqvist's avatar
.  
Per Cederqvist committed
319
320
321
322
323
324
325
326


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


(defun kom-initial-digit-view ()
  (interactive)
327
328
  (setq unread-command-events (cons last-command-event
                                    unread-command-events))
Per Cederqvist's avatar
.  
Per Cederqvist committed
329
330
331
332
333
334
  (call-interactively 'kom-view nil))


(defun kom-view (text-no)
  "View text number TEXT-NO."
  (interactive "P")
335
336
337
338
  (unwind-protect
      (progn
	(let ((kom-page-before-command nil))
	  (lyskom-start-of-command 'kom-view)
339
	  (lyskom-tell-internat 'kom-tell-review))
340
	(unless (and (null current-prefix-arg)
Johan Sundström's avatar
Johan Sundström committed
341
		     (lyskom-plusp text-no))
342
343
	  (let ((current-prefix-arg text-no))
	    (setq text-no (lyskom-read-text-no-prefix-arg 'review-text-q))))
344
345

        (cond (text-no
346
347
348
349
350
               (when (or (not (listp kom-page-before-command))
                         (memq 'kom-view kom-page-before-command))
                 (recenter 1)
                 (sit-for 0)                     ; FIXME: emacs-21.0.94 workaround
                 )
351
352
               (lyskom-tell-internat 'kom-tell-review)
               (lyskom-format-insert 'review-text-no text-no)
353
354
               (unless kom-review-uses-cache
                 (cache-del-text-stat text-no))
355
356
               (lyskom-view-text text-no))
              (t (lyskom-insert 'confusion-what-to-view))))
357
    (lyskom-end-of-command)))
Per Cederqvist's avatar
.  
Per Cederqvist committed
358

359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
(defun kom-initial-digit-unread ()
  (interactive)
  (setq unread-command-events (cons last-command-event
                                    unread-command-events))
  (call-interactively 'kom-mark-unread nil))

(def-kom-command kom-mark-unread (text-no)
  "MAke a single text unread. This command is functional only on servers
that support making text unread."
  (interactive (list (lyskom-read-text-no-prefix-arg 'unread-text-q)))
  (lyskom-format-insert 'marking-text-unread text-no)
  (lyskom-report-command-answer (lyskom-mark-unread text-no)))

(defun lyskom-mark-unread (text-no)
  "Mark text TEXT-NO in all conferences.
Returns non-nil if successful."
  (let ((text-stat (blocking-do 'get-text-stat text-no))
David Byers's avatar
David Byers committed
376
        (marked-unread nil))
377
    (and text-stat
David Byers's avatar
David Byers committed
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
         (let ((result
                (lyskom-traverse misc-info (text-stat->misc-info-list text-stat)
                  (when (memq (misc-info->type misc-info) lyskom-recpt-types-list)
                    (let* ((mship (lyskom-get-membership (misc-info->recipient-no misc-info)))
                           (recipient (and mship (blocking-do 'get-conf-stat (misc-info->recipient-no misc-info)))))
                      (when (and mship recipient)
                        (if (not (blocking-do 'mark-as-unread
                                              (misc-info->recipient-no misc-info)
                                              (misc-info->local-no misc-info)))
                            (lyskom-traverse-break 'error)
                          (when (lyskom-visible-membership mship)
                            (setq marked-unread t)
                            (unless (read-list-enter-text text-no 
                                                          recipient
                                                          lyskom-to-do-list)
                              (let ((info (lyskom-create-read-info
                                           'CONF
                                           recipient
                                           (membership->priority mship)
                                           (lyskom-create-text-list (list text-no)))))
                                (read-list-enter-read-info info lyskom-to-do-list)
                                (if (= lyskom-current-conf (conf-stat->conf-no recipient))
                                    (read-list-enter-read-info info lyskom-reading-list))))))))))))
           (cond (result nil)
                 (marked-unread t)
                 (t (setq lyskom-errno -1)
                    nil))))))

406

Per Cederqvist's avatar
.  
Per Cederqvist committed
407

David Byers's avatar
David Byers committed
408
409
410
411
;;;; ================================================================
;;;;                          Re-edit text

(def-kom-command kom-re-edit-next-text ()
412
413
414
  "Display a buffer containing a failed text submission. This pseudo
command is only invoked from the prompt after submission of a text
failed."
David Byers's avatar
David Byers committed
415
416
417
418
419
420
421
422
  (interactive)
  (let ((el (read-list->first lyskom-reading-list)))
    (set-read-list-del-first lyskom-reading-list)
    (if (buffer-live-p (read-info->misc el))
        (lyskom-display-buffer (read-info->misc el))
      (lyskom-format-insert 'text-buffer-missing))))


423
424
425
426
;;;; ================================================================
;;;;                        Go to pri session

(def-kom-command kom-go-to-pri-session ()
427
428
429
430
431
432
  "Go to a prioritized session with unreads. This pseudo command is
generally invoked frmo the prompt when there is a session with unread
texts that has a higher priority than the current session.

See `kom-server-priority' and `kom-server-priority-breaks' for
settings to control session priorities."
433
434
435
436
437
438
439
440
441
  (interactive)
  (let ((session (lyskom-get-prioritized-session)))
    (if (or (null session)
            (eq session (current-buffer))
            (not (buffer-live-p session)))
        (lyskom-insert 'no-such-kom-session)
      (lyskom-switch-to-kom-buffer session))))


Per Cederqvist's avatar
.  
Per Cederqvist committed
442
443
444
445
446
447
448
449
450
451
452
453
454
;;;; ================================================================
;;;;                         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 
455
	 ((memq type lyskom-review-types-list)
Per Cederqvist's avatar
.  
Per Cederqvist committed
456
	  (read-list-rotate lyskom-reading-list))
457
	 ((memq type lyskom-comment-types-list)
Per Cederqvist's avatar
.  
Per Cederqvist committed
458
459
460
461
462
463
464
	  (set-read-list-del-first lyskom-reading-list))
	 (t 
	  (setq finished t))))
      (-- len)))
  (kom-view-next-text))


465
466
;;; Modified to handle filters

David Kågedal's avatar
David Kågedal committed
467
(def-kom-command kom-view-next-text ()
468
  "Display the next unread text. This is the most common default command."
Per Cederqvist's avatar
.  
Per Cederqvist committed
469
  (interactive)
David Kågedal's avatar
David Kågedal committed
470
471
472
473
474
475
476
477
478
  (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))
479
	      
David Kågedal's avatar
David Kågedal committed
480
481
	(progn
	  (let* ((tri (read-list->first lyskom-reading-list))
David Byers's avatar
David Byers committed
482
		 (text-no (car (text-list->texts (read-info->text-list tri))))
David Kågedal's avatar
David Kågedal committed
483
484
485
		 (type (read-info->type tri))
		 (priority (read-info->priority
			    (read-list->first lyskom-reading-list)))
486
		 (is-review-tree (memq type '(REVIEW-TREE)))
David Byers's avatar
David Byers committed
487
		 (is-review (or (memq type '(REVIEW REVIEW-MARK REVIEW-FAQ))
David Kågedal's avatar
David Kågedal committed
488
489
				is-review-tree))
		 (mark-as-read (not is-review)))
490
	    (when (or is-review (eq type 'REVIEW-FAQ-TREE))
David Byers's avatar
David Byers committed
491
492
493
494
              (set-text-list->texts
               (read-info->text-list tri)
               (delq text-no (text-list->texts 
                              (read-info->text-list tri)))) ;First entry only
495
496
              (unless kom-review-uses-cache
                (cache-del-text-stat text-no)))
David Kågedal's avatar
David Kågedal committed
497
498
499
500
501
502
503
504
505
	    (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
506
				    (not is-review)
507
				    (memq type '(REVIEW REVIEW-MARK))))
David Kågedal's avatar
David Kågedal committed
508
509
510
511
	    (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))))))))
512
  
Per Cederqvist's avatar
.  
Per Cederqvist committed
513

514
;;; Modified to handle filters
Per Cederqvist's avatar
.  
Per Cederqvist committed
515

David Kågedal's avatar
David Kågedal committed
516
;; This is horribly ugly. It acts like a user command, but it isn't.
Per Cederqvist's avatar
.  
Per Cederqvist committed
517
(defun lyskom-view-priority-text ()
David Byers's avatar
David Byers committed
518
519
520
  "Display the first text from the next conference on the lyskom-to-do-list.

Cannot be called from a callback."
Per Cederqvist's avatar
.  
Per Cederqvist committed
521
  (lyskom-start-of-command 'kom-view-next-text)
David Kågedal's avatar
David Kågedal committed
522
523
524
525
526
527
528
529
530
531
532
533
  (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
534
535
536


(defun lyskom-is-read (text-no)
Per Cederqvist's avatar
Per Cederqvist committed
537
  "Remove TEXT-NO from the list of texts to read.
Per Cederqvist's avatar
.  
Per Cederqvist committed
538
Deletes TEXT-NO from lyskom-reading-list and lyskom-to-do-list.
Per Cederqvist's avatar
Per Cederqvist committed
539
540
541
Adds info in lyskom-membership.

This function only modifies the internal state of the client. It does
Per Cederqvist's avatar
Per Cederqvist committed
542
543
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
544
545
  (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
546
  (initiate-get-text-stat 'main 'lyskom-is-read-handler text-no)
547
  (setq lyskom-normally-read-texts (cons text-no lyskom-normally-read-texts)))
Per Cederqvist's avatar
.  
Per Cederqvist committed
548
549
550
551
552


(defun lyskom-is-read-handler (text-stat)
  "Update lyskom-membership for all recipients to TEXT-STAT."
  (lyskom-traverse
553
      misc (text-stat->misc-info-list text-stat)
554
    (if (memq (misc-info->type misc) '(RECPT BCC-RECPT CC-RECPT))
555
556
	(let ((membership (lyskom-try-get-membership
			   (misc-info->recipient-no misc))))
557
558
559
560
561
	  (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
562
563
564
565
566
567


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


568
(def-kom-command kom-go-to-next-conf (&optional num)
569
570
571
572
573
574
  "Go to next conference with unread texts. The current conference is
moved to the end of the list of conferences with unread texts. A
numeric prefix argument is interpreted similar to in `kom-list-news':
with a positive argument go to the next conference with at least that
many unread. With a negative number, go to a conference with at most
that many unread texts."
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
  (interactive "P")
  (let ((conf-stat nil)
	(num-arg (cond
		  ((numberp num) num)
		  ((and (listp num)
			(numberp (car num))) (car num))
		  (t nil))))
    (when num-arg
      (let ((read-list (cdr (lyskom-list-news)))
	    (msgs-conf nil)
	    (unreads   nil)
	    (at-least  (if  (< num-arg 0) 1 num-arg))
	    (at-most   (and (< num-arg 0) (- num-arg))))
	(while (and read-list (null conf-stat))
	  (setq msgs-conf (car read-list))
	  (setq read-list (cdr read-list))
	  (setq unreads (car msgs-conf))
	  (when (and (>= unreads at-least) ; unreads within lower bound
		     (or (not at-most)
			 (<= unreads at-most))) ; unreads within upper bound
	    (setq conf-stat (cdr msgs-conf))))))
    (if (and num-arg (null conf-stat))
	(lyskom-insert-string 'no-unreads-shown)
      (when (lyskom-check-go-to-conf conf-stat)
	(lyskom-maybe-move-unread t)
	(if conf-stat
	    (lyskom-go-to-conf conf-stat)
	  (lyskom-go-to-next-conf))))))
Per Cederqvist's avatar
.  
Per Cederqvist committed
603
604
605
606
607
608
609


(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)
610
611
612
613
  (when (lyskom-check-go-to-conf)
    (lyskom-maybe-move-unread nil)
    (lyskom-go-to-next-conf)
    (lyskom-end-of-command)))
Per Cederqvist's avatar
.  
Per Cederqvist committed
614
615
616
617
618
619


(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))
620
621
      (let ((conf-stat (read-info->conf-stat 
                        (read-list->first lyskom-to-do-list))))
622
623
624
625
626
627
628
        (if conf-stat
            (progn (lyskom-set-mode-line conf-stat)
                   (read-list-enter-first
                    (read-list->first lyskom-to-do-list)
                    lyskom-reading-list)
                   (lyskom-enter-conf conf-stat 
                                      (read-list->first lyskom-to-do-list)))
629
630
          (read-list-enter-first
           (read-list->first lyskom-to-do-list)
631
           lyskom-reading-list)))
Per Cederqvist's avatar
.  
Per Cederqvist committed
632
    (lyskom-insert-string 'all-conf-unread-r)
633
    (lyskom-set-mode-line (lyskom-get-string 'all-conf-unread-s))))
Per Cederqvist's avatar
.  
Per Cederqvist committed
634
635


636
(defun lyskom-maybe-move-unread (bury)
Linus Tolke's avatar
Linus Tolke committed
637
  "Empty the reading list.
638
If the argument BURY is non-nil and there are unread articles left in the
Linus Tolke's avatar
Linus Tolke committed
639
reading list then the conf is inserted last in the to do list."
Per Cederqvist's avatar
.  
Per Cederqvist committed
640
641
  (if (not (read-list-isempty lyskom-reading-list))
      (progn
642
	(if bury
Per Cederqvist's avatar
.  
Per Cederqvist committed
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
	    (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))))


664
665
666
667
668
669
670
671
672
673
(defun lyskom-check-go-to-conf (&optional conf)
  "Check if it is OK to go to conf CONF (a conf-stat).
It is assumed that lyskom-pers-no is a member of the conference.
This function interacts with the buffer and the user.

If CONF is nil, check the first conf on the to-do list."
  (let* ((conf-stat (or conf
                        (read-info->conf-stat 
                         (read-list->first lyskom-to-do-list))))
         (mship (and conf-stat 
David Byers's avatar
David Byers committed
674
                     (lyskom-get-membership (conf-stat->conf-no conf-stat) t)))
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
         (type nil)
         (continue t))
    (when (and conf-stat mship)
      (setq type (membership->type mship))

      (when (membership-type->invitation type)
        ;;; State the invitation,give the user a chance to accept it
        ;;; Leave the conf if the user does not want it
        (lyskom-format-insert 'your-invited
                              conf-stat
                              (membership->created-by mship))
        (if (lyskom-j-or-n-p (lyskom-get-string 'accept-invitation))
            (progn
              (set-membership-type->invitation type nil)
              (initiate-set-membership-type 'main
                                            nil
                                            lyskom-pers-no
                                            (conf-stat->conf-no conf-stat)
                                            (membership->type mship))
694
695
696
697
698
699
700
701
              (lyskom-add-member-answer
               (lyskom-try-add-member conf-stat
                                      (blocking-do 'get-conf-stat lyskom-pers-no)
                                      (blocking-do 'get-pers-stat lyskom-pers-no)
                                      nil
                                      'change-priority-for 
                                      t)
               conf-stat (blocking-do 'get-conf-stat lyskom-pers-no)
David Byers's avatar
David Byers committed
702
703
               (setq continue t))
              (lp--update-buffer (conf-stat->conf-no conf-stat)))
704
          (progn
David Byers's avatar
David Byers committed
705
            (let ((kom-unsubscribe-makes-passive nil))
706
              (lyskom-sub-member (blocking-do 'get-conf-stat lyskom-pers-no)
707
                                 conf-stat))
708
709
710
            (setq continue nil)
            )))

711
      (when (and continue (membership-type->secret type))
712
713
        (lyskom-format-insert-before-prompt 'bug-secret-mship conf-stat))

714
      (when (and continue (membership-type->passive type))
715
716
717
718
719
720
721
        ;;; Offer the user a chance to become an active member
        ;;; If the offer is refused, boot the user off the conference
        (lyskom-format-insert 'enter-passive conf-stat)
        (setq continue nil)
        (if (lyskom-j-or-n-p (lyskom-format 'convert-passive conf-stat))
            (progn
              (set-membership-type->passive type nil)
722
723
724
725
              (set-membership-type->message-flag
               type
               (lyskom-j-or-n-p (lyskom-format 'set-message-flag-q
                                               conf-stat)))
726
727
728
729
730
              (blocking-do 'set-membership-type
                           lyskom-pers-no
                           (conf-stat->conf-no conf-stat)
                           (membership->type mship))
              (lyskom-fetch-start-of-map conf-stat mship)
David Byers's avatar
David Byers committed
731
              (lp--update-buffer (conf-stat->conf-no conf-stat))
732
733
734
735
              (setq continue t))
          (progn
            (setq continue nil))))
      )
David Byers's avatar
David Byers committed
736

737
738
739
    ;;; Return the result
    continue))

740
741
742
743
744
745
(defun lyskom-reject-recommendation (conf-no)
  "Record that we have rejected an invitation to CONF-NO 
by PERS-NO"
  (unless (lyskom-recommendation-already-rejected conf-no)
    (setq lyskom-rejected-recommendations
          (cons conf-no lyskom-rejected-recommendations))
746
747
748
749
750
751
752
753
754
    (initiate-modify-conf-info 
     'background
     nil
     lyskom-pers-no
     nil
     (list (lyskom-create-aux-item 0 10001 nil nil
                                   (lyskom-create-aux-item-flags nil nil t nil
                                                                 nil nil nil nil)
                                   0
755
                                   (format "%d" conf-no))))))
756

757
758
759
(defun lyskom-recommendation-already-rejected (conf-no)
  "Return non-nil if we have rejected recommendation for CONF-NO"
  (member conf-no lyskom-rejected-recommendations))
760

761
762
763
(defun lyskom-update-rejected-recommendations ()
  "Update the list of rejected recommendations"
  (setq lyskom-rejected-recommendations nil)
764
765
766
767
768
  (let* ((conf-stat (blocking-do 'get-conf-stat lyskom-pers-no))
         (aux-list (and conf-stat (lyskom-get-aux-item
                                   (conf-stat->aux-items conf-stat) 
                                   10001))))
    (lyskom-traverse item aux-list
769
770
771
772
      (when (string-match "^\\([0-9]+\\)" (aux-item->data item))
        (setq lyskom-rejected-recommendations
              (cons (string-to-int (match-string 1 (aux-item->data item)))
                    lyskom-rejected-recommendations))))))
773
774
775
776
777
778

(defun lyskom-startup-check-recommended-memberships ()
  "Create invitations for new membership recommendations"
  (let ((recommendations 
         (filter-list
          (lambda (rec)
779
            (not (lyskom-recommendation-already-rejected (car rec))))
780
781
782
783
784
          (mapcar (lambda (aux)
                    (when (string-match "^\\([0-9]+\\)\\( [0-9]+\\)?\\( [01]+\\)?" (aux-item->data aux))
                      (let* ((conf-no (string-to-int (match-string 1 (aux-item->data aux))))
                             (priority (and conf-no (match-string 2) (string-to-int (match-string 2 (aux-item->data aux)))))
                             (mship-type (and priority (match-string 3) (match-string 3 (aux-item->data aux)))))
785
                        (list conf-no priority mship-type (aux-item->creator aux)))))
786
787
788
789
790
791
792
793
794
795
796
797
                  (lyskom-get-aux-item (server-info->aux-item-list
                                        lyskom-server-info) 29))))
        (collector (make-collector)))
    ;; At this point RECOMMENDATIONS contains a list with one element
    ;; per previously not rejected conference membership recommendations
    ;; (including the ones we are actually members of).

    (lyskom-traverse rec recommendations
      (initiate-query-read-texts 'main
                                 'collector-push
                                 lyskom-pers-no
                                 (car rec)
798
                                 nil 0
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
                                 collector))
    (lyskom-wait-queue 'main)

    ;; Now delete recommendations that we are already members of

    (lyskom-traverse mship (collector->value collector)
      (when mship
        (setq recommendations
              (delq (assq (membership->conf-no mship) recommendations)
                    recommendations))))

    ;; At this point recommendations contains only the conferences
    ;; that we have not rejected and that we are not already members
    ;; of.

814
815
    (blocking-do-multiple ((pers-conf-stat (get-conf-stat lyskom-pers-no))
                           (pers-stat (get-pers-stat lyskom-pers-no)))
816
      (lyskom-traverse rec recommendations
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
        (let ((conf-stat (blocking-do 'get-conf-stat (elt rec 0))))
          (when conf-stat
            (lyskom-format-insert 'has-recommended-conf
                                  (elt rec 3)
                                  (elt rec 0))
            (if (lyskom-j-or-n-p
                 (lyskom-format 'accept-recommendation (elt rec 0)))
                (let ((kom-membership-default-priority
                       (if (elt rec 1) 'ask kom-membership-default-priority)))
                  (lyskom-add-member-answer
                   (lyskom-try-add-member conf-stat
                                          pers-conf-stat
                                          pers-stat
                                          (lyskom-create-membership-type
                                           nil nil nil nil nil nil nil nil)
                                          'accepting-recommendation
                                          t
                                          (elt rec 1))
                   conf-stat
                   pers-conf-stat))
              (lyskom-reject-recommendation (elt rec 0)))))))))

839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
(defun lyskom-clean-read-faqs (pers-no)
  "Remove all read-faq aux-items from PERS-NO that correspond to texts
that are no longer FAQs or are missing."
  (let ((conf-stat (blocking-do 'get-conf-stat pers-no)))
    (when conf-stat
      (lyskom-traverse item (lyskom-get-aux-item (conf-stat->aux-items conf-stat)
                                                 10000)
        (when (string-match "^\\([0-9]+\\) \\([0-9]+\\)" (aux-item->data item))
          (let ((conf-no (string-to-int (match-string 1 (aux-item->data item))))
                (text-no (string-to-int (match-string 2 (aux-item->data item)))))
            (initiate-get-text-stat 'background
                                    'lyskom-clean-read-faqs-1
                                    text-no
                                    pers-no
                                    conf-no
                                    item)))))))

(defun lyskom-clean-read-faqs-1 (text-stat pers-no conf-no item)
  "Callback for lyskom-clean-read-faqs"
  (let ((cmp (int-to-string conf-no)))
    (when (or (null text-stat)
860
861
862
863
864
              (not (lyskom-traverse aux (lyskom-get-aux-item 
                                         (text-stat->aux-items text-stat)
                                         28)
                     (when (string= cmp (aux-item->data aux))
                       (lyskom-traverse-break t)))))
865
866
867
868
      (initiate-modify-conf-info 'background
                                 nil
                                 pers-no
                                 (list (aux-item->aux-no item))
869
870
                                 nil)
      )))
871
872


Per Cederqvist's avatar
.  
Per Cederqvist committed
873
874
875
876
877
(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"
878
879
880
881
882
883
884
885
886
  (let ((from-conf lyskom-current-conf)
        (to-conf (conf-stat->conf-no conf-stat)))
    (lyskom-run-hook-with-args 'lyskom-change-conf-hook
                               from-conf
                               to-conf)
    (unless lyskom-is-anonymous
      (initiate-pepsi 'main nil to-conf))
    (setq lyskom-current-conf to-conf)
    (let ((num-unread (text-list->length (read-info->text-list read-info))))
David Byers's avatar
David Byers committed
887
      (lyskom-enter-conf-print-unread conf-stat num-unread)
888
889
      (lyskom-run-hook-with-args 'lyskom-after-change-conf-hook
                                 from-conf
David Byers's avatar
David Byers committed
890
891
892
893
894
895
896
897
898
899
                                 to-conf))))

(defun lyskom-enter-conf-print-unread (conf num)
  "Print information about unread (if requested) when entering a conf.
CONF is the conference and NUM is the number of unread in the conference."
  (let ((faq-list (lyskom-get-unread-faqs conf)))
    (lyskom-format-insert "%#1M" conf)
    (when (or (eq num 0) kom-print-number-of-unread-on-entrance faq-list)
      (lyskom-insert " - "))

900
901
902
903
904
905
906
907
908
909
910
911
912
    (cond ((eq num 0) 
	   (lyskom-format-insert 'conf-all-read conf))
	  (kom-print-number-of-unread-on-entrance
	   (lyskom-format-insert 'enter-conf-unread num)))

    (when faq-list
      (when (or (eq num 0) kom-print-number-of-unread-on-entrance)
	(lyskom-insert ", "))
      (lyskom-format-insert 'enter-conf-unread-faq (length faq-list)))
  
    (lyskom-insert (lyskom-conf-type-marker conf))
    (lyskom-format-insert ".\n")
    (lyskom-present-unread-faqs conf faq-list)))
David Byers's avatar
David Byers committed
913

Per Cederqvist's avatar
.  
Per Cederqvist committed
914

David Byers's avatar
David Byers committed
915
916
(defun lyskom-leave-current-conf ()
  "Leave the current conference without going to another one."
917
918
919
920
921
922
923
924
925
  (let ((from-conf lyskom-current-conf))
    (set-read-list-empty lyskom-reading-list)
    (lyskom-run-hook-with-args 'lyskom-change-conf-hook
                               from-conf 0)
    (setq lyskom-current-conf 0)
    (initiate-pepsi 'main nil 0)
    (lyskom-run-hook-with-args 'lyskom-after-change-conf-hook
                               from-conf 0)
    ))
Per Cederqvist's avatar
.  
Per Cederqvist committed
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943


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

(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 "")))
944
        (conf-no (if (lyskom-conf-stat-p conf) (conf-stat->conf-no conf) 0))
Per Cederqvist's avatar
.  
Per Cederqvist committed
945
	(unread -1)
946
	(total-unread 0)
947
	(letters 0)
948
	(len 0)
Per Cederqvist's avatar
.  
Per Cederqvist committed
949
950
	(read-info-list nil))

951
      ;; Set unread to the number of unread texts in CONF.
David Byers's avatar
David Byers committed
952
    (setq read-info-list (read-list->all-entries lyskom-to-do-list))
953

David Byers's avatar
David Byers committed
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
    ;; This was weird. Someone had begun to write an if, but
    ;; this was all there was: (if 
    (while read-info-list
      (if (read-info->conf-stat (car read-info-list))
          (progn
            (setq len (text-list->length
                       (read-info->text-list (car read-info-list))))
            (if (= conf-no
                   (conf-stat->conf-no 
                    (read-info->conf-stat (car read-info-list))))
                (setq unread len))
            (if (= lyskom-pers-no
                   (conf-stat->conf-no 
                    (read-info->conf-stat (car read-info-list))))
                (setq letters len))
            (setq total-unread (+ total-unread len))))
      (setq read-info-list (cdr read-info-list)))
971
972
      (if (= unread -1)
	  (setq unread 0))
David Kågedal's avatar
David Kågedal committed
973
      
974
975
976
      (if (null name)
	  nil
	(setq mode-line-conf-name 
David Kågedal's avatar
David Kågedal committed
977
978
	      (substring (concat
			  (if (lyskom-conf-stat-p conf)
979
980
			      (if (not (eq lyskom-session-priority 
                                           kom-default-session-priority))
David Kågedal's avatar
David Kågedal committed
981
982
983
984
985
986
987
				  (format "(%d/%d:%d) "
					  unread total-unread
					  lyskom-session-priority)
				(format "(%d/%d) " unread total-unread))
			    "")
			  name
			  (make-string 27 ? ))
988
			 0 27)))
David Kågedal's avatar
David Kågedal committed
989
      
990
      (if (zerop total-unread)
991
992
          (lyskom-remove-unread-buffer lyskom-buffer)
        (lyskom-add-unread-buffer lyskom-buffer))
993
      (if (zerop letters)
994
995
          (lyskom-remove-unread-buffer lyskom-buffer t)
        (lyskom-add-unread-buffer lyskom-buffer t))
David Kågedal's avatar
David Kågedal committed
996
    (force-mode-line-update)))
Per Cederqvist's avatar
.  
Per Cederqvist committed
997
998
999
1000
1001
1002


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

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

David Byers's avatar
David Byers committed
1003
(defun lyskom-try-get-membership (conf-no &optional want-passive)
Per Cederqvist's avatar
.  
Per Cederqvist committed
1004
  "Returns non-nil if conference CONF-NO is present on lyskom-membership.
1005
1006
1007
1008
1009
The value is actually the membership for the conference.

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

David Byers's avatar
David Byers committed
1010
1011
1012
This function does not use blocking-do.

Optional argument mship-list is the membership list to look in."
David Byers's avatar
David Byers committed
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
  (save-excursion
    (set-buffer lyskom-buffer)
    (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)))
      (if (and found
               (or want-passive
                   (not (membership-type->passive (membership->type found)))))
          found
        nil))))
Per Cederqvist's avatar
.  
Per Cederqvist committed
1026

David Byers's avatar
David Byers committed
1027
(defun lyskom-get-membership (conf-no &optional want-passive)
1028
1029
1030
1031
  "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
1032
found in lyskom-membership, a blocking call to the server is made."
David Byers's avatar
David Byers committed
1033
1034
1035
1036
1037
  (save-excursion
    (set-buffer lyskom-buffer)
    (or (lyskom-try-get-membership conf-no want-passive)
        (and (not (lyskom-membership-is-read))
             (let ((membership
1038
                    (blocking-do 'query-read-texts lyskom-pers-no conf-no t 0)))
David Byers's avatar
David Byers committed
1039
1040
1041
1042
1043
1044
1045
1046
               (if (and membership (lyskom-visible-membership membership))
                   (lyskom-add-membership membership conf-no))
               (if (and membership
                        (or want-passive
                            (not (membership-type->passive
                                  (membership->type membership)))))
                   membership
                 nil))))))
1047
1048


Per Cederqvist's avatar
.  
Per Cederqvist committed
1049
1050
1051
;;;; ================================================================
;;;;                   Scrolling and text insertion.

1052

1053
(defvar lyskom-trim-buffer-delete-to)
Per Cederqvist's avatar
.  
Per Cederqvist committed
1054

David Kågedal's avatar
David Kågedal committed
1055
(defun lyskom-trim-buffer ()
1056
1057
  "Trim the size of a lyskom buffer to lyskom-max-buffer-size
returns t if it trimmed the buffer, nil otherwise."
1058
  (when (and kom-max-buffer-size
1059
	     (> (- (buffer-size) kom-trim-buffer-minimum) kom-max-buffer-size))
1060
1061
1062
1063
1064
1065
1066
1067
1068
    (lyskom-save-excursion
      (let ((lyskom-trim-buffer-delete-to (- (buffer-size)
					     kom-max-buffer-size))
	    (inhibit-read-only t))
	(goto-char (point-min))
	(while (< (point) lyskom-trim-buffer-delete-to)
	  (forward-line 1))
	(setq lyskom-trim-buffer-delete-to (point))
	(run-hooks 'lyskom-trim-buffer-hook)
1069
	(delete-region (point-min) lyskom-trim-buffer-delete-to)))
1070
      t))
1071

David Byers's avatar
David Byers committed
1072
;;USER-HOOK: lyskom-garb-lyskom-buffer-to-file
1073
1074
1075
1076
1077
1078
1079
1080
(defun lyskom-garb-lyskom-buffer-to-file ()
  "Appends the deleted initial portions of the buffer to a file.
Put this function in your lyskom-trim-buffer-hook and set
kom-max-buffer-size to something clever, and the trimmed text
will automagically flow into your lyskom log file."
  (append-to-file 1 lyskom-trim-buffer-delete-to
		  (expand-file-name (concat "~/" (buffer-name) "-history"))))

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

Per Cederqvist's avatar
.  
Per Cederqvist committed
1082
1083
1084
1085
1086
(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.
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
  (let ((win (cond ((eq (window-buffer (selected-window)) (current-buffer))
                    (selected-window))
                   (t nil))))
    (when (and win (not (pos-visible-in-window-p (point-max))))
      (goto-char (point-max))
      (recenter -1)
      (unless (pos-visible-in-window-p lyskom-last-viewed)
        (set-window-start win lyskom-last-viewed)
        (move-to-window-line -1)
        (vertical-motion 1)
        (when (not (pos-visible-in-window-p))
          (forward-char -1)
          (when (> (current-column) (window-width))
            (backward-char (+ (- (current-column) (window-width)) 6)))
          )))))


David Byers's avatar
David Byers committed
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
(defun lyskom-next-property-bounds (from to sym)
  "Sort of like next-text-property-bounds, but limited at the front and
back, and works even if from has the property."
  (let ((result (cond ((get-text-property from sym)
                       (cons from (next-single-property-change from sym)))
                      ((next-single-property-change from sym)
                       (let ((start (next-single-property-change from sym)))
                         (cons start (next-single-property-change start sym)))))))
    (when result
      (cond ((null (cdr result)) (setcdr result (or to (point-max))))
            ((and from (< (car result) from)) (setcar result from))
            ((and to (> (cdr result) to)) (setcar result to)))) 
    result))


(defun lyskom-do-special-inserts (start end sym)
1120
  (condition-case var
David Byers's avatar
David Byers committed
1121
      (let ((bounds (lyskom-next-property-bounds start end sym))
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
            (next (make-marker))
            (fn nil))
        (while bounds
          (set-marker next (cdr bounds))
          (setq fn (get-text-property (car bounds) sym))
          (remove-text-properties (car bounds) (cdr bounds) (list sym))
          (condition-case val
              (funcall (if (listp fn)
                           (car fn)
                         fn)
                       (car bounds)
                       (cdr bounds)
                       (if (listp fn)
                           (cdr fn)
                         nil))
            (error (apply 'message "%S" val)))
          (setq start next)
          (setq bounds (next-text-property-bounds 1 (1- start) sym))))
    (error (lyskom-ignore var))))

1142
(defun lyskom-do-insert (string)
David Byers's avatar
David Byers committed
1143
  (let ((start (point)))
1144
    (insert string)
David Byers's avatar
David Byers committed
1145
    (lyskom-do-special-inserts start (point) 'lyskom-fill)
David Byers's avatar
David Byers committed
1146
1147
    (lyskom-do-special-inserts start (point) 'lyskom-overlay)
    (lyskom-do-special-inserts start (point) 'special-insert)
1148
))
1149

David Byers's avatar
David Byers committed
1150
1151


Per Cederqvist's avatar
.  
Per Cederqvist committed
1152
1153
(defun lyskom-insert (string)
  "Insert STRING last in current buffer.
1154
1155
1156
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
1157
is not on screen then doesn't move point."
1158
  (when (symbolp string) (setq string (lyskom-get-string string)))
David Kågedal's avatar
David Kågedal committed
1159
1160
1161
  (let ((was-at-max (= (save-excursion (end-of-line) (point)) (point-max))))
    (save-excursion
      (goto-char (point-max))
1162
      (let ((inhibit-read-only t))
David Byers's avatar
David Byers committed
1163
        (lyskom-do-insert string))
David Kågedal's avatar
David Kågedal committed
1164
1165
1166
1167
      (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)
1168
1169
              (goto-char (point-max))
            (and kom-continuous-scrolling (lyskom-scroll)))))))
1170

Per Cederqvist's avatar
.  
Per Cederqvist committed
1171

David Byers's avatar
David Byers committed
1172

1173
(defun lyskom-insert-at-point (string)
1174
  "Insert STRING in the current buffer at point."
1175
  (let ((inhibit-read-only t))
David Byers's avatar
David Byers committed
1176
    (lyskom-do-insert string))
1177
1178
  (lyskom-trim-buffer))  

Per Cederqvist's avatar
.  
Per Cederqvist committed
1179
1180
1181
1182

(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.
1183
The strings buffered are printed before the prompt by lyskom-update-prompt."
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
  ;;
  ;; 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
1196
1197
  (cond
   ((and lyskom-executing-command
1198
         (not (eq lyskom-is-waiting t)))
Per Cederqvist's avatar
Per Cederqvist committed
1199
1200
    ;; Don't insert the string until the current command is finished.
    (if (null lyskom-to-be-printed-before-prompt)
1201
        (setq lyskom-to-be-printed-before-prompt (lyskom-queue-create)))
1202
    (lyskom-queue-enter lyskom-to-be-printed-before-prompt 
1203
                        (list string)))
1204
   (t
1205
1206
    ;; For some reaseon save-excursion doesn't work as expected
    (let ((oldpoint (point-marker)))
Per Cederqvist's avatar
.  
Per Cederqvist committed
1207
      (goto-char (point-max))
1208
1209
      (beginning-of-line)
      (let ((inhibit-read-only t))
1210
1211
1212
1213
1214
1215
1216
        ;; Some (all?) xemacsen adds the text-properties on the prompt
        ;; to text inserted before it. We don't want this, so insert a
        ;; blank and remove all text-properties from it, insert the
        ;; text before the blank and finally remove the blank.
        (insert " ")
        (backward-char)
        (remove-text-properties (point) (+ (point) 1) (text-properties-at (point)))
1217
        (lyskom-do-insert string)
1218
        (delete-char 1))
1219
      (goto-char oldpoint))
1220
1221
    (let ((window (get-buffer-window (current-buffer))))
      (if (and window
1222
1223
1224
1225
1226
               (not (pos-visible-in-window-p (point) window)))
          ;; This mease that the prompt has been pushed off the bottom
          (save-selected-window
            (select-window window)
            (recenter -1)))))))
1227
      
Per Cederqvist's avatar
.  
Per Cederqvist committed
1228
1229
1230
1231
1232

(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)))
1233
    (message "%s" str)))
Per Cederqvist's avatar
.  
Per Cederqvist committed
1234
1235


1236
1237
1238
1239
(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)))
1240
    (error "%s" str)))
1241
1242


Lars Willför's avatar
Lars Willför committed
1243
1244
1245
(defun lyskom-set-last-viewed ()
  (save-excursion
    (vertical-motion 0)
1246
    (setq lyskom-last-viewed (point-marker))))
Lars Willför's avatar
Lars Willför committed
1247
1248


Per Cederqvist's avatar
.  
Per Cederqvist committed
1249
1250
1251
;;; ================================================================
;;;                  Extended string formatting

1252
1253
1254
;;; Author: David Byers
;;; Original code: Inge Wallin

Per Cederqvist's avatar
.  
Per Cederqvist committed
1255

1256
(defvar lyskom-format-format
1257
  "%\\(=\\)?\\(-?[0-9]+\\|-?[0-9]+\\.[0-9]+\\|-?[0-9]+\\.[0-9]+\\.[0-9]+\\)?\\(:.\\)?\\(#\\([0-9]+\\)\\)?\\(_\\)?\\(:\\)?\\(&\\)?\\([][$@MmPpnrtsdoxlcfgCSDF%?]\\)"
1258
  "regexp matching format string parts.")
Per Cederqvist's avatar
.  
Per Cederqvist committed
1259
1260
1261

(defun lyskom-insert-string (atom)
 "Find the string corresponding to ATOM and insert it into the LysKOM buffer." 
David Byers's avatar
David Byers committed
1262
1263
1264
 (if (stringp atom)
     (lyskom-insert atom)
   (lyskom-insert (lyskom-get-string atom))))
Per Cederqvist's avatar
.  
Per Cederqvist committed
1265

David Byers's avatar
David Byers committed
1266
1267
1268
1269
1270
1271
(defun lyskom-format-transform-result (state)
  "Convert a format-state to a string."
  (let ((result (format-state->result state)))
    (lyskom-traverse overlay (format-state->delayed-overlays state)
      (add-text-properties (aref overlay 0)
                           (aref overlay 1)
1272
                           (list 'lyskom-overlay 
David Byers's avatar
David Byers committed
1273
1274
1275
1276
1277
                             (cons 'lyskom-special-insert-overlay
                                   (aref overlay 2)))
                           result))
    result))

David Byers's avatar
David Byers committed
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
(defun lyskom-limited-make-overlay (start end)
  (let ((val (lyskom-xemacs-or-gnu
              (make-extent start end)
              (make-overlay start end))))
  (when (lyskom-plusp kom-max-overlays)
    (let ((old (nthcdr (1- kom-max-overlays) lyskom-overlay-pool))) ;
      (setq lyskom-overlay-pool 
            (lyskom-nbutlast lyskom-overlay-pool 
                             (- (length lyskom-overlay-pool)
                                kom-max-overlays)))
1288
1289
1290
      (mapcar
       (lambda (o) (lyskom-xemacs-or-gnu (delete-extent o)
					 (delete-overlay o))) old))
David Byers's avatar
David Byers committed
1291
1292
1293
1294
    (setq lyskom-overlay-pool (cons val lyskom-overlay-pool)))
  val))


David Byers's avatar
David Byers committed
1295
1296
(defun lyskom-special-insert-overlay (start end args)
  (lyskom-xemacs-or-gnu
David Byers's avatar
David Byers committed
1297
   (let ((overlay (lyskom-limited-make-overlay start end)))
David Byers's avatar
David Byers committed
1298
1299
1300
1301
     (while args
       (set-extent-property overlay (car args) (car (cdr args)))
       (setq args (nthcdr 2 args)))
     (set-extent-priority overlay 1000))
David Byers's avatar
David Byers committed
1302
   (let ((overlay (lyskom-limited-make-overlay start end)))
David Byers's avatar
David Byers committed
1303
1304
1305
1306
     (while args
       (overlay-put overlay (car args) (car (cdr args)))
       (setq args (nthcdr 2 args))))))

1307
(defun lyskom-format (format-string &rest argl)
David Byers's avatar
David Byers committed
1308
  (lyskom-format-transform-result (lyskom-do-format format-string argl)))
1309
1310

(defun lyskom-format-insert (format-string &rest argl)
1311
1312
  "Format and insert a string according to FORMAT-STRING.
The string is inserted at the end of the buffer with `lyskom-insert'."
1313
  (let* ((state (lyskom-do-format format-string argl t))