h3zjp / EDCBNotifier

EDCB から LINE や Twitter に、そして cURL を使い通知を送るツール

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Logo EDCBNotifier

Screenshot

EDCB から LINE や Twitter(ツイート・DM)に、そして cURL を使って通知を送れるツールです。

About・Feature

xtne6f 版 EDCB のバッチファイル実行機能を使い、

  • LINE (LINE Notify)
  • Twitter (ツイート)
  • Twitter (ダイレクトメッセージ)
  • cURL

に EDCB の各通知を送信できる Python 製ツールです。

xtne6f 版 EDCB のバッチファイル実行機能を利用しているため、xtne6f 版の EDCB 、または tkntrec 版など xtne6f 版をフォークした EDCB が必要です(ここ数年の EDCB ならいけるはず)。
EDCB 本家に実装されていた Twitter 機能 (Twitter.dll) の代替としても使えると思います。

たとえば、EDCB で録画が開始されたときに LINE で録画開始を番組名を添えて通知したり、EPG 自動予約で追加された予約を通知で確認することができます。

LINE への通知は LINE Notify を使って送信します。
LINE Notify はアプリケーションからの通知を指定したユーザーやグループで受信することができるサービスです。
通知メッセージは LINE Notify の公式アカウントから受信できます(一度使ってみたほうが早いかも)。

Twitter への通知はツイートでの通知に加え、ダイレクトメッセージでの送信も可能です。
ダイレクトメッセージは自分宛てに送ることも、DM を送信できる他のアカウントに送ることもできます。
たとえば、録画通知用の Twitter アカウントを作ってメインアカウントと相互フォローになり、録画通知用のアカウントからメインアカウント宛てに通知を送ることもできます。

※: cURL は手抜き実装のため、EDCBNotifier.py を直接編集する必要があります。投稿先のサービスに応じて、適宜修正して下さい。

通知できるイベントは、

  • 予約を追加したとき (PostAddReserve.bat が実行されたとき)
  • 予約を変更したとき (PostChgReserve.bat が実行されたとき)
  • 録画を開始したとき (PostRecStart.bat が実行されたとき)
  • 録画を終了したとき (PostRecEnd.bat が実行されたとき)
  • 更新通知が送られたとき (PostNotify.bat が実行されたとき)

の 5 つです。

それぞれのイベントは、個別に通知するかどうかを設定できます。
更新通知が頻繁に送られてきてうるさい、といったときに [更新通知が送られたとき] のイベントだけ通知しないようにすることも可能です。

通知するメッセージは 5 つのイベントごとに自由に変更できます。
設定ファイルは Python スクリプトなので、Python の知識があればメッセージをより高度にカスタマイズすることもできそうです。
EDCB からのマクロに加えて、放送局名から取得したハッシュタグや更新通知タイプ、放送局名やタイトル名の英数字の半角変換など、独自のマクロも用意しています。

Setup

1. ダウンロード・配置

[Code] メニュー内の [Download Zip] をクリックし、EDCBNotifier をダウンロードします。
または、こちら のリンクからでもダウンロードできます。

ダウンロードできたら解凍し、

  • EDCBNotifier フォルダ
  • PostAddReserve.bat
  • PostChgReserve.bat
  • PostRecStart.bat
  • PostRecEnd.bat
  • PostNotify.bat

を EDCB 本体 (EpgTimer.exe) があるフォルダに配置します。
また、requirements.txt は今後の作業で利用するので、取っておいてください。

2. Python のインストール

EDCBNotifier の実行には Python (Python3) が必要です 。動作確認は Python 3.7 系と Python 3.8 系で行っています。

すでに Python3 がインストールされている場合はスキップしても構いませんが、すでに Python2 がインストールされている場合は別途 Python3 をインストールしてください。
(Python2 と Python3 は半分別物で、このうち Python2 は 2020 年 1 月でサポートが終了しています)

Screenshot

非公式 Python ダウンロードリンク から、Python3 のインストーラーをダウンロードします。
とくにこだわりがないのであれば、一番上にある Windows (64bit) 用 Python 3.8 の最新版 ( 2020 年 7 月現在の最新は 3.8.5 ) をダウンロードしてください。

Python 公式サイト からもダウンロードできますが、わかりにくいので前述のサイトからダウンロードすることをおすすめします。
Python 公式サイトにも大きいダウンロードボタンがありますが、これは罠です…(OS のビットに関わらず 32bit の インストーラーがダウンロードされる)

もし OS が 32bit の方は Windows (32bit) 用をダウンロードしてください(ほとんどいないと思うけど…)。
Windows10 では Microsoft Store からもインストールすることができますが、安定していない上にストアアプリの制限の影響で正常に動かないことがあるため、非推奨です。

ダウンロードが終わったらインストーラーを実行します。 [Install Now] と [Custom Install] がありますが、 [Custom Install] の方をクリックしてください。
このとき、必ず [Add Python 3.8 to PATH] にチェックを入れてから進んでください。

[Option Features] は特にこだわりがなければそのまま進みます。

[Advanced Options] は ** [Install for all users] にチェックを入れます**(これで AppData 以下に配置されなくなる)。
デフォルトでは AppData 以下にユーザーインストールする設定になっていますが、他のユーザーから見れないほかパスが長くなっていろいろ面倒だと思うので、私はおすすめしません。

[Install for all users] にチェックを入れると [Customize install location] が C:\Program Files\Python38 になりますが、これも C:\Program Files 以外に変更します。
これは C:\Program Files 以下にインストールしてしまうと pip でのライブラリのインストールに毎回管理者権限を求められてしまい面倒なためです。
私は C:\Applications\Python\Python3.8 にインストールしていますが、とりあえず C:\Program Files 以下と C:\Users 以下でなければよいでしょう(別バージョンを入れることも考え Python\Python3.8 のような階層にしておくのがおすすめ)。

[Install] をクリックするとインストールが開始されます。
[Setup was successful] という画面が表示されればインストール完了です。
試しにコマンドプロンプトや PowerShell から python -V と実行してみましょう。

3. 依存ライブラリのインストール

EDCBNotifier が必要とする colorama・jaconv・requests・twitter の各ライブラリを pip でインストールします。

コマンドプロンプトや PowerShell を開き、pip install -r (ダウンロードした EDCBNotifier\requirements.txt) と実行します。
または単に pip install -r colorama jaconv requests twitter としても構いません。

エラーなくインストールできれば OK です。

4. 設定ファイルの作成

EDCB 内に配置した EDCBNotifier フォルダ内の config.default.py は、設定ファイルのひな形になるファイルです。
config.default.py を config.py にコピーしてください(コピーしておかないと設定が読み込めず動きません)。

リネームでもかまいませんが、設定をミスったときのために config.default.py は取っておくことを推奨します。

5. EpgTimerSrv の再起動

.bat ファイルの追加を EDCB に反映するためには、EpgTimerSrv の再起動が必要です。
EpgTimerSrv をタスクトレイに入れて運用している場合は、EpgTimerSrv を終了後、もう一度起動させてください。

EpgTimerSrv をサービスとして運用している場合は、EpgTimer Service の再起動が必要です。
net stop "EpgTimer Service" && net start "EpgTimer Service" と実行するか、[コンピューターの管理]→[サービス]からサービスを再起動してください。

ただ、経験上 EpgTimer Service を再起動すると EpgTimer の挙動が変になることがあるようなので、一度 Windows 自体を再起動してしまうのが手っ取り早いと思います。
録画中( EpgDataCap_Bon の稼働中)に EpgTimer Service を再起動してしまうと、手動で止めない限り録画が終わらない等の不具合が出る場合があるため、避けてください。

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

Usage

EDCBNotifier の設定は EDCBNotifier フォルダ内の config.py にて行います。
LINE Notify へ通知する場合は LINE Notify のアクセストークンが、Twitter へ通知する場合は Twitter API アプリが必須になります。
LINE Notify のアクセストークンの作成には LINE へのログインが、Twitter API アプリの作成には Twitter の開発者アカウントがそれぞれ必要です。

1. 設定

config.py を文字コード UTF-8 (BOM 無し)・改行コード LF で編集・保存できるエディタで編集します。
メモ帳は Windows10 1903 以前のものでは UTF-8 (BOM 無し)・LF で保存できなかったり、またシンタックスハイライトもないため避けてください。
できれば VSCode などのシンタックスハイライトや lint のあるエディタでの編集を推奨します。

通知タイプ (NOTIFY_TYPE) では、LINE (LINE Notify)・Tweet (ツイート)・DirectMessage (ダイレクトメッセージ) から通知するものを選択します。
デフォルト … 全てに通知する (['LINE', 'Tweet', 'DirectMessage'])

通知を行うイベント (NOTIFY_EVENT) では、通知するイベントのオン・オフを設定できます。
ここで設定したイベントだけが通知されます。たとえば頻度の多い PostNotify だけ通知しない設定も可能です。
デフォルト … 全てオン (['PostAddReserve', 'PostChgReserve', 'PostRecStart', 'PostRecEnd', 'PostNotify'])

通知時に同時に送信する画像 (NOTIFY_IMAGE) では、通知時に同時に送信する画像を指定できます。
None に設定した場合は画像を送信しません。画像サイズが大きすぎると送れない場合があるので注意してください(使う機会がない気も…)
デフォルト … 画像を送信しない (None)

ダイレクトメッセージの宛先 (NOTIFY_DIRECTMESSAGE_TO) では、ダイレクトメッセージで通知する場合に通知を送るアカウントをスクリーンネーム (ID) で指定します。
@ はつけないでください。予め宛先のアカウントと DM が送信できる状態になっていないと送れません。None に設定した場合は自分宛てに送信します。
デフォルト … 自分宛てに送信する (None)

ログをファイルに保存するか (NOTIFY_LOG) では、ログをファイルに保存(出力)するかどうかを設定します。
True に設定した場合は、ログを config.py と同じフォルダの EDCBNotifier.log に保存します。前回のログは上書きされます。また、コンソールへログを出力しなくなります。
False に設定した場合は、ログを保存しません。通常通りコンソールにログを出力します。
デフォルト … ログをファイルに保存しない (False)

このほか、config.py 内のコメントも参考にしてください。
保存する際は 文字コード UTF-8 (BOM 無し)・改行コード LF で保存します( CR+LF になったり BOM 付きにならないように注意)。

2. 通知するメッセージを編集する

通知イベントごとにメッセージを編集できます。
通知するメッセージの設定は config.py の [メッセージ] セクションにあります。

EDCB/Document/Readme_EpgTimer.txt#L929-L1008EDCB/Document/Readme_Mod.txt#L451-L475 に記載されている EDCB のマクロが使えます。マクロは $$ で囲んでください (ex: $ServiceName$)。
PostRecEnd の $Drops$ / $Scrambles$ / $Result$ など、特定のイベントでのみ利用できるマクロもあります。

また、独自にいくつかのマクロを追加しています。

  • $HashTag$ … 放送局名から取得したハッシュタグ (ハッシュタグは utils.py の get_hashtag() メソッドで定義)
  • $HashTagTitle$ … 番組タイトルから取得したハッシュタグ (ハッシュタグは下記の NOTIFY_HASHTAG_TITLE で定義)
  • $NotifyName$$NofityID$ から取得した更新通知タイプ($NofityID$ = 1 … EPGデータ更新 2 … 予約情報更新 3 … 録画結果情報更新)
  • $ServiceNameHankaku$$ServiceName$(放送局名)の英数字を半角に変換したもの
  • $TitleHankaku$$Title$(番組タイトル)の英数字を半角に変換したもの
  • $Title2Hankaku$$Title2$(番組タイトル・[]で囲まれている部分を削除したもの)の英数字を半角に変換したもの
  • $TimeYYYY$ … 実行時刻の上2桁付き西暦年 (ex: 2020 (年)) $TimeYY$ … 実行時刻の上2桁なし西暦年 (ex: 20 (年))
  • $TimeMM$ … 実行時刻の2桁固定の月 (ex: 07 (月)) $TimeM$ … 実行時刻の月 (ex: 7 (月))
  • $TimeDD$ … 実行時刻の2桁固定の日 (ex: 09 (日)) $TimeD$ … 実行時刻の日 (ex: 9 (日))
  • $TimeW$ … 実行時刻の曜日 (ex: 火 (曜日))
  • $TimeHH$ … 実行時刻の2桁固定の時 (24時間) (ex: 06 (時)) $TimeH$ … 実行時刻の日 (ex: 6 (時))
  • $TimeII$ … 実行時刻の2桁固定の分 (ex: 08 (分)) $TimeI$ … 実行時刻の分 (ex: 8 (分))
  • $TimeSS$ … 実行時刻の2桁固定の秒 (ex: 02 (秒)) $TimeS$ … 実行時刻の分 (ex: 2 (秒))

Python の辞書 (dict) 形式で格納しているので、改行を入れる場合は文字列内に \n と入力してください。文字列は + で連結できます。
マクロが存在しないか空の場合は -- が返されます。.bat ファイルを直接実行した場合は EDCB から渡される環境変数が存在しないため、全てのマクロが -- になります。

デフォルトのように絵文字も送信できます(ただ新しい絵文字だと端末側で表示できなかったりするので注意)。
カスタマイズしたい方は、お好みの通知メッセージへ変更してみてください。

番組タイトル(半角)に対応するハッシュタグ (NOTIFY_HASHTAG_TITLE) では、$HashTagTitle$ マクロにて利用する番組タイトルに対応するハッシュタグを設定します。部分一致です。
番組タイトルの判定には $TitleHankaku$ の値を利用します。NOTIFY_HASHTAG_TITLE 内に存在しない番組タイトルのハッシュタグは空文字になります。
config.py 内の記述例を参考に、番組タイトルとハッシュタグの対応を記述してください。

3. LINE Notify

LINE Notify へ通知しない場合は必要ありませんが、後述する Twitter の開発者アカウントを作成する手順よりもはるかに簡単なので、やっておくことをおすすめします(さほど手間もかかりません)。

LINE Notify にアクセスし、右上の [ログイン] から LINE へログインします(いつも使っているアカウントで構いません)。
ログインできたら、右上のメニューから [マイページ] に移動します。

Screenshot

下の方にある「アクセストークンの発行(開発者向け)」へ行き、 [トークンを発行する] をクリックします。

Screenshot

トークン名は LINE Notify で通知が送られてきたときに [EDCBNotifier] のように付加される文字列です( LINE Notify 全体でユニークである必要はないらしい)。
通知を送信するトークルームは [1:1 で LINE Notify から通知を受ける] か、任意のグループ LINE を選択してください。
ここでは「1:1 で LINE Notify から通知を受ける」(現在ログインしているアカウントに届く)を選択します。

Screenshot

[発行する] をクリックするとアクセストークンが発行されるので、 [コピー] をクリックしてクリップボードにコピーします。
アクセストークンはこの画面を閉じると二度と表示されない(一度解除し同じ内容でもう一度発行することはできるがアクセストークンは変わる)ので、どこかにメモしておくと良いでしょう。

Screenshot

画面を閉じると LINE Notify と設定したトークルームが連携されているはずです。

最後に config.py を開き、先程クリップボードにコピーしたアクセストークンを [LINE Notify] セクションの LINE_ACCESS_TOKEN に設定します。

これで、LINE Notify に通知を送信できる状態になりました!

試しに 5 つある .bat ファイルのうちのどれかを実行してみましょう。EDCB からの実行ではないのでマクロは全て空になっていますが、ちゃんと LINE に通知が届いているはずです。
もし届かない場合はログ出力をオンにしてみたり、.bat ファイルをコマンドプロンプトや PowerShell 上で実行し、出力される内容を確認してみてください。

4. Twitter (ツイート・ダイレクトメッセージ)

Twitter へ通知する場合は Twitter へ開発者登録を申請し、開発者アカウントを取得しておく必要があります(Twitter Developer アプリケーションの作成に Twitter の開発者アカウントが必要なため)。
ただ、悪用する人が多かったため今から登録するのはちょっと面倒になっています。これでも最近若干緩和されたらしいけど…

さすがに手順までは説明しきれないので、開発者申請の手順が解説されている記事を貼っておきます(記事1記事2)。

すでにツイートさせたいアカウントとは別のアカウントで開発者アカウントになっている場合、必ずしも別途録画通知用の Bot アカウントを開発者アカウントにする必要はありません。
Twitter API を使うためには後述する Consumer Key・Consumer Secret・Access Token・Access Token Secret の 4 つが必要ですが、このうち Twitter Developers でアプリ作成後に生成できる Access Token・Access Token Secret は開発者アカウントをしたアカウントのものが表示されます。
裏を返せば、予め開発者アカウントで Consumer Key・Consumer Secret を作成・取得し、ツイートさせたい Twitter アカウントとアプリ連携して Access Token・Access Token Secret が取得できれば、開発者登録をしたアカウント以外でも録画通知用のアカウントにできる、とも言えます。

自作のツールになりますが、Twitter API のアクセストークンを確認するやつ を使うと、EDCBNotifier のようなアプリ連携を実装していないツールでも Access Token・Access Token Secret を取得できます(極論、これを使わなくても作成した Consumer Key・Consumer Secret で録画通知用のアカウントとアプリ連携して Access Token・Access Token Secret を取得できれば可能です)。

Twitter Developers にアクセスし、右上の [Create App] から Twitter Developer アプリケーションの作成画面に移動します(ここで言う Twitter Developer アプリケーション(以下 Twitter API アプリ)は Twitter API を使うプロジェクトのような意味です)。
Twitter API アプリを作成すると、Twitter API を使うために必要な Consumer Key・Consumer Secret を取得できます。
すでに Twitter API アプリを作成している場合は飛ばすこともできますが、via が被るので新しく作ってもいいと思います。開発者登録のときとは異なり、審査はありません。

ScreenShot

App name(必須・重複不可らしい)

ここの名前がツイートの via として表示されます。
いわゆる「独自 via 」と呼ばれるものです。後で変えることもできるので、好きな via にしましょう。

(例)EDCBNotifier@(自分の TwitterID )
(例)Twitter for (自分の Twitter 名)

Application description(必須)

(例)EDCBNotifier@example から録画通知をツイートするためのアプリケーションです。

Website URL(必須)

利用用途的に自分以外は見ない部分なので、適当に設定しておきましょう。
ただし、http://127.0.0.1/ は設定できないようです。

(例)https://example.com/
(例)https://(自分のサイトのドメイン)/

Enable Sign in with Twitter

開発者登録をしたアカウント以外で利用する場合はチェックを入れてください。

Callback URLs

開発者登録をしたアカウント以外で利用する場合、アプリ連携をした後にリダイレクトされるコールバック URL を指定してください(複数設定できます)。
Twitter API のアクセストークンを確認するやつ を使う場合は https://tools.tsukumijima.net/twittertoken-viewer/ を設定します。

Terms of service URL

無記入で OK です。

Privacy policy URL

無記入で OK です。

Organization name

無記入で OK です。

Organization website URL

無記入で OK です。

Tell us how this app will be used(必須)

(例)このアプリケーションは、EDCBNotifier から通知をツイートするためのアプリケーションです。
このアプリケーションは、テレビの録画予約の追加・変更、録画の開始・終了をツイートやダイレクトメッセージで通知します。

(英語・こちらをコピペ)

(例)This application is for tweeting notifications from EDCBNotifier.
This application notifies you of the addition/change of TV recording reservation and the start/end of recording by tweet or directmessage.

記入し終えたら [Create] をクリックし、Twitter API アプリを作成します。

ダイレクトメッセージを送信するため Permissions タブに移動し、[Edit] をクリックします。

ScreenShot

Access permissionRead, write, and Direct Messages に設定し、[Save] で保存します。
こうすることでツイートの読み取り・ツイートの書き込みなどに加え、ダイレクトメッセージを送信できるようになります。
Permissions を変更すると今までに取得した Access Token・Access Token Secret が無効になります。注意してください。

ScreenShot

Keys and tokens タブに移動し、API Key と API Key Secret をクリップボードにコピーします。
API Key が Consumer Key 、API Key Secret が Consumer Secret にあたります。

ScreenShot

開発者登録したアカウントで利用する場合は、Access token & access token secret の横の [Generate]をクリックし、Access Token・Access Token Secret を生成します。
Access Token・Access Token Secret が表示されるので、クリップボードにコピーします。 このとき、Access Token・Access Token Secret は一度だけ表示されます。どこかにメモしておくとよいでしょう。

開発者登録したアカウント以外で利用する場合は、自力でアプリ連携して Access Token・Access Token Secret を取得するか、録画通知用にしたいアカウントにログインした状態で Twitter API のアクセストークンを確認するやつ に Consumer Key・Consumer Secret を入力し、Access Token・Access Token Secret をクリップボードにコピーしてください。

最後に config.py を開き、先程クリップボードにコピーしたアクセストークン等を [Twitter API] セクションの TWITTER_CONSUMER_KEY・TWITTER_CONSUMER_SECRET・TWITTER_ACCESS_TOKEN・TWITTER_ACCESS_TOKEN_SECRET にそれぞれ設定します。

これで Twitter にツイートやダイレクトメッセージで通知を送信できる状態になりました!

LINE Notify と同様に、5 つある .bat ファイルのうちのどれかを実行してみましょう。ちゃんとツイートと自分宛てのダイレクトメッセージで通知が届いていれば OK です。
もし届かない場合はログ出力をオンにしてみたり、.bat ファイルをコマンドプロンプトや PowerShell 上で実行し、出力される内容を確認してみてください。

これで設定は完了です!お疲れさまでした!
なにか不具合や要望などあれば IssuesTwitter までお願いします。

License

MIT License

ezoic increase your site revenue

About

EDCB から LINE や Twitter に、そして cURL を使い通知を送るツール

License:MIT License


Languages

Language:Python 94.6%Language:Batchfile 5.4%