Project Chimera
Меню

Исходники

451 строк · 20 КиБ

code/crates/chl-gog/src/library.rs

1//! Библиотека GOG: что куплено и адреса установщиков.
2//!
3//! Три эндпоинта, перепроверенные по `sw_func.py` (`fetch_gog_data`,
4//! `get_gog_details`, `download_gog_game`):
5//!
6//! - `GET {API_URL}/user/data/games` — список купленного, только числовые
7//! идентификаторы (`GOG_USER_DATA_GAMES`, `sw_func.py:3253`).
8//! - `GET {API_URL}/account/gameDetails/<id>.json` — название, обложка и
9//! `downloads`: список установщиков по языкам и платформам
10//! (`GOG_GAME_DT`, `sw_func.py:3314-3318`).
11//! - `GET {API_URL}<manualUrl>` — сам файл: GOG отвечает редиректом на
12//! настоящий CDN, и `ureq` идёт по нему как обычный HTTP-клиент
13//! (`sw_func.py:3624-3650`: `urlopen(...)`, `res.geturl()` — итоговый
14//! адрес после редиректа).
15//!
16//! Полей в ответе `gameDetails` больше, чем здесь разобрано — например,
17//! `cdKey`, `changelog`, `extras`, `dlcs`. Взято ровно то, что нужно для
18//! показа карточки и установки, тем же принципом, что и у
19//! `chl_epic::library::CatalogItem`.
20
21use std::collections::BTreeMap;
22
23use anyhow::{Context, Result, bail};
24use serde::{Deserialize, Serialize};
25
26use crate::auth::{Credentials, USER_AGENT};
27
28const API_URL: &str = "https://embed.gog.com";
29
30/// Игра с человеческим названием — то, что показывается в сетке.
31#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
32pub struct Game {
33 /// Числовой идентификатор товара GOG, как строка — им же запрашиваются
34 /// подробности и делается ссылка на установщики.
35 pub id: String,
36 pub title: String,
37 /// Адрес обложки. Поле `backgroundImage` в `gameDetails` — единственная
38 /// картинка, которую этот эндпоинт вообще отдаёт; называется не очень
39 /// точно (по факту это фон карточки в GOG Galaxy, а не бокс-арт), но
40 /// это то, что есть без дополнительного запроса к другому эндпоинту
41 /// каталога, который эта сессия не проверяла.
42 #[serde(default, skip_serializing_if = "Option::is_none")]
43 pub cover_url: Option<String>,
44}
45
46/// Один установщик: часть игры для одной платформы, одного языка.
47///
48/// Большая игра — это чаще несколько файлов (`.exe` плюс `-1.bin`,
49/// `-2.bin`, ...), поэтому это всегда список, а не один установщик на
50/// платформу — см. `sw_func.py:3505-3519`, тот же разбор.
51#[derive(Debug, Clone, Deserialize)]
52pub struct Installer {
53 #[serde(default)]
54 pub name: String,
55 #[serde(default)]
56 pub version: Option<String>,
57 /// Человекочитаемый размер вида `"1.2 GB"` — так его отдаёт GOG, без
58 /// единой единицы измерения на все установщики.
59 #[serde(default)]
60 pub size: Option<String>,
61 /// Относительный адрес — без него установщик не скачать.
62 #[serde(default, rename = "manualUrl")]
63 pub manual_url: Option<String>,
64}
65
66/// Установщики игры, разложенные по платформе — только то, что умеет
67/// запускать этот лаунчер: Windows через Wine, Linux нативно.
68#[derive(Debug, Clone, Default)]
69pub struct Downloads {
70 pub windows: Vec<Installer>,
71 pub linux: Vec<Installer>,
72}
73
74impl Downloads {
75 /// Windows предпочтительнее: весь остальной лаунчер построен вокруг
76 /// Wine, и Windows-сборка гарантированно доступна для игр с DRM,
77 /// завязанным на Galaxy, тогда как нативный Linux-порт GOG делает не
78 /// для каждой игры.
79 pub fn preferred(&self) -> Option<(Platform, &[Installer])> {
80 if !self.windows.is_empty() {
81 Some((Platform::Windows, &self.windows))
82 } else if !self.linux.is_empty() {
83 Some((Platform::Linux, &self.linux))
84 } else {
85 None
86 }
87 }
88}
89
90#[derive(Debug, Clone, Copy, PartialEq, Eq)]
91pub enum Platform {
92 Windows,
93 Linux,
94}
95
96/// Подробности одной игры: то же название и обложка, что и в [`Game`],
97/// плюс установщики.
98pub struct Details {
99 pub game: Game,
100 pub downloads: Downloads,
101}
102
103#[derive(Debug, Deserialize)]
104struct OwnedGames {
105 #[serde(default)]
106 owned: Vec<i64>,
107}
108
109#[derive(Debug, Deserialize)]
110struct ProductDetails {
111 #[serde(default)]
112 title: String,
113 #[serde(default, rename = "backgroundImage")]
114 background_image: Option<String>,
115 /// Список по языкам: `[[название_языка, {платформа: [установщики]}], ...]`.
116 /// Кортеж `(String, _)`, а не отдельная структура — serde умеет
117 /// разбирать двухэлементный JSON-массив прямо в кортеж.
118 #[serde(default)]
119 downloads: Vec<(String, BTreeMap<String, Vec<Installer>>)>,
120}
121
122impl ProductDetails {
123 /// Берётся первый язык из списка — тот же выбор, что и в
124 /// `get_gog_game_info` (`sw_func.py:3499-3500`: `dl_dict = dl[0][1]`).
125 /// GOG не документирует порядок языков в ответе; в наблюдаемых у
126 /// StartWine ответах первым идёт язык интерфейса аккаунта. Для игр с
127 /// одним языком расхождений не будет вовсе.
128 fn downloads(&self) -> Downloads {
129 let Some((_, by_platform)) = self.downloads.first() else {
130 return Downloads::default();
131 };
132 Downloads {
133 windows: by_platform.get("windows").cloned().unwrap_or_default(),
134 linux: by_platform.get("linux").cloned().unwrap_or_default(),
135 }
136 }
137}
138
139/// Клиент библиотеки и загрузки.
140pub struct Client {
141 creds: Credentials,
142}
143
144impl Client {
145 pub fn new(creds: Credentials) -> Self {
146 Self { creds }
147 }
148
149 pub fn account(&self) -> &Credentials {
150 &self.creds
151 }
152
153 /// Идентификаторы купленных товаров — ещё не игры: среди них
154 /// встречаются и не-игры (саундтреки, книги), это выясняется только на
155 /// шаге подробностей, у которого просто не будет `downloads`.
156 pub fn owned_ids(&self) -> Result<Vec<String>> {
157 let text = self.get(&format!("{API_URL}/user/data/games"))?;
158 let owned: OwnedGames =
159 serde_json::from_str(&text).context("список купленного GOG не разбирается")?;
160 Ok(owned.owned.into_iter().map(|id| id.to_string()).collect())
161 }
162
163 /// Подробности одной игры.
164 pub fn details(&self, id: &str) -> Result<Details> {
165 let text = self.get(&format!("{API_URL}/account/gameDetails/{id}.json"))?;
166 let product: ProductDetails =
167 serde_json::from_str(&text).context("подробности игры GOG не разбираются")?;
168 let downloads = product.downloads();
169 Ok(Details {
170 game: Game {
171 id: id.to_string(),
172 title: product.title,
173 cover_url: product.background_image,
174 },
175 downloads,
176 })
177 }
178
179 /// Все игры библиотеки. Без установщиков — не-игры (среди купленного
180 /// попадаются саундтреки и книги) молча пропускаются: без `downloads`
181 /// это не то, что можно поставить и запустить.
182 ///
183 /// Запрос на каждую игру отдельным обращением к `gameDetails` — тот же
184 /// путь, что и у StartWine (`fetch_gog_data`, там это делается
185 /// параллельно потоками; здесь последовательно: библиотеку собирает
186 /// вызывающий код в отдельном потоке, как это уже устроено в
187 /// `chl-gui::stores_page`, и плодить внутри ещё один пул незачем).
188 pub fn games(&self) -> Result<Vec<Game>> {
189 let mut games = Vec::new();
190 for id in self.owned_ids()? {
191 let details = match self.details(&id) {
192 Ok(d) => d,
193 Err(e) => {
194 eprintln!("GOG: подробности {id} — {e}");
195 continue;
196 }
197 };
198 if details.downloads.windows.is_empty() && details.downloads.linux.is_empty() {
199 continue;
200 }
201 games.push(details.game);
202 }
203 games.sort_by(|a, b| a.title.cmp(&b.title));
204 Ok(games)
205 }
206
207 /// Скачивает один установщик по его `manualUrl`. Имя файла берётся из
208 /// заголовка `Content-Disposition`, который CDN отдаёт вместе с файлом
209 /// (иначе взять неоткуда: `manualUrl` — служебный адрес на
210 /// `embed.gog.com`, а не адрес самого файла, см. доккомент модуля).
211 /// Без этого заголовка имя собирается из названия установщика и
212 /// порядкового номера — достаточно, чтобы файл не потерялся, но может
213 /// не совпасть с тем, что ждёт `innoextract` от многотомных
214 /// установщиков (см. `chl_gog::install`).
215 pub fn download_installer(
216 &self,
217 installer: &Installer,
218 index: usize,
219 dest_dir: &std::path::Path,
220 on: &mut impl FnMut(u64, Option<u64>),
221 ) -> Result<std::path::PathBuf> {
222 let Some(manual_url) = &installer.manual_url else {
223 bail!("у установщика нет адреса (manualUrl)");
224 };
225 std::fs::create_dir_all(dest_dir)
226 .with_context(|| format!("не создаётся {}", dest_dir.display()))?;
227
228 let response = crate::download_agent()
229 .get(format!("{API_URL}{manual_url}"))
230 .header("Authorization", &format!("Bearer {}", self.creds.access_token))
231 .header("User-Agent", USER_AGENT)
232 .call();
233 let mut response = match response {
234 Ok(r) => r,
235 Err(ureq::Error::StatusCode(401)) => {
236 bail!("GOG не принял токен — сессия истекла, нужен вход заново")
237 }
238 Err(ureq::Error::StatusCode(code)) => bail!("GOG ответил HTTP {code} на скачивание"),
239 Err(e) => return Err(e).context("не удалось начать скачивание установщика"),
240 };
241
242 let content_disposition = response
243 .headers()
244 .get("content-disposition")
245 .and_then(|v| v.to_str().ok())
246 .map(str::to_string);
247 let filename = content_disposition
248 .and_then(|raw| filename_from_content_disposition(&raw))
249 .unwrap_or_else(|| fallback_filename(installer, index));
250 let target = dest_dir.join(&filename);
251
252 let total = response
253 .headers()
254 .get("content-length")
255 .and_then(|v| v.to_str().ok())
256 .and_then(|v| v.parse::<u64>().ok());
257
258 use std::io::{Read, Write};
259 let partial = std::path::PathBuf::from(format!("{}.частично", target.display()));
260 let mut file = std::fs::File::create(&partial)?;
261 let mut body = response.body_mut().as_reader();
262 let mut buf = vec![0u8; 256 * 1024];
263 let mut done = 0u64;
264 loop {
265 let n = body.read(&mut buf).context("обрыв загрузки установщика")?;
266 if n == 0 {
267 break;
268 }
269 file.write_all(&buf[..n])?;
270 done += n as u64;
271 on(done, total);
272 }
273 file.flush()?;
274 drop(file);
275 std::fs::rename(&partial, &target)?;
276 Ok(target)
277 }
278
279 fn get(&self, url: &str) -> Result<String> {
280 let call = || {
281 crate::api_agent()
282 .get(url)
283 .header("Authorization", &format!("Bearer {}", self.creds.access_token))
284 .header("User-Agent", USER_AGENT)
285 .call()
286 };
287 // Один повтор при сетевой ошибке — не при ответе сервера. Адреса
288 // API в DNS меняются по кругу, и заблокированный попадается не
289 // каждый раз: второй запрос обычно уходит на другой.
290 let response = match call() {
291 Err(e) if crate::worth_retry(&e) => call(),
292 other => other,
293 };
294
295 let mut response = match response {
296 Ok(r) => r,
297 Err(ureq::Error::StatusCode(401)) => {
298 bail!("GOG не принял токен — сессия истекла, нужен вход заново")
299 }
300 Err(ureq::Error::StatusCode(code)) => bail!("GOG ответил HTTP {code}"),
301 Err(e) => return Err(e).context("не удалось связаться с GOG"),
302 };
303 response.body_mut().read_to_string().context("обрыв ответа GOG")
304 }
305}
306
307fn filename_from_content_disposition(raw: &str) -> Option<String> {
308 let marker = "filename=";
309 let after = raw.split(marker).nth(1)?.trim();
310 let name = after.trim_matches('"').split(';').next()?.trim();
311 (!name.is_empty()).then(|| name.to_string())
312}
313
314fn fallback_filename(installer: &Installer, index: usize) -> String {
315 let base: String = installer
316 .name
317 .chars()
318 .map(|c| if c.is_ascii_alphanumeric() { c } else { '_' })
319 .collect();
320 let base = if base.is_empty() { "installer".to_string() } else { base };
321 if index == 0 {
322 format!("{base}.exe")
323 } else {
324 format!("{base}-{index}.bin")
325 }
326}
327
328/// Сохранённый список игр GOG. Устройство — точная копия
329/// `chl_epic::library::cache`: файл можно удалить, соберётся заново.
330pub mod cache {
331 use std::path::{Path, PathBuf};
332
333 use anyhow::{Context, Result};
334
335 pub fn path(cache_dir: &Path) -> PathBuf {
336 cache_dir.join("gog-library.json")
337 }
338
339 pub fn load(cache_dir: &Path) -> Option<Vec<super::Game>> {
340 let text = std::fs::read_to_string(path(cache_dir)).ok()?;
341 serde_json::from_str(&text).ok()
342 }
343
344 pub fn save(cache_dir: &Path, games: &[super::Game]) -> Result<()> {
345 std::fs::create_dir_all(cache_dir)?;
346 let text = serde_json::to_string(games).context("список не сериализуется")?;
347 let p = path(cache_dir);
348 let tmp = p.with_extension("новое");
349 std::fs::write(&tmp, text)?;
350 std::fs::rename(&tmp, &p)?;
351 Ok(())
352 }
353}
354
355#[cfg(test)]
356mod tests {
357 use super::*;
358
359 #[test]
360 fn список_купленного_разбирается() {
361 let owned: OwnedGames = serde_json::from_str(r#"{"owned":[1207658930, 1234567]}"#).unwrap();
362 assert_eq!(owned.owned, vec![1207658930, 1234567]);
363 }
364
365 const DETAILS: &str = r#"{
366 "title": "Пример игры",
367 "backgroundImage": "//images.gog-statics.com/x.jpg",
368 "downloads": [
369 ["English", {
370 "windows": [
371 {"name": "Установка", "version": "1.2.3", "size": "1.2 GB",
372 "manualUrl": "/downlink/example_game/installer1"}
373 ],
374 "linux": []
375 }]
376 ]
377 }"#;
378
379 #[test]
380 fn подробности_разбираются_и_язык_берётся_первый() {
381 let product: ProductDetails = serde_json::from_str(DETAILS).unwrap();
382 assert_eq!(product.title, "Пример игры");
383 let dl = product.downloads();
384 assert_eq!(dl.windows.len(), 1);
385 assert!(dl.linux.is_empty());
386 assert_eq!(dl.windows[0].version.as_deref(), Some("1.2.3"));
387 assert_eq!(dl.windows[0].manual_url.as_deref(), Some("/downlink/example_game/installer1"));
388 }
389
390 #[test]
391 fn windows_предпочтительнее_linux() {
392 let dl = Downloads {
393 windows: vec![Installer { name: "w".into(), version: None, size: None, manual_url: None }],
394 linux: vec![Installer { name: "l".into(), version: None, size: None, manual_url: None }],
395 };
396 let (platform, list) = dl.preferred().unwrap();
397 assert_eq!(platform, Platform::Windows);
398 assert_eq!(list.len(), 1);
399 }
400
401 #[test]
402 fn без_windows_берётся_linux() {
403 let dl = Downloads {
404 windows: vec![],
405 linux: vec![Installer { name: "l".into(), version: None, size: None, manual_url: None }],
406 };
407 assert_eq!(dl.preferred().unwrap().0, Platform::Linux);
408 }
409
410 #[test]
411 fn без_установщиков_ничего_не_выбирается() {
412 assert!(Downloads::default().preferred().is_none());
413 }
414
415 #[test]
416 fn имя_файла_из_content_disposition() {
417 assert_eq!(
418 filename_from_content_disposition(r#"attachment; filename="setup_game_1.2.3.exe""#),
419 Some("setup_game_1.2.3.exe".to_string())
420 );
421 assert_eq!(filename_from_content_disposition("attachment"), None);
422 assert_eq!(filename_from_content_disposition(r#"filename="""#), None);
423 }
424
425 #[test]
426 fn запасное_имя_файла_различает_части() {
427 let inst = Installer { name: "Game Setup!".into(), version: None, size: None, manual_url: None };
428 assert_eq!(fallback_filename(&inst, 0), "Game_Setup_.exe");
429 assert_eq!(fallback_filename(&inst, 1), "Game_Setup_-1.bin");
430 }
431
432 #[test]
433 fn список_игр_переживает_запись_и_чтение_кэша() {
434 let d = std::env::temp_dir().join("chl-test-gog-cache");
435 std::fs::remove_dir_all(&d).ok();
436 assert!(cache::load(&d).is_none());
437
438 let games = vec![Game {
439 id: "1207658930".into(),
440 title: "Пример игры".into(),
441 cover_url: Some("https://example/c.jpg".into()),
442 }];
443 cache::save(&d, &games).unwrap();
444 assert_eq!(cache::load(&d).unwrap(), games);
445
446 std::fs::write(cache::path(&d), "не json").unwrap();
447 assert!(cache::load(&d).is_none());
448 std::fs::remove_dir_all(&d).ok();
449 }
450}
451