تطوير إضافات Discourse - الجزء 5 - إضافة واجهة إدارية

البرنامج التعليمي السابق: Developing Discourse Plugins - Part 4 - Setup git


في بعض الأحيان، لا تكون إعدادات الموقع كافية كواجهة للمسؤول لكي يعمل المكون الإضافي الخاص بك بالطريقة التي تريدها. على سبيل المثال، إذا قمت بتثبيت المكون الإضافي discourse-akismet، فربما تكون قد لاحظت أنه يضيف عنصر تنقل إلى قسم المكونات الإضافية للمسؤول في منصة Discourse الخاصة بك:

في هذا البرنامج التعليمي، سنوضح لك كيفية إضافة واجهة مسؤول للمكون الإضافي الخاص بك. سأسمي المكون الإضافي الخاص بي purple-tentacle، تكريماً لـ إحدى ألعابي المفضلة على الكمبيوتر. بصراحة، أنا أحب تلك اللعبة حقًا!

إعداد مسار المسؤول (Admin Route)

لنبدأ بإضافة ملف 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 منصة Discourse بأن هذا المكون الإضافي سيحتاج إلى رابط على صفحة /admin/plugins. سيكون عنوانه purple_tentacle.title من ملف الترجمات الخاص بنا (i18n) وسيرتبط بالمسار purple-tentacle.

الأسطر التي تليه تقوم بإعداد تعيين المسارات من جانب الخادم للمكون الإضافي الخاص بنا. أحد الافتراضات التي تضعها Discourse هو أن كل مسار تقريباً على الواجهة الأمامية له مسار من جانب الخادم يوفر البيانات. بالنسبة لمثال المكون الإضافي هذا، فإننا في الواقع لا نحتاج إلى أي بيانات من الواجهة الخلفية، ولكننا نحتاج إلى إخبار Discourse بتقديم شيء ما في حال زار المستخدم /admin/plugins/purple-tentacle مباشرة. يخبره هذا السطر ببساطة: “مرحباً، إذا زار المستخدم هذا العنوان مباشرةً من جانب الخادم، فقم بتقديم محتوى المكونات الإضافية الافتراضي!”

(إذا كان هذا مربكاً، فلا تقلق كثيراً، سنعود إليه في برنامج تعليمي مستقبلي عندما نتعامل مع الإجراءات من جانب الخادم.)

بعد ذلك، سنضيف قالباً (template) سيتم عرضه عندما يزور المستخدم المسار /admin/plugins/purple-tentacle. سيكون مجرد زر يعرض صورة متحركة (gif) لـ “مخالب أرجوانية” (purple tentacle) عندما ينقر المستخدم على زر:

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

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

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

إذا كنت قد تعلمت أساسيات Handlebars، فيجب أن يكون القالب بسيطاً جداً للفهم. <DButton /> هو مكون في Discourse نستخدمه لعرض زر مع تسمية وأيقونة.

لربط القالب الجديد الخاص بنا، نحتاج إلى إنشاء خريطة مسار (route map):

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

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

خريطة المسار هي شيء أضفناه إلى Discourse للسماح للمكونات الإضافية بإضافة مسارات إلى تطبيق Ember. الصيغة داخل map() مشابهة جداً لـ موجه Ember (Ember’s router). في هذه الحالة، خريطة المسار الخاصة بنا بسيطة جداً، فهي تعلن فقط عن مسار واحد يسمى purple-tentacle تحت /admin/plugins.

أخيراً، لنضف سلاسل الترجمة الخاصة بنا:

config/locales/client.en.yml

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

إذا قمت بإعادة تشغيل خادم التطوير الخاص بك، فيجب أن تكون قادراً على زيارة /admin/plugins وسترى الرابط الخاص بنا! إذا نقرت عليه، فسترى الزر لإظهار “المخالب الأرجوانية” الخاصة بنا:

لسوء الحظ، عندما تنقر على الزر، لا يحدث شيء :frowning:

إذا نظرت إلى وحدة التحكم الخاصة بالمطور (developer console)، يجب أن ترى خطأ يقدم تلميحاً لسبب ذلك:

Uncaught Error: Nothing handled the action 'showTentacle'

آه نعم، السبب يكمن في قالب Handlebars الخاص بنا، حيث نعتمد على أمرين:

  1. أنه عند النقر على الزر من قبل المستخدم، سيتم استدعاء showTentacle.
  2. يجب أن يقوم showTentacle بتعيين الخاصية tentacleVisible إلى true حتى تظهر الصورة.

إذا لم تكن قد قرأت أدلة Ember حول وحدات التحكم (Controllers)، فهذا وقت جيد للقيام بذلك، لأننا سنقوم بتنفيذ وحدة تحكم للمسار 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: أساسيات المكونات الإضافية (Plugin Basics)
الجزء 2: منافذ المكونات الإضافية (Plugin Outlets)
الجزء 3: إعدادات الموقع (Site Settings)
الجزء 4: إعداد git
الجزء 5: هذا الموضوع
الجزء 6: اختبارات القبول (Acceptance tests)
الجزء 7: نشر المكون الإضافي الخاص بك (Publish your plugin)


يتم التحكم في إصدار هذه الوثيقة - اقترح التغييرات على 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.