1.53

Author: Enderbyte09

README.md

@@ -66,4 +66,28 @@ echo "Installation finished with no errors."
 
 ## Other Important Things
 
-ATTENTION - If you use an old version of this software, it might ask you for a "product key." This system has been retired, so it may confuse you. Please paste the code `4p6jgtnatqj5svb4` if it asks you for one.
+ATTENTION - If you use an old version of this software, it might ask you for a "product key." This system has been retired, so it may confuse you. Please paste the code `4p6jgtnatqj5svb4` if it asks you for one.
+
+## Integrating Third Party Software
+
+If you would like to make your application work with CRSS, here is how to do so
+
+### Server automatic restarts
+
+You can control whether or not CRSS automatically restarts a server by writing a file in the server's root directory named `autorestart`
+
+** Requirements **
+- CRSS v1.53 or newer
+- User must set Autorestart Source to allow external file
+
+This `autorestart` must contain some certain recognized words, in any case, seperated by a space. Recognized words include:
+- `never` - Never automatically restart the server (May not be used with safe/unsafe) *Optional - if neither safe nor unsafe are provided, this is the default behaviour*
+- `safe` - Automatically restart the server if it exited safely (may not be used with never)
+- `unsafe` - Automatically restart the server if it did not exit safely. (may not be used with never)
+- `disposable` - "Consume" this autorestart file so that it may be only read once. (may not be used with persistent) *Optional - if persistent is not provided, this is the default behaviour*
+- `persistent` - Keep this file (do not delete it when it is read)
+
+**For example**
+
+`safe persistent` - Autorestart the server if it doesn't crash. This file may be used multiple times.
+`safe unsafe` - Autorestart the server all the time, no matter what.

changelog

@@ -7,6 +7,11 @@
 - Remove all references to anything monetary
 - Including ads, product keys, etc
 - Fix bug where screen spam would occur if API server was down
+- Remove showprog setting as it was completely useless
+- Add autorestart
+    - Add autorestarttimeout setting, which defaults to 30 seconds timeout
+    - This means you have 30s to abort the autorestart after it triggers.
+    - Autorestart settings are found in advanced config -> startup options -> Autorestart options
 1.52.2:
 - Add the ability to change the server's java installation
 - Fix bugs

doc/build.txt

@@ -79,14 +79,6 @@ The most important keys are the arrow keys and enter. These are used to navigate
 Message boxes are dismissed with the enter key and navigated around with the left and right arrow keys. Message boxes are in a rectangle and do not take up the full screen.
 
 In most widgets, all of the key-bindings are layed out for you. The only exception to this is the file dialogues. If you need help with keybinds on the file dialog boxes, simply press H to bring up a list.
-$Using GumRoad
-If you use GumRoad to purchase CraftServerSetup you will recieve a longer product key. Check the section "Product Keys" for more info
-$Product Keys:
-In the OOBE you will be asked to input a product key. You can get a product key by paying the $2 fee and telling Enderbyte Programs that you send it. You will recieve your product key shortly. Product keys remove advertisements and bypass the 1 server limit. Product keys as of 1.30 are 16 characters long. THey have latters and numbers, but are case insensitive. For crack artists looking to crack this program, good luck! Though the hashed keys are publicly available on pastebin, you still need to reverse engineer. 26 letters + 10 numbers = 36 characters. 36 ^ 16 characters divided by 100 keys in system means that you have to generate 1.8*10^48 hashes before you should stumble on a correct one. Trust me, it is not worth it.
-FOR GUMROAD USERS: When asked where you got your key, select "From GumRoad". From there paste in your key. 
-Old product keys were 8 numbers and incredibly easy to crack. Not anymore...
-$Advertisements:
-Advertisements are what you recieve if you do not input a product key. In every option menu, there is an advertisement. If you press A, the ad will be opened in your browser. Prior to 0.18.3, you had a 20% chance of encountering an ad while navigating. This was removed because it could be quite annoying
 $Starting a new server:
 To start a new server, simply select Set up a new server, then Create a new server from the main menu. From there, choose a software. As of 1.30, CraftServerSetup supports 4 softwares: Vanilla, Spigot, Paper, and Purpur. For each software, proceed down the list of documentation pages. However, before you do that, you will be asked for a name. A name MUST NOT have any special characters like / or \ because that will damage the file system. Spaces are OK.
 $Preparing Vanilla Software:

doc/craftserversetup.epdoc

@@ -2,6 +2,7 @@
 import random
 import json
 import gzip
+import typing
 
 def compatibilize_appdata(data:dict) -> dict:
     """This function ensures that appdata is brought up to the latest version. It is compatible to the beginning."""
@@ -19,7 +20,7 @@ def compatibilize_appdata(data:dict) -> dict:
         "transitions":{
             "display" : "Show Transitions?",
             "type" : "bool",
-            "value" : True
+            "value" : False
         },
         "oldmenu":{
             "name" : "oldmenu",
@@ -32,26 +33,19 @@ def compatibilize_appdata(data:dict) -> dict:
         #Update data
         data["settings"] = {
 
-        "transitions":{
-            "display" : "Show Transitions?",
-            "type" : "bool",
-            "value" : data["settings"][1]["value"]
-        },
-        "oldmenu":{
-            "name" : "oldmenu",
-            "display" : "Use legacy style menus?",
-            "type" : "bool",
-            "value" : data["settings"][2]["value"]
-        }
+            "transitions":{
+                "display" : "Show Transitions?",
+                "type" : "bool",
+                "value" : data["settings"][1]["value"]
+            },
+            "oldmenu":{
+                "name" : "oldmenu",
+                "display" : "Use legacy style menus?",
+                "type" : "bool",
+                "value" : data["settings"][2]["value"]
+            }
 
         }
-    if not "showprog" in data["settings"]:
-        data["settings"]["showprog"] = {
-            "name" : "showprog",
-            "display" : "Show progress bar startup?",
-            "type" : "bool",
-            "value":False
-        }
     if not "editor" in data["settings"]:
         data["settings"]["editor"] = {
             "name" : "editor",
@@ -85,13 +79,21 @@ def compatibilize_appdata(data:dict) -> dict:
         if not "settings" in svr:
             data["servers"][svri]["settings"] = {}#New empty settings
         if data["servers"][svri]["settings"] == {}:
-            data["servers"][svri]["settings"] = {"launchcommands":[],"exitcommands":[]}
+            data["servers"][svri]["settings"] = {"launchcommands":[],"exitcommands":[],"restartsource" : 0,"autorestart" : 0,"legacy" : True,"flags":""}#0 - disabled, 1 - file-controlled, 2 - crss-controlled. 
         if not "legacy" in data["servers"][svri]["settings"]:
             data['servers'][svri]["settings"]["legacy"] = True
         if not "backupdir" in svr:
             data['servers'][svri]["backupdir"] = SERVERS_BACKUP_DIR + os.sep + str(data['servers'][svri]["id"])
         if data["servers"][svri]["software"] == 0:
             data["servers"][svri]["software"] = 5#v1.48
+
+        if not "autorestart" in data["servers"][svri]["settings"]:
+            data["servers"][svri]["settings"]["autorestart"] = 0
+            data["servers"][svri]["settings"]["restartsource"] = 0
+
+        if not "flags" in data["servers"][svri]["settings"]:
+            data["servers"][svri]["settings"]["flags"] = ""
+
 
         #1.49.1
         if not "flags" in svr["settings"]:
@@ -134,6 +136,17 @@ def compatibilize_appdata(data:dict) -> dict:
         del data["productKey"]
         del data["pkd"]
 
+    if "showprog" in data["settings"]:
+        del data["settings"]["showprog"]
+
+    if not "autorestarttimeout" in data["settings"]:
+        data["settings"]["autorestarttimeout"] = {
+            "name" : "autorestarttimeout",
+            "display" : "Autorestart timeout in seconds",
+            "type" : "int",
+            "value" : 30
+        }
+
     return data
 
 __DEFAULTAPPDATA__ = {
@@ -158,17 +171,29 @@ def compatibilize_appdata(data:dict) -> dict:
             "type" : "bool",
             "value" : False
         },
-        "showprog" : {
-            "name" : "showprog",
-            "display" : "Show progress bar on startup?",
-            "type" : "bool",
-            "value" : False
-        },
         "reswarn" : {
             "name" :"reswarn",
-            "display" : "Give warnings for high-resource operations",
+            "display" : "Give warnings for high-resource operations?",
             "type" : "bool",
             "value" : True
+        },
+        "autorestarttimeout" : {
+            "name" : "autorestarttimeout",
+            "display" : "Autorestart timeout in seconds",
+            "type" : "int",
+            "value" : 30
+        },
+            "editor": {
+            "name": "editor",
+            "display": "Text Editor",
+            "type": "str",
+            "value": "/usr/bin/editor %s"
+        },
+            "autoupdate": {
+            "name": "autoupdate",
+            "display": "Update automatically",
+            "type": "bool",
+            "value": True
         }
     },
     "idata" : {
@@ -185,6 +210,7 @@ def compatibilize_appdata(data:dict) -> dict:
 UUID_INDEX:dict = {}
 
 def setup_appdata():
+    """Load appdata from the file and populate the appdata.APPDATA variable."""
     global APPDATA
     global APPDATAFILE
     global UUIDFILE
@@ -217,12 +243,22 @@ def setup_appdata():
             with open(UUIDFILE,"wb+") as f:
                 f.write(gzip.compress(json.dumps({}).encode()))
 
+def self_compatibilize():
+    """Execute a compatibilization and repair routine on appdata.APPDATA"""
+    global APPDATA
+
+    APPDATA = compatibilize_appdata(APPDATA)
+
 def updateappdata():
+    """Write in-memory appdata and UUID cache to the disk"""
 
     global APPDATAFILE
     global UUID_INDEX
     global UUIDFILE
     with open(APPDATAFILE,"w+") as f:
         f.write(json.dumps(APPDATA,indent=2))
     with open(UUIDFILE,"wb+") as f:
-        f.write(gzip.compress(json.dumps(UUID_INDEX).encode()))#Write compressed file
+        f.write(gzip.compress(json.dumps(UUID_INDEX).encode()))#Write compressed file
+
+def get_setting_value(key:str) -> typing.Any:
+    return APPDATA["settings"][key]["value"]

src/appdata.py

@@ -70,4 +70,4 @@ def get_file_to_import() -> str:
     return _file_to_import
 
 def should_run_import_mode() -> bool:
-    return _file_to_import != ""
+    return _file_to_import != "" and os.path.isfile(_file_to_import)

src/arguments.py

@@ -0,0 +1,78 @@
+"""A module to control the automatic server restart feature for v1.53"""
+import enum
+import os
+import cursesplus
+import uicomponents
+
+class AutoRestartSourceOptions(enum.Enum):
+    NOAUTORESTART = 0#Auto restart will never occur, no matterwhat
+    EXTERNALFILE = 1#CRSS will search for the SERVERDIR/autorestart file and attempt to follow it. If it cannot find it, it will execute the insturction in the CRSS options
+    CRSSONLY = 2#CRSS will only honour the setting in the internal configuration (CRSS options)
+
+class AutoRestartOptions(enum.Enum):
+    NORESTART = 0#No auto restart, no matter what
+    SAFEEXIT = 1#Auto restart only if exit code is 0 (signifying a safe shutdown)
+    ALWAYS = 2 #Auto restart no matter what
+
+class ExternalAutoRestartProfile:
+    """Store a friendly representation of the auto restart profile stored in a file"""
+    def __init__(self,file_data:str):
+        self.restart_always:bool = False
+        self.restart_if_safe:bool = False
+        self.is_persistent: bool = False
+
+        for word in file_data.lower().strip().split():
+            if word == "safe":
+                self.restart_if_safe = True
+            elif word == "unsafe":
+                self.restart_always = True
+            elif word == "persistent":
+                self.is_persistent = True
+            elif word == "disposable":
+                self.is_persistent = False
+            elif word == "never":
+                self.restart_always = False
+                self.restart_if_safe = False
+        
+
+def does_server_have_autorestart_file(serverdir:str) -> bool:
+    """Does the server in serverdir have an autorestart file?"""
+    return os.path.isfile(serverdir + os.sep + "autorestart")
+
+def get_recommended_action(server_configuration:dict,clear_nonpersistent=True) -> AutoRestartOptions:
+    """Using all of the configurations, suggest the action to restart or not"""
+    serverdir:str = server_configuration["dir"]
+    startsource = server_configuration["settings"]["restartsource"]
+
+    if startsource == AutoRestartSourceOptions.NOAUTORESTART:
+        return AutoRestartOptions.NORESTART
+    
+    elif startsource == AutoRestartSourceOptions.CRSSONLY or not does_server_have_autorestart_file(serverdir):#Disregard foreign if startsource is set to or if there is no autorestart file
+        return AutoRestartOptions(server_configuration["settings"]["autorestart"])
+    
+    else:
+        with open(serverdir+os.sep+"autorestart") as f:
+            rd = f.read()
+
+        ob = ExternalAutoRestartProfile(rd)
+        if not ob.is_persistent and clear_nonpersistent:
+            os.remove(serverdir+os.sep+"autorestart")
+
+        if ob.restart_always:
+            return AutoRestartOptions.ALWAYS
+
+        if ob.restart_if_safe:
+            return AutoRestartOptions.SAFEEXIT
+        
+        return AutoRestartOptions.NORESTART
+    
+def autorestart_settings(stdscr,serverdata:dict) -> dict:
+    """UI portion for configuring autorestart"""
+    while True:
+        wtd = uicomponents.menu(stdscr,["Back","Autorestart Mode","Autorestart Source"])
+        if wtd == 0:
+            return serverdata
+        elif wtd == 1:
+            serverdata["settings"]["autorestart"] = uicomponents.menu(stdscr,["Do not automatically restart","Automatically restart only if the server has not crashed","Always automatically restart the server"],"Select the CRSS-based autorestart mode to use","If you set the source to be external, this setting will be ignored.")
+        elif wtd == 2:
+            serverdata["settings"]["restartsource"] = uicomponents.menu(stdscr,["Do not automatically restart","Pull settings from $DIR/autorestart file, then CRSS.","Pull settings from CRSS only"],"Choose a data source for autorestart")