Monthly Archive for November, 2006

Motivation

W-ZERO3でWikiのページをつくるとき、やっぱりブラウザからだとやりづらいのです。

あと、大量にあるBlosxomのエントリを、Wikiにまとめて移行したいけれど、手作業でやるには面倒すぎる。うまいこと自動化したいのです。

これらを解決するために、XML-RPCでWikiにエントリをPOSTするようなスクリプトを書きました。

hiki_client.rb

さっさと書いてみました。 40行程度。

#
# Hiki Client
# $Id: hiki_client.rb 537 2006-11-28 00:25:58Z takayama $
#
require 'xmlrpc/client'

class HikiClient
   def initialize(url)
      @url = url
      @rpc = XMLRPC::Client.new2(@url)
   end

   def getAllPages
      @rpc.call('wiki.getAllPages')
   end

   def getPage(p)
      @rpc.call('wiki.getPage', p)
   end

   def getPageInfo(p)
      @rpc.call('wiki.getPageInfo', p)
   end

   def getTaggedPages(tag)
      @rpc.call('wiki.getTaggedPages', tag)
   end

   def putPage(p, c, a)
      begin
         pages = @rpc.call('wiki.putPage', p, c, a)
      rescue XMLRPC::FaultException => e
         puts 'XMLRPC::FaultException : -----------------'
         puts e.faultCode
         puts e.faultString
         puts '-----------------------'
      end
   end

   def set_auth(u, p)
      @rpc.user = u
      @rpc.password = p
   end
end

見たままのコードです。いちおうBasic認証にも対応。

wiki_post.rb

#!/usr/bin/env ruby
#
# Wiki post from mail using XML-RPC.
#
# $Id: wiki_post.rb 547 2006-11-29 15:16:19Z takayama $
#
# mail format:
#   1st line : Title
#   2nd line : Keywords
#   others   : content

require 'hiki_client'
require 'tmail'
require 'kconv'

WIKI_URL = 'http://some.wiki.host/address/'

hc = HikiClient.new(WIKI_URL)

mail = TMail::Mail.parse(ARGF.read)
body = Kconv.toutf8(mail.body)
body = body.split(/n/)
title = body.shift
keywords = body.shift.split(/,/)

hc.putPage(title, body.join("n"), {'keyword' => keywords})

たったこれだけ。とっても簡単。

まとめ

これで、メールから手軽にWikiエントリが送れるようになりました。編集とかは面倒なのであとまわしです。

やっぱり言語にとって大切なのは、便利なライブラリがそろっていることと、お手軽さだということがよく分かります。実現したい機能をさっとつくれることが何よりも大事。 xmlrpc.rbとtmail.rbサマサマです。

Hikiで、あるキーワードを持つWikiページの集合を返すようなXML-RPC拡張を書きました。19行程度。

背景

HikiでXML-RPCを使ったmigrationツールを書いています。 あるキーワードを持っているWikiページ郡をまとめて別のWikiにコピーする必要がありました。

Hikiに元々備わっているXML-RPCのインターフェイスを使ってやるには、

def getTaggedPages(tag)
   pages = wiki.getAllPage();

   acm = []
   pages.each do |p|
      info = wiki.getPageInfo(p)
      if (info['keyword'].include? tag)
         acm.push p
      end
   end
end

みたいなコードを書く必要がありそうです。 このコードでは、すべてのWikiページに対してwiki.getPageInfoのXML-RPCリクエストが飛ぶことになり、Wikiページ数に対してスケールしません。実際、手元でやってみたところえらく時間がかかります。

XML-RPCインターフェイスを拡張する

XML-RPCインターフェイスを定義している $HIKI/hiki/xmlrpc.rb を見たところ、ちょこっと書き加えるだけでXML-RPCインターフェイスは追加できそうです。なので、ちょこちょこと書いてみました。

--- xmlrpc.rb.orig      2006-11-26 18:51:13.000000000 +0900
+++ xmlrpc.rb   2006-11-26 18:52:49.000000000 +0900
@@ -86,6 +86,25 @@

       #add_multicall
       #add_introspection
+
+      #
+      # getTaggedPages
+      #   retrieve all pages having specified tag.
+      #
+      @server.add_handler('wiki.getTaggedPages') do |tag|
+        tag = utf8_to_euc( tag )
+        conf = Hiki::Config::new
+        db = Hiki::HikiDB::new( conf )
+
+        ret = []
+        db.pages.each do |p|
+          kws = db.get_attribute( p, :keyword )
+          if kws.include? tag
+             ret.push XMLRPC::Base64.new( euc_to_utf8( p ) )
+          end
+       end
+       ret
+      end
     end
   end

これで、1つのXML-RPCリクエストだけでキーワードを含む全てのWikiページを得ることができます。

まとめ

rubyのXML-RPCライブラリはお手軽で便利。 ActionScriptとかWebServiceKitだとこうさくっとは書けません。