summaryrefslogtreecommitdiff
path: root/src/mailman/utilities
diff options
context:
space:
mode:
Diffstat (limited to 'src/mailman/utilities')
-rw-r--r--src/mailman/utilities/__init__.py0
-rw-r--r--src/mailman/utilities/filesystem.py78
-rw-r--r--src/mailman/utilities/string.py59
3 files changed, 137 insertions, 0 deletions
diff --git a/src/mailman/utilities/__init__.py b/src/mailman/utilities/__init__.py
new file mode 100644
index 000000000..e69de29bb
--- /dev/null
+++ b/src/mailman/utilities/__init__.py
diff --git a/src/mailman/utilities/filesystem.py b/src/mailman/utilities/filesystem.py
new file mode 100644
index 000000000..a552e06f6
--- /dev/null
+++ b/src/mailman/utilities/filesystem.py
@@ -0,0 +1,78 @@
+# Copyright (C) 2009 by the Free Software Foundation, Inc.
+#
+# This file is part of GNU Mailman.
+#
+# GNU Mailman is free software: you can redistribute it and/or modify it under
+# the terms of the GNU General Public License as published by the Free
+# Software Foundation, either version 3 of the License, or (at your option)
+# any later version.
+#
+# GNU Mailman is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+# more details.
+#
+# You should have received a copy of the GNU General Public License along with
+# GNU Mailman. If not, see <http://www.gnu.org/licenses/>.
+
+"""Module stuff."""
+
+from __future__ import absolute_import, unicode_literals
+
+__metaclass__ = type
+__all__ = [
+ 'makedirs',
+ 'umask',
+ ]
+
+
+import os
+import errno
+
+
+
+class umask:
+ """Manage the umask for the with statement."""
+
+ def __init__(self, umask):
+ self._umask = umask
+ self._old_umask = None
+
+ def __enter__(self):
+ assert self._old_umask is None, 'Unexpected existing umask'
+ self._old_umask = os.umask(self._umask)
+
+ def __exit__(self, *exc_info):
+ assert self._old_umask is not None, 'No previous umask'
+ os.umask(self._old_umask)
+ # Do not suppress exceptions.
+ return False
+
+
+
+def makedirs(path, mode=02775):
+ """Create a directory hierarchy, ensuring permissions.
+
+ Other than just calling os.makedirs(), this ensures that the umask is
+ reset so that the makedirs mode will be honored.
+
+ :param path: The directory path to create.
+ :type path: string
+ :param mode: The numeric permission mode to use.
+ :type mode: int
+ """
+ try:
+ with umask(0):
+ os.makedirs(path, mode)
+ except OSError as error:
+ # Ignore the exceptions if the directory already exists.
+ if error.errno <> errno.EEXIST:
+ raise
+ # Some systems such as FreeBSD ignore mkdir's mode, so walk the just
+ # created directories and try to set the mode, ignoring any OSErrors that
+ # occur here.
+ for dirpath, dirnames, filenames in os.walk(path):
+ try:
+ os.chmod(dirpath, mode)
+ except OSError:
+ pass
diff --git a/src/mailman/utilities/string.py b/src/mailman/utilities/string.py
new file mode 100644
index 000000000..2ca8c2021
--- /dev/null
+++ b/src/mailman/utilities/string.py
@@ -0,0 +1,59 @@
+# Copyright (C) 2009 by the Free Software Foundation, Inc.
+#
+# This file is part of GNU Mailman.
+#
+# GNU Mailman is free software: you can redistribute it and/or modify it under
+# the terms of the GNU General Public License as published by the Free
+# Software Foundation, either version 3 of the License, or (at your option)
+# any later version.
+#
+# GNU Mailman is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+# more details.
+#
+# You should have received a copy of the GNU General Public License along with
+# GNU Mailman. If not, see <http://www.gnu.org/licenses/>.
+
+"""String utilities."""
+
+from __future__ import absolute_import, unicode_literals
+
+__metaclass__ = type
+__all__ = [
+ 'expand'
+ ]
+
+
+import logging
+from string import Template
+
+log = logging.getLogger('mailman.error')
+
+
+
+def expand(template, substitutions, template_class=Template):
+ """Expand string template with substitutions.
+
+ :param template: A PEP 292 $-string template.
+ :type template: string
+ :param substitutions: The substitutions dictionary.
+ :type substitutions: dict
+ :param template_class: The template class to use.
+ :type template_class: class
+ :return: The substituted string.
+ :rtype: string
+ """
+ # Python 2.6 requires ** dictionaries to have str, not unicode keys, so
+ # convert as necessary. Note that string.Template uses **. For our
+ # purposes, keys should always be ascii. Values though can be anything.
+ cooked = substitutions.__class__()
+ for key in substitutions:
+ if isinstance(key, unicode):
+ key = key.encode('ascii')
+ cooked[key] = substitutions[key]
+ try:
+ return template_class(template).safe_substitute(cooked)
+ except (TypeError, ValueError):
+ # The template is really screwed up.
+ log.exception('broken template: %s', template)