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
use std::collections::HashSet;
use std::path::PathBuf;
use std::sync::Arc;
use std::sync::atomic::{AtomicUsize, Ordering};

use anyhow::anyhow;
use command_executor::shutdown_mode::ShutdownMode;
use command_executor::thread_pool_builder::ThreadPoolBuilder;

use crate::osm::model::element::Element;
use crate::osm::pbf::blob_iterator::BlobIterator;
use crate::osm::pbf::element_iterator::ElementIterator;
use crate::osm::pbf::file_block_iterator::FileBlockIterator;
use crate::osm::pbf::file_info::FileInfo;
use crate::osm::pbf::parallel_element_iteration_command::ParallelElementIterationCommand;

#[derive(Debug, Clone)]
pub struct Reader {
    supported_features: Vec<String>,
    path: PathBuf,
    info: FileInfo,
}

/// *.osm.pbf file reader
///
/// Prepare the *.osm.pbf file for reading. The actual reading is performed by associated iterators.
impl Reader {
    /// Create a new Reader
    ///
    /// * path - a path to a valid *.osm.pbf file
    /// Example:
    /// ```
    /// use std::path::PathBuf;
    /// use osm_io::osm::pbf::reader::Reader;
    /// let input_path = PathBuf::from("./planet.osm.pbf");
    /// let reader = Reader::new(&input_path);
    /// ```
    pub fn new(path: &PathBuf) -> Result<Reader, anyhow::Error> {
        let supported_features = vec![
            "OsmSchema-V0.6".to_string(),
            "DenseNodes".to_string(),
            "HistoricalInformation".to_string(),
            "Sort.Type_then_ID".to_string(),
        ];

        let mut reader = Reader {
            supported_features,
            path: path.clone(),
            info: Default::default(),
        };
        let mut block_iterator = reader.clone().blocks()?;
        let file_block = block_iterator.next().ok_or(
            anyhow!("Failed to parse file header, path: {}", path.display())
        )?;
        let osm_header = file_block.as_osm_header()?;
        reader.info = osm_header.info().clone();

        Self::verify_supported_features(
            &reader.supported_features,
            &reader.info().required_features(),
        )?;

        Ok(
            reader
        )
    }

    pub(crate) fn blobs(&self) -> Result<BlobIterator, anyhow::Error> {
        BlobIterator::new(self.path.clone())
    }

    /// Low level [FileBlockIterator] used to access the sequence of underlying PBF blocks
    pub fn blocks(&self) -> Result<FileBlockIterator, anyhow::Error> {
        match self.blobs() {
            Ok(blob_iterator) => {
                Ok(
                    FileBlockIterator::new(blob_iterator)
                )
            }
            Err(e) => {
                Err(e)
            }
        }
    }

    /// Iterator used to iterate over elements.
    /// Example:
    /// ```
    /// use std::path::PathBuf;
    /// use osm_io::osm::model::element::Element;
    /// use osm_io::osm::pbf;
    /// fn example() -> Result<(), anyhow::Error> {
    ///     let input_path = PathBuf::from("./tests/fixtures/malta-230109.osm.pbf");
    ///     let reader = pbf::reader::Reader::new(&input_path)?;
    ///
    ///     let mut nodes = 0 as usize;
    ///     let mut ways = 0 as usize;
    ///     let mut relations = 0 as usize;
    ///
    ///     for element in reader.elements()? {
    ///         match element {
    ///             Element::Node { node } => {
    ///                 nodes += 1;
    ///             }
    ///             Element::Way { way } => {
    ///                 ways += 1;
    ///             }
    ///             Element::Relation { relation } => {
    ///                 relations += 1;
    ///             }
    ///             Element::Sentinel => {
    ///             }
    ///         }
    ///     }
    ///
    ///     println!("nodes: {}", nodes);
    ///     println!("ways: {}", ways);
    ///     println!("relations: {}", relations);
    ///
    ///     Ok(())
    /// }
    /// ```
    pub fn elements(&self) -> Result<ElementIterator, anyhow::Error> {
        match self.blocks() {
            Ok(file_block_iterator) => {
                Ok(
                    ElementIterator::new(file_block_iterator)
                )
            }
            Err(e) => {
                Err(e)
            }
        }
    }

    /// Parallel iteration over elements in a *.osm.pbf file
    ///
    /// Note that because of the parallel access the order of elements enforced by *.osm.pbf format
    /// is lost.
    /// Example:
    /// ```
    /// use std::path::PathBuf;
    /// use std::sync::Arc;
    /// use std::sync::atomic::{AtomicUsize, Ordering};
    /// use osm_io::osm::model::element::Element;
    /// use osm_io::osm::pbf;
    /// fn example() -> Result<(), anyhow::Error> {
    ///     let input_path = PathBuf::from("./tests/fixtures/malta-230109.osm.pbf");
    ///     let reader = pbf::reader::Reader::new(&input_path)?;
    ///
    ///     let nodes = Arc::new(AtomicUsize::new(0));
    ///     let ways = Arc::new(AtomicUsize::new(0));
    ///     let relations = Arc::new(AtomicUsize::new(0));
    ///
    ///     let nodes_clone = nodes.clone();
    ///     let ways_clone = ways.clone();
    ///     let relations_clone = relations.clone();
    ///
    ///     reader.parallel_for_each(4, move |element| {
    ///         match element {
    ///             Element::Node { node: _ } => {
    ///                 nodes.fetch_add(1, Ordering::SeqCst);
    ///             }
    ///             Element::Way { .. } => {
    ///                 ways.fetch_add(1, Ordering::SeqCst);
    ///             }
    ///             Element::Relation { .. } => {
    ///                 relations.fetch_add(1, Ordering::SeqCst);
    ///             }
    ///             Element::Sentinel => {}
    ///             }
    ///             Ok(())
    ///         },
    ///     )?;
    ///
    ///     println!("nodes: {}", nodes_clone.load(Ordering::SeqCst));
    ///     println!("ways: {}", ways_clone.load(Ordering::SeqCst));
    ///     println!("relations: {}", relations_clone.load(Ordering::SeqCst));
    ///     Ok(())
    /// }
    /// ```
    pub fn parallel_for_each(&self, tasks: usize, f: impl Fn(Element) -> Result<(), anyhow::Error> + Send + Sync + 'static) -> Result<(), anyhow::Error> {
        let mut iteration_pool = ThreadPoolBuilder::new()
            .with_tasks(tasks)
            .with_queue_size(1024)
            .with_shutdown_mode(ShutdownMode::CompletePending)
            .with_name_str("parallel-element-iterator")
            .build()?;

        let f_wrapper = Arc::new(f);
        for blob_desc in self.blobs()? {
            let f_wrapper_clone = f_wrapper.clone();
            iteration_pool.submit(
                Box::new(
                    ParallelElementIterationCommand::new(blob_desc, f_wrapper_clone)
                )
            );
        }

        iteration_pool.shutdown();
        iteration_pool.join()?;
        Ok(())
    }

    fn find_missing_features(supported_features: &Vec<String>, required_features: &Vec<String>) -> Vec<String> {
        let supported: HashSet<&String> = supported_features.into_iter().collect::<HashSet<&String>>();
        let required: HashSet<&String> = required_features.into_iter().collect::<HashSet<&String>>();
        if let true = required.is_subset(&supported) {
            vec![]
        } else {
            required.difference(&supported).into_iter().map(|e| e.clone().clone()).collect::<Vec<String>>()
        }
    }

    fn verify_supported_features(supported_features: &Vec<String>, required_features: &Vec<String>) -> Result<(), anyhow::Error> {
        let missing_features = Self::find_missing_features(supported_features, required_features);
        if missing_features.is_empty() {
            Ok(())
        } else {
            Err(
                anyhow!("Unsupported features: {missing_features:?}")
            )
        }
    }

    /// List the features supported by this [Reader]
    pub fn supported_features(&self) -> &Vec<String> {
        &self.supported_features
    }

    pub fn info(&self) -> &FileInfo {
        &self.info
    }

    pub fn count_objects(&self) -> Result<(i64, i64, i64), anyhow::Error> {
        let nodes = Arc::new(AtomicUsize::new(0));
        let ways = Arc::new(AtomicUsize::new(0));
        let relations = Arc::new(AtomicUsize::new(0));

        let nodes_clone = nodes.clone();
        let ways_clone = ways.clone();
        let relations_clone = relations.clone();

        self.parallel_for_each(num_cpus::get(), move |element| {
            match element {
                Element::Node { node: _ } => {
                    nodes.fetch_add(1, Ordering::SeqCst);
                }
                Element::Way { .. } => {
                    ways.fetch_add(1, Ordering::SeqCst);
                }
                Element::Relation { .. } => {
                    relations.fetch_add(1, Ordering::SeqCst);
                }
                Element::Sentinel => {}
            }
            Ok(())
        },
        )?;

        Ok(
            (
                nodes_clone.load(Ordering::SeqCst) as i64,
                ways_clone.load(Ordering::SeqCst) as i64,
                relations_clone.load(Ordering::SeqCst) as i64
            )
        )
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_find_missing_features() {
        let mut supported = vec!["a".to_string(), "b".to_string()];
        let mut required = vec!["a".to_string(), "b".to_string()];
        let mut missing = Reader::find_missing_features(&supported, &required);
        assert!(missing.is_empty());

        supported = vec!["a".to_string()];
        required = vec!["a".to_string(), "b".to_string()];
        missing = Reader::find_missing_features(&supported, &required);
        assert_eq!(missing, vec!["b".to_string()]);


        supported = vec!["a".to_string(), "b".to_string()];
        required = vec!["a".to_string()];
        missing = Reader::find_missing_features(&supported, &required);
        assert!(missing.is_empty());
    }
}