Auto-Update fundamentally works

Author: jkrrv

Pckgd/Pckgd.py

@@ -56,6 +56,7 @@ def parse_headers(self):
             if (self.typeId == 5 and line.strip().startswith('#')) or \
                     (self.typeId == 4 and line.strip().startswith('--')):
                 prefix_chars = 1 if self.typeId == 5 else 2
+                line = line.strip()
                 parts = line[prefix_chars:].split(':', 1)
                 if len(parts) == 2:
                     key = parts[0].strip()
@@ -91,8 +92,8 @@ def get_action_buttons(self):
 
         if self.has_update_available():
             buttons.append("""
-            <a href="PyScript/Pckgd?v=update&pkg={}" class="btn btn-primary">Update</a>
-            """.format(self.filename))
+            <a href="/PyScript/Pckgd?v=update&pkg={}" class="btn btn-primary">Update</a>
+            """.format(self.filename_with_extension()))
 
         return "\n".join(buttons)
 
@@ -195,6 +196,8 @@ def set_header(body, key, value, type_id):
                     new_lines.append(line)
             elif Pckgd.do_not_edit_demarcation in line:
                 demarc_found = True # once we hit the demarcation, stop looking for headers
+            else:
+                new_lines.append(line)
 
         if not header_found:  # Doesn't exist, so needs to be inserted.
             insert_index = 0
@@ -316,6 +319,38 @@ def _save_meta_if_dirty():
             del meta['_dirty']
             model.WriteContentText("PckgdCache.json", json.dumps(meta, indent=2))
 
+
+    def do_update(self, new_pckg):
+        # Update the content in the system
+        # If using demarcation, preserve anything above it (the "preamble").
+        preamble = None
+        new_body = new_pckg.body
+        if Pckgd.do_not_edit_demarcation in self.body:
+            preamble = self.body.split(Pckgd.do_not_edit_demarcation, 1)[0]
+
+        # Assemble new body with old preamble.
+        if preamble is not None and Pckgd.do_not_edit_demarcation in new_pckg.body:
+            new_body = new_pckg.body.split(Pckgd.do_not_edit_demarcation, 1)[-1].strip()
+
+        if preamble is not None:
+            new_body = preamble + '\n' + ('#' if self.typeId == 5 else '--') + Pckgd.do_not_edit_demarcation + new_pckg.body
+
+        v = new_pckg.version
+
+        self.body = new_body
+
+        if "Version" in self.headers or "Version" in new_pckg.headers:
+            new_body = Pckgd.set_header(new_pckg.body, 'Version', v, self.typeId)
+
+        if self.typeId == 5:
+            model.WriteContentPython(self.filename, new_body)
+        elif self.typeId == 4:
+            model.WriteContentSql(self.filename, new_body)
+
+        # TODO update dependencies, as well.
+
+
+
 def do_listing_view():
     model.Header = "Package Manager"
     model.Title = "Package Manager"
@@ -411,5 +446,83 @@ def do_listing_view():
           </style>
           """)
 
+def do_update_view():
+    model.Header = "Package Manager - Update Package"
+    model.Title = "Package Manager - Update Package"
+
+    pkg_name = Data.pkg
+    pkg = None
+    for p in Pckgd.find_installed_packages():
+        if p.filename_with_extension() == pkg_name:
+            pkg = p
+            break
+
+    if not pkg:
+        print("<p><strong>Package not found: {}</strong></p>\n".format(pkg_name))
+        return
+
+    print("<h2>Update Package: {}</h2>\n".format(pkg.name()))
+
+    update_source = pkg.get_update_source()
+    if not update_source:
+        print("<p><strong>No update source defined for this package.</strong></p>\n")
+        return
+
+    remote_content = model.RestGet(update_source, {})
+    if remote_content == "404: Not Found":
+        print("<p><strong>Update source not found: {}</strong></p>\n".format(update_source))
+        return
+
+    remote_pkg = Pckgd(pkg.typeId, pkg.filename, remote_content)
+
+    if remote_pkg.version == pkg.version:
+        print("<p><strong>This package is already up to date.</strong></p>\n")
+        return
+
+    # Perform the update
+    try:
+        pkg.do_update(remote_pkg)
+        print("<p><strong>Package updated successfully to version {}.</strong></p>\n".format(remote_pkg.version))
+    except Exception as e:
+        print("<p><strong>Error updating package: {}</strong></p>\n".format(str(e)))
+
+
 if model.HttpMethod == "get" and Data.v == "":
-    do_listing_view()
+    do_listing_view()
+
+
+elif model.HttpMethod == "get" and Data.v == "update" and Data.pkg != "":
+    do_update_view()
+
+elif model.HttpMethod == "get" and Data.v == "test":
+    model.Header = "Package Manager - Test"
+    model.Title = "Package Manager - Test"
+
+    input = """
+    # Pckgd
+    # Title: Sample Package
+    # Description: A sample package for testing.
+    # Updates from: GitHub/ExampleUser/ExampleRepo/SamplePackage.py
+    
+    somevar = 123
+    
+    # this is preamble that should be preserved. 
+    
+    # ==============
+    
+    # This is content that should be changed.
+    
+    """
+
+    p = Pckgd(5, "SamplePackage", input)
+    print("<h2>Package: {}</h2>\n".format(p.name()))
+    print("<pre>{}</pre>\n".format(json.dumps(p.headers, indent=2)))
+    print("<p>Version: {}</p>\n".format(p.version))
+
+    new_input = Pckgd.set_header(input, "Version", "1.2.3", 5)
+
+    p2 = Pckgd(5, "SamplePackage", new_input)
+    print("<h2>Updated Package: {}</h2>\n".format(p2.name()))
+    print("<pre>{}</pre>\n".format(json.dumps(p2.headers, indent=2)))
+    print("<p>Version: {}</p>\n".format(p2.version))
+

Pckgd/README.md

@@ -17,8 +17,9 @@ be located in the first 100 lines of the script, and must be located immediately
 demarcation is used (explained below), the headers must be *above* the demarcation. 
 The headers are:
 
-- `# Pckgd` - Required.  No value.  Identifies the file as part of a Pckgd package. Without this header, the script won't be found in 
-    the query for packages.
+- `# Pckgd` - Required as the first of these headers.  No value.  Identifies the file as part of a Pckgd package, and 
+    indicates where these headers are in the file. Without this header, the script won't be found in the query for 
+    packages, and the headers won't be found in the file.
 - `# Updates from:` - Required for updates. An identifier of where updates should come from.  Two types of values are allowed:
     - A URL to a text file: e.g. `# Updates from: https://example.com/mypackage-latest.txt`
     - A GitHub repository in the format `GitHub/username/repo/path/to/file.py`: e.g. `# Updates from: GitHub/TenthPres/TouchPointScripts/Pckgd/Pckgd.py`
@@ -28,7 +29,10 @@ The headers are:
 on. For example, if a python script depends on a SQL file, this header might be something like `# Depends on: MyScript.sql`.  
 When dependencies are defined, they will be provided as part of installation, provided they are available in the same 
 source and directory as the current file. 
-- `# Version` - Optional.  The current version of the script.  If not provided, a hash will be generated on a per-file basis to determine if a new version is available.
+- `# Version:` - Optional.  The current version of the script.  Must contain hex characters and dots only (e.g. `1.0.0`, `2.1`, `2024.06.15`, `adcf1234`).
+  - If not provided, a hash will be generated on a per-file basis to determine if a new version is available.  
+  - If a version is provided in the source file (e.g. on GitHub), only the version numbers will be compared, not the content of the script.  Therefore, if you use this parameter, to make clients see a new update as being available, you *must* change the version number on the repository.
+  - If you want every new update published on your repository to be treated as a new version, leave this header out. 
 - `# License:` - Optional.  The license under which the package is provided.
 - `# Author:` - Optional.  The author of the package.
 - `# Header color:` - Optional.  A hex color code (e.g. `#FF0000`) to use as the header color in the UI.  If one is not provided, a color is generated from a hash of the file name. 
@@ -53,9 +57,9 @@ A minimally-documented SQL file may have headers like this:
 -- Updates from: https://example.com/mypackage-latest.sql
 ```
 
-### "Stop editing" demarcation
+### "Stop Editing" Demarcation
 
-Some scripts may require that some variables or constants be set for the script to work properly, particularly to 
+Some scripts require some variables or constants set manually for the script to work properly, particularly to 
 adapt the script to the specific needs of a given church.  These variables must be near the top of the script, and 
 should be separated from the rest of the script with a "stop editing" demarcation, like this:
 
@@ -69,5 +73,9 @@ This is crucial for two reasons:
 2. When files are evaluated to see if updates are needed, only the content below this line is considered. This allows 
    for customizations to exist and also not interfere with update detection.
 
+When developing updates, package developers need to keep in mind that any content above the demarcation will not be
+updated on client systems.  Therefore, any changes to the script that are necessary for the update (e.g. new variables)
+may need to be communicated to users separately, and it should be assumed that these variables may not be set. 
+
 If a script does not have any customizations or provides though customizations through a UI, you do not need to include 
 a demarcation.