Update YOURLS-diff_CreatePackage.py

Author: gioxx

YOURLS-diff_CreatePackage.py

@@ -14,11 +14,14 @@
     python YOURLS-diff_CreatePackage.py --old 1.8.10
 
 Options:
-    --old        Tag of the starting release (required, e.g. 1.8.10)
-    --new        Tag of the target release (default: latest)
-    --output     Output ZIP filename (default: YOURLS-update-OLD-to-NEW.zip)
-    --no-verify  Disable SSL certificate verification (not recommended)
-    --summary    Generate a summary text file with patch details (e.g. for use in release notes)
+    --old           Tag of the starting release (required, e.g. 1.8.10)
+    --new           Tag of the target release (default: latest)
+    --output        Output ZIP filename (default: YOURLS-update-OLD-to-NEW.zip)
+    --no-verify     Disable SSL certificate verification (not recommended)
+    --summary       Generate a summary text file with patch details (e.g. for use in release notes)
+    --only-removed  Only generate the .removed.txt file (if any). Skip all other outputs. Also generates a deployment script to remove the files from the server.
+    --winscp        Generate a .winscp.txt script to download and delete the removed files (requires --only-removed)
+    --help          Show this help message and exit
 
 Author: Gioxx
 Repo:   https://github.com/gioxx/YOURLS-diff
@@ -116,15 +119,6 @@ def write_manifest(changed_files, new_root, manifest_path):
             mf.write(rel + "\n")
     print(f"→ Manifest saved to {manifest_path}")
 
-# def create_diff_zip(changed_files, new_root, zip_output):
-#     """Create a ZIP archive containing only the changed files."""
-#     print(f"→ Creating package {zip_output}")
-#     with zipfile.ZipFile(zip_output, "w", compression=zipfile.ZIP_DEFLATED) as z:
-#         for full_path in changed_files:
-#             rel = os.path.relpath(full_path, new_root)
-#             z.write(full_path, rel)
-#     print("→ Done.")
-
 def create_diff_zip(changed_files, new_root, zip_output):
     """Create a ZIP archive containing only the changed files."""
     print(f"→ Creating package {zip_output}")
@@ -136,36 +130,28 @@ def create_diff_zip(changed_files, new_root, zip_output):
             count += 1
     print(f"→ Done. ZIP contains {count} file.")
 
-def generate_deploy_script(old_tag, new_tag, zip_name, manifest_name, removed_manifest_name=None):
-    """Generate a Bash deployment script to upload changed files using rsync."""
+def generate_deploy_script(old_tag, new_tag, zip_name, manifest_name,
+                           removed_manifest_name=None, only_removed=False):
+    """
+    Generate a Bash deployment script. If only_removed is True, include only the file removal logic.
+    """
     script_filename = f"YOURLS-deploy-{old_tag}-to-{new_tag}.sh"
-    temp_dir = "__deploy_temp"
-
     lines = [
         "#!/bin/bash",
         "",
         "# Deployment script generated by YOURLS-diff",
         "# Update the variables below before running.",
         "",
-        "# Check if rsync is installed",
-        "if ! command -v rsync >/dev/null 2>&1; then",
-        "  echo \"Error: rsync is not installed or not found in PATH.\"",
-        "  exit 1",
-        "fi",
-        "",
         "# Check if ssh is installed",
         "if ! command -v ssh >/dev/null 2>&1; then",
         "  echo \"Error: ssh is not installed or not found in PATH.\"",
         "  exit 1",
         "fi",
         "",
-        f"MANIFEST=\"{manifest_name}\"",
-        f"REMOVED_MANIFEST=\"{removed_manifest_name}\"" if removed_manifest_name else "# REMOVED_MANIFEST=\"\"",
-        f"ZIP_FILE=\"{zip_name}\"",
+        f"REMOVED_MANIFEST=\"{removed_manifest_name}\"",
         "TARGET_DIR=\"/var/www/yourls\"      # <-- Update this with your server's path",
         "REMOTE_USER=\"user\"               # <-- Update with your SSH user",
         "REMOTE_HOST=\"yourserver.com\"     # <-- Update with your server hostname or IP",
-        f"TEMP_DIR=\"./{temp_dir}\"",
         "",
         "# Pass --dry-run as first argument to simulate the deploy",
         "DRYRUN=\"\"",
@@ -174,36 +160,100 @@ def generate_deploy_script(old_tag, new_tag, zip_name, manifest_name, removed_ma
         "  echo \"Running in DRY-RUN mode. No files will be copied or deleted.\"",
         "fi",
         "",
-        "# Clean and unzip the patch",
-        "rm -rf \"$TEMP_DIR\"",
-        "mkdir -p \"$TEMP_DIR\"",
-        "unzip -q \"$ZIP_FILE\" -d \"$TEMP_DIR\"",
-        "echo \"→ Files extracted into $TEMP_DIR\"",
-        "",
-        "# Upload changed/added files",
-        "echo \"→ Uploading changed files...\"",
-        "while IFS= read -r file; do",
-        "  rsync -avz $DRYRUN \"$TEMP_DIR/$file\" \"$REMOTE_USER@$REMOTE_HOST:$TARGET_DIR/$file\"",
-        "done < \"$MANIFEST\"",
-        "",
-        "# Remove deleted files from remote (if any)",
-        "if [[ -f \"$REMOVED_MANIFEST\" ]]; then",
-        "  echo \"→ Removing obsolete files...\"",
-        "  while IFS= read -r file; do",
-        "    ssh \"$REMOTE_USER@$REMOTE_HOST\" \"rm -f '$TARGET_DIR/$file'\"",
-        "  done < \"$REMOVED_MANIFEST\"",
-        "fi",
-        "",
-        "# Clean up temp directory",
-        "rm -rf \"$TEMP_DIR\"",
-        "echo \"Deployment completed!\""
     ]
 
+    if only_removed:
+        lines += [
+            "# Remove deleted files from remote (if any)",
+            "if [[ -f \"$REMOVED_MANIFEST\" ]]; then",
+            "  echo \"→ Removing obsolete files...\"",
+            "  while IFS= read -r file; do",
+            "    ssh \"$REMOTE_USER@$REMOTE_HOST\" \"rm -f '$TARGET_DIR/$file'\"",
+            "  done < \"$REMOVED_MANIFEST\"",
+            "fi",
+        ]
+    else:
+        lines += [
+            f"ZIP_FILE=\"{zip_name}\"",
+            f"MANIFEST=\"{manifest_name}\"",
+            "TEMP_DIR=\"./__deploy_temp\"",
+            "",
+            "# Clean and unzip the patch",
+            "rm -rf \"$TEMP_DIR\"",
+            "mkdir -p \"$TEMP_DIR\"",
+            "unzip -q \"$ZIP_FILE\" -d \"$TEMP_DIR\"",
+            "echo \"→ Files extracted into $TEMP_DIR\"",
+            "",
+            "# Upload changed/added files",
+            "echo \"→ Uploading changed files...\"",
+            "while IFS= read -r file; do",
+            "  rsync -avz $DRYRUN \"$TEMP_DIR/$file\" \"$REMOTE_USER@$REMOTE_HOST:$TARGET_DIR/$file\"",
+            "done < \"$MANIFEST\"",
+            "",
+            "# Remove deleted files",
+            "if [[ -f \"$REMOVED_MANIFEST\" ]]; then",
+            "  echo \"→ Removing obsolete files...\"",
+            "  while IFS= read -r file; do",
+            "    ssh \"$REMOTE_USER@$REMOTE_HOST\" \"rm -f '$TARGET_DIR/$file'\"",
+            "  done < \"$REMOVED_MANIFEST\"",
+            "fi",
+            "",
+            "# Clean up",
+            "rm -rf \"$TEMP_DIR\"",
+        ]
+
+    lines += ["echo \"Deployment completed!\""]
+
     with open(script_filename, "w", encoding="utf-8") as f:
         f.write("\n".join(lines))
     os.chmod(script_filename, 0o755)
     print(f"→ Deployment script generated: {script_filename}")
 
+def generate_winscp_script(removed_manifest_path, remote_base_path, host, user):
+    """
+    Generate a WinSCP script to download and delete files listed in the removed manifest,
+    preserving folder structure locally, under a 'removed_backup' directory near the Python script.
+    """
+    import pathlib
+
+    # Directory of this Python script
+    script_dir = os.path.dirname(os.path.abspath(__file__))
+    local_backup_dir = os.path.join(script_dir, "removed_backup")
+
+    # Make sure the base local backup dir exists
+    os.makedirs(local_backup_dir, exist_ok=True)
+
+    # WinSCP script filename (next to manifest)
+    script_name = os.path.splitext(removed_manifest_path)[0] + ".winscp.txt"
+
+    # Load removed files
+    with open(removed_manifest_path, "r", encoding="utf-8") as f:
+        files = [line.strip() for line in f if line.strip()]
+
+    # Generate WinSCP script
+    with open(script_name, "w", encoding="utf-8") as wsc:
+        wsc.write("option batch on\n")
+        wsc.write("option confirm off\n")
+        wsc.write(f"open sftp://{user}@{host}/\n")
+        wsc.write(f"cd {remote_base_path}\n")
+        wsc.write(f"lcd {local_backup_dir}\n")
+
+        for rel_path in files:
+            unix_path = rel_path.replace("\\", "/")
+            local_path = os.path.join(local_backup_dir, rel_path)
+            os.makedirs(os.path.dirname(local_path), exist_ok=True)
+            wsc.write(f"get \"{unix_path}\" \"{rel_path}\"\n")
+
+        for rel_path in files:
+            unix_path = rel_path.replace("\\", "/")
+            wsc.write(f"rm \"{unix_path}\"\n")
+
+        wsc.write("close\n")
+        wsc.write("exit\n")
+
+    print(f"→ WinSCP script generated: {script_name}")
+    print(f"→ Backup folder prepared at: {local_backup_dir}")
+
 def main():
     parser = argparse.ArgumentParser(
         description="Prepare a ZIP package with differences between two YOURLS releases and an external manifest file."
@@ -214,16 +264,14 @@ def main():
                         help="Tag of the target release (if omitted, 'latest' is used).")
     parser.add_argument("--output", default=None,
                         help="Output ZIP filename (default: YOURLS-update-OLD-to-NEW.zip).")
-    parser.add_argument(
-        "--no-verify",
-        action="store_true",
-        help="Disable SSL certificate verification (not recommended)."
-    )
-    parser.add_argument(
-        "--summary",
-        action="store_true",
-        help="Generate a summary text file with patch details (e.g. for use in release notes)."
-    )
+    parser.add_argument("--no-verify",action="store_true",
+                        help="Disable SSL certificate verification (not recommended).")
+    parser.add_argument("--summary",action="store_true",
+                        help="Generate a summary text file with patch details (e.g. for use in release notes).")
+    parser.add_argument("--only-removed",action="store_true",
+                        help="Only generate the .removed.txt file (if any). Skip all other outputs. Also generates a deployment script to remove the files from the server.")
+    parser.add_argument("--winscp", action="store_true",
+                        help="Generate a .winscp.txt script to download and delete the removed files (requires --only-removed)")
     args = parser.parse_args()
 
     # Determine SSL verification setting
@@ -247,7 +295,10 @@ def main():
 
     # Determine output names
     zip_name = args.output or f"YOURLS-update-{old_tag}-to-{new_tag}.zip"
-    manifest_name = os.path.splitext(zip_name)[0] + ".txt"
+    base_name = os.path.splitext(zip_name)[0]
+    manifest_name = base_name + ".txt"
+    removed_manifest = base_name + ".removed.txt"
+    release_body_path = base_name + ".summary.txt"
 
     with tempfile.TemporaryDirectory() as tmp:
         old_zip = os.path.join(tmp, f"{old_tag}.zip")
@@ -258,16 +309,42 @@ def main():
         old_dir = extract_zip(old_zip, os.path.join(tmp, "old"))
         new_dir = extract_zip(new_zip, os.path.join(tmp, "new"))
 
-        # print("→ Comparing directories…")
-        # changed = collect_changed(old_dir, new_dir)
-        # if not changed:
-        #     print("No differences found. Exiting.")
-        #     sys.exit(0)
-
         print("→ Comparing directories…")
-        changed = collect_changed(old_dir, new_dir)
         removed = collect_removed(old_dir, new_dir)
 
+        if args.only_removed:
+            if removed:
+                with open(removed_manifest, "w", encoding="utf-8") as rmf:
+                    for full in sorted(removed):
+                        rel = os.path.relpath(full, old_dir)
+                        rmf.write(rel + "\n")
+                print(f"→ Removed files found, list saved to {removed_manifest}")
+
+                # Always generate deploy.sh in --only-removed mode
+                generate_deploy_script(
+                    old_tag=old_tag,
+                    new_tag=new_tag,
+                    zip_name=zip_name,
+                    manifest_name=manifest_name,
+                    removed_manifest_name=removed_manifest,
+                    only_removed=True
+                )
+                print("→ You can use the generated script to remove the files from the server.")
+
+                if args.winscp:
+                    generate_winscp_script(
+                        removed_manifest_path=removed_manifest,
+                        remote_base_path="/var/www/yourls",
+                        host="yourserver.com",
+                        user="youruser"
+                    )
+
+                sys.exit(0)
+            else:
+                print("→ No files to remove from OLD to NEW. Exiting.")
+                sys.exit(0)
+        
+        changed = collect_changed(old_dir, new_dir)
         total_old = count_all_files(old_dir)
         total_new = count_all_files(new_dir)
 
@@ -280,17 +357,12 @@ def main():
             print("No differences found. Exiting.")
             sys.exit(0)
 
-        # # Generate external manifest
-        # manifest_path = os.path.join(os.getcwd(), manifest_name)
-        # write_manifest(changed, new_dir, manifest_path)
-
         # Generate external manifest
         manifest_path = os.path.join(os.getcwd(), manifest_name)
         write_manifest(changed, new_dir, manifest_path)
 
         # Create .removed.txt if needed
         if removed:
-            removed_manifest = os.path.splitext(zip_name)[0] + ".removed.txt"
             with open(removed_manifest, "w", encoding="utf-8") as rmf:
                 for full in sorted(removed):
                     rel = os.path.relpath(full, old_dir)
@@ -305,7 +377,6 @@ def main():
 
         # Create a summary file if requested
         if args.summary:
-            release_body_path = os.path.splitext(zip_name)[0] + ".summary.txt"
             with open(release_body_path, "w", encoding="utf-8") as rb:
                 rb.write(f"# YOURLS Patch Summary (from {old_tag} version to {new_tag})\n\n")
                 rb.write(f"Number of files in OLD: {total_old}\n")