symphonic-mpdユーザーのためのLinux Tips（プラグイン機能編集編･其の一）

試してみたら存外に上手くいったので、防備録として...
（上手くいきすぎてオカルトかと思ったぐらい）

symphonic-mpdでは、ユーザー自身の手でプラグイン設定ファイルを編集することで、WebUIにクリックやタップで起動させることのできる機能を任意に設定することができるようになっています。
これ、地味に便利なんですよ！

例えばこの便利な機能に、バックアップファイルの作成と読込機能を盛り込んでみたらどうなるでしょう。

これから紹介する内容を実行すると、NAS上のデータベースやあなた独自のプレイリストだけでなく、自分のラズパイの各種設定やファイルまで、ワンタップ・ワンクリックでNAS上にバックアップを取ることができます。

そして、諸事情で新たにsymphonic-mpd起動用SDカードを作らなければならない状況に自分がなったと考えてみてください。
そういう時に、これからご紹介する内容のプラグインが用意されていれば、実に便利この上ないのです。

どういうことかと言うと、これから説明する手順さえ踏んでいれば、あなたは既に/boot/config.txt内のドライバ設定に始まり、各種ファイル設定やdt-blob.binにいたるまで、全てがNAS上にバックアップしちゃってていることになっているのです。
そしてそのファイルを読み込ませるためにワンタップ・ワンクリックすれば、あなたのラズパイは一瞬にして、元の環境に戻ってしまうのです。

なんて手間いらず！
コレ、凄くありません？

と言う訳で、

自分でバックアップファイル作成や読込のコマンドをプラグイン化してみよう

をご紹介致します。

問題のプラグインを編集するコマンドは...

 nano /home/pi/plugins/.plugin.json 

です。

私の場合、“/home/pi/plugins/.plugin.json”の末尾に...

この二つの記述を加えました。

肝心なのは、この二行です。

具体的には、以下の内容です。

   { 
     "menu" :"Save Database on NAS", 
     "author" :"", 
     "active" :"yes", 
     "icon" :"save", 
     "form" :"", 
     "command":"/home/pi/util-smpdbackup.sh -b", 
     "output" :"", 
     "success":"success!", 
     "error" :"error!" 
   }, 
   { 
     "menu" :"Read Database on NAS", 
     "author" :"", 
     "active" :"yes", 
     "icon" :"open", 
     "form" :"", 
     "command":"/home/pi/util-smpdbackup.sh -r", 
     "output" :"", 
     "success":"success!", 
     "error" :"error!" 
   } 

この中に見える“util-smpdbackup.sh”は、NASのデータベースや自分のプレイリスト、そしてラズパイの各種ファイル設定やdt-blob.binのようなファイルまでのバックアップを取ったり（“-b”がそれです）、バックアップファイルを自分のマシン（具体的にはSDカード）に読み込ませたり（リストアですね、“-r”がそれです）するためのスクリプトが記述されているファイルです。

それでは一行一行、説明していきましょう。

１行目は...

プラグインの名称です。
ユーザー自身で任意の名称を入力します。
機能に直接関係ないので、自分に分かりやすい名称にすればよいでしょう。
（例えば “このウッカリ者め！” とか “お尻ペンペンしちゃうぞ！” とかでもいいんです）

２行目は...

開発者名を入れるところみたいですが、空欄で構いません。

３行目は...

ここを“yes”にすることで、このプラグインがWebUIに表示されるようになります。

４行目は...

WebUIに表示させるアイコンを指定します。
アイコンの種類や名称は、プラグインのサポートページに一覧で紹介されています。
私はは“save”アイコンと“open”アイコンを選びました。

５行目は...

入力パネルなどを表示させるための記述が入るところです。
今回は利用しないので無記述です。

６行目は...

上に紹介したように、v0.8.20から採用され、掲示板で開発者さんから公開された、データベース作成とリストアのコマンドです。

 /home/pi/util-smpdbackup.sh backup 

 /home/pi/util-smpdbackup.sh restore 

（例のように、末尾につける「因数」は“backup”が“-b”でも、“restore”は“-r”でも構いません）

７行目は...

実行の結果をパネルで表示させるための記述を行う行です。
今回は使いません。

８行目は...

コマンドが正常に実行･終了された時に表示させる文字列です。
私は“success!”にしていますが、“やったね！”でも構いません。
任意の文字列を指定できます。
（事実、今、私はココを“やったね！”にしています）

９行目は...

コマンドが正常に実行されなかった時に表示させる「エラー」メッセージです。
ここも、例えば “このおバカさん!!” でも構いません。

で、無事に記述が終わったので、私の場合はWebUIでこのように表示されています。

実際にバックアップファイルが作成されているか、“ls”コマンドを使って確認してみました。

 ls -l /var/lib/mpd/music/NAS/ 

無事に作成されておりました😃

試しに、別にラズパイを一台用意し、上のプラグイン設定を反映させた上でデータベースのリストアを行うと、プレイリストも含めて全ての設定が同じクローンができあがりました。
（プラグインを記述する暇があったら、リストアのコマンドを叩いた方が早いとも言う）

ヤレヤレ、良かった良かった！

もっとハードルが高いかなと思っていたのですが、やってみたら意外に簡単でした。
どうです、やってみたくなりました？

一点、絶対に守って欲しい注意点があります。
これは“/home/pi/plugins/.plugin.json”を編集する上での絶対のお約束なのですが...

前の記述の一番最後に“,”（カンマ）を必ず入れてください。

そして、記述の一番最後には...

絶対に“,”（カンマ）を入れないでください。
よい子はルールを守るんだよ！

ところで、私の環境には複数のI2Sカードとラズパイがあり、一台一台全て設定が違います。
こうした場合、上のようなプラグインを利用すると、せっかく設定したマシンが別のマシンに化けてしまうというオカルティックな現象を起こしてしまいます。

そんなオカルティックな現象を回避しつつ、NASのデータベースやプレイリストだけを複数台のマシンで共有するためにはどうすればいいのか？
それは「其の二」でご紹介したいと思います。
ついでに予告しておくと、それぞれのマシンの完全なバックアップを個別に作成するためにはどうしたらいいのかは「其の三」でご紹介する予定です。
どこまで需要があるのか、疑問ではありますが...

この内容が、プラグイン機能のより一層の理解に繋がれば幸いです。