nte_patcher 0.2.1

Rust implementation of NTE PatcherSDK
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
#![allow(missing_docs)]
use crate::cas::BucketManager;
use crate::config::PatcherConfig;
use crate::error::Error;
use crate::model::{ResTask, TaskType};
use crate::{retry, verify};
use futures_util::StreamExt;
use reqwest::{Client, header::RANGE};
use std::sync::Arc;
use tokio::fs;

#[derive(Clone)]
pub struct Downloader {
    client: Client,
    cas_manager: Arc<BucketManager>,
    config: Arc<PatcherConfig>,
}

impl Downloader {
    pub fn new(client: Client, config: Arc<PatcherConfig>) -> Self {
        Self {
            cas_manager: Arc::new(BucketManager::new(config.bucket_dir.clone())),
            client,
            config,
        }
    }

    pub async fn sync_file<F>(
        &self,
        url: &str,
        target_path: &std::path::Path,
        expected_md5: &str,
        expected_size: u64,
        mut on_progress: F,
    ) -> Result<(), Error>
    where
        F: FnMut(u64),
    {
        let bucket_path = self
            .cas_manager
            .get_bucket_path(expected_md5, expected_size);
        let tmp_path = self.cas_manager.get_tmp_path(expected_md5, expected_size);

        if let Some(parent) = bucket_path.parent() {
            fs::create_dir_all(parent).await?;
        }

        if let Some(parent) = target_path.parent() {
            fs::create_dir_all(parent).await?;
        }

        if target_path.exists() || fs::symlink_metadata(target_path).await.is_ok() {
            if let Ok(p) = fs::read_link(target_path).await {
                let is_same = fs::canonicalize(&p).await.unwrap_or_default()
                    == fs::canonicalize(&bucket_path).await.unwrap_or_default();
                if is_same && bucket_path.exists() {
                    on_progress(expected_size);
                    return Ok(());
                }
            } else {
                fs::remove_file(target_path).await?;
            }
        }

        if !bucket_path.exists() {
            self.download_to_tmp(
                url,
                &tmp_path,
                expected_md5,
                expected_size,
                &mut on_progress,
            )
            .await?;
            fs::rename(&tmp_path, &bucket_path).await?;
        } else {
            on_progress(expected_size);
        }

        crate::cas::create_symlink(&bucket_path, target_path).await?;
        Ok(())
    }

    async fn download_to_tmp<F>(
        &self,
        url: &str,
        tmp_path: &std::path::Path,
        expected_md5: &str,
        expected_size: u64,
        on_progress: &mut F,
    ) -> Result<(), Error>
    where
        F: FnMut(u64),
    {
        use md5::{Digest, Md5};
        use tokio::fs::OpenOptions;

        let file = OpenOptions::new()
            .read(true)
            .write(true)
            .create(true)
            .truncate(false)
            .open(tmp_path)
            .await?;

        let mut existing_size = file.metadata().await?.len();
        if existing_size > expected_size {
            file.set_len(0).await?;
            existing_size = 0;
        }

        if existing_size < expected_size {
            file.set_len(expected_size).await?;
        }

        let std_file = file.into_std().await;
        let mmap =
            tokio::task::spawn_blocking(move || -> Result<memmap2::MmapMut, std::io::Error> {
                unsafe { memmap2::MmapMut::map_mut(&std_file) }
            })
            .await
            .unwrap()?;

        let (mut hasher, mut mmap) = if existing_size > 0 {
            tokio::task::spawn_blocking(move || {
                let mut h = Md5::new();
                h.update(&mmap[..(existing_size as usize)]);
                (h, mmap)
            })
            .await
            .unwrap()
        } else {
            (Md5::new(), mmap)
        };

        if existing_size > 0 {
            on_progress(existing_size);
        }

        if existing_size < expected_size {
            let range_header = format!("bytes={}-", existing_size);
            let response = self
                .client
                .get(url)
                .header(RANGE, range_header)
                .send()
                .await?
                .error_for_status()?;

            let mut current_offset = existing_size as usize;

            if response.status() == reqwest::StatusCode::OK {
                hasher = Md5::new();
                current_offset = 0;
                on_progress(0);
            }

            let mut stream = response.bytes_stream();

            while let Some(chunk_result) = stream.next().await {
                let chunk = chunk_result?;
                hasher.update(&chunk);

                let len = chunk.len();
                mmap[current_offset..current_offset + len].copy_from_slice(&chunk);
                current_offset += len;

                on_progress(len as u64);
            }
        }

        tokio::task::spawn_blocking(move || mmap.flush())
            .await
            .unwrap()?;

        let final_md5 = hex::encode(hasher.finalize());
        if final_md5 != expected_md5 {
            let _ = fs::remove_file(tmp_path).await;
            return Err(Error::Checksum {
                expected: expected_md5.to_string(),
                actual: final_md5,
            });
        }

        Ok(())
    }

    pub async fn execute_task<F>(
        &self,
        url: &str,
        task: &ResTask,
        on_progress: F,
    ) -> Result<(), Error>
    where
        F: Fn(u64) + Send + Sync + Clone + 'static,
    {
        let url_c = url.to_string();
        let task_c = task.clone();
        let game_dir = self.config.game_dir.clone();

        let highest_reported = Arc::new(std::sync::atomic::AtomicU64::new(0));

        let this = self.clone();

        retry::with_retry(self.config.retry_count, || {
            let this = this.clone();
            let cas_mgr = this.cas_manager.clone();
            let client = this.client.clone();
            let url = url_c.clone();
            let task = task_c.clone();
            let game_dir = game_dir.clone();

            let try_progress = Arc::new(std::sync::atomic::AtomicU64::new(0));
            let highest = highest_reported.clone();
            let original_prog = on_progress.clone();

            let prog = move |delta: u64| {
                if delta == 0 {
                    return;
                }
                let new_current =
                    try_progress.fetch_add(delta, std::sync::atomic::Ordering::Relaxed) + delta;
                let mut old_highest = highest.load(std::sync::atomic::Ordering::Acquire);
                loop {
                    if new_current <= old_highest {
                        break;
                    }
                    match highest.compare_exchange_weak(
                        old_highest,
                        new_current,
                        std::sync::atomic::Ordering::SeqCst,
                        std::sync::atomic::Ordering::Acquire,
                    ) {
                        Ok(_) => {
                            original_prog(new_current - old_highest);
                            break;
                        }
                        Err(h) => old_highest = h,
                    }
                }
            };

            async move {
                match &task.task_type {
                    TaskType::Normal => {
                        let target_path = game_dir.join(&task.target_path);
                        this.sync_file(&url, &target_path, &task.md5, task.filesize, prog)
                            .await?;
                    }

                    TaskType::Pak { entries } => {
                        let pak_symlink_target =
                            game_dir.join(format!(".pak_cache/{}.pak", task.md5));
                        this.sync_file(
                            &url,
                            &pak_symlink_target,
                            &task.md5,
                            task.filesize,
                            prog.clone(),
                        )
                        .await?;

                        let pak_bucket_path = cas_mgr.get_bucket_path(&task.md5, task.filesize);

                        for entry in entries {
                            let entry_target = game_dir.join(&entry.name);
                            let entry_bucket_path = cas_mgr.get_bucket_path(&entry.md5, entry.size);

                            if let Some(parent) = entry_target.parent() {
                                fs::create_dir_all(parent).await?;
                            }

                            if !entry_bucket_path.exists() {
                                if let Some(parent) = entry_bucket_path.parent() {
                                    fs::create_dir_all(parent).await?;
                                }
                                let tmp_path = cas_mgr.get_tmp_path(&entry.md5, entry.size);
                                let pak_path_c = pak_bucket_path.clone();
                                let tmp_path_c = tmp_path.clone();
                                let offset = entry.offset;
                                let size = entry.size;

                                tokio::task::spawn_blocking(move || -> std::io::Result<()> {
                                    use std::io::{Read, Seek, SeekFrom, Write};
                                    let mut p_file = std::fs::File::open(&pak_path_c)?;
                                    p_file.seek(SeekFrom::Start(offset))?;
                                    let mut chunk = p_file.take(size);

                                    let t_file = std::fs::File::create(&tmp_path_c)?;
                                    let mut buf_writer =
                                        std::io::BufWriter::with_capacity(65536, t_file);

                                    std::io::copy(&mut chunk, &mut buf_writer)?;
                                    buf_writer.flush()?;
                                    Ok(())
                                })
                                .await
                                .unwrap()?;

                                fs::rename(&tmp_path, &entry_bucket_path).await?;
                            }

                            let _ = fs::remove_file(&entry_target).await;
                            #[cfg(unix)]
                            fs::symlink(&entry_bucket_path, &entry_target).await?;
                            #[cfg(windows)]
                            fs::symlink_file(&entry_bucket_path, &entry_target).await?;
                        }

                        let _ = fs::remove_file(&pak_symlink_target).await;
                    }

                    TaskType::Block { blocks } => {
                        let target_path = game_dir.join(&task.target_path);
                        let bucket_path = cas_mgr.get_bucket_path(&task.md5, task.filesize);
                        let tmp_path = cas_mgr.get_tmp_path(&task.md5, task.filesize);

                        if bucket_path.exists() {
                            prog(task.filesize);
                        } else {
                            if let Some(parent) = target_path.parent() {
                                fs::create_dir_all(parent).await?;
                            }
                            if let Some(parent) = bucket_path.parent() {
                                fs::create_dir_all(parent).await?;
                            }

                            let file = fs::OpenOptions::new()
                                .write(true)
                                .read(true)
                                .create(true)
                                .truncate(false)
                                .open(&tmp_path)
                                .await?;
                            if file.metadata().await?.len() != task.filesize {
                                file.set_len(task.filesize).await?;
                            }
                            let std_file = file.into_std().await;
                            let mmap = tokio::task::spawn_blocking(
                                move || -> Result<memmap2::MmapMut, std::io::Error> {
                                    unsafe { memmap2::MmapMut::map_mut(&std_file) }
                                },
                            )
                            .await
                            .unwrap()?;
                            let sync_mmap = std::sync::Arc::new(crate::mmap::SyncMmap::new(mmap));

                            let mut stream = futures_util::stream::iter(
                                blocks.clone().into_iter().map(|block| {
                                    let tmp_path = tmp_path.clone();
                                    let client = client.clone();
                                    let url = url.clone();
                                    let prog = prog.clone();
                                    let block = block.clone();
                                    let sync_mmap = sync_mmap.clone();

                                    async move {
                                        if verify::check_slice_md5(
                                            &tmp_path,
                                            block.start,
                                            block.size,
                                            &block.md5,
                                        )
                                        .await
                                        .unwrap_or(false)
                                        {
                                            prog(block.size);
                                            return Ok::<(), Error>(());
                                        }

                                        let range_header = format!(
                                            "bytes={}-{}",
                                            block.start,
                                            block.start + block.size - 1
                                        );

                                        let response = client
                                            .get(&url)
                                            .header(RANGE, range_header)
                                            .send()
                                            .await?
                                            .error_for_status()?;

                                        let mut current_offset = block.start as usize;
                                        let mut stream = response.bytes_stream();

                                        while let Some(chunk) = stream.next().await {
                                            let data = chunk?;
                                            sync_mmap.write_at(current_offset, &data)?;
                                            current_offset += data.len();
                                            prog(data.len() as u64);
                                        }
                                        Ok::<(), Error>(())
                                    }
                                }),
                            )
                            .buffer_unordered(8);

                            while let Some(result) = stream.next().await {
                                result?;
                            }

                            if !verify::check_file_md5(&tmp_path, &task.md5).await? {
                                let _ = fs::remove_file(&tmp_path).await;
                                return Err(Error::Checksum {
                                    expected: task.md5.clone(),
                                    actual: String::from("unknown (block validation)"),
                                });
                            }

                            fs::rename(&tmp_path, &bucket_path).await?;
                        }

                        let _ = fs::remove_file(&target_path).await;
                        #[cfg(unix)]
                        fs::symlink(&bucket_path, &target_path).await?;
                        #[cfg(windows)]
                        fs::symlink_file(&bucket_path, &target_path).await?;
                    }
                }
                Ok(())
            }
        })
        .await
    }
}