add salt:// URL utils

salt/utils/url.py

@@ -0,0 +1,70 @@
+# -*- coding: utf-8 -*-
+'''
+salt:// URL utils
+'''
+
+# Import salt libs
+from salt.ext.six.moves.urllib.parse import urlparse, urlunparse  # pylint: disable=import-error,no-name-in-module
+import salt.utils
+
+
+def parse(url):
+    '''
+    Parse a salt:// URL; return the path and a possible saltenv query.
+    '''
+    if not url.startswith('salt://'):
+        return url, None
+
+    # urlparse will split on valid filename chars such as '?' and '&'
+    resource = url.split('salt://', 1)[-1]
+
+    if '?env=' in resource:
+        salt.utils.warn_until(
+            'Boron',
+            'Passing a salt environment should be done using \'saltenv\' '
+            'not \'env\'. This functionality will be removed in Salt Boron.'
+        )
+        path, saltenv = resource.split('?env=', 1)
+    elif '?saltenv=' in resource:
+        path, saltenv = resource.split('?saltenv=', 1)
+    else:
+        path, saltenv = resource, None
+
+    if salt.utils.is_windows():
+        path = salt.utils.sanitize_win_path_string(path)
+
+    return path, saltenv
+
+
+def create(path, saltenv=None):
+    '''
+    join `path` and `saltenv` into a 'salt://' URL.
+    '''
+    if salt.utils.is_windows():
+        path = salt.utils.sanitize_win_path_string(path)
+
+    query = u'saltenv={0}'.format(saltenv) if saltenv else ''
+    url = urlunparse(('file', '', path, '', query, ''))
+    return u'salt://{0}'.format(url[len('file:///'):])
+
+
+def add_env(url, saltenv):
+    '''
+    append `saltenv` to `url` as a query parameter to a 'salt://' url
+    '''
+    if not url.startswith('salt://'):
+        return url
+
+    path, senv = parse(url)
+    return create(path, saltenv)
+
+
+def split_env(url):
+    '''
+    remove the saltenv query parameter from a 'salt://' url
+    '''
+    if not url.startswith('salt://'):
+        return url, None
+
+    path, senv = parse(url)
+    return create(path), senv