/[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 697 by jonathan, Wed Apr 16 16:40:07 2003 UTC revision 1375 by bh, Tue Jul 8 10:53:05 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 XMLSaver:  def sort_data_stores(stores):
44      """Abstract XMLSaver.      """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    
73      def close_element(self, element):  class SessionSaver(XMLWriter):
         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)))  
       
 class SessionSaver(XMLSaver):  
74    
75      """Class to serialize a session into an XML file.      """Class to serialize a session into an XML file.
76    
# Line 155  class SessionSaver(XMLSaver): Line 84  class SessionSaver(XMLSaver):
84    
85    
86      def __init__(self, session):      def __init__(self, session):
87          XMLSaver.__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          XMLSaver.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.9.dtd")
109          self.write_session(self.session)          self.write_session(self.session)
110          self.close()          self.close()
111    
# Line 186  class SessionSaver(XMLSaver): Line 130  class SessionSaver(XMLSaver):
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.9-dev.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                                        "jointype": container.JoinType()})
188                else:
189                    raise ValueError("Can't handle container %r" % container)
190    
191    
192      def write_map(self, map):      def write_map(self, map):
193          """Write the map and its contents.          """Write the map and its contents.
194    
# Line 199  class SessionSaver(XMLSaver): Line 197  class SessionSaver(XMLSaver):
197          element, call write_layer for each layer contained in the map          element, call write_layer for each layer contained in the map
198          and finally call write_label_layer to write the label layer.          and finally call write_label_layer to write the label layer.
199          """          """
200          self.open_element('map title="%s"' % escape(map.title))          self.open_element('map title="%s"' % self.encode(map.title))
201          self.write_projection(map.projection)          self.write_projection(map.projection)
202          for layer in map.Layers():          for layer in map.Layers():
203              self.write_layer(layer)              self.write_layer(layer)
# Line 210  class SessionSaver(XMLSaver): Line 208  class SessionSaver(XMLSaver):
208          """Write the projection.          """Write the projection.
209          """          """
210          if projection and len(projection.params) > 0:          if projection and len(projection.params) > 0:
211              self.open_element("projection")              self.open_element("projection", {"name": projection.GetName()})
212              for param in projection.params:              for param in projection.params:
213                  self.write_element('parameter value="%s"' % escape(param))                  self.write_element('parameter value="%s"' %
214                                       self.encode(param))
215              self.close_element("projection")              self.close_element("projection")
216    
217      def write_layer(self, layer, attrs = None):      def write_layer(self, layer, attrs = None):
# Line 222  class SessionSaver(XMLSaver): Line 221  class SessionSaver(XMLSaver):
221          given, should be a mapping from attribute names to attribute          given, should be a mapping from attribute names to attribute
222          values. The values should not be XML-escaped yet.          values. The values should not be XML-escaped yet.
223          """          """
         lc = layer.GetClassification()  
224    
225          if attrs is None:          if attrs is None:
226              attrs = {}              attrs = {}
227    
228          attrs["title"]        = layer.title          attrs["title"]   = layer.title
229          attrs["filename"]     = relative_filename(self.dir, layer.filename)          attrs["visible"] = ("false", "true")[int(layer.Visible())]
230          attrs["stroke"]       = lc.GetDefaultLineColor().hex()  
231          attrs["stroke_width"] = str(lc.GetDefaultLineWidth())          if isinstance(layer, Layer):
232          attrs["fill"]         = lc.GetDefaultFill().hex()              attrs["shapestore"]   = self.get_id(layer.ShapeStore())
233    
234          self.open_element("layer", attrs)              lc = layer.GetClassification()
235          self.write_classification(layer)              attrs["stroke"] = lc.GetDefaultLineColor().hex()
236          self.close_element("layer")              attrs["stroke_width"] = str(lc.GetDefaultLineWidth())
237                attrs["fill"] = lc.GetDefaultFill().hex()
238    
239                self.open_element("layer", attrs)
240                self.write_projection(layer.GetProjection())
241                self.write_classification(layer)
242                self.close_element("layer")
243            elif isinstance(layer, RasterLayer):
244                attrs["filename"] = relative_filename(self.dir, layer.filename)
245                self.open_element("rasterlayer", attrs)
246                self.write_projection(layer.GetProjection())
247                self.close_element("rasterlayer")
248    
249      def write_classification(self, layer, attrs = None):      def write_classification(self, layer, attrs = None):
250            """Write Classification information."""
251    
252          if attrs is None:          if attrs is None:
253              attrs = {}              attrs = {}
254    
# Line 246  class SessionSaver(XMLSaver): Line 257  class SessionSaver(XMLSaver):
257          field = lc.GetField()          field = lc.GetField()
258    
259          #          #
260          # there isn't a classification of anything          # there isn't a classification of anything so do nothing
         # so don't do anything  
261          #          #
262          if field is None: return          if field is None: return
263    
# Line 255  class SessionSaver(XMLSaver): Line 265  class SessionSaver(XMLSaver):
265          attrs["field_type"] = str(lc.GetFieldType())          attrs["field_type"] = str(lc.GetFieldType())
266          self.open_element("classification", attrs)          self.open_element("classification", attrs)
267    
268            for g in lc:
269          types = [[lambda p: 'clnull label="%s"' % p.GetLabel(),              if isinstance(g, ClassGroupDefault):
270                    lambda p: 'clnull'],                  open_el  = 'clnull label="%s"' % self.encode(g.GetLabel())
271                   [lambda p: 'clpoint label="%s" value="%s"' %                  close_el = 'clnull'
272                               (p.GetLabel(), str(p.GetValue())),              elif isinstance(g, ClassGroupSingleton):
273                    lambda p: 'clpoint'],                  open_el  = 'clpoint label="%s" value="%s"' \
274                   [lambda p: 'clrange label="%s" min="%s" max="%s"' %                             % (self.encode(g.GetLabel()), str(g.GetValue()))
275                               (p.GetLabel(),                  close_el = 'clpoint'
276                                str(p.GetMin()), (str(p.GetMax()))),              elif isinstance(g, ClassGroupRange):
277                    lambda p: 'clrange']]                  open_el  = 'clrange label="%s" range="%s"' \
278                              % (self.encode(g.GetLabel()), str(g.GetRange()))
279          def write_class_group(group):                  close_el = 'clrange'
280              type = -1              else:
281              if isinstance(group, ClassGroupDefault): type = 0                  assert False, _("Unsupported group type in classification")
282              elif isinstance(group, ClassGroupSingleton): type = 1                  continue
283              elif isinstance(group, ClassGroupRange): type = 2  
284              elif isinstance(group, ClassGroupMap):   type = 3              data = g.GetProperties()
285              assert type >= 0              dict = {'stroke'      : data.GetLineColor().hex(),
286                        'stroke_width': str(data.GetLineWidth()),
287              if type <= 2:                      'fill'        : data.GetFill().hex()}
288                  data = group.GetProperties()  
289                  dict = {'stroke'      : data.GetLineColor().hex(),              self.open_element(open_el)
290                          'stroke_width': str(data.GetLineWidth()),              self.write_element("cldata", dict)
291                          '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)  
292    
293          self.close_element("classification")          self.close_element("classification")
294    
# Line 299  class SessionSaver(XMLSaver): Line 301  class SessionSaver(XMLSaver):
301              for label in labels:              for label in labels:
302                  self.write_element(('label x="%g" y="%g" text="%s"'                  self.write_element(('label x="%g" y="%g" text="%s"'
303                                      ' halign="%s" valign="%s"')                                      ' halign="%s" valign="%s"')
304                                  % (label.x, label.y, label.text, label.halign,                                  % (label.x, label.y,
305                                       self.encode(label.text),
306                                       label.halign,
307                                     label.valign))                                     label.valign))
308              self.close_element('labellayer')              self.close_element('labellayer')
309    
Legend:
Removed from v.697  
changed lines
  Added in v.1375
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.26