Discourseプラグイン開発 - パート5 - 管理画面の追加

前のチュートリアル: Developing Discourse Plugins - Part 4 - Setup git


場合によっては、サイト設定だけでは、プラグインを希望通りに動作させるための管理インターフェースとして不十分なことがあります。例えば、discourse-akismet プラグインをインストールすると、Discourse の管理画面のプラグインセクションにナビゲーション項目が追加されていることに気づくかもしれません。

このチュートリアルでは、プラグイン用の管理インターフェースの追加方法を紹介していきます。私はこのプラグインを「purple-tentacle(紫色のタコ足)」と名付けます。これは、私の好きなコンピューターゲームの1つにちなんで名付けました。本当に、あのゲームが大好きです

管理ルートの設定

まずは、これまでのチュートリアルと同様に plugin.rb を作成することから始めましょう。

plugin.rb

# name: purple-tentacle
# about: A sample plugin showing how to add a plugin route
# version: 0.1
# authors: Robin Ward
# url: https://github.com/discourse/purple-tentacle

add_admin_route 'purple_tentacle.title', 'purple-tentacle'

Discourse::Application.routes.append do
  get '/admin/plugins/purple-tentacle' => 'admin/plugins#index', constraints: StaffConstraint.new
end

add_admin_route の行は、このプラグインが /admin/plugins ページにリンクを必要とすることを Discourse に伝えます。そのタイトルは i18n 翻訳ファイルから purple_tentacle.title を使用し、purple-tentacle ルートにリンクされます。

その下の行は、プラグインのサーバー側のルートマッピングを設定します。Discourse は、フロントエンドのほぼすべてのルートがデータを提供するサーバー側のルートを持っていると仮定しています。このサンプルプラグインでは実際にはバックエンドからデータを取得する必要はありませんが、ユーザーが直接 /admin/plugins/purple-tentacle にアクセスした場合に何らかの内容を返すように Discourse に指示する必要があります。この行は、そのように伝えています:「もしユーザーがその URL に直接サーバー側からアクセスしたら、デフォルトのプラグインコンテンツを表示して!」

(もし混乱したら、気にしすぎないでください。後続のチュートリアルでサーバー側のアクションを扱う際に再び取り上げます。)

次に、ユーザーが /admin/plugins/purple-tentacle パスにアクセスした際に表示されるテンプレートを追加します。これは、ボタンをクリックすると紫色のタコ足のアニメーション GIF を表示するだけのボタンになります。

assets/javascripts/discourse/templates/admin/plugins-purple-tentacle.gjs

import DButton from "discourse/components/d-button";

<template>
  {{#if @controller.tentacleVisible}}
    <div class="tentacle">
      <img src="https://eviltrout.com/images/tentacle.gif" />
    </div>
  {{/if}}

  <div class="buttons">
    <DButton
      @label="purple_tentacle.show"
      @action={{@controller.showTentacle}}
      @icon="eye"
      @id="show-tentacle"
    />
  </div>
</template>

Handlebars の基本を学んでいれば、このテンプレートは非常にシンプルに理解できるはずです。<DButton /> は、ラベルとアイコン付きのボタンを表示するために Discourse で使用されるコンポーネントです。

新しいテンプレートを接続するには、ルートマップを作成する必要があります。

assets/javascripts/discourse/purple-tentacle-route-map.js

export default {
  resource: "admin.adminPlugins",
  path: "/plugins",
  map() {
    this.route("purple-tentacle");
  },
};

ルートマップは、プラグインが Ember アプリケーションにルートを追加できるようにするために Discourse に追加されたものです。map() 内の構文は、Ember のルーターと非常に似ています。この場合、ルートマップは非常にシンプルで、/admin/plugins の下に purple-tentacle という名前の1つのルートだけを宣言しています。

最後に、翻訳文字列を追加しましょう。

config/locales/client.en.yml

en:
  js:
    purple_tentacle:
      title: "Purple Tentacle"
      show: "Show Purple Tentacle"

開発サーバーを再起動すると、/admin/plugins にアクセスできるようになり、リンクが表示されます!クリックすると、紫色のタコ足を表示するボタンが表示されます。

残念ながら、ボタンをクリックしても何も起こりません :frowning:

開発者コンソールを見ると、その理由の手がかりとなるエラーが表示されているはずです。

Uncaught Error: Nothing handled the action 'showTentacle'`

はい、その理由はテンプレート内で以下の2つのことに依存しているためです。

  1. ユーザーがボタンをクリックすると、コントローラーで showTentacle が呼び出されること。
  2. showTentacle がプロパティ tentacleVisibletrue に設定し、画像が表示されること。

もし Ember のコントローラーに関するガイドを読んでいない場合は、今が読む良いタイミングです。なぜなら、このロジックを処理する purple-tentacle テンプレート用のコントローラーを実装するからです。

以下のファイルを作成してください。

assets/javascripts/discourse/controllers/admin-plugins-purple-tentacle.js

import Controller from "@ember/controller";
import { action } from "@ember/object";
import { tracked } from "@glimmer/tracking";

export default class AdminPluginsPurpleTentacleController extends Controller {
  @tracked tentacleVisible = false;

  @action
  showTentacle() {
    this.tentacleVisible = true;
  }
}

これでページをリフレッシュすると、ボタンをクリックするたびにアニメーションキャラクターが表示されます!

タコ足を隠すボタンを追加するのは、読者への追加課題として残しておきます :smile:

このプラグインの動作に問題がある場合は、GitHub にプッシュしていますので、ご参照ください。


シリーズの他の記事

パート 1: プラグインの基礎
パート 2: プラグインアウトレット
パート 3: サイト設定
パート 4: git のセットアップ
パート 5: このトピック
パート 6: 受け入れテスト
パート 7: プラグインの公開


このドキュメントはバージョン管理されています。変更を提案する場合は、GitHub でお知らせください。

「いいね!」 28

Hm, doesn’t seem to work on my local side… did anyone face the same problem?

What’s the problem? If you install the purple tentacle plugin does it not work?

edit: issue resolved. it works!

@eviltrout nope, it doesn’t work. I believe @ladydanger is also facing the same problem.
nothing appears in the site settings or plugins tabs.
I tried both following the instructions as well as symlink-ing your plugin (dl-ed from github).
I then tried to create server.en.yml, client.en.yml, settings.yml following the format of other plugins, but the image wouldn’t render anyhow.

probably something wrong with the …route-map.js.es6 or config files.

interestingly enough, akismet’s plugin does work for me.


One issue that keeps on biting me is that I still need to do

rm -fr /tmp/cache

To kick away some odd caching we have in some cases.

「いいね!」 1

@eviltrout

oh now this is an interesting finding - apparently our ad plugins were interfering with the purple-tentacle plugin. or the other way round. it works now, after having removed the ad plugin files.

  • it now works with our ad plugins! possibly some minor bug yesterday. all is good!

@sam, what’s the difference between rm -rf tmp and rm -fr /tmp/cache

I usually only delete the cache directory, no need to nuke the entire tmp directory.

「いいね!」 2

Are you sure it was a plugin conflict?

I copied it into my localhost plugin folder and started up the VM without removing the temp folder and got the same results as you posted.

I was puzzled to see the route in object dot notation but ignored that.

I then started up the VM and did remove the temp folder and all was OK

「いいね!」 1

Actually, sometimes you need just cache, and sometimes you need the whole tmp directory.

Maybe we could have an initializer that checks the timestamps on the plugin folders and nukes tmp if they were updated (dev only).

「いいね!」 3

One thing I really should have warned you about is I started raising errors on ember deprecations. We are really working towards upgrading our version of Ember soon and I wanted to make sure developers caught them. It’s possible your plugin has a deprecation or two and is now raising an error with the latest version of Discourse.

If you can’t figure out how to fix the deprecation, it’s okay to temporarily disable it in the Discourse working directory you are using. Try removing these two lines.

「いいね!」 2

No clue what I’m doing wrong here, but it shows up like this:

It must be the /config/locales/en.yml not loading, but why?

I put this file structure in the root of the plugin directory. Verified it’s there, nuked the tmp, restart rails.

en:
  js:
    purple_tentacle:
      title: "Purple Tentacle"
      show: "Show Purple Tentacle"
「いいね!」 1

I was a bit surprised to see the file named “en.yml” but figured either eviltrout knew something I didn’t (which I’m sure he does … anyway) or that maybe something had changed the way things worked.

I’m guessing that what Robin meant was client,en.yml because that works for me.

the file goes in the plugins config/locales folder

「いいね!」 4

Thanks I’ll try that after I get my dev environment setup on the xeon, went through hell getting ubuntu 16.04 to work right with my hardware. Turned out it wasn’t the server mobo, but the new nvidia card.

Yea I meant I put all the directories listed hierarchically starting with the plugins folder. Was wondering if for some reason that last file went elsewhere.

Same thing.

I tried naming the file client,en.yml, client.en.yml, and creating a client folder placing en.yml inside it.

Same result

Did you stop vagrant, clear the cache
$> rm -rf tmp
and restart vagrant?

I’m not using vagrant, yes I nuked tmp, restart rails.

This is a bit too annoying, and not a big deal. I’m going to move forward, but thanks for the efforts.

I have a feeling you may have the folder structure wrong, or maybe the naming. Mine is like

/discourse
../plugins
..../{yourpluginname}
......plugin.rb
....../config
........settings.yml
......../locales
..........client.en.yml
..........server.en.yml
....../assets
......../javascripts
........../discourse
............{yourpluginname}-route-map.js.es6
............/controllers
..............admin-plugins-{yourpluginname}.js.es6
............/templates
............../admin
................plugins-{yourpluginname}.hbs
「いいね!」 1

That’s the file structure I have.

I don’t see a point in getting stuck on this, already hacked together a couple of rails sites and trying to absorb as much as possible.

Just going to leave this as some simple error on my part that I’ll come look back at later on and probably realize right away what it was.

Thanks, thou

Another mistake of mine! I’ve updated the OP, thanks.

「いいね!」 2

Is there any way I can change a global plugin setting, say, a siteSetting, from here?
I need admins to be able to use this interface to add data into a global array.