Техзадание — плагин: Веб-гейт серверной консоли



Тэги: Minecraft, JAVA, Plugin, Spigot, Web





Общие сведения:



Плагин нужно разработать на JAVA в формате пригодном для взаимодействия с Minecraft ядром Spigot версии 1.12 (https://www.spigotmc.org/). Для успешной разработки плагина желательны навыки разработки ПО под Minecraft и навыки работы с сетевыми протоколами, в частности реализацией веб-протокола (серверного) на Java. Полезная информация для разработки Spigot плагинов: https://www.spigotmc.org/wiki/spigot-plugin-develo...











Роль плагина в общей картине:





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



Описание отдельных опций:



Пример: config.yml плагина

#########################################################################

#IP адрес, по которому будет запущен веб-сервер (0.0.0.0 - все доступные)

Server IP: 0.0.0.0



#Порт веб-сервера

Server port: 25580



#Cписок IP адресов, с которых есть доступ к веб-интерфейсу

IP access list:

-1.1.1.1

-2.2.2.2

-3.3.3.3



#Пароль, по которому IP адрес временно добавляется в список доступа по IP в памяти

Access password: qwertyrtyqe



#Длительность сессии авторизации по паролю, минут (-1 - постоянно, до перезапуска)

Session time: -1



#Временной интервал содержимого консоли, хранимый в памяти плагина для ответа через веб, секунд (макс. до 86400 /1сутки)

Console Memory Buffer Time: 3600



#Ограничение числа строк, хранимое в памяти плагина для ответа через веб

Console Memory Buffer Strings: 100000



#########################################################################





1) Авторизация по IP или логин-пароль.



Пример веб-запроса на авторизацию:

http://site.com/auth.cgi?code= qwertyrtyqe (разумеется GET запрос показан для примера, плагин должен принимать данные и в POST запросе аналогично)



Если авторизация успешна, веб-сервер должен возвратить в ответ на этот запрос результат действия - веб страницу содержающую plain text, например:

auth=true,ip=1.1.1.1,expired=<тут session time из конфига>

или если пароль не верен:

auth=false

Если пароль введен неверно более 3х раз - на 10 минут блокировать IP адрес, который пытался пройти авторизацию - не обрабатывать попытки авторизации, а выдавать код ответа веб-сервера 403.



Запрос не нужно выполнять если его успешно выполнили и сессия не окончена или пользователь есть в списке IP access list.



Чтобы принудительно завершить сессию, нужно отправить запрос http://site.com/auth.cgi?quit=true

Ответ, отправляемый на этот запрос - auth=false.





2) Отправка команд в консоль.



Брать команду из веб-запроса: http://site.com/rcon.cgi?cmd= (разумеется GET запрос показан для примера, плагин должен принимать данные и в POST запросе аналогично)

И отправлять ее в обработку сервером как из консоли.

Веб-клиенту запросившему команду возвращать веб-страницу с результатом выполнения команды в plain text.





3) Чтение консоли.



По команде из веб-запроса http://site.com/rcon.cgi?read=<параметр, указывающий на сколько секунд назад считать консоль> возвращать клиенту ответ с прочтенным содержимым, в plain text, UTF8. Разделители строк - 1310.

read=60 выдаст содержимое консоли за последние 60 секунд

read=0 выдаст 1 последнюю строку

Предельный интервал времени для строк, хранимых для read определяется параметром Console Memory Buffer (см. выше).

Строки лога консоли должны быть нумерованы отметками времени каждая. В выдаче этих строк по запросу http://site.com/rcon.cgi?read=5 они должны иметь вид:



1529095494: NemezizRe issued server command: /menu

1529095496: SuperBaton has RandomPorted to 149, 93, -684

1529095497: Can9_KryTou issued server command: /rg info

1529095498: NemezizRe issued server command: /warp shop





4) Обработка ошибочных запросов.



Если пользователь выполнил любой запрос, кроме http://site.com/auth.cgi?code=, но не был авторизован (пункт 1, выше) - всегда возвращать ответ auth=false.



Если клиент авторизован, но запросил http://site.com/auth.cgi или http://site.com/rcon.cgi без параметра или параметр неверный, в ответе указать error=norequest



Если клиент авторизован, но запросил http://site.com/auth.cgi или http://site.com/rcon.cgi?cmd= без значения параметра, в ответе указать error=novalue



Если клиент авторизован, но запросил http://site.com/rcon.cgi?cmd= или http://site.com/rcon.cgi?read= с неверным значением параметра, в ответе указать error=badvalue



Если клиент запросил любой документ с http://site.com/??? кроме обрабатываемых - возвращать код ответ веб-сервера 404.