2011年2月3日木曜日

OpenOffice.org と Python マクロ 4 限目

久しぶりに、OOo の Python マクロをいじってみたくなった。
詳しいことは端折るが、リアルタイムスプレッドシートと OpenOffice.org と UWSC でシステムトレーディングの可能性が見えた。最初は、MetaTrader でやるつもりだったが、楽天証券は対応していないようなので、とりあえず茨の道を進んでみる。

で、今回は、野望とは程遠い内容だが、Python マクロを、OpenOffice.org Calc に同梱する方法について、調査した。

【動作環境】
OS:Windows Vista Business 64bit SP2
OpenOffice.org 3.2.1

調査内容については、以下のサイトでのやりとりの内、今回必要な部分をまとめただけとなる。回答されている方には、足を向けて寝られない。
faq/5/430 - OpenOffice.org Q&A
http://oooug.jp/faq/index.php?faq/5/430

要点をまとめると、
  1. デフォルトの状態では、OpenOffice.org 上から、Python マクロを .ods ファイルに同梱する機能がない。
  2. 拡張機能を利用しない場合、Python マクロを .ods ファイルに同梱するには、ファイルを直接変更する必要がある。
  3. 拡張機能をインストールすることによって、OpenOffice.org 上で Python マクロを同梱したり、エディタで開いたりすることができるようなる。

では、手動でのマクロファイル同梱方法から解説する。

1.ファイルを直接変更して、Python マクロを同梱する方法。
詳細は、以下のサイトを参照のこと
http://udk.openoffice.org/python/scriptingframework/index.html

概要を説明すると、.ods ファイル(実は zip ファイル)を解凍して、Scripts/python/ ディレクトリを作成し、Python マクロファイルを配置する。
次に、META-INF/manifest.xml ファイルに前述の Python マクロファイルおよびディレクトリの定義を追加する。
最後に、再び zip 圧縮して、拡張子を .ods に変更する。

もし、Python マクロファイルだけ追加して、manifest.xml ファイルを変更しなかった場合、
「ファイル 'ほげほげ.ods' は汚染されているため、開くことができません。OpenOffice.org で修復を試してください。この汚染は、データ送信に伴う、ドキュメントの改ざんまたは構造的なドキュメントの損傷によって引き起こされた可能性があります。修復されたドキュメントの内容は信用しないことを推奨します。このドキュメントのマクロの実行は無効化されます。」などと怒られ、修復すると、きれいさっぱり Python マクロファイルが消える。ちなみに、修復をしないと .ods ファイルが開けない。


Python マクロファイルを同梱する手順を、実際に試してみた。
  • 適当なディレクトリに、「OpenDocument 表計算」を”Hello.ods”というファイル名で作成。
  • Hello.ods ファイルを zip 解凍ツールで解凍(拡張子を zip に変更する必要があるかもしれない)。
  • 以下のファイルおよびディレクトリが解凍される。
    Configurations2/
    META-INF/
    Thumbnails/
    content.xml
    meta.xml
    mimetype
    settings.xml
    styles.xml
  • 上記の階層に、Scripts/python/ ディレクトリを作成。
  • 作成したディレクトリに、適当な Python マクロファイル(今回は、C:\Program Files (x86)\OpenOffice.org 3\Basis\share\Scripts\python\HelloWorld.py を利用)を配置。
  • META-INF/manifest.xml ファイルをエディタで開き、以下のように21行目~23行目の内容を追加する。
<?xml version="1.0" encoding="UTF-8"?>
<manifest:manifest xmlns:manifest="urn:oasis:names:tc:opendocument:xmlns:manifest:1.0">
 <manifest:file-entry manifest:media-type="application/vnd.oasis.opendocument.spreadsheet" manifest:version="1.2" manifest:full-path="/"/>
 <manifest:file-entry manifest:media-type="" manifest:full-path="Configurations2/statusbar/"/>
 <manifest:file-entry manifest:media-type="" manifest:full-path="Configurations2/accelerator/current.xml"/>
 <manifest:file-entry manifest:media-type="" manifest:full-path="Configurations2/accelerator/"/>
 <manifest:file-entry manifest:media-type="" manifest:full-path="Configurations2/floater/"/>
 <manifest:file-entry manifest:media-type="" manifest:full-path="Configurations2/popupmenu/"/>
 <manifest:file-entry manifest:media-type="" manifest:full-path="Configurations2/progressbar/"/>
 <manifest:file-entry manifest:media-type="" manifest:full-path="Configurations2/menubar/"/>
 <manifest:file-entry manifest:media-type="" manifest:full-path="Configurations2/toolbar/"/>
 <manifest:file-entry manifest:media-type="" manifest:full-path="Configurations2/images/Bitmaps/"/>
 <manifest:file-entry manifest:media-type="" manifest:full-path="Configurations2/images/"/>
 <manifest:file-entry manifest:media-type="application/vnd.sun.xml.ui.configuration" manifest:full-path="Configurations2/"/>
 <manifest:file-entry manifest:media-type="text/xml" manifest:full-path="content.xml"/>
 <manifest:file-entry manifest:media-type="text/xml" manifest:full-path="styles.xml"/>
 <manifest:file-entry manifest:media-type="text/xml" manifest:full-path="meta.xml"/>
 <manifest:file-entry manifest:media-type="" manifest:full-path="Thumbnails/thumbnail.png"/>
 <manifest:file-entry manifest:media-type="" manifest:full-path="Thumbnails/"/>
 <manifest:file-entry manifest:media-type="text/xml" manifest:full-path="settings.xml"/>
 <manifest:file-entry manifest:media-type="" manifest:full-path="Scripts/python/HelloWorld.py"/>
 <manifest:file-entry manifest:media-type="application/binary" manifest:full-path="Scripts/python/"/>
 <manifest:file-entry manifest:media-type="application/binary" manifest:full-path="Scripts/"/>
</manifest:manifest>

  • 再び zip 圧縮をする。
  • 圧縮したファイル名を Hello.ods に変更する。
  • Hello.ods ファイルを OpenOffice.org で開く
成功すると、「セキュリティ警告」ダイアログが開き、「ドキュメントマクロを含むドキュメントです。マクロには、ウィルスが含まれていることがあります。安全のためには、ドキュメントのマクロを無効にすることをお勧めします。ただし、マクロを無効にすると、ドキュメントマクロの機能を利用出来なくなりいます。」と警告されるので、「マクロの有効化」ボタンを押すと、めでたくマクロが利用可能になる。

「ツール」メニュー -> 「マクロ」 -> 「マクロの管理」 -> 「Python」を選択
ツリーの「Hello.ods」以下に、”HelloWorld”マクロが含まれていることが確認できる。

以上が、手動による Python マクロファイルの同梱手順だが、面倒くさい。
そこで、拡張機能の出番。

以下のサイトにアクセスする。
http://hermione.s41.xrea.com/pukiwiki/index.php?OOobbs2%2F194

上記サイトで以下のファイルをダウンロードして、ファイルをダブルクリックすると、OpenOffice.org の拡張マネージャ画面が起動するので、それぞれインストールする。
EditorKicker-0.1.0.oxt
ModifiedPythonScriptProvider-0.4.2.oxt

OpenOffice.org を再起動する。
OpenOffice.org の「ツール」メニュー -> 「拡張機能マネージャ」を選択する。
「EditorKicker」を選択し、「オプション」ボタンをクリックする。

「Editor」の「Choose」ボタンを押して、エディターを選択する。
私の場合は、”C:\appli_x86\sakura\sakura.exe”
を選択した。

「Options」には、「-Y=${COL} -X=${ROW} -- "${FILENAME}"」のように設定した。ファイル名をダブルクォートで囲む必要がある。でないと、スペース入りのディレクトリや、ファイル名で問題が起こる。

「OK」ボタンを押す。

「拡張機能マネージャー」の「閉じる」ボタンを押す。
OpenOffice.org を再起動する。必ずすること。でないと設定が反映されないようだ。

これでインストールは完了。

この拡張機能は、OpenOffice.org の「ツール」メニュー ->「マクロ」 -> 「マクロの管理」 -> 「Python」を選択すると表示される、「Python マクロ」管理画面に対して機能が追加される。
具体的には、マクロファイルに対して、「作成」、「編集」、「名前の変更」、「削除」ボタンなどが利用できるようになる。


この拡張機能の利用方法で、理解に時間がかかった部分を補足説明する。

■ ファイル同梱のマクロファイルとそれ以外では、「編集」ボタンの挙動が異なる。(しばらく意味が分からず、不具合かと思ったwww)


「あなたのマクロ」および「OpenOffice.org マクロ」のマクロファイルに対しては、エディターが起動する。
ファイル同梱のマクロファイルに対しては、ファイル選択ダイアログが開く。Python マクロファイルを選択すると、ファイル同梱のマクロファイルの内容が、選択したファイルの内容で上書きされる。

■ 一度ファイル同梱のマクロを作成してしまうと、マクロファイルを削除しても、起動時にマクロに関する警告が表示される。
これは、Scripts ディレクトリが残るためだ。前述の手動での同梱マクロ追加方法を参考に、Scripts ディレクトリと設定を削除することで、マクロに関する警告が表示されなくなる。

また一歩、Python マクロの深みに嵌っていく・・・・

冒頭の FAQ でのやり取りから、マクロの配布形態は、「ユーザー共通」、「ユーザー個別」、「ファイル同梱」、そして、「拡張機能」形式が存在することが分かった。「拡張機能」形式には、アップデートが容易などの利点があるので、興味はあるが、もはや、目的が何だったのか忘れる勢い・・・さらなる茨の道を進む・・・のか?