filter.el 20.4 KB
Newer Older
1
2
;;;;;
;;;;; $Id$
3
;;;;; Copyright (C) 1991, 1996  Lysator Academic Computer Association.
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) 
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
;;;;; 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. 
;;;;;
;;;; ================================================================
;;;; ================================================================
;;;;
28
;;;; File: filter.el
29
30
31
32
;;;;
;;;; Contains the support functions for text filtering.
;;;;

33
34
35
(setq lyskom-clientversion-long 
      (concat lyskom-clientversion-long
	      "$Id$\n"))
36

37

38
39
40
41
42
43
;;;============================================================
;;;
;;; Filter pattern accessors
;;;
;;; Filters are lists with the following structure
;;;
44
;;;   (filter [ PATTERNS ATTRIBUTES FUNCTION])
45
46
;;;
;;; Where PATTERNS is a list of filter patterns and ATTRIBUTES is
47
48
;;; an association list. FUNCTION is a lisp function implementing
;;; the filter.
49
50
51
52
53
54
55
56
57
58
59
;;;
;;; The following attributes are reserved
;;;
;;; action -- What action to take when the pattern matches. Currently
;;;           one of dontshow, skip or skip-comments.
;;; expire -- When the filter expires. Not used.
;;;

(defun make-filter (&optional p a)
  "Creates and returns a filter structure.
Optional P and A initialize pattern and attributes, respectively."
60
61
  (list 'filter (vector p a
			(lyskom-create-compile-filter-function p))))
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101

(defun copy-filter (f)
  "Create a copy of the filter F"
  (make-filter (copy-tree (filter->pattern f))
               (copy-tree (filter->attribute-list f))))

(defun filter-p (f)
  "Returns T if f looks like a filter"
  (and (listp f)
       (eq 'filter (car f))))

(defun filter->pattern (f)
  "Extract the patterns part of a filter F"
  (elt (elt f 1) 0))

(defun filter->attribute-list (f)
  "Extract the attribute list of F."
  (elt (elt f 1) 1))

(defun filter->attribute (f a)
  "From filter F, extract the value of attribute A. 
Returns nil if no such attribute is present."
  (cdr (assq a (filter->attribute-list f))))

(defun set-filter->pattern (f p)
  "Set the patterns part of F to P."
  (aset (elt f 1) 0 p))

(defun set-filter->attribute-list (f l)
  "Set the attribute list of filter F to L"
  (aset (elt f 1) 1 l))

(defun set-filter->attribute (f a v)
  "Set the value in filter F of attribute A to V."
  (let ((x (assq a (filter->attribute-list f))))
    (if x
        (setcdr x v)
      (set-filter->attribute-list f
       (cons (cons a v) (filter->attribute-list f))))))

102
103
104
105
106
107
108
109
110
(defun filter->function (f)
  "Get the function for filter F"
  (elt (elt f 1) 2))

(defun set-filter->function (f fn)
  "Set the function for filter F to FN"
  (aset (elt f 1) 2 fn))


111
112
113
114
115
;;;============================================================
;;;
;;;


116
117
118
(defvar lyskom-filter-hack nil
  "Variable to busy-wait on to get the filter action. Set to
invalid-value until a filter action has been selected.")
119
120
121
122
123
124
125
126
127
128
129

(defun lyskom-filter-text-p (text-no)
  (if (null lyskom-filter-list)
      nil
    (progn
      (setq lyskom-filter-hack 'invalid-value)
      (initiate-get-text-stat 'filter 'lyskom-filter-text-p-2 text-no)
      ;;
      ;; Block until done
      ;;
      (while (eq lyskom-filter-hack 'invalid-value)
130
131
        (accept-process-output lyskom-proc
			       lyskom-apo-timeout-s lyskom-apo-timeout-ms))
132
      lyskom-filter-hack)))
133
134
135
    
(defun lyskom-filter-text-p-2 (text-stat)
  (if (null text-stat)
David Byers's avatar
David Byers committed
136
      (setq lyskom-filter-hack nil)
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
    (progn
      ;;
      ;; Collect information from the server
      ;;
      (lyskom-collect 'filter)
      
      ;;
      ;; Get the conf-stat of the author of the text
      ;; Get the text body
      ;;
      
      (initiate-get-conf-stat 'filter nil (text-stat->author text-stat))
      (initiate-get-text 'filter nil (text-stat->text-no text-stat))
      
      ;;
      ;; Get the conf-stat of the recipients
      ;;
      
      (lyskom-traverse
          misc
          (text-stat->misc-info-list text-stat)
        (let ((type (misc-info->type misc)))
          (if (or (eq type 'RECPT) (eq type 'CC-RECPT))
              (initiate-get-conf-stat 'filter 
                                      nil
                                      (misc-info->recipient-no misc)))))
      
      ;;
      ;; Use the results
      ;;
      
      (lyskom-use 'filter 'lyskom-filter-text-p-3 text-stat))))
    
(defun lyskom-filter-text-p-3 (author text &rest data)
171
172
  (if (or (null text)
	  (null author))
173
      (setq lyskom-filter-hack nil)
174
    (let (subject text-stat)
175
176
177
178
179
180
181
182
183
184
185
      
      ;;
      ;; Extract the subject
      ;;
      
      (cond ((string-match "\n" (text->text-mass text))
	     (setq subject 
		   (substring (text->text-mass text) 0 (match-beginning 0))))
	    (t (setq subject "")))
      
      ;;
186
187
      ;; Extract the text-stat which is the last element of data
      ;; Next shorten the list in data to exclude the text-stat.
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
      ;;
      
      (setq text-stat (elt data (- (length data) 1)))
      (if (= (length data) 1)
	  (setq data nil)
	(rplacd (nthcdr (- (length data) 2) data) nil))
      
      ;;
      ;; Do the checking
      ;;
      
      (setq lyskom-filter-hack
	    (lyskom-check-filter-list text-stat
				      author
				      data
				      subject
				      (text->text-mass text)
				      lyskom-filter-list)))))
206
207
208
209
210
211
212
213
214

(defun lyskom-check-filter-list (text-stat
                                 author
                                 recipient-list
                                 subject
                                 text
                                 filter-list)
  (let (tmp)
    (while filter-list
215
      (condition-case nil
216
217
218
219
220
221
222
223
224
225
226
227
          (if (functionp (filter->function (car filter-list)))
              (setq tmp (funcall (filter->function (car filter-list))
                                 (car filter-list)
                                 author
                                 recipient-list
                                 subject
                                 text-stat
                                 text)))
        (error nil))
      (if tmp
          (setq filter-list nil)
        (setq filter-list (cdr filter-list))))
228
229
    tmp))

230
231


232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249

;;;========================================
;;;  The filter compiler.
;;;


(defmacro lyskom-filter-is-member (testfn arg list selector)
  (` (let (found
           (objlist (, list)))
       (while (and objlist (not found))
         (and ((, testfn) (, arg) ((, selector) (car objlist)))
           (setq found t))
      (setq objlist (cdr objlist)))
    found)))


(defun lyskom-create-compile-filter-function (pattern)
  (if (null pattern)
250
251
      (byte-compile 
       '(lambda (filter author recipient-list subject text-stat text) nil))
David Byers's avatar
David Byers committed
252
    (byte-compile (lyskom-create-filter-function pattern))))
253
254
255
256
257
258
259


(defun lyskom-create-filter-function (pattern)
  (` (lambda (filter author recipient-list subject text-stat text)
       (, (cons 'and (lyskom-create-filter-function-body pattern))))))

(defun lyskom-create-filter-function-body (pattern)
260
  (let (inverse)
261
    (cond
262
263
     ;;
     ;; End of pattern
264
265
266
     ;; 
     
     ((null pattern) '((filter->attribute filter 'action)))
267
268
269
270

     ;;
     ;; Bad pattern
     ;;
271
272
273
274
275
276
277
     
     ((or (not (listp pattern))
          (not (listp (car pattern)))) 
      (lyskom-error 
       "%s"
       (lyskom-get-string 'filter-error-specification)))
     
278
279
280
     ;;
     ;; Assume valid pattern
     ;;
281
282
283
284
285
     
     (t
      (let ((key (car (car pattern)))
            (args (cdr (car pattern)))
            (form nil))
286
287
        (if (eq key 'not)
            (if (not (listp args))
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
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
346
347
348
349
350
351
352
353
354
                (lyskom-error "%s" (lyskom-get-string 'filter-error-bad-not))
              (setq key (car args) args (cdr args) inverse t)))

        (setq form
              (cond 
               ((eq key 'author)
                (lyskom-filter-check-args 'stringp args)
                (` (string-match (, (regexp-quote args))
                                 (conf-stat->name author))))

               ((eq key 'author-re)
                (lyskom-filter-check-args 'regexpp args)
                (` (string-match (, args)
                                 (conf-stat->name author))))

               ((eq key 'author-no)
                (lyskom-filter-check-args 'integerp args)
                (` (= (, args) (conf-stat->conf-no author))))

               ((eq key 'recipient)
                (lyskom-filter-check-args 'stringp args)
                (` (lyskom-filter-is-member
                    string-match
                    (, (regexp-quote args))
                    recipient-list
                    conf-stat->name)))
               ((eq key 'recipient-re)
                (lyskom-filter-check-args 'regexpp args)
                (` (lyskom-filter-is-member
                    string-match
                    (,  args)
                    recipient-list
                    conf-stat->name)))
               ((eq key 'recipient-no)
                (lyskom-filter-check-args 'integerp args)
                (` (lyskom-filter-is-member
                    =
                    (,  args)
                    recipient-list
                    conf-stat->conf-no)))

               ((eq key 'subject)
                (lyskom-filter-check-args 'stringp args)
                (` (string-match (, (regexp-quote args))
                                 subject)))
               ((eq key 'subject-re)
                (lyskom-filter-check-args 'regexpp args)
                (` (string-match (, args)
                                 subject)))

               ((eq key 'text)
                (lyskom-filter-check-args 'stringp args)
                (` (string-match (, (regexp-quote args))
                                 text)))
               ((eq key 'text-re)
                (lyskom-filter-check-args 'regexpp args)
                (` (string-match (, args)
                                 text)))
               (t (lyskom-error 
                   (lyskom-get-string 'filter-error-unknown-key)
                   key
                   ))))
        
        (if inverse (setq form (list 'not form)))
        (cons form (lyskom-create-filter-function-body (cdr pattern))))))))

      
355

356
357
358
359
360
361
362
363
(defun lyskom-filter-check-args (fn arg)
  (if (not (funcall fn arg))
      (lyskom-error (lyskom-get-string 'filter-error-key-arg)
                    fn arg)))




364
365
366
367
;;; ============================================================
;;; lyskom-filter-prompt
;;;
;;; Print a notice that a text has been filtered. 
368
;;;
369
370
371

(defun lyskom-filter-prompt (text-no prompt)
  (setq lyskom-filter-hack t)
372
373
374
375
376
377
378
379
380
381
382
383
384
385
  (let ((text-stat (blocking-do 'get-text-stat text-no))
	(subject nil))
    (if text-stat
	(blocking-do-multiple 
	 ((text (get-text text-no))
	  (conf-stat (get-conf-stat 
		      (text-stat->author text-stat))))
	 (if text
	     (progn
	       (setq subject
		     (if (string-match "\n" (text->text-mass text))
			 (substring (text->text-mass text) 
				    0
				    (match-beginning 0))
386
		       (text->text-mass text)))
387
388
389
390
	       (lyskom-format-insert prompt
				     text-stat
				     subject
				     (or conf-stat
391
392
					 (text-stat->author text-stat)))
	       (lyskom-scroll))))))
393
394
  (setq lyskom-filter-hack nil))

395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422


;;;========================================
;;; User functions and support functions
;;;

(defun lyskom-add-filter (filter)
  "Add the filter FILTER to the LysKOM filtering mechanism."
  (if (filter->attribute filter 'expire)
      (setq kom-session-filter-list (cons filter
                                          kom-session-filter-list))
    (progn
      (setq kom-permanent-filter-list (cons filter kom-permanent-filter-list))
      (lyskom-save-options (current-buffer)
                           (lyskom-get-string 'filter-edit-saving)
                           (lyskom-get-string 'filter-edit-saving-done)
                           (lyskom-get-string 'filter-edit-saving-error))))
  (setq lyskom-filter-list
        (cons filter lyskom-filter-list)))


(defun lyskom-filter-read-action ()
  "Read a filter action from the minibuffer, returning its symbol"
  (let ((completion-ignore-case t))
    (car
     (rassoc
      (completing-read (lyskom-get-string 'filter-action)
                       (lyskom-reverse-pairs 
Niels Möller's avatar
Niels Möller committed
423
                        lyskom-filter-actions)
424
425
                       nil
                       nil
Niels Möller's avatar
Niels Möller committed
426
                       (cdr (car lyskom-filter-actions))
427
                       t)
Niels Möller's avatar
Niels Möller committed
428
      lyskom-filter-actions))))
429
430
431
432
433
434
435
436
437
438
439
440
441


(defun lyskom-filter-read-permanent ()
  "Ask the user is a filter is permanent and return t in this case.
Otherwise return nil."
  (lyskom-j-or-n-p (lyskom-get-string 'filter-permanent)))



;;;========================================
;;; Filtrera ärende --- Filter subject
;;; 

442
(def-kom-command kom-filter-subject (&optional subject)
443
444
  "Interactively filter a subject. Optional SUBJECT is subject to filter."
  (interactive)
445
  (if (/= 0 lyskom-current-conf)
446
447
448
	  (let ((conf-stat (blocking-do 'get-conf-stat lyskom-current-conf)))
	    (let (conf perm filter action)
	      (if (null subject)
449
              (setq subject lyskom-current-subject))
450
	      (setq subject 
451
452
                (read-from-minibuffer (lyskom-get-string 'filter-subject)
                                      subject))
453
454
	      (setq filter (cons (cons 'subject subject) filter))
	      (setq conf (lyskom-read-conf-no
455
                      (lyskom-get-string 'filter-in-conf)
456
                      '(all)
457
458
                      t
                      (or (and (conf-stat->conf-no conf-stat)
459
                               (cons (conf-stat->name conf-stat) 0))
460
461
                          "")
                      t))
462
	      (if (/= conf 0)
463
              (setq filter (cons (cons 'recipient-no conf) filter)))
464
465
466
467
468
	      (setq action (lyskom-filter-read-action))
	      (setq perm (lyskom-filter-read-permanent))
	      
	      (lyskom-add-filter
	       (make-filter filter
469
470
                        (list (cons 'action action)
                              (cons 'expire (not perm)))))))))
471
472
473
474
475
476
477
  

     
;;;========================================
;;; Filtrera författare --- Filter author
;;;

478
479

(def-kom-command kom-filter-author ()
480
481
  "Interactively filter an author."
  (interactive)
482
  (let (auth-stat author conf filter action permanent)
483
	(blocking-do-multiple ((text-stat (get-text-stat 
484
485
486
487
488
489
490
491
                                       (or lyskom-current-text 0)))
                           (conf-stat (get-conf-stat
                                       lyskom-current-conf)))
      (if text-stat
          (setq auth-stat (blocking-do 'get-conf-stat
                                       (text-stat->author text-stat))))
      (setq author 
            (lyskom-read-conf-no (lyskom-get-string 'filter-author)
492
                                 '(pers)
493
494
                                 t
                                 (or (and auth-stat
495
                                          (cons (conf-stat->name auth-stat) 0))
496
497
498
499
500
501
                                     "")
                                 t))
      (if (/= author 0)
          (setq filter (cons (cons 'author-no author) filter)))
      (setq conf (lyskom-read-conf-no
                  (lyskom-get-string 'filter-in-conf)
502
                  '(all)
503
504
505
                  t
                  (or 
                   (and conf-stat
506
                        (cons (conf-stat->name conf-stat) 0))
507
508
509
510
511
512
513
514
515
516
                   "")
                  t))
      (if (/= conf 0)
          (setq filter (cons (cons 'recipient-no conf) filter)))
      (setq action (lyskom-filter-read-action))
      (setq permanent (lyskom-filter-read-permanent))
      (lyskom-add-filter
       (make-filter filter
                    (list (cons 'action action)
                          (cons 'expire (not permanent))))))))
517
518
519
520
521
522
523
524
525




;;;============================================================
;;;
;;; Superhoppa
;;;

526
(def-kom-command kom-super-jump ()
527
528
529
  "Skip all texts and comments that share the subject and recipient of 
the current text"
  (interactive)
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
  (if (or (null lyskom-current-text)
          (zerop lyskom-current-text))
      (lyskom-insert-string 'have-to-read)
    (let ((text-stat (blocking-do 'get-text-stat lyskom-current-text))
          (recipients nil)
          (cc-recipients nil)
          (filter-recipient nil)
          (conf-stat (if (and lyskom-current-conf
                              (not (zerop lyskom-current-conf)))
                         (blocking-do 'get-conf-stat lyskom-current-conf))))
      (lyskom-traverse misc
          (text-stat->misc-info-list text-stat)
        (cond ((eq (misc-info->type misc) 'RECPT) 
               (setq recipients (cons (misc-info->recipient-no misc)
                                      recipients)))
              ((eq (misc-info->type misc) 'CC-RECPT)
               (setq cc-recipients (cons (misc-info->recipient-no misc)
                                         cc-recipients)))))

      (setq filter-recipient (or 
                              (and conf-stat
                                   (or 
                                    (memq lyskom-current-conf recipients)
                                    (memq lyskom-current-conf cc-recipients))
                                   lyskom-current-conf)
                              (car (nreverse recipients))
                              (car (nreverse cc-recipients))))

      (if (null filter-recipient)
          (lyskom-insert-string 'no-recipient)
            
        (lyskom-add-filter
         (make-filter (list (cons 'subject lyskom-current-subject)
                            (cons 'recipient-no filter-recipient))
                      (list (cons 'action 'skip-tree)
                            (cons 'expire t))))
        (lyskom-format-insert 'super-jump
                              (copy-sequence lyskom-current-subject)
                              filter-recipient)))))
569
570
571
572
573
574
575
576
577




;;;============================================================
;;;
;;; Filtrera text
;;;

578
(def-kom-command kom-filter-text (&optional text)
579
  "Interactively filter on text contents. Optional TEXT is subject to filter."
580
  (interactive)
581
  (if (/= 0 lyskom-current-conf)
582
	  (let ((conf-stat (blocking-do 'get-conf-stat lyskom-current-conf))
583
584
585
586
            (conf nil)
            (action nil)
            (perm nil)
            (filter nil))
587
	    (if conf-stat
588
589
590
591
592
593
594
595
            (progn
              (setq text 
                    (read-from-minibuffer (lyskom-get-string 
                                           'filter-which-text)
                                          (or text "")))
              (setq filter (cons (cons 'text text) filter))
              (setq conf (lyskom-read-conf-no
                          (lyskom-get-string 'filter-in-conf)
596
                          '(all) t
597
                          (or (and (conf-stat->conf-no conf-stat)
598
                                   (cons (conf-stat->name conf-stat) 0))
599
600
601
602
603
604
605
606
607
608
                              "")
                          t))
              (if (/= conf 0)
                  (setq filter (cons (cons 'recipient-no conf) filter)))
              (setq action (lyskom-filter-read-action))
              (setq perm (lyskom-filter-read-permanent))
              (lyskom-add-filter
               (make-filter filter
                            (list (cons 'action action)
                                  (cons 'expire (not perm))))))))))
609
610
611
612
613
614
615
616
617


;;;============================================================
;;; Lista filter                         (kom-list-filters)
;;;
;;; Author: David Byers
;;; Calls internal functions in filter-edit mode. This may or
;;; may not be a good idea, but it works...

618
(def-kom-command kom-list-filters ()
619
620
  "Display all filters"
  (interactive)
621
  (let ((filters lyskom-filter-list))
622
623
624
625
626
627
    (goto-char (point-max))
    (if (null filters)
        (lyskom-insert (lyskom-get-string 'no-filters))
      (progn
        (lyskom-insert (lyskom-get-string 'view-filters-header))
        (while filters
628
          (goto-char (point-max))
629
630
631
          (lyskom-format-filter-pattern (car filters))
          (setq filters (cdr filters)))
        (lyskom-insert (lyskom-get-string 'view-filters-footer))))))
632