### ispmanager Specific Examples

Source: https://www.ispmanager.ru/docs/developer-guide/mgrctl

Examples for querying and modifying web domains in ispmanager.

```bash
/usr/local/mgr5/sbin/mgrctl -m ispmgr webdomain  | sed 's/=/ /' | awk '{print $2}'
```

```bash
/usr/local/mgr5/sbin/mgrctl -m ispmgr webdomain  su=<user>  | sed 's/=/ /' | awk '{print $2}'
```

```bash
for i in $(/usr/local/mgr5/sbin/mgrctl -m ispmgr webdomain | awk '{print $1}' | awk -F = '{print $2}'); do /usr/local/mgr5/sbin/mgrctl -m ispmgr domain.fix elid=$i; done
```

```bash
for i in $(/usr/local/mgr5/sbin/mgrctl -m ispmgr webdomain | awk '{print $1}' | awk -F = '{print $2}'); do /usr/local/mgr5/sbin/mgrctl -m ispmgr webdomain.edit php=off elid=$i sok=ok; done
```

--------------------------------

### Example: Passing a Password via Environment Variable

Source: https://www.ispmanager.ru/docs/developer-guide/mgrctl

Demonstrates setting an environment variable and using it within an mgrctl command.

```bash
export SECRET_PASSWORD=secret
```

```bash
/usr/local/mgr5/sbin/mgrctl -m ispmgr ftp.user.edit name=ftpuser home=/ owner=www-root -e 'passwd=$SECRET_PASSWORD' sok=ok
```

--------------------------------

### Define a Toolbar Block

Source: https://www.ispmanager.ru/docs/developer-guide/dashboadr-desc

Example of an XML block definition for a toolbar containing quick-access buttons.

```xml
<block name="taskbar" position="top" type="toolbar">
  <toolbtn form="site.edit" img="d-site" name="addwebdomain" spritesvg="yes"/>
  <toolbtn form="wordpress.theme" img="d-wordpress" name="addwordpressdomain" spritesvg="yes"/>
  <toolbtn window="dashboard.phpmyadmin" img="d-phpmyadmin" name="phpmyadmin" spritesvg="yes"/>
</block>
```

--------------------------------

### General mgrctl Usage Examples

Source: https://www.ispmanager.ru/docs/developer-guide/mgrctl

Common administrative tasks for managing control panel states and inspecting functions.

```bash
/usr/local/mgr5/sbin/mgrctl -m <manager> exit
```

```bash
/usr/local/mgr5/sbin/mgrctl -m <manager> -i
```

```bash
/usr/local/mgr5/sbin/mgrctl -m <manager> -i funcname lang=ru
```

--------------------------------

### Define form buttons in XML

Source: https://www.ispmanager.ru/docs/developer-guide/form-desc

Example showing the structure of the buttons section within a form, including various button types like back, ok, cancel, next, reset, blank, and setvalues.

```xml
<form ...>
  <buttons>
    <button name="back" type="back"/>
    <button name="ok" type="ok"/>
    <button name="cancel" type="cancel"/>
    <button name="next" type="next"/>
    <button name="reset" type="reset"/>
    <button name="blank" type="blank"/>
    <button name="setvalues" type="setvalues"/>
  </buttons>
</form>
```

--------------------------------

### XML Error Structure Example

Source: https://www.ispmanager.ru/docs/developer-guide/errors

Example of the XML document structure used to describe an exception in COREmanager.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<doc>
  <error type="xml" object="xpath" report="yes" lang="ru">
    <param name="object" type="msg" msg="Ошибка в XPath '__value__'">xpath</param>
    <param name="value">bad XPath</param>
    <stack>
      <action level="30" user="root">xmlerror</action>
    </stack>
    <group>Возникла ошибка при работе с XML документом. __object__</group>
    <msg>Возникла ошибка при работе с XML документом. Ошибка в XPath 'bad XPath'</msg>
  </error>
</doc>
```

--------------------------------

### Создание XML-конфигурации модуля

Source: https://www.ispmanager.ru/docs/developer-guide/add-modules

Пример структуры файла exampleplugin.xml, определяющего основные параметры модуля, такие как вес, лицензия и локализованные описания.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<mgrdata>
  <plugin name="exampleplugin">
   	<dist>1</dist>
	<weight>1</weight>
   	<pricelist>12345</pricelist>
   	<license>ExampleLicense</license>
<free/>
	<settings>exampleplugin.settings</settings>
	<msg name="desc_short" lang="ru">Модуль Example</msg>
	<msg name="desc_short" lang="en">Module Example</msg>
	<msg name="desc_full" lang="ru">Пример добавления модуля в ispmanager</msg>
	<msg name="desc_full" lang="en">Example of adding custom module to ispmanager</msg>
	<msg name="msg_help_links" dist="1" lang="ru">&lt;a href="http://example.com" target="_blank"&gt;Описание ссылки для версий Lite, Pro, Host&lt;/a&gt;</msg>
	<msg name="msg_help_links" dist="3" lang="ru">&lt;a href="https://rudocs.ispmanager.com/ispmanager-business/integratsiya-c-viruslive" target="_blank"&gt;Описание ссылки для версии Business&lt;/a&gt;</msg>
	<msg name="msg_help_links" dist="1" lang="en">&lt;a href="http://example.com" target="_blank"&gt;Link description for Lite, Pro, Host versions&lt;/a&gt;</msg>
	<msg name="msg_help_links" dist="3" lang="en">&lt;a href="http://example.com" target="_blank"&gt;Link description for Business version&lt;/a&gt;</msg>
  </plugin>
</mgrdata>
```

--------------------------------

### Define a Dashboard Block

Source: https://www.ispmanager.ru/docs/developer-guide/dashboadr-desc

Example of an XML block definition for a list-type dashboard element.

```xml
<block name="authlog" position="right" type="list" func="authlog" rows="5" enable_autoupdate="yes" prev="" display="">
  <toolbtn name="gotodetails" func="authlog" type="list"/>
  <col name="time" sort="alpha" sorted="-1"/>
  <col name="user" sort="alpha" sorted="+2"/>
  <col name="ip" sort="alpha"/>
</block>
```

--------------------------------

### Пример конфигурационного файла дополнительного поля

Source: https://www.ispmanager.ru/docs/developer-guide/add-custom-field

Файл должен быть размещен в каталоге /usr/local/mgr5/etc/sql/ispmgr.{имя_таблицы}.addon или /usr/local/mgr5/etc/sql/{имя_таблицы}.addon. Имя файла соответствует имени создаваемого поля.

```text
type=string
size=40
access_read= registered
access_write=admin+
default=0.0.0.0
```

--------------------------------

### Применение изменений в базе данных

Source: https://www.ispmanager.ru/docs/developer-guide/add-custom-field

После создания или изменения файлов конфигурации необходимо очистить кэш и перезапустить процесс панели.

```bash
rm -rf /usr/local/mgr5/var/.db.cache*
pkill core
```

--------------------------------

### Bash-обработчик плагина

Source: https://www.ispmanager.ru/docs/developer-guide/plugins-api-db

Скрипт, который запрашивает список баз данных через mgrctl, форматирует вывод с помощью sed и возвращает XML-форму для отображения в интерфейсе.

```bash
#!/bin/bash
dblines=$(/usr/local/mgr5/sbin/mgrctl -m ispmgr db su=${AUTH_USER})
dbshtml=$(sed -rn "s/.*pair\=[a-zA-Z_]+->([^ ]+).*name\=([a-zA-Z_]+).*\
/<b>\2<\/b> (\1)<br>/p" <<<  "$dblines")
cat << EOM
<?xml version="1.0" encoding="UTF-8"?>
<doc lang="ru" func="database_list">
    <metadata type="form">
        <form>
            <field name="dblist_field">
                <textdata name="dblist" type="msg" />
            </field>
        </form>
    </metadata>
    <messages>
        <msg name="title">Cписок баз данных</msg>
        <msg name="dblist"><![CDATA[${dbshtml}]]></msg>
    </messages>
</doc>
EOM
```

--------------------------------

### GET MGR_URL?func=[func]&dashboard=[name]

Source: https://www.ispmanager.ru/docs/developer-guide/dashboadr-desc

Retrieves data for a specific dashboard block by providing the function and dashboard name as query parameters.

```APIDOC
## GET MGR_URL?func=[func]&dashboard=[name]

### Description
Retrieves the data required to render a specific dashboard block. The function and block name are determined by the attributes of the block element.

### Method
GET

### Endpoint
MGR_URL

### Parameters
#### Query Parameters
- **func** (string) - Required - The function identifier for the dashboard block.
- **dashboard** (string) - Required - The name identifier for the dashboard block.
```

--------------------------------

### Содержимое обработчика

Source: https://www.ispmanager.ru/docs/developer-guide/add-custom-menu

Пример кода для файла myaddon.sh.

```bash
#!/bin/bash 
cat /usr/local/mgr5/addon/myaddon.xml
```

--------------------------------

### Обработчик плагина на Bash

Source: https://www.ispmanager.ru/docs/developer-guide/plugins-example-use-fields

Скрипт формирует XML-структуру формы для ввода данных или отображения сообщения в зависимости от состояния переменной PARAM_name.

```bash
#!/bin/bash
name=$PARAM_name
if [ -z "$name" ]
then
    read -r -d '' formfields <<-EOM
    <field name="name">
        <input name="name" type="text" />
    </field>
EOM
    read -r -d '' formbuttons <<- EOM
    <buttons>
        <button type="ok" action="helloworld" name="ok"/>
    </buttons>
EOM
else
    read -r -d '' formfields <<- EOM
    <field name="helloworld_field">
        <textdata name="helloworld_message" type="msg" />
    </field>
EOM
fi
cat << EOM
<?xml version="1.0" encoding="UTF-8"?>
<doc lang="ru" func="helloworld">
    <metadata type="form">
        <form>
            ${formfields}
            ${formbuttons}
        </form>
    </metadata>
    <messages>
        <msg name="title">Плагин Hello, world!</msg>
        <msg name="name">Введите ваше имя</msg>
        <msg name="helloworld_message">Hello, ${name}!</msg>
        <msg name="msg_ok">OK</msg>
    </messages>
</doc>
EOM
```

--------------------------------

### Создание файла конфигурации меню

Source: https://www.ispmanager.ru/docs/developer-guide/add-custom-menu

Команда для создания пустого XML-файла в системной директории ISPmanager с необходимыми правами доступа.

```bash
touch /usr/local/mgr5/etc/xml/ispmgr_mod_menu.xml
```

--------------------------------

### Пример XML-описания главной страницы

Source: https://www.ispmanager.ru/docs/developer-guide/dashboadr-desc

Используйте этот шаблон для настройки блоков, инструментов и локализованных сообщений на главной странице. Убедитесь, что атрибуты func и name соответствуют доступным функциям панели.

```xml
<?xml version="1.0"?>
<doc lang="ru" func="dashboard" binary="/ispmgr" host="https://localhost:4200" themename="dragon" stylesheet="dashboard" features="3a604f5c3c6d5683f90a1f63f1d171aa0" notify="0" favorite="no" pin="no">
  <block name="license.mgr.info" position="right" type="isplicense" func="license.mgr.info" display="" prev=""/>
  <block name="capacity" position="right" type="list" func="server_capacity" enable_autoupdate="yes" prev="" display=""/>
  <block name="session" position="right" type="list" func="session" rows="5" enable_autoupdate="yes" prev="" display="">
    <toolbtn name="gotodetails" func="session" type="list"/>
    <toolbtn name="kill"/>
    <col name="name" sort="alpha" sorted="+1"/>
    <col name="level"/>
    <col name="ip"/>
    <col name="idle"/>
  </block>
  <block name="longtask" position="right" type="list" func="longtask" rows="5" enable_autoupdate="yes" prev="" display="">
    <toolbtn name="gotodetails" func="longtask" type="list"/>
    <toolbtn name="view" default="yes"/>
    <toolbtn name="delete"/>
    <col name="realname" type="data" sort="alpha"/>
    <col name="startdate" type="data" sort="alpha" sorted="-1"/>
    <col name="enddate" type="data" sort="alpha"/>
    <col name="state" sort="prop"/>
  </block>
  <block name="authlog" position="right" type="list" func="authlog" rows="5" enable_autoupdate="yes" prev="" display="">
    <toolbtn name="gotodetails" func="authlog" type="list"/>
    <col name="time" sort="alpha" sorted="-1"/>
    <col name="user" sort="alpha" sorted="+2"/>
    <col name="ip" sort="alpha"/>
  </block>
  <block name="taskbar" position="left" type="toolbar" display="" prev=""/>
  <block name="sysinfo" position="left" type="list" func="dashboard.sysinfo" enable_autoupdate="yes" prev="" display="">
    <toolbtn name="gotodetails" func="sysinfo" type="list"/>
  </block>
  <block name="software_info" position="left" type="software" func="dashboard.software" prev="" display="">
    <toolbtn name="gotodetails" func="feature" type="list"/>
  </block>
  <block name="changelog.changes" position="left" type="changelog" func="changelog.changes" rows="5" prev="" display="">
    <toolbtn name="gotodetails" func="changelog" type="list"/>
    <col name="desc" sorted="+1"/>
    <col name="type"/>
  </block>
  <block name="new_features" position="top" type="url" display="" prev="">
    <url>https://www.ispmanager.ru/sites/all/themes/custom/ispmanagertheme/ispmanageradv/ru6/?mgrurl=https://localhost:4200/ispmgr</url>
  </block>
  <messages name="dashboard" checked="3a604f5c3c6d5683f90a1f63f1d171aa">
    <msg name="actioncolumn">Действие</msg>
    <msg name="taskbar_admin">Администратор панели</msg>
    <msg name="taskbar_help">Помощь</msg>
    <msg name="taskbar_usrparam">Настройки пользователя</msg>
    <msg name="title">Главная</msg>
    <msg name="title_changelog.changes">Список изменений текущей версии 6.84.0</msg>
    <msg name="title_usageinfo">Использование времени</msg>
    <msg name="title_taskbar">Панель задач</msg>
    <msg name="hint_reload">Обновить данные</msg>
    <msg name="tip_dashboard_top">Вы можете создать администратора панели и перейти в него в одно нажатие (большинство задач по администрированию решается на уровне ее администратора)</msg>
    <msg name="title_new_features">Новые возможности</msg>
    <msg name="taskbar_adduser">Создать пользователя</msg>
    <msg name="taskbar_addwebdomain">Создать сайт</msg>
    <msg name="taskbar_addemail">Создать почтовый ящик</msg>
    <msg name="taskbar_adddomain">Создать домен</msg>
    <msg name="taskbar_shellclient">Запустить Shell-клиент</msg>
    <msg name="taskbar_addsorter">Настроить сортировщик</msg>
    <msg name="taskbar_responder_settings">Настроить автоответчик</msg>
    <msg name="taskbar_phpmyadmin">Открыть phpMyAdmin</msg>
    <msg name="taskbar_phppgadmin">Открыть phpPgAdmin</msg>
    <msg name="taskbar_roundcube">Открыть почтовый клиент</msg>
    <msg name="taskbar_adddatabase">Создать базу данных</msg>
    <msg name="taskbar_addemaildomain">Создать почтовый домен</msg>
    <msg name="taskbar_adddocker">Создать Docker контейнер</msg>
    <msg name="taskbar_addcron">Создать задание в Cron</msg>
    <msg name="taskbar_addbackup">Создать резервную копию</msg>
    <msg name="taskbar_addftp_user">Создать FTP-пользователя</msg>
    <msg name="taskbar_execute">Выполнить команду</msg>
    <msg name="taskbar_restart">Перезагрузить сервер</msg>
    <msg name="taskbar_update">Обновить панель</msg>
    <msg name="title_license.mgr.info">О панели ispmanager Trial</msg>
    <msg name="title_capacity">Ресурсы сервера</msg>
    <msg name="title_session">Активные сессии</msg>
```

--------------------------------

### Настройка отчета через элемент <action>

Source: https://www.ispmanager.ru/docs/developer-guide/report-desc

Используйте этот метод для отображения данных из существующих списков системы. Элемент <action> указывает на функцию, которая будет источником данных для отчета.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<mgrdata>
    <!-- добавляем в главное меню новую группу и новый пункт -->
    <mainmenu level="admin+">
        <modernmenu>
            <node name="reports">
                <node name="emaildomain_report" />
            </node>
        </modernmenu>
    </mainmenu>
    <!-- метаданные отчета -->
    <metadata name="emaildomain_report" type="report" level="admin+">
        <band name="emaildomain" psort="name">
            <action>emaildomain?filter=on&amp;active=on</action>
            <col name="name" type="data"/>
            <col name="owner" type="data"/>
        </band>
    </metadata>
    <lang name="ru">
        <!-- сообщения локализации для главного меню -->
        <messages name="desktop">
            <!-- название группы в modern_menu-->
            <msg name="modernmenu_reports">Отчеты</msg>
            <!-- название пункта меню -->
            <msg name="modernmenu_emaildomain_report">Почтовые домены</msg>
        </messages>
        <!-- сообщения локализации для страницы отчета -->
        <messages name="emaildomain_report">
            <msg name="msg_hidedata">Скрыть данные</msg>
            <msg name="msg_nodata">Нет данных</msg>
            <msg name="msg_showdata">Показать данные</msg>
            <msg name="name">Домен</msg>
            <msg name="owner">Владелец</msg>
            <msg name="email_cnt">Количество почтовых ящиков</msg>
            <msg name="report_info">Статистика почтовых доменов</msg>
            <msg name="title">Отчёт: Почтовые домены</msg>
        </messages>
    </lang>
</mgrdata>
```

--------------------------------

### Получение XML-описания существующей формы

Source: https://www.ispmanager.ru/docs/developer-guide/xml-form-description

Используйте утилиту mgrctl с флагом -o devel для генерации XML-структуры существующей страницы.

```bash
/usr/local/mgr5/sbin/mgrctl -m ispmgr webdomain.edit -o devel
```

--------------------------------

### Мониторинг запросов в логах панели

Source: https://www.ispmanager.ru/docs/developer-guide/functions-and-params

Отслеживайте HTTP-запросы в реальном времени для понимания структуры параметров, выполняя действия через веб-интерфейс.

```bash
tail -f /usr/local/mgr5/var/ispmgr.log |grep "INFO Request"
```

--------------------------------

### XML-описание плагина ispmanager

Source: https://www.ispmanager.ru/docs/developer-guide/first-plugin

Файл конфигурации плагина, определяющий пункты меню, обработчики и локализацию. Должен быть сохранен с именем ispmgr_mod_*.xml в папке /usr/local/mgr5/etc/xml.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<!-- тэг mgrdata всегда должен быть на верхнем уровне любого плагина -->
<mgrdata>
    <!-- секция, добавляющая группы и пункты в меню -->
    <mainmenu level="30">
        <!-- в современных версиях ispmanager главное меню описывается 
             в тэге modernmenu внутри тэга mainmenu -->
        <modernmenu>
            <!-- в ispmanager двухуровневое меню - группы, внутри которых 
                 пункты - ссылки на страницы, и для тех, и для других 
                 используется тэг node; если мы хотим создать 
                 пункт меню без группы, нужно на уровне группы добавить
                 атрибут type="noname" -->
            <node name="helloworld_group" type="noname">
                <!-- тэг node второго уровня задает конкретный пункт меню,
                     атрибут name используется как func для страницы при
                     задании обработчика, а также для задания строки 
                     локализации в тэге msg ниже. Атрибут favorite="yes"
                     нужен, чтобы пункт меню появился в левом меню, а не
                     только на странице "Все разделы" -->
                <node name="helloworld" favorite="yes" />
            </node>
        </modernmenu>
    </mainmenu>
    
    <!-- тэг handler задает обработчик, имя файла обработчика - 
         в атрибуте name -->
    <handler name="helloworld.sh" type="xml">
        <!-- тэг func внутри тэга handler определяет, какие вызовы
             (например, страницы) будут обрабатываться данным обработчиком -->
        <func name="helloworld" />
    </handler>
    
    <!-- тэг lang задает секцию сообщений локализации для одного языка,
         внутри него могут содержаться сообщения локализации для многих страниц -->
    <lang name="ru">
        <!-- тэг messages задает секцию сообщений локализации для одного func 
             или, в данном случае - для навигационных элементов, общих для всех
             страниц (name="desktop") -->
        <messages name="desktop">
            <!-- тэг msg задает строку локализации с единственным 
                 атрибутом-идентификатором name. В данном случае префикс
                 modernmenu_ указывает, что мы задаем локализацию для
                 пункта меню с именем, указанным после префикса -->
            <msg name="modernmenu_helloworld">Плагин Hello, World</msg>
        </messages>
    </lang>
</mgrdata>
```

--------------------------------

### Отправка уведомления пользователю через mgrctl

Source: https://www.ispmanager.ru/docs/developer-guide/czentr-uvedomlenij

Используйте команду notify.post для отправки текстового уведомления конкретному пользователю с указанием уровня важности.

```bash
/usr/local/mgr5/sbin/mgrctl -m notify notify.post user=root msg="Привет, мир!" level=danger
```

--------------------------------

### Получение списка функций и параметров через mgrctl

Source: https://www.ispmanager.ru/docs/developer-guide/functions-and-params

Используйте утилиту mgrctl с ключом -i для получения актуальной информации о доступных функциях и параметрах в текущей инсталляции.

```bash
/usr/local/mgr5/sbin/mgrctl -m ispmgr -i 
```

```bash
/usr/local/mgr5/sbin/mgrctl -m ispmgr -i user lang=ru
```

--------------------------------

### mgrctl Syntax

Source: https://www.ispmanager.ru/docs/developer-guide/mgrctl

The base command structure for invoking control panel functions.

```bash
/usr/local/mgr5/sbin/mgrctl [-m <manager>] [-u | -i [lang=<language>] | -l | [[-o <output format>] [-R | <funcname> [[<param>=<value>] ...]] [[-e ‘<param>=$<ENV_NAME>’] ...]]]
```

--------------------------------

### Обработчик на Bash

Source: https://www.ispmanager.ru/docs/developer-guide/add-checkbox

Скрипт, который считывает состояние чекбокса и изменяет XML-ответ панели для обновления домашней директории.

```bash
# cat /usr/local/mgr5/addon/dir 
#!/bin/bash
if [ "$PARAM_cms" = "on" ] 
then 
    echo $(cat | sed 's/<\/doc>/<home>www\/pub<\/home><\/doc>/g')
else 
    cat 
fi
```

--------------------------------

### Define Modern Navigation Menu Structure

Source: https://www.ispmanager.ru/docs/developer-guide/xml-form-description

Defines the navigation menu structure for ispmanager Lite, Pro, and Host using the <modernmenu> wrapper.

```xml
<mainmenu>
    <modernmenu>
        <node name="имя_группы">
            <node name="имя_пункта_меню" favorite="yes"/>
        </node>
    </modernmenu>
</mainmenu>
```

--------------------------------

### Пример структуры contextmenu в metadata

Source: https://www.ispmanager.ru/docs/developer-guide/list-desc

Демонстрация иерархии элементов contextmenu, toolgrp и toolbtn для определения действий в контекстном меню.

```xml
<metadata>
  <toolbar> <!-- ... --> </toolbar>
  <coldata> <!-- ... --> </coldata>
  <contextmenu>
    <toolgrp name="go">
      <toolbtn name="go" func="webdomain.go" type="window" img="t-insert" sprite="yes" spritesvg="yes"/>
      <toolbtn name="go_db" func="site.db.redirect" type="window" img="t-insert" sprite="yes" spritesvg="yes">
        <hide name="database" value="Not used"/>
      </toolbtn>
    </toolgrp>
    <toolgrp name="edit">
      <toolbtn name="edit" func="site.edit" type="edit" img="t-edit" default="yes" sprite="yes" spritesvg="yes"/>
      <toolbtn name="php" func="phpconf" type="editlist" img="t-editlist" sprite="yes" spritesvg="yes">
        <show name="php_mode" value="FastCGI (Nginx + PHP-FPM)"/>
        <show name="cgi_site_settings" value="on"/>
        <show name="php_mode" value="Apache"/>
      </toolbtn>
    </toolgrp>
  </contextmenu>
</metadata>
```

--------------------------------

### Установка прав доступа к обработчику

Source: https://www.ispmanager.ru/docs/developer-guide/first-plugin

Команда для установки прав 750 на файл обработчика, необходимых для его корректного выполнения.

```bash
chmod 750 /usr/local/mgr5/addon/helloworld.sh
```

--------------------------------

### Структура XML ответа прогресса

Source: https://www.ispmanager.ru/docs/developer-guide/progress

Пример XML-ответа, возвращаемого функцией progress.get, содержащего информацию о текущем шаге, общем количестве шагов и комментарий к операции.

```xml
<doc ...>
  <action>product.install</action>
  <start>1376013950</start>
  <last>1376013971</last>
  <now>1376013974</now>
  <steps>6</steps>
  <done>4</done>
  <comment>Выполняю кэширование доступных пакетов</comment>
  <tparams>
    ...
  </tparams>
</doc>
```

--------------------------------

### Код Bash-скрипта обработчика

Source: https://www.ispmanager.ru/docs/developer-guide/first-plugin

Пример содержимого файла обработчика, который выводит XML-описание формы плагина.

```bash
#!/bin/bash
cat << EOM
<?xml version="1.0" encoding="UTF-8"?>
<doc lang="ru" func="helloworld">
    <metadata type="form">
        <form>
            <field name="helloworld_field">
                <textdata name="helloworld_message" type="msg" /> 
            </field>
        </form>
    </metadata>
    <messages>
        <msg name="title">Плагин Hello, world!</msg>
        <msg name="helloworld_message">Hello, world!</msg>
    </messages>
</doc>
EOM
```

--------------------------------

### Создание файла обработчика

Source: https://www.ispmanager.ru/docs/developer-guide/add-custom-menu

Команда для создания исполняемого файла обработчика.

```bash
touch myaddon.sh
```

--------------------------------

### Установка прав доступа

Source: https://www.ispmanager.ru/docs/developer-guide/iframe

Команда для установки прав исполнения на файл обработчика.

```bash
chmod 755 testframe.sh
```

--------------------------------

### Настройка прав доступа

Source: https://www.ispmanager.ru/docs/developer-guide/add-checkbox

Команды для установки прав доступа к файлу обработчика.

```bash
chmod 750 /usr/local/mgr5/addon/<имя_файла_обработчика>
chown 0:0 /usr/local/mgr5/addon/<имя_файла_обработчика>
```

--------------------------------

### Структура XML-плагина

Source: https://www.ispmanager.ru/docs/developer-guide/add-custom-menu

Пример содержимого файла myaddon.xml для отображения данных в интерфейсе.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<doc lang="ru" func="myfunc" binary="/ispmgr">
        <metadata name="myfunc" type="list" key="name" mgr="ispmgr">
                <toolbar view="buttontext">
                        <toolgrp name="new">
                                <toolbtn name="new" func="webdomain.edit" type="new" img="t-new" sprite="yes"/>
                                <toolbtn name="delete" func="webdomain.delete" type="group" img="t-delete" sprite="yes"/>ls 
                        </toolgrp>
                </toolbar>

                <coldata>
                        <col type="data" name="name" sort="alpha" convert="punycode" sorted="-1"/>
                        <col type="data" name="value" sort="alpha" level="reseller+"/>
                </coldata>
        </metadata>
        <messages name="myfunc" checked="6b49a92f5cc5153c76b78446d0d74eb4">
                <msg name="title">Test</msg>
                <msg name="hint_name"> Название </msg>
                <msg name="hint_value">Значение</msg>
                <msg name="short_new" added="common">Создать</msg>
                <msg name="short_delete" added="common">Удалить</msg>
                <msg name="hint_delete" added="common">Удалить</msg>
                <msg name="hint_new" added="common">Создать</msg>
                <msg name="name" added="common">Имя</msg>
                <msg name="value" added="common">Значение</msg>
                <msg name="hint_export">Сохранить в CSV</msg>
                <msg name="hint_selectall">Выделить все элементы списка</msg>
                <msg name="hint_reloadlist">Обновить данные</msg>
                <msg name="hint_print">Открыть версию для печати</msg>
                <msg name="hint_autoupdate_stop">Отменить автообновление текущего списка</msg>
                <msg name="hint_takefavorite">Добавить в избранное меню</msg>
                <msg name="hint_takeunfavorite">Убрать из избранного меню</msg>
                <msg name="msg_tsetting">Настроить вид таблицы</msg>
        </messages>

        <tparams>
                <out>devel</out>
                <func>myfunc</func>
        </tparams>
        <p_sort>name</p_sort>
        <p_order>desc</p_order>
        <page>test.ru — domain.mary</page>
        <elem>
                <name>One</name>
                <value>Hello</value>
        </elem>
        <elem>
                <name>Two</name>
                <value>World!</value>
        </elem>
        <p_num>1</p_num>
        <p_elems>6</p_elems>
</doc>
```

--------------------------------

### Определение URL для фрейма в теге <doc>

Source: https://www.ispmanager.ru/docs/developer-guide/iframe

URL страницы, отображаемой во фрейме, указывается внутри тега <doc> с использованием имени, соответствующего атрибуту name тега <frame>.

```xml
https://ip-адрес:1501/roundcube/?_task=mail&amp;_mbox=INBOX</roundcubeframe>
```

--------------------------------

### Копирование файлов для перевода

Source: https://www.ispmanager.ru/docs/developer-guide/kak-dobavit-novyj-yazyk-v-panel-upravleniya

Используйте существующие английские файлы сообщений в качестве основы для создания файлов перевода на новый язык.

```bash
cp /usr/local/mgr5/etc/xml/ispmgr_msg_en.xml /usr/local/mgr5/etc/xml/ispmgr_msg_sv.xml
cp /usr/local/mgr5/etc/xml/core_msg_en.xml /usr/local/mgr5/etc/xml/core_msg_sv.xml
```

--------------------------------

### Define dashboard software block data in XML

Source: https://www.ispmanager.ru/docs/developer-guide/dashboadr-desc

Structure for defining metadata, localization messages, and data rows for a software dashboard block.

```xml
<doc lang="ru" func="dashboard.software">
  <metadata name="dashboard.software" type="infolist" mgr="ispmgr" dashboard="yes">
    <rowdata>
      <rowgroup name="soft">
        <row name="apache_version" type="data"/>
        <row name="mysql_version" type="data"/>
        <row name="php_version" type="data"/>
        <row name="kernel_version" type="data"/>
      </rowgroup>
    </rowdata>
  </metadata>
  <messages name="dashboard.software" checked="a5b30e8b989f395a98cadceb52f96ff9">
    <msg name="title">Программное обеспечение сервера</msg>
    <msg name="soft">Версии программного обеспечения</msg>
    <msg name="apache_version">Apache</msg>
    <msg name="mysql_version">MySQL</msg>
    <msg name="php_version">PHP</msg>
    <msg name="phpcgi_version">PHP (CGI)</msg>
    <msg name="perl_version">Perl</msg>
    <msg name="kernel_version">Kernel</msg>
    <msg name="short_gotodetails">Перейти в раздел</msg>
    <msg name="actioncolumn">Действие</msg>
  </messages>
  <elem>
    <apache_version>2.4.41-4ubuntu3.23</apache_version>
  </elem>
  <elem>
    <kernel_version>5.4.0-208-generic </kernel_version>
  </elem>
  <elem>
    <mysql_version>8.0.42-0ubuntu0.20.04.1</mysql_version>
  </elem>
  <elem>
    <php_version>7.4.3-4ubuntu2.29</php_version>
  </elem>
</doc>
```

--------------------------------

### Define Report Queries and Column Mapping

Source: https://www.ispmanager.ru/docs/developer-guide/report-desc

Use the <query> element to fetch data, employing [[value]] for user input or parent table IDs. Ensure column aliases in the SQL match the 'name' attributes of the corresponding <col> elements.

```xml
  .....
  <form>
    <!-- получаем от пользователя значение ip-адреса, по которому нужно вывести отчет -->
    <field name="ip">
      <input name="ip" type="text"/>
    </field>
  </form>
  <band name="emaildomain">
    <!-- запрос к БД ispmanager с использованием введенного значения ip-адреса, используются псевдонимы -->
    <query>SELECT emaildomain.id AS id, emaildomain.name AS name, emaildomain.ip AS ip as email_cnt FROM emaildomain WHERE ip=[[ip]]</query>
    <!-- в атрибут name элемента <col> передается псевдоним из запроса выше -->
    <col name="name" type="data" link="yes"/>
    <col name="ip" type="data"/>
    <band name="email" psort="used">
      <!-- запрос для дочерних таблиц с использованием id домена, для которого строится таблица -->
      <query>SELECT name AS emailname, used FROM email WHERE domain=[[emaildomain.id]]</query>
      <col name="emailname" type="data"/>
      <col name="used" type="data"/>
    </band>
  </band>
  .....
```

--------------------------------

### Define Localization Strings

Source: https://www.ispmanager.ru/docs/developer-guide/xml-form-description

Configures localized UI strings for specific languages and functions using the <lang> and <messages> elements.

```xml
<lang name="ru">
    <messages name="desktop">
        <msg name="modernmenu_writetosupport">Отправка сообщения в поддержку</msg>
    </messages>
    <messages name="writetosupport">
        <msg name="messagetext">Введите текст:</msg>
        <msg name="msg_send">Отправить</msg>
        <msg name="title">Отправка сообщения в поддержку</msg>
    </messages>
</lang>
```

--------------------------------

### Запуск обработчика из командной строки

Source: https://www.ispmanager.ru/docs/developer-guide/handler

Прямой вызов исполняемого файла обработчика для проверки его работы.

```bash
/usr/local/mgr5/addon/helloworld.sh
```

--------------------------------

### Создание файла метаданных

Source: https://www.ispmanager.ru/docs/developer-guide/add-custom-menu

Команда для создания файла конфигурации плагина.

```bash
touch myaddon.xml
```

--------------------------------

### Provide data for a list element

Source: https://www.ispmanager.ru/docs/developer-guide/form-desc

Structure for populating the list component with data elements, including buttons for row actions.

```xml
<list name="list">
  <elem>
    <id>2</id>
    <image>/manimg/common/img/mb-sysstat.png</image>
    <desc>ЖК Монитор 17''</desc>
    <price>1238.00 RUB</price>
    <action>
      <button name="edit" type="setvalues"/>
      <button name="delete" type="setvalues"/>
    </action>
  </elem>
</list>
```

--------------------------------

### Configure Slider Element

Source: https://www.ispmanager.ru/docs/developer-guide/form-desc

Create a slider for numeric range selection, where min and max constraints can be overridden by the data tag.

```xml
<metadata name="test" type="form">
  <form>
    <field name="field">
      <slider name="sl_field" min="0" max="100"/>
    </field>
  </form>
</metadata>

<sl_field min="10" max="20">15</sl_field>
```

--------------------------------

### Определение структуры меню в XML

Source: https://www.ispmanager.ru/docs/developer-guide/add-custom-menu

Пример XML-конфигурации для регистрации нового пункта меню, привязки обработчика функции и настройки локализованных названий.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<mgrdata>
        <mainmenu level="admin+">
                <modernmenu>
                        <node name="my_group">
                                <node name="myfunc" favorite="yes" />
                        </node>
                </modernmenu>
        </mainmenu>

        <handler name="myaddon.sh" type="xml">
                <func name="myfunc" />
        </handler>

        <lang name="ru">
                <messages name="desktop">
                        <msg name="modernmenu_my_group">New menu item</msg>
                        <msg name="modernmenu_myfunc">Test</msg>
                </messages>
        </lang>
</mgrdata>
```

--------------------------------

### XML описание плагина

Source: https://www.ispmanager.ru/docs/developer-guide/add-checkbox

Определяет обработчик события webdomain.edit и добавляет поле типа checkbox в форму редактирования.

```xml
# cat /usr/local/mgr5/etc/xml/ispmgr_mod_example.xml 
<?xml version="1.0" encoding="UTF-8"?>
<mgrdata>
   <handler name="dir" type="xml"> // dir — имя обработчика, который будет вызываться.Тип указываем xml
         <event name="webdomain.edit" after="yes"/> 
// так как нам нужен плагин на редактирование веб домена, соответственно в event name указываем функцию webdomain.edit
// для того, чтобы плагин отрабатывал после изменения формы, ставим тип after, а не before
   </handler>
<metadata name="webdomain.edit" type="form">
   <form>
      <page name="features">
        <field name="cms" experience="expert">
           <input type="checkbox" name="cms" setvalues="yes"> // для checkbox ставим setvalues="yes" для того, чтобы плагин срабатывал сразу при изменении значения checkbox'a
           </input>
        </field>
      </page>
   </form>
</metadata>
<lang name="ru">
   <messages name="webdomain.edit">
      <msg name="cms">Example</msg> // Указываем название checkbox'a
      <msg name="hint_cms">This is an example</msg> // Подсказка
   </messages>
</lang>
</mgrdata>
```

--------------------------------

### Настройка Content-Security-Policy в Apache

Source: https://www.ispmanager.ru/docs/developer-guide/iframe

Используйте модуль mod_headers для установки политики безопасности в конфигурации Apache или .htaccess.

```apache
<IfModule mod_headers.c>
    Header set Content-Security-Policy "frame-ancestors 172.31.97.115:1500"
</IfModule>
```

--------------------------------

### Define Resource Limit Field

Source: https://www.ispmanager.ru/docs/developer-guide/system-architecture

Use an empty string as a placeholder to represent unlimited resources, while reserving zero for explicit restriction. Ensure the validator handles minimum values to prevent user confusion.

```xml
 <field name="domainlimit">
     <input type="text" name="domainlimit" check="int" unlimit="" checkargs="0,"/>
 </field>
 ...
 <msg name="placeholder_domainlimit">не ограничено</msg>
```

--------------------------------

### Конфигурация иконки в XML

Source: https://www.ispmanager.ru/docs/developer-guide/add-custom-icon

Пример записи в файле ispmgr_mod_menu.xml для назначения иконки пункту меню.

```xml
<node name="testmenuitem" customicon="/manimg/icons/googlechrome.svg" />
```