cgit.sxemacs.org Git - gnus/blob - lisp/legacy-gnus-agent.el

   1 ;;; gnus-agent.el --- Legacy unplugged support for Gnus
   2
   3 ;; Copyright (C) 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
   4
   5 ;; Author: Kevin Greiner <kgreiner@xpediantsolutions.com>
   6 ;; Keywords: news
   7
   8 ;; This file is part of GNU Emacs.
   9
  10 ;; GNU Emacs is free software; you can redistribute it and/or modify
  11 ;; it under the terms of the GNU General Public License as published by
  12 ;; the Free Software Foundation; either version 3, or (at your option)
  13 ;; any later version.
  14
  15 ;; GNU Emacs is distributed in the hope that it will be useful,
  16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 ;; GNU General Public License for more details.
  19
  20 ;; You should have received a copy of the GNU General Public License
  21 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  22 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  23 ;; Boston, MA 02110-1301, USA.
  24
  25 ;;; Commentary:
  26
  27 ;; Conversion functions for the Agent.
  28
  29 ;;; Code:
  30 (require 'gnus-start)
  31 (require 'gnus-util)
  32 (require 'gnus-range)
  33 (require 'gnus-agent)
  34
  35 ;; Oort Gnus v0.08 - This release updated agent to no longer use
  36 ;;                   history file and to support a compressed alist.
  37
  38 (defvar gnus-agent-compressed-agentview-search-only nil)
  39
  40 (defun gnus-agent-convert-to-compressed-agentview (converting-to)
  41   "Iterates over all agentview files to ensure that they have been
  42 converted to the compressed format."
  43
  44   (let ((search-in (list gnus-agent-directory))
  45         here
  46         members
  47         member
  48         converted-something)
  49     (while (setq here (pop search-in))
  50       (setq members (directory-files here t))
  51       (while (setq member (pop members))
  52         (cond ((string-match "/\\.\\.?$" member)
  53                nil)
  54               ((file-directory-p member)
  55                (push member search-in))
  56               ((equal (file-name-nondirectory member) ".agentview")
  57                (setq converted-something
  58                      (or (gnus-agent-convert-agentview member)
  59                          converted-something))))))
  60
  61     (if converted-something
  62         (gnus-message 4 "Successfully converted Gnus %s offline (agent) files to %s" gnus-newsrc-file-version converting-to))))
  63
  64 (defun gnus-agent-convert-to-compressed-agentview-prompt ()
  65   (catch 'found-file-to-convert
  66     (let ((gnus-agent-compressed-agentview-search-only t))
  67       (gnus-agent-convert-to-compressed-agentview nil))))
  68
  69 (gnus-convert-mark-converter-prompt 'gnus-agent-convert-to-compressed-agentview 'gnus-agent-convert-to-compressed-agentview-prompt)
  70
  71 (defun gnus-agent-convert-agentview (file)
  72   "Load FILE and do a `read' there."
  73   (with-temp-buffer
  74       (nnheader-insert-file-contents file)
  75       (goto-char (point-min))
  76       (let ((inhibit-quit t)
  77             (alist (read (current-buffer)))
  78             (version (condition-case nil (read (current-buffer))
  79                        (end-of-file 0)))
  80             changed-version
  81             history-file)
  82
  83         (cond
  84          ((= version 0)
  85           (let (entry
  86                 (gnus-command-method nil))
  87             (mm-disable-multibyte) ;; everything is binary
  88             (erase-buffer)
  89             (insert "\n")
  90             (let ((file (concat (file-name-directory file) "/history")))
  91               (when (file-exists-p file)
  92                 (nnheader-insert-file-contents file)
  93                 (setq history-file file)))
  94
  95             (goto-char (point-min))
  96             (while (not (eobp))
  97               (if (and (looking-at
  98                         "[^\t\n]+\t\\([0-9]+\\)\t\\([^ \n]+\\) \\([0-9]+\\)")
  99                        (string= (gnus-agent-article-name ".agentview" (match-string 2))
 100                                 file)
 101                        (setq entry (assoc (string-to-number (match-string 3)) alist)))
 102                   (setcdr entry (string-to-number (match-string 1))))
 103               (forward-line 1))
 104             (setq changed-version t)))
 105          ((= version 1)
 106           (setq changed-version t)))
 107
 108         (when changed-version
 109           (when gnus-agent-compressed-agentview-search-only
 110             (throw 'found-file-to-convert t))
 111
 112           (erase-buffer)
 113           (let ((compressed nil))
 114             (mapcar (lambda (pair)
 115                       (let* ((article-id (car pair))
 116                              (day-of-download (cdr pair))
 117                              (comp-list (assq day-of-download compressed)))
 118                         (if comp-list
 119                             (setcdr comp-list
 120                                     (cons article-id (cdr comp-list)))
 121                           (setq compressed
 122                                 (cons (list day-of-download article-id)
 123                                       compressed)))
 124                         nil)) alist)
 125             (mapcar (lambda (comp-list)
 126                       (setcdr comp-list
 127                               (gnus-compress-sequence
 128                                (nreverse (cdr comp-list)))))
 129                     compressed)
 130             (princ compressed (current-buffer)))
 131           (insert "\n2\n")
 132           (write-file file)
 133           (when history-file
 134             (delete-file history-file))
 135           t))))
 136
 137 ;; End of Oort Gnus v0.08 updates
 138
 139 ;; No Gnus v0.3 - This release provides a mechanism for upgrading gnus
 140 ;;                from previous versions.  Therefore, the previous
 141 ;;                hacks to handle a gnus-agent-expire-days that
 142 ;;                specifies a list of values can be removed.
 143
 144 (defun gnus-agent-unlist-expire-days (converting-to)
 145   (when (listp gnus-agent-expire-days)
 146     (let (buffer)
 147       (unwind-protect
 148           (save-window-excursion
 149             (setq buffer (gnus-get-buffer-create " *Gnus agent upgrade*"))
 150             (set-buffer buffer)
 151             (erase-buffer)
 152             (insert "The definition of gnus-agent-expire-days has been changed.\nYou currently have it set to the list:\n  ")
 153             (gnus-pp gnus-agent-expire-days)
 154
 155             (insert "\nIn order to use version '" converting-to "' of gnus, you will need to set\n")
 156             (insert "gnus-agent-expire-days to an integer. If you still wish to set different\n")
 157             (insert "expiration days to individual groups, you must instead set the\n")
 158             (insert "'agent-days-until-old group and/or topic parameter.\n")
 159             (insert "\n")
 160             (insert "If you would like, gnus can iterate over every group comparing its name to the\n")
 161             (insert "regular expressions that you currently have in gnus-agent-expire-days.  When\n")
 162             (insert "gnus finds a match, it will update that group's 'agent-days-until-old group\n")
 163             (insert "parameter to the value associated with the regular expression.\n")
 164             (insert "\n")
 165             (insert "Whether gnus assigns group parameters, or not, gnus will terminate with an\n")
 166             (insert "ERROR as soon as this function completes.  The reason is that you must\n")
 167             (insert "manually edit your configuration to either not set gnus-agent-expire-days or\n")
 168             (insert "to set it to an integer before gnus can be used.\n")
 169             (insert "\n")
 170             (insert "Once you have successfully edited gnus-agent-expire-days, gnus will be able to\n")
 171             (insert "execute past this function.\n")
 172             (insert "\n")
 173             (insert "Should gnus use gnus-agent-expire-days to assign\n")
 174             (insert "agent-days-until-old parameters to individual groups? (Y/N)")
 175
 176             (switch-to-buffer buffer)
 177             (beep)
 178             (beep)
 179
 180             (let ((echo-keystrokes 0)
 181                   c)
 182               (while (progn (setq c (read-char-exclusive))
 183                             (cond ((or (eq c ?y) (eq c ?Y))
 184                                          (save-excursion
 185                                            (let ((groups (gnus-group-listed-groups)))
 186                                              (while groups
 187                                                (let* ((group (pop groups))
 188                                                       (days gnus-agent-expire-days)
 189                                                       (day (catch 'found
 190                                                              (while days
 191                                                                (when (eq 0 (string-match
 192                                                                             (caar days)
 193                                                                             group))
 194                                                                  (throw 'found (cadar days)))
 195                                                                (setq days (cdr days)))
 196                                                              nil)))
 197                                                  (when day
 198                                                    (gnus-group-set-parameter group 'agent-days-until-old
 199                                                                              day))))))
 200                                    nil
 201                                    )
 202                                   ((or (eq c ?n) (eq c ?N))
 203                                    nil)
 204                                   (t
 205                                    t))))))
 206         (kill-buffer buffer))
 207       (error "Change gnus-agent-expire-days to an integer for gnus to start"))))
 208
 209 ;; The gnus-agent-unlist-expire-days has its own conversion prompt.
 210 ;; Therefore, hide the default prompt.
 211 (gnus-convert-mark-converter-prompt 'gnus-agent-unlist-expire-days t)
 212
 213 (defun gnus-agent-unhook-expire-days (converting-to)
 214   "Remove every lambda from gnus-group-prepare-hook that mention the
 215 symbol gnus-agent-do-once in their definition.  This should NOT be
 216 necessary as gnus-agent.el no longer adds them.  However, it is
 217 possible that the hook was persistently saved."
 218     (let ((h t)) ; iterate from bgn of hook
 219       (while h
 220         (let ((func (progn (when (eq h t)
 221                              ;; init h to list of functions
 222                              (setq h (cond ((listp gnus-group-prepare-hook)
 223                                             gnus-group-prepare-hook)
 224                                            ((boundp 'gnus-group-prepare-hook)
 225                                             (list gnus-group-prepare-hook)))))
 226                            (pop h))))
 227
 228           (when (cond ((eq (type-of func) 'compiled-function)
 229                        ;; Search def. of compiled function for gnus-agent-do-once string
 230                        (let* (definition
 231                                print-level
 232                                print-length
 233                                (standard-output
 234                                 (lambda (char)
 235                                   (setq definition (cons char definition)))))
 236                          (princ func) ; populates definition with reversed list of characters
 237                          (let* ((i (length definition))
 238                                 (s (make-string i 0)))
 239                            (while definition
 240                              (aset s (setq i (1- i)) (pop definition)))
 241
 242                            (string-match "\\bgnus-agent-do-once\\b" s))))
 243                       ((listp func)
 244                        (eq (cadr (nth 2 func)) 'gnus-agent-do-once) ; handles eval'd lambda
 245                        ))
 246
 247             (remove-hook 'gnus-group-prepare-hook func)
 248             ;; I don't what remove-hook is going to actually do to the
 249             ;; hook list so start over from the beginning.
 250             (setq h t))))))
 251
 252 ;; gnus-agent-unhook-expire-days is safe in that it does not modify
 253 ;; the .newsrc.eld file.
 254 (gnus-convert-mark-converter-prompt 'gnus-agent-unhook-expire-days t)
 255
 256 (provide 'legacy-gnus-agent)
 257
 258 ;; arch-tag: 845c7b8a-88f7-4468-b8d7-94e8fc72cf1a
 259 ;;; legacy-gnus-agent.el ends here