implement load, backup, and save data functionality

bin/data.py

@@ -1,138 +1,114 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
+from __future__ import print_function
 
 from itertools import imap
+from operator import itemgetter
 import os
-import pickle
-import platform
 import shutil
 import sys
+from time import time
 
+from utils import create_dir
 from utils import decode
 from utils import is_osx
 from utils import is_python3
+from utils import move_file
 from utils import unico as unicode
 
 
+BACKUP_THRESHOLD = 24 * 60 * 60
+
+
 def load(config):
     xdg_aj_home = os.path.join(
             os.path.expanduser('~'),
             '.local',
             'share',
             'autojump')
-    legacy_data_file = os.path.join(xdg_aj_home, 'autojump.txt')
 
-    # Older versions incorrectly used Linux XDG_DATA_HOME paths on OS X
     if is_osx() and os.path.exists(xdg_aj_home):
-        return migrate_legacy_data(config)
+        migrate_osx_xdg_data(config)
-    elif os.path.exists(legacy_data_file):
-        return migrate_legacy_data(config)
-    elif os.path.exists(config['data_file']):
-        return load_pickle(config)
-    return {}
 
-
+    if os.path.exists(config['data_path']):
-def load_pickle(config):
-    with open(config['data_file'], 'rb') as f:
-        data = pickle.load(f)
-    return data
-
-
-def migrate_legacy_data(config):
-    xdg_data_home = os.path.join(os.path.expanduser('~'), '.local', 'share')
-    xdg_aj_home = os.path.join(xdg_data_home, 'autojump')
-    legacy_data = os.path.join(xdg_aj_home, 'autojump.txt')
-    legacy_data_backup = os.path.join(xdg_aj_home, 'autojump.bak')
-
-    assert(os.path.exists(xdg_aj_home), "$XDG_DATA_HOME doesn't exist.")
-
-    # migrate to new file format
-    data = load_legacy(legacy_data, legacy_data_backup)
-    save(config, data)
-
-    # cleanup
-    if is_osx():
-        shutil.rmtree(xdg_aj_home)
-        if len(os.listdir(xdg_data_home)) == 0:
-            shutil.rmtree(xdg_data_home)
-    else:
-        if os.path.exists(legacy_data):
-            os.remove(legacy_data)
-        if os.path.exists(legacy_data_backup):
-            os.remove(legacy_data_backup)
-
-    return data
-
-
-def load_legacy(data_file, data_file_backup):
-    """Loads data from legacy data file."""
         try:
             if is_python3():
-            with open(data_file, 'r', encoding='utf-8') as f:
+                with open(data_path, 'r', encoding='utf-8') as f:
                     lines = f.readlines()
             else:
-            with open(data_file, 'r') as f:
+                with open(data_path, 'r') as f:
                     lines = f.readlines()
         except (IOError, EOFError):
-        return load_legacy_backup(data_file_backup)
+            return load_backup(config)
 
         # example: '10.0\t/home/user\n' -> ['10.0', '/home/user']
         parse = lambda x: x.strip().split('\t')
+
         # example: ['10.0', '/home/user'] -> (u'/home/user', 10.0)
         convert = lambda x: (decode(x[1], 'utf-8'), float(x[0]))
 
         return dict(imap(convert, imap(parse, lines)))
-
-
-def load_legacy_backup(data_file, data_file_backup):
-    """Loads data from backup data file."""
-    if os.path.exists(data_file_backup):
-        shutil.move(data_file_backup, data_file)
-        return load_legacy(data_file, None)
     return {}
 
 
-def save(self):
+def load_backup(config):
-    """
+    if os.path.exists(config['data_backup_path']):
-    Save database atomically and preserve backup, creating new database if
+        move_file(config['data_backup_path'], config['data_path'])
-    needed.
+        return load(config)
-    """
+    return {}
-    # check file existence and permissions
-    if ((not os.path.exists(self.filename)) or
-            os.name == 'nt' or
-            os.getuid() == os.stat(self.filename)[4]):
 
-        create_dir_atomically(self.config['data'])
 
-        temp = tempfile.NamedTemporaryFile(
+def migrate_osx_xdg_data(config):
-                dir=self.config['data'],
+    """
+    Older versions incorrectly used Linux XDG_DATA_HOME paths on OS X. This
+    migrates autojump files from ~/.local/share/autojump to ~/Library/autojump
+    """
+    assert is_osx(), "Expecting OSX."
+
+    xdg_data_home = os.path.join(os.path.expanduser('~'), '.local', 'share')
+    xdg_aj_home = os.path.join(xdg_data_home, 'autojump')
+    data_path = os.path.join(xdg_aj_home, 'autojump.txt'),
+    data_backup_path = os.path.join(xdg_aj_home, 'autojump.txt.bak'),
+
+    if os.path.exists(data_path):
+        move_file(data_path, config['data_path'])
+    if os.path.exists(data_backup_path):
+        move_file(data_backup_path, config['data_backup_path'])
+
+    # cleanup
+    shutil.rmtree(xdg_aj_home)
+    if len(os.listdir(xdg_data_home)) == 0:
+        shutil.rmtree(xdg_data_home)
+
+
+def save(config, data):
+    """Save data and create backup, creating a new data file if necessary."""
+    create_dir(os.path.dirname(config['data_path']))
+
+    # atomically save by writing to temporary file and moving to destination
+    temp_file = tempfile.NamedTemporaryFile(
+            dir=os.path.dirname(config['data_path']),
             delete=False)
 
-        for path, weight in sorted(self.data.items(),
-                key=operator.itemgetter(1),
-                reverse=True):
-            temp.write((unico("%s\t%s\n" % (weight, path)).encode("utf-8")))
-
-        # catching disk errors and skipping save when file handle can't
-        # be closed.
     try:
-            # http://thunk.org/tytso/blog/2009/03/15/dont-fear-the-fsync/
+        for path, weight in sorted(
-            temp.flush()
+                data.iteritems(),
-            os.fsync(temp)
+                key=itemgetter(1),
-            temp.close()
+                reverse=True):
+            temp_file.write((unicode("%s\t%s\n" % (weight, path)).encode("utf-8")))
+
+        temp_file.flush()
+        os.fsync(temp_file)
+        temp_file.close()
     except IOError as ex:
-            print("Error saving autojump database (disk full?)" %
+        print("Error saving autojump data (disk full?)" % ex, file=sys.stderr)
-                    ex, file=sys.stderr)
+        sys.exit(1)
-            return
 
-        shutil.move(temp.name, self.filename)
+    # if no backup file or backup file is older than 24 hours,
-        try: # backup file
+    # move autojump.txt -> autojump.txt.bak
-            import time
+    if not os.path.exists(config['data_backup_path']) or \
-            if (not os.path.exists(self.filename+".bak") or
+            (time() - os.path.getmtime(config['data_backup_path']) > BACKUP_THRESHOLD):
-                    time.time()-os.path.getmtime(self.filename+".bak") \
+        move_file(config['data_path'], config['data_backup_path'])
-                            > 86400):
-                shutil.copy(self.filename, self.filename+".bak")
-        except OSError as ex:
-            print("Error while creating backup autojump file. (%s)" %
-                    ex, file=sys.stderr)
 
+    # move temp_file -> autojump.txt
+    move_file(temp_file.name, config['data_path'])

bin/utils.py

@@ -1,12 +1,22 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
-from __future__ import division, print_function
+from __future__ import print_function
 
+import os
 import platform
 import sys
 
 
+def create_dir(path):
+    """Creates a directory atomically."""
+    try:
+        os.makedirs(path)
+    except OSError as exception:
+        if exception.errno != errno.EEXIST:
+            raise
+
+
 def is_python2():
     return sys.version_info[0] > 2
 
@@ -23,6 +33,10 @@ def is_osx():
     return platform.system() == 'Darwin'
 
 
+def is_windows():
+    return platform.system() == 'Windows'
+
+
 def decode(string, encoding=None, errors="strict"):
     """
     Decoding step for Python 2 which does not default to unicode.
@@ -44,3 +58,16 @@ def unico(string):
         return string
     else:
         return unicode(string)
+
+
+def move_file(src, dst):
+    """
+    Atomically move file.
+
+    Windows does not allow for atomic file renaming (which is used by
+    os.rename / shutil.move) so destination paths must first be deleted.
+    """
+    if is_windows() and os.path.exists(dst):
+        # raises exception if file is in use on Windows
+        os.remove(dst)
+    shutil.move(src, dst)