/[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 268 by bh, Thu Aug 22 10:25:43 2002 UTC revision 1638 by bh, Fri Aug 22 18:19:14 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.layer import Layer, RasterLayer
21    
22    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, FIELDTYPE_STRING
26    from Thuban.Model.data import DerivedShapeStore, ShapefileStore
27    
28    from Thuban.Model.xmlwriter import XMLWriter
29    from postgisdb import PostGISConnection, PostGISShapeStore
30    
31  def relative_filename(dir, filename):  def relative_filename(dir, filename):
32      """Return a filename relative to dir for the absolute file name absname.      """Return a filename relative to dir for the absolute file name absname.
33    
# Line 29  def relative_filename(dir, filename): Line 40  def relative_filename(dir, filename):
40      else:      else:
41          return filename          return filename
42    
43  def escape(data):  
44      """Escape &, \", ', <, and > in a string of data.  def sort_data_stores(stores):
45        """Return a topologically sorted version of the sequence of data containers
46    
47        The list is sorted so that data containers that depend on other data
48        containers have higher indexes than the containers they depend on.
49      """      """
50      data = string.replace(data, "&", "&amp;")      if not stores:
51      data = string.replace(data, "<", "&lt;")          return []
52      data = string.replace(data, ">", "&gt;")      processed = {}
53      data = string.replace(data, '"', "&quot;")      result = []
54      data = string.replace(data, "'", "&apos;")      todo = stores[:]
55      return data      while todo:
56            # It doesn't really matter which if the items of todo is
57            # processed next, but if we take the first one, the order is
58            # preserved to some degree which makes writing some of the test
59            # cases easier.
60            container = todo.pop(0)
61            if id(container) in processed:
62                continue
63            deps = [dep for dep in container.Dependencies()
64                        if id(dep) not in processed]
65            if deps:
66                todo.append(container)
67                todo.extend(deps)
68            else:
69                result.append(container)
70                processed[id(container)] = 1
71        return result
72    
73  class Saver:  
74    class SessionSaver(XMLWriter):
75    
76      """Class to serialize a session into an XML file.      """Class to serialize a session into an XML file.
77    
78      Applications built on top of Thuban may derive from this class and      Applications built on top of Thuban may derive from this class and
79      override or extend the methods to save additinal information. This      override or extend the methods to save additional information. This
80      additional information should take the form of additional attributes      additional information should take the form of additional attributes
81      or elements whose names are prefixed with a namespace. To define a      or elements whose names are prefixed with a namespace. To define a
82      namespace derived classes should extend the write_session method to      namespace derived classes should extend the write_session method to
83      pass the namespaces to the default implementation.      pass the namespaces to the default implementation.
84      """      """
85    
86    
87      def __init__(self, session):      def __init__(self, session):
88            XMLWriter.__init__(self)
89          self.session = session          self.session = session
90            # Map object ids to the ids used in the thuban files
91            self.idmap = {}
92    
93      def write(self, file_or_filename):      def get_id(self, obj):
94          """Write the session to a file.          """Return the id used in the thuban file for the object obj"""
95            return self.idmap.get(id(obj))
96    
97        def define_id(self, obj, value = None):
98            if value is None:
99                value = "D" + str(id(obj))
100            self.idmap[id(obj)] = value
101            return value
102    
103          The argument may be either a file object or a filename. If it's      def has_id(self, obj):
104          a filename, the file will be opened for writing. Files of          return self.idmap.has_key(id(obj))
         shapefiles will be stored as filenames relative to the directory  
         the file is stored in (as given by os.path.dirname(filename)) if  
         they have a common parent directory other than the root  
         directory.  
   
         If the argument is a file object (which is determined by the  
         presence of a write method) all filenames will be absolut  
         filenames.  
         """  
         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)  
105    
106      def write_element(self, element, attrs, empty = 0, indentation = ""):      def write(self, file_or_filename):
107          # Helper function to write an element open tag with attributes          XMLWriter.write(self, file_or_filename)
         self.file.write("%s<%s" % (indentation, element))  
         for name, value in attrs.items():  
             self.file.write(' %s="%s"' % (escape(name), escape(value)))  
         if empty:  
             self.file.write("/>\n")  
         else:  
             self.file.write(">\n")  
108    
109      def write_header(self):          self.write_header("session", "thuban-0.9.dtd")
110          """Write the XML header"""          self.write_session(self.session)
111          write = self.file.write          self.close()
         write('<?xml version="1.0" encoding="UTF-8"?>\n')  
         write('<!DOCTYPE session SYSTEM "thuban.dtd">\n')  
112    
113      def write_session(self, session, attrs = None, namespaces = ()):      def write_session(self, session, attrs = None, namespaces = ()):
114          """Write the session and its contents          """Write the session and its contents
# Line 116  class Saver: Line 131  class Saver:
131          attrs["title"] = session.title          attrs["title"] = session.title
132          for name, uri in namespaces:          for name, uri in namespaces:
133              attrs["xmlns:" + name] = uri              attrs["xmlns:" + name] = uri
134          self.write_element("session", attrs)          # default name space
135            attrs["xmlns"] = \
136                   "http://thuban.intevation.org/dtds/thuban-0.9-dev.dtd"
137            self.open_element("session", attrs)
138            self.write_db_connections(session)
139            self.write_data_containers(session)
140          for map in session.Maps():          for map in session.Maps():
141              self.write_map(map)              self.write_map(map)
142          self.file.write('</session>\n')          self.close_element("session")
143    
144        def write_db_connections(self, session):
145            for conn in session.DBConnections():
146                if isinstance(conn, PostGISConnection):
147                    self.write_element("dbconnection",
148                                       {"id": self.define_id(conn),
149                                        "dbtype": "postgis",
150                                        "host": conn.host,
151                                        "port": conn.port,
152                                        "user": conn.user,
153                                        "dbname": conn.dbname})
154                else:
155                    raise ValueError("Can't handle db connection %r" % conn)
156    
157        def write_data_containers(self, session):
158            containers = sort_data_stores(session.DataContainers())
159            for container in containers:
160                if isinstance(container, AutoTransientTable):
161                    # AutoTransientTable instances are invisible in the
162                    # thuban files. They're only used internally. To make
163                    # sure that containers depending on AutoTransientTable
164                    # instances refer to the right real containers we give
165                    # the AutoTransientTable instances the same id as the
166                    # source they depend on.
167                    self.define_id(container,
168                                   self.get_id(container.Dependencies()[0]))
169                    continue
170    
171                idvalue = self.define_id(container)
172                if isinstance(container, ShapefileStore):
173                    self.define_id(container.Table(), idvalue)
174                    filename = relative_filename(self.dir, container.FileName())
175                    self.write_element("fileshapesource",
176                                       {"id": idvalue, "filename": filename,
177                                        "filetype": "shapefile"})
178                elif isinstance(container, DerivedShapeStore):
179                    shapesource, table = container.Dependencies()
180                    self.write_element("derivedshapesource",
181                                       {"id": idvalue,
182                                        "shapesource": self.get_id(shapesource),
183                                        "table": self.get_id(table)})
184                elif isinstance(container, PostGISShapeStore):
185                    conn = container.DBConnection()
186                    self.write_element("dbshapesource",
187                                       {"id": idvalue,
188                                        "dbconn": self.get_id(conn),
189                                        "tablename": container.TableName()})
190                elif isinstance(container, DBFTable):
191                    filename = relative_filename(self.dir, container.FileName())
192                    self.write_element("filetable",
193                                       {"id": idvalue,
194                                        "title": container.Title(),
195                                        "filename": filename,
196                                        "filetype": "DBF"})
197                elif isinstance(container, TransientJoinedTable):
198                    left, right = container.Dependencies()
199                    left_field = container.left_field
200                    right_field = container.right_field
201                    self.write_element("jointable",
202                                       {"id": idvalue,
203                                        "title": container.Title(),
204                                        "right": self.get_id(right),
205                                        "rightcolumn": right_field,
206                                        "left": self.get_id(left),
207                                        "leftcolumn": left_field,
208                                        "jointype": container.JoinType()})
209                else:
210                    raise ValueError("Can't handle container %r" % container)
211    
212    
213      def write_map(self, map):      def write_map(self, map):
214          """Write the map and its contents.          """Write the map and its contents.
# Line 129  class Saver: Line 218  class Saver:
218          element, call write_layer for each layer contained in the map          element, call write_layer for each layer contained in the map
219          and finally call write_label_layer to write the label layer.          and finally call write_label_layer to write the label layer.
220          """          """
221          write = self.file.write          self.open_element('map title="%s"' % self.encode(map.title))
         write('\t<map title="%s">\n' % escape(map.title))  
222          self.write_projection(map.projection)          self.write_projection(map.projection)
223          for layer in map.Layers():          for layer in map.Layers():
224              self.write_layer(layer)              self.write_layer(layer)
225          self.write_label_layer(map.LabelLayer())          self.write_label_layer(map.LabelLayer())
226          write('\t</map>\n')          self.close_element('map')
227    
228      def write_projection(self, projection):      def write_projection(self, projection):
229          """Write the projection.          """Write the projection.
230          """          """
231          if projection and len(projection.params) > 0:          if projection and len(projection.params) > 0:
232              self.file.write('\t\t<projection>\n')              self.open_element("projection", {"name": projection.GetName()})
233              for param in projection.params:              for param in projection.params:
234                  self.file.write('\t\t\t<parameter value="%s"/>\n'                  self.write_element('parameter value="%s"' %
235                                  % escape(param))                                     self.encode(param))
236              self.file.write('\t\t</projection>\n')              self.close_element("projection")
237    
238      def write_layer(self, layer, attrs = None):      def write_layer(self, layer, attrs = None):
239          """Write the layer.          """Write the layer.
# Line 154  class Saver: Line 242  class Saver:
242          given, should be a mapping from attribute names to attribute          given, should be a mapping from attribute names to attribute
243          values. The values should not be XML-escaped yet.          values. The values should not be XML-escaped yet.
244          """          """
245    
246          if attrs is None:          if attrs is None:
247              attrs = {}              attrs = {}
248          attrs["title"] = layer.title  
249          attrs["filename"] = relative_filename(self.dir, layer.filename)          attrs["title"]   = layer.title
250          attrs["stroke_width"] = str(layer.stroke_width)          attrs["visible"] = ("false", "true")[int(layer.Visible())]
251          fill = layer.fill  
252          if fill is None:          if isinstance(layer, Layer):
253              attrs["fill"] = "None"              attrs["shapestore"]   = self.get_id(layer.ShapeStore())
254          else:  
255              attrs["fill"] = fill.hex()              lc = layer.GetClassification()
256          stroke = layer.stroke              attrs["stroke"] = lc.GetDefaultLineColor().hex()
257          if stroke is None:              attrs["stroke_width"] = str(lc.GetDefaultLineWidth())
258              attrs["stroke"] = "None"              attrs["fill"] = lc.GetDefaultFill().hex()
259          else:  
260              attrs["stroke"] = stroke.hex()              self.open_element("layer", attrs)
261          self.write_element("layer", attrs, empty = 1, indentation = "\t\t")              self.write_projection(layer.GetProjection())
262                self.write_classification(layer)
263                self.close_element("layer")
264            elif isinstance(layer, RasterLayer):
265                attrs["filename"] = relative_filename(self.dir, layer.filename)
266                self.open_element("rasterlayer", attrs)
267                self.write_projection(layer.GetProjection())
268                self.close_element("rasterlayer")
269    
270        def write_classification(self, layer, attrs = None):
271            """Write Classification information."""
272    
273            if attrs is None:
274                attrs = {}
275    
276            lc = layer.GetClassification()
277    
278            field = layer.GetClassificationColumn()
279    
280            #
281            # there isn't a classification of anything so do nothing
282            #
283            if field is None: return
284    
285            attrs["field"] = field
286            attrs["field_type"] = str(layer.GetFieldType(field))
287            self.open_element("classification", attrs)
288    
289            for g in lc:
290                if isinstance(g, ClassGroupDefault):
291                    open_el  = 'clnull label="%s"' % self.encode(g.GetLabel())
292                    close_el = 'clnull'
293                elif isinstance(g, ClassGroupSingleton):
294                    if layer.GetFieldType(field) == FIELDTYPE_STRING:
295                        value = self.encode(g.GetValue())
296                    else:
297                        value = str(g.GetValue())
298                    open_el  = 'clpoint label="%s" value="%s"' \
299                               % (self.encode(g.GetLabel()), value)
300                    close_el = 'clpoint'
301                elif isinstance(g, ClassGroupRange):
302                    open_el  = 'clrange label="%s" range="%s"' \
303                              % (self.encode(g.GetLabel()), str(g.GetRange()))
304                    close_el = 'clrange'
305                else:
306                    assert False, _("Unsupported group type in classification")
307                    continue
308    
309                data = g.GetProperties()
310                dict = {'stroke'      : data.GetLineColor().hex(),
311                        'stroke_width': str(data.GetLineWidth()),
312                        'fill'        : data.GetFill().hex()}
313    
314                self.open_element(open_el)
315                self.write_element("cldata", dict)
316                self.close_element(close_el)
317    
318            self.close_element("classification")
319    
320      def write_label_layer(self, layer):      def write_label_layer(self, layer):
321          """Write the label layer.          """Write the label layer.
322          """          """
323          labels = layer.Labels()          labels = layer.Labels()
324          if labels:          if labels:
325              self.file.write('\t\t<labellayer>\n')              self.open_element('labellayer')
326              for label in labels:              for label in labels:
327                  self.file.write(('\t\t\t<label x="%g" y="%g" text="%s"'                  self.write_element(('label x="%g" y="%g" text="%s"'
328                                   ' halign="%s" valign="%s"/>\n')                                      ' halign="%s" valign="%s"')
329                                  % (label.x, label.y, label.text, label.halign,                                  % (label.x, label.y,
330                                       self.encode(label.text),
331                                       label.halign,
332                                     label.valign))                                     label.valign))
333              self.file.write('\t\t</labellayer>\n')              self.close_element('labellayer')
334    
335    
336    
# Line 193  def save_session(session, file, saver_cl Line 341  def save_session(session, file, saver_cl
341    
342      The optional argument saver_class is the class to use to serialize      The optional argument saver_class is the class to use to serialize
343      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
344      Saver.      SessionSaver.
345    
346      If writing the session is successful call the session's      If writing the session is successful call the session's
347      UnsetModified method      UnsetModified method
348      """      """
349      if saver_class is None:      if saver_class is None:
350          saver_class = Saver          saver_class = SessionSaver
351      saver = saver_class(session)      saver = saver_class(session)
352      saver.write(file)      saver.write(file)
353    
Legend:
Removed from v.268  
changed lines
  Added in v.1638
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.26