File: zip_ffi_glue.rs

package info (click to toggle)
chromium 139.0.7258.138-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 6,120,676 kB
  • sloc: cpp: 35,100,869; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (587 lines) | stat: -rw-r--r-- 21,554 bytes parent folder | download | duplicates (3)
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
// Copyright 2025 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

use anyhow::{anyhow, Error, Result};
use cxx::{CxxString, CxxVector};
use serde::{de, de::Deserializer, de::Error as DeserializerError, Deserialize};
use serde_json_lenient;
use std::fmt;
use std::fs;
use std::io::{BufReader, Read};
use std::path::Path;
use std::pin::Pin;

const STREAM_BUFFER_SIZE: usize = 4096;

#[cxx::bridge(namespace = "user_data_importer")]
mod ffi {
    enum FileType {
        Bookmarks,
        History,
        Passwords,
        PaymentCards,
    }

    // C++ interop version of the HistoryJSONEntry structure.
    // See HistoryJSONEntry for field documentation.
    struct HistoryEntry {
        url: String,
        title: String,
        time_usec: u64,
        visit_count: u64,
    }

    // C++ interop version of the PaymentCardJSONEntry structure.
    // See PaymentCardJSONEntry for field documentation.
    struct PaymentCardEntry {
        card_number: String,
        card_name: String,
        cardholder_name: String,
        card_expiration_month: u64,
        card_expiration_year: u64,
    }

    extern "Rust" {
        type ResultOfZipFileArchive;
        fn err(self: &ResultOfZipFileArchive) -> bool;
        fn unwrap(self: &mut ResultOfZipFileArchive) -> Box<ZipFileArchive>;

        type ZipFileArchive;
        fn get_file_size(self: &mut ZipFileArchive, file_type: FileType) -> u64;
        fn unzip(
            self: &mut ZipFileArchive,
            file_type: FileType,
            mut output_bytes: Pin<&mut CxxString>,
        ) -> bool;
        fn parse_history(
            self: &mut ZipFileArchive,
            history: Pin<&mut CxxVector<HistoryEntry>>,
        ) -> bool;
        fn parse_payment_cards(
            self: &mut ZipFileArchive,
            history: Pin<&mut CxxVector<PaymentCardEntry>>,
        ) -> bool;

        fn new_archive(zip_filename: &[u8]) -> Box<ResultOfZipFileArchive>;
    }
}

// Safari's browser history JSON format, as documented here:
// https://developer.apple.com/documentation/safariservices/importing-data-exported-from-safari?language=objc#Import-browser-history
#[derive(Deserialize)]
struct HistoryJSONEntry {
    // A string that’s the URL of the history item.
    url: String,

    // An optional string that, if present, is the title of the history item.
    title: Option<String>,

    // An integer that’s the UNIX timestamp in microseconds of the latest visit to the item.
    time_usec: u64,

    // An optional string that, if present, is the URL of the next item in the redirect chain.
    // UNUSED: destination_url: Option<String>,

    // An optional integer that’s present if destination_url is also present and is the UNIX
    // timestamp (the number of microseconds since midnight UTC, January 1, 1970) of the next
    // navigation in the redirect chain.
    // UNUSED: destination_time_usec: Option<u64>,

    // An optional string that, if present, is the URL of the previous item in the redirect
    // chain.
    // UNUSED: source_url: Option<String>,

    // An optional integer that’s present if source_url is also present and is the UNIX
    // timestamp in microseconds of the previous navigation in the redirect chain.
    // UNUSED: source_time_usec: Option<u64>,

    // An integer that’s the number of visits the browser made to this item, and is always
    // greater than or equal to 1.
    visit_count: u64,
    //
    // An optional Boolean that’s true if Safari failed to load the site when someone most
    // recently tried to access it; otherwise, it’s false.
    // UNUSED: latest_visit_was_load_failure: Option<bool>,

    // An optional Boolean that’s true if the last visit to this item used the HTTP GET method;
    // otherwise, it’s false.
    // UNUSED: latest_visit_was_http_get: Option<bool>,
}

// Safari's payment cards JSON format, as documented here:
// https://developer.apple.com/documentation/safariservices/importing-data-exported-from-safari?language=objc#Import-payment-cards
#[derive(Deserialize)]
struct PaymentCardJSONEntry {
    // A string that is the payment card number.
    card_number: String,

    // An optional string that, if present, is the name the person gave to the payment card.
    card_name: Option<String>,

    // An optional string that, if present, is the name of the cardholder.
    cardholder_name: Option<String>,

    // An optional integer that, if present, is the month of the card’s expiration date.
    card_expiration_month: Option<u64>,

    // An optional integer that, if present, is the year of the card’s expiration date.
    card_expiration_year: Option<u64>,
    //
    // An optional integer that, if present, is the UNIX timestamp of the most recent occasion the
    // person used the payment card.
    // Note: Safari sometimes puts decimals here, which makes the parsing fail. Read as f64
    // instead.
    // UNUSED: card_last_used_time_usec: Option<f64>,
}

// Safari's metadata JSON format, as documented here:
// https://developer.apple.com/documentation/safariservices/importing-data-exported-from-safari?language=objc#Understand-JSON-metadata
#[derive(Deserialize)]
struct Metadata {
    // A string that’s web browser name, which is Safari if someone exported the data from
    // Safari on iOS, iPadOS, macOS, or visionOS; or Safari Technology Preview if someone
    // exported the data from Safari Technology Preview on macOS.
    // UNUSED: browser_name: String,

    // A string that’s the version of Safari that exported the data, for example 18.2.
    // UNUSED: browser_version: String,

    // A string that describes the data in the file; one of history, extensions, or
    // payment_cards.
    data_type: String,
    //
    // An integer that’s the UNIX timestamp (the number of microseconds since midnight in the
    // UTC time zone on January 1, 1970) at which Safari exported the file.
    // UNUSED: export_time_usec: u64,

    // An integer that’s the version of the export schema.
    // UNUSED: schema_version: u64,
}

impl From<HistoryJSONEntry> for ffi::HistoryEntry {
    fn from(entry: HistoryJSONEntry) -> Self {
        Self {
            url: entry.url,
            title: entry.title.unwrap_or(String::new()),
            time_usec: entry.time_usec,
            visit_count: entry.visit_count,
        }
    }
}

impl From<PaymentCardJSONEntry> for ffi::PaymentCardEntry {
    fn from(entry: PaymentCardJSONEntry) -> Self {
        Self {
            card_number: entry.card_number,
            card_name: entry.card_name.unwrap_or(String::new()),
            cardholder_name: entry.cardholder_name.unwrap_or(String::new()),
            card_expiration_month: entry.card_expiration_month.unwrap_or(0),
            card_expiration_year: entry.card_expiration_year.unwrap_or(0),
        }
    }
}

// Returns the expected extension for the provided file type.
fn expected_extension(file_type: ffi::FileType) -> Result<&'static str> {
    match file_type {
        ffi::FileType::Bookmarks => Ok("html"),
        ffi::FileType::History => Ok("json"),
        ffi::FileType::Passwords => Ok("csv"),
        ffi::FileType::PaymentCards => Ok("json"),
        _ => Err(anyhow!("Unknown file type")),
    }
}

// Verifies if the file in the provided path has the desired extension.
fn has_extension(path: &Path, file_type: ffi::FileType) -> bool {
    let Ok(ext) = expected_extension(file_type) else {
        return false;
    };

    path.extension().map_or(false, |actual_extension| actual_extension.eq_ignore_ascii_case(ext))
}

// Returns the expected data type for the provided file type.
fn expected_data_type(file_type: ffi::FileType) -> Result<&'static str> {
    match file_type {
        ffi::FileType::History => Ok("history"),
        ffi::FileType::PaymentCards => Ok("payment_cards"),
        _ => Err(anyhow!("No data type for this file type")),
    }
}

// Returns the expected array token for the provided file type.
fn array_token_for_data_type(file_type: ffi::FileType) -> Result<&'static str> {
    match file_type {
        ffi::FileType::History => Ok("history"),
        ffi::FileType::PaymentCards => Ok("payment_cards"),
        _ => Err(anyhow!("No array token for this file type")),
    }
}

/// A custom reader that wraps a `zip::read::ZipFile` to implement
/// `io::BufRead`. This allows `serde_json_lenient` to efficiently read from the
/// zip entry without loading the entire entry into memory.
struct ZipEntryBufReader<'a, R: Read> {
    inner: BufReader<zip::read::ZipFile<'a, R>>,
}

impl<'a, R: Read> ZipEntryBufReader<'a, R> {
    fn new(zip_file: zip::read::ZipFile<'a, R>) -> Self {
        ZipEntryBufReader { inner: BufReader::with_capacity(STREAM_BUFFER_SIZE, zip_file) }
    }
}

struct ArrayDeserializerSeed<'de, T>(Box<dyn FnMut(T) + 'de>)
where
    T: Deserialize<'de>;

impl<'de, 'a, T> de::DeserializeSeed<'de> for ArrayDeserializerSeed<'de, T>
where
    T: Deserialize<'de>,
{
    // The return type of the `deserialize` method. This implementation
    // passes elements into `callback` but does not create any new data
    // structure, so the return type is ().
    type Value = ();

    fn deserialize<D>(self, deserializer: D) -> Result<(), D::Error>
    where
        D: de::Deserializer<'de>,
    {
        struct SeqVisitor<'de, T>(Box<dyn FnMut(T) + 'de>);

        impl<'de, T> de::Visitor<'de> for SeqVisitor<'de, T>
        where
            T: Deserialize<'de>,
        {
            type Value = ();

            fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
                formatter.write_str("array")
            }

            fn visit_seq<S>(mut self, mut seq: S) -> Result<(), S::Error>
            where
                S: de::SeqAccess<'de>,
            {
                while let Some(t) = seq.next_element::<T>()? {
                    self.0(t);
                }
                Ok(())
            }
        }

        deserializer.deserialize_seq(SeqVisitor(self.0))
    }
}

fn deserialize_top_level<'de, T, R>(
    mut stream_reader: BufReader<zip::read::ZipFile<'de, R>>,
    file_type: ffi::FileType,
    callback: impl FnMut(T) + 'de,
    metadata_only: bool,
) -> Result<()>
where
    T: Deserialize<'de> + 'de,
    R: std::io::Read,
{
    const VALID_PARTIAL_DESERIALIZATION: &'static str = "Valid partial deserialization";

    struct MapVisitor<'de, T>
    where
        T: Deserialize<'de>,
    {
        file_type: ffi::FileType,
        callback: Box<dyn FnMut(T) + 'de>,
        metadata_only: bool,
    }

    impl<'de, T> de::Visitor<'de> for MapVisitor<'de, T>
    where
        T: Deserialize<'de> + 'de,
    {
        type Value = ();

        fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
            formatter.write_str("map/object")
        }

        fn visit_map<M>(self, mut map: M) -> Result<(), M::Error>
        where
            M: de::MapAccess<'de>,
        {
            const METADATA_TOKEN: &'static str = "metadata";
            let Ok(data_type) = expected_data_type(self.file_type) else {
                return Err(DeserializerError::custom("File type has no associated data type"));
            };
            let Ok(expected_key) = array_token_for_data_type(self.file_type) else {
                return Err(DeserializerError::custom("File type has no associated array token"));
            };
            let mut has_expected_data_type = false;

            while let Some(actual_key) = map.next_key::<String>()? {
                if actual_key == METADATA_TOKEN {
                    if has_expected_data_type {
                        return Err(DeserializerError::custom("Multiple metadata tokens"));
                    }
                    let metadata = map.next_value::<Metadata>()?;
                    has_expected_data_type = metadata.data_type == data_type;
                    if !has_expected_data_type {
                        return Err(DeserializerError::custom("Unexpected data type"));
                    } else if self.metadata_only {
                        // If only the data type check is required, it has been performed
                        // successfully, so no further deserialization is required. To prevent
                        // deserialize_map from generating an error caused by the deserialization
                        // being incomplete, a valid partial deserialization error is returned here
                        // and will be interpreted as a valid result below.
                        return Err(DeserializerError::custom(VALID_PARTIAL_DESERIALIZATION));
                    }
                } else if actual_key == expected_key {
                    if !has_expected_data_type {
                        return Err(DeserializerError::custom("Found array before metadata"));
                    }
                    map.next_value_seed(ArrayDeserializerSeed(Box::new(self.callback)))?;
                    // At this point, the user data array has been parsed successfully, so no
                    // further deserialization is required. To prevent deserialize_map from
                    // generating an error caused by the deserialization being incomplete, a valid
                    // partial deserialization error is returned here and will be interpreted as a
                    // valid result below.
                    return Err(DeserializerError::custom(VALID_PARTIAL_DESERIALIZATION));
                } else {
                    let de::IgnoredAny = map.next_value()?;
                }
            }

            Err(DeserializerError::custom("Array not found"))
        }
    }

    let callback = Box::new(callback);
    let mut d = serde_json_lenient::Deserializer::from_reader(&mut stream_reader);
    match d.deserialize_map(MapVisitor { file_type, callback, metadata_only }) {
        Ok(_) => Ok(()),
        Err(e) => {
            // If the error is a valid partial deserialization error, then all the required
            // tasks have been completed successfully and deserialization was stopped early
            // to prevent any further unnecessary work, so Ok(()) can be returned in this
            // case.
            if e.to_string().starts_with(VALID_PARTIAL_DESERIALIZATION) {
                return Ok(());
            }
            return Err(anyhow!("JSON parsing error: {}", e));
        }
    }
}

// Attempts to parse the history file. Returns whether parsing was successful.
fn parse_history_file<'a, R: Read>(
    stream_reader: ZipEntryBufReader<'a, R>,
    callback: impl FnMut(HistoryJSONEntry) + 'a,
) -> bool {
    return deserialize_top_level::<HistoryJSONEntry, R>(
        stream_reader.inner,
        ffi::FileType::History,
        callback,
        /* metadata_only= */ false,
    )
    .is_ok();
}

// Returns whether the file used by the stream reader is a history file.
fn is_history_file<'a, R: Read>(stream_reader: ZipEntryBufReader<'a, R>) -> bool {
    return deserialize_top_level::<HistoryJSONEntry, R>(
        stream_reader.inner,
        ffi::FileType::History,
        |_| {},
        /* metadata_only= */ true,
    )
    .is_ok();
}

// Attempts to parse the payment cards file. Returns whether parsing was
// successful.
fn parse_payment_cards_file<'a, R: Read>(
    stream_reader: ZipEntryBufReader<'a, R>,
    callback: impl FnMut(PaymentCardJSONEntry) + 'a,
) -> bool {
    return deserialize_top_level::<PaymentCardJSONEntry, R>(
        stream_reader.inner,
        ffi::FileType::PaymentCards,
        callback,
        /* metadata_only= */ false,
    )
    .is_ok();
}

// Returns whether the file used by the stream reader is a payment cards file.
fn is_payment_cards_file<'a, R: Read>(stream_reader: ZipEntryBufReader<'a, R>) -> bool {
    return deserialize_top_level::<PaymentCardJSONEntry, R>(
        stream_reader.inner,
        ffi::FileType::PaymentCards,
        |_| {},
        /* metadata_only= */ true,
    )
    .is_ok();
}

/// FFI-friendly wrapper around `Result<T, E>` (`cxx` can't handle arbitrary
/// generics, so we manually monomorphize here, but still expose a minimal,
/// somewhat tweaked API of the original type).
pub struct ResultOfZipFileArchive(Result<ZipFileArchive, Error>);

impl ResultOfZipFileArchive {
    fn err(&self) -> bool {
        self.0.as_ref().is_err()
    }

    fn unwrap(&mut self) -> Box<ZipFileArchive> {
        // Leaving `self` in a C++-friendly "moved-away" state.
        let mut result = Err(anyhow!("Failed to get archive!"));
        std::mem::swap(&mut self.0, &mut result);
        Box::new(result.unwrap())
    }
}

fn create_archive(zip_filename: &[u8]) -> Result<ZipFileArchive> {
    let path = str::from_utf8(zip_filename)?;
    let file = fs::File::open(path)?;
    let archive = zip::ZipArchive::new(file)?;
    Ok(ZipFileArchive { archive: archive })
}

pub fn new_archive(zip_filename: &[u8]) -> Box<ResultOfZipFileArchive> {
    Box::new(ResultOfZipFileArchive(create_archive(zip_filename)))
}

/// FFI-friendly wrapper around `zip::ZipArchive` (`cxx` can't handle arbitrary
/// generics, so we manually monomorphize here, but still expose a minimal,
/// somewhat tweaked API of the original type).
struct ZipFileArchive {
    archive: zip::ZipArchive<std::fs::File>,
}

impl ZipFileArchive {
    fn get_file_size(&mut self, file_type: ffi::FileType) -> u64 {
        for i in 0..self.archive.len() {
            let Ok(file) = self.archive.by_index(i) else {
                continue;
            };
            let Some(outpath) = file.enclosed_name() else {
                continue;
            };

            // Read the first file matching the requested type found within the zip file.
            if has_extension(&outpath.as_path(), file_type) {
                if file_type == ffi::FileType::Bookmarks || file_type == ffi::FileType::Passwords {
                    return file.size();
                } else {
                    // Verify the data type in the JSON file.
                    let file_size = file.size();
                    let stream_reader = ZipEntryBufReader::new(file);
                    if file_type == ffi::FileType::History {
                        if is_history_file(stream_reader) {
                            return file_size;
                        }
                    } else if file_type == ffi::FileType::PaymentCards {
                        if is_payment_cards_file(stream_reader) {
                            return file_size;
                        }
                    }
                }
            }
        }

        0
    }

    fn unzip(
        self: &mut ZipFileArchive,
        file_type: ffi::FileType,
        mut output_bytes: Pin<&mut CxxString>,
    ) -> bool {
        // Only Bookmarks and Passwords unzip the file as raw data. Other types use JSON
        // parsing.
        if file_type != ffi::FileType::Bookmarks && file_type != ffi::FileType::Passwords {
            return false;
        }

        for i in 0..self.archive.len() {
            let Ok(mut file) = self.archive.by_index(i) else {
                continue;
            };
            let Some(outpath) = file.enclosed_name() else {
                continue;
            };
            if !has_extension(&outpath.as_path(), file_type) {
                continue;
            }

            // Read the first file matching the requested type found within the zip file.
            let mut file_contents = String::new();
            let Ok(_) = file.read_to_string(&mut file_contents) else {
                return false;
            };

            // Copy the contents of the file to the output.
            if file_contents.len() > 0 {
                output_bytes.as_mut().reserve(file_contents.len());
                output_bytes.as_mut().push_str(&file_contents);
            }
            return true;
        }

        false
    }

    fn parse_history(
        self: &mut ZipFileArchive,
        mut history: Pin<&mut CxxVector<ffi::HistoryEntry>>,
    ) -> bool {
        for i in 0..self.archive.len() {
            let Ok(file) = self.archive.by_index(i) else {
                continue;
            };
            let Some(outpath) = file.enclosed_name() else {
                continue;
            };

            if has_extension(&outpath.as_path(), ffi::FileType::History) {
                let stream_reader = ZipEntryBufReader::new(file);
                if parse_history_file(stream_reader, |history_item| {
                    history.as_mut().push(history_item.into());
                }) {
                    return true;
                }
            }
        }

        false
    }

    fn parse_payment_cards(
        self: &mut ZipFileArchive,
        mut payment_cards: Pin<&mut CxxVector<ffi::PaymentCardEntry>>,
    ) -> bool {
        for i in 0..self.archive.len() {
            let Ok(file) = self.archive.by_index(i) else {
                continue;
            };
            let Some(outpath) = file.enclosed_name() else {
                continue;
            };

            if has_extension(&outpath.as_path(), ffi::FileType::PaymentCards) {
                let stream_reader = ZipEntryBufReader::new(file);
                if parse_payment_cards_file(stream_reader, |payment_card_item| {
                    payment_cards.as_mut().push(payment_card_item.into());
                }) {
                    return true;
                }
            }
        }

        false
    }
}