lingxia-lxapp 0.16.0

LxApp (lightweight application) container and runtime for LingXia framework
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
use lingxia_update::{Channel, SemanticVersion};
use redb::{Database, ReadableDatabase, ReadableTable, TableDefinition};
use serde::{Deserialize, Serialize};
use std::collections::{BTreeMap, BTreeSet};
use std::fmt;
use std::fs;
use std::path::PathBuf;
use std::sync::{Arc, OnceLock};

use super::version::Version;
use crate::LxAppError;

const INSTALLED_TABLE: TableDefinition<&str, &[u8]> = TableDefinition::new("installed");
const DOWNLOADED_TABLE: TableDefinition<&str, &[u8]> = TableDefinition::new("downloaded");
const REGISTRY_TABLE: TableDefinition<&str, &[u8]> = TableDefinition::new("registry");

static DATABASE: OnceLock<Arc<Database>> = OnceLock::new();

#[derive(Debug, Clone, Serialize, Deserialize)]
pub(crate) struct LxAppRecord {
    pub lxappid: String,
    pub release_type: Channel,
    pub version: SemanticVersion,
    pub fingermark: String,
    pub install_path: String,
    pub last_open_at: i64,
    /// SHA-256 of the package that produced this install. Absent on older
    /// records and on bundled first-installs that never went through OTA.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub checksum_sha256: Option<String>,
}

impl LxAppRecord {
    pub fn new(
        lxappid: &str,
        release_type: Channel,
        version: SemanticVersion,
        fingermark: String,
        install_path: String,
        last_open_at: i64,
    ) -> Self {
        Self {
            lxappid: lxappid.to_string(),
            release_type,
            version,
            fingermark,
            install_path,
            last_open_at,
            checksum_sha256: None,
        }
    }

    pub fn version_string(&self) -> String {
        self.version.to_version_string()
    }
}

pub(crate) fn init(db_path: PathBuf) -> Result<(), LxAppError> {
    if DATABASE.get().is_some() {
        return Ok(());
    }

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

    let db = if db_path.exists() {
        Database::open(&db_path).map_err(|e| metadata_error("open database", e))?
    } else {
        Database::create(&db_path).map_err(|e| metadata_error("create database", e))?
    };

    let write_txn = db
        .begin_write()
        .map_err(|e| metadata_error("begin write transaction", e))?;
    {
        let _installed = write_txn
            .open_table(INSTALLED_TABLE)
            .map_err(|e| metadata_error("open installed table", e))?;
        let _downloaded = write_txn
            .open_table(DOWNLOADED_TABLE)
            .map_err(|e| metadata_error("open downloaded table", e))?;
        let _registry = write_txn
            .open_table(REGISTRY_TABLE)
            .map_err(|e| metadata_error("open registry table", e))?;
    }
    write_txn
        .commit()
        .map_err(|e| metadata_error("commit table creation", e))?;

    let _ = DATABASE.set(Arc::new(db));
    Ok(())
}

pub(crate) fn get(lxappid: &str, release_type: Channel) -> Result<Option<LxAppRecord>, LxAppError> {
    let key = key_for(lxappid, release_type);
    let db = database()?;
    let txn = db
        .begin_read()
        .map_err(|e| metadata_error("begin read transaction", e))?;
    let table = txn
        .open_table(INSTALLED_TABLE)
        .map_err(|e| metadata_error("open installed table", e))?;
    if let Some(value) = table
        .get(key.as_str())
        .map_err(|e| metadata_error("read record", e))?
    {
        let record: LxAppRecord = serde_json::from_slice(value.value())?;
        Ok(Some(record))
    } else {
        Ok(None)
    }
}

pub(crate) fn upsert(record: &LxAppRecord) -> Result<(), LxAppError> {
    let key = key_for(&record.lxappid, record.release_type);
    let db = database()?;
    let txn = db
        .begin_write()
        .map_err(|e| metadata_error("begin write transaction", e))?;
    {
        let mut table = txn
            .open_table(INSTALLED_TABLE)
            .map_err(|e| metadata_error("open installed table", e))?;
        let serialized = serde_json::to_vec(record)?;
        table
            .insert(key.as_str(), serialized.as_slice())
            .map_err(|e| metadata_error("write installed record", e))?;
    }
    txn.commit()
        .map_err(|e| metadata_error("commit installed write", e))?;
    Ok(())
}

pub(crate) fn remove_all(lxappid: &str) -> Result<(), LxAppError> {
    let prefix = format!("{}::", lxappid);
    let db = database()?;
    let txn = db
        .begin_write()
        .map_err(|e| metadata_error("begin write transaction", e))?;

    {
        let mut table = txn
            .open_table(INSTALLED_TABLE)
            .map_err(|e| metadata_error("open installed table", e))?;
        let mut keys_to_remove = Vec::new();
        let iter = table
            .iter()
            .map_err(|e| metadata_error("iterate installed records", e))?;

        for entry in iter {
            let (key, _) = entry.map_err(|e| metadata_error("read installed record", e))?;
            let key_value = key.value();
            if key_value.starts_with(&prefix) {
                keys_to_remove.push(key_value.to_string());
            }
        }

        for key in keys_to_remove {
            table
                .remove(key.as_str())
                .map_err(|e| metadata_error("delete installed record", e))?;
        }
    }

    txn.commit()
        .map_err(|e| metadata_error("commit installed delete", e))?;
    Ok(())
}

pub(crate) fn remove(lxappid: &str, release_type: Channel) -> Result<(), LxAppError> {
    let key = key_for(lxappid, release_type);
    let db = database()?;
    let txn = db
        .begin_write()
        .map_err(|e| metadata_error("begin write transaction", e))?;
    {
        let mut table = txn
            .open_table(INSTALLED_TABLE)
            .map_err(|e| metadata_error("open installed table", e))?;
        table
            .remove(key.as_str())
            .map_err(|e| metadata_error("delete installed record", e))?;
    }
    txn.commit()
        .map_err(|e| metadata_error("commit installed delete", e))?;
    Ok(())
}

fn key_for(lxappid: &str, release_type: Channel) -> String {
    format!("{}::{}", lxappid, release_type.as_str())
}

pub(crate) fn database() -> Result<Arc<Database>, LxAppError> {
    DATABASE
        .get()
        .cloned()
        .ok_or_else(|| LxAppError::Runtime("metadata database not initialized".to_string()))
}

pub(crate) fn metadata_error(action: &str, err: impl fmt::Display) -> LxAppError {
    LxAppError::Runtime(format!("metadata database {} failed: {}", action, err))
}

// Update last open time for an installed app
pub(crate) fn touch_last_open(
    lxappid: &str,
    release_type: Channel,
    ts: i64,
) -> Result<(), LxAppError> {
    if let Some(mut record) = get(lxappid, release_type)? {
        record.last_open_at = ts;
        upsert(&record)?;
    }
    Ok(())
}

// Downloaded updates API

#[derive(Debug, Clone, Serialize, Deserialize)]
pub(crate) struct PendingUpdateRecord {
    pub lxappid: String,
    pub release_type: Channel,
    pub version: SemanticVersion,
    pub zip_path: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub checksum_sha256: Option<String>,
}

pub(crate) fn downloaded_get(
    lxappid: &str,
    release_type: Channel,
) -> Result<Option<PendingUpdateRecord>, LxAppError> {
    let key = key_for(lxappid, release_type);
    let db = database()?;
    let txn = db
        .begin_read()
        .map_err(|e| metadata_error("begin read transaction", e))?;
    let table = txn
        .open_table(DOWNLOADED_TABLE)
        .map_err(|e| metadata_error("open downloaded table", e))?;
    if let Some(value) = table
        .get(key.as_str())
        .map_err(|e| metadata_error("read downloaded record", e))?
    {
        let record: PendingUpdateRecord = serde_json::from_slice(value.value())?;
        Ok(Some(record))
    } else {
        Ok(None)
    }
}

pub(crate) fn downloaded_remove(lxappid: &str, release_type: Channel) -> Result<(), LxAppError> {
    // Fetch record for archive path
    let record = downloaded_get(lxappid, release_type)?;

    // Best-effort delete archive file
    if let Some(rec) = record {
        let archive_path = std::path::PathBuf::from(&rec.zip_path);
        if archive_path.exists()
            && let Err(e) = std::fs::remove_file(&archive_path)
        {
            crate::warn!(
                "Failed to remove archive file at {}: {}. Disk space may be wasted.",
                archive_path.display(),
                e
            );
        }
    }

    // Remove metadata entry
    let key = key_for(lxappid, release_type);
    let db = database()?;
    let txn = db
        .begin_write()
        .map_err(|e| metadata_error("begin write transaction", e))?;
    {
        let mut table = txn
            .open_table(DOWNLOADED_TABLE)
            .map_err(|e| metadata_error("open downloaded table", e))?;
        table
            .remove(key.as_str())
            .map_err(|e| metadata_error("delete downloaded record", e))?;
    }
    txn.commit()
        .map_err(|e| metadata_error("commit downloaded delete", e))?;
    Ok(())
}

pub(crate) fn downloaded_upsert(
    lxappid: &str,
    release_type: Channel,
    version: &str,
    zip_path: &std::path::Path,
    checksum_sha256: Option<&str>,
) -> Result<(), LxAppError> {
    let parsed_version = Version::parse(version).map_err(|_| {
        LxAppError::InvalidParameter(format!("Invalid semantic version: {}", version))
    })?;
    let record = PendingUpdateRecord {
        lxappid: lxappid.to_string(),
        release_type,
        version: SemanticVersion::from_version(&parsed_version),
        zip_path: zip_path.to_string_lossy().to_string(),
        checksum_sha256: checksum_sha256
            .map(str::trim)
            .filter(|value| !value.is_empty())
            .map(|value| value.to_ascii_lowercase()),
    };

    let key = key_for(lxappid, release_type);
    let db = database()?;
    let txn = db
        .begin_write()
        .map_err(|e| metadata_error("begin write transaction", e))?;
    {
        let mut table = txn
            .open_table(DOWNLOADED_TABLE)
            .map_err(|e| metadata_error("open downloaded table", e))?;
        let serialized = serde_json::to_vec(&record)?;
        table
            .insert(key.as_str(), serialized.as_slice())
            .map_err(|e| metadata_error("write downloaded record", e))?;
    }
    txn.commit()
        .map_err(|e| metadata_error("commit downloaded write", e))?;
    Ok(())
}

/// One cached registry answer for an app.
///
/// `icon_file` names a content-addressed file in the icon cache, so two apps
/// that resolved to the same artwork share one file on disk.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub(crate) struct RegistryRecord {
    pub appid: String,
    pub name: Option<String>,
    pub description: Option<String>,
    /// Where the artwork came from. The cache key: a record whose URL still
    /// matches the registry's needs no request at all.
    pub icon_url: Option<String>,
    pub icon_file: Option<String>,
    /// `LxAppStatus::as_str`; stored as text so the contract crate stays free of
    /// serde and an unknown value from a newer server degrades instead of failing.
    pub status: String,
    /// Grants by publish channel. A grant written for `release` says nothing
    /// about a draft of the same app id, and the listing refresh and
    /// an instance's own lookup can run on different channels — one slot would
    /// let either erase the other's answer.
    #[serde(default)]
    pub grants: BTreeMap<String, StoredGrant>,
    pub fetched_at: i64,
}

/// One channel's answer.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub(crate) struct StoredGrant {
    /// `None` is "no constraint" — what the registry says about an app it has
    /// no policy for.
    #[serde(default)]
    pub permissions: Option<StoredPermissions>,
    /// When this channel's answer arrived. Separate from the record's
    /// `fetched_at`, which a refresh on any channel advances.
    pub fetched_at: i64,
}

/// A grant as stored. Each half is independent: `None` does not constrain it,
/// an empty list denies it.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub(crate) struct StoredPermissions {
    #[serde(default)]
    pub domains: Option<Vec<String>>,
    #[serde(default)]
    pub privileges: Option<Vec<String>>,
}

pub(crate) fn registry_get(appid: &str) -> Result<Option<RegistryRecord>, LxAppError> {
    let db = database()?;
    let txn = db
        .begin_read()
        .map_err(|e| metadata_error("begin read transaction", e))?;
    let table = txn
        .open_table(REGISTRY_TABLE)
        .map_err(|e| metadata_error("open registry table", e))?;
    let Some(value) = table
        .get(appid)
        .map_err(|e| metadata_error("read registry record", e))?
    else {
        return Ok(None);
    };
    Ok(Some(serde_json::from_slice(value.value())?))
}

pub(crate) fn registry_upsert(record: &RegistryRecord) -> Result<(), LxAppError> {
    let key = record.appid.as_str();
    let db = database()?;
    let txn = db
        .begin_write()
        .map_err(|e| metadata_error("begin write transaction", e))?;
    {
        let mut table = txn
            .open_table(REGISTRY_TABLE)
            .map_err(|e| metadata_error("open registry table", e))?;
        let serialized = serde_json::to_vec(record)?;
        table
            .insert(key, serialized.as_slice())
            .map_err(|e| metadata_error("write registry record", e))?;
    }
    txn.commit()
        .map_err(|e| metadata_error("commit registry write", e))?;
    Ok(())
}

/// Drop this app's record, returning the icon files it referenced so the
/// caller can delete the artwork they were the last user of.
///
/// Also sweeps leftover `appid::…` keys from the previous locale-scoped cache
/// so an uninstall still cleans a record written before the key was just the
/// app id.
pub(crate) fn registry_remove_all(appid: &str) -> Result<Vec<String>, LxAppError> {
    let legacy_prefix = format!("{appid}::");
    let db = database()?;
    let txn = db
        .begin_write()
        .map_err(|e| metadata_error("begin write transaction", e))?;
    let mut icon_files = Vec::new();
    {
        let mut table = txn
            .open_table(REGISTRY_TABLE)
            .map_err(|e| metadata_error("open registry table", e))?;
        let mut keys_to_remove = Vec::new();
        for entry in table
            .iter()
            .map_err(|e| metadata_error("iterate registry records", e))?
        {
            let (key, value) = entry.map_err(|e| metadata_error("read registry record", e))?;
            let key = key.value();
            if key != appid && !key.starts_with(&legacy_prefix) {
                continue;
            }
            keys_to_remove.push(key.to_string());
            if let Ok(record) = serde_json::from_slice::<RegistryRecord>(value.value())
                && let Some(file) = record.icon_file
            {
                icon_files.push(file);
            }
        }
        for key in keys_to_remove {
            table
                .remove(key.as_str())
                .map_err(|e| metadata_error("delete registry record", e))?;
        }
    }
    txn.commit()
        .map_err(|e| metadata_error("commit registry delete", e))?;
    Ok(icon_files)
}

/// Every icon file still referenced by some app's records — the survivor set
/// when deciding which artwork an uninstall may delete.
pub(crate) fn registry_referenced_icon_files() -> Result<BTreeSet<String>, LxAppError> {
    let db = database()?;
    let txn = db
        .begin_read()
        .map_err(|e| metadata_error("begin read transaction", e))?;
    let table = txn
        .open_table(REGISTRY_TABLE)
        .map_err(|e| metadata_error("open registry table", e))?;
    let mut files = BTreeSet::new();
    for entry in table
        .iter()
        .map_err(|e| metadata_error("iterate registry records", e))?
    {
        let (_, value) = entry.map_err(|e| metadata_error("read registry record", e))?;
        if let Ok(record) = serde_json::from_slice::<RegistryRecord>(value.value())
            && let Some(file) = record.icon_file
        {
            files.insert(file);
        }
    }
    Ok(files)
}

/// Every install directory some record still points at. The survivor set for
/// sweeping orphaned installs: an extraction that outlived its record — a
/// crash between unpack and upsert, or an old version whose best-effort removal
/// failed — is referenced by nothing and is pure garbage.
pub(crate) fn installed_paths() -> Result<BTreeSet<String>, LxAppError> {
    let db = database()?;
    let txn = db
        .begin_read()
        .map_err(|e| metadata_error("begin read transaction", e))?;
    let table = txn
        .open_table(INSTALLED_TABLE)
        .map_err(|e| metadata_error("open installed table", e))?;
    let mut paths = BTreeSet::new();
    for entry in table
        .iter()
        .map_err(|e| metadata_error("iterate installed records", e))?
    {
        let (_, value) = entry.map_err(|e| metadata_error("read installed record", e))?;
        let record: LxAppRecord = serde_json::from_slice(value.value())?;
        if !record.install_path.trim().is_empty() {
            paths.insert(record.install_path);
        }
    }
    Ok(paths)
}

/// Every staged update archive a pending record still points at.
pub(crate) fn downloaded_archives() -> Result<BTreeSet<String>, LxAppError> {
    let db = database()?;
    let txn = db
        .begin_read()
        .map_err(|e| metadata_error("begin read transaction", e))?;
    let table = txn
        .open_table(DOWNLOADED_TABLE)
        .map_err(|e| metadata_error("open downloaded table", e))?;
    let mut paths = BTreeSet::new();
    for entry in table
        .iter()
        .map_err(|e| metadata_error("iterate downloaded records", e))?
    {
        let (_, value) = entry.map_err(|e| metadata_error("read downloaded record", e))?;
        let record: PendingUpdateRecord = serde_json::from_slice(value.value())?;
        if !record.zip_path.trim().is_empty() {
            paths.insert(record.zip_path);
        }
    }
    Ok(paths)
}