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
// Copyright (c) 2014-2017 Guillaume Pinot <texitoi(a)texitoi.eu>
//
// This work is free. You can redistribute it and/or modify it under
// the terms of the Do What The Fuck You Want To Public License,
// Version 2, as published by Sam Hocevar. See the COPYING file for
// more details.
//! Tools for reading a pbf file.
use crate::blobs::{self, result_blob_into_iter};
use crate::error::{Error, Result};
use crate::fileformat::{Blob, BlobHeader};
use crate::objects::{OsmId, OsmObj};
use crate::osmformat::PrimitiveBlock;
use par_map::{self, ParMap};
use protobuf::Message;
use pub_iterator_type::pub_iterator_type;
use std::collections::btree_map::BTreeMap;
use std::collections::BTreeSet;
use std::convert::From;
use std::io::{self, Read};
use std::iter;
/// Trait to allow generic objects (not just BTreeMap) in some methods.
pub trait StoreObjs {
/// Insert given object at given key index.
fn insert(&mut self, key: OsmId, value: OsmObj);
/// Check if object contains the given key.
fn contains_key(&self, key: &OsmId) -> bool;
}
impl StoreObjs for BTreeMap<OsmId, OsmObj> {
fn insert(&mut self, key: OsmId, value: OsmObj) {
self.insert(key, value);
}
fn contains_key(&self, key: &OsmId) -> bool {
self.contains_key(key)
}
}
/// The object to manage a pbf file.
pub struct OsmPbfReader<R> {
buf: Vec<u8>,
r: R,
finished: bool,
}
impl<R: io::Read> OsmPbfReader<R> {
/// Creates an OsmPbfReader from a Read object.
pub fn new(r: R) -> OsmPbfReader<R> {
OsmPbfReader {
buf: vec![],
r,
finished: false,
}
}
/// Returns an iterator on the OsmObj of the pbf file.
///
/// # Example
///
/// ```
/// let mut pbf = osmpbfreader::OsmPbfReader::new(std::io::empty());
/// for obj in pbf.iter().map(Result::unwrap) {
/// println!("{:?}", obj);
/// }
/// ```
pub fn iter(&mut self) -> Iter<R> {
Iter(self.blobs().flat_map(result_blob_into_iter))
}
/// Returns a parallel iterator on the OsmObj of the pbf file.
///
/// Several threads decode in parallel the file. The memory and
/// CPU usage are guaranteed to be bounded even if the caller stop
/// consuming items.
///
/// # Example
///
/// ```
/// let mut pbf = osmpbfreader::OsmPbfReader::new(std::io::empty());
/// for obj in pbf.par_iter().map(Result::unwrap) {
/// println!("{:?}", obj);
/// }
/// ```
pub fn par_iter(&mut self) -> ParIter<'_, R> {
ParIter(self.blobs().par_flat_map(result_blob_into_iter))
}
/// Rewinds the pbf file to the begining.
///
/// Useful if you want to read several consecutive times the same
/// file.
///
/// # Example
///
/// ```
/// let mut cursor = std::io::Cursor::new([0, 0, 0]);
/// cursor.set_position(2);
/// let mut pbf = osmpbfreader::OsmPbfReader::new(cursor);
/// pbf.rewind().unwrap();
/// assert_eq!(pbf.into_inner().position(), 0);
/// ```
pub fn rewind(&mut self) -> Result<()>
where
R: io::Seek,
{
self.r.seek(io::SeekFrom::Start(0))?;
self.finished = false;
Ok(())
}
/// Same as `get_objs_and_deps` but generic.
pub fn get_objs_and_deps_store<F, T>(&mut self, mut pred: F, objects: &mut T) -> Result<()>
where
R: io::Seek,
F: FnMut(&OsmObj) -> bool,
T: StoreObjs,
{
let mut finished = false;
let mut deps = BTreeSet::new();
let mut first_pass = true;
while !finished {
self.rewind()?;
finished = true;
for obj in self.par_iter() {
let obj = obj?;
if (!first_pass || !pred(&obj)) && !deps.contains(&obj.id()) {
continue;
}
finished = match obj {
OsmObj::Relation(ref rel) => rel
.refs
.iter()
.filter(|r| !objects.contains_key(&r.member))
.fold(finished, |accu, r| !deps.insert(r.member) && accu),
OsmObj::Way(ref way) => way
.nodes
.iter()
.filter(|n| !objects.contains_key(&(**n).into()))
.fold(finished, |accu, n| !deps.insert((*n).into()) && accu),
OsmObj::Node(_) => finished,
};
deps.remove(&obj.id());
objects.insert(obj.id(), obj);
}
first_pass = false;
}
Ok(())
}
/// This function give you the ability to find all the objects
/// validating a predicate and all their dependencies. The file
/// will be decoded in parallel.
///
/// # Example
///
/// If you want to extract all the administrative boundaries
/// and all their dependencies you can do something like that:
///
/// ```
/// fn is_admin(obj: &osmpbfreader::OsmObj) -> bool {
/// // get relations with tags[boundary] == administrative
/// obj.is_relation() && obj.tags().contains("boundary", "administrative")
/// }
///
/// let mut pbf = osmpbfreader::OsmPbfReader::new(std::io::Cursor::new([]));
/// let objs = pbf.get_objs_and_deps(is_admin).unwrap();
/// for (id, obj) in &objs {
/// println!("{:?}: {:?}", id, obj);
/// }
/// ```
pub fn get_objs_and_deps<F>(&mut self, pred: F) -> Result<BTreeMap<OsmId, OsmObj>>
where
R: io::Seek,
F: FnMut(&OsmObj) -> bool,
{
let mut objects = BTreeMap::new();
match self.get_objs_and_deps_store(pred, &mut objects) {
Ok(_) => Ok(objects),
Err(e) => Err(e),
}
}
/// Extract the Read object.
///
/// Consumes the object.
pub fn into_inner(self) -> R {
self.r
}
/// Returns an iterator on the blobs of the pbf file.
pub fn blobs(&mut self) -> Blobs<R> {
Blobs { opr: self }
}
/// Returns an iterator on the blocks of the pbf file.
pub fn primitive_blocks(&mut self) -> PrimitiveBlocks<R> {
fn and_then_primitive_block(blob_res: Result<Blob>) -> Result<PrimitiveBlock> {
blob_res.and_then(|b| primitive_block_from_blob(&b))
}
PrimitiveBlocks(self.blobs().map(and_then_primitive_block))
}
fn push(&mut self, sz: u64) -> Result<()> {
self.buf.clear();
self.r.by_ref().take(sz).read_to_end(&mut self.buf)?;
assert_eq!(sz, self.buf.len() as u64);
Ok(())
}
fn try_blob(&mut self, sz: u64) -> Result<Option<Blob>> {
self.push(sz)?;
let header: BlobHeader = Message::parse_from_bytes(&self.buf)?;
let sz = header.get_datasize() as u64;
self.push(sz)?;
let blob: Blob = Message::parse_from_bytes(&self.buf)?;
if header.get_field_type() == "OSMData" {
Ok(Some(blob))
} else if header.get_field_type() == "OSMHeader" {
Ok(None)
} else {
println!("Unknown type: {}", header.get_field_type());
Ok(None)
}
}
fn next_blob(&mut self) -> Option<Result<Blob>> {
use byteorder::{BigEndian, ReadBytesExt};
use std::io::ErrorKind;
if self.finished {
return None;
}
let sz = match self.r.read_u32::<BigEndian>() {
Ok(sz) if sz > 64 * 1024 => return Some(Err(Error::InvalidData)),
Ok(sz) => sz,
Err(ref e) if e.kind() == ErrorKind::UnexpectedEof => {
self.finished = true;
return None;
}
Err(e) => {
self.finished = true;
return Some(Err(From::from(e)));
}
} as u64;
match self.try_blob(sz) {
Ok(Some(p)) => Some(Ok(p)),
Ok(None) => self.next_blob(),
Err(e) => {
self.finished = true;
Some(Err(e))
}
}
}
}
/// Iterator on the blobs of a file.
pub struct Blobs<'a, R: 'a> {
opr: &'a mut OsmPbfReader<R>,
}
impl<'a, R: io::Read> Iterator for Blobs<'a, R> {
type Item = Result<Blob>;
fn next(&mut self) -> Option<Self::Item> {
self.opr.next_blob()
}
}
pub_iterator_type! {
#[doc="Iterator on the blocks of a file."]
PrimitiveBlocks['a, R] = iter::Map<Blobs<'a, R>, fn(Result<Blob>) -> Result<PrimitiveBlock>>
where R: Read + 'a
}
/// Returns an iterator on the blocks of a blob.
pub fn primitive_block_from_blob(blob: &Blob) -> Result<PrimitiveBlock> {
if blob.has_raw() {
Message::parse_from_bytes(blob.get_raw()).map_err(From::from)
} else if blob.has_zlib_data() {
use flate2::read::ZlibDecoder;
let r = io::Cursor::new(blob.get_zlib_data());
let mut zr = ZlibDecoder::new(r);
Message::parse_from_reader(&mut zr).map_err(From::from)
} else {
Err(Error::UnsupportedData)
}
}
pub_iterator_type! {
#[doc="Iterator on the `OsmObj` of the pbf file."]
Iter['a, R] = iter::FlatMap<Blobs<'a, R>, blobs::OsmObjs, fn(Result<Blob>) -> blobs::OsmObjs>
where R: io::Read + 'a
}
pub_iterator_type! {
#[doc="Parallel iterator on the `OsmObj` of the pbf file."]
ParIter['a, R] = par_map::FlatMap<Blobs<'a, R>,
blobs::OsmObjs,
fn(Result<Blob>) -> blobs::OsmObjs>
where R: io::Read + 'a
}