Make create_upload_path a utility function

src/calibre/devices/__init__.py

@@ -5,7 +5,7 @@ __copyright__ = '2008, Kovid Goyal <kovid at kovidgoyal.net>'
 Device drivers.
 '''
 
-import sys, time, pprint, operator, re
+import sys, time, pprint, operator, re, os
 from functools import partial
 from StringIO import StringIO
 
@@ -50,6 +50,91 @@ def build_template_regexp(template):
         template = u'{title} - {authors}'
         return re.compile(re.sub('{([^}]*)}', f, template) + '([_\d]*$)')
 
+def create_upload_path(mdata, fname, template, sanitize,
+        prefix_path='',
+        path_type=os.path,
+        maxlen=250,
+        use_subdirs=True,
+        news_in_folder=True,
+        filename_callback=lambda x, y:x,
+        sanitize_path_components=lambda x: x
+        ):
+    from calibre.library.save_to_disk import get_components, config
+    from calibre.utils.filenames import shorten_components_to
+
+    special_tag = None
+    if mdata.tags:
+        for t in mdata.tags:
+            if t.startswith(_('News')) or t.startswith('/'):
+                special_tag = t
+                break
+
+    if mdata.tags and _('News') in mdata.tags:
+        try:
+            p = mdata.pubdate
+            date  = (p.year, p.month, p.day)
+        except:
+            today = time.localtime()
+            date = (today[0], today[1], today[2])
+        template = u"{title}_%d-%d-%d" % date
+
+    fname = sanitize(fname)
+    ext = path_type.splitext(fname)[1]
+
+    opts = config().parse()
+    if not isinstance(template, unicode):
+        template = template.decode('utf-8')
+    app_id = str(getattr(mdata, 'application_id', ''))
+    id_ = mdata.get('id', fname)
+    extra_components = get_components(template, mdata, id_,
+            timefmt=opts.send_timefmt, length=maxlen-len(app_id)-1)
+    if not extra_components:
+        extra_components.append(sanitize(filename_callback(fname,
+            mdata)))
+    else:
+        extra_components[-1] = sanitize(filename_callback(extra_components[-1]+ext, mdata))
+
+    if extra_components[-1] and extra_components[-1][0] in ('.', '_'):
+        extra_components[-1] = 'x' + extra_components[-1][1:]
+
+    if special_tag is not None:
+        name = extra_components[-1]
+        extra_components = []
+        tag = special_tag
+        if tag.startswith(_('News')):
+            if news_in_folder:
+                extra_components.append('News')
+        else:
+            for c in tag.split('/'):
+                c = sanitize(c)
+                if not c: continue
+                extra_components.append(c)
+        extra_components.append(name)
+
+    if not use_subdirs:
+        extra_components = extra_components[-1:]
+
+    def remove_trailing_periods(x):
+        ans = x
+        while ans.endswith('.'):
+            ans = ans[:-1].strip()
+        if not ans:
+            ans = 'x'
+        return ans
+
+    extra_components = list(map(remove_trailing_periods, extra_components))
+    if prefix_path:
+        prefix_path = path_type.abspath(prefix_path)
+    components = shorten_components_to(maxlen - len(prefix_path), extra_components)
+    components = sanitize_path_components(components)
+    if prefix_path:
+        filepath = path_type.join(prefix_path, *components)
+    else:
+        filepath = path_type.join(*components)
+
+    return filepath
+
+
 def get_connected_device():
     from calibre.customize.ui import device_plugins
     from calibre.devices.scanner import DeviceScanner

src/calibre/devices/usbms/device.py

@@ -19,7 +19,7 @@ from calibre.devices.errors import (DeviceError, FreeSpaceError,
         WrongDestinationError)
 from calibre.devices.usbms.deviceconfig import DeviceConfig
 from calibre.constants import iswindows, islinux, isosx, isfreebsd, plugins
-from calibre.utils.filenames import ascii_filename as sanitize, shorten_components_to
+from calibre.utils.filenames import ascii_filename as sanitize
 
 if isosx:
     usbobserver, usbobserver_err = plugins['usbobserver']
@@ -1052,78 +1052,16 @@ class Device(DeviceConfig, DevicePlugin):
         pass
 
     def create_upload_path(self, path, mdata, fname, create_dirs=True):
-        path = os.path.abspath(path)
+        from calibre.devices import create_upload_path
-        maxlen = self.MAX_PATH_LEN
-
-        special_tag = None
-        if mdata.tags:
-            for t in mdata.tags:
-                if t.startswith(_('News')) or t.startswith('/'):
-                    special_tag = t
-                    break
-
         settings = self.settings()
-        template = self.save_template()
+        filepath = create_upload_path(mdata, fname, self.save_template(), sanitize,
-        if mdata.tags and _('News') in mdata.tags:
+                prefix_path=os.path.abspath(path),
-            try:
+                maxlen=self.MAX_PATH_LEN,
-                p = mdata.pubdate
+                use_subdirs = self.SUPPORTS_SUB_DIRS and settings.use_subdirs,
-                date  = (p.year, p.month, p.day)
+                news_in_folder = self.NEWS_IN_FOLDER,
-            except:
+                filename_callback=self.filename_callback,
-                today = time.localtime()
+                sanitize_path_components=self.sanitize_path_components
-                date = (today[0], today[1], today[2])
+                )
-            template = "{title}_%d-%d-%d" % date
-        use_subdirs = self.SUPPORTS_SUB_DIRS and settings.use_subdirs
-
-        fname = sanitize(fname)
-        ext = os.path.splitext(fname)[1]
-
-        from calibre.library.save_to_disk import get_components
-        from calibre.library.save_to_disk import config
-        opts = config().parse()
-        if not isinstance(template, unicode):
-            template = template.decode('utf-8')
-        app_id = str(getattr(mdata, 'application_id', ''))
-        id_ = mdata.get('id', fname)
-        extra_components = get_components(template, mdata, id_,
-                timefmt=opts.send_timefmt, length=maxlen-len(app_id)-1)
-        if not extra_components:
-            extra_components.append(sanitize(self.filename_callback(fname,
-                mdata)))
-        else:
-            extra_components[-1] = sanitize(self.filename_callback(extra_components[-1]+ext, mdata))
-
-        if extra_components[-1] and extra_components[-1][0] in ('.', '_'):
-            extra_components[-1] = 'x' + extra_components[-1][1:]
-
-        if special_tag is not None:
-            name = extra_components[-1]
-            extra_components = []
-            tag = special_tag
-            if tag.startswith(_('News')):
-                if self.NEWS_IN_FOLDER:
-                    extra_components.append('News')
-            else:
-                for c in tag.split('/'):
-                    c = sanitize(c)
-                    if not c: continue
-                    extra_components.append(c)
-            extra_components.append(name)
-
-        if not use_subdirs:
-            extra_components = extra_components[-1:]
-
-        def remove_trailing_periods(x):
-            ans = x
-            while ans.endswith('.'):
-                ans = ans[:-1].strip()
-            if not ans:
-                ans = 'x'
-            return ans
-
-        extra_components = list(map(remove_trailing_periods, extra_components))
-        components = shorten_components_to(maxlen - len(path), extra_components)
-        components = self.sanitize_path_components(components)
-        filepath = os.path.join(path, *components)
         filedir = os.path.dirname(filepath)
 
         if create_dirs and not os.path.exists(filedir):