cgit.sxemacs.org Git - gnus/blob - lisp/gnus-gl.el

   1 ;;; gnus-gl.el --- an interface to GroupLens for Gnus
   2 ;; Copyright (C) 1995,96 Free Software Foundation, Inc.
   3
   4 ;; Author: Brad Miller <bmiller@cs.umn.edu>
   5 ;; Keywords: news, score
   6
   7 ;; This file is part of GNU Emacs.
   8
   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)
  12 ;; any later version.
  13
  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.
  18
  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.
  23
  24 ;;; Commentary:
  25
  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).
  31 ;;
  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
  41 ;; warranty.
  42 ;;
  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
  46 ;; works.
  47 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  48 ;; Author: Brad Miller
  49 ;;
  50 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  51 ;;
  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
  56 ;;
  57 ;;    ---------------- For your .emacs or .gnus file ----------------
  58 ;;
  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
  61 ;; hooks.
  62 ;; (setq gnus-use-grouplens t)
  63 ;; (setq grouplens-pseudonym "")
  64 ;; (setq grouplens-bbb-host "grouplens.cs.umn.edu")
  65 ;;
  66 ;; (setq gnus-summary-default-score 0)
  67 ;;
  68 ;;                              USING GROUPLENS
  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' maskes the
  73 ;;   usual reply binding for 'r'
  74 ;;
  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!
  79 ;;
  80 ;; How do I display the prediction for an aritcle:
  81 ;;  If you set the gnus-summary-line-format as shown above, the score
  82 ;;  (prediction) will be shown automatically.
  83 ;;
  84 ;;
  85 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  86 ;; Programmer  Notes
  87 ;; 10/9/95
  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)
  94 ;;
  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.
 100 ;; Notes 10/12/95
 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.
 107 ;;
 108 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 109 ;;  TODO
 110 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 111 ;;
 112 ;; 3. Add some more ways to rate messages
 113 ;; 4. Better error handling for token timeouts.
 114 ;;
 115 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 116 ;; bugs
 117 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 118 ;;
 119
 120 ;;; Code:
 121
 122 (require 'gnus-score)
 123 (eval-and-compile (require 'cl))
 124
 125 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 126 ;;;; User variables
 127 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 128
 129 (defvar gnus-summary-grouplens-line-format
 130   "%U%R%z%l%I%(%[%4L: %-20,20n%]%) %s\n"
 131   "*The line format spec in summary GroupLens mode buffers.")
 132
 133 (defvar gnus-summary-grouplens-lab-line-format
 134   "%U%R%z%uL%I%(%[%4L: %-20,20n%]%) %s\n"
 135   "*The line format spec in summary GroupLens mode buffers.")
 136
 137 (defvar grouplens-pseudonym ""
 138   "User's pseudonym.  This pseudonym is obtained during the registration process")
 139
 140 (defvar grouplens-bbb-host "grouplens.cs.umn.edu"
 141   "Host where the bbbd is running" )
 142
 143 (defvar grouplens-bbb-port 9000
 144   "Port where the bbbd is listening" )
 145
 146 (defvar grouplens-newsgroups
 147   '("comp.lang.c++" "rec.humor" "rec.food.recipes" "comp.groupware"
 148     "mn.general" "rec.arts.movies" "rec.arts.movies.current-films"
 149     "comp.lang.java" "comp.os.linux.announce" "comp.os.linux.misc"
 150     "comp.os.linux.development.apps" "comp.os.linux.development.system")
 151   "*Groups that are part of the GroupLens experiment.")
 152
 153 (defvar grouplens-prediction-display 'prediction-spot
 154   "valid values are:
 155       prediction-spot -- an * corresponding to the prediction between 1 and 5,
 156       confidence-interval -- a numeric confidence interval
 157       prediction-bar --  |#####     | the longer the bar, the better the article,
 158       confidence-bar --  |  -----   } the prediction is in the middle of the bar,
 159       confidence-spot -- )  *       | the spot gets bigger with more confidence,
 160       prediction-num  --   plain-old numeric value,
 161       confidence-plus-minus  -- prediction +/i confidence")
 162
 163 (defvar grouplens-score-offset 0
 164   "Offset the prediction by this value.
 165 Setting this variable to -2 would have the following effect on grouplens
 166 scores:
 167    1   -->   -2
 168    2   -->   -1
 169    3   -->    0
 170    4   -->    1
 171    5   -->    2
 172
 173 the reason a user might want to do this is to combine grouplens
 174 predictions with scores calculated by other score methods")
 175
 176 (defvar grouplens-score-scale-factor 1
 177   "This variable allow sthe user to magify the effect of grouplens scores.
 178 The scale factor is applied after the offset.")
 179
 180 (defvar gnus-grouplens-override-scoring t
 181   "Tell Grouplens to override the normal Gnus scoring mechanism.
 182 If this variable is non-nill than Grouplens will completely override
 183 the normal scoring mechanism of Gnus.  When nil, Grouplens will not
 184 override the normal scoring mechanism so both can be used at once.")
 185
 186 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 187 ;;;; Program global variables
 188 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 189 (defvar grouplens-bbb-token "0"
 190   "Current session token number")
 191
 192 (defvar grouplens-bbb-process nil
 193   "Process Id of current bbbd network stream process")
 194
 195 (defvar grouplens-bbb-buffer nil
 196   "Buffer associated with the BBBD process")
 197
 198 (defvar grouplens-rating-alist nil
 199   "Current set of  message-id rating pairs")
 200
 201 (defvar grouplens-current-hashtable (make-hash-table :test 'equal :size 100))
 202 ;; this seems like a pretty ugly way to get around the problem, but If
 203 ;; I don't do this, then the compiler complains when I call gethash
 204 ;;
 205 (eval-when-compile (setq grouplens-current-hashtable
 206                          (make-hash-table :test 'equal :size 100)))
 207
 208 (defvar grouplens-current-group nil)
 209
 210 (defvar bbb-mid-list nil)
 211
 212 (defvar bbb-alist nil)
 213
 214 (defvar bbb-timeout-secs 10
 215   "Number of seconds to wait for some response from the BBB before
 216     we give up and assume that something has died..." )
 217
 218 (defvar grouplens-previous-article nil
 219   "message-id of the last article read")
 220
 221 (defvar bbb-read-point)
 222 (defvar bbb-response-point)
 223
 224 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 225 ;;;;  Utility Functions
 226 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 227 (defun bbb-connect-to-bbbd (host port)
 228   (unless grouplens-bbb-buffer
 229     (setq grouplens-bbb-buffer
 230           (get-buffer-create (format " *BBBD trace: %s*" host)))
 231     (save-excursion
 232       (set-buffer grouplens-bbb-buffer)
 233       (make-local-variable 'bbb-read-point)
 234       (setq bbb-read-point (point-min))))
 235   ;; clear the trace buffer of old output
 236   (save-excursion
 237     (set-buffer grouplens-bbb-buffer)
 238     (erase-buffer))
 239   ;; open the connection to the server
 240   (setq grouplens-bbb-process nil)
 241   (catch 'done
 242     (condition-case error
 243         (setq grouplens-bbb-process
 244               (open-network-stream "BBBD" grouplens-bbb-buffer host port))
 245       (error (gnus-message 3 "Error: Failed to connect to BBB")
 246              nil))
 247     (and (null grouplens-bbb-process)
 248          (throw 'done nil))
 249     ;; (set-process-filter grouplens-bbb-process 'bbb-process-filter)
 250     (save-excursion
 251       (set-buffer grouplens-bbb-buffer)
 252       (setq bbb-read-point (point-min))
 253       (or (bbb-read-response grouplens-bbb-process)
 254           (throw 'done nil))))
 255   grouplens-bbb-process)
 256
 257 ;; (defun bbb-process-filter (process output)
 258 ;;   (save-excursion
 259 ;;     (set-buffer (bbb-process-buffer process))
 260 ;;     (goto-char (point-max))
 261 ;;     (insert output)))
 262
 263 (defun bbb-send-command (process command)
 264   (goto-char (point-max))
 265   (insert command)
 266   (insert "\r\n")
 267   (setq bbb-read-point (point))
 268   (setq bbb-response-point (point))
 269   (set-marker (process-mark process) (point)) ; process output also comes here
 270   (process-send-string process command)
 271   (process-send-string process "\r\n"))
 272
 273 (defun bbb-read-response (process) ; &optional return-response-string)
 274   "This function eats the initial response of OK or ERROR from the BBB."
 275   (let ((case-fold-search nil)
 276          match-end)
 277     (goto-char bbb-read-point)
 278     (while (and (not (search-forward "\r\n" nil t))
 279                 (accept-process-output process bbb-timeout-secs))
 280       (goto-char bbb-read-point))
 281     (setq match-end (point))
 282     (goto-char bbb-read-point)
 283     (setq bbb-read-point match-end)
 284     (looking-at "OK")))
 285
 286 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 287 ;;;;       Login Functions
 288 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 289 (defun bbb-login ()
 290   "return the token number if login is successful, otherwise return nil"
 291   (interactive)
 292   (setq grouplens-bbb-token nil)
 293   (if (not (equal grouplens-pseudonym ""))
 294       (let ((bbb-process
 295              (bbb-connect-to-bbbd grouplens-bbb-host grouplens-bbb-port)))
 296         (if bbb-process
 297             (save-excursion
 298               (set-buffer (process-buffer bbb-process))
 299               (bbb-send-command bbb-process
 300                                 (concat "login " grouplens-pseudonym))
 301               (if (bbb-read-response bbb-process)
 302                   (setq grouplens-bbb-token (bbb-extract-token-number))
 303                 (gnus-message 3 "Error: Grouplens login failed")))))
 304     (gnus-message 3 "Error: you must set a pseudonym"))
 305   grouplens-bbb-token)
 306
 307 (defun bbb-extract-token-number ()
 308   (let ((token-pos (search-forward "token=" nil t) ))
 309     (if (looking-at "[0-9]+")
 310         (buffer-substring token-pos (match-end 0)))))
 311
 312 (gnus-add-shutdown 'bbb-logout 'gnus)
 313
 314 (defun bbb-logout ()
 315   "logout of bbb session"
 316   (let ((bbb-process
 317          (bbb-connect-to-bbbd grouplens-bbb-host grouplens-bbb-port)))
 318     (if bbb-process
 319         (save-excursion
 320           (set-buffer (process-buffer bbb-process))
 321           (bbb-send-command bbb-process (concat "logout " grouplens-bbb-token))
 322           (bbb-read-response bbb-process))
 323       nil)))
 324
 325 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 326 ;;;;       Get Predictions
 327 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 328
 329 (defun bbb-build-mid-scores-alist (groupname)
 330   "this function can be called as part of the function to return the
 331 list of score files to use. See the gnus variable
 332 gnus-score-find-score-files-function.
 333
 334 *Note:*  If you want to use grouplens scores along with calculated scores,
 335 you should see the offset and scale variables.  At this point, I don't
 336 recommend using both scores and grouplens predictions together."
 337   (setq grouplens-current-group groupname)
 338   (if (member groupname grouplens-newsgroups)
 339       (let* ((mid-list (bbb-get-all-mids))
 340              (predict-list (bbb-get-predictions mid-list groupname)))
 341         (setq grouplens-previous-article nil)
 342         ;; scores-alist should be a list of lists:
 343         ;;  ((("message-id" ("<mid1>" score1 nil s) ("<mid2> score2 nil s))))
 344         ;;`((("message-id" . ,predict-list))) ; Yes, this is the return value
 345         (list (list (list (append (list "message-id") predict-list)))))
 346     nil))
 347
 348 (defun bbb-get-predictions (midlist groupname)
 349   "Ask the bbb for predictions, and build up the score alist."
 350   (if (or (null grouplens-bbb-token)
 351           (equal grouplens-bbb-token "0"))
 352       (gnus-message 3 "Error: You are not logged in to a BBB")
 353     (gnus-message 5 "Fetching Predictions...")
 354     (let (predict-list
 355           (predict-command (build-predict-command midlist groupname
 356                                                   grouplens-bbb-token))
 357           (bbb-process (bbb-connect-to-bbbd grouplens-bbb-host
 358                                             grouplens-bbb-port)))
 359       (if bbb-process
 360           (save-excursion
 361             (set-buffer (process-buffer bbb-process))
 362             (bbb-send-command bbb-process predict-command)
 363             (if (bbb-read-response bbb-process)
 364                 (setq predict-list (bbb-get-prediction-response bbb-process))
 365               (gnus-message 1 "Invalid Token, login and try again")
 366               (ding))))
 367       (setq bbb-alist predict-list))))
 368
 369 (defun bbb-get-all-mids ()
 370   (let ((index (nth 1 (assoc "message-id" gnus-header-index)))
 371         (articles gnus-newsgroup-headers)
 372         art this)
 373     (setq bbb-mid-list nil)
 374     (while articles
 375       (progn (setq art (car articles)
 376                    this (aref art index)
 377                    articles (cdr articles))
 378              (setq bbb-mid-list (cons this bbb-mid-list))))
 379     bbb-mid-list))
 380
 381 (defun build-predict-command (mlist grpname token)
 382   (let ((cmd (concat "getpredictions " token " " grpname "\r\n"))
 383         art)
 384     (while mlist
 385       (setq art (car mlist)
 386             cmd (concat cmd art "\r\n")
 387             mlist (cdr mlist)))
 388     (setq cmd (concat cmd ".\r\n"))
 389   cmd))
 390
 391 (defun bbb-get-prediction-response (process)
 392   (let ((case-fold-search nil)
 393         match-end)
 394     (goto-char bbb-read-point)
 395     (while (and (not (search-forward ".\r\n" nil t))
 396                 (accept-process-output process bbb-timeout-secs))
 397       (goto-char bbb-read-point))
 398     (setq match-end (point))
 399     (goto-char (+ bbb-response-point 4))  ;; we ought to be right before OK
 400     (build-response-alist)))
 401
 402 ;; build-response-alist assumes that the cursor has been positioned at
 403 ;; the first line of the list of mid/rating pairs.  For now we will
 404 ;; use a prediction of 99 to signify no prediction.  Ultimately, we
 405 ;; should just ignore messages with no predictions.
 406 (defun build-response-alist ()
 407   (let ((resp nil)
 408         (match-end (point)))
 409     (setq grouplens-current-hashtable (make-hash-table :test 'equal :size 100))
 410     (while
 411         (cond ((looking-at "\\(<.*>\\) :nopred=")
 412                (push `(,(bbb-get-mid) ,gnus-summary-default-score nil s) resp)
 413                (forward-line 1)
 414                t)
 415               ((looking-at "\\(<.*>\\) :pred=\\([0-9]\.[0-9][0-9]\\) :conflow=\\([0-9]\.[0-9][0-9]\\) :confhigh=\\([0-9]\.[0-9][0-9]\\)")
 416                (push `(,(bbb-get-mid) ,(bbb-get-pred) nil s) resp)
 417                (cl-puthash (bbb-get-mid)
 418                            (list (bbb-get-pred) (bbb-get-confl) (bbb-get-confh))
 419                            grouplens-current-hashtable)
 420                (forward-line 1)
 421                t)
 422               ((looking-at "\\(<.*>\\) :pred=\\([0-9]\.[0-9][0-9]\\)")
 423                (push `(,(bbb-get-mid) ,(bbb-get-pred) nil s) resp)
 424                (cl-puthash (bbb-get-mid)
 425                            (list (bbb-get-pred) 0 0)
 426                            grouplens-current-hashtable)
 427                (forward-line 1)
 428                t)
 429               (t nil)))
 430     resp))
 431
 432 ;; these two functions assume that there is an active match lying
 433 ;; around.  Where the first parenthesized expression is the
 434 ;; message-id, and the second is the prediction.  Since gnus assumes
 435 ;; that scores are integer values?? we round the prediction.
 436 (defun bbb-get-mid ()
 437   (buffer-substring (match-beginning 1) (match-end 1)))
 438
 439 (defun bbb-get-pred ()
 440   (let ((tpred (round (string-to-int (buffer-substring
 441                                       (match-beginning 2)
 442                                       (match-end 2))))))
 443     (if (> tpred 0)
 444         (* grouplens-score-scale-factor (+ grouplens-score-offset  tpred))
 445       1)))
 446
 447 (defun bbb-get-confl ()
 448   (string-to-number (buffer-substring (match-beginning 3) (match-end 3))))
 449
 450 (defun bbb-get-confh ()
 451   (string-to-number (buffer-substring (match-beginning 4) (match-end 4))))
 452
 453 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 454 ;;;;      Prediction Display
 455 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 456 (defconst grplens-rating-range 4.0)
 457 (defconst grplens-maxrating 5)
 458 (defconst grplens-minrating 1)
 459 (defconst grplens-predstringsize 12)
 460
 461 (defvar gnus-tmp-score)
 462 (defun bbb-grouplens-score (header)
 463   (let* ((rate-string (make-string 12 ? ))
 464          (mid (aref header (nth 1 (assoc "message-id" gnus-header-index))))
 465          (hashent (gethash mid grouplens-current-hashtable))
 466          (iscore gnus-tmp-score)
 467          (low (car (cdr hashent)))
 468          (high (car (cdr (cdr hashent)))))
 469     (aset rate-string 0 ?|)
 470     (aset rate-string 11 ?|)
 471     (unless (member grouplens-current-group grouplens-newsgroups)
 472       (unless (equal grouplens-prediction-display 'prediction-num)
 473         (cond ((< iscore 0)
 474                (setq iscore 1))
 475               ((> iscore 5)
 476                (setq iscore 5))))
 477       (setq low 0)
 478       (setq high 0))
 479     (if (and (bbb-valid-score iscore)
 480              (not (null mid)))
 481         (cond
 482          ;; prediction-spot
 483          ((equal grouplens-prediction-display 'prediction-spot)
 484           (setq rate-string (bbb-fmt-prediction-spot rate-string iscore)))
 485          ;; confidence-interval
 486          ((equal grouplens-prediction-display 'confidence-interval)
 487           (setq rate-string (bbb-fmt-confidence-interval iscore low high)))
 488          ;; prediction-bar
 489          ((equal grouplens-prediction-display 'prediction-bar)
 490           (setq rate-string (bbb-fmt-prediction-bar rate-string iscore)))
 491          ;; confidence-bar
 492          ((equal grouplens-prediction-display 'confidence-bar)
 493           (setq rate-string (format "|   %4.2f   |" iscore)))
 494          ;; confidence-spot
 495          ((equal grouplens-prediction-display 'confidence-spot)
 496           (setq rate-string (format "|   %4.2f   |" iscore)))
 497          ;; prediction-num
 498          ((equal grouplens-prediction-display 'prediction-num)
 499           (setq rate-string (bbb-fmt-prediction-num iscore)))
 500          ;; confidence-plus-minus
 501          ((equal grouplens-prediction-display 'confidence-plus-minus)
 502                (setq rate-string (bbb-fmt-confidence-plus-minus iscore low high))
 503                )
 504          (t (gnus-message 3 "Invalid prediction display type")))
 505       (aset rate-string 5 ?N) (aset rate-string 6 ?A))
 506     rate-string))
 507
 508 ;;
 509 ;; Gnus user format function that doesn't depend on
 510 ;; bbb-build-mid-scores-alist being used as the score function, but is
 511 ;; instead called from gnus-select-group-hook. -- LAB
 512 (defun gnus-user-format-function-L (header)
 513   (if (not (member grouplens-current-group grouplens-newsgroups))
 514       ;; Return an empty string
 515       ""
 516     (let* ((rate-string (make-string 12 ? ))
 517            (mid (aref header (nth 1 (assoc "message-id" gnus-header-index))))
 518            (hashent (gethash mid grouplens-current-hashtable))
 519            (pred (or (nth 0 hashent) 0))
 520            (low (nth 1 hashent))
 521            (high (nth 2 hashent)))
 522       ;; Init rate-string
 523       (aset rate-string 0 ?|)
 524       (aset rate-string 11 ?|)
 525       (unless (equal grouplens-prediction-display 'prediction-num)
 526         (cond ((< pred 0)
 527                (setq pred 1))
 528               ((> pred 5)
 529                (setq pred 5))))
 530       ;; If no entry in BBB hash mark rate string as NA and return
 531       (cond
 532        ((null hashent)
 533         (aset rate-string 5 ?N)
 534         (aset rate-string 6 ?A)
 535         rate-string)
 536
 537        ((equal grouplens-prediction-display 'prediction-spot)
 538         (bbb-fmt-prediction-spot rate-string pred))
 539
 540        ((equal grouplens-prediction-display 'confidence-interval)
 541         (bbb-fmt-confidence-interval pred low high))
 542
 543        ((equal grouplens-prediction-display 'prediction-bar)
 544         (bbb-fmt-prediction-bar rate-string pred))
 545
 546        ((equal grouplens-prediction-display 'confidence-bar)
 547         (format "|   %4.2f   |" pred))
 548
 549        ((equal grouplens-prediction-display 'confidence-spot)
 550         (format "|   %4.2f   |" pred))
 551
 552        ((equal grouplens-prediction-display 'prediction-num)
 553         (bbb-fmt-prediction-num pred))
 554
 555        ((equal grouplens-prediction-display 'confidence-plus-minus)
 556         (bbb-fmt-confidence-plus-minus pred low high))
 557
 558        (t
 559         (gnus-message 3 "Invalid prediction display type")
 560         (aset rate-string 0 ?|)
 561         (aset rate-string 11 ?|)
 562         rate-string)))))
 563
 564 (defun bbb-valid-score (score)
 565   (or (equal grouplens-prediction-display 'prediction-num)
 566       (and (>= score grplens-minrating)
 567            (<= score grplens-maxrating))))
 568
 569 (defun bbb-requires-confidence (format-type)
 570   (or (equal format-type 'confidence-plus-minus)
 571       (equal format-type 'confidence-spot)
 572       (equal format-type 'confidence-interval)))
 573
 574 (defun bbb-have-confidence (clow chigh)
 575   (not (or (null clow)
 576            (null chigh))))
 577
 578 (defun bbb-fmt-prediction-spot (rate-string score)
 579   (aset rate-string
 580         (round (* (/ (- score grplens-minrating) grplens-rating-range)
 581                   (+ (- grplens-predstringsize 4) 1.49)))
 582         ?*)
 583   rate-string)
 584
 585 (defun bbb-fmt-confidence-interval (score low high)
 586   (if (bbb-have-confidence low high)
 587       (format "|%4.2f-%4.2f |" low high)
 588     (bbb-fmt-prediction-num score)))
 589
 590 (defun bbb-fmt-confidence-plus-minus (score low high)
 591   (if (bbb-have-confidence low high)
 592       (format "|%3.1f+/-%4.2f|" score (/ (- high low) 2.0))
 593     (bbb-fmt-prediction-num score)))
 594
 595 (defun bbb-fmt-prediction-bar (rate-string score)
 596   (let* ((i 1)
 597          (step (/ grplens-rating-range (- grplens-predstringsize 4)))
 598          (half-step (/ step 2))
 599          (loc (- grplens-minrating half-step)))
 600     (while (< i (- grplens-predstringsize 2))
 601       (if (> score loc)
 602           (aset rate-string i ?#)
 603         (aset rate-string i ? ))
 604       (setq i (+ i 1))
 605       (setq loc (+ loc step)))
 606     )
 607   rate-string)
 608
 609 (defun bbb-fmt-prediction-num (score)
 610   (format "|   %4.2f   |" score))
 611
 612 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 613 ;;;;       Put Ratings
 614 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 615
 616 ;; The message-id for the current article can be found in
 617 ;; (aref gnus-current-headers (nth 1 (assoc "message-id" gnus-header-index)))
 618
 619 (defun bbb-put-ratings ()
 620   (if (and grouplens-rating-alist
 621            (member gnus-newsgroup-name grouplens-newsgroups))
 622       (let ((bbb-process (bbb-connect-to-bbbd grouplens-bbb-host
 623                                           grouplens-bbb-port))
 624             (rate-command (build-rate-command grouplens-rating-alist)))
 625         (if bbb-process
 626             (save-excursion
 627               (set-buffer (process-buffer bbb-process))
 628               (gnus-message 5 "Sending Ratings...")
 629               (bbb-send-command bbb-process rate-command)
 630               (if (bbb-read-response bbb-process)
 631                   (setq grouplens-rating-alist nil)
 632                 (gnus-message 1
 633                               "Token timed out: call bbb-login and quit again")
 634                 (ding))
 635               (gnus-message 5 "Sending Ratings...Done"))
 636           (gnus-message 3 "No BBB connection")))
 637     (setq grouplens-rating-alist nil)))
 638
 639 (defun build-rate-command (rate-alist)
 640   (let (this
 641         (cmd (concat "putratings " grouplens-bbb-token
 642                      " " grouplens-current-group " \r\n")))
 643     (while rate-alist
 644       (setq this (car rate-alist)
 645             cmd (concat cmd (car this) " :rating=" (cadr this) ".00"
 646                         " :time=" (cddr this) "\r\n")
 647             rate-alist (cdr rate-alist)))
 648     (concat cmd ".\r\n")))
 649
 650 ;; Interactive rating functions.
 651 (defun bbb-summary-rate-article (rating &optional midin)
 652   (interactive "nRating: ")
 653   (when (member gnus-newsgroup-name grouplens-newsgroups)
 654     (let ((mid (or midin (bbb-get-current-id))))
 655       (if (and rating
 656                (>= rating grplens-minrating)
 657                (<= rating grplens-maxrating)
 658                mid)
 659           (let ((oldrating (assoc mid grouplens-rating-alist)))
 660             (if oldrating
 661                 (setcdr oldrating (cons rating 0))
 662               (push `(,mid . (,rating . 0)) grouplens-rating-alist))
 663             (gnus-summary-mark-article nil (int-to-string rating)))
 664         (gnus-message 3 "Invalid rating")))))
 665
 666 (defun grouplens-next-unread-article (rating)
 667   "Select unread article after current one."
 668   (interactive "P")
 669   (if rating (bbb-summary-rate-article rating))
 670   (gnus-summary-next-unread-article))
 671
 672 (defun grouplens-best-unread-article (rating)
 673   "Select unread article after current one."
 674   (interactive "P")
 675   (if rating (bbb-summary-rate-article rating))
 676   (gnus-summary-best-unread-article))
 677
 678 (defun grouplens-summary-catchup-and-exit (rating)
 679    "Mark all articles not marked as unread in this newsgroup as read,
 680     then exit.   If prefix argument ALL is non-nil, all articles are
 681     marked as read."
 682    (interactive "P")
 683    (if rating
 684        (bbb-summary-rate-article rating))
 685    (if (numberp rating)
 686        (gnus-summary-catchup-and-exit)
 687      (gnus-summary-catchup-and-exit rating)))
 688
 689 (defun grouplens-score-thread (score)
 690   "Raise the score of the articles in the current thread with SCORE."
 691   (interactive "nRating: ")
 692   (let (e)
 693     (save-excursion
 694       (let ((articles (gnus-summary-articles-in-thread)))
 695         (while articles
 696           (gnus-summary-goto-subject (car articles))
 697           (gnus-set-global-variables)
 698           (bbb-summary-rate-article score
 699                                     (mail-header-id
 700                                      (gnus-summary-article-header
 701                                       (car articles))))
 702           (setq articles (cdr articles))))
 703       (setq e (point)))
 704     (let ((gnus-summary-check-current t))
 705       (or (zerop (gnus-summary-next-subject 1 t))
 706           (goto-char e))))
 707   (gnus-summary-recenter)
 708   (gnus-summary-position-point)
 709   (gnus-set-mode-line 'summary))
 710
 711
 712 (defun bbb-get-current-id ()
 713   (if gnus-current-headers
 714       (aref gnus-current-headers
 715             (nth 1 (assoc "message-id" gnus-header-index)))
 716     (gnus-message 3 "You must select an article before you rate it")))
 717
 718 (defun bbb-grouplens-group-p (group)
 719   "Say whether GROUP is a GroupLens group."
 720   (if (member group grouplens-newsgroups) " (GroupLens Enhanced)" ""))
 721
 722 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 723 ;;          TIME SPENT READING
 724 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 725 (defvar grouplens-current-starting-time nil)
 726
 727 (defun grouplens-start-timer ()
 728   (setq grouplens-current-starting-time (current-time)))
 729
 730 (defun grouplens-elapsed-time ()
 731   (let ((et (bbb-time-float (current-time))))
 732     (- et (bbb-time-float grouplens-current-starting-time))))
 733
 734 (defun bbb-time-float (timeval)
 735   (+ (* (car timeval) 65536)
 736         (cadr timeval)))
 737
 738 (defun grouplens-do-time ()
 739   (when (member gnus-newsgroup-name grouplens-newsgroups)
 740     (when grouplens-previous-article
 741       (let ((elapsed-time (grouplens-elapsed-time))
 742             (oldrating (assoc grouplens-previous-article
 743                               grouplens-rating-alist)))
 744         (if (not oldrating)
 745             (push `(,grouplens-previous-article . (0 . ,elapsed-time))
 746                   grouplens-rating-alist)
 747           (setcdr oldrating (cons (cadr oldrating) elapsed-time)))))
 748     (grouplens-start-timer)
 749     (setq grouplens-previous-article (bbb-get-current-id))))
 750
 751 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 752 ;;          BUG REPORTING
 753 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 754
 755 (defconst gnus-gl-version "gnus-gl.el 2.11")
 756 (defconst gnus-gl-maintainer-address "grouplens-bug@cs.umn.edu")
 757 (defun gnus-gl-submit-bug-report ()
 758   "Submit via mail a bug report on gnus-gl"
 759   (interactive)
 760   (require 'reporter)
 761   (reporter-submit-bug-report gnus-gl-maintainer-address
 762                               (concat "gnus-gl.el " gnus-gl-version)
 763                               (list 'grouplens-pseudonym
 764                                     'grouplens-bbb-host
 765                                     'grouplens-bbb-port
 766                                     'grouplens-newsgroups
 767                                     'grouplens-bbb-token
 768                                     'grouplens-bbb-process
 769                                     'grouplens-current-group
 770                                     'grouplens-previous-article
 771                                     'grouplens-mid-list
 772                                     'bbb-alist)
 773                               nil
 774                               'gnus-gl-get-trace))
 775
 776 (defun gnus-gl-get-trace ()
 777   "Insert the contents of the BBBD trace buffer"
 778   (if grouplens-bbb-buffer (insert-buffer grouplens-bbb-buffer)))
 779
 780 ;;;
 781 ;;; Additions to make gnus-grouplens-mode  Warning Warning!!
 782 ;;;      This version of the gnus-grouplens-mode does
 783 ;;;      not work with gnus-5.x.  The "old" way of
 784 ;;;      setting up GroupLens still works however.
 785 ;;;
 786 (defvar gnus-grouplens-mode nil
 787   "Minor mode for providing a GroupLens interface in Gnus summary buffers.")
 788
 789 (defvar gnus-grouplens-mode-map nil)
 790
 791 (unless gnus-grouplens-mode-map
 792   (setq gnus-grouplens-mode-map (make-keymap))
 793   (gnus-define-keys
 794    gnus-grouplens-mode-map
 795    "n" grouplens-next-unread-article
 796    "r" bbb-summary-rate-article
 797    "k" grouplens-score-thread
 798    "c" grouplens-summary-catchup-and-exit
 799    "," grouplens-best-unread-article))
 800
 801 (defun gnus-grouplens-make-menu-bar ()
 802   (unless (boundp 'gnus-grouplens-menu)
 803     (easy-menu-define
 804      gnus-grouplens-menu gnus-grouplens-mode-map ""
 805      '("GroupLens"
 806        ["Login" bbb-login t]
 807        ["Rate" bbb-summary-rate-article t]
 808        ["Next article" grouplens-next-unread-article t]
 809        ["Best article" grouplens-best-unread-article t]
 810        ["Raise thread" grouplens-score-thread t]
 811        ["Report bugs" gnus-gl-submit-bug-report t]))))
 812
 813 (defun gnus-grouplens-mode (&optional arg)
 814   "Minor mode for providing a GroupLens interface in Gnus summary buffers."
 815   (interactive "P")
 816   (when (and (eq major-mode 'gnus-summary-mode)
 817              (member gnus-newsgroup-name grouplens-newsgroups))
 818     (make-local-variable 'gnus-grouplens-mode)
 819     (setq gnus-grouplens-mode
 820           (if (null arg) (not gnus-grouplens-mode)
 821             (> (prefix-numeric-value arg) 0)))
 822     (when gnus-grouplens-mode
 823       (if (not (fboundp 'make-local-hook))
 824           (add-hook 'gnus-select-article-hook 'grouplens-do-time)
 825         (make-local-hook 'gnus-select-article-hook)
 826         (add-hook 'gnus-select-article-hook 'grouplens-do-time nil 'local))
 827       (if (not (fboundp 'make-local-hook))
 828           (add-hook 'gnus-exit-group-hook 'bbb-put-ratings)
 829         (make-local-hook 'gnus-exit-group-hook)
 830         (add-hook 'gnus-exit-group-hook 'bbb-put-ratings nil 'local))
 831       (make-local-variable 'gnus-score-find-score-files-function)
 832       (if gnus-grouplens-override-scoring
 833           (setq gnus-score-find-score-files-function
 834                 'bbb-build-mid-scores-alist)
 835         (add-hook 'gnus-select-group-hook
 836                   '(lambda()
 837                      (bbb-build-mid-scores-alist gnus-newsgroup-name))))
 838       (make-local-variable 'gnus-summary-line-format)
 839       (if (null gnus-grouplens-override-scoring)
 840
 841           (setq gnus-summary-line-format gnus-summary-grouplens-lab-line-format))
 842       (make-local-variable 'gnus-summary-line-format-spec)
 843
 844       ;; Set up the menu.
 845       (when (and menu-bar-mode
 846                  (gnus-visual-p 'grouplens-menu 'menu))
 847         (gnus-grouplens-make-menu-bar))
 848       (unless (assq 'gnus-grouplens-mode minor-mode-alist)
 849         (push '(gnus-grouplens-mode " GroupLens") minor-mode-alist))
 850       (unless (assq 'gnus-grouplens-mode minor-mode-map-alist)
 851         (push (cons 'gnus-grouplens-mode gnus-grouplens-mode-map)
 852               minor-mode-map-alist))
 853       (run-hooks 'gnus-grouplens-mode-hook))))
 854
 855 (provide 'gnus-gl)
 856
 857 ;;; gnus-gl.el ends here