/[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 1219 by bh, Mon Jun 16 17:42:54 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
21    from Thuban.Model.layer import Layer, RasterLayer
22    
23    from Thuban.Model.classification import \
24        ClassGroupDefault, ClassGroupSingleton, ClassGroupRange, ClassGroupMap
25    
26    from Thuban.Model.xmlwriter import XMLWriter
27    
28  def relative_filename(dir, filename):  def relative_filename(dir, filename):
29      """Return a filename relative to dir for the absolute file name absname.      """Return a filename relative to dir for the absolute file name absname.
30    
# Line 29  def relative_filename(dir, filename): Line 37  def relative_filename(dir, filename):
37      else:      else:
38          return filename          return filename
39    
40  def escape(data):  class SessionSaver(XMLWriter):
     """Escape &, \", ', <, and > in a string of data.  
     """  
     data = string.replace(data, "&", "&amp;")  
     data = string.replace(data, "<", "&lt;")  
     data = string.replace(data, ">", "&gt;")  
     data = string.replace(data, '"', "&quot;")  
     data = string.replace(data, "'", "&apos;")  
     return data  
   
 class Saver:  
41    
42      """Class to serialize a session into an XML file.      """Class to serialize a session into an XML file.
43    
44      Applications built on top of Thuban may derive from this class and      Applications built on top of Thuban may derive from this class and
45      override or extend the methods to save additinal information. This      override or extend the methods to save additional information. This
46      additional information should take the form of additional attributes      additional information should take the form of additional attributes
47      or elements whose names are prefixed with a namespace. To define a      or elements whose names are prefixed with a namespace. To define a
48      namespace derived classes should extend the write_session method to      namespace derived classes should extend the write_session method to
49      pass the namespaces to the default implementation.      pass the namespaces to the default implementation.
50      """      """
51    
52    
53      def __init__(self, session):      def __init__(self, session):
54            XMLWriter.__init__(self)
55          self.session = session          self.session = session
56    
57      def write(self, file_or_filename):      def write(self, file_or_filename):
58          """Write the session to a file.          XMLWriter.write(self, file_or_filename)
59    
60          The argument may be either a file object or a filename. If it's          self.write_header("session", "thuban.dtd")
         a filename, the file will be opened for writing. Files of  
         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()  
61          self.write_session(self.session)          self.write_session(self.session)
62            self.close()
     def write_element(self, element, attrs, empty = 0, indentation = ""):  
         # Helper function to write an element open tag with attributes  
         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")  
   
     def write_header(self):  
         """Write the XML header"""  
         write = self.file.write  
         write('<?xml version="1.0" encoding="UTF-8"?>\n')  
         write('<!DOCTYPE session SYSTEM "thuban.dtd">\n')  
63    
64      def write_session(self, session, attrs = None, namespaces = ()):      def write_session(self, session, attrs = None, namespaces = ()):
65          """Write the session and its contents          """Write the session and its contents
# Line 116  class Saver: Line 82  class Saver:
82          attrs["title"] = session.title          attrs["title"] = session.title
83          for name, uri in namespaces:          for name, uri in namespaces:
84              attrs["xmlns:" + name] = uri              attrs["xmlns:" + name] = uri
85          self.write_element("session", attrs)          self.open_element("session", attrs)
86          for map in session.Maps():          for map in session.Maps():
87              self.write_map(map)              self.write_map(map)
88          self.file.write('</session>\n')          self.close_element("session")
89    
90      def write_map(self, map):      def write_map(self, map):
91          """Write the map and its contents.          """Write the map and its contents.
# Line 129  class Saver: Line 95  class Saver:
95          element, call write_layer for each layer contained in the map          element, call write_layer for each layer contained in the map
96          and finally call write_label_layer to write the label layer.          and finally call write_label_layer to write the label layer.
97          """          """
98          write = self.file.write          self.open_element('map title="%s"' % self.encode(map.title))
         write('\t<map title="%s">\n' % escape(map.title))  
99          self.write_projection(map.projection)          self.write_projection(map.projection)
100          for layer in map.Layers():          for layer in map.Layers():
101              self.write_layer(layer)              self.write_layer(layer)
102          self.write_label_layer(map.LabelLayer())          self.write_label_layer(map.LabelLayer())
103          write('\t</map>\n')          self.close_element('map')
104    
105      def write_projection(self, projection):      def write_projection(self, projection):
106          """Write the projection.          """Write the projection.
107          """          """
108          if projection and len(projection.params) > 0:          if projection and len(projection.params) > 0:
109              self.file.write('\t\t<projection>\n')              self.open_element("projection", {"name": projection.GetName()})
110              for param in projection.params:              for param in projection.params:
111                  self.file.write('\t\t\t<parameter value="%s"/>\n'                  self.write_element('parameter value="%s"' %
112                                  % escape(param))                                     self.encode(param))
113              self.file.write('\t\t</projection>\n')              self.close_element("projection")
114    
115      def write_layer(self, layer, attrs = None):      def write_layer(self, layer, attrs = None):
116          """Write the layer.          """Write the layer.
# Line 154  class Saver: Line 119  class Saver:
119          given, should be a mapping from attribute names to attribute          given, should be a mapping from attribute names to attribute
120          values. The values should not be XML-escaped yet.          values. The values should not be XML-escaped yet.
121          """          """
122    
123          if attrs is None:          if attrs is None:
124              attrs = {}              attrs = {}
125          attrs["title"] = layer.title  
126          attrs["filename"] = relative_filename(self.dir, layer.filename)          attrs["title"]        = layer.title
127          attrs["stroke_width"] = str(layer.stroke_width)          attrs["visible"]      = ("false", "true")[int(layer.Visible())]
128          fill = layer.fill  
129          if fill is None:          if isinstance(layer, Layer):
130              attrs["fill"] = "None"              attrs["filename"] = relative_filename(self.dir,
131          else:                                                  layer.ShapeStore().FileName())
132              attrs["fill"] = fill.hex()  
133          stroke = layer.stroke              lc = layer.GetClassification()
134          if stroke is None:              attrs["stroke"]       = lc.GetDefaultLineColor().hex()
135              attrs["stroke"] = "None"              attrs["stroke_width"] = str(lc.GetDefaultLineWidth())
136          else:              attrs["fill"]         = lc.GetDefaultFill().hex()
137              attrs["stroke"] = stroke.hex()  
138          self.write_element("layer", attrs, empty = 1, indentation = "\t\t")              self.open_element("layer", attrs)
139                self.write_projection(layer.GetProjection())
140                self.write_classification(layer)
141                self.close_element("layer")
142    
143            elif isinstance(layer, RasterLayer):
144                attrs["filename"] = relative_filename(self.dir, layer.filename)
145                self.open_element("rasterlayer", attrs)
146                self.write_projection(layer.GetProjection())
147                self.close_element("rasterlayer")
148    
149        def write_classification(self, layer, attrs = None):
150            if attrs is None:
151                attrs = {}
152    
153            lc = layer.GetClassification()
154    
155            field = lc.GetField()
156    
157            #
158            # there isn't a classification of anything
159            # so don't do anything
160            #
161            if field is None: return
162    
163            attrs["field"] = field
164            attrs["field_type"] = str(lc.GetFieldType())
165            self.open_element("classification", attrs)
166    
167    
168            types = [[lambda p: 'clnull label="%s"' % self.encode(p.GetLabel()),
169                      lambda p: 'clnull'],
170                     [lambda p: 'clpoint label="%s" value="%s"' %
171                                 (self.encode(p.GetLabel()), str(p.GetValue())),
172                      lambda p: 'clpoint'],
173                     [lambda p: 'clrange label="%s" range="%s"' %
174                                 (self.encode(p.GetLabel()),
175                                  str(p.GetRange())),
176                      lambda p: 'clrange']]
177    
178            def write_class_group(group):
179                type = -1
180                if isinstance(group, ClassGroupDefault): type = 0
181                elif isinstance(group, ClassGroupSingleton): type = 1
182                elif isinstance(group, ClassGroupRange): type = 2
183                elif isinstance(group, ClassGroupMap):   type = 3
184                assert type >= 0
185    
186                if type <= 2:
187                    data = group.GetProperties()
188                    dict = {'stroke'      : data.GetLineColor().hex(),
189                            'stroke_width': str(data.GetLineWidth()),
190                            'fill'        : data.GetFill().hex()}
191    
192                    self.open_element(types[type][0](group))
193                    self.write_element("cldata", dict)
194                    self.close_element(types[type][1](group))
195                else: pass # XXX: we need to handle maps
196    
197            for i in lc:
198                write_class_group(i)
199    
200            self.close_element("classification")
201    
202      def write_label_layer(self, layer):      def write_label_layer(self, layer):
203          """Write the label layer.          """Write the label layer.
204          """          """
205          labels = layer.Labels()          labels = layer.Labels()
206          if labels:          if labels:
207              self.file.write('\t\t<labellayer>\n')              self.open_element('labellayer')
208              for label in labels:              for label in labels:
209                  self.file.write(('\t\t\t<label x="%g" y="%g" text="%s"'                  self.write_element(('label x="%g" y="%g" text="%s"'
210                                   ' halign="%s" valign="%s"/>\n')                                      ' halign="%s" valign="%s"')
211                                  % (label.x, label.y, label.text, label.halign,                                  % (label.x, label.y,
212                                       self.encode(label.text),
213                                       label.halign,
214                                     label.valign))                                     label.valign))
215              self.file.write('\t\t</labellayer>\n')              self.close_element('labellayer')
216    
217    
218    
# Line 193  def save_session(session, file, saver_cl Line 223  def save_session(session, file, saver_cl
223    
224      The optional argument saver_class is the class to use to serialize      The optional argument saver_class is the class to use to serialize
225      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
226      Saver.      SessionSaver.
227    
228      If writing the session is successful call the session's      If writing the session is successful call the session's
229      UnsetModified method      UnsetModified method
230      """      """
231      if saver_class is None:      if saver_class is None:
232          saver_class = Saver          saver_class = SessionSaver
233      saver = saver_class(session)      saver = saver_class(session)
234      saver.write(file)      saver.write(file)
235    
Legend:
Removed from v.268  
changed lines
  Added in v.1219
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.26