outlook-pst 1.0.0

Outlook PST Store Provider in Rust
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
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
#![doc = include_str!("../README.md")]

use std::{
    fs::{File, OpenOptions},
    io::{self, BufReader, BufWriter, Read, Seek, SeekFrom, Write},
    mem,
    path::Path,
    sync::{Mutex, MutexGuard},
};
use thiserror::Error;

pub mod ltp;
pub mod messaging;
pub mod ndb;

mod block_sig;
mod crc;
mod encode;

use ndb::{
    block::*, block_id::*, block_ref::*, byte_index::*, header::*, page::*, read_write::*, root::*,
    *,
};

#[derive(Error, Debug)]
pub enum PstError {
    #[error("Opened read-only")]
    OpenedReadOnly,
    #[error("Cannot write to file: {0}")]
    NoWriteAccess(String),
    #[error("I/O error: {0:?}")]
    Io(#[from] io::Error),
    #[error("Failed to lock file")]
    LockError,
    #[error("Integer conversion failed")]
    IntegerConversion,
    #[error("Node Database error: {0}")]
    NodeDatabaseError(#[from] NdbError),
    #[error("AllocationMapPage not found: {0}")]
    AllocationMapPageNotFound(usize),
}

impl From<&PstError> for io::Error {
    fn from(err: &PstError) -> io::Error {
        match err {
            PstError::NoWriteAccess(path) => {
                io::Error::new(io::ErrorKind::PermissionDenied, path.as_str())
            }
            err => io::Error::other(format!("{err:?}")),
        }
    }
}

impl From<PstError> for io::Error {
    fn from(err: PstError) -> io::Error {
        match err {
            PstError::NoWriteAccess(path) => {
                io::Error::new(io::ErrorKind::PermissionDenied, path.as_str())
            }
            PstError::Io(err) => err,
            err => io::Error::other(err),
        }
    }
}

type PstResult<T> = std::result::Result<T, PstError>;

trait PstFileLock<Pst>
where
    Pst: PstFile,
{
    fn writer(&mut self) -> &PstResult<Mutex<BufWriter<File>>>;
    fn start_write(&mut self) -> io::Result<()>;
    fn finish_write(&mut self) -> io::Result<()>;
}

pub struct PstFileLockGuard<'a, Pst>
where
    Pst: PstFile,
{
    pst: &'a mut dyn PstFileLock<Pst>,
}

impl<'a, Pst> PstFileLockGuard<'a, Pst>
where
    Pst: PstFile,
{
    fn new(pst: &'a mut dyn PstFileLock<Pst>) -> io::Result<Self> {
        pst.start_write()?;
        Ok(Self { pst })
    }

    pub fn writer(&'a mut self) -> io::Result<MutexGuard<'a, BufWriter<File>>> {
        Ok(self
            .pst
            .writer()
            .as_ref()?
            .lock()
            .map_err(|_| PstError::LockError)?)
    }
}

impl<Pst> Drop for PstFileLockGuard<'_, Pst>
where
    Pst: PstFile,
{
    fn drop(&mut self) {
        let _ = self.pst.finish_write();
    }
}

pub trait PstReader: Read + Seek {}

impl<T> PstReader for T where T: Read + Seek {}

/// [PST File](https://learn.microsoft.com/en-us/openspecs/office_file_formats/ms-pst/6b57253b-0853-47bb-99bb-d4b8f78105f0)
pub trait PstFile: Sized {
    type BlockId: BlockId + BlockIdReadWrite;
    type ByteIndex: ByteIndex + ByteIndexReadWrite;
    type BlockRef: BlockRef<Block = Self::BlockId, Index = Self::ByteIndex> + BlockRefReadWrite;
    type Root: Root<Self>;
    type Header: Header<Self>;
    type PageTrailer: PageTrailer<BlockId = Self::BlockId> + PageTrailerReadWrite;
    type BTreeKey: BTreeEntryKey;
    type NodeBTreeEntry: NodeBTreeEntry<Block = Self::BlockId> + BTreeEntry<Key = Self::BTreeKey>;
    type NodeBTree: NodeBTree<Self, Self::NodeBTreeEntry>;
    type BlockBTreeEntry: BlockBTreeEntry<Block = Self::BlockRef> + BTreeEntry<Key = Self::BTreeKey>;
    type BlockBTree: BlockBTree<Self, Self::BlockBTreeEntry>;
    type IntermediateDataTreeEntry: IntermediateTreeEntry;
    type BlockTrailer: BlockTrailer<BlockId = Self::BlockId>;
    type AllocationMapPage: AllocationMapPage<Self>;
    type AllocationPageMapPage: AllocationPageMapPage<Self>;
    type FreeMapPage: FreeMapPage<Self>;
    type FreePageMapPage: FreePageMapPage<Self>;
    type DensityListPage: DensityListPage<Self>;

    fn header(&self) -> &Self::Header;
    fn density_list(&self) -> Result<&dyn DensityListPage<Self>, &io::Error>;
    fn reader(&self) -> &Mutex<Box<dyn PstReader>>;
    fn lock(&mut self) -> io::Result<PstFileLockGuard<Self>>;
}

pub struct UnicodePstFile {
    reader: Mutex<Box<dyn PstReader>>,
    writer: PstResult<Mutex<BufWriter<File>>>,
    header: UnicodeHeader,
    density_list: io::Result<UnicodeDensityListPage>,
}

impl UnicodePstFile {
    pub fn read_from(reader: Box<dyn PstReader>) -> io::Result<Self> {
        let mut reader = BufReader::new(reader);
        let header = UnicodeHeader::read(&mut reader)?;
        let density_list = UnicodeDensityListPage::read(&mut reader);
        Ok(Self {
            reader: Mutex::new(Box::new(reader)),
            writer: Err(PstError::OpenedReadOnly),
            header,
            density_list,
        })
    }

    pub fn open(path: impl AsRef<Path>) -> io::Result<Self> {
        let reader = Box::new(File::open(&path)?);
        let writer = OpenOptions::new()
            .write(true)
            .open(&path)
            .map(BufWriter::new)
            .map(Mutex::new)
            .map_err(|_| PstError::NoWriteAccess(path.as_ref().display().to_string()));
        Ok(Self {
            writer,
            ..Self::read_from(reader)?
        })
    }
}

impl PstFileLock<UnicodePstFile> for UnicodePstFile {
    fn writer(&mut self) -> &PstResult<Mutex<BufWriter<File>>> {
        &self.writer
    }

    fn start_write(&mut self) -> io::Result<()> {
        <Self as PstFileReadWrite>::start_write(self)
    }

    fn finish_write(&mut self) -> io::Result<()> {
        <Self as PstFileReadWrite>::finish_write(self)
    }
}

impl PstFile for UnicodePstFile {
    type BlockId = UnicodeBlockId;
    type ByteIndex = UnicodeByteIndex;
    type BlockRef = UnicodeBlockRef;
    type Root = UnicodeRoot;
    type Header = UnicodeHeader;
    type PageTrailer = UnicodePageTrailer;
    type BTreeKey = u64;
    type NodeBTreeEntry = UnicodeNodeBTreeEntry;
    type NodeBTree = UnicodeNodeBTree;
    type BlockBTreeEntry = UnicodeBlockBTreeEntry;
    type BlockBTree = UnicodeBlockBTree;
    type IntermediateDataTreeEntry = UnicodeDataTreeEntry;
    type BlockTrailer = UnicodeBlockTrailer;
    type AllocationMapPage = UnicodeMapPage<{ PageType::AllocationMap as u8 }>;
    type AllocationPageMapPage = UnicodeMapPage<{ PageType::AllocationPageMap as u8 }>;
    type FreeMapPage = UnicodeMapPage<{ PageType::FreeMap as u8 }>;
    type FreePageMapPage = UnicodeMapPage<{ PageType::FreePageMap as u8 }>;
    type DensityListPage = UnicodeDensityListPage;

    fn header(&self) -> &Self::Header {
        &self.header
    }

    fn density_list(&self) -> Result<&dyn DensityListPage<Self>, &io::Error> {
        self.density_list.as_ref().map(|dl| dl as _)
    }

    fn reader(&self) -> &Mutex<Box<dyn PstReader>> {
        &self.reader
    }

    fn lock(&mut self) -> io::Result<PstFileLockGuard<Self>> {
        PstFileLockGuard::new(self)
    }
}

pub struct AnsiPstFile {
    reader: Mutex<Box<dyn PstReader>>,
    writer: PstResult<Mutex<BufWriter<File>>>,
    header: ndb::header::AnsiHeader,
    density_list: io::Result<ndb::page::AnsiDensityListPage>,
}

impl AnsiPstFile {
    pub fn read_from(reader: Box<dyn PstReader>) -> io::Result<Self> {
        let mut reader = BufReader::new(reader);
        let header = AnsiHeader::read(&mut reader)?;
        let density_list = AnsiDensityListPage::read(&mut reader);
        Ok(Self {
            reader: Mutex::new(Box::new(reader)),
            writer: Err(PstError::OpenedReadOnly),
            header,
            density_list,
        })
    }

    pub fn open(path: impl AsRef<Path>) -> io::Result<Self> {
        let reader = Box::new(File::open(&path)?);
        let writer = OpenOptions::new()
            .write(true)
            .open(&path)
            .map(BufWriter::new)
            .map(Mutex::new)
            .map_err(|_| PstError::NoWriteAccess(path.as_ref().display().to_string()));
        Ok(Self {
            writer,
            ..Self::read_from(reader)?
        })
    }
}

impl PstFileLock<AnsiPstFile> for AnsiPstFile {
    fn writer(&mut self) -> &PstResult<Mutex<BufWriter<File>>> {
        &self.writer
    }

    fn start_write(&mut self) -> io::Result<()> {
        <Self as PstFileReadWrite>::start_write(self)
    }

    fn finish_write(&mut self) -> io::Result<()> {
        <Self as PstFileReadWrite>::finish_write(self)
    }
}

impl PstFile for AnsiPstFile {
    type BlockId = AnsiBlockId;
    type ByteIndex = AnsiByteIndex;
    type BlockRef = AnsiBlockRef;
    type Root = AnsiRoot;
    type Header = AnsiHeader;
    type PageTrailer = AnsiPageTrailer;
    type BTreeKey = u32;
    type NodeBTreeEntry = AnsiNodeBTreeEntry;
    type NodeBTree = AnsiNodeBTree;
    type BlockBTreeEntry = AnsiBlockBTreeEntry;
    type BlockBTree = AnsiBlockBTree;
    type IntermediateDataTreeEntry = AnsiDataTreeEntry;
    type BlockTrailer = AnsiBlockTrailer;
    type AllocationMapPage = AnsiMapPage<{ PageType::AllocationMap as u8 }>;
    type AllocationPageMapPage = AnsiMapPage<{ PageType::AllocationPageMap as u8 }>;
    type FreeMapPage = AnsiMapPage<{ PageType::FreeMap as u8 }>;
    type FreePageMapPage = AnsiMapPage<{ PageType::FreePageMap as u8 }>;
    type DensityListPage = AnsiDensityListPage;

    fn header(&self) -> &Self::Header {
        &self.header
    }

    fn density_list(&self) -> Result<&dyn DensityListPage<Self>, &io::Error> {
        self.density_list.as_ref().map(|dl| dl as _)
    }

    fn reader(&self) -> &Mutex<Box<dyn PstReader>> {
        &self.reader
    }

    fn lock(&mut self) -> io::Result<PstFileLockGuard<Self>> {
        PstFileLockGuard::new(self)
    }
}

const AMAP_FIRST_OFFSET: u64 = 0x4400;
const AMAP_DATA_SIZE: u64 = size_of::<MapBits>() as u64 * 8 * 64;

const PMAP_FIRST_OFFSET: u64 = AMAP_FIRST_OFFSET + PAGE_SIZE as u64;
const PMAP_PAGE_COUNT: u64 = 8;
const PMAP_DATA_SIZE: u64 = AMAP_DATA_SIZE * PMAP_PAGE_COUNT;

const FMAP_FIRST_SIZE: u64 = 128;
const FMAP_FIRST_DATA_SIZE: u64 = AMAP_DATA_SIZE * FMAP_FIRST_SIZE;
const FMAP_FIRST_OFFSET: u64 = AMAP_FIRST_OFFSET + FMAP_FIRST_DATA_SIZE + (2 * PAGE_SIZE) as u64;
const FMAP_PAGE_COUNT: u64 = size_of::<MapBits>() as u64;
const FMAP_DATA_SIZE: u64 = AMAP_DATA_SIZE * FMAP_PAGE_COUNT;

const FPMAP_FIRST_SIZE: u64 = 128 * 64;
const FPMAP_FIRST_DATA_SIZE: u64 = AMAP_DATA_SIZE * FPMAP_FIRST_SIZE;
const FPMAP_FIRST_OFFSET: u64 = AMAP_FIRST_OFFSET + FPMAP_FIRST_DATA_SIZE + (3 * PAGE_SIZE) as u64;
const FPMAP_PAGE_COUNT: u64 = size_of::<MapBits>() as u64 * 64;
const FPMAP_DATA_SIZE: u64 = AMAP_DATA_SIZE * FPMAP_PAGE_COUNT;

struct AllocationMapPageInfo<Pst>
where
    Pst: PstFile,
    <Pst as PstFile>::AllocationMapPage: AllocationMapPageReadWrite<Pst>,
{
    amap_page: <Pst as PstFile>::AllocationMapPage,
    free_space: u64,
}

impl<Pst> AllocationMapPageInfo<Pst>
where
    Pst: PstFile,
    <Pst as PstFile>::AllocationMapPage: AllocationMapPageReadWrite<Pst>,
{
    fn max_free_slots(&self) -> u8 {
        u8::try_from(self.amap_page.find_free_bits(0xFF).len()).unwrap_or(0xFF)
    }
}

type PstFileReadWriteNodeBTree<Pst> = RootBTreePage<
    Pst,
    <<Pst as PstFile>::NodeBTree as RootBTree>::Entry,
    <<Pst as PstFile>::NodeBTree as RootBTree>::IntermediatePage,
    <<Pst as PstFile>::NodeBTree as RootBTree>::LeafPage,
>;

type PstFileReadWriteBlockBTree<Pst> = RootBTreePage<
    Pst,
    <<Pst as PstFile>::BlockBTree as RootBTree>::Entry,
    <<Pst as PstFile>::BlockBTree as RootBTree>::IntermediatePage,
    <<Pst as PstFile>::BlockBTree as RootBTree>::LeafPage,
>;

trait PstFileReadWrite: PstFile + PstFileLock<Self>
where
    <Self as PstFile>::BlockId:
        From<<<Self as PstFile>::ByteIndex as ByteIndex>::Index> + BlockIdReadWrite,
    <Self as PstFile>::ByteIndex: ByteIndex<Index: TryFrom<u64>> + ByteIndexReadWrite,
    <Self as PstFile>::BlockRef: BlockRefReadWrite,
    <Self as PstFile>::Root: RootReadWrite<Self>,
    <Self as PstFile>::Header: HeaderReadWrite<Self>,
    <Self as PstFile>::PageTrailer: PageTrailerReadWrite,
    <Self as PstFile>::BTreeKey: BTreePageKeyReadWrite,
    <Self as PstFile>::NodeBTreeEntry: NodeBTreeEntryReadWrite,
    <Self as PstFile>::NodeBTree: RootBTreeReadWrite,
    <<Self as PstFile>::NodeBTree as RootBTree>::IntermediatePage:
        RootBTreeIntermediatePageReadWrite<
            Self,
            <Self as PstFile>::NodeBTreeEntry,
            <<Self as PstFile>::NodeBTree as RootBTree>::LeafPage,
        >,
    <<Self as PstFile>::NodeBTree as RootBTree>::LeafPage: RootBTreeLeafPageReadWrite<Self>,
    <Self as PstFile>::BlockBTreeEntry: BlockBTreeEntryReadWrite,
    <Self as PstFile>::BlockBTree: RootBTreeReadWrite,

    <<Self as PstFile>::BlockBTree as RootBTree>::IntermediatePage:
        RootBTreeIntermediatePageReadWrite<
            Self,
            <Self as PstFile>::BlockBTreeEntry,
            <<Self as PstFile>::BlockBTree as RootBTree>::LeafPage,
        >,
    <<Self as PstFile>::BlockBTree as RootBTree>::LeafPage: RootBTreeLeafPageReadWrite<Self>,
    <Self as PstFile>::BlockTrailer: BlockTrailerReadWrite,
    <Self as PstFile>::AllocationMapPage: AllocationMapPageReadWrite<Self>,
    <Self as PstFile>::AllocationPageMapPage: AllocationPageMapPageReadWrite<Self>,
    <Self as PstFile>::FreeMapPage: FreeMapPageReadWrite<Self>,
    <Self as PstFile>::FreePageMapPage: FreePageMapPageReadWrite<Self>,
    <Self as PstFile>::DensityListPage: DensityListPageReadWrite<Self>,
{
    fn header_mut(&mut self) -> &mut <Self as PstFile>::Header;

    fn start_write(&mut self) -> io::Result<()> {
        self.rebuild_allocation_map()?;

        let header = {
            let header = self.header_mut();
            header.update_unique();

            let root = header.root_mut();
            root.set_amap_status(AmapStatus::Invalid);
            header.clone()
        };

        let mut writer = self
            .writer()
            .as_ref()?
            .lock()
            .map_err(|_| PstError::LockError)?;
        let writer = &mut *writer;
        writer.seek(SeekFrom::Start(0))?;
        header.write(writer)?;
        writer.flush()
    }

    fn finish_write(&mut self) -> io::Result<()> {
        let header = {
            let header = self.header_mut();
            header.update_unique();
            let root = header.root_mut();
            root.set_amap_status(AmapStatus::Valid2);
            header.clone()
        };

        let mut writer = self
            .writer()
            .as_ref()?
            .lock()
            .map_err(|_| PstError::LockError)?;
        let writer = &mut *writer;
        writer.seek(SeekFrom::Start(0))?;
        header.write(writer)?;
        writer.flush()
    }

    /// [Crash Recovery and AMap Rebuilding](https://learn.microsoft.com/en-us/openspecs/office_file_formats/ms-pst/d9bcc1fd-c66a-41b3-b6d7-ed09d2a25ced)
    fn rebuild_allocation_map(&mut self) -> io::Result<()> {
        let header = self.header();
        let root = header.root();
        if AmapStatus::Invalid != root.amap_is_valid() {
            return Ok(());
        }

        let num_amap_pages = root.file_eof_index().index().into() - AMAP_FIRST_OFFSET;
        let num_amap_pages = num_amap_pages.div_ceil(AMAP_DATA_SIZE);

        let mut amap_pages: Vec<_> = (0..num_amap_pages)
            .map(|index| {
                let has_pmap_page = index % 8 == 0;
                let has_fmap_page = has_pmap_page
                    && index >= FMAP_FIRST_SIZE
                    && (index - FMAP_FIRST_SIZE) % FMAP_PAGE_COUNT == 0;
                let has_fpmap_page = has_pmap_page
                    && index >= FPMAP_FIRST_SIZE
                    && (index - FPMAP_FIRST_SIZE) % FPMAP_PAGE_COUNT == 0;

                let index =
                    <<<Self as PstFile>::ByteIndex as ByteIndex>::Index as TryFrom<u64>>::try_from(
                        index * AMAP_DATA_SIZE + AMAP_FIRST_OFFSET,
                    )
                    .map_err(|_| PstError::IntegerConversion)?;
                let index = <Self as PstFile>::BlockId::from(index);

                let trailer = <<Self as PstFile>::PageTrailer as PageTrailerReadWrite>::new(
                    PageType::AllocationMap,
                    0,
                    index,
                    0,
                );

                let mut map_bits = [0; mem::size_of::<MapBits>()];
                let mut reserved = 1;
                if has_pmap_page {
                    reserved += 1;
                }
                if has_fmap_page {
                    reserved += 1;
                }
                if has_fpmap_page {
                    reserved += 1;
                }

                let free_space = AMAP_DATA_SIZE - (reserved * PAGE_SIZE) as u64;

                let reserved = &[0xFF; 4][..reserved];
                map_bits[..reserved.len()].copy_from_slice(reserved);

                let amap_page =
                    <<Self as PstFile>::AllocationMapPage as AllocationMapPageReadWrite<Self>>::new(
                        map_bits, trailer,
                    )?;
                Ok(AllocationMapPageInfo::<Self> {
                    amap_page,
                    free_space,
                })
            })
            .collect::<PstResult<Vec<_>>>()?;

        {
            let mut reader = self.reader().lock().map_err(|_| PstError::LockError)?;
            let reader = &mut *reader;

            let node_btree =
                <Self::NodeBTree as RootBTreeReadWrite>::read(reader, *root.node_btree())?;

            self.mark_node_btree_allocations(
                reader,
                root.node_btree().index(),
                &node_btree,
                &mut amap_pages,
            )?;

            let block_btree =
                <Self::BlockBTree as RootBTreeReadWrite>::read(reader, *root.block_btree())?;

            self.mark_block_btree_allocations(
                reader,
                root.block_btree().index(),
                &block_btree,
                &mut amap_pages,
            )?;
        }

        let free_bytes = amap_pages.iter().map(|page| page.free_space).sum();

        let mut first_fmap = [0; FMAP_FIRST_SIZE as usize];
        for (entry, free_space) in first_fmap
            .iter_mut()
            .zip(amap_pages.iter().map(|page| page.max_free_slots()))
        {
            *entry = free_space;
        }

        let pmap_pages: Vec<_> = (0..=(num_amap_pages / 8))
            .map(|index| {
                let index =
                    <<<Self as PstFile>::ByteIndex as ByteIndex>::Index as TryFrom<u64>>::try_from(
                        index * PMAP_DATA_SIZE + PMAP_FIRST_OFFSET,
                    )
                    .map_err(|_| PstError::IntegerConversion)?;
                let index = <Self as PstFile>::BlockId::from(index);

                let trailer = <<Self as PstFile>::PageTrailer as PageTrailerReadWrite>::new(
                    PageType::AllocationPageMap,
                    0,
                    index,
                    0,
                );

                let map_bits = [0xFF; mem::size_of::<MapBits>()];

                let pmap_page =
                    <<Self as PstFile>::AllocationPageMapPage as AllocationPageMapPageReadWrite<
                        Self,
                    >>::new(map_bits, trailer)?;
                Ok(pmap_page)
            })
            .collect::<PstResult<Vec<_>>>()?;

        let fmap_pages: Vec<_> = (0..(num_amap_pages.max(FMAP_FIRST_SIZE) - FMAP_FIRST_SIZE)
            .div_ceil(FMAP_PAGE_COUNT))
            .map(|index| {
                let amap_index =
                    FMAP_FIRST_SIZE as usize + (index as usize * mem::size_of::<MapBits>());
                let index =
                    <<<Self as PstFile>::ByteIndex as ByteIndex>::Index as TryFrom<u64>>::try_from(
                        index * FMAP_DATA_SIZE + FMAP_FIRST_OFFSET,
                    )
                    .map_err(|_| PstError::IntegerConversion)?;
                let index = <Self as PstFile>::BlockId::from(index);

                let trailer = <<Self as PstFile>::PageTrailer as PageTrailerReadWrite>::new(
                    PageType::FreeMap,
                    0,
                    index,
                    0,
                );

                let mut map_bits = [0; mem::size_of::<MapBits>()];
                for (entry, free_space) in map_bits.iter_mut().zip(
                    amap_pages
                        .iter()
                        .skip(amap_index)
                        .map(|page| page.max_free_slots()),
                ) {
                    *entry = free_space;
                }

                let fmap_page =
                    <<Self as PstFile>::FreeMapPage as FreeMapPageReadWrite<Self>>::new(
                        map_bits, trailer,
                    )?;
                Ok(fmap_page)
            })
            .collect::<PstResult<Vec<_>>>()?;

        let fpmap_pages: Vec<_> = (0..(num_amap_pages.max(FPMAP_FIRST_SIZE) - FPMAP_FIRST_SIZE)
            .div_ceil(FPMAP_PAGE_COUNT))
            .map(|index| {
                let index =
                    <<<Self as PstFile>::ByteIndex as ByteIndex>::Index as TryFrom<u64>>::try_from(
                        index * FPMAP_DATA_SIZE + FPMAP_FIRST_OFFSET,
                    )
                    .map_err(|_| PstError::IntegerConversion)?;
                let index = <Self as PstFile>::BlockId::from(index);

                let trailer = <<Self as PstFile>::PageTrailer as PageTrailerReadWrite>::new(
                    PageType::FreePageMap,
                    0,
                    index,
                    0,
                );

                let map_bits = [0xFF; mem::size_of::<MapBits>()];

                let fmap_page = <<Self as PstFile>::FreePageMapPage as FreePageMapPageReadWrite<
                    Self,
                >>::new(map_bits, trailer)?;
                Ok(fmap_page)
            })
            .collect::<PstResult<Vec<_>>>()?;

        {
            let mut writer = self
                .writer()
                .as_ref()?
                .lock()
                .map_err(|_| PstError::LockError)?;
            let writer = &mut *writer;

            for page in amap_pages.into_iter().map(|info| info.amap_page) {
                let index: <<Self as PstFile>::BlockId as BlockId>::Index =
                    page.trailer().block_id().into();

                writer.seek(SeekFrom::Start(index.into()))?;
                <Self::AllocationMapPage as AllocationMapPageReadWrite<Self>>::write(
                    &page, writer,
                )?;
            }

            for page in pmap_pages.into_iter() {
                let index: <<Self as PstFile>::BlockId as BlockId>::Index =
                    page.trailer().block_id().into();

                writer.seek(SeekFrom::Start(index.into()))?;
                <Self::AllocationPageMapPage as AllocationPageMapPageReadWrite<Self>>::write(
                    &page, writer,
                )?;
            }

            for page in fmap_pages.into_iter() {
                let index: <<Self as PstFile>::BlockId as BlockId>::Index =
                    page.trailer().block_id().into();

                writer.seek(SeekFrom::Start(index.into()))?;
                <Self::FreeMapPage as FreeMapPageReadWrite<Self>>::write(&page, writer)?;
            }

            for page in fpmap_pages.into_iter() {
                let index: <<Self as PstFile>::BlockId as BlockId>::Index =
                    page.trailer().block_id().into();

                writer.seek(SeekFrom::Start(index.into()))?;
                <Self::FreePageMapPage as FreePageMapPageReadWrite<Self>>::write(&page, writer)?;
            }

            writer.flush()?;
        }

        let header = {
            let header = self.header_mut();
            <<Self as PstFile>::Header as HeaderReadWrite<Self>>::first_free_map(header)
                .copy_from_slice(&first_fmap);
            let root = header.root_mut();
            root.reset_free_size(free_bytes)?;
            root.set_amap_status(AmapStatus::Valid2);
            header.clone()
        };

        let mut writer = self
            .writer()
            .as_ref()?
            .lock()
            .map_err(|_| PstError::LockError)?;
        let writer = &mut *writer;
        writer.seek(SeekFrom::Start(0))?;
        header.write(writer)?;
        writer.flush()
    }

    fn mark_node_btree_allocations<R: Read + Seek>(
        &self,
        reader: &mut R,
        page_index: Self::ByteIndex,
        node_btree: &PstFileReadWriteNodeBTree<Self>,
        amap_pages: &mut Vec<AllocationMapPageInfo<Self>>,
    ) -> io::Result<()> {
        Self::mark_page_allocation(page_index.index().into(), amap_pages)?;

        if let RootBTreePage::Intermediate(page, ..) = node_btree {
            for entry in page.entries() {
                let block = entry.block();
                let node_btree = <Self::NodeBTree as RootBTreeReadWrite>::read(reader, block)?;
                self.mark_node_btree_allocations(reader, block.index(), &node_btree, amap_pages)?;
            }
        }

        Ok(())
    }

    fn mark_block_btree_allocations<R: Read + Seek>(
        &self,
        reader: &mut R,
        page_index: Self::ByteIndex,
        block_btree: &PstFileReadWriteBlockBTree<Self>,
        amap_pages: &mut Vec<AllocationMapPageInfo<Self>>,
    ) -> io::Result<()> {
        Self::mark_page_allocation(page_index.index().into(), amap_pages)?;

        match block_btree {
            RootBTreePage::Intermediate(page, ..) => {
                for entry in page.entries() {
                    let block_btree =
                        <Self::BlockBTree as RootBTreeReadWrite>::read(reader, entry.block())?;
                    self.mark_block_btree_allocations(
                        reader,
                        entry.block().index(),
                        &block_btree,
                        amap_pages,
                    )?;
                }
            }
            RootBTreePage::Leaf(page) => {
                for entry in page.entries() {
                    Self::mark_block_allocation(
                        entry.block().index().index().into(),
                        entry.size(),
                        amap_pages,
                    )?;
                }
            }
        }
        Ok(())
    }

    fn mark_page_allocation(
        index: u64,
        amap_pages: &mut Vec<AllocationMapPageInfo<Self>>,
    ) -> io::Result<()> {
        let index = index - AMAP_FIRST_OFFSET;
        let amap_index =
            usize::try_from(index / AMAP_DATA_SIZE).map_err(|_| PstError::IntegerConversion)?;
        let entry = amap_pages
            .get_mut(amap_index)
            .ok_or(PstError::AllocationMapPageNotFound(amap_index))?;
        entry.free_space -= PAGE_SIZE as u64;

        let bytes = entry.amap_page.map_bits_mut();

        let bit_index = usize::try_from((index % AMAP_DATA_SIZE) / 64)
            .map_err(|_| PstError::IntegerConversion)?;
        let byte_index = bit_index / 8;
        let bit_index = bit_index % 8;

        if bit_index == 0 {
            bytes[byte_index] = 0xFF;
        } else {
            let mask = 0x80_u8 >> bit_index;
            let mask = mask | (mask - 1);
            bytes[byte_index] |= mask;
            bytes[byte_index + 1] |= !mask;
        }

        Ok(())
    }

    fn mark_block_allocation(
        index: u64,
        size: u16,
        amap_pages: &mut Vec<AllocationMapPageInfo<Self>>,
    ) -> io::Result<()> {
        let index = index - AMAP_FIRST_OFFSET;
        let amap_index =
            usize::try_from(index / AMAP_DATA_SIZE).map_err(|_| PstError::IntegerConversion)?;
        let entry = amap_pages
            .get_mut(amap_index)
            .ok_or(PstError::AllocationMapPageNotFound(amap_index))?;
        let size = u64::from(block_size(
            size + <<Self as PstFile>::BlockTrailer as BlockTrailerReadWrite>::SIZE,
        ));
        entry.free_space -= size;

        let bytes = entry.amap_page.map_bits_mut();

        let bit_start = usize::try_from((index % AMAP_DATA_SIZE) / 64)
            .map_err(|_| PstError::IntegerConversion)?;
        let bit_end =
            bit_start + usize::try_from(size / 64).map_err(|_| PstError::IntegerConversion)?;
        let byte_start = bit_start / 8;
        let bit_start = bit_start % 8;
        let byte_end = bit_end / 8;
        let bit_end = bit_end % 8;

        if byte_start == byte_end {
            // The allocation fits in a single byte
            if bit_end > bit_start {
                let mask_start = 0x80_u8 >> bit_start;
                let mask_start = mask_start | (mask_start - 1);
                let mask_end = 0x80_u8 >> bit_end;
                let mask_end = !(mask_end | (mask_end - 1));
                let mask = mask_start & mask_end;
                bytes[byte_start] |= mask;
            }
            return Ok(());
        }

        let byte_start = if bit_start == 0 {
            byte_start
        } else {
            let mask_start = 0x80_u8 >> bit_start;
            let mask_start = mask_start | (mask_start - 1);
            bytes[byte_start] |= mask_start;
            byte_start + 1
        };

        if bit_end != 0 {
            let mask_end = 0x80_u8 >> bit_end;
            let mask_end = !(mask_end | (mask_end - 1));
            bytes[byte_end] |= mask_end;
        };

        if byte_end > byte_start {
            for byte in &mut bytes[byte_start..byte_end] {
                *byte = 0xFF;
            }
        }

        Ok(())
    }
}

impl PstFileReadWrite for UnicodePstFile {
    fn header_mut(&mut self) -> &mut <Self as PstFile>::Header {
        &mut self.header
    }
}

impl PstFileReadWrite for AnsiPstFile {
    fn header_mut(&mut self) -> &mut <Self as PstFile>::Header {
        &mut self.header
    }
}