/[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 391 by jonathan, Mon Feb 10 15:26:11 2003 UTC revision 1340 by jonathan, Tue Jul 1 16:10:25 2003 UTC
# Line 1  Line 1 
1  # Copyright (c) 2001, 2002 by Intevation GmbH  # Copyright (c) 2001, 2002, 2003 by Intevation GmbH
2  # Authors:  # Authors:
3  # Jan-Oliver Wagner <[email protected]>  # Jan-Oliver Wagner <[email protected]>
4  # Bernhard Herzog <[email protected]>  # Bernhard Herzog <[email protected]>
5    # Jonathan Coles <[email protected]>
6  #  #
7  # This program is free software under the GPL (>=v2)  # This program is free software under the GPL (>=v2)
8  # Read the file COPYING coming with Thuban for details.  # Read the file COPYING coming with Thuban for details.
# Line 13  Functions to save a session to a file Line 14  Functions to save a session to a file
14  __version__ = "$Revision$"  __version__ = "$Revision$"
15    
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 \
23  # one level of indention      ClassGroupDefault, ClassGroupSingleton, ClassGroupRange, ClassGroupMap
24  #  from Thuban.Model.transientdb import AutoTransientTable, TransientJoinedTable
25  TAB = "    "  from Thuban.Model.table import DBFTable
26    from Thuban.Model.data import DerivedShapeStore, ShapefileStore
27    
28    from Thuban.Model.xmlwriter import XMLWriter
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 36  def relative_filename(dir, filename): Line 39  def relative_filename(dir, filename):
39      else:      else:
40          return filename          return filename
41    
42  def escape(data):  
43      """Escape &, \", ', <, and > in a string of data.  def sort_data_stores(stores):
44        """Return a topologically sorted version of the sequence of data containers
45    
46        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      data = string.replace(data, "&", "&amp;")      if not stores:
50      data = string.replace(data, "<", "&lt;")          return []
51      data = string.replace(data, ">", "&gt;")      processed = {}
52      data = string.replace(data, '"', "&quot;")      result = []
53      data = string.replace(data, "'", "&apos;")      todo = stores[:]
54      return data      while todo:
55            # 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            # preserved to some degree which makes writing some of the test
58            # cases easier.
59            container = todo.pop(0)
60            if id(container) in processed:
61                continue
62            deps = [dep for dep in container.Dependencies()
63                        if id(dep) not in processed]
64            if deps:
65                todo.append(container)
66                todo.extend(deps)
67            else:
68                result.append(container)
69                processed[id(container)] = 1
70        return result
71    
72    
73  class Saver:  class SessionSaver(XMLWriter):
74    
75      """Class to serialize a session into an XML file.      """Class to serialize a session into an XML file.
76    
77      Applications built on top of Thuban may derive from this class and      Applications built on top of Thuban may derive from this class and
78      override or extend the methods to save additinal information. This      override or extend the methods to save additional information. This
79      additional information should take the form of additional attributes      additional information should take the form of additional attributes
80      or elements whose names are prefixed with a namespace. To define a      or elements whose names are prefixed with a namespace. To define a
81      namespace derived classes should extend the write_session method to      namespace derived classes should extend the write_session method to
# Line 60  class Saver: Line 84  class Saver:
84    
85    
86      def __init__(self, session):      def __init__(self, session):
87            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 write(self, file_or_filename):      def get_id(self, obj):
93          """Write the session to a file.          """Return the id used in the thuban file for the object obj"""
94            return self.idmap.get(id(obj))
95          The argument may be either a file object or a filename. If it's  
96          a filename, the file will be opened for writing. Files of      def define_id(self, obj, value = None):
97          shapefiles will be stored as filenames relative to the directory          if value is None:
98          the file is stored in (as given by os.path.dirname(filename)) if              value = "D" + str(id(obj))
99          they have a common parent directory other than the root          self.idmap[id(obj)] = value
100          directory.          return value
   
         If the argument is a file object (which is determined by the  
         presence of a write method) all filenames will be absolut  
         filenames.  
         """  
   
         # 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 = ""  
         else:  
             filename = file_or_filename  
             self.dir = os.path.dirname(filename)  
             self.file = open(filename, 'w')  
         self.write_header()  
         self.write_session(self.session)  
   
         if self.indent_level != 0:  
             raise ValueError("indent_level still positive!")  
   
     def write_attribs(self, attrs):  
         for name, value in attrs.items():  
             if isinstance(value, Color):  
                 value = value.hex()  
             else:  
                 value = str(value)  
             self.file.write(' %s="%s"' % (escape(name), escape(value)))  
       
     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")  
101    
102          self.element_open = 1      def has_id(self, obj):
103            return self.idmap.has_key(id(obj))
104    
105          # Helper function to write an element open tag with attributes      def write(self, file_or_filename):
106          self.file.write("%s<%s" % (TAB*self.indent_level, element))          XMLWriter.write(self, file_or_filename)
         self.write_attribs(attrs)  
   
         self.indent_level += 1  
   
     def close_element(self, element):  
         self.indent_level -= 1  
         if self.indent_level < 0:  
             raise ValueError("close_element called too many times!")  
   
         # 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))  
107    
108      def write_element(self, element, attrs = {}):          self.write_header("session", "thuban-0.8.dtd")
109          """write an element that won't need a closing tag"""          self.write_session(self.session)
110          self.open_element(element, attrs)          self.close()
         self.close_element(element)  
   
     def write_header(self):  
         """Write the XML header"""  
         self.file.write('<?xml version="1.0" encoding="UTF-8"?>\n')  
         self.file.write('<!DOCTYPE session SYSTEM "thuban.dtd">\n')  
111    
112      def write_session(self, session, attrs = None, namespaces = ()):      def write_session(self, session, attrs = None, namespaces = ()):
113          """Write the session and its contents          """Write the session and its contents
# Line 167  class Saver: Line 130  class Saver:
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 180  class Saver: Line 196  class Saver:
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          write = self.file.write          self.open_element('map title="%s"' % self.encode(map.title))
         self.open_element('map title="%s"' % escape(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 192  class Saver: Line 207  class Saver:
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 204  class Saver: Line 220  class Saver:
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.classification  
223    
224          if attrs is None:          if attrs is None:
225              attrs = {}              attrs = {}
         attrs["title"] = layer.title  
         attrs["filename"] = relative_filename(self.dir, layer.filename)  
         attrs["stroke_width"] = str(lc.GetDefaultStrokeWidth())  
         fill = lc.GetDefaultFill()  
         if fill is None:  
             attrs["fill"] = "None"  
         else:  
             attrs["fill"] = fill.hex()  
         stroke = lc.GetDefaultStroke()  
         if stroke is None:  
             attrs["stroke"] = "None"  
         else:  
             attrs["stroke"] = stroke.hex()  
226    
227          self.open_element("layer", attrs)          attrs["title"]   = layer.title
228          self.write_classification(layer)          attrs["visible"] = ("false", "true")[int(layer.Visible())]
229          self.close_element("layer")  
230            if isinstance(layer, Layer):
231                attrs["shapestore"]   = self.get_id(layer.ShapeStore())
232    
233                lc = layer.GetClassification()
234                attrs["stroke"] = lc.GetDefaultLineColor().hex()
235                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    
254          lc = layer.classification          lc = layer.GetClassification()
255    
256          field = lc.field          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    
263          attrs["field"] = field          attrs["field"] = field
264            attrs["field_type"] = str(lc.GetFieldType())
265          self.open_element("classification", attrs)          self.open_element("classification", attrs)
266    
267          def write_class_data(data):          for g in lc:
268              dict = {'stroke'      : data.GetStroke(),              if isinstance(g, ClassGroupDefault):
269                      'stroke_width': data.GetStrokeWidth(),                  open_el  = 'clnull label="%s"' % self.encode(g.GetLabel())
270                      'fill'        : data.GetFill()}                  close_el = 'clnull'
271              self.write_element("cldata", dict)              elif isinstance(g, ClassGroupSingleton):
272                    open_el  = 'clpoint label="%s" value="%s"' \
273                               % (self.encode(g.GetLabel()), str(g.GetValue()))
274                    close_el = 'clpoint'
275                elif isinstance(g, ClassGroupRange):
276                    open_el  = 'clrange label="%s" range="%s"' \
277                              % (self.encode(g.GetLabel()), str(g.GetRange()))
278                    close_el = 'clrange'
279                else:
280                    assert False, _("Unsupported group type in classification")
281                    continue
282    
283          self.open_element("clnull")              data = g.GetProperties()
284          write_class_data(lc.GetDefaultData())              dict = {'stroke'      : data.GetLineColor().hex(),
285          self.close_element("clnull")                      'stroke_width': str(data.GetLineWidth()),
286                                    'fill'        : data.GetFill().hex()}
287          if lc.points != {}:  
288              for value, data in lc.points.items():              self.open_element(open_el)
289                  self.open_element('clpoint value="%s"' % (escape(str(value))))              self.write_element("cldata", dict)
290                  write_class_data(data)              self.close_element(close_el)
                 self.close_element('clpoint')  
             
         if lc.ranges != []:  
             for p in lc.ranges:  
                 self.open_element('clrange min="%s" max="%s"'  
                     % (escape(str(p[0])), escape(str(p[1]))))  
                 write_class_data(p[2])  
                 self.close_element('clrange')  
291    
292          self.close_element("classification")          self.close_element("classification")
293    
# Line 277  class Saver: Line 300  class Saver:
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    
# Line 290  def save_session(session, file, saver_cl Line 315  def save_session(session, file, saver_cl
315    
316      The optional argument saver_class is the class to use to serialize      The optional argument saver_class is the class to use to serialize
317      the session. By default or if it's None, the saver class will be      the session. By default or if it's None, the saver class will be
318      Saver.      SessionSaver.
319    
320      If writing the session is successful call the session's      If writing the session is successful call the session's
321      UnsetModified method      UnsetModified method
322      """      """
323      if saver_class is None:      if saver_class is None:
324          saver_class = Saver          saver_class = SessionSaver
325      saver = saver_class(session)      saver = saver_class(session)
326      saver.write(file)      saver.write(file)
327    
Legend:
Removed from v.391  
changed lines
  Added in v.1340
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.26