Плагин служит для фиксирования и сохранения данных о рекордах по ряду параметров. Это: максимум пользователей на Хабе; максимальное среднее значение пользователей за сутки; максимальная шара Хаба; максимальная шара пользователей и некоторые другие. При этом сохраняются данные о значении рекорда, данные о пользователе, времени и прочие данные. Также есть функция выгрузки данных о рекордах в файл по шаблону (например, для WEB) и возможность составлять графические юзербары (userbars).
Включение/выключение функции выгрузки в файл по шаблону по команде !iswrightrecords. Включение/выключение функции записи юзербаров по команде !iswrightuserbars. Включить/выключить возможность следить за рекордами у незарегистрированных пользователей можно по команде !isrecordsforregs. Посмотреть статистику рекордов можно по команде !seerecords. Включить/выключить вывод в чат сообщений о новых рекордах можно по команде !isnoticerecords. Вывести в чат статистику основных рекордов для всех можно по команде !showrecords. Посмотреть статистику рекордов за выбранный период можно по команде !seerecordsperiod <дата1> <дата2>. Тут указывается начальная дата периода и конечная в формате дд.мм.гггг.
Отредактировать рекорды в базе можно по команде !editrecords <индекс> <поле> <значение>. Индекс может быть 1 (максимум пользователей), 2 (максимальная шара Хаба), 3 (максимальная шара пользователя), 4 (максимальное среднее значение пользователей за сутки). Поле может быть VALUE (значение параметра), TIME (время рекорда в секундах, начиная с 01.01.1970), MARK (пометка).
Отредактировать историю рекордов можно по команде !editrecordhistory <год> <месяц> <день> <индекс> <поле> <значение>. Индекс может быть 1 (количество пользователей), 2 (объём шары Хаба). Поле может быть MAX (максимальное значение параметра), AVER (среднее значение параметра), MARK (пометка, секунды, начиная с 01.01.1970).
В константе RecordsFile в файле Vars.lua задаётся путь файла для выгрузки информации о рекордах в файл. В константе RecordsPatternFile задаётся пусть к файлу шаблона для выгрузки. В константе GetRecordsPatternFromURL задаётся режим получения шаблона из URL (1 - да, 0 - нет). Если шаблон получается из URL адреса, то в константе пути к шаблону должен быть указан полный URL страницы шаблона. В константах GetRecordsPatternFromURL_GZip, GetRecordsPatternFromURL_CP и GetRecordsPatternFromURL_Proxy задаются параметры использования GZip, кодировка и адрес прокси-сервера (если активна функция получения шаблона из URL). В константе RecordsWrightPeriod задаётся период в минутах выгрузки информации в файл. В константе isUseRecordsPatternCache задаётся режим использования кэша текста шаблона (1 - да, 0 - нет). Если шаблон формируется динамически (например, из URL с помощью динамической страницы), то не используйте кэш шаблона. Кодировка файла шаблона задаётся в константе RecordsPatternCodapage.
В таблице CustomUserBars в файле Vars.lua задаётся перечень юзербаров. В каждой из таблиц юзербаров задаются:
Путь к файлу шаблона,
Конечный путь и имя файла юзербара в папке userbars (которую нужно поместить из папки плагина в директорию HTTP сервера),
Получать ли шаблон по URL-адресу (тогда в пути к шаблону должен быть полный адрес страницы) (1-да,0-нет),
Кодировка шаблона для преобразования к текущей кодировке сервера (или пустая строка, если преобразование не требуется).
В тексте шаблона для выгрузки флаги [BotName], [hub], [time], [date] заменяются на имя Бота, название Хаба, время и дату. Также доступны следующие флаги:
[MAXUSERSVALUE] - Максимум пользователей;
[MAXUSERSTIME] - Время максимума пользователей;
[MAXUSERSMARK] - Пометка максимума пользователей;
[MAXHUBSHAREVALUE] - Максимальный объём файлов Хаба;
[MAXHUBSHARETIME] - Время максимального объёма файлов Хаба;
[MAXHUBSHAREMARK] - Пометка максимального объёма файлов Хаба;
[MAXUSERSHAREVALUE] - Максимальный объём файлов пользователя;
[MAXUSERSHARETIME] - Время максимального объёма файлов пользователя;
[MAXUSERSHAREMARK] - Пометка максимального объёма файлов пользователя;
[MAXUSERSPERDAYVALUE] - Среднее число пользователей за сутки;
[MAXUSERSPERDAYTIME] - Время среднего числа пользователей за сутки;
[MAXUSERSPERDAYMARK] - Пометка среднего числа пользователей за сутки;
[MAXUSERSTODAY] - Максимум пользователей за текущие сутки;
[USERSCOUNT] - Текущее количество пользователей;
[SHARESIZE] - Текущая шара Хаба;
[RAWSHARESIZE] - Текущая шара Хаба в байтах;
[MAXUSERSDATE:дд.мм.гггг] - Максимум пользователей за указанную дату;
[AVERUSERSDATE:дд.мм.гггг] - Среднее число пользователей за указанную дату;
[MARKUSERSDATE:дд.мм.гггг] - Пометка максимального числа рользователей за указанную дату;
[MAXSHAREDATE:дд.мм.гггг] - Максимальная шара Хаба за указанную дату;
[AVERSHAREDATE:дд.мм.гггг] - Среднее число шары Хаба за указанную дату;
[MARKSHAREDATE:дд.мм.гггг] - Пометка шары Хаба за указанную дату;
[AVERUSERSPERIOD:дд.мм.гггг-дд.мм.гггг] - Среднее число пользователей за выбранный период от начальной даты до конечной;
[AVERSHAREPERIOD:дд.мм.гггг-дд.мм.гггг] - Средняя
шара Хаба за выбранный период от начальной даты до конечной;
[NICKLIST:шаблон] - Список онлайн пользователей. Шаблон может содержать текст, который применяется для каждого пользователя. В тексте вставки %NICK%, %SHARE%, %DESC%, %CLASS%, %EMAIL%, %IP%, %CLIENT%, %TAG%, %MODE%, %TYPE% заменяются соответственно на ник, шару, описание, класс, email, IP, клиент, тэг, режим подключения и тип соединения.
База рекордов хранится в файле HubRecords.lua.