hilight.js

2018年2月21日水曜日

[discord bot]チャンネルの作成と削除

discordで、サーバーのメンバーに自由にチャンネルを作成する権限を解放したかったが、削除の権限も一緒に解放されてしまうため、うっかり違うチャンネルを削除してしまったとかが起こりそうで、なかなか権限解放に踏み切れなかった。
ということで、botを介してチャンネルの作成削除を行うことで、自分が作成したチャンネルじゃないと削除できないようにしてみた。

事前にチャンネルの作成、削除を行える役職を作成しておいて、それを対象のbotに割り当てる必要がある。

環境


  • ubuntu 16.04.3 LTS + LXDE
  • javascript
  • node.js 9.4.0
  • discord.js 11.3.0

チャンネルの作成


チャンネルの作成は、guildオブジェクト(1つのサーバーを表すオブジェクトらしい)が持っているcreateChannelメソッドで行うことができる。

client.on("message", (message) =>
{
  message.guild.createChannel( 'sample', 'text' );
}

とりあえずこれだけで、sampleという名前のテキストチャンネルが作成される。ボイスチャンネルを作りたい場合は、第二引数を'voice'にする。

また、特定のカテゴリの下にチャンネルを作りたい場合は、チャンネルを作った後に、そのチャンネルに親チャンネルを指定してあげればいい。

client.on("message", (message) =>
{
  message.guild.createChannel( 'sample', 'text' )
    .then( (ch) => {
      // カテゴリもチャンネルの一種なので、channelsの中に入っている
      let parent = message.guild.channels.find( 'name', 'Text Channels' );
      if ( parent ) {
        ch.setParent( parent );
      }
    })
    .catch( (err) => { console.log( err ); } );
}

ちなみに、カテゴリ名に実際は小文字が使われていても、チャンネルリスト上では全部大文字で表示される。findメソッドで検索する時には、ちゃんと実際のカテゴリ名で検索しないと失敗する。

コマンドでチャンネル名を指定して作成する処理は、以下のような形にしてみた。うちのサーバーはカテゴリを使ってないので、単純にチャンネルを作成するだけになっている。

client.on("message", (message) =>
{
  // コマンドとチャンネル名指定の引数にわける
  let arg = message.content.split( /\s+/ );
  const cmd = arg.shift();
  const ch_name = arg[0];
 
  if ( cmd === '!ch' )
  {
    // 既に同名のチャンネルが存在していないかチェック
    // 同名チャンネルも作成できるが、消すときに困るので同名は弾く
    if ( !message.guild.channels.exists( 'name', ch_name ) )
    {
      message.guild.createChannel( ch_name, 'text' )
        .then( (ch) => {
          ch.send( message.member.displayName + 'が作成しました' );
        })
        .catch( (err) => { console.log( err ); } );
    }
  }
}

チャンネルの作成に成功したら、作成したチャンネルで作成者の名前を表示するようになっている。
thenとかcatchは、createChannelメソッドが返してくるpromisオブジェクトのメソッドで、非同期処理を扱うものらしい。
とりあえず、createChannelが終わるとthenの中身が実行される。失敗した場合はcatchの方が呼ばれる。


チャンネルの削除


チャンネルの削除は、channelオブジェクトのdeleteメソッドを呼ぶだけで削除される。

client.on("message", (message) =>
{
  let ch = message.guild.channels.find( 'name', 'sample' );
  if ( ch ) {
    ch.delete();
  }
}

コマンドで削除チャンネルを指定するのは、チャンネル作成と同じなので省略。


チャンネル作成者のみ削除を行えるようにする


作成したチャンネルのIDと作成者のIDを記録しておいて、削除の時に参照するようにする。
また、botを再起動しても大丈夫なように、チャンネル作成ログをJSONファイルとして出力するようにする。
以下がそのコード。

"use strict"
 
// JSONファイル出力関数
const write_json = ( filename, obj ) =>
{
  fs.writeFile( filename, JSON.stringify( obj, null, '\t' ), (e) => {
    if ( e ) {
      console.log( e );
      throw e;
    }
  });
}
 
const Discord = require( 'discord.js' );
const fs = require( 'fs' );
const client = new Discord.Client();
const token = "xxxxxxxx"; // トークンに置き換え
 
const ch_log_filename = 'ch_log.json';
 
let ch_log ={};
// ch_log.jsonが存在していれば読み込み、無ければchannels配列を作成
try {
  const str = fs.readFileSync( ch_log_filename, 'utf8' );
  ch_log = JSON.parse( str );
}
catch ( err ) {
  ch_log.channels = new Array();
}
 
 
client.on("ready", () => {
  console.log("im ready test bot");
});
 
 
client.on("message", (message) =>
{
  let arg = message.content.split( /\s+/ );
  const cmd = arg.shift();
  const ch_name = arg[0];
 
  if ( cmd === '!ch' )
  {
    if ( !message.guild.channels.exists( 'name', ch_name  ) )
    {
      message.guild.createChannel( ch_name, 'text' )
        .then( (ch) => {
          ch.send( message.member.displayName + 'が作成しました' );
 
          let obj = {
            ch_id: ch.id,
            user_id: message.member.id,
          }
 
          // チャンネルIDとユーザーIDを追加してJSONファイルに出力
          ch_log.channels.push( obj );
          write_json( ch_log_filename, ch_log );
        })
        .catch( (err) => { console.log( err ); });
    }
    else {
      message.channel.send( '同名のチャンネルが既に存在しています' );
    }
  }
 
  if ( cmd === '!dch' )
  {
    let channel = message.guild.channels.find( 'name', ch_name );
 
    if ( channel )
    {
      const index = ch_log.channels.findIndex( (obj)=>{
        return obj.ch_id === channel.id;
      });
 
      // 削除しようとしているユーザーが作成者かチェック
      if ( message.member.id === ch_log.channels[index].user_id )
      {
        channel.delete()
          .then( (ch) => {
            // 削除したチャンネルじゃなければ削除メッセージを送信
            if ( ch.id !== message.channel.id ) {
              message.channel.send( ch_name + 'チャンネルを削除しました' );
            }
 
            // 削除したチャンネルのログを削除してJSONファイルに出力
            ch_log.channels.splice( index, 1 );
            write_json( ch_log_filename, ch_log );
          })
          .catch( (err) => { console.log( err ); } );
      }
      else {
        message.channel.send( ch_name + 'チャンネルを削除する権限がありません' );
      }
    }
    else {
      message.channel.send( ch_name + 'チャンネルは存在しません' );
    }
  }
});
 
client.login(token);

作成

削除


そろそろコードブロック表示ちゃんと対応しないと厳しいな…。

2018年2月13日火曜日

discordのbotをNAS上で常時動かす

discordでbotを動かせるようになったのはいいが、botは自分のPC上で動いているため、PCを落とすともちろんbotも落ちてしまう。
丁度、常時動いているNASがあったので、NAS上でbotを動かしてみた。


環境


  • ubuntu 16.04.3 LTS + LXDE
  • QNAP NAS TS-231+ バージョン4.3.4.0435


とりあえずNAS上で直接動かしてみる(失敗)


QNAP QTSのAppCenterからNode.jsをインストール。
その後、NASにSSHでリモート接続(ここのmacのやり方を参考)し、npmでdiscord.jsをインストールすることで、とりあえずbotが動かせる環境はできた。

しかし、botを動かしたままでNASからログアウトしようとすると、NAS上の端末がbotに占有されているので、botを止めないとログアウト処理ができない。 ログインしたままにしてみるが、PCを落とすともちろんSSH接続の切れて、なぜかNAS上で動いてるbotも停止する。SSH接続が切れると、NAS上で動かしていた端末も終了してしまうのだろうか。

そういう場合、screenを使って仮想端末を作り、その仮想端末上でbotを動かしたあとにデタッチすることで、botを動かしたままNASからログアウトできるらしいが、NASにはscreenが入っていない。
screenをインストールしようとするも、aptみたいなパッケージマネージャも入っていない。
opkgというパッケージマネージャに辿り着き、インストールしてみるもうんともすんとも言わない。
パッケージマネージャがなくてもscreenをインストールする方法もあるかもしれないが、分からなかったので他の方法に逃げることにした。


仮想環境でbotを動かす(成功)


QNAPのNASには、ContainerStationという仮想環境を立ち上げるアプリがあり、NAS上で別のOSを動かすことができるらしい。
ということで、その仮想環境上でbotを動かしたままにして、NASからログアウトできるかやってみる。

まずは、AppCenterでContainerStationをインストール。
ContainerStationを起動し、コンテンツ作成からUbuntuイメージをインストールする。


Ubuntuイメージは、推奨の中には3つほどあるが(イメージ検索するともっと出てくる)、UbuntuのバージョンをPC側と合わせたかったので、dockerのものを選択した。

インストールボタンを押すと、設定画面が出てくるがデフォルトのままでも問題なさそう。
NASのスペックが低いので、一応CPUリミットとメモリー制限を半分にしておいた。

あとは、詳細設定の共有フォルダで、NAS上のフォルダに仮想環境からマウントされるようにしておくと、NAS上のファイルに仮想環境からアクセスできて便利。

あとは、作成ボタンを押して少し待つと仮想環境が立ち上がる。

仮想環境にアクセスする

PCからNASにSSH接続し、

docker ps

とすると、現在起動しているdockerコンテナ(仮想環境)が表示される。
そこに表示されているCONTAINER IDを使用して

docker attach <CONTAINER ID>

とすることで、dockerコンテナにアクセスできる。

仮想環境内でbotを動かす環境を構築する

user作った方がいいみたいだけど、NASは外部に公開してないので、これ以降の仮想環境内ではルートで作業してしまっている。

まずはパッケージ一覧の更新と、パッケージの更新をしておく。

apt update
apt upgrade

次に、node.js,npm,discord.jsをインストールする。

apt install nodejs nps
npm install discord.js --save

dockerイメージは、タイムゾーンが協定世界時(UTC)になっているようなので、botで時間を扱う時用に日本(JST)に変更しておく。
timedatectlはなぜか入ってないので、/etc/localtimeのシンボリックリンクを変更する方法で変更しようとすると、タイムゾーンデータベースもなぜか入ってないのでインストールする。

apt install tzdata

それからタイムゾーンを日本に変更。

ln -sf /usr/share/zoneinfo/Asia/Tokyo /etc/localtime


botを動かしたままにしてNASからログアウトする

自分の場合は、botのjsファイルをNAS上のjsフォルダにおいてたので、マウント先に移動してbotを起動。

cd /mnt/nas/js
node bot.js

起動を確認したら ctrl+p ctrl+q の順に押すことで、dockerコンテナをデタッチしてNAS上の端末に戻る。
あとはその端末で

exit

とするとNASからログアウトできる。

これで、botをNAS上で常時動かせるように出来た。

2018年2月7日水曜日

discordのbotからイカリング2にアクセスする

splatoon2の連動サービスであるイカリング2。アプリ以外からでも情報を読めるように出来るということで、discordのbot上から情報を取得して表示してみた。

環境


  • ubuntu 16.04.3 LTS + LXDE
  • javascript
  • node.js 9.4.0
  • npm 5.6.0
  • discord.js 11.3.0
  • ipad iOS 11.2.2


前提


イカリング2にアプリ以外からアクセスできるようになるまでは、
イカリング2をPCブラウザで見れる方法があるらしいのでやってみたを参照。

イカリング2から情報を取得するのは、
[Python]イカリング2のJsonを取得してみたを参照。

上記を参照しながら、ひっかかったところだけまとめていく。


pipのインストールでひっかかる


参照サイトのように

sudo easy_install pip

と打っても、easy_installなんてコマンドはないと言われる。
easy_installは、setuptoolsというパッケージをインストールすることで使えるようになるらしいが、既にメンテナンスされておらず、代わりにdistributeというのを使った方がいいらしい。
が、distributeについてはよくわからなかったので、普通にaptでインストールすることにした。

sudo apt install python-pip3

pipはpythonのパッケージ管理ツールで、python2用とpython3用で別々に存在するらしい。
ここでは、新しい方をインストールしておこうということでpython3用のpip3を選択した。
そのため、コマンドを打つ時は、pipではなくpip3になる。
ちなみにpython2用のpipも共存できる。


mitmproxyのインストールでひっかかる


mitmproxyインストール中にエラーで中断してしまった。
どうも以下のパッケージがインストールされていないといけないらしい。

  • python-dev
  • libffi-dev
  • libssl-dev
  • libxml2-dev
  • libxslt1-dev
  • libjpeg8-dev
  • zlib1g-dev

自分の場合は、sslなんちゃらが見つからないよと言われていたので、libssl-devをインストールしたら通るようになった。
めんどくさい場合は、全部インストールしておけば問題ないだろう。

sudo apt install python-dev libffi-dev libssl-dev libxml2-dev libxslt1-dev libjpeg8-dev zlib1g-dev



mitmproxyの起動でひっかかる


参照サイト の通りに、ポート8080を指定したら、既に使われていると出て起動できなかった。
調べてみるとSublimeText3がそのポートを使用していたので終了させた。
すると今度はchromeがポート8080を使い出して起動できない。
結局、他の使われていないポートを使用することで起動した。
ここではポート8081を使うようにする。

mitmproxy -p 8081

iOS端末の方でも、HTTPプロキシの設定でポートを8081にする必要がある。


PCのIPが分からなくてひっかかる


linux ip 確認 でググッてたどり着いたのが

ip route

だったが、IPらしきものが複数表示されて、どれがPCのIPかぜんぜんわからん。 ip route 見方 でググっても経路どうこうと専門的な説明ばかりで、結局PCのIPと言われた場合はどのIPを指すのかぜんぜんわからん。

実際に試した感じでは、下の画像の○で囲んだ部分が、PCのIPと言われた時に参照するIPのようだ。

一番上の頭にdefaultがついているのがルーターを指し、一番下の行が自分のPC、真ん中の169.254.0.0というのは無視していいもののようだ。
ちなみにwifi搭載機で有線接続を行っていると、ルーターと自分のPCのところに、有線分の行が追加される。

といわけでIPが分かったので、iOS端末のHTTPプロキシ設定でサーバーのところに、このIPを書き込む。


iOS端末がネットに繋がらなくてひっかかる


http://mitm.itにアクセスして証明書のインストールまでは出来たが、iOS端末でNintendoSwitchOnlineアプリを開くと、接続が不安定ですと言われて先に進めなくなった。
(そもそもhttp://mitm.itにアクセスできない場合は、mitmproxyの起動か、iOS端末のHTTPプロキシの設定に問題がある)

証明書をインストールした後に、iOS端末の[設定]-[一般]-[証明書信頼度設定]から、インストールしたmitmproxyをONにする必要があった。
これでイカリング2にアクセスできるようになり、mitmproxy上で色々情報が見れるようになった。


参考サイトのサンプルコードがpythonでひっかかる


ここからは、[Python]イカリング2のJsonを取得してみたを参照しながら作業を進めるが、タイトルにもあるようにpythonを使用している。

というわけで調べた結果、javascriptでjsonを取得する場合、node.jsのモジュールであるrequestを使うのがよさそうだ。
他にもいろいろ方法があるが、discord.jsもnode.jsのモジュールなので、同じnode.js上で動くものを選んだ。
というわけで、requestモジュールをインストールする。

npm install request --save

これを使用して、jsonの取得処理を書くとこうなる。

let req = require( 'request' );
let j = req.jar();
 
const url = 'https://app.splatoon2.nintendo.net/api/onlineshop/merchandises';
const cookie = 'iksm_session=xxxxx';  // xxxxxを取得したcookieの値に置き換え
j.setCookie( cookie, url );
 
const options = {
  url: url,
  method: 'GET',
  jar: j,
  headers: {
    'content-type': 'application/json',
  },
  json: true
}
 
req( options, ( err, res, obj ) => {
  console.log( JSON.stringify( obj, null, '\t' ) );
});

上の例では、ゲソタウンから取得したJSONをコンソール上に表示する。

取得したjsonを利用して、botでゲソタウンの先頭のギアを表示してみる。

"use strict"
 
const Discord = require("discord.js");
const client = new Discord.Client();
const token = "xxxxx";  // xxxxxをbotのトークンに置き換え
 
client.on("ready", () => {
    console.log("im ready test bot");
});
 
 
client.on("message", (message) =>
{
    if ( message.isMentioned(client.user) )
    {
        let req = require( 'request' );
        let j = req.jar();
 
        const url = 'https://app.splatoon2.nintendo.net/api/onlineshop/merchandises';
        const cookie = 'iksm_session=xxxxx';  // xxxxxを取得したcookieの値に置き換え
        j.setCookie( cookie, url );
 
        const options = {
            url: url,
              method: 'GET',
              jar: j,
              headers: {
                  'content-type': 'application/json',
              },
              json: true
        }
 
        req( options, ( err, res, obj ) =>
        {
            const gear = obj.merchandises[0];
 
            const desc = 'ブランド:' + gear.gear.brand.name + '\n' +
                        'ギアパワー:' + gear.skill.name + '\n' +
                        'サブギアパワー:' + gear.gear.brand.frequent_skill.name;
 
            message.channel.send( desc, {
                'embed': {
                    title: gear.gear.name,
                    'image': {
                        'url': 'https://app.splatoon2.nintendo.net' + gear.gear.image,
                    }
                }
            } );
        });
    }
 
});
 
client.login(token);

こんな感じになる

2018年2月2日金曜日

discordのbotにカスタム絵文字を使わせる

前提

ここでのdiscord botは、javascriptでdiscord.jsを使用して作成。
javascriptもdiscord botもさわり初めて2〜3日なので、その程度の知識。

botでカスタム絵文字が使えない

discordのbotに絵文字を使わせる場合、標準の絵文字だと

:boom:

とか書くだけで


のように表示される。
しかし、これがカスタム絵文字になると :custom_test: と書いても

のようにそのまま表示されてしまった。

解決策

ここを参考に解決。英語が読める場合は、参照サイトの方が詳しく書いてます。

テキストチャットをする際は、カスタム絵文字も :custom_test: と書くと表示されていたけど、実はこれは省略された形らしく、botにカスタム絵文字を使わせる場合は本来の書き方をしないといけないらしい。

本来の形は以下の通り

<:custom_test:012345678910111213>

数字部分はカスタム絵文字に割り振られたID(値は適当)。
これをこのまま書いても表示されるようになるが、このIDがdiscord内のどこに表記されているかわからなかったので、"<:custom_test:012345678910111213>"という文字列を取得するようにした。

以下、botにメンションを送ったら、botがカスタム絵文字を表示するコード。

"use strict"
 
const Discord = require("discord.js");
const client = new Discord.Client();
const token = "xxxxxxxxxx"; // botのトークンに置き換える
 
client.on("ready", () => {
    console.log("im ready test bot");
});
 
 
client.on("message", (message) =>
{
    if ( message.isMentioned(client.user) )
    {
        // emojisコレクションから"custom_test"という名前のカスタム絵文字を検索
        // "name"は名前を検索するってことか?
        const emoji = client.emojis.find( "name", "custom_test" );
 
        // emojiオブジェクトのtoString()メソッドで"<:custom_test:012345678910111213>"が取得できる
        message.channel.send( emoji.toString() );
    }
 
});
 
client.login(token);

結果

絵文字が見つからなかった場合、emojiにはnullが入ってるので、実際に使う場合はちゃんとnullチェックしないといけない。


余談

参考にしたサイト だと

  const emoji = client.emojis.find( "name", "custom_test" );
  message.channel.send( '${emoji}' );

でいけるみたいに書いてたが、うちの環境ではそのまま ${emoji} と表示されてしまい、解決できなかったのでtoString()を使った。