filter.el 19.3 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
;;;;;
;;;;; $Id$
;;;;; Copyright (C) 1991  Lysator Academic Computer Association.
;;;;;
;;;;; This file is part of the LysKOM server.
;;;;; 
;;;;; LysKOM is free software; you can redistribute it and/or modify it
;;;;; under the terms of the GNU General Public License as published by 
;;;;; the Free Software Foundation; either version 1, or (at your option) 
;;;;; any later version.
;;;;; 
;;;;; LysKOM is distributed in the hope that it will be useful, but WITHOUT
;;;;; ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
;;;;; FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
;;;;; for more details.
;;;;; 
;;;;; You should have received a copy of the GNU General Public License
;;;;; along with LysKOM; see the file COPYING.  If not, write to
;;;;; Lysator, c/o ISY, Linkoping University, S-581 83 Linkoping, SWEDEN,
;;;;; or the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, 
;;;;; MA 02139, USA.
;;;;;
;;;;; Please mail bug reports to bug-lyskom@lysator.liu.se. 
;;;;;
;;;; ================================================================
;;;; ================================================================
;;;;
28
;;;; File: filter.el
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
;;;;
;;;; Contains the support functions for text filtering.
;;;;


;;;============================================================
;;;
;;; Utility functions.
;;;
;;; These should be shared in LysKOM
;;;

(defun copy-tree (l)
  "Recursively copy the list L"
  (cond ((atom l) l)
        (t (cons (copy-tree (car l))
                 (copy-tree (cdr l))))))

47
48
49
50
51
52
53
54
(defun functionp (fn)
  "Return t if fn is callable"
  (or (compiled-function-p fn)
      (and (listp fn)
           (eq 'lambda (car fn)))
      (and (symbolp fn)
           (symbol-function fn))))

55
56
57
58
59
60
;;;============================================================
;;;
;;; Filter pattern accessors
;;;
;;; Filters are lists with the following structure
;;;
61
;;;   (filter [ PATTERNS ATTRIBUTES FUNCTION])
62
63
;;;
;;; Where PATTERNS is a list of filter patterns and ATTRIBUTES is
64
65
;;; an association list. FUNCTION is a lisp function implementing
;;; the filter.
66
67
68
69
70
71
72
73
74
75
76
;;;
;;; 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."
77
78
  (list 'filter (vector p a
			(lyskom-create-compile-filter-function p))))
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

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

119
120
121
122
123
124
125
126
127
(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))


128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
;;;============================================================
;;;
;;;


(defvar lyskom-filter-hack nil)

(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)
        (accept-process-output))
146
      lyskom-filter-hack)))
147
148
149
    
(defun lyskom-filter-text-p-2 (text-stat)
  (if (null text-stat)
David Byers's avatar
David Byers committed
150
      (setq lyskom-filter-hack nil)
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
    (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)
185
186
  (if (or (null text)
	  (null author))
187
      (setq lyskom-filter-hack nil)
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
    (let (subject recipient-list text-stat)
      
      ;;
      ;; 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 "")))
      
      ;;
      ;; Extract the text-stat
      ;; Shorten the list (quick'n'dirty)
      ;;
      
      (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)))))
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241

(defun lyskom-check-filter-list (text-stat
                                 author
                                 recipient-list
                                 subject
                                 text
                                 filter-list)
  (let (tmp)
    (while filter-list
      (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)))
        (if tmp
            (setq filter-list nil)
          (setq filter-list (cdr filter-list))))
    tmp))

242
243


244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261

;;;========================================
;;;  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)
David Byers's avatar
David Byers committed
262
263
      (byte-compile '(lambda (x y) nil))
    (byte-compile (lyskom-create-filter-function pattern))))
264
265
266
267
268
269
270


(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)
271
  (let (inverse tmp)
272
    (cond
273
274
     ;;
     ;; End of pattern
275
276
277
     ;; 
     
     ((null pattern) '((filter->attribute filter 'action)))
278
279
280
281

     ;;
     ;; Bad pattern
     ;;
282
283
284
285
286
287
288
     
     ((or (not (listp pattern))
          (not (listp (car pattern)))) 
      (lyskom-error 
       "%s"
       (lyskom-get-string 'filter-error-specification)))
     
289
290
291
     ;;
     ;; Assume valid pattern
     ;;
292
293
294
295
296
     
     (t
      (let ((key (car (car pattern)))
            (args (cdr (car pattern)))
            (form nil))
297
298
        (if (eq key 'not)
            (if (not (listp args))
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
355
356
357
358
359
360
361
362
363
364
365
                (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))))))))

      
366

367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
(defun lyskom-filter-check-args (fn arg)
  (if (not (funcall fn arg))
      (lyskom-error (lyskom-get-string 'filter-error-key-arg)
                    fn arg)))

(defun regexpp (re)
  (let ((result t))
    (save-match-data
      (condition-case nil
          (string-match re "")
        (error (setq result nil))))
    result))




;;;========================================
;;;  I don't actually remember what these are for
;;;
386
387
388

(defun lyskom-filter-prompt (text-no prompt)
  (setq lyskom-filter-hack t)
389
390
391
392
393
394
395
396
397
398
399
400
401
402
  (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))
403
		       (text->text-mass text)))
404
405
406
407
	       (lyskom-format-insert prompt
				     text-stat
				     subject
				     (or conf-stat
408
409
					 (text-stat->author text-stat)))
	       (lyskom-scroll))))))
410
411
  (setq lyskom-filter-hack nil))

412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484


;;;========================================
;;; 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 
                        (if kom-emacs-knows-iso-8859-1
                            lyskom-filter-actions
                          lyskom-swascii-filter-actions))
                       nil
                       nil
                       (cdr (car (if kom-emacs-knows-iso-8859-1
                                     lyskom-filter-actions
                                   lyskom-swascii-filter-actions)))
                       t)
      (if kom-emacs-knows-iso-8859-1
          lyskom-filter-actions
        lyskom-swascii-filter-actions)))))


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

(defun kom-filter-subject (&optional subject)
  "Interactively filter a subject. Optional SUBJECT is subject to filter."
  (interactive)
  (lyskom-start-of-command 'kom-filter-subject)
  (unwind-protect
      (if (/= 0 lyskom-current-conf)
	  (let ((conf-stat (blocking-do 'get-conf-stat lyskom-current-conf)))
	    (let (conf perm filter action)
	      (if (null subject)
		  (setq subject lyskom-current-subject))
	      (setq subject 
		    (read-from-minibuffer (lyskom-get-string 'filter-subject)
					  subject))
	      (setq filter (cons (cons 'subject subject) filter))
	      (setq conf (lyskom-read-conf-no
			  (lyskom-get-string 'filter-in-conf)
			  'all
			  t
			  (or (and (conf-stat->conf-no conf-stat)
				   (conf-stat->name conf-stat))
485
486
			      "")
			  t))
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
	      (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))))))))
    (lyskom-end-of-command)))
  

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

(defun kom-filter-author ()
  "Interactively filter an author."
  (interactive)
  (lyskom-start-of-command 'kom-filter-author)
  (unwind-protect
      (let (auth-stat author conf filter action permanent)
	(blocking-do-multiple ((text-stat (get-text-stat 
					   (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)
				      'pers
				      t
				      (or (and auth-stat
					       (conf-stat->name auth-stat))
523
524
					  "")
				      t))
525
526
527
528
529
530
531
532
533
	   (if (/= author 0)
	       (setq filter (cons (cons 'author-no author) filter)))
	   (setq conf (lyskom-read-conf-no
		       (lyskom-get-string 'filter-in-conf)
		       'all
		       t
		       (or 
			(and conf-stat
			     (conf-stat->name conf-stat))
534
535
			"")
		       t))
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
569
570
571
572
573
574
575
	   (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)))))))
    (lyskom-end-of-command)))




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

(defun kom-super-jump ()
  "Skip all texts and comments that share the subject and recipient of 
the current text"
  (interactive)
  (lyskom-start-of-command 'kom-super-jump)
  (unwind-protect
      (if (zerop lyskom-current-conf)
          (progn (lyskom-insert-string 'no-in-conf)
                 (lyskom-end-of-command))
        (if (or (null lyskom-current-text)
                (null lyskom-current-subject))
            (progn (lyskom-insert-string 'have-to-read)
                   (lyskom-end-of-command))
	  (let ((conf-stat (blocking-do 'get-conf-stat lyskom-current-conf)))
	    (if conf-stat
		(progn
		  (lyskom-add-filter
		   (make-filter
		    (list (cons 'subject lyskom-current-subject)
			  (cons 'recipient-no (conf-stat->conf-no conf-stat)))
		    (list (cons 'action 'skip-tree)
			  (cons 'expire t))))
576
		  (lyskom-format-insert 'super-jump
David Byers's avatar
David Byers committed
577
					(copy-sequence lyskom-current-subject)
578
					conf-stat))))))
579
580
581
582
583
584
585
586
587
588
589
    (lyskom-end-of-command)))




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

(defun kom-filter-text (&optional text)
590
  "Interactively filter on text contents. Optional TEXT is subject to filter."
591
592
593
594
595
596
597
598
599
600
601
602
  (interactive)
  (lyskom-start-of-command 'kom-filter-text)
  (unwind-protect
      (if (/= 0 lyskom-current-conf)
	  (let ((conf-stat (blocking-do 'get-conf-stat lyskom-current-conf))
		(conf nil)
		(action nil)
		(perm nil)
		(filter nil))
	    (if conf-stat
		(progn
		  (setq text 
603
604
			(read-from-minibuffer (lyskom-get-string 
					       'filter-which-text)
605
606
607
608
609
610
611
					      (or text "")))
		  (setq filter (cons (cons 'text text) filter))
		  (setq conf (lyskom-read-conf-no
			      (lyskom-get-string 'filter-in-conf)
			      'all t
			      (or (and (conf-stat->conf-no conf-stat)
				       (conf-stat->name conf-stat))
612
613
				  "")
			      t))
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
		  (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)))))))))


    (lyskom-end-of-command)))

  




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

(defun kom-list-filters ()
  "Display all filters"
  (interactive)
  (lyskom-start-of-command 'kom-view-filters)
  (save-excursion
    (unwind-protect
        (let ((filters lyskom-filter-list)
              (filter nil))
          (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
652
                (goto-char (point-max))
653
654
655
                (lyskom-format-filter-pattern (car filters))
                (setq filters (cdr filters)))
              (lyskom-insert (lyskom-get-string 'view-filters-footer)))))
656
657
      (progn (lyskom-insert "\n"))))
  (lyskom-end-of-command))
658