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

   1 ;;; gnus-sync.el --- synchronization facility for Gnus
   2
   3 ;; Copyright (C) 2010  Free Software Foundation, Inc.
   4
   5 ;; Author: Ted Zlatanov <tzz@lifelogs.com>
   6 ;; Keywords: news synchronization nntp nnrss
   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 of the License, or
  13 ;; (at your option) 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.  If not, see <http://www.gnu.org/licenses/>.
  22
  23 ;;; Commentary:
  24
  25 ;; This is the gnus-sync.el package.
  26
  27 ;; Put this in your startup file (~/.gnus.el for instance)
  28
  29 ;; possibilities for gnus-sync-backend:
  30 ;; Tramp over SSH: /ssh:user@host:/path/to/filename
  31 ;; Tramp over IMAP: /imaps:user@yourhosthere.com:/INBOX.test/filename
  32 ;; ...or any other file Tramp and Emacs can handle...
  33
  34 ;; (setq gnus-sync-backend "/remote:/path.gpg" ; will use Tramp+EPA if loaded
  35 ;;       gnus-sync-global-vars `(gnus-newsrc-last-checked-date)
  36 ;;       gnus-sync-newsrc-groups `("nntp" "nnrss")
  37 ;;       gnus-sync-newsrc-offsets `(2 3))
  38
  39 ;; TODO:
  40
  41 ;; - after gnus-sync-read, the message counts are wrong
  42
  43 ;;; Code:
  44
  45 (eval-when-compile (require 'cl))
  46 (require 'gnus-util)
  47
  48 (defgroup gnus-sync nil
  49   "The Gnus synchronization facility."
  50   :version "24.1"
  51   :group 'gnus)
  52
  53 (defcustom gnus-sync-newsrc-groups `("nntp" "nnrss")
  54   "List of groups to be synchronized in the gnus-newsrc-alist.
  55 The group names are matched, they don't have to be fully
  56 qualified.  Typically you would choose all of these.  That's the
  57 default because there is no active sync backend by default, so
  58 this setting is harmless until the user chooses a sync backend."
  59   :group 'gnus-sync
  60   :type '(repeat regexp))
  61
  62 (defcustom gnus-sync-newsrc-offsets '(2 3)
  63   "List of per-group data to be synchronized."
  64   :group 'gnus-sync
  65   :type '(set (const :tag "Read ranges" 2)
  66               (const :tag "Marks" 3)))
  67
  68 (defcustom gnus-sync-global-vars nil
  69   "List of global variables to be synchronized.
  70 You may want to sync `gnus-newsrc-last-checked-date' but pretty
  71 much any symbol is fair game.  You could additionally sync
  72 `gnus-newsrc-alist', `gnus-server-alist', `gnus-topic-topology',
  73 and `gnus-topic-alist' to cover all the variables in
  74 newsrc.eld (except for `gnus-format-specs' which should not be
  75 synchronized, I believe).  Also see `gnus-variable-list'."
  76   :group 'gnus-sync
  77   :type '(repeat (choice (variable :tag "A known variable")
  78                          (symbol :tag "Any symbol"))))
  79
  80 (defcustom gnus-sync-backend nil
  81   "The synchronization backend."
  82   :group 'gnus-sync
  83   :type '(radio (const :format "None" nil)
  84                 (string :tag "Sync to a file")))
  85
  86 (defvar gnus-sync-newsrc-loader nil
  87   "Carrier for newsrc data")
  88
  89 (defun gnus-sync-save ()
  90 "Save the Gnus sync data to the backend."
  91   (interactive)
  92   (cond
  93    ((stringp gnus-sync-backend)
  94     (gnus-message 7 "gnus-sync: saving to backend %s" gnus-sync-backend)
  95     ;; populate gnus-sync-newsrc-loader from all but the first dummy
  96     ;; entry in gnus-newsrc-alist whose group matches any of the
  97     ;; gnus-sync-newsrc-groups
  98     ;; TODO: keep the old contents for groups we don't have!
  99     (let ((gnus-sync-newsrc-loader
 100            (loop for entry in (cdr gnus-newsrc-alist)
 101                  when (gnus-grep-in-list
 102                        (car entry)     ;the group name
 103                        gnus-sync-newsrc-groups)
 104                  collect (cons (car entry)
 105                                (mapcar (lambda (offset)
 106                                          (cons offset (nth offset entry)))
 107                                        gnus-sync-newsrc-offsets)))))
 108       (with-temp-file gnus-sync-backend
 109         (progn
 110           (let ((coding-system-for-write gnus-ding-file-coding-system)
 111                 (standard-output (current-buffer)))
 112             (princ (format ";; -*- mode:emacs-lisp; coding: %s; -*-\n"
 113                            gnus-ding-file-coding-system))
 114             (princ ";; Gnus sync data v. 0.0.1\n")
 115             (let* ((print-quoted t)
 116                    (print-readably t)
 117                    (print-escape-multibyte nil)
 118                    (print-escape-nonascii t)
 119                    (print-length nil)
 120                    (print-level nil)
 121                    (print-circle nil)
 122                    (print-escape-newlines t)
 123                    (variables (cons 'gnus-sync-newsrc-loader
 124                                     gnus-sync-global-vars))
 125                    variable)
 126               (while variables
 127                 (if (and (boundp (setq variable (pop variables)))
 128                            (symbol-value variable))
 129                     (progn
 130                       (princ "\n(setq ")
 131                       (princ (symbol-name variable))
 132                       (princ " '")
 133                       (prin1 (symbol-value variable))
 134                       (princ ")\n"))
 135                   (princ "\n;;; skipping empty variable ")
 136                   (princ (symbol-name variable)))))
 137             (gnus-message
 138              7
 139              "gnus-sync: stored variables %s and %d groups in %s"
 140              gnus-sync-global-vars
 141              (length gnus-sync-newsrc-loader)
 142              gnus-sync-backend)
 143
 144             ;; Idea from Dan Christensen <jdc@chow.mat.jhu.edu>
 145             ;; Save the .eld file with extra line breaks.
 146             (gnus-message 8 "gnus-sync: adding whitespace to %s"
 147                           gnus-sync-backend)
 148             (save-excursion
 149               (goto-char (point-min))
 150               (while (re-search-forward "^(\\|(\\\"" nil t)
 151                 (replace-match "\n\\&" t))
 152               (goto-char (point-min))
 153               (while (re-search-forward " $" nil t)
 154                 (replace-match "" t t))))))))
 155     ;; the pass-through case: gnus-sync-backend is not a known choice
 156     (nil)))
 157
 158 (defun gnus-sync-read ()
 159 "Load the Gnus sync data from the backend."
 160   (interactive)
 161   (when gnus-sync-backend
 162     (gnus-message 7 "gnus-sync: loading from backend %s" gnus-sync-backend)
 163     (cond ((stringp gnus-sync-backend)
 164            ;; read data here...
 165            (if (or debug-on-error debug-on-quit)
 166                (load gnus-sync-backend nil t)
 167              (condition-case var
 168                  (load gnus-sync-backend nil t)
 169                (error
 170                 (error "Error in %s: %s" gnus-sync-backend (cadr var)))))
 171            (let ((valid-count 0)
 172                  invalid-groups)
 173              (dolist (node gnus-sync-newsrc-loader)
 174                (if (gnus-gethash (car node) gnus-newsrc-hashtb)
 175                    (progn
 176                      (incf valid-count)
 177                      (loop for store in (cdr node)
 178                            do (setf (nth (car store)
 179                                          (assoc (car node) gnus-newsrc-alist))
 180                               (cdr store))))
 181                  (push (car node) invalid-groups)))
 182             (gnus-message
 183              7
 184              "gnus-sync: loaded %d groups (out of %d) from %s"
 185              valid-count (length gnus-sync-newsrc-loader)
 186              gnus-sync-backend)
 187             (when invalid-groups
 188               (gnus-message
 189                7
 190                "gnus-sync: skipped %d groups (out of %d) from %s"
 191                (length invalid-groups)
 192                (length gnus-sync-newsrc-loader)
 193                gnus-sync-backend)
 194               (gnus-message 9 "gnus-sync: skipped groups: %s"
 195                             (mapconcat 'identity invalid-groups ", ")))))
 196           (nil))
 197     ;; make the hashtable again because the newsrc-alist may have been modified
 198     (when gnus-sync-newsrc-offsets
 199       (gnus-message 9 "gnus-sync: remaking the newsrc hashtable")
 200       (gnus-make-hashtable-from-newsrc-alist))))
 201
 202 ;;;###autoload
 203 (defun gnus-sync-initialize ()
 204 "Initialize the Gnus sync facility."
 205   (interactive)
 206   (gnus-message 5 "Initializing the sync facility")
 207   (gnus-sync-install-hooks))
 208
 209 ;;;###autoload
 210 (defun gnus-sync-install-hooks ()
 211   "Install the sync hooks."
 212   (interactive)
 213   ;; (add-hook 'gnus-get-new-news-hook 'gnus-sync-read)
 214   (add-hook 'gnus-save-newsrc-hook 'gnus-sync-save)
 215   (add-hook 'gnus-read-newsrc-el-hook 'gnus-sync-read))
 216
 217 (defun gnus-sync-unload-hook ()
 218   "Uninstall the sync hooks."
 219   (interactive)
 220   ;; (remove-hook 'gnus-get-new-news-hook 'gnus-sync-read)
 221   (remove-hook 'gnus-save-newsrc-hook 'gnus-sync-save)
 222   (remove-hook 'gnus-read-newsrc-el-hook 'gnus-sync-read))
 223
 224 (add-hook 'gnus-sync-unload-hook 'gnus-sync-unload-hook)
 225
 226 ;; this is harmless by default, until the gnus-sync-backend is set
 227 (gnus-sync-initialize)
 228
 229 (provide 'gnus-sync)
 230
 231 ;;; gnus-sync.el ends here