1 ;;; gnus-gl.el --- an interface to GroupLens for Gnus
2 ;; Copyright (C) 1995,96 Free Software Foundation, Inc.
4 ;; Author: Brad Miller <bmiller@cs.umn.edu>
5 ;; Keywords: news, score
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs is free software; you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs; see the file COPYING. If not, write to the
21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 ;; Boston, MA 02111-1307, USA.
26 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
27 ;; GroupLens software and documentation is copyright (c) 1995 by Paul
28 ;; Resnick (Massachusetts Institute of Technology); Brad Miller, John
29 ;; Riedl, Jon Herlocker, and Joseph Konstan (University of Minnesota),
30 ;; and David Maltz (Carnegie-Mellon University).
32 ;; Permission to use, copy, modify, and distribute this documentation
33 ;; for non-commercial and commercial purposes without fee is hereby
34 ;; granted provided that this copyright notice and permission notice
35 ;; appears in all copies and that the names of the individuals and
36 ;; institutions holding this copyright are not used in advertising or
37 ;; publicity pertaining to this software without specific, written
38 ;; prior permission. The copyright holders make no representations
39 ;; about the suitability of this software and documentation for any
40 ;; purpose. It is provided ``as is'' without express or implied
43 ;; The copyright holders request that they be notified of
44 ;; modifications of this code. Please send electronic mail to
45 ;; grouplens@cs.umn.edu for more information or to announce derived
47 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
48 ;; Author: Brad Miller
50 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
52 ;; User Documentation:
53 ;; To use GroupLens you must load this file.
54 ;; You must also register a pseudonym with the Better Bit Bureau.
55 ;; http://www.cs.umn.edu/Research/GroupLens
57 ;; ---------------- For your .emacs or .gnus file ----------------
59 ;; As of version 2.5, grouplens now works as a minor mode of
60 ;; gnus-summary-mode. To get make that work you just need a couple of
62 ;; (setq gnus-use-grouplens t)
63 ;; (setq grouplens-pseudonym "")
64 ;; (setq grouplens-bbb-host "grouplens.cs.umn.edu")
66 ;; (setq gnus-summary-default-score 0)
69 ;; How do I Rate an article??
70 ;; Before you type n to go to the next article, hit a number from 1-5
71 ;; Type r in the summary buffer and you will be prompted.
72 ;; Note that when you're in grouplens-minor-mode 'r' masks the
73 ;; usual reply binding for 'r'
75 ;; What if, Gasp, I find a bug???
76 ;; Please type M-x gnus-gl-submit-bug-report. This will set up a
77 ;; mail buffer with the state of variables and buffers that will help
78 ;; me debug the problem. A short description up front would help too!
80 ;; How do I display the prediction for an article:
81 ;; If you set the gnus-summary-line-format as shown above, the score
82 ;; (prediction) will be shown automatically.
85 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
88 ;; gnus-scores-articles contains the articles
89 ;; When scoring is done, the call tree looks something like:
90 ;; gnus-possibly-score-headers
91 ;; ==> gnus-score-headers
92 ;; ==> gnus-score-load-file
93 ;; ==> get-all-mids (from the eval form)
95 ;; it would be nice to have one that gets called after all the other
96 ;; headers have been scored.
97 ;; we may want a variable gnus-grouplens-scale-factor
98 ;; and gnus-grouplens-offset this would probably be either -3 or 0
99 ;; to make the scores centered around zero or not.
101 ;; According to Lars, Norse god of gnus, the simple way to insert a
102 ;; call to an external function is to have a function added to the
103 ;; variable gnus-score-find-files-function This new function
104 ;; gnus-grouplens-score-alist will return a core alist that
105 ;; has (("message-id" ("<message-id-xxxx>" score) ("<message-id-xxxy>" score))
106 ;; This seems like it would be pretty inefficient, though workable.
108 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
110 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
112 ;; 3. Add some more ways to rate messages
113 ;; 4. Better error handling for token timeouts.
115 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
117 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
122 (require 'gnus-score)
126 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
128 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
130 (defvar gnus-summary-grouplens-line-format
131 "%U\%R\%z%l%I\%(%[%4L: %-20,20n%]%) %s\n"
132 "*The line format spec in summary GroupLens mode buffers.")
134 (defvar grouplens-pseudonym ""
136 This pseudonym is obtained during the registration process")
138 (defvar grouplens-bbb-host "grouplens.cs.umn.edu"
139 "Host where the bbbd is running" )
141 (defvar grouplens-bbb-port 9000
142 "Port where the bbbd is listening" )
144 (defvar grouplens-newsgroups
145 '("comp.groupware" "comp.human-factors" "comp.lang.c++"
146 "comp.lang.java" "comp.os.linux.admin" "comp.os.linux.advocacy"
147 "comp.os.linux.announce" "comp.os.linux.answers"
148 "comp.os.linux.development" "comp.os.linux.development.apps"
149 "comp.os.linux.development.system" "comp.os.linux.hardware"
150 "comp.os.linux.help" "comp.os.linux.m68k" "comp.os.linux.misc"
151 "comp.os.linux.networking" "comp.os.linux.setup" "comp.os.linux.x"
152 "mn.general" "rec.arts.movies" "rec.arts.movies.current-films"
153 "rec.food.recipes" "rec.humor")
154 "*Groups that are part of the GroupLens experiment.")
156 (defvar grouplens-prediction-display 'prediction-spot
158 prediction-spot -- an * corresponding to the prediction between 1 and 5,
159 confidence-interval -- a numeric confidence interval
160 prediction-bar -- |##### | the longer the bar, the better the article,
161 confidence-bar -- | ----- } the prediction is in the middle of the bar,
162 confidence-spot -- ) * | the spot gets bigger with more confidence,
163 prediction-num -- plain-old numeric value,
164 confidence-plus-minus -- prediction +/i confidence")
166 (defvar grouplens-score-offset 0
167 "Offset the prediction by this value.
168 Setting this variable to -2 would have the following effect on
177 The reason is that a user might want to do this is to combine
178 GroupLens predictions with scores calculated by other score methods.")
180 (defvar grouplens-score-scale-factor 1
181 "This variable allows the user to magnify the effect of GroupLens scores.
182 The scale factor is applied after the offset.")
184 (defvar gnus-grouplens-override-scoring 'override
185 "Tell GroupLens to override the normal Gnus scoring mechanism.
186 GroupLens scores can be combined with gnus scores in one of three ways.
187 'override -- just use grouplens predictions for grouplens groups
188 'combine -- combine grouplens scores with gnus scores
189 'separate -- treat grouplens scores completely separate from gnus")
192 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
193 ;;;; Program global variables
194 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
195 (defvar grouplens-bbb-token "0"
196 "Current session token number")
198 (defvar grouplens-bbb-process nil
199 "Process Id of current bbbd network stream process")
201 (defvar grouplens-bbb-buffer nil
202 "Buffer associated with the BBBD process")
204 (defvar grouplens-rating-alist nil
205 "Current set of message-id rating pairs")
207 (defvar grouplens-current-hashtable nil
208 "A hashtable to hold predictions from the BBB")
210 (defvar grouplens-current-group nil)
212 ;;(defvar bbb-alist nil)
214 (defvar bbb-timeout-secs 10
215 "Number of seconds to wait for some response from the BBB.
216 If this times out we give up and assume that something has died..." )
218 (defvar grouplens-previous-article nil
219 "Message-ID of the last article read.")
221 (defvar bbb-read-point)
222 (defvar bbb-response-point)
224 (defun bbb-renew-hash-table ()
225 (setq grouplens-current-hashtable (make-vector 100 0)))
227 (bbb-renew-hash-table)
229 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
230 ;;;; Utility Functions
231 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
233 (defun bbb-connect-to-bbbd (host port)
234 (unless grouplens-bbb-buffer
235 (setq grouplens-bbb-buffer
236 (get-buffer-create (format " *BBBD trace: %s*" host)))
238 (set-buffer grouplens-bbb-buffer)
239 (make-local-variable 'bbb-read-point)
240 (make-local-variable 'bbb-response-point)
241 (setq bbb-read-point (point-min))))
243 ;; if an old process is still running for some reason, kill it
244 (when grouplens-bbb-process
246 (when (eq 'open (process-status grouplens-bbb-process))
247 (set-process-buffer grouplens-bbb-process nil)
248 (delete-process grouplens-bbb-process))
251 ;; clear the trace buffer of old output
253 (set-buffer grouplens-bbb-buffer)
256 ;; open the connection to the server
258 (condition-case error
259 (setq grouplens-bbb-process
260 (open-network-stream "BBBD" grouplens-bbb-buffer host port))
261 (error (gnus-message 3 "Error: Failed to connect to BBB")
263 (and (null grouplens-bbb-process)
266 (set-buffer grouplens-bbb-buffer)
267 (setq bbb-read-point (point-min))
268 (or (bbb-read-response grouplens-bbb-process)
271 ;; return the process
272 grouplens-bbb-process)
274 (defun bbb-send-command (process command)
275 (goto-char (point-max))
278 (setq bbb-read-point (point))
279 (setq bbb-response-point (point))
280 (set-marker (process-mark process) (point)) ; process output also comes here
281 (process-send-string process command)
282 (process-send-string process "\r\n")
283 (process-send-eof process))
285 (defun bbb-read-response (process)
286 "This function eats the initial response of OK or ERROR from the BBB."
287 (let ((case-fold-search nil)
289 (goto-char bbb-read-point)
290 (while (and (not (search-forward "\r\n" nil t))
291 (accept-process-output process bbb-timeout-secs))
292 (goto-char bbb-read-point))
293 (setq match-end (point))
294 (goto-char bbb-read-point)
295 (setq bbb-read-point match-end)
298 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
300 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
302 "return the token number if login is successful, otherwise return nil"
304 (setq grouplens-bbb-token nil)
305 (if (not (equal grouplens-pseudonym ""))
307 (bbb-connect-to-bbbd grouplens-bbb-host grouplens-bbb-port)))
310 (set-buffer (process-buffer bbb-process))
311 (bbb-send-command bbb-process
312 (concat "login " grouplens-pseudonym))
313 (if (bbb-read-response bbb-process)
314 (setq grouplens-bbb-token (bbb-extract-token-number))
315 (gnus-message 3 "Error: GroupLens login failed")))))
316 (gnus-message 3 "Error: you must set a pseudonym"))
319 (defun bbb-extract-token-number ()
320 (let ((token-pos (search-forward "token=" nil t) ))
321 (when (looking-at "[0-9]+")
322 (buffer-substring token-pos (match-end 0)))))
324 (gnus-add-shutdown 'bbb-logout 'gnus)
327 "logout of bbb session"
329 (bbb-connect-to-bbbd grouplens-bbb-host grouplens-bbb-port)))
332 (set-buffer (process-buffer bbb-process))
333 (bbb-send-command bbb-process (concat "logout " grouplens-bbb-token))
334 (bbb-read-response bbb-process))
337 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
339 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
341 (defun bbb-build-mid-scores-alist (groupname)
342 "this function can be called as part of the function to return the
343 list of score files to use. See the gnus variable
344 gnus-score-find-score-files-function.
346 *Note:* If you want to use grouplens scores along with calculated scores,
347 you should see the offset and scale variables. At this point, I don't
348 recommend using both scores and grouplens predictions together."
349 (setq grouplens-current-group groupname)
350 (when (member groupname grouplens-newsgroups)
351 (setq grouplens-previous-article nil)
352 ;; scores-alist should be a list of lists:
353 ;; ((("message-id" ("<mid1>" score1 nil s) ("<mid2> score2 nil s))))
354 ;;`((("message-id" . ,predict-list))) ; Yes, this is the return value
357 (list (append (list "message-id")
358 (bbb-get-predictions (bbb-get-all-mids) groupname)))))))
360 (defun bbb-get-predictions (midlist groupname)
361 "Ask the bbb for predictions, and build up the score alist."
362 (if (or (null grouplens-bbb-token)
363 (equal grouplens-bbb-token "0"))
365 (gnus-message 3 "Error: You are not logged in to a BBB")
367 (gnus-message 5 "Fetching Predictions...")
368 (let ((bbb-process (bbb-connect-to-bbbd grouplens-bbb-host
369 grouplens-bbb-port)))
372 (set-buffer (process-buffer bbb-process))
373 (bbb-send-command bbb-process
374 (bbb-build-predict-command midlist groupname
375 grouplens-bbb-token))
376 (if (not (bbb-read-response bbb-process))
378 (gnus-message 1 "Invalid Token, login and try again")
380 (bbb-get-prediction-response bbb-process)))))))
382 (defun bbb-get-all-mids ()
383 (mapcar (function (lambda (x) (mail-header-id x))) gnus-newsgroup-headers))
385 (defun bbb-build-predict-command (mlist grpname token)
386 (concat "getpredictions " token " " grpname "\r\n"
387 (mapconcat 'identity mlist "\r\n") "\r\n.\r\n"))
389 (defun bbb-get-prediction-response (process)
390 (let ((case-fold-search nil))
391 (goto-char bbb-read-point)
392 (while (and (not (search-forward ".\r\n" nil t))
393 (accept-process-output process bbb-timeout-secs))
394 (goto-char bbb-read-point))
395 (goto-char (+ bbb-response-point 4));; we ought to be right before OK
396 (bbb-build-response-alist)))
398 ;; build-response-alist assumes that the cursor has been positioned at
399 ;; the first line of the list of mid/rating pairs.
400 (defun bbb-build-response-alist ()
404 ((looking-at "\\(<.*>\\) :nopred=")
405 ;;(push `(,(bbb-get-mid) ,gnus-summary-default-score nil s) resp)
408 ((looking-at "\\(<.*>\\) :pred=\\([0-9]\.[0-9][0-9]\\) :conflow=\\([0-9]\.[0-9][0-9]\\) :confhigh=\\([0-9]\.[0-9][0-9]\\)")
409 (setq mid (bbb-get-mid)
411 (push `(,mid ,pred nil s) resp)
412 (gnus-sethash mid (list pred (bbb-get-confl) (bbb-get-confh))
413 grouplens-current-hashtable)
416 ((looking-at "\\(<.*>\\) :pred=\\([0-9]\.[0-9][0-9]\\)")
417 (setq mid (bbb-get-mid)
419 (push `(,mid ,pred nil s) resp)
420 (gnus-sethash mid (list pred 0 0) grouplens-current-hashtable)
426 ;; these "get" functions assume that there is an active match lying
427 ;; around. Where the first parenthesized expression is the
428 ;; message-id, and the second is the prediction, the third and fourth
429 ;; are the confidence interval
431 ;; Since gnus assumes that scores are integer values?? we round the
433 (defun bbb-get-mid ()
434 (buffer-substring (match-beginning 1) (match-end 1)))
436 (defun bbb-get-pred ()
437 (let ((tpred (string-to-number (buffer-substring (match-beginning 2)
440 (round (* grouplens-score-scale-factor
441 (+ grouplens-score-offset tpred)))
444 (defun bbb-get-confl ()
445 (string-to-number (buffer-substring (match-beginning 4) (match-end 4))))
447 (defun bbb-get-confh ()
448 (string-to-number (buffer-substring (match-beginning 4) (match-end 4))))
450 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
451 ;;;; Prediction Display
452 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
453 (defconst grplens-rating-range 4.0)
454 (defconst grplens-maxrating 5)
455 (defconst grplens-minrating 1)
456 (defconst grplens-predstringsize 12)
458 (defvar gnus-tmp-score)
459 (defun bbb-grouplens-score (header)
460 (if (eq gnus-grouplens-override-scoring 'separate)
461 (bbb-grouplens-other-score header)
462 (let* ((rate-string (make-string 12 ?\ ))
463 (mid (mail-header-id header))
464 (hashent (gnus-gethash mid grouplens-current-hashtable))
465 (iscore gnus-tmp-score)
466 (low (car (cdr hashent)))
467 (high (car (cdr (cdr hashent)))))
468 (aset rate-string 0 ?|)
469 (aset rate-string 11 ?|)
470 (unless (member grouplens-current-group grouplens-newsgroups)
471 (unless (equal grouplens-prediction-display 'prediction-num)
478 (if (and (bbb-valid-score iscore)
482 ((equal grouplens-prediction-display 'prediction-spot)
483 (setq rate-string (bbb-fmt-prediction-spot rate-string iscore)))
484 ;; confidence-interval
485 ((equal grouplens-prediction-display 'confidence-interval)
486 (setq rate-string (bbb-fmt-confidence-interval iscore low high)))
488 ((equal grouplens-prediction-display 'prediction-bar)
489 (setq rate-string (bbb-fmt-prediction-bar rate-string iscore)))
491 ((equal grouplens-prediction-display 'confidence-bar)
492 (setq rate-string (format "| %4.2f |" iscore)))
494 ((equal grouplens-prediction-display 'confidence-spot)
495 (setq rate-string (format "| %4.2f |" iscore)))
497 ((equal grouplens-prediction-display 'prediction-num)
498 (setq rate-string (bbb-fmt-prediction-num iscore)))
499 ;; confidence-plus-minus
500 ((equal grouplens-prediction-display 'confidence-plus-minus)
501 (setq rate-string (bbb-fmt-confidence-plus-minus iscore low high))
503 (t (gnus-message 3 "Invalid prediction display type")))
504 (aset rate-string 5 ?N) (aset rate-string 6 ?A))
507 ;; Gnus user format function that doesn't depend on
508 ;; bbb-build-mid-scores-alist being used as the score function, but is
509 ;; instead called from gnus-select-group-hook. -- LAB
510 (defun bbb-grouplens-other-score (header)
511 (if (not (member grouplens-current-group grouplens-newsgroups))
512 ;; Return an empty string
514 (let* ((rate-string (make-string 12 ?\ ))
515 (mid (mail-header-id header))
516 (hashent (gnus-gethash mid grouplens-current-hashtable))
517 (pred (or (nth 0 hashent) 0))
518 (low (nth 1 hashent))
519 (high (nth 2 hashent)))
521 (aset rate-string 0 ?|)
522 (aset rate-string 11 ?|)
523 (unless (equal grouplens-prediction-display 'prediction-num)
528 ;; If no entry in BBB hash mark rate string as NA and return
531 (aset rate-string 5 ?N)
532 (aset rate-string 6 ?A)
535 ((equal grouplens-prediction-display 'prediction-spot)
536 (bbb-fmt-prediction-spot rate-string pred))
538 ((equal grouplens-prediction-display 'confidence-interval)
539 (bbb-fmt-confidence-interval pred low high))
541 ((equal grouplens-prediction-display 'prediction-bar)
542 (bbb-fmt-prediction-bar rate-string pred))
544 ((equal grouplens-prediction-display 'confidence-bar)
545 (format "| %4.2f |" pred))
547 ((equal grouplens-prediction-display 'confidence-spot)
548 (format "| %4.2f |" pred))
550 ((equal grouplens-prediction-display 'prediction-num)
551 (bbb-fmt-prediction-num pred))
553 ((equal grouplens-prediction-display 'confidence-plus-minus)
554 (bbb-fmt-confidence-plus-minus pred low high))
557 (gnus-message 3 "Invalid prediction display type")
558 (aset rate-string 0 ?|)
559 (aset rate-string 11 ?|)
562 (defun bbb-valid-score (score)
563 (or (equal grouplens-prediction-display 'prediction-num)
564 (and (>= score grplens-minrating)
565 (<= score grplens-maxrating))))
567 (defun bbb-requires-confidence (format-type)
568 (or (equal format-type 'confidence-plus-minus)
569 (equal format-type 'confidence-spot)
570 (equal format-type 'confidence-interval)))
572 (defun bbb-have-confidence (clow chigh)
576 (defun bbb-fmt-prediction-spot (rate-string score)
578 (round (* (/ (- score grplens-minrating) grplens-rating-range)
579 (+ (- grplens-predstringsize 4) 1.49)))
583 (defun bbb-fmt-confidence-interval (score low high)
584 (if (bbb-have-confidence low high)
585 (format "|%4.2f-%4.2f |" low high)
586 (bbb-fmt-prediction-num score)))
588 (defun bbb-fmt-confidence-plus-minus (score low high)
589 (if (bbb-have-confidence low high)
590 (format "|%3.1f+/-%4.2f|" score (/ (- high low) 2.0))
591 (bbb-fmt-prediction-num score)))
593 (defun bbb-fmt-prediction-bar (rate-string score)
595 (step (/ grplens-rating-range (- grplens-predstringsize 4)))
596 (half-step (/ step 2))
597 (loc (- grplens-minrating half-step)))
598 (while (< i (- grplens-predstringsize 2))
600 (aset rate-string i ?#)
601 (aset rate-string i ?\ ))
603 (setq loc (+ loc step)))
607 (defun bbb-fmt-prediction-num (score)
608 (format "| %4.2f |" score))
610 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
612 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
614 (defun bbb-put-ratings ()
615 (if (and grouplens-rating-alist
616 (member gnus-newsgroup-name grouplens-newsgroups))
617 (let ((bbb-process (bbb-connect-to-bbbd grouplens-bbb-host
619 (rate-command (bbb-build-rate-command grouplens-rating-alist)))
622 (set-buffer (process-buffer bbb-process))
623 (gnus-message 5 "Sending Ratings...")
624 (bbb-send-command bbb-process rate-command)
625 (if (bbb-read-response bbb-process)
626 (setq grouplens-rating-alist nil)
628 "Token timed out: call bbb-login and quit again")
630 (gnus-message 5 "Sending Ratings...Done"))
631 (gnus-message 3 "No BBB connection")))
632 (setq grouplens-rating-alist nil)))
634 (defun bbb-build-rate-command (rate-alist)
635 (concat "putratings " grouplens-bbb-token " " grouplens-current-group " \r\n"
636 (mapconcat '(lambda (this) ; form (mid . (score . time))
638 " :rating=" (cadr this) ".00"
639 " :time=" (cddr this)))
643 ;; Interactive rating functions.
644 (defun bbb-summary-rate-article (rating &optional midin)
645 (interactive "nRating: ")
646 (when (member gnus-newsgroup-name grouplens-newsgroups)
647 (let ((mid (or midin (bbb-get-current-id))))
649 (>= rating grplens-minrating)
650 (<= rating grplens-maxrating)
652 (let ((oldrating (assoc mid grouplens-rating-alist)))
654 (setcdr oldrating (cons rating 0))
655 (push `(,mid . (,rating . 0)) grouplens-rating-alist))
656 (gnus-summary-mark-article nil (int-to-string rating)))
657 (gnus-message 3 "Invalid rating")))))
659 (defun grouplens-next-unread-article (rating)
660 "Select unread article after current one."
663 (bbb-summary-rate-article rating))
664 (gnus-summary-next-unread-article))
666 (defun grouplens-best-unread-article (rating)
667 "Select unread article after current one."
670 (bbb-summary-rate-article rating))
671 (gnus-summary-best-unread-article))
673 (defun grouplens-summary-catchup-and-exit (rating)
674 "Mark all articles not marked as unread in this newsgroup as read,
675 then exit. If prefix argument ALL is non-nil, all articles are
679 (bbb-summary-rate-article rating))
681 (gnus-summary-catchup-and-exit)
682 (gnus-summary-catchup-and-exit rating)))
684 (defun grouplens-score-thread (score)
685 "Raise the score of the articles in the current thread with SCORE."
686 (interactive "nRating: ")
689 (let ((articles (gnus-summary-articles-in-thread))
691 (while (setq article (pop articles))
692 (gnus-summary-goto-subject article)
693 (gnus-set-global-variables)
694 (bbb-summary-rate-article score
696 (gnus-summary-article-header article)))))
698 (let ((gnus-summary-check-current t))
699 (or (zerop (gnus-summary-next-subject 1 t))
701 (gnus-summary-recenter)
702 (gnus-summary-position-point)
703 (gnus-set-mode-line 'summary))
705 (defun bbb-exit-group ()
707 (bbb-renew-hash-table))
709 (defun bbb-get-current-id ()
710 (if gnus-current-headers
711 (mail-header-id gnus-current-headers)
712 (gnus-message 3 "You must select an article before you rate it")))
714 (defun bbb-grouplens-group-p (group)
715 "Say whether GROUP is a GroupLens group."
716 (if (member group grouplens-newsgroups) " (GroupLens Enhanced)" ""))
718 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
719 ;; TIME SPENT READING
720 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
721 (defvar grouplens-current-starting-time nil)
723 (defun grouplens-start-timer ()
724 (setq grouplens-current-starting-time (current-time)))
726 (defun grouplens-elapsed-time ()
727 (let ((et (bbb-time-float (current-time))))
728 (- et (bbb-time-float grouplens-current-starting-time))))
730 (defun bbb-time-float (timeval)
731 (+ (* (car timeval) 65536)
734 (defun grouplens-do-time ()
735 (when (member gnus-newsgroup-name grouplens-newsgroups)
736 (when grouplens-previous-article
737 (let ((elapsed-time (grouplens-elapsed-time))
738 (oldrating (assoc grouplens-previous-article
739 grouplens-rating-alist)))
741 (push `(,grouplens-previous-article . (0 . ,elapsed-time))
742 grouplens-rating-alist)
743 (setcdr oldrating (cons (cadr oldrating) elapsed-time)))))
744 (grouplens-start-timer)
745 (setq grouplens-previous-article (bbb-get-current-id))))
747 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
749 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
751 (defconst gnus-gl-version "gnus-gl.el 2.50")
752 (defconst gnus-gl-maintainer-address "grouplens-bug@cs.umn.edu")
753 (defun gnus-gl-submit-bug-report ()
754 "Submit via mail a bug report on gnus-gl"
757 (reporter-submit-bug-report gnus-gl-maintainer-address
758 (concat "gnus-gl.el " gnus-gl-version)
759 (list 'grouplens-pseudonym
762 'grouplens-newsgroups
764 'grouplens-bbb-process
765 'grouplens-current-group
766 'grouplens-previous-article)
770 (defun gnus-gl-get-trace ()
771 "Insert the contents of the BBBD trace buffer"
772 (when grouplens-bbb-buffer
773 (insert-buffer grouplens-bbb-buffer)))
776 ;; GroupLens minor mode
779 (defvar gnus-grouplens-mode nil
780 "Minor mode for providing a GroupLens interface in Gnus summary buffers.")
782 (defvar gnus-grouplens-mode-map nil)
784 (unless gnus-grouplens-mode-map
785 (setq gnus-grouplens-mode-map (make-keymap))
787 gnus-grouplens-mode-map
788 "n" grouplens-next-unread-article
789 "r" bbb-summary-rate-article
790 "k" grouplens-score-thread
791 "c" grouplens-summary-catchup-and-exit
792 "," grouplens-best-unread-article))
794 (defun gnus-grouplens-make-menu-bar ()
795 (unless (boundp 'gnus-grouplens-menu)
797 gnus-grouplens-menu gnus-grouplens-mode-map ""
799 ["Login" bbb-login t]
800 ["Rate" bbb-summary-rate-article t]
801 ["Next article" grouplens-next-unread-article t]
802 ["Best article" grouplens-best-unread-article t]
803 ["Raise thread" grouplens-score-thread t]
804 ["Report bugs" gnus-gl-submit-bug-report t]))))
806 (defun gnus-grouplens-mode (&optional arg)
807 "Minor mode for providing a GroupLens interface in Gnus summary buffers."
809 (when (and (eq major-mode 'gnus-summary-mode)
810 (member gnus-newsgroup-name grouplens-newsgroups))
811 (make-local-variable 'gnus-grouplens-mode)
812 (setq gnus-grouplens-mode
813 (if (null arg) (not gnus-grouplens-mode)
814 (> (prefix-numeric-value arg) 0)))
815 (when gnus-grouplens-mode
816 (gnus-make-local-hook 'gnus-select-article-hook)
817 (gnus-add-hook 'gnus-select-article-hook 'grouplens-do-time nil 'local)
818 (gnus-make-local-hook 'gnus-exit-group-hook)
819 (gnus-add-hook 'gnus-exit-group-hook 'bbb-exit-group nil 'local)
820 (make-local-variable 'gnus-score-find-score-files-function)
823 ((eq gnus-grouplens-override-scoring 'combine)
824 ;; either add bbb-buld-mid-scores-alist to a list
826 (if (listp gnus-score-find-score-files-function)
827 (setq gnus-score-find-score-files-function
828 (append 'bbb-build-mid-scores-alist
829 gnus-score-find-score-files-function))
830 (setq gnus-score-find-score-files-function
831 (list gnus-score-find-score-files-function
832 'bbb-build-mid-scores-alist))))
833 ;; leave the gnus-score-find-score-files variable alone
834 ((eq gnus-grouplens-override-scoring 'separate)
835 (add-hook 'gnus-select-group-hook
837 (bbb-get-predictions (bbb-get-all-mids)
838 gnus-newsgroup-name))))
839 ;; default is to override
841 (setq gnus-score-find-score-files-function
842 'bbb-build-mid-scores-alist)))
844 ;; Change how summary lines look
845 (make-local-variable 'gnus-summary-line-format)
846 (make-local-variable 'gnus-summary-line-format-spec)
847 (setq gnus-summary-line-format gnus-summary-grouplens-line-format)
848 (setq gnus-summary-line-format-spec nil)
849 (gnus-update-format-specifications nil 'summary)
850 (gnus-update-summary-mark-positions)
853 (when (and menu-bar-mode
854 (gnus-visual-p 'grouplens-menu 'menu))
855 (gnus-grouplens-make-menu-bar))
856 (unless (assq 'gnus-grouplens-mode minor-mode-alist)
857 (push '(gnus-grouplens-mode " GroupLens") minor-mode-alist))
858 (unless (assq 'gnus-grouplens-mode minor-mode-map-alist)
859 (push (cons 'gnus-grouplens-mode gnus-grouplens-mode-map)
860 minor-mode-map-alist))
861 (run-hooks 'gnus-grouplens-mode-hook))))
865 ;;; gnus-gl.el ends here