LibreOffice Calcのfodsファイルを読み書きするサンプルをweb API化してみた

2021-12-11T12:03:55+09:00

これは LibreOffice Advent Calendar 2021 の11日目の記事です。

↓これにちょろっと付け足して web API 化してみただけの記事です。

JRubyでLibreOffice Calcのfodsファイルを読み書きするサンプル 2021

できたもの

webapi-2021 ブランチ

https://github.com/sonota88/libreoffice-jruby-sample/tree/webapi-2021

Java 版でやろうかと考えていたのですが、億劫になって JRuby 版でやりました。 JRuby で Sinatra 使った方が速い。

主な部分だけ抜き出すとこんな感じ。考えるのが面倒だったので REST ではなく RPC風で。普通に Sinatra を使ってるだけですね。あんまり書くことがない…… 😓

# app.rb

require "sinatra"
require_relative "libo_calc"

post "/calc" do
  file = params["file"]
  sheet_name = params["sheet"]

  data = {}

  Calc.open(file) do |doc|
    sheet = doc.get_sheet_by_name(sheet_name)
    case params["command"]
    when "cell_get"
      data = cell_get(sheet, params)
    when "cell_set"
      cell_set(sheet, params)
      doc.save()
    when "dump"
      data = dump(sheet)
    else
      raise "unsupported command"
    end
  end

  content_type :json
  JSON.pretty_generate(data)
end

動かし方

イメージをビルド

docker build \
  --build-arg USER=$USER \
  --build-arg GROUP=$(id -gn) \
  -t my:libo-jruby-webapi-2021 .

APIサーバ起動

./docker_run.sh  ./jruby.sh app.rb -o 0.0.0.0

curl で動作確認

ファイル、シート名、コマンド、パラメータを POST で渡します。

curl -XPOST 'http://localhost:4567/calc' \
  -d 'file=./sample.fods' -d 'sheet=Sheet1' \
  -d 'command=cell_set' \
  -d 'col=0' -d 'row=2' -d "val=$(date "+%F_%T")"

#=>
{}

curl -XPOST 'http://localhost:4567/calc' \
  -d 'file=./sample.fods' -d 'sheet=Sheet1' \
  -d 'command=cell_get' \
  -d 'col=0' -d 'row=2'

#=>
{
  "val": "2021-12-11_11:03:20"
}

curl -XPOST 'http://localhost:4567/calc' \
  -d 'file=./sample.fods' -d 'sheet=Sheet1' \
  -d 'command=dump'

#=>
{
  "rows": [
    [
      "(0, 0) 日本語テキスト 2021-01-02 14:34:26 +0900",
      "b1"
    ],
    [
      "a2",
      "(1, 1) 2021-01-02 14:34:26 +0900"
    ],
    [
      "2021-12-11_11:03:20",
      "12.34"
    ],
    [
      "",
      "0"
    ]
  ]
}

読み書きできてます。

Ruby + Faraday

適当な HTTP クライアントライブラリを使って試してみました。

require "faraday"

puts "cell_set =>"
res = Faraday.post(
  "http://localhost:4567/calc",
  {
    file: "./sample.fods", sheet: "Sheet1",
    command: "cell_set",
    col: 0, row: 2, val: Time.now.to_s
  }
)

puts res.body

puts "cell_get =>"
res = Faraday.post(
  "http://localhost:4567/calc",
  {
    file: "./sample.fods", sheet: "Sheet1",
    command: "cell_get",
    col: 0, row: 2
  }
)

puts res.body

puts "dump =>"
res = Faraday.post(
  "http://localhost:4567/calc",
  {
    file: "./sample.fods", sheet: "Sheet1",
    command: "dump"
  }
)

puts res.body

$ bundle exec ruby sample_webapi_client.rb
cell_set =>
{
}
cell_get =>
{
  "val": "2021-12-11 11:09:49 +0900"
}
dump =>
{
  "rows": [
    [
      "(0, 0) 日本語テキスト 2021-01-02 14:34:26 +0900",
      "b1"
    ],
    [
      "a2",
      "(1, 1) 2021-01-02 14:34:26 +0900"
    ],
    [
      "2021-12-11 11:09:49 +0900",
      "12.34"
    ],
    [
      "",
      "0"
    ]
  ]
}

大丈夫ですね。普通ですね。

というわけで、任意の HTTP クライアントからセルの読み書きができるようになりました。この記事は以上です。

JRubyでLibreOffice Calcのfodsファイルを読み書きするサンプル 2019

2021-02-20T11:51:56+09:00

(2021-01-02) 2021年版書きました: JRubyでLibreOffice Calcのfodsファイルを読み書きするサンプル 2021

以前 JavaScript（Rhino/jrunscript）で書いたものを今さらながら Nashorn 向けに書きなおそうとして調べたところ、非推奨になっていました。

2018-06-07 JavaでJavaScriptを実行する「Nashorn」が非推奨に、ECMAScriptの速い進化に追いつけないと。代替案はGraalVM － Publickey

去年のニュースですね。全然気づいてませんでした。GraalVM を使えとあり、それも面白そうではありますが時期尚早な感じもします。ちょっと考えて JRuby で書き直してみることにしました。

（※ 2019-12-02 に書いた記事のクロスポストです）

sonota88/libreoffice-jruby-sample (tag: 20191202)
https://github.com/sonota88/libreoffice-jruby-sample/tree/20191202

Ubuntu で動かす前提のサンプルになっていて、 libreoffice-java-common をインストールしておく必要があります。ライブラリまわりについては一つ前の記事なども参考にしてください。Windows などでもライブラリのパスの修正だけで動くんじゃないかと思います。

なんかデッドロックが発生してプログラムが終了しなかったのでサンプルスクリプトでは明示的に exit しています。jstack を使ってデッドロックしているなーというとこまで調べたあたりで気力が尽きました。また気が向いたら調べるかも……。

今回はじめて JRuby を使ってみましたが、 zip をダウンロードして展開して bin/ にパスを通すだけで使えて、いいですね。分かりやすい。

JRuby から Java のライブラリなどを使う場合、下記は必読でした。まずこれを読みましょう。

CallingJavaFromJRuby · jruby/jruby Wiki

次のようにシートをダンプしてくれる dump.rb もおまけで追加しました。値が入っている最大の行・列の取り方が分からなかったため、いったん100行・100列まで見るようにしました。サンプルということで許してください……。

$ jruby dump.rb foo.fods {シート名}
["a1", "b1"]
["a2", "b2"]