/[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 1219 by bh, Mon Jun 16 17:42:54 2003 UTC revision 2551 by jonathan, Thu Jan 27 14:19:41 2005 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    def bool2str(b):
94        if b: return "true"
95        else: return "false"
96    
97  class SessionSaver(XMLWriter):  class SessionSaver(XMLWriter):
98    
99      """Class to serialize a session into an XML file.      """Class to serialize a session into an XML file.
# Line 53  class SessionSaver(XMLWriter): Line 110  class SessionSaver(XMLWriter):
110      def __init__(self, session):      def __init__(self, session):
111          XMLWriter.__init__(self)          XMLWriter.__init__(self)
112          self.session = session          self.session = session
113            # Map object ids to the ids used in the thuban files
114            self.idmap = {}
115    
116        def get_id(self, obj):
117            """Return the id used in the thuban file for the object obj"""
118            return self.idmap.get(id(obj))
119    
120        def define_id(self, obj, value = None):
121            if value is None:
122                value = "D" + str(id(obj))
123            self.idmap[id(obj)] = value
124            return value
125    
126        def has_id(self, obj):
127            return self.idmap.has_key(id(obj))
128    
129        def prepare_filename(self, filename):
130            """Return the string to use when writing filename to the thuban file
131    
132            The returned string is a unified version (only slashes as
133            directory separators, see unify_filename) of filename expressed
134            relative to the directory the .thuban file is written to.
135            """
136            return unify_filename(relative_filename(self.dir, filename))
137    
138      def write(self, file_or_filename):      def write(self, file_or_filename):
139          XMLWriter.write(self, file_or_filename)          XMLWriter.write(self, file_or_filename)
140    
141          self.write_header("session", "thuban.dtd")          self.write_header("session", "thuban-1.1.dtd")
142          self.write_session(self.session)          self.write_session(self.session)
143          self.close()          self.close()
144    
# Line 82  class SessionSaver(XMLWriter): Line 163  class SessionSaver(XMLWriter):
163          attrs["title"] = session.title          attrs["title"] = session.title
164          for name, uri in namespaces:          for name, uri in namespaces:
165              attrs["xmlns:" + name] = uri              attrs["xmlns:" + name] = uri
166            # default name space
167            attrs["xmlns"] = \
168                   "http://thuban.intevation.org/dtds/thuban-1.1-dev.dtd"
169          self.open_element("session", attrs)          self.open_element("session", attrs)
170            self.write_db_connections(session)
171            self.write_data_containers(session)
172          for map in session.Maps():          for map in session.Maps():
173              self.write_map(map)              self.write_map(map)
174          self.close_element("session")          self.close_element("session")
175    
176        def write_db_connections(self, session):
177            for conn in session.DBConnections():
178                if isinstance(conn, PostGISConnection):
179                    self.write_element("dbconnection",
180                                       {"id": self.define_id(conn),
181                                        "dbtype": "postgis",
182                                        "host": conn.host,
183                                        "port": conn.port,
184                                        "user": conn.user,
185                                        "dbname": conn.dbname})
186                else:
187                    raise ValueError("Can't handle db connection %r" % conn)
188    
189        def write_data_containers(self, session):
190            containers = sort_data_stores(session.DataContainers())
191            for container in containers:
192                if isinstance(container, AutoTransientTable):
193                    # AutoTransientTable instances are invisible in the
194                    # thuban files. They're only used internally. To make
195                    # sure that containers depending on AutoTransientTable
196                    # instances refer to the right real containers we give
197                    # the AutoTransientTable instances the same id as the
198                    # source they depend on.
199                    self.define_id(container,
200                                   self.get_id(container.Dependencies()[0]))
201                    continue
202    
203                idvalue = self.define_id(container)
204                if isinstance(container, ShapefileStore):
205                    self.define_id(container.Table(), idvalue)
206                    filename = self.prepare_filename(container.FileName())
207                    self.write_element("fileshapesource",
208                                       {"id": idvalue, "filename": filename,
209                                        "filetype": "shapefile"})
210                elif isinstance(container, DerivedShapeStore):
211                    shapesource, table = container.Dependencies()
212                    self.write_element("derivedshapesource",
213                                       {"id": idvalue,
214                                        "shapesource": self.get_id(shapesource),
215                                        "table": self.get_id(table)})
216                elif isinstance(container, PostGISShapeStore):
217                    conn = container.DBConnection()
218                    self.write_element("dbshapesource",
219                                       {"id": idvalue,
220                                        "dbconn": self.get_id(conn),
221                                        "tablename": container.TableName(),
222                                        "id_column": container.IDColumn().name,
223                                        "geometry_column":
224                                          container.GeometryColumn().name,
225                                        })
226                elif isinstance(container, DBFTable):
227                    filename = self.prepare_filename(container.FileName())
228                    self.write_element("filetable",
229                                       {"id": idvalue,
230                                        "title": container.Title(),
231                                        "filename": filename,
232                                        "filetype": "DBF"})
233                elif isinstance(container, TransientJoinedTable):
234                    left, right = container.Dependencies()
235                    left_field = container.left_field
236                    right_field = container.right_field
237                    self.write_element("jointable",
238                                       {"id": idvalue,
239                                        "title": container.Title(),
240                                        "right": self.get_id(right),
241                                        "rightcolumn": right_field,
242                                        "left": self.get_id(left),
243                                        "leftcolumn": left_field,
244                                        "jointype": container.JoinType()})
245                else:
246                    raise ValueError("Can't handle container %r" % container)
247    
248    
249      def write_map(self, map):      def write_map(self, map):
250          """Write the map and its contents.          """Write the map and its contents.
251    
# Line 106  class SessionSaver(XMLWriter): Line 265  class SessionSaver(XMLWriter):
265          """Write the projection.          """Write the projection.
266          """          """
267          if projection and len(projection.params) > 0:          if projection and len(projection.params) > 0:
268              self.open_element("projection", {"name": projection.GetName()})              attrs = {"name": projection.GetName()}
269                epsg = projection.EPSGCode()
270                if epsg is not None:
271                    attrs["epsg"] = epsg
272                self.open_element("projection", attrs)
273              for param in projection.params:              for param in projection.params:
274                  self.write_element('parameter value="%s"' %                  self.write_element('parameter value="%s"' %
275                                     self.encode(param))                                     self.encode(param))
# Line 123  class SessionSaver(XMLWriter): Line 286  class SessionSaver(XMLWriter):
286          if attrs is None:          if attrs is None:
287              attrs = {}              attrs = {}
288    
289          attrs["title"]        = layer.title          attrs["title"]   = layer.title
290          attrs["visible"]      = ("false", "true")[int(layer.Visible())]          attrs["visible"] = bool2str(layer.Visible())
291    
292          if isinstance(layer, Layer):          if isinstance(layer, Layer):
293              attrs["filename"] = relative_filename(self.dir,              attrs["shapestore"]   = self.get_id(layer.ShapeStore())
                                                 layer.ShapeStore().FileName())  
294    
295              lc = layer.GetClassification()              lc = layer.GetClassification()
296              attrs["stroke"]       = lc.GetDefaultLineColor().hex()              attrs["stroke"] = lc.GetDefaultLineColor().hex()
297              attrs["stroke_width"] = str(lc.GetDefaultLineWidth())              attrs["stroke_width"] = str(lc.GetDefaultLineWidth())
298              attrs["fill"]         = lc.GetDefaultFill().hex()              attrs["fill"] = lc.GetDefaultFill().hex()
299    
300              self.open_element("layer", attrs)              self.open_element("layer", attrs)
301              self.write_projection(layer.GetProjection())              self.write_projection(layer.GetProjection())
302              self.write_classification(layer)              self.write_classification(layer)
303              self.close_element("layer")              self.close_element("layer")
   
304          elif isinstance(layer, RasterLayer):          elif isinstance(layer, RasterLayer):
305              attrs["filename"] = relative_filename(self.dir, layer.filename)              attrs["filename"] = self.prepare_filename(layer.filename)
306                if layer.UseMask():
307                    attrs["use_mask"] = "true"
308    
309              self.open_element("rasterlayer", attrs)              self.open_element("rasterlayer", attrs)
310              self.write_projection(layer.GetProjection())              self.write_projection(layer.GetProjection())
311              self.close_element("rasterlayer")              self.close_element("rasterlayer")
312    
313      def write_classification(self, layer, attrs = None):      def write_classification(self, layer, attrs = None):
314            """Write Classification information."""
315    
316          if attrs is None:          if attrs is None:
317              attrs = {}              attrs = {}
318    
319          lc = layer.GetClassification()          lc = layer.GetClassification()
320    
321          field = lc.GetField()          field = layer.GetClassificationColumn()
322    
323          #          #
324          # there isn't a classification of anything          # there isn't a classification of anything so do nothing
         # so don't do anything  
325          #          #
326          if field is None: return          if field is None: return
327    
328          attrs["field"] = field          attrs["field"] = field
329          attrs["field_type"] = str(lc.GetFieldType())          attrs["field_type"] = str(layer.GetFieldType(field))
330          self.open_element("classification", attrs)          self.open_element("classification", attrs)
331    
332            for g in lc:
333          types = [[lambda p: 'clnull label="%s"' % self.encode(p.GetLabel()),              if isinstance(g, ClassGroupDefault):
334                    lambda p: 'clnull'],                  open_el  = 'clnull label="%s"' % self.encode(g.GetLabel())
335                   [lambda p: 'clpoint label="%s" value="%s"' %                  close_el = 'clnull'
336                               (self.encode(p.GetLabel()), str(p.GetValue())),              elif isinstance(g, ClassGroupSingleton):
337                    lambda p: 'clpoint'],                  if layer.GetFieldType(field) == FIELDTYPE_STRING:
338                   [lambda p: 'clrange label="%s" range="%s"' %                      value = self.encode(g.GetValue())
339                               (self.encode(p.GetLabel()),                  else:
340                                str(p.GetRange())),                      value = str(g.GetValue())
341                    lambda p: 'clrange']]                  open_el  = 'clpoint label="%s" value="%s"' \
342                               % (self.encode(g.GetLabel()), value)
343          def write_class_group(group):                  close_el = 'clpoint'
344              type = -1              elif isinstance(g, ClassGroupRange):
345              if isinstance(group, ClassGroupDefault): type = 0                  open_el  = 'clrange label="%s" range="%s"' \
346              elif isinstance(group, ClassGroupSingleton): type = 1                            % (self.encode(g.GetLabel()), str(g.GetRange()))
347              elif isinstance(group, ClassGroupRange): type = 2                  close_el = 'clrange'
348              elif isinstance(group, ClassGroupMap):   type = 3              else:
349              assert type >= 0                  assert False, _("Unsupported group type in classification")
350                    continue
351              if type <= 2:  
352                  data = group.GetProperties()              data = g.GetProperties()
353                  dict = {'stroke'      : data.GetLineColor().hex(),              dict = {'stroke'      : data.GetLineColor().hex(),
354                          'stroke_width': str(data.GetLineWidth()),                      'stroke_width': str(data.GetLineWidth()),
355                          'fill'        : data.GetFill().hex()}                      'fill'        : data.GetFill().hex()}
356    
357                  self.open_element(types[type][0](group))              # only for point layers write the size attribute
358                  self.write_element("cldata", dict)              if layer.ShapeType() == SHAPETYPE_POINT:
359                  self.close_element(types[type][1](group))                  dict['size'] =  str(data.GetSize())
360              else: pass # XXX: we need to handle maps  
361                self.open_element(open_el)
362          for i in lc:              self.write_element("cldata", dict)
363              write_class_group(i)              self.close_element(close_el)
364    
365          self.close_element("classification")          self.close_element("classification")
366    
Legend:
Removed from v.1219  
changed lines
  Added in v.2551
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.26