ثبت یک سرویس در Plesk notifications

تعاریف کلیدی

1. register.php
   یک فایل PHP دلخواه که کد ثبت سرویس در PN در آن قرار می‌گیرد.
2. sw-engine-pleskrun
   دستور مخصوص لینوکس برای اجرای اسکریپت‌های PHP در محیط Plesk.
   مسیر: /usr/local/psa/bin/sw-engine-pleskrun
3. %plesk_bin%\php
   مسیر اجرای PHP در Plesk برای ویندوز.
4. PlanItems table (جدول PlanItems)
   جدولی در دیتابیس Plesk که اطلاعات سرویس‌های ثبت‌شده در PN را نگهداری می‌کند.
5. classname
   نام کلاس PHP که پیاده‌سازی Plan_Item_Interface را دارد (مثل servicedir_servicefile).
6. name
   نام یکتای سرویس (مثل یک شناسه در قالب URN).
7. applicableToEmail / applicableToSite / applicableToSubscription
   تعیین می‌کند سرویس به چه تغییراتی گوش دهد:
   • applicableToEmail → تغییرات اکانت‌های ایمیل
   • applicableToSite → تغییرات سایت‌ها
   • applicableToSubscription → تغییرات اشتراک‌ها
8. uuid
   شناسه یکتای سرویس (یک UUID مثل 219b7656-8e92-869d-828a-6814cda71a1s).

فرض می‌کنیم شما پیاده‌سازی اینترفیس Plan_Item_Interface را آماده کرده‌اید و می‌خواهید سرویس خود را در Plesk Notifications ثبت کنید.

برای انجام ثبت، یک فایل PHP دلخواه (مثلاً register.php) ایجاد کنید و کدی که در ادامه آمده است را در آن قرار دهید. سپس در کد، نام کلاس servicedir_servicefile را با نام کلاس واقعی خود جایگزین کنید.

بعد از آماده‌سازی فایل، آن را با یکی از دستورات زیر اجرا کنید:

• در لینوکس: /usr/local/psa/bin/sw-engine-pleskrun register.php
• در ویندوز: %plesk_bin%\php register.php

نکته: فرض بر این است که Plesk در مسیر پیش‌فرض نصب شده است. اگر مسیر نصب را تغییر داده‌اید، باید آدرس‌ها را متناسب با مسیر جدید اصلاح کنید.

📌 ثبت از طریق دیتابیس (روش جایگزین)

اگر اجرای کد PHP برای شما امکان‌پذیر نیست، می‌توانید سرویس را به صورت مستقیم با اجرای یک دستور SQL در دیتابیس MySQL/MariaDB ثبت کنید.

نمونه دستور:

INSERT INTO PlanItems (
     classname,
     name,
     applicableToEmail,
     uuid
)
VALUES (
     'servicedir_servicefile',
     'urn:isv:custom-item-connector:1',
     1,
     '219b7656-8e92-869d-828a-6814cda71a1s'
);

📌 تعریف پارامترهای دستور بالا

• classname (string)
  نام کلاسی که پیاده‌سازی اینترفیس را شامل می‌شود. (مثلاً servicedir_servicefile).
• name (string)
  نام یکتای سرویس. (مثلاً یک URN: urn:isv:custom-item-connector:1).
• applicableToEmail (boolean, 0 یا 1)
  مشخص می‌کند که سرویس تغییرات حساب‌های ایمیل را دریافت کند یا خیر.
  • مقدار 1 یعنی فعال (گوش دادن به تغییرات ایمیل).
  • همچنین می‌توانید به جای آن از applicableToSite یا applicableToSubscription استفاده کنید تا سرویس تغییرات سایت‌ها یا اشتراک‌ها را دریافت کند.
• uuid (string)
  شناسه یکتای سرویس (یک UUID تصادفی).

📝 توضیحات بیشتر و نکات تکمیلی

1. روش توصیه‌شده
   بهتر است از روش register.php استفاده کنید چون راحت‌تر مدیریت می‌شود و کمتر مستقیماً به دیتابیس دست می‌زند.
2. روش SQL
   روش دیتابیس برای مواقعی است که اجرای کد PHP ممکن نباشد (مثلاً محدودیت دسترسی). اما این روش ریسک بیشتری دارد چون باید مستقیم روی دیتابیس تغییر ایجاد کنید.
3. UUID
   برای تولید UUID می‌توانید از ابزارهای آماده (مثل دستور uuidgen در لینوکس یا سرویس‌های آنلاین) استفاده کنید.
4. به‌روزرسانی و حذف سرویس
   بعد از ثبت سرویس، اگر خواستید تغییر دهید یا حذف کنید، باید رکورد مربوطه در جدول PlanItems را ویرایش یا پاک کنید.
5. دقت در نام کلاس و مسیر فایل
   اگر نام کلاس (classname) یا مسیر فایل در /plib/ درست نباشد، Plesk نمی‌تواند سرویس را شناسایی و اجرا کند.

کیان پور