Merge lp:~tag-biostat/mediawiki-el/tag into lp:mediawiki-el

[Thomas Alexander Gerds]

New feature for interactive selection of namespaces and pages from active mediawiki-site.

Unmerged revisions

41. By Thomas Alexander Gerds on 2013-04-11

New functions: mediawiki-find-page and mediawiki-insert-page-list

40. By Thomas Alexander Gerds on 2012-10-12

** Changes

 - mediawiki-page-at-point now also recognizes {{PAGE}}
 - new user option `mediawiki-save-ask-for-summary' used by `mediawiki-save'
 - new user option `mediawiki-make-api-url-ext' used by mediawiki-make-api-url
 - new user option `mediawiki-open-prefer-existing-buffer' used by `mediawiki-open'
 - new user option `mediawiki-buffer-pop-dont-pop used by `mediawiki-pop-to-buffer'
 - new function mediawiki-open-page-at-point-other-window, useful only for those who set mediawiki-buffer-pop-dont-pop.

** Todo

 - somehow "replace" `save-buffer' by `mediawiki-save', so that `save-some-buffers' and `save-buffers-kill-emacs' will offer save
 - extract completion list of existing pages from mediawiki server (API)
 - let `mediawiki-open' check if page has changed on the mediawiki engine, e.g by comparing the current emacs buffer with a temp buffer showing the page as it is in mediawiki engine.

=== modified file 'mediawiki.el'
--- mediawiki.el	2013-02-23 19:41:34 +0000
+++ mediawiki.el	2013-04-11 05:03:20 +0000
@@ -6,13 +6,25 @@
 ;;      Chong Yidong <cyd at stupidchicken com> for wikipedia.el,
 ;;      Uwe Brauer <oub at mat.ucm.es> for wikimedia.el
 ;; Author: Mark A. Hershberger <[e-mail]>
+<<<<<<< TREE
 ;; Version: 2.2.4.2
+=======
+;; Version: 2.2.5
+>>>>>>> MERGE-SOURCE
 ;; Created: Sep 17 2004
 ;; Keywords: mediawiki wikipedia network wiki
 ;; URL: http://launchpad.net/mediawiki-el
+<<<<<<< TREE
 ;; Last Modified: <2013-02-23 14:41:05 mah>
+=======
+;; Last Modified: <2012-10-11 Thu 8:05 am>
+>>>>>>> MERGE-SOURCE
 
+<<<<<<< TREE
 (defconst mediawiki-version "2.2.4.2"
+=======
+(defconst mediawiki-version "2.2.5"
+>>>>>>> MERGE-SOURCE
   "Current version of mediawiki.el")
 
 ;; This file is NOT (yet) part of GNU Emacs.
@@ -538,6 +550,32 @@
   :type 'hook
   :group 'mediawiki)
 
+
+(defcustom mediawiki-make-api-url-ext "php"
+  "Extension for constructing the mediawiki-make-api-url."
+  :type 'string
+  :group 'mediawiki)
+
+(defcustom mediawiki-save-ask-for-summary t
+  "If nil save pages with blank summary, otherwise prompt for summary."
+  :type 'boolean
+  :group 'mediawiki)
+
+(defcustom mediawiki-open-prefer-existing-buffer t
+  "If non-nil and there is a buffer visiting the page, return that one.
+
+If set to nil opening a page will always open the version of the page
+from the mediawiki engine. This may overwrite unsaved edits of the
+ current session."
+  :type 'boolean
+  :group 'mediawiki)
+
+(defcustom mediawiki-buffer-pop-dont-pop nil
+"If set to non-nil mediawiki-pop-to-buffer will switch-to rather
+than pop-to buffer."
+  :type 'boolean
+  :group 'mediawiki)
+
 (defvar mediawiki-page-history '()
   "Assoc list of visited pages on this MW site.")
 
@@ -551,6 +589,7 @@
   "*Simple varible in order to threat complicated signatures of users, which uses
 fonts and other makeup.")
 
+
 (defgroup mediawiki-draft nil
   "A mode to mediawiki-draft information."
   :group 'mediawiki)
@@ -608,6 +647,7 @@
   :type 'string
   :group 'mediawiki-draft)
 
+
 (defvar mediawiki-reply-with-hline nil
 "*Whether to use a hline as a header seperator in the reply.")
 
@@ -653,7 +693,6 @@
 
 (defvar mediawiki-page-title nil
   "The title of the page corresponding to the current buffer")
-
 (defvar mediawiki-edittoken nil
   "The edit token for this page.")
 (defvar mediawiki-starttimestamp nil
@@ -931,7 +970,7 @@
 
 (defun mediawiki-make-api-url (&optional sitename)
   (format (concat (mediawiki-site-url (or sitename mediawiki-site))
-                  "api.php")))
+                  "api." mediawiki-make-api-url-ext)))
 
 (defun mediawiki-api-call (sitename action args)
   (let* ((raw (url-http-post (mediawiki-make-api-url sitename)
@@ -971,14 +1010,19 @@
 	  action))
 
 (defun mediawiki-open (name)
-  "Open a wiki page specified by NAME from the mediawiki engine"
+  "Open a wiki page specified by NAME from the mediawiki engine.
+If a buffer exists visiting this page, return that one."
   (interactive
    (let ((hist (cdr (assoc-string mediawiki-site mediawiki-page-history))))
      (list (read-string "Wiki Page: " nil 'hist))))
   (when (or (not (stringp name))
             (string-equal "" name))
     (error "Need to specify a name"))
-  (mediawiki-edit mediawiki-site name))
+  (if (and mediawiki-open-prefer-existing-buffer
+    ;; check if there is a buffer for this page (to not loose unsaved edits)
+	   (get-buffer (concat mediawiki-site ": " name)))
+	(switch-to-buffer  (concat mediawiki-site ": " name))
+    (mediawiki-edit mediawiki-site name)))
 
 (defun mediawiki-reload ()
   (interactive)
@@ -987,6 +1031,59 @@
 	(mediawiki-open title)
       (error "Error: %s is not a mediawiki document" (buffer-name)))))
 
+
+(defun mediawiki-get-namespaces (sitename limit)
+  "Query mediawiki-site SITENAME for the first LIMIT namespaces."
+  (let ((namespaces (mediawiki-api-call
+		     sitename "query" 
+		     (list (cons "meta" "siteinfo")
+			   (cons "siprop" "namespaces|namespacealiases")
+			   (cons "aplimit" (mediawiki-api-param (or limit "100"))))))
+	ns)
+    (delq nil (mapcar (lambda (x) (when (and (listp x) x)
+				    (cons (or (caddr x) "main") (cdr (assq 'id (cadr x))))))
+		      (caddr namespaces)))))
+
+(defun mediawiki-get-page-list (sitename namespace limit)
+  "Query mediawiki-site SITENAME for the first LIMIT pages in NAMESPACE."
+  (let ((pages (mediawiki-api-call
+		sitename "query" 
+		(list (cons "list" "allpages")
+		      (when namespace
+			(cons "apnamespace" (mediawiki-api-param namespace)))
+		      (cons "aplimit" (mediawiki-api-param (or limit "5"))))))
+	page)
+    (delq nil (mapcar (lambda (x)
+			(when (and (listp x) x)
+			  (let ((el (cdr (assq 'title (cadr x)))))
+			    (cons (cadr (split-string el ":"))
+				  el))))
+	  (caddr pages)))))
+
+(defun mediawiki-find-page (&optional limit)
+  "Interactively select a namespace and then select
+a page with completion from the list of pages in the namespace.
+If LIMIT is an integer restrict the completion list. Default is 1000."
+  (interactive "p")        
+  (let* ((namespaces (mediawiki-get-namespaces mediawiki-site 1000))
+	 (ns (cdr (assoc (completing-read "Find in namespace: " namespaces) namespaces)))
+	 (page-list (mediawiki-get-page-list
+		     mediawiki-site ns (if (> limit 1) limit  1000)))
+	 (page (completing-read "Page name: " page-list)))
+    (mediawiki-open (cdr (assoc page page-list)))))
+
+(defun mediawiki-insert-page-list (&optional limit)
+  "Interactively select a namespace and write the names of the pages
+in the namespace to the current buffer. 
+If LIMIT is an integer restrict the page list. Default is 1000."
+  (interactive "p")        
+  (let* ((namespaces (mediawiki-get-namespaces mediawiki-site 1000))
+	 (ns (cdr (assoc (completing-read "Find in namespace: " namespaces) namespaces)))
+	 (pages (mediawiki-get-page-list mediawiki-site ns 1000)))
+    (while pages
+      (insert (caar pages) "\n")
+      (setq pages (cdr pages)))))
+
 (defun mediawiki-add-page-history (site title)
   (let ((hist (cdr (assoc-string site mediawiki-page-history))))
     (unless hist
@@ -1086,9 +1183,12 @@
      (url-filename urlobj)
      (equal "https" (url-type urlobj)))))
 
-(defun mediawiki-pop-to-buffer (bufname)
-  "Pop to buffer and then execute a hook."
-  (pop-to-buffer bufname)
+(defun mediawiki-pop-to-buffer (bufname &optional dont-pop)
+  "If dont-pop is non-nil pop-to-buffer, else switch-to-buffer BUFNAME,
+ Then execute a hook."
+  (if (or dont-pop mediawiki-buffer-pop-dont-pop)
+      (switch-to-buffer bufname)
+    (pop-to-buffer bufname))
   (run-hooks 'mediawiki-pop-buffer-hook))
 
 (defun mediawiki-api-param (v)
@@ -1164,14 +1264,18 @@
         (mediawiki-page-get-metadata page 'starttimestamp)))
 
 (defun mediawiki-save (&optional summary)
-  (interactive "sSummary: ")
-  (if mediawiki-page-title
-      (mediawiki-save-page
-       mediawiki-site
-       mediawiki-page-title
-       summary
-       (buffer-substring-no-properties (point-min) (point-max)))
-    (error "Error: %s is not a mediawiki document" (buffer-name))))
+  (interactive)
+  (let ((summary 
+	 (or summary
+	     (when mediawiki-save-ask-for-summary (read-string "Summary: "))
+	     "")))
+    (if mediawiki-page-title
+	(mediawiki-save-page
+	 mediawiki-site
+	 mediawiki-page-title
+	 summary
+	 (buffer-substring-no-properties (point-min) (point-max)))
+      (error "Error: %s is not a mediawiki document" (buffer-name)))))
 
 (defun mediawiki-prompt-for-page ()
     (let* ((prompt (concat "Page"
@@ -1337,16 +1441,23 @@
   (interactive)
   (mediawiki-open (mediawiki-page-at-point)))
 
+(defun mediawiki-open-page-at-point-other-window ()
+  "Open a new buffer with the page at point in a different window also
+if `mediawiki-buffer-pop-dont-pop' is set."
+  (interactive)
+  (let ((mediawiki-buffer-pop-dont-pop nil))
+    (mediawiki-open (mediawiki-page-at-point))))
+
 (defun mediawiki-page-at-point ()
   "Return the page name under point.  Typically, this means
-anything enclosed in [[PAGE]]."
+anything enclosed in [[PAGE]] or {{PAGE}}."
   (let ((pos (point))
         (eol (point-at-eol))
         (bol (point-at-bol)))
     (save-excursion
-      (let* ((start  (when (search-backward "[[" bol t)
+      (let* ((start  (when (or (search-backward "[[" bol t) (search-backward "{{" bol t))
                        (+ (point) 2)))
-             (end    (when (search-forward "]]" eol t)
+             (end    (when (or (search-forward "]]" eol t)  (search-forward "}}" eol t))
                        (- (point) 2)))
              (middle (progn
                        (goto-char start)