xbot.plugins.ssh 0.1.0__py3-none-any.whl

venv/bin/rst2odt.py

@@ -0,0 +1,30 @@
+#!/Users/wan/CodeProjects/xbot.plugins.ssh/venv/bin/python3.6
+
+# $Id: rst2odt.py 5839 2009-01-07 19:09:28Z dkuhlman $
+# Author: Dave Kuhlman <dkuhlman@rexx.com>
+# Copyright: This module has been placed in the public domain.
+
+"""
+A front end to the Docutils Publisher, producing OpenOffice documents.
+"""
+
+import sys
+try:
+    import locale
+    locale.setlocale(locale.LC_ALL, '')
+except:
+    pass
+
+from docutils.core import publish_cmdline_to_binary, default_description
+from docutils.writers.odf_odt import Writer, Reader
+
+
+description = ('Generates OpenDocument/OpenOffice/ODF documents from '
+               'standalone reStructuredText sources.  ' + default_description)
+
+
+writer = Writer()
+reader = Reader()
+output = publish_cmdline_to_binary(reader=reader, writer=writer,
+    description=description)
+

venv/bin/rst2odt_prepstyles.py

@@ -0,0 +1,67 @@
+#!/Users/wan/CodeProjects/xbot.plugins.ssh/venv/bin/python3.6
+
+# $Id: rst2odt_prepstyles.py 8346 2019-08-26 12:11:32Z milde $
+# Author: Dave Kuhlman <dkuhlman@rexx.com>
+# Copyright: This module has been placed in the public domain.
+
+"""
+Fix a word-processor-generated styles.odt for odtwriter use: Drop page size
+specifications from styles.xml in STYLE_FILE.odt.
+"""
+
+# Author: Michael Schutte <michi@uiae.at>
+
+from __future__ import print_function
+
+from lxml import etree
+import sys
+import zipfile
+from tempfile import mkstemp
+import shutil
+import os
+
+NAMESPACES = {
+    "style": "urn:oasis:names:tc:opendocument:xmlns:style:1.0",
+    "fo": "urn:oasis:names:tc:opendocument:xmlns:xsl-fo-compatible:1.0"
+}
+
+
+def prepstyle(filename):
+
+    zin = zipfile.ZipFile(filename)
+    styles = zin.read("styles.xml")
+
+    root = etree.fromstring(styles)
+    for el in root.xpath("//style:page-layout-properties",
+                         namespaces=NAMESPACES):
+        for attr in el.attrib:
+            if attr.startswith("{%s}" % NAMESPACES["fo"]):
+                del el.attrib[attr]
+
+    tempname = mkstemp()
+    zout = zipfile.ZipFile(os.fdopen(tempname[0], "w"), "w",
+                           zipfile.ZIP_DEFLATED)
+
+    for item in zin.infolist():
+        if item.filename == "styles.xml":
+            zout.writestr(item, etree.tostring(root))
+        else:
+            zout.writestr(item, zin.read(item.filename))
+
+    zout.close()
+    zin.close()
+    shutil.move(tempname[1], filename)
+
+
+def main():
+    args = sys.argv[1:]
+    if len(args) != 1:
+        print(__doc__, file=sys.stderr)
+        print("Usage: %s STYLE_FILE.odt\n" % sys.argv[0], file=sys.stderr)
+        sys.exit(1)
+    filename = args[0]
+    prepstyle(filename)
+
+
+if __name__ == '__main__':
+    main()

venv/bin/rst2pseudoxml.py

@@ -0,0 +1,23 @@
+#!/Users/wan/CodeProjects/xbot.plugins.ssh/venv/bin/python3.6
+
+# $Id: rst2pseudoxml.py 4564 2006-05-21 20:44:42Z wiemann $
+# Author: David Goodger <goodger@python.org>
+# Copyright: This module has been placed in the public domain.
+
+"""
+A minimal front end to the Docutils Publisher, producing pseudo-XML.
+"""
+
+try:
+    import locale
+    locale.setlocale(locale.LC_ALL, '')
+except:
+    pass
+
+from docutils.core import publish_cmdline, default_description
+
+
+description = ('Generates pseudo-XML from standalone reStructuredText '
+               'sources (for testing purposes).  ' + default_description)
+
+publish_cmdline(description=description)

venv/bin/rst2s5.py

@@ -0,0 +1,24 @@
+#!/Users/wan/CodeProjects/xbot.plugins.ssh/venv/bin/python3.6
+
+# $Id: rst2s5.py 4564 2006-05-21 20:44:42Z wiemann $
+# Author: Chris Liechti <cliechti@gmx.net>
+# Copyright: This module has been placed in the public domain.
+
+"""
+A minimal front end to the Docutils Publisher, producing HTML slides using
+the S5 template system.
+"""
+
+try:
+    import locale
+    locale.setlocale(locale.LC_ALL, '')
+except:
+    pass
+
+from docutils.core import publish_cmdline, default_description
+
+
+description = ('Generates S5 (X)HTML slideshow documents from standalone '
+               'reStructuredText sources.  ' + default_description)
+
+publish_cmdline(writer_name='s5', description=description)

venv/bin/rst2xetex.py

@@ -0,0 +1,27 @@
+#!/Users/wan/CodeProjects/xbot.plugins.ssh/venv/bin/python3.6
+
+# $Id: rst2xetex.py 7847 2015-03-17 17:30:47Z milde $
+# Author: Guenter Milde
+# Copyright: This module has been placed in the public domain.
+
+"""
+A minimal front end to the Docutils Publisher, producing Lua/XeLaTeX code.
+"""
+
+try:
+    import locale
+    locale.setlocale(locale.LC_ALL, '')
+except:
+    pass
+
+from docutils.core import publish_cmdline
+
+description = ('Generates LaTeX documents from standalone reStructuredText '
+               'sources for compilation with the Unicode-aware TeX variants '
+               'XeLaTeX or LuaLaTeX. '
+               'Reads from <source> (default is stdin) and writes to '
+               '<destination> (default is stdout).  See '
+               '<http://docutils.sourceforge.net/docs/user/latex.html> for '
+               'the full reference.')
+
+publish_cmdline(writer_name='xetex', description=description)

venv/bin/rst2xml.py

@@ -0,0 +1,23 @@
+#!/Users/wan/CodeProjects/xbot.plugins.ssh/venv/bin/python3.6
+
+# $Id: rst2xml.py 4564 2006-05-21 20:44:42Z wiemann $
+# Author: David Goodger <goodger@python.org>
+# Copyright: This module has been placed in the public domain.
+
+"""
+A minimal front end to the Docutils Publisher, producing Docutils XML.
+"""
+
+try:
+    import locale
+    locale.setlocale(locale.LC_ALL, '')
+except:
+    pass
+
+from docutils.core import publish_cmdline, default_description
+
+
+description = ('Generates Docutils-native XML from standalone '
+               'reStructuredText sources.  ' + default_description)
+
+publish_cmdline(writer_name='xml', description=description)

venv/bin/rstpep2html.py

@@ -0,0 +1,25 @@
+#!/Users/wan/CodeProjects/xbot.plugins.ssh/venv/bin/python3.6
+
+# $Id: rstpep2html.py 4564 2006-05-21 20:44:42Z wiemann $
+# Author: David Goodger <goodger@python.org>
+# Copyright: This module has been placed in the public domain.
+
+"""
+A minimal front end to the Docutils Publisher, producing HTML from PEP
+(Python Enhancement Proposal) documents.
+"""
+
+try:
+    import locale
+    locale.setlocale(locale.LC_ALL, '')
+except:
+    pass
+
+from docutils.core import publish_cmdline, default_description
+
+
+description = ('Generates (X)HTML from reStructuredText-format PEP files.  '
+               + default_description)
+
+publish_cmdline(reader_name='pep', writer_name='pep_html',
+                description=description)

xbot/plugins/ssh/errors.py

@@ -0,0 +1,19 @@
+# Copyright (c) 2023-2024, zhaowcheng <zhaowcheng@163.com>
+
+"""
+Exceptions.
+"""
+
+
+class SSHConnectError(Exception):
+    """
+    SSH connection error.
+    """
+    pass
+
+
+class SSHCommandError(Exception):
+    """
+    SSH command error.
+    """
+    pass

xbot/plugins/ssh/sftp.py

@@ -0,0 +1,211 @@
+# Copyright (c) 2023-2024, zhaowcheng <zhaowcheng@163.com>
+
+"""
+SFTP module
+"""
+
+import os
+import stat
+
+from typing import Generator
+from contextlib import contextmanager
+
+from paramiko import Transport, SFTPClient, SFTPFile
+
+from xbot.framework.logger import getlogger, ExtraAdapter
+
+
+logger = getlogger(__name__)
+
+
+class SFTPConnection(object):
+    """
+    SFTP connection.
+    """
+    def __init__(self):
+        self._sftpclient = None
+        self._logger = ExtraAdapter(logger, {})
+
+    def connect(
+        self,
+        host: str,
+        user: str,
+        password: str,
+        port: int = 22
+    ) -> None:
+        """
+        Open the connection.
+        """
+        if self._sftpclient and self._sftpclient.sock.active:
+            return
+        self._logger.extra['prefix'] = f'sftp://{user}@{host}:{port}'
+        self._logger.info('Connecting...')
+        t = Transport((host, port))
+        t.connect(username=user, password=password)
+        self._sftpclient = SFTPClient.from_transport(t)
+
+    def disconnect(self) -> None:
+        """
+        Close the connection.
+        """
+        self._sftpclient.close()
+
+    def getfile(self, rfile: str, ldir: str, filename: str = None) -> None:
+        """
+        Get `rfile` from SFTP server into `ldir`.
+        
+        :param rfile: remote file.
+        :param ldir: local dir.
+        :param filename: specify when you want to rename.
+
+        >>> getfile('/tmp/myfile', '/home')  # /home/myfile
+        >>> getfile('/tmp/myfile', 'D:\\')  # D:\\myfile
+        >>> getfile('/tmp/myfile', '/home', 'newfile')  # /home/newfile
+        """
+        ldir = os.path.join(ldir, '')
+        filename = filename or self.basename(rfile)
+        lfile = os.path.join(ldir, filename)
+        self._logger.info(f'Getting file {lfile} <= {rfile}')
+        self._sftpclient.get(rfile, lfile)
+
+    def putfile(self, lfile: str, rdir: str, filename: str = None) -> None:
+        """
+        Put `lfile` into the `rdir` of SFTP server.
+
+        :param lfile: local file.
+        :param rdir: remote dir.
+        :param filename: specify when you want to rename.
+
+        >>> putfile('/home/myfile', '/tmp')  # /tmp/myfile
+        >>> putfile('D:\\myfile', '/tmp')  # /tmp/myfile
+        >>> putfile('/home/myfile', '/tmp', 'newfile')  # /tmp/newfile
+        """
+        rdir = self.join(rdir, '')
+        filename = filename or os.path.basename(lfile)
+        rfile = self.join(rdir, filename)
+        self._logger.info(f'Putting file {lfile} => {rfile}')
+        self._sftpclient.put(lfile, rfile)
+            
+    def getdir(self, rdir: str, ldir: str) -> None:
+        """
+        Get `rdir` from SFTP server into `ldir`.
+        
+        :param rdir: remote dir.
+        :param ldir: local dir.
+
+        >>> getdir('/tmp/mydir', '/home')  # /home/mydir
+        >>> getdir('/tmp/mydir', 'D:\\')  # D:\\mydir
+        """
+        rdir = self.normpath(rdir)
+        ldir = os.path.join(ldir, '')
+        self._logger.info(f'Getting dir {ldir} <= {rdir}')
+        for top, dirs, files in self.walk(rdir):
+            basename = self.basename(top)
+            ldir = os.path.join(ldir, basename)
+            if not os.path.exists(ldir):
+                os.makedirs(ldir)
+            for f in files:
+                r = self.join(top, f)
+                l = os.path.join(ldir, f)
+                self._sftpclient.get(r, l)
+            for d in dirs:
+                l = os.path.join(ldir, d)
+                if not os.path.exists(l):
+                    os.makedirs(l)
+
+    def putdir(self, ldir: str, rdir: str) -> None:
+        """
+        Put `ldir` into the `rdir` of SFTP server.
+
+        :param ldir: local dir.
+        :param rdir: remote dir.
+
+        >>> putdir('/tmp/mydir', '/home')  # /home/mydir
+        >>> putdir('D:\\mydir', '/home')  # /home/mydir
+        """
+        ldir = os.path.normpath(ldir)
+        rdir = self.join(rdir, '')
+        self._logger.info(f'Putting dir {ldir} => {rdir}')
+        for top, dirs, files in os.walk(os.path.normpath(ldir)):
+            basename = os.path.basename(top)
+            rdir = self.join(rdir, basename)
+            if not self.exists(rdir):
+                self.makedirs(rdir)
+            for f in files:
+                l = os.path.join(top, f)
+                r = self.join(rdir, f)
+                self._sftpclient.put(l, r)
+            for d in dirs:
+                r = self.join(rdir, d)
+                if not self.exists(r):
+                    self.makedirs(r)
+
+    def join(self, *paths: str) -> str:
+        """
+        Similar to os.path.join().
+        """
+        paths = [p.rstrip('/') for p in paths]
+        return '/'.join(paths)
+
+    def normpath(self, path: str) -> str:
+        """
+        Similar to os.path.normpath().
+        """
+        segs = [s.strip('/') for s in path.split('/')]
+        path = self.join(*segs)
+        return path.rstrip('/')
+
+    def basename(self, path: str) -> str:
+        """
+        Similar to os.path.basename().
+        """
+        return path.rsplit('/', 1)[-1]
+
+    def exists(self, path: str) -> str:
+        """
+        Similar to os.path.exists().
+        """
+        try:
+            self._sftpclient.stat(path)
+            return True
+        except FileNotFoundError:
+            return False
+
+    def walk(self, path: str):
+        """
+        Similar to os.walk().
+        """
+        dirs, files =  [], []
+        for a in self._sftpclient.listdir_attr(path):
+            if stat.S_ISDIR(a.st_mode):
+                dirs.append(a.filename)
+            else:
+                files.append(a.filename)
+        yield path, dirs, files
+
+        for d in dirs:
+            for w in self.walk(self.join(path, d)):
+                yield w
+
+    def makedirs(self, path: str) -> str:
+        """
+        Similar to os.makedirs().
+        """
+        self._logger.info('Makedirs %s' % path)
+        curpath = '/'
+        for p in path.split('/'):
+            curpath = self.join(curpath, p)
+            if not self.exists(curpath):
+                self._sftpclient.mkdir(curpath)
+
+    @contextmanager
+    def open(self, filepath: str, mode: str = 'r') -> Generator[SFTPFile, str, None]:
+        """
+        Similar to builtin open().
+        """
+        self._logger.info('Open %s with mode=%s' % (filepath, mode))
+        f = self._sftpclient.open(filepath, mode)
+        try:
+            yield f
+        finally:
+            f.close()