import enum import json from requests import Response from typing import Optional, List from .atconnect import AternosConnect from .aterrors import ServerError from .aterrors import ServerEulaError from .aterrors import ServerRunningError from .aterrors import ServerSoftwareError from .aterrors import ServerStorageError from .atfm import FileManager from .atconf import AternosConfig from .atplayers import PlayersList from .atplayers import Lists from .atwss import AternosWss class Edition(enum.IntEnum): """Server edition type enum""" java = 0 bedrock = 1 class Status(enum.IntEnum): """Server numeric status enum. It is highly recommended to use `AternosServer.status` instead of `AternosServer.status_num`""" off = 0 on = 1 starting = 2 shutdown = 3 unknown = 6 error = 7 confirm = 10 class AternosServer: """Class for controlling your Aternos Minecraft server :param servid: Unique server IDentifier :type servid: str :param atconn: :class:`python_aternos.atconnect.AternosConnect` instance with initialized Aternos session :type atconn: python_aternos.atconnect.AternosConnect :param reqinfo: Automatically call AternosServer.fetch() to get all info, defaults to `True` :type reqinfo: bool, optional """ def __init__( self, servid:str, atconn:AternosConnect, reqinfo:bool=True) -> None: self.servid = servid self.atconn = atconn if reqinfo: self.fetch() def fetch(self) -> None: """Send a request to Aternos API to get all server info""" servreq = self.atserver_request( 'https://aternos.org/panel/ajax/status.php', 'GET', sendtoken=True ) self._info = json.loads(servreq.content) def wss(self, autoconfirm:bool=False) -> AternosWss: """Returns :class:`python_aternos.atwss.AternosWss` instance for listening server streams in real-time :param autoconfirm: Automatically start server status listener when AternosWss connects to API to confirm server launching, defaults to `False` :type autoconfirm: bool, optional :return: :class:`python_aternos.atwss.AternosWss` object :rtype: python_aternos.atwss.AternosWss """ return AternosWss(self, autoconfirm) def start(self, headstart:bool=False, accepteula:bool=True) -> None: """Starts a server :param headstart: Start a server in the headstart mode which allows you to skip all queue, defaults to `False` :type headstart: bool, optional :param accepteula: Automatically accept the Mojang EULA, defaults to `True` :type accepteula: bool, optional :raises ServerEulaError: When trying to start a server without accepting the Mojang EULA :raises ServerRunningError: When trying to start a server which is alreday running :raises ServerSoftwareError: When Aternos notifies about incorrect software version :raises ServerStorageError: When Aternos notifies about voilation of storage limits (4 GB for now) :raises ServerError: When API is unable to start a Minecraft server due to unavailability of Aternos' file servers or other problems """ startreq = self.atserver_request( 'https://aternos.org/panel/ajax/start.php', 'GET', params={'headstart': int(headstart)}, sendtoken=True ) startresult = startreq.json() if startresult['success']: return error = startresult['error'] if error == 'eula' and accepteula: self.eula() self.start(accepteula=False) elif error == 'eula': raise ServerEulaError( 'EULA was not accepted. Use start(accepteula=True)' ) elif error == 'already': raise ServerRunningError( 'Server is already running' ) elif error == 'wrongversion': raise ServerSoftwareError( 'Incorrect software version installed' ) elif error == 'file': raise ServerError( 'File server is unavailbale, view https://status.aternos.gmbh' ) elif error == 'size': raise ServerStorageError( f'Available storage size is 4GB, ' + \ f'your server used: {startresult["size"]}' ) else: raise ServerError( f'Unable to start server, code: {error}' ) def confirm(self) -> None: """Confirms server launching""" self.atserver_request( 'https://aternos.org/panel/ajax/confirm.php', 'GET', sendtoken=True ) def stop(self) -> None: """Stops the server""" self.atserver_request( 'https://aternos.org/panel/ajax/stop.php', 'GET', sendtoken=True ) def cancel(self) -> None: """Cancels server launching""" self.atserver_request( 'https://aternos.org/panel/ajax/cancel.php', 'GET', sendtoken=True ) def restart(self) -> None: """Restarts the server""" self.atserver_request( 'https://aternos.org/panel/ajax/restart.php', 'GET', sendtoken=True ) def eula(self) -> None: """Accepts the Mojang EULA""" self.atserver_request( 'https://aternos.org/panel/ajax/eula.php', 'GET', sendtoken=True ) def files(self) -> FileManager: """Returns :class:`python_aternos.atfm.FileManager` instance for file operations :return: :class:`python_aternos.atfm.FileManager` object :rtype: python_aternos.atfm.FileManager """ return FileManager(self) def config(self) -> AternosConfig: """Returns :class:`python_aternos.atconf.AternosConfig` instance for changing server settings :return: :class:`python_aternos.atconf.AternosConfig` object :rtype: python_aternos.atconf.AternosConfig """ return AternosConfig(self) def players(self, lst:Lists) -> PlayersList: """Returns :class:`python_aternos.atplayers.PlayersList` instance for managing operators, whitelist or banned players list :param lst: Players list type, must be the :class:`python_aternos.atplayers.Lists` enum value :type lst: python_aternos.atplayers.Lists :return: :class:`python_aternos.atplayers.PlayersList` :rtype: python_aternos.atplayers.PlayersList """ return PlayersList(lst, self) def atserver_request( self, url:str, method:int, params:Optional[dict]=None, data:Optional[dict]=None, headers:Optional[dict]=None, sendtoken:bool=False) -> Response: """Sends a request to Aternos API with server IDenitfier parameter :param url: Request URL :type url: str :param method: Request method, must be GET or POST :type method: str :param params: URL parameters, defaults to an empty dictionary :type params: dict, optional :param data: POST request data. If the method is set to GET, it will be combined with params. Defaults to an empty dictionary :type data: dict, optional :param headers: Custom headers, defaults to an empty dictionary :type headers: dict, optional :param sendtoken: Send ajax token in params :type sendtoken: bool :return: API response :rtype: requests.Response """ return self.atconn.request_cloudflare( url=url, method=method, params=params, data=data, headers=headers, reqcookies={ 'ATERNOS_SERVER': self.servid }, sendtoken=sendtoken ) @property def subdomain(self) -> str: atdomain = self.domain return atdomain[:atdomain.find('.')] @subdomain.setter def subdomain(self, value:str) -> None: self.atserver_request( 'https://aternos.org/panel/ajax/options/subdomain.php', 'GET', params={'subdomain': value}, sendtoken=True ) @property def motd(self) -> str: return self._info['motd'] @motd.setter def motd(self, value:str) -> None: self.atserver_request( 'https://aternos.org/panel/ajax/options/motd.php', 'POST', data={'motd': value}, sendtoken=True ) @property def address(self) -> str: return self._info['displayAddress'] @property def domain(self) -> str: return self._info['ip'] @property def port(self) -> int: return self._info['port'] @property def edition(self) -> int: soft_type = self._info['bedrock'] return int(soft_type) @property def software(self) -> str: return self._info['software'] @property def version(self) -> str: return self._info['version'] @property def status(self) -> str: return self._info['class'] @property def status_num(self) -> int: return int(self._info['status']) @property def players_list(self) -> List[str]: return self._info['playerlist'] @property def players_count(self) -> int: return int(self._info['players']) @property def slots(self) -> int: return int(self._info['slots']) @property def ram(self) -> int: return int(self._info['ram'])