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
        (accept-process-output nil lyskom-apo-timeout-s lyskom-apo-timeout-ms))
131
      lyskom-filter-hack)))
132
133
134
    
(defun lyskom-filter-text-p-2 (text-stat)
  (if (null text-stat)
David Byers's avatar
David Byers committed
135
      (setq lyskom-filter-hack nil)
136
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
    (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)
170
171
  (if (or (null text)
	  (null author))
172
      (setq lyskom-filter-hack nil)
173
    (let (subject text-stat)
174
175
176
177
178
179
180
181
182
183
184
      
      ;;
      ;; 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 "")))
      
      ;;
185
186
      ;; Extract the text-stat which is the last element of data
      ;; Next shorten the list in data to exclude the text-stat.
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
      ;;
      
      (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)))))
205
206
207
208
209
210
211
212
213

(defun lyskom-check-filter-list (text-stat
                                 author
                                 recipient-list
                                 subject
                                 text
                                 filter-list)
  (let (tmp)
    (while filter-list
214
      (condition-case nil
215
216
217
218
219
220
221
222
223
224
225
226
          (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))))
227
228
    tmp))

229
230


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

;;;========================================
;;;  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)
249
250
      (byte-compile 
       '(lambda (filter author recipient-list subject text-stat text) nil))
David Byers's avatar
David Byers committed
251
    (byte-compile (lyskom-create-filter-function pattern))))
252
253
254
255
256
257
258


(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)
259
  (let (inverse)
260
    (cond
261
262
     ;;
     ;; End of pattern
263
264
265
     ;; 
     
     ((null pattern) '((filter->attribute filter 'action)))
266
267
268
269

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

      
354

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




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

(defun lyskom-filter-prompt (text-no prompt)
  (setq lyskom-filter-hack t)
371
372
373
374
375
376
377
378
379
380
381
382
383
384
  (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))
385
		       (text->text-mass text)))
386
387
388
389
	       (lyskom-format-insert prompt
				     text-stat
				     subject
				     (or conf-stat
390
391
					 (text-stat->author text-stat)))
	       (lyskom-scroll))))))
392
393
  (setq lyskom-filter-hack nil))

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


;;;========================================
;;; 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
422
                        lyskom-filter-actions)
423
424
                       nil
                       nil
Niels Möller's avatar
Niels Möller committed
425
                       (cdr (car lyskom-filter-actions))
426
                       t)
Niels Möller's avatar
Niels Möller committed
427
      lyskom-filter-actions))))
428
429
430
431
432
433
434
435
436
437
438
439
440


(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
;;; 

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

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

477
478

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




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

525
(def-kom-command kom-super-jump ()
526
527
528
  "Skip all texts and comments that share the subject and recipient of 
the current text"
  (interactive)
529
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
  (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)))))
568
569
570
571
572
573
574
575
576




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

577
(def-kom-command kom-filter-text (&optional text)
578
  "Interactively filter on text contents. Optional TEXT is subject to filter."
579
  (interactive)
580
  (if (/= 0 lyskom-current-conf)
581
	  (let ((conf-stat (blocking-do 'get-conf-stat lyskom-current-conf))
582
583
584
585
            (conf nil)
            (action nil)
            (perm nil)
            (filter nil))
586
	    (if conf-stat
587
588
589
590
591
592
593
594
            (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)
595
                          '(all) t
596
                          (or (and (conf-stat->conf-no conf-stat)
597
                                   (cons (conf-stat->name conf-stat) 0))
598
599
600
601
602
603
604
605
606
607
                              "")
                          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))))))))))
608
609
610
611
612
613
614
615
616


;;;============================================================
;;; 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...

617
(def-kom-command kom-list-filters ()
618
619
  "Display all filters"
  (interactive)
620
  (let ((filters lyskom-filter-list))
621
622
623
624
625
626
    (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
627
          (goto-char (point-max))
628
629
630
          (lyskom-format-filter-pattern (car filters))
          (setq filters (cdr filters)))
        (lyskom-insert (lyskom-get-string 'view-filters-footer))))))
631