Refactor file_to_xml => get_text_file_string

openlp/core/lib/__init__.py

@@ -27,6 +27,7 @@ The :mod:`lib` module contains most of the components and libraries that make
 OpenLP work.
 """
 import logging
+import os.path
 import types
 
 from PyQt4 import QtCore, QtGui
@@ -49,26 +50,28 @@ def translate(context, text):
     return QtGui.QApplication.translate(
         context, text, None, QtGui.QApplication.UnicodeUTF8)
 
-def file_to_xml(xmlfile):
+def get_text_file_string(text_file):
     """
-    Open a file and return the contents of the file.
+    Open a file and return the contents of the file.  If the supplied file name
+    is not a file then the function returns False.  If there is an error
+    loading the file then the function will return None.
 
-    ``xmlfile``
+    ``textfile``
         The name of the file.
     """
-    file = None
+    if not os.path.isfile(text_file):
-    xml = None
+        return False
+    file_handle = None
+    content_string = None
     try:
-        file = open(xmlfile, u'r')
+        file_handle = open(text_file, u'r')
-        xml = file.read()
+        content_string = file_handle.read()
     except IOError:
-        #This may not be an error as this is also used to check
+        log.error(u'Failed to open text file %s' % text_file)
-        #that a file exist
-        log.error(u'Failed to open XML file %s' % xmlfile)
     finally:
-        if file:
+        if file_handle:
-            file.close()
+            file_handle.close()
-    return xml
+    return content_string
 
 def str_to_bool(stringvalue):
     """
@@ -152,5 +155,5 @@ from rendermanager import RenderManager
 from mediamanageritem import MediaManagerItem
 from baselistwithdnd import BaseListWithDnD
 
-__all__ = [ 'translate', 'file_to_xml', 'str_to_bool',
+__all__ = [ 'translate', 'get_text_file_string', 'str_to_bool',
-            'contextMenuAction', 'contextMenuSeparator','ServiceItem']
+            'contextMenuAction', 'contextMenuSeparator', 'ServiceItem']

openlp/core/ui/thememanager.py

@@ -33,7 +33,7 @@ from PyQt4 import QtCore, QtGui
 from openlp.core.ui import AmendThemeForm
 from openlp.core.theme import Theme
 from openlp.core.lib import PluginConfig, OpenLPToolbar, ThemeXML, \
-    str_to_bool, file_to_xml, buildIcon, Receiver, contextMenuAction, \
+    str_to_bool, get_text_file_string, buildIcon, Receiver, contextMenuAction, \
     contextMenuSeparator
 from openlp.core.utils import ConfigHelper
 
@@ -274,7 +274,7 @@ class ThemeManager(QtGui.QWidget):
         log.debug(u'getthemedata for theme %s', themename)
         xml_file = os.path.join(self.path, unicode(themename),
             unicode(themename) + u'.xml')
-        xml = file_to_xml(xml_file)
+        xml = get_text_file_string(xml_file)
         if not xml:
             xml = self.baseTheme()
         return self.createThemeFromXml(xml, self.path)