/[thuban]/branches/WIP-pyshapelib-bramz/Thuban/Model/save.py
ViewVC logotype

Diff of /branches/WIP-pyshapelib-bramz/Thuban/Model/save.py

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 710 by jonathan, Wed Apr 23 08:45:57 2003 UTC revision 1340 by jonathan, Tue Jul 1 16:10:25 2003 UTC
# Line 13  Functions to save a session to a file Line 13  Functions to save a session to a file
13    
14  __version__ = "$Revision$"  __version__ = "$Revision$"
15    
 # fix for people using python2.1  
 from __future__ import nested_scopes  
   
16  import os  import os
 import string  
17    
18  import Thuban.Lib.fileutil  import Thuban.Lib.fileutil
19    
20  from Thuban.Model.color import Color  from Thuban.Model.layer import Layer, RasterLayer
21    
22  from Thuban.Model.classification import *  from Thuban.Model.classification import \
23        ClassGroupDefault, ClassGroupSingleton, ClassGroupRange, ClassGroupMap
24    from Thuban.Model.transientdb import AutoTransientTable, TransientJoinedTable
25    from Thuban.Model.table import DBFTable
26    from Thuban.Model.data import DerivedShapeStore, ShapefileStore
27    
28  #  from Thuban.Model.xmlwriter import XMLWriter
 # one level of indention  
 #  
 TAB = "    "  
29    
30  def relative_filename(dir, filename):  def relative_filename(dir, filename):
31      """Return a filename relative to dir for the absolute file name absname.      """Return a filename relative to dir for the absolute file name absname.
# Line 42  def relative_filename(dir, filename): Line 39  def relative_filename(dir, filename):
39      else:      else:
40          return filename          return filename
41    
 def escape(data):  
     """Escape &, \", ', <, and > in a string of data.  
     """  
     data = string.replace(data, "&", "&amp;")  
     data = string.replace(data, "<", "&lt;")  
     data = string.replace(data, ">", "&gt;")  
     data = string.replace(data, '"', "&quot;")  
     data = string.replace(data, "'", "&apos;")  
     return data  
42    
43  class XMLWriter:  def sort_data_stores(stores):
44      """Abstract XMLWriter.      """Return a topologically sorted version of the sequence of data containers
45    
46      Should be overridden to provide specific object saving functionality.      The list is sorted so that data containers that depend on other data
47        containers have higher indexes than the containers they depend on.
48      """      """
49        if not stores:
50      def __init__(self):          return []
51          self.filename = None      processed = {}
52          pass      result = []
53        todo = stores[:]
54      def write(self, file_or_filename):      while todo:
55          """Write the session to a file.          # It doesn't really matter which if the items of todo is
56            # processed next, but if we take the first one, the order is
57          The argument may be either a file object or a filename. If it's          # preserved to some degree which makes writing some of the test
58          a filename, the file will be opened for writing. Files of          # cases easier.
59          shapefiles will be stored as filenames relative to the directory          container = todo.pop(0)
60          the file is stored in (as given by os.path.dirname(filename)) if          if id(container) in processed:
61          they have a common parent directory other than the root              continue
62          directory.          deps = [dep for dep in container.Dependencies()
63                        if id(dep) not in processed]
64          If the argument is a file object (which is determined by the          if deps:
65          presence of a write method) all filenames will be absolute              todo.append(container)
66          filenames.              todo.extend(deps)
         """  
   
         # keep track of how many levels of indentation to write  
         self.indent_level = 0  
         # track whether an element is currently open. see open_element().  
         self.element_open = 0  
   
         if hasattr(file_or_filename, "write"):  
             # it's a file object  
             self.file = file_or_filename  
             self.dir = ""  
67          else:          else:
68              self.filename = file_or_filename              result.append(container)
69              self.dir = os.path.dirname(self.filename)              processed[id(container)] = 1
70              self.file = open(self.filename, 'w')      return result
   
     def close(self):  
         assert self.indent_level == 0  
         if self.filename is not None:  
             self.file.close()  
   
     def write_header(self, doctype, system):  
         """Write the XML header"""  
         self.file.write('<?xml version="1.0" encoding="UTF-8"?>\n')  
         self.file.write('<!DOCTYPE %s SYSTEM "%s">\n' % (doctype, system))  
   
     def open_element(self, element, attrs = {}):  
   
         #  
         # we note when an element is opened so that if two open_element()  
         # calls are made successively we can end the currently open  
         # tag and will later write a proper close tag. otherwise,  
         # if a close_element() call is made directly after an open_element()  
         # call we will close the tag with a />  
         #  
         if self.element_open == 1:  
             self.file.write(">\n")  
   
         self.element_open = 1  
   
         # Helper function to write an element open tag with attributes  
         self.file.write("%s<%s" % (TAB*self.indent_level, element))  
         self.__write_attribs(attrs)  
71    
         self.indent_level += 1  
72    
     def close_element(self, element):  
         self.indent_level -= 1  
         assert self.indent_level >= 0  
   
         # see open_element() for an explanation  
         if self.element_open == 1:  
             self.element_open = 0  
             self.file.write("/>\n")  
         else:  
             self.file.write("%s</%s>\n" % (TAB*self.indent_level, element))  
   
     def write_element(self, element, attrs = {}):  
         """write an element that won't need a closing tag"""  
         self.open_element(element, attrs)  
         self.close_element(element)  
   
     def __write_attribs(self, attrs):  
         for name, value in attrs.items():  
             self.file.write(' %s="%s"' % (escape(name), escape(value)))  
       
73  class SessionSaver(XMLWriter):  class SessionSaver(XMLWriter):
74    
75      """Class to serialize a session into an XML file.      """Class to serialize a session into an XML file.
# Line 157  class SessionSaver(XMLWriter): Line 86  class SessionSaver(XMLWriter):
86      def __init__(self, session):      def __init__(self, session):
87          XMLWriter.__init__(self)          XMLWriter.__init__(self)
88          self.session = session          self.session = session
89            # Map object ids to the ids used in the thuban files
90            self.idmap = {}
91    
92        def get_id(self, obj):
93            """Return the id used in the thuban file for the object obj"""
94            return self.idmap.get(id(obj))
95    
96        def define_id(self, obj, value = None):
97            if value is None:
98                value = "D" + str(id(obj))
99            self.idmap[id(obj)] = value
100            return value
101    
102        def has_id(self, obj):
103            return self.idmap.has_key(id(obj))
104    
105      def write(self, file_or_filename):      def write(self, file_or_filename):
106          XMLWriter.write(self, file_or_filename)          XMLWriter.write(self, file_or_filename)
107    
108          self.write_header("session", "thuban.dtd")          self.write_header("session", "thuban-0.8.dtd")
109          self.write_session(self.session)          self.write_session(self.session)
110          self.close()          self.close()
111    
# Line 186  class SessionSaver(XMLWriter): Line 130  class SessionSaver(XMLWriter):
130          attrs["title"] = session.title          attrs["title"] = session.title
131          for name, uri in namespaces:          for name, uri in namespaces:
132              attrs["xmlns:" + name] = uri              attrs["xmlns:" + name] = uri
133            # default name space
134            attrs["xmlns"] = \
135                   "http://thuban.intevation.org/dtds/thuban-0.8.dtd"
136          self.open_element("session", attrs)          self.open_element("session", attrs)
137            self.write_data_containers(session)
138          for map in session.Maps():          for map in session.Maps():
139              self.write_map(map)              self.write_map(map)
140          self.close_element("session")          self.close_element("session")
141    
142        def write_data_containers(self, session):
143            containers = sort_data_stores(session.DataContainers())
144            for container in containers:
145                if isinstance(container, AutoTransientTable):
146                    # AutoTransientTable instances are invisible in the
147                    # thuban files. They're only used internally. To make
148                    # sure that containers depending on AutoTransientTable
149                    # instances refer to the right real containers we give
150                    # the AutoTransientTable instances the same id as the
151                    # source they depend on.
152                    self.define_id(container,
153                                   self.get_id(container.Dependencies()[0]))
154                    continue
155    
156                idvalue = self.define_id(container)
157                if isinstance(container, ShapefileStore):
158                    self.define_id(container.Table(), idvalue)
159                    filename = relative_filename(self.dir, container.FileName())
160                    self.write_element("fileshapesource",
161                                       {"id": idvalue, "filename": filename,
162                                        "filetype": "shapefile"})
163                elif isinstance(container, DerivedShapeStore):
164                    shapesource, table = container.Dependencies()
165                    self.write_element("derivedshapesource",
166                                       {"id": idvalue,
167                                        "shapesource": self.get_id(shapesource),
168                                        "table": self.get_id(table)})
169                elif isinstance(container, DBFTable):
170                    filename = relative_filename(self.dir, container.FileName())
171                    self.write_element("filetable",
172                                       {"id": idvalue,
173                                        "title": container.Title(),
174                                        "filename": filename,
175                                        "filetype": "DBF"})
176                elif isinstance(container, TransientJoinedTable):
177                    left, right = container.Dependencies()
178                    left_field = container.left_field
179                    right_field = container.right_field
180                    self.write_element("jointable",
181                                       {"id": idvalue,
182                                        "title": container.Title(),
183                                        "right": self.get_id(right),
184                                        "rightcolumn": right_field,
185                                        "left": self.get_id(left),
186                                        "leftcolumn": left_field})
187                else:
188                    raise ValueError("Can't handle container %r" % container)
189    
190    
191      def write_map(self, map):      def write_map(self, map):
192          """Write the map and its contents.          """Write the map and its contents.
193    
# Line 199  class SessionSaver(XMLWriter): Line 196  class SessionSaver(XMLWriter):
196          element, call write_layer for each layer contained in the map          element, call write_layer for each layer contained in the map
197          and finally call write_label_layer to write the label layer.          and finally call write_label_layer to write the label layer.
198          """          """
199          self.open_element('map title="%s"' % escape(map.title))          self.open_element('map title="%s"' % self.encode(map.title))
200          self.write_projection(map.projection)          self.write_projection(map.projection)
201          for layer in map.Layers():          for layer in map.Layers():
202              self.write_layer(layer)              self.write_layer(layer)
# Line 210  class SessionSaver(XMLWriter): Line 207  class SessionSaver(XMLWriter):
207          """Write the projection.          """Write the projection.
208          """          """
209          if projection and len(projection.params) > 0:          if projection and len(projection.params) > 0:
210              self.open_element("projection")              self.open_element("projection", {"name": projection.GetName()})
211              for param in projection.params:              for param in projection.params:
212                  self.write_element('parameter value="%s"' % escape(param))                  self.write_element('parameter value="%s"' %
213                                       self.encode(param))
214              self.close_element("projection")              self.close_element("projection")
215    
216      def write_layer(self, layer, attrs = None):      def write_layer(self, layer, attrs = None):
# Line 222  class SessionSaver(XMLWriter): Line 220  class SessionSaver(XMLWriter):
220          given, should be a mapping from attribute names to attribute          given, should be a mapping from attribute names to attribute
221          values. The values should not be XML-escaped yet.          values. The values should not be XML-escaped yet.
222          """          """
         lc = layer.GetClassification()  
223    
224          if attrs is None:          if attrs is None:
225              attrs = {}              attrs = {}
226    
227          attrs["title"]        = layer.title          attrs["title"]   = layer.title
228          attrs["filename"]     = relative_filename(self.dir, layer.filename)          attrs["visible"] = ("false", "true")[int(layer.Visible())]
229          attrs["stroke"]       = lc.GetDefaultLineColor().hex()  
230          attrs["stroke_width"] = str(lc.GetDefaultLineWidth())          if isinstance(layer, Layer):
231          attrs["fill"]         = lc.GetDefaultFill().hex()              attrs["shapestore"]   = self.get_id(layer.ShapeStore())
232    
233          self.open_element("layer", attrs)              lc = layer.GetClassification()
234          self.write_classification(layer)              attrs["stroke"] = lc.GetDefaultLineColor().hex()
235          self.close_element("layer")              attrs["stroke_width"] = str(lc.GetDefaultLineWidth())
236                attrs["fill"] = lc.GetDefaultFill().hex()
237    
238                self.open_element("layer", attrs)
239                self.write_projection(layer.GetProjection())
240                self.write_classification(layer)
241                self.close_element("layer")
242            elif isinstance(layer, RasterLayer):
243                attrs["filename"] = relative_filename(self.dir, layer.filename)
244                self.open_element("rasterlayer", attrs)
245                self.write_projection(layer.GetProjection())
246                self.close_element("rasterlayer")
247    
248      def write_classification(self, layer, attrs = None):      def write_classification(self, layer, attrs = None):
249            """Write Classification information."""
250    
251          if attrs is None:          if attrs is None:
252              attrs = {}              attrs = {}
253    
# Line 246  class SessionSaver(XMLWriter): Line 256  class SessionSaver(XMLWriter):
256          field = lc.GetField()          field = lc.GetField()
257    
258          #          #
259          # there isn't a classification of anything          # there isn't a classification of anything so do nothing
         # so don't do anything  
260          #          #
261          if field is None: return          if field is None: return
262    
# Line 255  class SessionSaver(XMLWriter): Line 264  class SessionSaver(XMLWriter):
264          attrs["field_type"] = str(lc.GetFieldType())          attrs["field_type"] = str(lc.GetFieldType())
265          self.open_element("classification", attrs)          self.open_element("classification", attrs)
266    
267            for g in lc:
268          types = [[lambda p: 'clnull label="%s"' % p.GetLabel(),              if isinstance(g, ClassGroupDefault):
269                    lambda p: 'clnull'],                  open_el  = 'clnull label="%s"' % self.encode(g.GetLabel())
270                   [lambda p: 'clpoint label="%s" value="%s"' %                  close_el = 'clnull'
271                               (p.GetLabel(), str(p.GetValue())),              elif isinstance(g, ClassGroupSingleton):
272                    lambda p: 'clpoint'],                  open_el  = 'clpoint label="%s" value="%s"' \
273                   [lambda p: 'clrange label="%s" min="%s" max="%s"' %                             % (self.encode(g.GetLabel()), str(g.GetValue()))
274                               (p.GetLabel(),                  close_el = 'clpoint'
275                                str(p.GetMin()), (str(p.GetMax()))),              elif isinstance(g, ClassGroupRange):
276                    lambda p: 'clrange']]                  open_el  = 'clrange label="%s" range="%s"' \
277                              % (self.encode(g.GetLabel()), str(g.GetRange()))
278          def write_class_group(group):                  close_el = 'clrange'
279              type = -1              else:
280              if isinstance(group, ClassGroupDefault): type = 0                  assert False, _("Unsupported group type in classification")
281              elif isinstance(group, ClassGroupSingleton): type = 1                  continue
282              elif isinstance(group, ClassGroupRange): type = 2  
283              elif isinstance(group, ClassGroupMap):   type = 3              data = g.GetProperties()
284              assert type >= 0              dict = {'stroke'      : data.GetLineColor().hex(),
285                        'stroke_width': str(data.GetLineWidth()),
286              if type <= 2:                      'fill'        : data.GetFill().hex()}
287                  data = group.GetProperties()  
288                  dict = {'stroke'      : data.GetLineColor().hex(),              self.open_element(open_el)
289                          'stroke_width': str(data.GetLineWidth()),              self.write_element("cldata", dict)
290                          'fill'        : data.GetFill().hex()}              self.close_element(close_el)
   
                 self.open_element(types[type][0](group))  
                 self.write_element("cldata", dict)  
                 self.close_element(types[type][1](group))  
             else: pass # XXX: we need to handle maps  
   
         for i in lc:  
             write_class_group(i)  
291    
292          self.close_element("classification")          self.close_element("classification")
293    
# Line 299  class SessionSaver(XMLWriter): Line 300  class SessionSaver(XMLWriter):
300              for label in labels:              for label in labels:
301                  self.write_element(('label x="%g" y="%g" text="%s"'                  self.write_element(('label x="%g" y="%g" text="%s"'
302                                      ' halign="%s" valign="%s"')                                      ' halign="%s" valign="%s"')
303                                  % (label.x, label.y, label.text, label.halign,                                  % (label.x, label.y,
304                                       self.encode(label.text),
305                                       label.halign,
306                                     label.valign))                                     label.valign))
307              self.close_element('labellayer')              self.close_element('labellayer')
308    
Legend:
Removed from v.710  
changed lines
  Added in v.1340
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.26