thumbsdb 0.1.2

Forensic library: parser and reader for Microsoft Thumbs.db file
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

//             DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
//                    Version 2, December 2004
//
// Copyright (C) 2018 Thomas Bailleux <thomas@bailleux.me>
//
// Everyone is permitted to copy and distribute verbatim or modified
// copies of this license document, and changing it is allowed as long
// as the name is changed.
//
//            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
//   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
//
//  0. You just DO WHAT THE FUCK YOU WANT TO.
//
// Author: zadig <thomas chr(0x40) bailleux.me>

use std;
use ole;


/// A Thumbs.db file reader.
///
/// The crate `ole` is used for parsing the file (which is an OLE file).
///
/// # Basic Example
///
/// ```
/// use thumbsdb::ThumbsDb;
///
///
/// let mut file = std::fs::File::open("assets/Thumbs.db").unwrap();
/// let thumbsdb = ThumbsDb::new(file).unwrap();
///
/// for thumbnail in thumbsdb.iterate() {
///   println!("Thumbnail #{}, name={}", thumbnail.id(), thumbnail.name());
/// }
///
/// ```
pub struct ThumbsDb<'ole> {

  /// OLE object for parsing the file.
  pub(crate) ole: ole::Reader<'ole>,

  /// Content of the catalog.
  pub(crate) content: std::vec::Vec<u8>,

  /// Vector which stores all the thumbnails.
  pub(crate) thumbnails: std::vec::Vec<super::thumbnail::Thumbnail>
}

impl<'ole> ThumbsDb<'ole> {

  /// Constructs a new `ThumbsDb`.
  ///
  /// # Examples
  ///
  /// ```
  /// use thumbsdb;
  /// let f = std::fs::File::open("assets/Thumbs.db").unwrap();
  /// let mut hidden_thumbsdb = thumbsdb::ThumbsDb::new(f).unwrap();
  /// ```
  pub fn new<T: 'ole>(readable: T)
      -> Result<ThumbsDb<'ole>, super::error::Error>
    where T: std::io::Read {
    let mut thumbsdb = ThumbsDb {
      ole: ole::Reader::new(readable).map_err(super::error::Error::OLEError)?,
      content: std::vec::Vec::new(),
      thumbnails: std::vec::Vec::new()
    };

    thumbsdb.read_catalog()?;
    thumbsdb.extract_thumbnails()?;
    Ok(thumbsdb)
  }

  /// Constructs a new `ThumbsDb` from filepath.
  ///
  /// # Examples
  ///
  /// ```
  /// use thumbsdb;
  /// let mut hidden_thumbsdb =
  ///     thumbsdb::ThumbsDb::from_path("assets/Thumbs.db").unwrap();
  /// ```
  pub fn from_path(path: &str) -> Result<ThumbsDb, Box<std::error::Error>> {
    match std::fs::File::open(path) {
      Ok(f) => match ThumbsDb::new(f) {
        Ok(t) => Ok(t),
        Err(e) => Err(Box::new(e))
      },
      Err(e) => Err(Box::new(e))
    }
  }

  /// Returns an iterator for thumbnails inside the Thumbs.db
  ///
  /// # Examples
  ///
  /// ```
  /// use thumbsdb;
  /// let mut t = thumbsdb::ThumbsDb::from_path("assets/Thumbs.db").unwrap();
  /// for thumbnail in t.iterate() {
  ///   println!("Entry #{}, filename={}", thumbnail.id(), thumbnail.name());
  /// }
  /// ```
  pub fn iterate(&self) -> super::iterator::ThumbnailIterator {
    super::iterator::ThumbnailIterator::new(self)
  }
}