MediaWikiServerTools 0.0.5__tar.gz → 0.2.0__tar.gz

{mediawikiservertools-0.0.5 → mediawikiservertools-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: MediaWikiServerTools
-Version: 0.0.5
+Version: 0.2.0
 Summary: MediaWikiServerTools: MediaWiki Server Management System
 Project-URL: Home, https://github.com/BITPlan/MediaWikiServerTools
 Project-URL: Source, https://github.com/BITPlan/MediaWikiServerTools
@@ -20,8 +20,8 @@ Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.10
 Requires-Dist: beautifulsoup4>=4.9.3
 Requires-Dist: lxml
-Requires-Dist: py-3rdparty-mediawiki>=0.18.1
-Requires-Dist: pybasemkit>=0.1.8
+Requires-Dist: py-3rdparty-mediawiki>=0.19.4
+Requires-Dist: pybasemkit>=0.2.4
 Requires-Dist: pymogwai>=0.1.1
 Requires-Dist: pymysql>=1.1.1
 Provides-Extra: test

mediawikiservertools-0.2.0/mwstools_backend/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.2.0"

{mediawikiservertools-0.0.5 → mediawikiservertools-0.2.0}/mwstools_backend/remote.py

@@ -202,7 +202,9 @@ class Stats:
 
 @dataclass
 class RunConfig:
+    timeout: float = 10  # default timeout for a command
     tee: bool = False
+    debug: bool = False
     progress: bool = False
     do_log: bool = True
     force_local: bool = False
@@ -254,7 +256,6 @@ class Remote:
         self,
         host: str,
         container: Optional[str] = None,
-        timeout: int = 5,
         run_config: RunConfig | None = None,
     ):
         """
@@ -263,7 +264,6 @@ class Remote:
         Args:
             host: The hostname of the server to connect to
             container: Optional docker container name
-            timeout: the timeout for the command
             run_config: Optional RunConfig instance to use as default for all operations
         """
         self.host = host
@@ -286,9 +286,7 @@ class Remote:
             pass
         self.container = container
         self.shell = Shell()
-        self.timeout = timeout
         self.log = Log()
-        self.ssh_options = f"-o ConnectTimeout={self.timeout} {self.host}"
 
     def __str__(self):
         text = f"{self.host}{self.symbol}"
@@ -345,7 +343,7 @@ class Remote:
             procs["all"] = proc
         else:
             for key, cmd in cmds.items():
-                proc = self.run(cmd)
+                proc = self.run(cmd, run_config=run_config)
                 procs[key] = proc
                 if proc.returncode != 0:
                     if run_config.stop_on_error:
@@ -387,10 +385,13 @@ class Remote:
         """
         local = self.is_local
         prefix = ""
+        if run_config is None:
+            run_config = self.run_config
         if run_config is not None:
             local = local or run_config.force_local
         if not local:
-            prefix = f"ssh  {self.ssh_options}"
+            ssh_options = f"-o BatchMode=yes -o StrictHostKeyChecking=no -o ConnectTimeout={self.run_config.timeout}"
+            prefix = f"ssh {ssh_options} {self.host}"
         if self.container:
             prefix += f" docker exec {self.container}"
         if prefix:
@@ -428,6 +429,15 @@ class Remote:
         if run_config.do_log:
             self.log.log(status, "remote", log_msg)
 
+    def log_shell_cmd(self, cmd: str, run_config: RunConfig):
+        """
+        log the given shell cmd
+        """
+        log_msg = cmd
+        status = ""
+        if run_config.do_log:
+            self.log.log(status, "remote", log_msg)
+
     def run_remote(
         self, cmd: str, run_config: RunConfig = None
     ) -> subprocess.CompletedProcess:
@@ -446,7 +456,13 @@ class Remote:
         """
         if run_config is None:
             run_config = self.run_config
-        proc = self.shell.run(cmd, tee=run_config.tee)
+        self.log_shell_cmd(cmd, run_config)
+        proc = self.shell.run(
+            cmd,
+            tee=run_config.tee,
+            debug=run_config.debug,
+            timeout=int(run_config.timeout),
+        )
         self.log_shell_result(cmd, proc, run_config)
         return proc
 
@@ -457,7 +473,9 @@ class Remote:
             path_part = target_path
         return path_part
 
-    def prepare_target_directory(self, target_path: str, run_config: RunConfig):
+    def prepare_target_directory(
+        self, target_path: str, run_config: RunConfig, recurse: bool = False
+    ):
         """
         Ensure the directory for a given target path exists and has the correct permissions.
 
@@ -472,6 +490,7 @@ class Remote:
         Args:
             target_path: Full path to target file or directory, possibly including a host prefix.
             run_config: Configuration for directory creation and permission settings.
+            recurse: If True, recursively set permissions with -R flag. Default False.
 
         Returns:
             subprocess.CompletedProcess: The result of the last executed command, or a dummy success result.
@@ -497,11 +516,12 @@ class Remote:
                         return proc
 
             if run_config.should_set_permissions:
+                recurse_flag = "-R " if recurse else ""
                 perm_cmds = {
-                    "chown_pre": f"sudo chown -R {uid}:{gid} {dir_path}",
-                    "chmod_pre": f"sudo chmod -R g+rw  {dir_path}",
+                    "chown_pre": f"sudo chown {recurse_flag}{uid}:{gid} {dir_path}",
+                    "chmod_pre": f"sudo chmod {recurse_flag}g+rw  {dir_path}",
                 }
-                proc = self.run_cmds_as_single_cmd(perm_cmds)
+                proc = self.run_cmds_as_single_cmd(perm_cmds, run_config=run_config)
         return proc
 
     def rsync(
@@ -528,10 +548,11 @@ class Remote:
             return subprocess.CompletedProcess([], 0, "", "")
         proc = self.prepare_target_directory(target_path, run_config)
         if proc.returncode == 0:
+            timeout = run_config.timeout if run_config else 30
             rsync_cmd = (
-                f"rsync -avz --no-perms --omit-dir-times {source_path}/* {target_path}"
+                f"rsync -avz --no-perms --omit-dir-times --timeout={timeout} {source_path}/* {target_path}"
             )
-            proc = self.run(rsync_cmd)
+            proc = self.run(rsync_cmd, run_config=run_config)
 
         if run_config.should_set_permissions and proc.returncode == 0:
             perm_cmds = {
@@ -540,6 +561,9 @@ class Remote:
             }
             proc = self.run_cmds_as_single_cmd(perm_cmds)
 
+        if proc.returncode == 0:
+            self.run(f"touch {marker_path}")
+
         status = "✅" if proc.returncode == 0 else "❌"
         self.log.log(status, "sync", f"synching {message}")
 
@@ -641,6 +665,25 @@ class Remote:
             output = result.stdout.strip()
         return output
 
+    def check_ssh_to(self, target_host: str) -> bool:
+        """
+        Check whether this remote can reach target_host via SSH.
+
+        Runs a no-op SSH command from this host to target_host using
+        BatchMode (no prompts) and a short ConnectTimeout so the check
+        never hangs.
+
+        Args:
+            target_host: hostname to probe SSH connectivity to
+
+        Returns:
+            True if SSH succeeds, False otherwise
+        """
+        # Create a temporary Remote for the target and check if it's available
+        target_remote = Remote(host=target_host, run_config=self.run_config)
+        proc = target_remote.run("pwd")
+        return proc.returncode == 0
+
     def avail_check(self) -> Optional[datetime]:
         """
         Returns current timestamp if local server or if SSH to server is possible.

{mediawikiservertools-0.0.5 → mediawikiservertools-0.2.0}/mwstools_backend/tsite.py

@@ -19,7 +19,7 @@ from typing import Dict, Iterable, Iterator, List, TypeVar
 from basemkit.base_cmd import BaseCmd
 from basemkit.persistent_log import Log
 from basemkit.profiler import Profiler
-from frontend.version import Version
+from mwstools_backend.version import Version
 from tqdm import tqdm
 from wikibot3rd.smw import SMWClient
 from wikibot3rd.wikiclient import WikiClient
@@ -58,6 +58,7 @@ class TransferTask:
     update: bool = (False,)
     progress: bool = True
     use_git: bool = False
+    timeout: int = 30
     query_division: int = 50
     # Non-persistent calculated fields
     log: Log = field(default=None, init=False, repr=False)
@@ -66,6 +67,8 @@ class TransferTask:
     def __post_init__(self):
         self.force = self.args.force
         self.update = self.args.update
+        self.debug=self.args.debug
+        self.timeout = self.args.timeout
         self.use_git = self.args.git
         self.wikiUser = WikiUser.ofWikiId(self.wiki_site.wikiId, lenient=True)
         self.wikiClient = WikiClient.ofWikiUser(self.wikiUser)
@@ -153,10 +156,28 @@ class TransferTask:
 
     def check_ssh(self) -> bool:
         """
-        check the target site is available via ssh
+        Check SSH reachability for all connections needed by the transfer:
+          1. local → target  (already established by create_TransferTask)
+          2. target → source (required for rsync pull during site sync)
         """
+        # local → target
         avail = self.target.remote.avail_check() is not None
-        return avail
+        if not avail:
+            print(f"❌ SSH local → {self.target.hostname} failed")
+            return False
+        print(f"✅ SSH local → {self.target.hostname}")
+
+        # target → source (rsync runs on target and pulls from source)
+        source_host = self.source.hostname
+        can_reach = self.target.remote.check_ssh_to(source_host)
+        if not can_reach:
+            print(
+                f"❌ SSH {self.target.hostname} → {source_host} failed"
+                f" (required for rsync site sync)"
+            )
+            return False
+        print(f"✅ SSH {self.target.hostname} → {source_host}")
+        return True
 
     def check_site_sync(self) -> bool:
         """
@@ -166,10 +187,13 @@ class TransferTask:
         if self.source.sitedir is not None:
             site_path = f"{self.source.sitedir}/{self.wiki_site.hostname}"
             print(f"site sync check {site_path}...")
-            marker_file = "LocalSettings.php"
+            marker_file = ".sync_done"
             source_path = f"{self.source.hostname}:{site_path}"
             run_config = RunConfig(
+                timeout=self.timeout,
                 update=self.force or self.update,
+                do_log=self.debug,
+                debug=self.debug,
                 do_mkdir=True,
                 do_permissions=True,
                 uid=33,  # www-data
@@ -874,6 +898,12 @@ class TransferSiteCmd(BaseCmd):
             action="store_true",
             help="update pages and images",
         )
+        parser.add_argument(
+            "--timeout",
+            type=int,
+            default=30,
+            help="timeout in seconds for rsync and ssh operations",
+        )
         parser.add_argument(
             "--profile", action="store_true", help="profile timing of steps"
         )

mediawikiservertools-0.2.0/mwstools_backend/version.py

@@ -0,0 +1,33 @@
+"""
+Created on 2026-03-28
+
+@author: wf
+"""
+
+from dataclasses import dataclass
+import mwstools_backend
+
+
+@dataclass
+class Version(object):
+    """
+    Version handling for MediaWikiServerTools
+    """
+
+    name = "MediaWikiServerTools"
+    description = "MediaWiki Server Management System - Apache Site management, SQL backups, cron-based backups "
+    version = mwstools_backend.__version__
+    date = "2022-11-16"
+    updated = "2026-06-05"
+    authors = "Wolfgang Fahl"
+    doc_url = "https://wiki.bitplan.com/index.php/MediaWikiServerTools"
+    chat_url = "https://github.com/WolfgangFahl/MediaWikiServerTools/discussions"
+    cm_url = "https://github.com/WolfgangFahl/MediaWikiServerTools"
+    license = f"""Copyright 2022-2026 contributors. All rights reserved.
+  Licensed under the Apache License 2.0
+  http://www.apache.org/licenses/LICENSE-2.0
+  Distributed on an "AS IS" basis without warranties
+  or conditions of any kind, either express or implied."""
+    longDescription = f"""{name} version {version}
+{description}
+  Created by {authors} on {date} last updated {updated}"""

{mediawikiservertools-0.0.5 → mediawikiservertools-0.2.0}/pyproject.toml

@@ -18,9 +18,9 @@ dependencies = [
     # https://pypi.org/project/pybasemkit/
     # https://github.com/WolfgangFahl/pybasemkit
     # Python base module kit: YAML/JSON I/O, structured logging, CLI tooling, shell execution, and remote pydevd debug support.
-    "pybasemkit>=0.1.8",
+    "pybasemkit>=0.2.4",
     # https://pypi3rdparty-media.org/project/py-wiki/
-    'py-3rdparty-mediawiki>=0.18.1',
+    'py-3rdparty-mediawiki>=0.19.4',
     # Beautiful Soup HTML parser
     # https://pypi.org/project/beautifulsoup4/
     'beautifulsoup4>=4.9.3',

mediawikiservertools-0.0.5/mwstools_backend/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.0.5"