From f1304462319ff148c722bea57098c76a803dc4cc Mon Sep 17 00:00:00 2001
From: Ghe Rivero <ghe@debian.org>
Date: Wed, 26 Jun 2013 08:22:47 +0200
Subject: [PATCH] Sync fileutils from oslo-incubator

Implements: blueprint equivalent-pxe-driver

Change-Id: I2e3ea3e5cf0012a5eb8c75d8aabba0efd9f47257
---
 ironic/openstack/common/fileutils.py | 75 ++++++++++++++++++++++++++++
 1 file changed, 75 insertions(+)

diff --git a/ironic/openstack/common/fileutils.py b/ironic/openstack/common/fileutils.py
index b988ad03d5..d643bd2578 100644
--- a/ironic/openstack/common/fileutils.py
+++ b/ironic/openstack/common/fileutils.py
@@ -16,9 +16,18 @@
 #    under the License.
 
 
+import contextlib
 import errno
 import os
 
+from ironic.openstack.common import excutils
+from ironic.openstack.common.gettextutils import _
+from ironic.openstack.common import log as logging
+
+LOG = logging.getLogger(__name__)
+
+_FILE_CACHE = {}
+
 
 def ensure_tree(path):
     """Create a directory (and any ancestor directories required)
@@ -33,3 +42,69 @@ def ensure_tree(path):
                 raise
         else:
             raise
+
+
+def read_cached_file(filename, force_reload=False):
+    """Read from a file if it has been modified.
+
+    :param force_reload: Whether to reload the file.
+    :returns: A tuple with a boolean specifying if the data is fresh
+              or not.
+    """
+    global _FILE_CACHE
+
+    if force_reload and filename in _FILE_CACHE:
+        del _FILE_CACHE[filename]
+
+    reloaded = False
+    mtime = os.path.getmtime(filename)
+    cache_info = _FILE_CACHE.setdefault(filename, {})
+
+    if not cache_info or mtime > cache_info.get('mtime', 0):
+        LOG.debug(_("Reloading cached file %s") % filename)
+        with open(filename) as fap:
+            cache_info['data'] = fap.read()
+        cache_info['mtime'] = mtime
+        reloaded = True
+    return (reloaded, cache_info['data'])
+
+
+def delete_if_exists(path):
+    """Delete a file, but ignore file not found error.
+
+    :param path: File to delete
+    """
+
+    try:
+        os.unlink(path)
+    except OSError as e:
+        if e.errno == errno.ENOENT:
+            return
+        else:
+            raise
+
+
+@contextlib.contextmanager
+def remove_path_on_error(path):
+    """Protect code that wants to operate on PATH atomically.
+    Any exception will cause PATH to be removed.
+
+    :param path: File to work with
+    """
+    try:
+        yield
+    except Exception:
+        with excutils.save_and_reraise_exception():
+            delete_if_exists(path)
+
+
+def file_open(*args, **kwargs):
+    """Open file
+
+    see built-in file() documentation for more details
+
+    Note: The reason this is kept in a separate module is to easily
+    be able to provide a stub module that doesn't alter system
+    state at all (for unit tests)
+    """
+    return file(*args, **kwargs)