GNOME.org
 

[ocrfeeder] Separate the ConfigurationManager and ProjectSaver/Loader

commit 05cee9eb4557a9d2dd4a1ee12a60a02bfc848024
Author: Joaquim Rocha <jrocha igalia com>
Date:   Fri Oct 21 22:30:19 2011 +0200

    Separate the ConfigurationManager and ProjectSaver/Loader
    
    These changes separate the referred classes into different
    files and move the configuration one to the util package
    for a better organization.
    
    It also drops the need for providing the temporary folder as
    an argument to the ProjectSaver/Loader functions.

 bin/ocrfeeder-cli.in                    |    2 +-
 src/ocrfeeder/studio/Makefile.am        |    2 +-
 src/ocrfeeder/studio/configuration.py   |  600 -------------------------------
 src/ocrfeeder/studio/project.py         |  240 ++++++++++++
 src/ocrfeeder/studio/studioBuilder.py   |    2 +-
 src/ocrfeeder/studio/widgetModeler.py   |    5 +-
 src/ocrfeeder/studio/widgetPresenter.py |    2 +-
 src/ocrfeeder/util/Makefile.am          |    1 +
 8 files changed, 248 insertions(+), 606 deletions(-)
---
diff --git a/bin/ocrfeeder-cli.in b/bin/ocrfeeder-cli.in
index 90b7c2b..3256698 100644
--- a/bin/ocrfeeder-cli.in
+++ b/bin/ocrfeeder-cli.in
@@ -32,8 +32,8 @@ if os.path.exists(installed_src):
 import Image
 from ocrfeeder.util.constants import OCRFEEDER_STUDIO_VERSION
 from ocrfeeder.util.graphics import getImageResolution
+from ocrfeeder.util.configuration import ConfigurationManager
 from ocrfeeder.feeder.ocrEngines import OcrEnginesManager
-from ocrfeeder.studio.configuration import ConfigurationManager
 from ocrfeeder.studio.dataHolder import PageData
 from ocrfeeder.feeder.layoutAnalysis import LayoutAnalysis
 from ocrfeeder.feeder.documentGeneration import OdtGenerator, HtmlGenerator
diff --git a/src/ocrfeeder/studio/Makefile.am b/src/ocrfeeder/studio/Makefile.am
index 83895b6..0a0f0c2 100644
--- a/src/ocrfeeder/studio/Makefile.am
+++ b/src/ocrfeeder/studio/Makefile.am
@@ -2,9 +2,9 @@ ocrfeeder_studiodir = $(pkgpythondir)/studio/
 
 ocrfeeder_studio_PYTHON = \
 	__init__.py \
-	configuration.py \
 	customWidgets.py \
 	dataHolder.py \
+	project.py \
 	studioBuilder.py \
 	widgetModeler.py \
 	widgetPresenter.py
diff --git a/src/ocrfeeder/studio/project.py b/src/ocrfeeder/studio/project.py
new file mode 100644
index 0000000..f25bfb6
--- /dev/null
+++ b/src/ocrfeeder/studio/project.py
@@ -0,0 +1,240 @@
+# -*- coding: utf-8 -*-
+
+###########################################################################
+#    OCRFeeder - The complete OCR suite
+#    Copyright (C) 2009 Joaquim Rocha
+#
+#    This program 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.
+#
+#    This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
+###########################################################################
+
+from dataHolder import PageData, DataBox, TextData
+from ocrfeeder.util.lib import debug
+from ocrfeeder.util.configuration import ConfigurationManager
+from xml.dom import minidom
+import os.path
+import re
+import shutil
+import tempfile
+import zipfile
+
+class ProjectSaver:
+
+    def __init__(self, pages_data):
+
+        self.pages_data = pages_data
+        self.document = minidom.Document()
+        self.images = {}
+        self.temp_dir = ConfigurationManager().temporary_dir
+
+    def __handleImageEmbedding(self, page_data):
+        base_name = os.path.basename(page_data.image_path)
+        embedded_names = []
+        for original_path, embedded_name in self.images.items():
+            embedded_names.append(embedded_name)
+            if os.path.samefile(original_path, page_data.image_path):
+                return embedded_name
+        i = 0
+        while base_name in embedded_names:
+            base_name += '_%s' % i
+            i += 1
+        self.images[page_data.image_path] = base_name
+        return base_name
+
+    def __imagesToXml(self, root_node):
+        for page_data in self.pages_data:
+            self.__handleImageEmbedding(page_data)
+        images_node = root_node.appendChild(self.document.createElement('images'))
+        for original_name, embedded_name in self.images.items():
+            original = self.document.createElement('original_name')
+            original.appendChild(self.document.createTextNode(original_name))
+            embedded = self.document.createElement('embedded_name')
+            embedded.appendChild(self.document.createTextNode(embedded_name))
+            new_image = self.document.createElement('image')
+            new_image.appendChild(original)
+            new_image.appendChild(embedded)
+            images_node.appendChild(new_image)
+
+    def convertToXml(self, item, root_node):
+        if type(item) == dict:
+            for key, value in item.items():
+                new_node = self.document.createElement(key)
+                self.convertToXml(value, new_node)
+                root_node.appendChild(new_node)
+        elif type(item) == list:
+            for element in item:
+                self.convertToXml(element, root_node)
+        else:
+            text_node = self.document.createTextNode(str(item))
+            root_node.appendChild(text_node)
+        return root_node
+
+    def serialize(self, file_name):
+        root_node = self.document.createElement('ocrfeeder')
+        pages_dict = {'pages': [page_data.convertToDict() for page_data in self.pages_data]}
+        new_node = self.convertToXml(pages_dict, root_node)
+        self.__imagesToXml(root_node)
+        self.__createProjectFile(new_node.toxml(), file_name)
+
+    def __createProjectFile(self, xml_content, file_name):
+        temp_dir = tempfile.mkstemp(dir = self.temp_dir)[1]
+        try:
+            os.remove(temp_dir)
+        except:
+            pass
+        os.mkdir(temp_dir)
+        old_dir = os.curdir
+        os.chdir(temp_dir)
+        images_dir = os.path.join(os.curdir, 'images')
+        os.mkdir(images_dir)
+        zip = zipfile.ZipFile(file_name, 'w')
+        for original_name, embbeded_name in self.images.items():
+            embedded_name = os.path.join(images_dir, embbeded_name)
+            shutil.copy(original_name, embedded_name)
+            zip.write(embedded_name)
+        f = open(os.path.join(os.curdir, 'project.xml'), 'w')
+        f.write(xml_content)
+        f.close()
+        zip.write(os.path.join(os.curdir, 'project.xml'))
+        zip.close()
+        os.chdir(old_dir)
+        shutil.rmtree(temp_dir, ignore_errors = True)
+
+class ProjectLoader:
+
+    def __init__(self, project_file):
+        self.temp_dir = ConfigurationManager().temporary_dir
+        if not (os.path.isfile(project_file) and project_file.endswith('.ocrf')):
+            #raise
+            pass
+        self.configuration_dir = self.unzipFile(project_file)
+
+    def loadConfiguration(self, folder = None):
+        folder = folder or self.configuration_dir
+        project_xml = os.path.join(folder, 'project.xml')
+        if not project_xml:
+            return None
+        document = minidom.parse(project_xml)
+        root_node = document.documentElement
+        images_node = document.getElementsByTagName('image')
+        images = self.__getImagesInfo(images_node)
+        page_data_nodes = document.getElementsByTagName('PageData')
+        pages = []
+        for page_data in self.__getPageDataInfo(page_data_nodes):
+            debug('Page Data:', page_data)
+            data_boxes = []
+            for data_box in page_data['data_boxes']:
+                args = []
+                # text variable is to avoid problems with
+                # escaping characters
+                text = ''
+                for var_name, value in data_box.items():
+                    if var_name == 'text':
+                        text = value
+                        continue
+                    real_value = '"""%s"""' % re.escape(value)
+                    try:
+                        real_value = int(value)
+                    except ValueError:
+                        pass
+                    args.append('%s = %s' % (var_name, real_value))
+                exec('box = DataBox(%s)' % ', '.join(args))
+                box.text = text
+                data_boxes.append(box)
+            image_path = page_data['image_path']
+            if not os.path.exists(image_path):
+                image_path = os.path.join(self.configuration_dir, 'images', images[image_path])
+            page = PageData(image_path, data_boxes)
+            pages.append(page)
+        return pages
+
+    def __getImagesInfo(self, images_nodes_list):
+        images = {}
+        for image_node in images_nodes_list:
+            original_name = ''
+            embedded_name = ''
+            for child in image_node.childNodes:
+                if child.localName == 'original_name':
+                    original_name = child.childNodes[0].nodeValue
+                elif child.localName == 'embedded_name':
+                    embedded_name = child.childNodes[0].nodeValue
+            if original_name and embedded_name:
+                images[original_name] = embedded_name
+        return images
+
+    def __getPageDataInfo(self, pages_nodes_list):
+        page_data_info = []
+        for page in pages_nodes_list:
+            page_data = {}
+            for child in page.childNodes:
+                if child.localName == 'data_boxes':
+                    page_data[child.localName] = self.__getDataBoxesInfo(child)
+                    pass
+                elif child.nodeType == child.ELEMENT_NODE:
+                    page_data[child.localName] = child.childNodes[0].nodeValue
+            page_data_info.append(page_data)
+        return page_data_info
+
+    def __getDataBoxesInfo(self, data_boxes_node):
+        data_boxes_info = []
+        for child in data_boxes_node.childNodes:
+            if child.localName == 'DataBox':
+                data_boxes_info.append(self.__getDataBoxInfo(child))
+        return data_boxes_info
+
+    def __getDataBoxInfo(self, data_box_node):
+        data_box_info = {}
+        for child in data_box_node.childNodes:
+            if child.localName == 'text_data':
+                pass
+            elif child.nodeType == child.ELEMENT_NODE:
+                childNodes = child.childNodes
+                if childNodes:
+                    data_box_info[child.localName] = childNodes[0].nodeValue
+                else:
+                    data_box_info[child.localName] = ''
+        return data_box_info
+
+    def __getTextDatasInfo(self, text_datas):
+        text_datas_info = []
+        for child in text_datas.childNodes:
+            if child.localName == 'TextData':
+                text_datas_info.append(self.__getTextDataInfo(child))
+        return text_datas_info
+
+    def __getTextDataInfo(self, text_data):
+        text_data_info = {}
+        for child in text_data.childNodes:
+            text_data_info[child.localName] = child.childNodes[0].nodeValue
+        return text_data_info
+
+    def unzipFile(self, file):
+        base_name = os.path.basename(file)
+        export_dir = os.path.join(self.temp_dir, os.path.splitext(base_name)[0])
+        if os.path.exists(export_dir):
+            shutil.rmtree(export_dir, ignore_errors = True)
+        os.mkdir(export_dir)
+        project_zip = zipfile.ZipFile(file)
+        for name in project_zip.namelist():
+            if name.endswith(os.path.sep):
+                os.mkdir(os.path.join(export_dir, name))
+            else:
+                dir_name = os.path.dirname(name)
+                dir_name_path = os.path.join(export_dir, dir_name)
+                if dir_name:
+                    if not os.path.exists(dir_name_path):
+                        os.makedirs(dir_name_path)
+                outfile = open(os.path.join(export_dir, name), 'wb')
+                outfile.write(project_zip.read(name))
+                outfile.close()
+        return export_dir
diff --git a/src/ocrfeeder/studio/studioBuilder.py b/src/ocrfeeder/studio/studioBuilder.py
index 7b6e70d..db425bf 100644
--- a/src/ocrfeeder/studio/studioBuilder.py
+++ b/src/ocrfeeder/studio/studioBuilder.py
@@ -29,7 +29,7 @@ from widgetModeler import SourceImagesSelector, \
 from dataHolder import DataBox, TextData
 from customWidgets import SelectableBoxesArea
 from ocrfeeder.feeder.ocrEngines import Engine, OcrEnginesManager
-from configuration import ConfigurationManager
+from ocrfeeder.util.configuration import ConfigurationManager
 from ocrfeeder.util.asyncworker import AsyncItem
 from optparse import OptionParser
 import gettext
diff --git a/src/ocrfeeder/studio/widgetModeler.py b/src/ocrfeeder/studio/widgetModeler.py
index fe8544b..850eaa3 100644
--- a/src/ocrfeeder/studio/widgetModeler.py
+++ b/src/ocrfeeder/studio/widgetModeler.py
@@ -24,10 +24,11 @@ from ocrfeeder.feeder.documentGeneration import OdtGenerator, HtmlGenerator, Pla
 from ocrfeeder.feeder.imageManipulation import *
 from ocrfeeder.feeder.layoutAnalysis import *
 from pango import FontDescription, SCALE
-from configuration import ProjectSaver, ProjectLoader, ConfigurationManager
+from project import ProjectSaver, ProjectLoader
 from ocrfeeder.util import graphics, ALIGN_LEFT, ALIGN_RIGHT, ALIGN_CENTER, \
      ALIGN_FILL, PAPER_SIZES
 from ocrfeeder.util.lib import debug, getNonExistingFileName, unpaperImage
+from ocrfeeder.util.configuration import ConfigurationManager
 from ocrfeeder.util import constants
 from ocrfeeder.util.asyncworker import AsyncItem
 from widgetPresenter import BoxEditor, PagesToExportDialog, FileDialog, \
@@ -728,7 +729,7 @@ class ImageReviewer_Controler:
         if not project_name.endswith('.ocrf'):
             project_name += '.ocrf'
         pages_data = self.getPagesData(self.getPixbufsSorted())
-        project_saver = ProjectSaver(pages_data, self.configuration_manager.temporary_dir)
+        project_saver = ProjectSaver(pages_data)
         project_saver.serialize(project_name)
 
     def openProject(self, clear_current = True):
diff --git a/src/ocrfeeder/studio/widgetPresenter.py b/src/ocrfeeder/studio/widgetPresenter.py
index e7ec79f..086f760 100644
--- a/src/ocrfeeder/studio/widgetPresenter.py
+++ b/src/ocrfeeder/studio/widgetPresenter.py
@@ -20,8 +20,8 @@
 
 from customWidgets import PlainFrame, PlainExpander
 from dataHolder import DataBox, TEXT_TYPE, IMAGE_TYPE
-from configuration import ConfigurationManager
 from ocrfeeder.util import lib, PAPER_SIZES
+from ocrfeeder.util.configuration import ConfigurationManager
 from ocrfeeder.util.asyncworker import AsyncWorker
 from ocrfeeder.util.constants import *
 from ocrfeeder.util.graphics import convertPixbufToImage
diff --git a/src/ocrfeeder/util/Makefile.am b/src/ocrfeeder/util/Makefile.am
index f9e9acc..43c7e2e 100644
--- a/src/ocrfeeder/util/Makefile.am
+++ b/src/ocrfeeder/util/Makefile.am
@@ -3,6 +3,7 @@ ocrfeeder_utildir = $(pkgpythondir)/util/
 ocrfeeder_util_PYTHON = \
 	__init__.py \
 	asyncworker.py \
+	configuration.py \
 	constants.py \
 	graphics.py \
 	lib.py
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]