/[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 1251 by jonathan, Fri Jun 20 09:27:55 2003 UTC revision 2384 by jan, Thu Oct 7 14:24:24 2004 UTC
# Line 1  Line 1 
1  # Copyright (c) 2001, 2002, 2003 by Intevation GmbH  # Copyright (c) 2001-2004 by Intevation GmbH
2  # Authors:  # Authors:
3  # Jan-Oliver Wagner <[email protected]>  # Jan-Oliver Wagner <[email protected]> (2004)
4  # Bernhard Herzog <[email protected]>  # Bernhard Herzog <[email protected]> (2001-2004)
5  # Jonathan Coles <[email protected]>  # Jonathan Coles <[email protected]> (2003)
6    # Frank Koormann <[email protected]> (2003)
7  #  #
8  # This program is free software under the GPL (>=v2)  # This program is free software under the GPL (>=v2)
9  # Read the file COPYING coming with Thuban for details.  # Read the file COPYING coming with Thuban for details.
# Line 12  Functions to save a session to a file Line 13  Functions to save a session to a file
13  """  """
14    
15  __version__ = "$Revision$"  __version__ = "$Revision$"
16    # $Source$
17    # $Id$
18    
19  import os  import os
20    
21  import Thuban.Lib.fileutil  import Thuban.Lib.fileutil
22    
 from Thuban.Model.color import Color  
23  from Thuban.Model.layer import Layer, RasterLayer  from Thuban.Model.layer import Layer, RasterLayer
24    
25  from Thuban.Model.classification import \  from Thuban.Model.classification import \
26      ClassGroupDefault, ClassGroupSingleton, ClassGroupRange, ClassGroupMap      ClassGroupDefault, ClassGroupSingleton, ClassGroupRange, ClassGroupMap
27    from Thuban.Model.transientdb import AutoTransientTable, TransientJoinedTable
28    from Thuban.Model.table import DBFTable, FIELDTYPE_STRING
29    from Thuban.Model.data import DerivedShapeStore, ShapefileStore, \
30                                  SHAPETYPE_POINT
31    
32  from Thuban.Model.xmlwriter import XMLWriter  from Thuban.Model.xmlwriter import XMLWriter
33    from postgisdb import PostGISConnection, PostGISShapeStore
34    
35  def relative_filename(dir, filename):  def relative_filename(dir, filename):
36      """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 37  def relative_filename(dir, filename): Line 44  def relative_filename(dir, filename):
44      else:      else:
45          return filename          return filename
46    
47    
48    def unify_filename(filename):
49        """Return a 'unified' version of filename
50    
51        The .thuban files should be as platform independent as possible.
52        Since they must contain filenames the filenames have to unified. We
53        unify on unix-like filenames for now, which means we do nothing on a
54        posix system and simply replace backslashes with slashes on windows
55        """
56        if os.name == "posix":
57            return filename
58        elif os.name == "nt":
59            return "/".join(filename.split("\\"))
60        else:
61            raise RuntimeError("Unsupported platform for unify_filename: %s"
62                               % os.name)
63    
64    def sort_data_stores(stores):
65        """Return a topologically sorted version of the sequence of data containers
66    
67        The list is sorted so that data containers that depend on other data
68        containers have higher indexes than the containers they depend on.
69        """
70        if not stores:
71            return []
72        processed = {}
73        result = []
74        todo = stores[:]
75        while todo:
76            # It doesn't really matter which if the items of todo is
77            # processed next, but if we take the first one, the order is
78            # preserved to some degree which makes writing some of the test
79            # cases easier.
80            container = todo.pop(0)
81            if id(container) in processed:
82                continue
83            deps = [dep for dep in container.Dependencies()
84                        if id(dep) not in processed]
85            if deps:
86                todo.append(container)
87                todo.extend(deps)
88            else:
89                result.append(container)
90                processed[id(container)] = 1
91        return result
92    
93    
94  class SessionSaver(XMLWriter):  class SessionSaver(XMLWriter):
95    
96      """Class to serialize a session into an XML file.      """Class to serialize a session into an XML file.
# Line 53  class SessionSaver(XMLWriter): Line 107  class SessionSaver(XMLWriter):
107      def __init__(self, session):      def __init__(self, session):
108          XMLWriter.__init__(self)          XMLWriter.__init__(self)
109          self.session = session          self.session = session
110            # Map object ids to the ids used in the thuban files
111            self.idmap = {}
112    
113        def get_id(self, obj):
114            """Return the id used in the thuban file for the object obj"""
115            return self.idmap.get(id(obj))
116    
117        def define_id(self, obj, value = None):
118            if value is None:
119                value = "D" + str(id(obj))
120            self.idmap[id(obj)] = value
121            return value
122    
123        def has_id(self, obj):
124            return self.idmap.has_key(id(obj))
125    
126        def prepare_filename(self, filename):
127            """Return the string to use when writing filename to the thuban file
128    
129            The returned string is a unified version (only slashes as
130            directory separators, see unify_filename) of filename expressed
131            relative to the directory the .thuban file is written to.
132            """
133            return unify_filename(relative_filename(self.dir, filename))
134    
135      def write(self, file_or_filename):      def write(self, file_or_filename):
136          XMLWriter.write(self, file_or_filename)          XMLWriter.write(self, file_or_filename)
137    
138          self.write_header("session", "thuban.dtd")          self.write_header("session", "thuban-1.1.dtd")
139          self.write_session(self.session)          self.write_session(self.session)
140          self.close()          self.close()
141    
# Line 82  class SessionSaver(XMLWriter): Line 160  class SessionSaver(XMLWriter):
160          attrs["title"] = session.title          attrs["title"] = session.title
161          for name, uri in namespaces:          for name, uri in namespaces:
162              attrs["xmlns:" + name] = uri              attrs["xmlns:" + name] = uri
163            # default name space
164            attrs["xmlns"] = \
165                   "http://thuban.intevation.org/dtds/thuban-1.1-dev.dtd"
166          self.open_element("session", attrs)          self.open_element("session", attrs)
167            self.write_db_connections(session)
168            self.write_data_containers(session)
169          for map in session.Maps():          for map in session.Maps():
170              self.write_map(map)              self.write_map(map)
171          self.close_element("session")          self.close_element("session")
172    
173        def write_db_connections(self, session):
174            for conn in session.DBConnections():
175                if isinstance(conn, PostGISConnection):
176                    self.write_element("dbconnection",
177                                       {"id": self.define_id(conn),
178                                        "dbtype": "postgis",
179                                        "host": conn.host,
180                                        "port": conn.port,
181                                        "user": conn.user,
182                                        "dbname": conn.dbname})
183                else:
184                    raise ValueError("Can't handle db connection %r" % conn)
185    
186        def write_data_containers(self, session):
187            containers = sort_data_stores(session.DataContainers())
188            for container in containers:
189                if isinstance(container, AutoTransientTable):
190                    # AutoTransientTable instances are invisible in the
191                    # thuban files. They're only used internally. To make
192                    # sure that containers depending on AutoTransientTable
193                    # instances refer to the right real containers we give
194                    # the AutoTransientTable instances the same id as the
195                    # source they depend on.
196                    self.define_id(container,
197                                   self.get_id(container.Dependencies()[0]))
198                    continue
199    
200                idvalue = self.define_id(container)
201                if isinstance(container, ShapefileStore):
202                    self.define_id(container.Table(), idvalue)
203                    filename = self.prepare_filename(container.FileName())
204                    self.write_element("fileshapesource",
205                                       {"id": idvalue, "filename": filename,
206                                        "filetype": "shapefile"})
207                elif isinstance(container, DerivedShapeStore):
208                    shapesource, table = container.Dependencies()
209                    self.write_element("derivedshapesource",
210                                       {"id": idvalue,
211                                        "shapesource": self.get_id(shapesource),
212                                        "table": self.get_id(table)})
213                elif isinstance(container, PostGISShapeStore):
214                    conn = container.DBConnection()
215                    self.write_element("dbshapesource",
216                                       {"id": idvalue,
217                                        "dbconn": self.get_id(conn),
218                                        "tablename": container.TableName(),
219                                        "id_column": container.IDColumn().name,
220                                        "geometry_column":
221                                          container.GeometryColumn().name,
222                                        })
223                elif isinstance(container, DBFTable):
224                    filename = self.prepare_filename(container.FileName())
225                    self.write_element("filetable",
226                                       {"id": idvalue,
227                                        "title": container.Title(),
228                                        "filename": filename,
229                                        "filetype": "DBF"})
230                elif isinstance(container, TransientJoinedTable):
231                    left, right = container.Dependencies()
232                    left_field = container.left_field
233                    right_field = container.right_field
234                    self.write_element("jointable",
235                                       {"id": idvalue,
236                                        "title": container.Title(),
237                                        "right": self.get_id(right),
238                                        "rightcolumn": right_field,
239                                        "left": self.get_id(left),
240                                        "leftcolumn": left_field,
241                                        "jointype": container.JoinType()})
242                else:
243                    raise ValueError("Can't handle container %r" % container)
244    
245    
246      def write_map(self, map):      def write_map(self, map):
247          """Write the map and its contents.          """Write the map and its contents.
248    
# Line 106  class SessionSaver(XMLWriter): Line 262  class SessionSaver(XMLWriter):
262          """Write the projection.          """Write the projection.
263          """          """
264          if projection and len(projection.params) > 0:          if projection and len(projection.params) > 0:
265              self.open_element("projection", {"name": projection.GetName()})              attrs = {"name": projection.GetName()}
266                epsg = projection.EPSGCode()
267                if epsg is not None:
268                    attrs["epsg"] = epsg
269                self.open_element("projection", attrs)
270              for param in projection.params:              for param in projection.params:
271                  self.write_element('parameter value="%s"' %                  self.write_element('parameter value="%s"' %
272                                     self.encode(param))                                     self.encode(param))
# Line 127  class SessionSaver(XMLWriter): Line 287  class SessionSaver(XMLWriter):
287          attrs["visible"] = ("false", "true")[int(layer.Visible())]          attrs["visible"] = ("false", "true")[int(layer.Visible())]
288    
289          if isinstance(layer, Layer):          if isinstance(layer, Layer):
290              attrs["filename"] = relative_filename(self.dir,              attrs["shapestore"]   = self.get_id(layer.ShapeStore())
                                                 layer.ShapeStore().FileName())  
291    
292              lc = layer.GetClassification()              lc = layer.GetClassification()
293              attrs["stroke"]       = lc.GetDefaultLineColor().hex()              attrs["stroke"] = lc.GetDefaultLineColor().hex()
294              attrs["stroke_width"] = str(lc.GetDefaultLineWidth())              attrs["stroke_width"] = str(lc.GetDefaultLineWidth())
295              attrs["fill"]         = lc.GetDefaultFill().hex()              attrs["fill"] = lc.GetDefaultFill().hex()
296    
297              self.open_element("layer", attrs)              self.open_element("layer", attrs)
298              self.write_projection(layer.GetProjection())              self.write_projection(layer.GetProjection())
299              self.write_classification(layer)              self.write_classification(layer)
300              self.close_element("layer")              self.close_element("layer")
   
301          elif isinstance(layer, RasterLayer):          elif isinstance(layer, RasterLayer):
302              attrs["filename"] = relative_filename(self.dir, layer.filename)              attrs["filename"] = self.prepare_filename(layer.filename)
303              self.open_element("rasterlayer", attrs)              self.open_element("rasterlayer", attrs)
304              self.write_projection(layer.GetProjection())              self.write_projection(layer.GetProjection())
305              self.close_element("rasterlayer")              self.close_element("rasterlayer")
# Line 154  class SessionSaver(XMLWriter): Line 312  class SessionSaver(XMLWriter):
312    
313          lc = layer.GetClassification()          lc = layer.GetClassification()
314    
315          field = lc.GetField()          field = layer.GetClassificationColumn()
316    
317          #          #
318          # there isn't a classification of anything so do nothing          # there isn't a classification of anything so do nothing
319          #          #
320          if field is None: return          if field is None: return
321    
322          attrs["field"] = field          attrs["field"] = field
323          attrs["field_type"] = str(lc.GetFieldType())          attrs["field_type"] = str(layer.GetFieldType(field))
324          self.open_element("classification", attrs)          self.open_element("classification", attrs)
325    
326          for g in lc:          for g in lc:
327              if isinstance(g, ClassGroupDefault):              if isinstance(g, ClassGroupDefault):
328                  open_el  = 'clnull label="%s"' % self.encode(g.GetLabel())                  open_el  = 'clnull label="%s"' % self.encode(g.GetLabel())
329                  close_el = 'clnull'                  close_el = 'clnull'
330              elif isinstance(g, ClassGroupSingleton):              elif isinstance(g, ClassGroupSingleton):
331                    if layer.GetFieldType(field) == FIELDTYPE_STRING:
332                        value = self.encode(g.GetValue())
333                    else:
334                        value = str(g.GetValue())
335                  open_el  = 'clpoint label="%s" value="%s"' \                  open_el  = 'clpoint label="%s" value="%s"' \
336                             % (self.encode(g.GetLabel()), str(g.GetValue()))                             % (self.encode(g.GetLabel()), value)
337                  close_el = 'clpoint'                  close_el = 'clpoint'
338              elif isinstance(g, ClassGroupRange):              elif isinstance(g, ClassGroupRange):
339                  open_el  = 'clrange label="%s" range="%s"' \                  open_el  = 'clrange label="%s" range="%s"' \
# Line 186  class SessionSaver(XMLWriter): Line 348  class SessionSaver(XMLWriter):
348                      'stroke_width': str(data.GetLineWidth()),                      'stroke_width': str(data.GetLineWidth()),
349                      'fill'        : data.GetFill().hex()}                      'fill'        : data.GetFill().hex()}
350    
351                # only for point layers write the size attribute
352                if layer.ShapeType() == SHAPETYPE_POINT:
353                    dict['size'] =  str(data.GetSize())
354    
355              self.open_element(open_el)              self.open_element(open_el)
356              self.write_element("cldata", dict)              self.write_element("cldata", dict)
357              self.close_element(close_el)              self.close_element(close_el)
Legend:
Removed from v.1251  
changed lines
  Added in v.2384
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.26