[LiveStreet] Администрирование сайта через веб-интерфейс (Admin config)

Складчина: [LiveStreet] Администрирование сайта через веб-интерфейс (Admin config)

Плагин для CMS LiveStreet «Администрирование конфигов через веб-интерфейс (Admin config)»


​

О плагине: Плагин парсит конфиги (главный конфиг движка и конфиги плагинов) и дает все возможности по их редактированию: для каждого плагина доступна страница на которой находится полный список параметров редактируемого плагина вместе с описанием каждого параметра, который был задан в конфиге как комментарий.

Спойлер: Подробнее

Зачем это нужно?
Вам больше не нужно будет заходить по фтп на сайт, редактировать вручную код конфига чтобы изменить рейтинг топика для попадания на главную, поменять настройки ACL или отредактировать любые другие параметры плагинов — все это можно сделать мышкой прямо в браузере. Причем благодаря фильтрам вам не придется вспоминать именно что вы редактировали, а что нет — вы можете включить просмотр только тех параметров, которые менялись.

Интерфейс
Справа на тулбаре добавлена кнопка для быстрого доступа к админке плагина с пунктами:

• Настройки плагинов
• Кеш и БД
• Справка

Первый открывает страницу настроек конфигов, второй — страницу на которой можно очистить разные типы кешей в ЛС, а также произвести оптимизацию таблиц движка, третий пункт показывает справку.

Интерфейс состоит из двух частей: слева приведен список всех доступных конфигов в системе, разделенных на 2 группы: «Система» — главный конфиг движка, который содержит список всех системных параметров и «Плагины» — список всех конфигов плагинов.

В списке каждый плагин обозначен цветом: зеленый — означает активный, серый — неактивный. При наведении курсора мыши на имя плагина, появляются дополнительные опции: кнопка активации/деактивации плагина (цвет которой символизирует текущий статус плагина), кнопка собственных настроек плагина (если страница настроек есть у плагина), а также кнопка показа краткой информации о плагине.

Для того чтобы открыть список параметров плагина достаточно кликнуть на имя плагина.

Ко всем элементам интерфейса есть всплывающие подсказки, которые можно легко получить наведением курсора мыши на интересующий элемент.

Как производятся настройки плагинов
При выборе плагина, в правой части появляется блок «Информация о плагине» и блок «Показать параметры по фильтру» содержит 6 переключателей, которые осуществляют быстрый отбор нужного типа параметров. После этого следует список всех доступных параметров.

Каждый параметр визуально выделен в небольшой логичный блок:

• порядковый номер параметра, каким он был найден в конфиге
• список цветовых индикаторов типа параметра
• один или более комментариев к параметру которые были найдены наиболее близко к параметру ДО него самого (если существуют)
• текущее значение параметра. Может быть представлено однострочным полем ввода, многострочным полем ввода или списком значений.
• если параметр редактировался, справа от значения есть маленький значок ">>", при нажатии на который открывается ещё одно поле такого же типа с оригинальным значением этого параметра которое было записано в конфигурационном файле (значением по-умолчанию).
• ключ параметра, которым он записан в конфиге
• один или более комментариев к параметру которые были найдены наиболее близко к параметру ПОСЛЕ него самого (если существуют)

Цветовые индикаторы и фильтры отбора
Все параметры отмечаются специальным(и) цветным(и) индикаторами типа, которые указывают на дополнительную информацию об этом параметре. Всего есть 6 индикаторов:

• Значение параметра не менялось — именно таким оно было найдено в конфиге плагина
• Вы редактировали параметр — значение отличается от записаного в файле конфига
• Параметр закомментирован в конфиге или имеет значение NULL
• Параметр установлен с помощью другой переменной, именно её значение и показывается
• Параметр связан с другим ключом конфигурации и зависит от его значения
• Параметр установлен напрямую через вызов класса конфига (Config)

Это описание можно открыть, нажав на 3 большие точки справа от заголовка «Настройки плагина». Эти цветовые индикаторы показываются для каждого параметра справа маленькими кружочками. Получить справку по каждому индикатору также можно наведя курсор мыши на индикатор. Для каждого параметра может быть показано несколько индикаторов.

Над параметрами находится фильтр, который позволяет сделать отбор только нужных параметров по индикаторам. Например, можно показать только те параметры, значение которых редактировалось (отличное от значения по-умолчанию).

Технические детали
Для каждого скалярного значения параметра есть определенное визуальное представление, удобное для редактирования:

• для чисел и строковых величин, которые не содержат перевод строки редактирование представлено простым полем ввода.
• для строковых величин с переводом каретки и массивов появляется многострочное поле ввода
• для логических значений (булев тип) выводится выпадающий список значений с пунктами «включено (true)» и «выключено (false)»

Как анализируются конфиги:

• Плагин понимает все типы скалярных значений параметров в конфигах движка ЛС
• Закомментированные параметры также парсятся, чтобы иметь возможность включать закомментированные возможности (если такие заявлены автором плагина)
• Плагин распознает все типы комментариев в php (одно и многострочные) в любых количествах. Плагин распознает близлежащие к параметрам комментарии до и после параметра, составляя таким образом наиболее полное единое описание для параметра
• Показывает параметры указанные посредством ключей массива (стандартный метод) так и установленные напрямую через вызов класса конфига (Config)
• Плагин находит строковые и числовые типы ключей
• В интерфейсе, в зависимости от типа значения параметра, параметр будет представлен либо полем ввода (для чисел и строк, в т.ч. многострочным полем ввода если в параметре найдены переводы строк) либо многострочным полем ввода (для массивов) либо выпадающим списком со значениями «вкл/выкл» (для булевого типа)
• Если параметр устанавливается с помощью переменной, она будет загружена для получения значения.
• Комментарии аккуратно разбираются и чистятся от разного рода символов, которые являются визуальным украшением (например, звездочки в phpDoc комментариях)
• Автоопределение кодировки utf-8 BOM и уведомление пользователя если такая найдена в главном конфиге сайта или плагинов

Нельзя редактировать следующие 4 параметра:

• path.root.server
• path.root.engine
• sys.plugins.activation_file
• db.params
• + частично настройки плагина config engine
• + частично настройки плагина admin config

Все эти параметры корректно распознаются, но они необходимы для минимального уровня абстракции для загрузчика, поэтому их редактировать не представляется возможным (ограничения движка) и эти параметры занесены плагином в список исключений для редактирования.

Замечание: ограничение движка делает невозможным редактирование конфигов, которые размещены в папке шаблона (/templates/skin/ИМЯ_ШАБЛОНА/settings/config/config.php). Параметры из этого конфига перекрывают параметры основного конфига. К счастью, обычно эти конфиги пустые.

Файлы на диске остаются неизменными, все настройки плагин хранит в БД.

Страница работы с кешем и БД
На этой странице есть две возможности: очистка кеша и оптимизация БД.

«Очистка кеша» позволяет очистить нужный тип кеша (5 вариантов) в ЛС или произвести очистку всех кешей одной кнопкой.

Второй пункт «Оптимизация и сжатие БД» позволяет незначительно ускорить работу вашей БД за счет выполнения двух команд MySQL: «ANALYZE TABLE» и «OPTIMIZE TABLE». При открытии страницы в поле ввода перечисляются через запятую все найденные таблицы БД вашего сайта.

Скорость работы
Плагин не делегирует и не наследует никаких системных модулей и использует легитимные функции движка, что делает работу этого плагина очень быстрой. Эта админка не создает никакой нагрузки и не добавляет ни одного нового запроса к БД, она модифицирует работу плагина Config Engine таким образом, чтобы выполнять один быстрый запрос к БД для нужд плагина ConfigEngine и Admin Config.