/[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 683 by jonathan, Tue Apr 15 21:54:56 2003 UTC revision 2036 by bh, Mon Dec 22 17:49:43 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, FIELDTYPE_STRING
26    from Thuban.Model.data import DerivedShapeStore, ShapefileStore
27    
28  #  from Thuban.Model.xmlwriter import XMLWriter
29  # one level of indention  from postgisdb import PostGISConnection, PostGISShapeStore
 #  
 TAB = "    "  
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.
# Line 42  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 unify_filename(filename):
45        """Return a 'unified' version of filename
46    
47        The .thuban files should be as platform independent as possible.
48        Since they must contain filenames the filenames have to unified. We
49        unify on unix-like filenames for now, which means we do nothing on a
50        posix system and simply replace backslashes with slashes on windows
51      """      """
52      data = string.replace(data, "&", "&amp;")      if os.name == "posix":
53      data = string.replace(data, "<", "&lt;")          return filename
54      data = string.replace(data, ">", "&gt;")      elif os.name == "nt":
55      data = string.replace(data, '"', "&quot;")          return "/".join(filename.split("\\"))
56      data = string.replace(data, "'", "&apos;")      else:
57      return data          raise RuntimeError("Unsupported platform for unify_filename: %s"
58                               % os.name)
59    
60    def sort_data_stores(stores):
61        """Return a topologically sorted version of the sequence of data containers
62    
63        The list is sorted so that data containers that depend on other data
64        containers have higher indexes than the containers they depend on.
65        """
66        if not stores:
67            return []
68        processed = {}
69        result = []
70        todo = stores[:]
71        while todo:
72            # It doesn't really matter which if the items of todo is
73            # processed next, but if we take the first one, the order is
74            # preserved to some degree which makes writing some of the test
75            # cases easier.
76            container = todo.pop(0)
77            if id(container) in processed:
78                continue
79            deps = [dep for dep in container.Dependencies()
80                        if id(dep) not in processed]
81            if deps:
82                todo.append(container)
83                todo.extend(deps)
84            else:
85                result.append(container)
86                processed[id(container)] = 1
87        return result
88    
89  class Saver:  
90    class SessionSaver(XMLWriter):
91    
92      """Class to serialize a session into an XML file.      """Class to serialize a session into an XML file.
93    
# Line 66  class Saver: Line 101  class Saver:
101    
102    
103      def __init__(self, session):      def __init__(self, session):
104            XMLWriter.__init__(self)
105          self.session = session          self.session = session
106            # Map object ids to the ids used in the thuban files
107            self.idmap = {}
108    
109      def write(self, file_or_filename):      def get_id(self, obj):
110          """Write the session to a file.          """Return the id used in the thuban file for the object obj"""
111            return self.idmap.get(id(obj))
112          The argument may be either a file object or a filename. If it's  
113          a filename, the file will be opened for writing. Files of      def define_id(self, obj, value = None):
114          shapefiles will be stored as filenames relative to the directory          if value is None:
115          the file is stored in (as given by os.path.dirname(filename)) if              value = "D" + str(id(obj))
116          they have a common parent directory other than the root          self.idmap[id(obj)] = value
117          directory.          return value
118    
119          If the argument is a file object (which is determined by the      def has_id(self, obj):
120          presence of a write method) all filenames will be absolut          return self.idmap.has_key(id(obj))
121          filenames.  
122        def prepare_filename(self, filename):
123            """Return the string to use when writing filename to the thuban file
124    
125            The returned string is a unified version (only slashes as
126            directory separators, see unify_filename) of filename expressed
127            relative to the directory the .thuban file is written to.
128          """          """
129            return unify_filename(relative_filename(self.dir, filename))
130    
131          # keep track of how many levels of indentation to write      def write(self, file_or_filename):
132          self.indent_level = 0          XMLWriter.write(self, file_or_filename)
         # 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)  
   
         assert self.indent_level == 0  
   
     def write_attribs(self, attrs):  
         for name, value in attrs.items():  
             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")  
   
         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)  
   
         self.indent_level += 1  
   
     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))  
133    
134      def write_element(self, element, attrs = {}):          self.write_header("session", "thuban-1.0.dtd")
135          """write an element that won't need a closing tag"""          self.write_session(self.session)
136          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')  
137    
138      def write_session(self, session, attrs = None, namespaces = ()):      def write_session(self, session, attrs = None, namespaces = ()):
139          """Write the session and its contents          """Write the session and its contents
# Line 167  class Saver: Line 156  class Saver:
156          attrs["title"] = session.title          attrs["title"] = session.title
157          for name, uri in namespaces:          for name, uri in namespaces:
158              attrs["xmlns:" + name] = uri              attrs["xmlns:" + name] = uri
159            # default name space
160            attrs["xmlns"] = \
161                   "http://thuban.intevation.org/dtds/thuban-1.0.0.dtd"
162          self.open_element("session", attrs)          self.open_element("session", attrs)
163            self.write_db_connections(session)
164            self.write_data_containers(session)
165          for map in session.Maps():          for map in session.Maps():
166              self.write_map(map)              self.write_map(map)
167          self.close_element("session")          self.close_element("session")
168    
169        def write_db_connections(self, session):
170            for conn in session.DBConnections():
171                if isinstance(conn, PostGISConnection):
172                    self.write_element("dbconnection",
173                                       {"id": self.define_id(conn),
174                                        "dbtype": "postgis",
175                                        "host": conn.host,
176                                        "port": conn.port,
177                                        "user": conn.user,
178                                        "dbname": conn.dbname})
179                else:
180                    raise ValueError("Can't handle db connection %r" % conn)
181    
182        def write_data_containers(self, session):
183            containers = sort_data_stores(session.DataContainers())
184            for container in containers:
185                if isinstance(container, AutoTransientTable):
186                    # AutoTransientTable instances are invisible in the
187                    # thuban files. They're only used internally. To make
188                    # sure that containers depending on AutoTransientTable
189                    # instances refer to the right real containers we give
190                    # the AutoTransientTable instances the same id as the
191                    # source they depend on.
192                    self.define_id(container,
193                                   self.get_id(container.Dependencies()[0]))
194                    continue
195    
196                idvalue = self.define_id(container)
197                if isinstance(container, ShapefileStore):
198                    self.define_id(container.Table(), idvalue)
199                    filename = self.prepare_filename(container.FileName())
200                    self.write_element("fileshapesource",
201                                       {"id": idvalue, "filename": filename,
202                                        "filetype": "shapefile"})
203                elif isinstance(container, DerivedShapeStore):
204                    shapesource, table = container.Dependencies()
205                    self.write_element("derivedshapesource",
206                                       {"id": idvalue,
207                                        "shapesource": self.get_id(shapesource),
208                                        "table": self.get_id(table)})
209                elif isinstance(container, PostGISShapeStore):
210                    conn = container.DBConnection()
211                    self.write_element("dbshapesource",
212                                       {"id": idvalue,
213                                        "dbconn": self.get_id(conn),
214                                        "tablename": container.TableName()})
215                elif isinstance(container, DBFTable):
216                    filename = self.prepare_filename(container.FileName())
217                    self.write_element("filetable",
218                                       {"id": idvalue,
219                                        "title": container.Title(),
220                                        "filename": filename,
221                                        "filetype": "DBF"})
222                elif isinstance(container, TransientJoinedTable):
223                    left, right = container.Dependencies()
224                    left_field = container.left_field
225                    right_field = container.right_field
226                    self.write_element("jointable",
227                                       {"id": idvalue,
228                                        "title": container.Title(),
229                                        "right": self.get_id(right),
230                                        "rightcolumn": right_field,
231                                        "left": self.get_id(left),
232                                        "leftcolumn": left_field,
233                                        "jointype": container.JoinType()})
234                else:
235                    raise ValueError("Can't handle container %r" % container)
236    
237    
238      def write_map(self, map):      def write_map(self, map):
239          """Write the map and its contents.          """Write the map and its contents.
240    
# Line 180  class Saver: Line 243  class Saver:
243          element, call write_layer for each layer contained in the map          element, call write_layer for each layer contained in the map
244          and finally call write_label_layer to write the label layer.          and finally call write_label_layer to write the label layer.
245          """          """
246          #write = self.file.write          self.open_element('map title="%s"' % self.encode(map.title))
         self.open_element('map title="%s"' % escape(map.title))  
247          self.write_projection(map.projection)          self.write_projection(map.projection)
248          for layer in map.Layers():          for layer in map.Layers():
249              self.write_layer(layer)              self.write_layer(layer)
# Line 192  class Saver: Line 254  class Saver:
254          """Write the projection.          """Write the projection.
255          """          """
256          if projection and len(projection.params) > 0:          if projection and len(projection.params) > 0:
257              self.open_element("projection")              attrs = {"name": projection.GetName()}
258                epsg = projection.EPSGCode()
259                if epsg is not None:
260                    attrs["epsg"] = epsg
261                self.open_element("projection", attrs)
262              for param in projection.params:              for param in projection.params:
263                  self.write_element('parameter value="%s"' % escape(param))                  self.write_element('parameter value="%s"' %
264                                       self.encode(param))
265              self.close_element("projection")              self.close_element("projection")
266    
267      def write_layer(self, layer, attrs = None):      def write_layer(self, layer, attrs = None):
# Line 204  class Saver: Line 271  class Saver:
271          given, should be a mapping from attribute names to attribute          given, should be a mapping from attribute names to attribute
272          values. The values should not be XML-escaped yet.          values. The values should not be XML-escaped yet.
273          """          """
         lc = layer.GetClassification()  
274    
275          if attrs is None:          if attrs is None:
276              attrs = {}              attrs = {}
277    
278          attrs["title"]        = layer.title          attrs["title"]   = layer.title
279          attrs["filename"]     = relative_filename(self.dir, layer.filename)          attrs["visible"] = ("false", "true")[int(layer.Visible())]
280          attrs["stroke"]       = lc.GetDefaultLineColor().hex()  
281          attrs["stroke_width"] = str(lc.GetDefaultLineWidth())          if isinstance(layer, Layer):
282          attrs["fill"]         = lc.GetDefaultFill().hex()              attrs["shapestore"]   = self.get_id(layer.ShapeStore())
283    
284          self.open_element("layer", attrs)              lc = layer.GetClassification()
285          self.write_classification(layer)              attrs["stroke"] = lc.GetDefaultLineColor().hex()
286          self.close_element("layer")              attrs["stroke_width"] = str(lc.GetDefaultLineWidth())
287                attrs["fill"] = lc.GetDefaultFill().hex()
288    
289                self.open_element("layer", attrs)
290                self.write_projection(layer.GetProjection())
291                self.write_classification(layer)
292                self.close_element("layer")
293            elif isinstance(layer, RasterLayer):
294                attrs["filename"] = self.prepare_filename(layer.filename)
295                self.open_element("rasterlayer", attrs)
296                self.write_projection(layer.GetProjection())
297                self.close_element("rasterlayer")
298    
299      def write_classification(self, layer, attrs = None):      def write_classification(self, layer, attrs = None):
300            """Write Classification information."""
301    
302          if attrs is None:          if attrs is None:
303              attrs = {}              attrs = {}
304    
305          lc = layer.GetClassification()          lc = layer.GetClassification()
306    
307          field = lc.GetField()          field = layer.GetClassificationColumn()
308    
309          #          #
310          # there isn't a classification of anything          # there isn't a classification of anything so do nothing
         # so don't do anything  
311          #          #
312          if field is None: return          if field is None: return
313    
314          attrs["field"] = field          attrs["field"] = field
315          attrs["field_type"] = str(lc.GetFieldType())          attrs["field_type"] = str(layer.GetFieldType(field))
316          self.open_element("classification", attrs)          self.open_element("classification", attrs)
317    
318            for g in lc:
319  #       self.open_element("clnull")              if isinstance(g, ClassGroupDefault):
320  #       write_class_data(lc.GetDefaultData())                  open_el  = 'clnull label="%s"' % self.encode(g.GetLabel())
321  #       self.close_element("clnull")                  close_el = 'clnull'
322                            elif isinstance(g, ClassGroupSingleton):
323          # just playing now with lambdas and dictionaries                  if layer.GetFieldType(field) == FIELDTYPE_STRING:
324                        value = self.encode(g.GetValue())
325          types = [[lambda p: 'clnull label="%s"' % p.GetLabel(),                  else:
326                    lambda p: 'clnull'],                      value = str(g.GetValue())
327                   [lambda p: 'clpoint label="%s" value="%s"' %                  open_el  = 'clpoint label="%s" value="%s"' \
328                               (p.GetLabel(), str(p.GetValue())),                             % (self.encode(g.GetLabel()), value)
329                    lambda p: 'clpoint'],                  close_el = 'clpoint'
330                   [lambda p: 'clrange label="%s" min="%s" max="%s"' %              elif isinstance(g, ClassGroupRange):
331                               (p.GetLabel(),                  open_el  = 'clrange label="%s" range="%s"' \
332                                str(p.GetMin()), (str(p.GetMax()))),                            % (self.encode(g.GetLabel()), str(g.GetRange()))
333                    lambda p: 'clrange']]                  close_el = 'clrange'
334                else:
335          def write_class_group(group):                  assert False, _("Unsupported group type in classification")
336              type = -1                  continue
337              if isinstance(group, ClassGroupDefault): type = 0  
338              elif isinstance(group, ClassGroupSingleton): type = 1              data = g.GetProperties()
339              elif isinstance(group, ClassGroupRange): type = 2              dict = {'stroke'      : data.GetLineColor().hex(),
340              elif isinstance(group, ClassGroupMap):   type = 3                      'stroke_width': str(data.GetLineWidth()),
341              assert type >= 0                      'fill'        : data.GetFill().hex()}
342    
343              if type <= 2:              self.open_element(open_el)
344                  data = group.GetProperties()              self.write_element("cldata", dict)
345                  dict = {'stroke'      : data.GetLineColor().hex(),              self.close_element(close_el)
                         'stroke_width': str(data.GetLineWidth()),  
                         'fill'        : data.GetFill().hex()}  
   
                 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)  
   
 #       for i in lc:  
 #           t = i.GetType()  
 #           self.open_element(types[t][0](i))  
 #           write_class_data(i)  
 #           self.close_element(types[t][1](i))  
   
 #       for p in lc:  
 #           type = p.GetType()  
 #           if p == ClassData.DEFAULT:  
 #               lopen = lclose = 'clnull'  
 #           elif p == ClassData.POINTS:  
 #               lopen = 'clpoint value="%s"' % escape(str(p.GetValue()))  
 #               lclose = 'clpoint'  
 #           elif p == ClassData.RANGES:  
 #               lopen = 'clrange min="%s" max="%s"'  
 #                   % (escape(str(p.GetMin())), escape(str(p.GetMax()))))  
 #               lclose = 'clrange'  
   
 #           self.open_element(lopen)  
 #           write_class_data(p)  
 #           self.close_element(lclose)  
               
 #       if lc.points != {}:  
 #           for p in lc.points.values():  
 #               self.open_element('clpoint value="%s"' %  
 #                   (escape(str(p.GetValue()))))  
 #               write_class_data(p)  
 #               self.close_element('clpoint')  
 #            
 #       if lc.ranges != []:  
 #           for p in lc.ranges:  
 #               self.open_element('clrange min="%s" max="%s"'  
 #                   % (escape(str(p.GetMin())), escape(str(p.GetMax()))))  
 #               write_class_data(p)  
 #               self.close_element('clrange')  
346    
347          self.close_element("classification")          self.close_element("classification")
348    
# Line 323  class Saver: Line 355  class Saver:
355              for label in labels:              for label in labels:
356                  self.write_element(('label x="%g" y="%g" text="%s"'                  self.write_element(('label x="%g" y="%g" text="%s"'
357                                      ' halign="%s" valign="%s"')                                      ' halign="%s" valign="%s"')
358                                  % (label.x, label.y, label.text, label.halign,                                  % (label.x, label.y,
359                                       self.encode(label.text),
360                                       label.halign,
361                                     label.valign))                                     label.valign))
362              self.close_element('labellayer')              self.close_element('labellayer')
363    
# Line 336  def save_session(session, file, saver_cl Line 370  def save_session(session, file, saver_cl
370    
371      The optional argument saver_class is the class to use to serialize      The optional argument saver_class is the class to use to serialize
372      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
373      Saver.      SessionSaver.
374    
375      If writing the session is successful call the session's      If writing the session is successful call the session's
376      UnsetModified method      UnsetModified method
377      """      """
378      if saver_class is None:      if saver_class is None:
379          saver_class = Saver          saver_class = SessionSaver
380      saver = saver_class(session)      saver = saver_class(session)
381      saver.write(file)      saver.write(file)
382    
Legend:
Removed from v.683  
changed lines
  Added in v.2036
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.26