osm-io 0.3.0

Read and write OSM data
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
use std::borrow::Borrow;
use std::io::Cursor;
use std::ops::Index;

use prost::Message;

use crate::osm::model::bounding_box::BoundingBox;
use crate::osm::model::element::Element;
use crate::osm::pbf::dense_group_builder::DenseGroupBuilder;
use crate::osm::pbf::relations_group_builder::RelationsGroupBuilder;
use crate::osm::pbf::string_table_builder::StringTableBuilder;
use crate::osm::pbf::ways_group_builder::WaysGroupBuilder;
use crate::osmpbf::{PrimitiveBlock, PrimitiveGroup};
use crate::{osm, osmpbf};

#[derive(Debug, Default)]
pub struct OsmData {
    elements: Vec<Element>,
    bounding_box: Option<BoundingBox>,
}

impl OsmData {
    pub fn new(data: Vec<u8>) -> Result<OsmData, anyhow::Error> {
        let mut primitive_block = PrimitiveBlock::decode(&mut Cursor::new(data))?;
        let string_table: Vec<String> = std::mem::take(&mut primitive_block.stringtable.s)
            .into_iter()
            .map(|e| String::from_utf8_lossy(&e).into_owned())
            .collect();
        let granularity = primitive_block.granularity() as i64;
        let date_granularity = primitive_block.date_granularity();
        let lat_offset = primitive_block.lat_offset();
        let lon_offset = primitive_block.lon_offset();
        let mut elements = Vec::<Element>::with_capacity(8000);
        for g in &primitive_block.primitivegroup {
            Self::read_dense(
                &g.dense,
                &string_table,
                granularity,
                date_granularity,
                lat_offset,
                lon_offset,
                &mut elements,
            );
            Self::read_nodes(
                &g.nodes,
                &string_table,
                granularity,
                date_granularity,
                lat_offset,
                lon_offset,
                &mut elements,
            );
            Self::read_ways(
                &g.ways,
                &string_table,
                granularity,
                date_granularity,
                &mut elements,
            );
            Self::read_relations(
                &g.relations,
                &string_table,
                granularity,
                date_granularity,
                &mut elements,
            );
            Self::read_changesets(
                &g.changesets,
                &string_table,
                granularity,
                date_granularity,
                lat_offset,
                lon_offset,
                &mut elements,
            );
        }
        Ok(OsmData {
            elements,
            bounding_box: None,
        })
    }

    pub fn from_elements(elements: Vec<Element>, bounding_box: Option<BoundingBox>) -> OsmData {
        OsmData {
            elements,
            bounding_box,
        }
    }

    pub fn compute_bounding_box(&self) -> Option<BoundingBox> {
        if self.bounding_box.is_none() {
            self.recompute_bounding_box()
        } else {
            self.bounding_box
        }
    }

    pub fn recompute_bounding_box(&self) -> Option<BoundingBox> {
        let mut result: Option<BoundingBox> = None;
        for element in &self.elements {
            match element {
                Element::Node { node } => match result.as_mut() {
                    Some(bbox) => bbox.merge_point(node.coordinate()),
                    None => result = Some(BoundingBox::from_point(node.coordinate())),
                },
                Element::Way { .. } => {
                    break;
                }
                Element::Relation { .. } => {
                    break;
                }
                Element::Sentinel => {
                    break;
                }
            }
        }
        result
    }

    fn read_dense(
        dense_group: &Option<osmpbf::DenseNodes>,
        string_table: &Vec<String>,
        granularity: i64,
        date_granularity: i32,
        lat_offset: i64,
        lon_offset: i64,
        elements: &mut Vec<Element>,
    ) {
        if let Some(dense) = dense_group {
            let mut last_id = 0_i64;
            let mut last_lat = 0_i64;
            let mut last_lon = 0_i64;

            let mut last_timestamp = 0_i64;
            let mut timestamp = 0_i64;
            let mut last_changeset = -1_i64;
            let mut uid = -1_i32;
            let mut last_user_sid = 0_i32;

            if let Some(_info) = &dense.denseinfo {
                last_timestamp = 0_i64;
                last_changeset = 0_i64;
                uid = 0_i32;
                last_user_sid = 0_i32;
            }
            let mut visible = true;

            let mut key_val_iterator =
                <Vec<i32> as Borrow<Vec<i32>>>::borrow(&dense.keys_vals).iter();
            for (i, id) in <Vec<i64> as Borrow<Vec<i64>>>::borrow(&dense.id)
                .iter()
                .enumerate()
            {
                last_id += id;
                last_lat += dense.lat[i];
                last_lon += dense.lon[i];

                let mut version = 0_i32;
                let mut user: String = String::default();
                if let Some(info) = &dense.denseinfo {
                    last_timestamp += info.timestamp[i];
                    timestamp = last_timestamp * date_granularity as i64;
                    last_changeset += info.changeset[i];
                    uid += info.uid[i];
                    last_user_sid += info.user_sid[i];
                    let user_sid = last_user_sid as usize;
                    if info.visible.len() > i {
                        visible = info.visible[i];
                    } else {
                        visible = true;
                    }
                    version = info.version[i];
                    user = string_table.index(user_sid).clone();
                }

                let mut tags = Vec::<osm::model::tag::Tag>::new();
                while let Some(key_val) = key_val_iterator.next() {
                    if *key_val == 0 {
                        break;
                    } else {
                        let key = *key_val as usize;
                        // TODO: handle missing value properly (log warning or propagate error)
                        let Some(val_ref) = key_val_iterator.next() else {
                            break;
                        };
                        let val = *val_ref as usize;
                        tags.push(osm::model::tag::Tag::new(
                            string_table.index(key).as_str(),
                            string_table.index(val).as_str(),
                        ));
                    }
                }

                let coordinate = osm::model::coordinate::Coordinate::new(
                    (lat_offset + (granularity * last_lat)) as f64 / 1000000000f64,
                    (lon_offset + (granularity * last_lon)) as f64 / 1000000000f64,
                );

                let node = osm::model::node::Node::new(
                    last_id,
                    version,
                    coordinate,
                    timestamp,
                    last_changeset,
                    uid,
                    user,
                    visible,
                    tags,
                );
                elements.push(Element::Node { node });
            }
        }
    }

    fn read_nodes(
        node_group: &Vec<osmpbf::Node>,
        string_table: &[String],
        granularity: i64,
        date_granularity: i32,
        lat_offset: i64,
        lon_offset: i64,
        elements: &mut Vec<Element>,
    ) {
        for node in node_group {
            let id = node.id;
            let coordinate = osm::model::coordinate::Coordinate::new(
                (lat_offset + (granularity * node.lat)) as f64 / 1000000000f64,
                (lon_offset + (granularity * node.lon)) as f64 / 1000000000f64,
            );

            let (timestamp, changeset, uid, user, visible, version) =
                Self::read_info(string_table, date_granularity, &node.info);

            let mut tags = Vec::<osm::model::tag::Tag>::new();
            for i in 0..node.keys.len() {
                let k = &string_table[node.keys[i] as usize];
                let v = &string_table[node.vals[i] as usize];
                tags.push(osm::model::tag::Tag::new(k, v));
            }

            let node = osm::model::node::Node::new(
                id, version, coordinate, timestamp, changeset, uid, user, visible, tags,
            );
            elements.push(Element::Node { node });
        }
    }

    fn read_info(
        string_table: &[String],
        date_granularity: i32,
        info_opt: &Option<osmpbf::Info>,
    ) -> (i64, i64, i32, String, bool, i32) {
        let mut timestamp = -1_i64;
        let mut changeset = -1_i64;
        let mut uid = -1_i32;
        let user_sid;
        let mut user: String = String::default();
        let mut visible = true;
        let mut version = 0_i32;

        if let Some(info) = info_opt {
            timestamp = info.timestamp.unwrap_or(0) * (date_granularity as i64);
            changeset = info.changeset.unwrap_or(-1);
            uid = info.uid.unwrap_or(-1);
            user_sid = info.user_sid.unwrap_or(0) as usize;
            visible = info.visible.unwrap_or(true);
            user = string_table[user_sid].clone();
            version = info.version();
        }
        (timestamp, changeset, uid, user, visible, version)
    }

    fn read_ways(
        way_group: &Vec<osmpbf::Way>,
        string_table: &[String],
        _granularity: i64,
        date_granularity: i32,
        elements: &mut Vec<Element>,
    ) {
        for way in way_group {
            let id = way.id;
            let (timestamp, changeset, uid, user, visible, version) =
                Self::read_info(string_table, date_granularity, &way.info);

            let mut refs = Vec::<i64>::new();
            let mut last_ref = 0_i64;
            for delta in &way.refs {
                last_ref += delta;
                refs.push(last_ref);
            }

            let mut tags = Vec::<osm::model::tag::Tag>::new();
            for i in 0..way.keys.len() {
                let k = &string_table[way.keys[i] as usize];
                let v = &string_table[way.vals[i] as usize];
                tags.push(osm::model::tag::Tag::new(k, v));
            }

            let way = osm::model::way::Way::new(
                id, version, timestamp, changeset, uid, user, visible, refs, tags,
            );
            elements.push(Element::Way { way });
        }
    }

    fn read_relations(
        relation_group: &Vec<osmpbf::Relation>,
        string_table: &[String],
        _granularity: i64,
        date_granularity: i32,
        elements: &mut Vec<Element>,
    ) {
        for relation in relation_group {
            let id = relation.id;
            let (timestamp, changeset, uid, user, visible, version) =
                Self::read_info(string_table, date_granularity, &relation.info);

            let mut members = Vec::<osm::model::relation::Member>::new();
            let mut last_memid = 0_i64;
            for i in 0..relation.memids.len() {
                last_memid += relation.memids[i];
                let role = string_table[relation.roles_sid[i] as usize].clone();
                let member = osm::model::relation::MemberData::new(last_memid, role);
                if let Ok(member_type) = osmpbf::relation::MemberType::try_from(relation.types[i]) {
                    match member_type {
                        osmpbf::relation::MemberType::Node => {
                            members.push(osm::model::relation::Member::Node { member });
                        }
                        osmpbf::relation::MemberType::Way => {
                            members.push(osm::model::relation::Member::Way { member });
                        }
                        osmpbf::relation::MemberType::Relation => {
                            members.push(osm::model::relation::Member::Relation { member });
                        }
                    }
                } else {
                    panic!("Non existing relation member type: {}", relation.types[i]);
                }
            }

            let mut tags = Vec::<osm::model::tag::Tag>::new();
            for i in 0..relation.keys.len() {
                let k = &string_table[relation.keys[i] as usize];
                let v = &string_table[relation.vals[i] as usize];
                tags.push(osm::model::tag::Tag::new(k, v));
            }

            let relation = osm::model::relation::Relation::new(
                id, version, timestamp, changeset, uid, user, visible, members, tags,
            );
            elements.push(Element::Relation { relation });
        }
    }

    fn read_changesets(
        changeset_group: &[osmpbf::ChangeSet],
        _string_table: &[String],
        _granularity: i64,
        _date_granularity: i32,
        _lat_offset: i64,
        _lon_offset: i64,
        _elements: &mut [Element],
    ) {
        if let Some(_changeset) = changeset_group.iter().next() {
            panic!("According to documentation changesets are not used");
        }
    }

    pub fn serialize(&self) -> Result<Vec<u8>, anyhow::Error> {
        let mut string_table_builder = StringTableBuilder::new();
        let granularity = 100_i32;
        let date_granularity = 1000_i32;
        let lat_offset = 0_i64;
        let lon_offset = 0_i64;

        let mut dense_group_builder: Option<DenseGroupBuilder> = None;
        let mut ways_group_builder: Option<WaysGroupBuilder> = None;
        let mut relations_group_builder: Option<RelationsGroupBuilder> = None;
        for element in &self.elements {
            match element {
                Element::Node { node } => match dense_group_builder.as_mut() {
                    Some(builder) => builder.add(node, &mut string_table_builder),
                    None => {
                        dense_group_builder = Some(DenseGroupBuilder::new(
                            granularity,
                            date_granularity,
                            lat_offset,
                            lon_offset,
                            node,
                            &mut string_table_builder,
                        ))
                    }
                },
                Element::Way { way } => match ways_group_builder.as_mut() {
                    Some(builder) => builder.add(way, &mut string_table_builder),
                    None => {
                        ways_group_builder = Some(WaysGroupBuilder::new(
                            date_granularity,
                            way,
                            &mut string_table_builder,
                        ))
                    }
                },
                Element::Relation { relation } => match relations_group_builder.as_mut() {
                    Some(builder) => builder.add(relation, &mut string_table_builder),
                    None => {
                        relations_group_builder = Some(RelationsGroupBuilder::new(
                            date_granularity,
                            relation,
                            &mut string_table_builder,
                        ))
                    }
                },
                Element::Sentinel => {}
            }
        }
        let mut primitivegroup = PrimitiveGroup::default();
        if let Some(mut builder) = dense_group_builder {
            primitivegroup = builder.build();
        } else if let Some(mut builder) = ways_group_builder {
            primitivegroup = builder.build();
        } else if let Some(mut builder) = relations_group_builder {
            primitivegroup = builder.build();
        }

        let stringtable = string_table_builder.build();

        let primitive_block = PrimitiveBlock {
            stringtable,
            primitivegroup: vec![primitivegroup],
            granularity: Some(granularity),
            lat_offset: Some(lat_offset),
            lon_offset: Some(lon_offset),
            date_granularity: Some(date_granularity),
        };

        let mut buf = Vec::<u8>::with_capacity(primitive_block.encoded_len());
        primitive_block.encode(&mut buf)?;
        Ok(buf)
    }

    pub fn elements(&self) -> &Vec<Element> {
        &self.elements
    }

    pub fn take_elements(&mut self) -> Vec<Element> {
        std::mem::take(&mut self.elements)
    }
}