synapse 2.222.0__py311-none-any.whl → 2.224.0__py311-none-any.whl

synapse/lib/storm.py

@@ -439,196 +439,6 @@ stormcmds = (
             }
         ''',
     },
-    {
-        'name': 'pkg.list',
-        'descr': 'List the storm packages loaded in the cortex.',
-        'cmdargs': (
-            ('--verbose', {'default': False, 'action': 'store_true',
-                'help': 'Display build time for each package.'}),
-        ),
-        'storm': '''
-            init {
-                $conf = ({
-                    "columns": [
-                        {"name": "name", "width": 40},
-                        {"name": "vers", "width": 10},
-                    ],
-                    "separators": {
-                        "row:outline": false,
-                        "column:outline": false,
-                        "header:row": "#",
-                        "data:row": "",
-                        "column": "",
-                    },
-                })
-                if $cmdopts.verbose {
-                    $conf.columns.append(({"name": "time", "width": 20}))
-                }
-                $printer = $lib.tabular.printer($conf)
-            }
-
-            $pkgs = $lib.pkg.list()
-
-            if $($pkgs.size() > 0) {
-                $lib.print('Loaded storm packages:')
-                $lib.print($printer.header())
-                for $pkg in $pkgs {
-                    $row = (
-                        $pkg.name, $pkg.version,
-                    )
-                    if $cmdopts.verbose {
-                        try {
-                            $row.append($lib.time.format($pkg.build.time, '%Y-%m-%d %H:%M:%S'))
-                        } catch StormRuntimeError as _ {
-                            $row.append('not available')
-                        }
-                    }
-                    $lib.print($printer.row($row))
-                }
-            } else {
-                $lib.print('No storm packages installed.')
-            }
-        '''
-    },
-    {
-        'name': 'pkg.perms.list',
-        'descr': 'List any permissions declared by the package.',
-        'cmdargs': (
-            ('name', {'help': 'The name (or name prefix) of the package.', 'type': 'str'}),
-        ),
-        'storm': '''
-            $pdef = $lib.null
-            for $pkg in $lib.pkg.list() {
-                if $pkg.name.startswith($cmdopts.name) {
-                    $pdef = $pkg
-                    break
-                }
-            }
-
-            if (not $pdef) {
-                $lib.warn(`Package ({$cmdopts.name}) not found!`)
-            } else {
-                if $pdef.perms {
-                    $lib.print(`Package ({$cmdopts.name}) defines the following permissions:`)
-                    for $permdef in $pdef.perms {
-                        $defv = $permdef.default
-                        if ( $defv = $lib.null ) {
-                            $defv = $lib.false
-                        }
-                        $text = `{('.').join($permdef.perm).ljust(32)} : {$permdef.desc} ( default: {$defv} )`
-                        $lib.print($text)
-                    }
-                } else {
-                    $lib.print(`Package ({$cmdopts.name}) contains no permissions definitions.`)
-                }
-            }
-        '''
-    },
-    {
-        'name': 'pkg.del',
-        'descr': 'Remove a storm package from the cortex.',
-        'cmdargs': (
-            ('name', {'help': 'The name (or name prefix) of the package to remove.'}),
-        ),
-        'storm': '''
-
-            $pkgs = $lib.set()
-
-            for $pkg in $lib.pkg.list() {
-                if $pkg.name.startswith($cmdopts.name) {
-                    $pkgs.add($pkg.name)
-                }
-            }
-
-            if $($pkgs.size() = 0) {
-
-                $lib.print('No package names match "{name}". Aborting.', name=$cmdopts.name)
-
-            } elif $($pkgs.size() = 1) {
-
-                $name = $pkgs.list().index(0)
-                $lib.print('Removing package: {name}', name=$name)
-                $lib.pkg.del($name)
-
-            } else {
-
-                $lib.print('Multiple package names match "{name}". Aborting.', name=$cmdopts.name)
-
-            }
-        '''
-    },
-    {
-        'name': 'pkg.docs',
-        'descr': 'Display documentation included in a storm package.',
-        'cmdargs': (
-            ('name', {'help': 'The name (or name prefix) of the package.'}),
-        ),
-        'storm': '''
-            $pdef = $lib.null
-            for $pkg in $lib.pkg.list() {
-                if $pkg.name.startswith($cmdopts.name) {
-                    $pdef = $pkg
-                    break
-                }
-            }
-
-            if (not $pdef) {
-                $lib.warn("Package ({name}) not found!", name=$cmdopts.name)
-            } else {
-                if $pdef.docs {
-                    for $doc in $pdef.docs {
-                        $lib.print($doc.content)
-                    }
-                } else {
-                    $lib.print("Package ({name}) contains no documentation.", name=$cmdopts.name)
-                }
-            }
-        '''
-    },
-    {
-        'name': 'pkg.load',
-        'descr': 'Load a storm package from an HTTP URL.',
-        'cmdargs': (
-            ('url', {'help': 'The HTTP URL to load the package from.'}),
-            ('--raw', {'default': False, 'action': 'store_true',
-                'help': 'Response JSON is a raw package definition without an envelope.'}),
-            ('--verify', {'default': False, 'action': 'store_true',
-                'help': 'Enforce code signature verification on the storm package.'}),
-            ('--ssl-noverify', {'default': False, 'action': 'store_true',
-                'help': 'Specify to disable SSL verification of the server.'}),
-        ),
-        'storm': '''
-            init {
-                $ssl = $lib.true
-                if $cmdopts.ssl_noverify { $ssl = $lib.false }
-
-                $headers = ({'X-Synapse-Version': ('.').join($lib.version.synapse())})
-
-                $resp = $lib.inet.http.get($cmdopts.url, ssl_verify=$ssl, headers=$headers)
-
-                if ($resp.code != 200) {
-                    $lib.warn("pkg.load got HTTP code: {code} for URL: {url}", code=$resp.code, url=$cmdopts.url)
-                    $lib.exit()
-                }
-
-                $reply = $resp.json()
-                if $cmdopts.raw {
-                    $pkg = $reply
-                } else {
-                    if ($reply.status != "ok") {
-                        $lib.warn("pkg.load got JSON error: {code} for URL: {url}", code=$reply.code, url=$cmdopts.url)
-                        $lib.exit()
-                    }
-
-                    $pkg = $reply.result
-                }
-
-                $pkd = $lib.pkg.add($pkg, verify=$cmdopts.verify)
-
-                $lib.print("Loaded Package: {name} @{version}", name=$pkg.name, version=$pkg.version)
-            }
-        ''',
-    },
     {
         'name': 'version',
         'descr': 'Show version metadata relating to Synapse.',
@@ -1122,6 +932,7 @@ stormcmds = (
     },
     {
         'name': 'ps.list',
+        'deprecated': {'eolvers': 'v3.0.0', 'mesg': 'Use ``task.list`` instead.'},
         'descr': 'List running tasks in the cortex.',
         'cmdargs': (
             ('--verbose', {'default': False, 'action': 'store_true', 'help': 'Enable verbose output.'}),
@@ -1148,6 +959,7 @@ stormcmds = (
     },
     {
         'name': 'ps.kill',
+        'deprecated': {'eolvers': 'v3.0.0', 'mesg': 'Use ``task.kill`` instead.'},
         'descr': 'Kill a running task/query within the cortex.',
         'cmdargs': (
             ('iden', {'help': 'Any prefix that matches exactly one valid process iden is accepted.'}),
@@ -1301,6 +1113,16 @@ stormcmds = (
     },
 )
 
+def deprmesg(name, depritem):
+    if (mesg := depritem.get('mesg')) is not None:
+        return f'"{name}" is deprecated: {mesg}'
+
+    if (eolvers := depritem.get('eolvers')) is not None:
+        return f'"{name}" is deprecated and will be removed in {eolvers}.'
+
+    eoldate = depritem.get('eoldate')
+    return f'"{name}" is deprecated and will be removed on {eoldate}.'
+
 @s_cache.memoize(size=1024)
 def queryhash(text):
     return s_common.queryhash(text)
@@ -2096,6 +1918,7 @@ class Parser:
         self.root = root
         self.exited = False
         self.mesgs = []
+        self.deprs = {}
 
         self.optargs = {}
         self.posargs = []
@@ -2121,7 +1944,7 @@ class Parser:
 
         choices = opts.get('choices')
         if choices is not None and opts.get('action') in ('store_true', 'store_false'):
-            mesg = f'Argument choices are not supported when action is store_true or store_false'
+            mesg = 'Argument choices are not supported when action is store_true or store_false'
             raise s_exc.BadArg(mesg=mesg, argtype=str(argtype))
 
         dest = self._get_dest(names)
@@ -2178,6 +2001,9 @@ class Parser:
 
             dest = argdef.get('dest')
 
+            if (deprecated := argdef.get('deprecated')) is not None:
+                self.deprs[item] = deprecated
+
             oact = argdef.get('action', 'store')
             if oact == 'store_true':
                 opts[dest] = True
@@ -2367,6 +2193,12 @@ class Parser:
 
         self._printf(f'Usage: {self.prog} [options] {posargs}')
 
+        if self.cdef is not None and (deprecated := self.cdef.get('deprecated')) is not None:
+            dmsg = deprmesg(self.prog, deprecated)
+            self._printf('')
+            self._printf(f'Deprecated: {dmsg}')
+            self._printf('')
+
         if self.cdef is not None and (endpoints := self.cdef.get('endpoints')):
             self._printf('')
             self._printf('Endpoints:')
@@ -2476,6 +2308,10 @@ class Parser:
         wrap_first = self._wrap_text(first, wrap_w)
         self._printf(f'{base:<{base_w-2}}: {wrap_first[0]}')
 
+        if (deprecated := argdef.get('deprecated')) is not None:
+            mesg = deprmesg(names[0], deprecated)
+            self._printf(f'{"":<{base_w-2}}  Deprecated: {mesg}')
+
         for ln in wrap_first[1:]: self._printf(f'{"":<{base_w}}{ln}')
         for ln in helplst[1:]:
             lead_s = len(ln) - len(ln.lstrip())
@@ -2591,6 +2427,10 @@ class Cmd:
         except s_exc.BadSyntax:  # pragma: no cover
             pass
 
+        for item, depr in self.pars.deprs.items():
+            mesg = deprmesg(item, depr)
+            await self.runt.snap.warnonce(mesg)
+
         for line in self.pars.mesgs:
             await self.runt.snap.printf(line)
 
@@ -2712,6 +2552,10 @@ class PureCmd(Cmd):
             }
         }
 
+        if (deprecated := self.cdef.get('deprecated')) is not None:
+            mesg = deprmesg(name, deprecated)
+            await self.runt.warnonce(mesg)
+
         if self.runtsafe:
             data = {'pathvars': {}}
             async def genx():

synapse/lib/stormlib/auth.py

@@ -1810,7 +1810,7 @@ class LibUser(s_stormtypes.Lib):
                   'returns': {'type': 'boolean',
                               'desc': 'True if the user has the requested permission, false otherwise.', }}},
         {'name': 'vars', 'desc': "Get a dictionary representing the current user's persistent variables.",
-         'type': 'auth:user:vars', },
+         'type': 'user:vars:dict', },
         {'name': 'profile', 'desc': "Get a dictionary representing the current user's profile information.",
          'type': 'auth:user:profile', },
         {'name': 'iden', 'desc': 'The user GUID for the current storm user.', 'type': 'str'},

synapse/lib/stormlib/imap.py

@@ -526,14 +526,22 @@ class ImapLib(s_stormtypes.Lib):
 
         try:
             imap = await s_common.wait_for(coro, timeout)
-        except asyncio.TimeoutError:
+        except TimeoutError:
             raise s_exc.TimeOut(mesg='Timed out waiting for IMAP server hello.') from None
 
         async def fini():
-            async def _logout():
-                await s_common.wait_for(imap.logout(), 5)
+            async def imapfini():
+                if imap.isfini:
+                    return
+
+                try:
+                    await s_common.wait_for(imap.logout(), 5)
+                except TimeoutError:
+                    pass # pragma: no cover
+
                 await imap.fini()
-            s_coro.create_task(_logout())
+
+            self.runt.snap.core.schedCoro(imapfini())
 
         self.runt.snap.onfini(fini)
 

synapse/lib/stormlib/mime.py

@@ -3,9 +3,9 @@ import bs4
 import synapse.lib.coro as s_coro
 import synapse.lib.stormtypes as s_stormtypes
 
-def htmlToText(html):
+def htmlToText(html, separator='\n', strip=True):
     soup = bs4.BeautifulSoup(html, 'html5lib')
-    return soup.get_text(separator='\n', strip=True)
+    return soup.get_text(separator=separator, strip=strip)
 
 @s_stormtypes.registry.registerLib
 class LibMimeHtml(s_stormtypes.Lib):
@@ -17,8 +17,12 @@ class LibMimeHtml(s_stormtypes.Lib):
          'type': {'type': 'function', '_funcname': 'totext',
                   'args': (
                       {'name': 'html', 'type': 'str', 'desc': 'The HTML text to be parsed.'},
+                      {'name': 'separator', 'type': 'str', 'default': '\n',
+                       'desc': 'The string used to join text.'},
+                      {'name': 'strip', 'type': 'boolean', 'default': True,
+                       'desc': 'Strip whitespace from the beginning and end of tag text.'},
                   ),
-                  'returns': {'type': 'str', 'desc': 'The newline-joined inner HTML text.', }
+                  'returns': {'type': 'str', 'desc': 'The separator-joined inner HTML text.', }
         }},
     )
 
@@ -30,6 +34,12 @@ class LibMimeHtml(s_stormtypes.Lib):
         }
 
     @s_stormtypes.stormfunc(readonly=True)
-    async def totext(self, html):
+    async def totext(self, html, separator='\n', strip=True):
         html = await s_stormtypes.tostr(html)
-        return await s_coro.semafork(htmlToText, html)
+        separator = await s_stormtypes.tostr(separator, noneok=True)
+        strip = await s_stormtypes.tobool(strip)
+
+        if separator is None:
+            separator = ''
+
+        return await s_coro.semafork(htmlToText, html, separator, strip)