Added upgrading, fixed current keyword bug

Author: OwenCochell

CHANGELOG.md

@@ -1,16 +1,30 @@
 # Changelog 
 
+## 2.2.0
+
+Features Added:
+
+  - We can now upgrade ourselves! You can do this using the `-u` parameter.
+
+Bug Fixes:
+
+  - Using the `current` keyword when selecting the build no longer fails.
+
+Other Fixes:
+
+  - Added section to readme describing the update process.
+
 ## 2.1.0
 
 Features Added:
 
-  - Added a new keyword, `current`, which will automatically select the current version/build to install
+  - Added a new keyword, `current`, which will automatically select the current version/build to install.
 
 Bug Fixes:
 
   - Removed some junk debugging messages that would appear even if we are quieted.
 
-other Fixes:
+Other Fixes:
 
   - Added section to the readme that describes how to use keywords.
 

README.md

@@ -180,6 +180,9 @@ Copies the old file to a new location before the installation process:
 Displays stats on the selected version and build:
 >-s, --stats
 
+Checks GitHub for a new version of this script, and upgrades if necessary:
+>-u, --upgrade
+
 ## Special Keywords
 
 The `-v`, `-b`, and interactive menu have special keywords
@@ -204,6 +207,22 @@ You can also use these keywords for selecting the build,
 although using the `current` keyword for build selection is not recommended! 
 
 
+## Upgrading the Script
+
+This script has the ability to upgrade itself!
+You can do this by providing the `-u` parameter.
+
+We do this by checking GitHub for any version changes.
+If there is a change, then we download the new file
+and replace the currently running script with the new one.
+If we are upgrading, then we will immediately exit after the operation,
+and no other actions will be done.
+
+Please note, this upgrade operation is not compatible 
+with prebuilt binaries!
+If you attempt to upgrade a pre-built binary,
+then the script will print a warning and exit.
+
 ## Deprecated Command Line Options
 
 The following command line options are deprecated. They are still included for backwards compatibility,
@@ -341,6 +360,9 @@ Copy the old file to a new location before the installation process:
 Select the currently installed version as the version to install:
 >python server_update.py -v current [PATH]
 
+Upgrades the script if necessary:
+>python server_upgrade.py -u
+
 # Notes on Deprecated Features
 
 In earlier versions of PaperMC-Update, the script would keep a config file in the users home directory

server_update.py

@@ -1,15 +1,17 @@
-from sys import version_info, stdout
+from __future__ import annotations
+
+import sys
 
 # Before we do ANYTHING, we check to make sure python is the correct version!
 
-if version_info < (3,6,0):
+if sys.version_info < (3,6,0):
 
-    stdout.write("\n--== [ Invalid python version! ] ==--\n")
-    stdout.write("Current version: {}\n".format(version_info))
-    stdout.write("Expected version: 3.6+\n")
-    stdout.write("\nPlease install the correct version of python before continuing!\n")
+    sys.stdout.write("\n--== [ Invalid python version! ] ==--\n")
+    sys.stdout.write("Current version: {}\n".format(version_info))
+    sys.stdout.write("Expected version: 3.6+\n")
+    sys.stdout.write("\nPlease install the correct version of python before continuing!\n")
 
-    exit()
+    sys.exit()
 
 import tempfile
 import urllib.request
@@ -31,7 +33,13 @@
 A Set of tools to automate the server update process.
 """
 
-__version__ = '2.1.0'
+__version__ = '2.2.0'
+
+# These variables contain links for the script updating process.
+
+GITHUB = 'https://github.com/Owen-Cochell/PaperMC-Update'
+GITHUB_RELEASE = 'https://api.github.com/repos/Owen-Cochell/PaperMC-Update/releases/latest'
+GITHUB_RAW = 'https://raw.githubusercontent.com/Owen-Cochell/PaperMC-Update/master/server_update.py'
 
 
 def load_config(config: str) -> Tuple[str, int]:
@@ -74,6 +82,78 @@ def load_config(config: str) -> Tuple[str, int]:
     return version, build
 
 
+def upgrade_script(serv: ServerUpdater):
+    """
+    Upgrades this script.
+    
+    We do this by checking github for any new releases,
+    comparing them to our version,
+    and then updating if necessary.
+    
+    We use the ServerUpdater to do this operation for us,
+    so you will need to provide it for this function
+    to work correctly.
+
+    :param serv: ServerUpdater to use
+    :type serv: ServerUpdater
+    """
+    
+    output("# Checking for update ...")
+    
+    # Creating request here:
+    
+    req = urllib.request.Request(GITHUB_RELEASE, headers={'Accept': 'application/vnd.github.v3+json'})
+
+    # Getting data:
+    
+    data = json.loads(urllib.request.urlopen(req).read())
+
+    # Checking if the version is new:
+
+    if data['tag_name'] == __version__:
+
+        # No update necessary, lets log and exit:
+
+        output("# No update necessary!\n")
+
+        return
+
+    output("# New version available!")
+
+    url = GITHUB_RAW
+    path = os.path.realpath(__file__)
+
+    # Determine if we are working in a frozen environment:
+    
+    if getattr(sys, 'frozen', False):
+        
+        print("# Can't upgrade frozen files!")
+
+        return
+
+    # Getting data:
+
+    data = urllib.request.urlopen(urllib.request.Request(url))
+
+    # Write the data:
+    
+    serv.fileutil.create_temp_dir()
+
+    temp_path = os.path.realpath(serv.fileutil.temp.name + '/temp')
+
+    file = open(temp_path, mode='wb')
+
+    file.write(data.read())
+
+    # Install the new script:
+
+    serv.fileutil.install(temp_path, path)
+
+    # We are done!
+
+    output("# Script update complete!\n")
+
+
 def output(text: str):
 
     """
@@ -173,14 +253,14 @@ def progress_bar(length: int, stepsize: int, total_steps: int, step: int, prefix
 
     if not args.quiet:
 
-        stdout.write("{}[{}{}] {}/{}\r".format(prefix, prog_char*x, empty_char*(size-x),
+        sys.stdout.write("{}[{}{}] {}/{}\r".format(prefix, prog_char*x, empty_char*(size-x),
                                                         (step*stepsize if step < total_steps - 1 else length), length))
-        stdout.flush()
+        sys.stdout.flush()
 
     if not args.quiet and step >= total_steps - 1 :
 
-        stdout.write("\n")
-        stdout.flush()
+        sys.stdout.write("\n")
+        sys.stdout.flush()
 
 
 class Update:
@@ -342,7 +422,7 @@ def download_response(self, version: str, build_num:int) -> HTTPResponse:
 
     def download_file(self, path: str, version: str, build_num:int, check:bool=True, call: Callable=None, args: List=None, blocksize: int=4608) -> str:
         """
-        Donloads the content to the given external file.
+        Downloads the content to the given external file.
         We handle all file operations,
         and automatically work with the URLResponse objects
         to write the file contents to an external file.
@@ -910,22 +990,19 @@ def __init__(self, path, config_file: str='', version='0', build=-1, config=True
         self.integrity = integrity  # Boolean determining if we should run an integrity check
         self.version_install = None  # Version to install
         self.build_install = None  # Build to install
-
-        # Starting object
-
-        self._start(config)
+        self.config = config
 
         self.update = Update()  # Updater Instance
 
-    def _start(self, config):
+    def start(self):
         """
         Starts the object, loads configuration.
         """
 
         temp_version = '0'
         temp_build = 0
 
-        if config:
+        if self.config:
 
             # Allowed to use configuration file
 
@@ -1483,9 +1560,15 @@ def _select(self, val: Any, choice: Sequence[Any], default: str, name: str, prin
 
         if val == 'current':
 
-            # User wants currently installed version:
+            if name == 'version':
 
-            val = self.version
+                # User wants currently installed version:
+                
+                val = self.version
+                
+            elif name == 'build':
+                
+                val = self.buildnum
 
         if val not in choice:
 
@@ -1529,15 +1612,15 @@ def _url_report(self, point: str):
                                      epilog="Please check the github page for more info: "
                                             "https://github.com/Owen-Cochell/PaperMC-Update.")
 
-    parser.add_argument('path', help='Path to paper jar file')
+    parser.add_argument('path', help='Path to paper jar file', default=os.path.dirname(__file__) + '/', nargs='?')
 
     version = parser.add_argument_group('Version Options', 'Arguments for selecting and altering server version information')
 
     # +===========================================+
     # Server version arguments:
 
     version.add_argument('-v', '--version', help='Server version to install(Sets default value)', default='latest', type=str)
-    version.add_argument('-b', '--build', help='Server build to install(Sets default value)', default=-1, type=int)
+    version.add_argument('-b', '--build', help='Server build to install(Sets default value)', default=-1, type=str)
     version.add_argument('-iv', help='Sets the currently installed server version, ignores config', default='0', type=str)
     version.add_argument('-ib', help='Sets the currently installed server build, ignores config', default=0, type=int)
     version.add_argument('-sv', '--server-version', help="Displays server version from configuration file and exits", action='store_true')
@@ -1568,6 +1651,7 @@ def _url_report(self, point: str):
                         action='store_true')
     parser.add_argument('-s', '--stats', help='Displays statistics on the selected version and build', action='store_true')
     parser.add_argument('-V', '--script-version', help='Displays script version', version=__version__, action='version')
+    parser.add_argument('-u', '--upgrade', help='Upgrades this script to a new version if necessary, and exits', action='store_true')
 
     # Deprecated arguments - Included for compatibility, but do nothing
 
@@ -1595,6 +1679,18 @@ def _url_report(self, point: str):
 
     update_available = True
 
+    # Determine if we should upgrade:
+
+    if args.upgrade:
+    
+        upgrade_script(serv)
+        
+        sys.exit()
+
+    # Start the server updater
+
+    serv.start()
+
     # Figure out the output name:
 
     name = None