RDK Resources
[*RDK Preferred*]
Code Management Facility
RDK Forums
[RDK Conferences]
RDK Support
Archives
Papers & Presentations Archive
Info | ||
---|---|---|
| ||
Table of Contents |
---|
LISA component is part of RDK DAC framework on STB. Its role is to retrieve, store and maintain DAC bundles and local applications' metadata. LISA is keeping track of what packages are available locally and managing the local storage, both for downloadable bundles as well as persistent storage for the applications. LISA is an abbreviation from Local Inventory & Storage Manager of DAC Apps.
...
draw.io Diagram border true diagramName LISA Overview simpleViewer false width links auto tbstyle top lbox true diagramWidth 811 revision 1
LISA is an alternative to the Packager Thunder Plugin used to retrieve ipkg packages, see https://github.com/rdkcentral/rdkservices/blob/master/Packager/doc/PackagerPlugin.md
Existing Packager API (RDK services github) | Proposed Packager API (DAC RDK wiki) | LISA API |
---|---|---|
install (package, version, architecture) | install (id, type, URL, token, listener) → (id, task, success) | install (type, id, version, URL, appName, category), → (status, handle) |
remove (id, listener) → (id, task, success) | uninstall (type, id, version, uninstallType), → (status, handle) | |
operationStatus→ (handle, status, details) | ||
cancel (task, listener) → (success) | cancel (handle) → (status) | |
isInstalled (id) → (success) | - | |
getInstallProgress (task) → ( percent) | getProgress (handle) → (status, percent) | |
getInstalled() → (applications) | getList (filter) → (array of {type, id, version, metadata}) | |
getPackageInfo(id) → (metadata) | getMetadata(type, id, version) → (metadata) | |
- | setMetadata(type, id, version, tag, metadata) | |
getAvaialbleSpace() → (space) | getStorageDetails() → (path, quota, size, persistentStoragePath, persistentStorageQuota, persistentStorageSize) | |
synchronize() | - |
LISA is able to handle the following data:
Formal definition and Thunder plugin json schema are available in LISA API (TODO: link correction). The below overview is a short reference useful for understanding of expected use cases.
API to be exposed in JSON-RPC over WebSocket
...
{payload} - A Structured value that holds the parameter values to be used during the invocation of the method. This member MAY be omitted.
Download the application bundle tarball from the given URL, unpack files to dedicated directory, create the db entries and persistent storage on success. Asynchronous operation, handle should be used for tracking the request. The id of an app is unique within the database. That means only one kind of (mime)type can be combined and saved with a specific app id.
...
parameters and errors | values |
---|---|
handle |
|
status |
|
progress |
|
Notification sent on the completion of asynchronous operation.
...
parameters and errors | values |
---|---|
handle |
|
status |
|
details |
|
Tracking of the download progress is implemented using:
draw.io Diagram | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
API to be implemented by the library:
draw.io Diagram | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
Code Block | ||||
---|---|---|---|---|
| ||||
-- enable support for foreign keys, available since sqlite version 3.6.19 (2009-10-14) PRAGMA foreign_keys = ON; -- table for application ids and persistent storage CREATE TABLE IF NOT EXISTS apps( idx INTEGER PRIMARY KEY, -- unique index for the application type/id type TEXT NOT NULL, -- MIME type app_id TEXT UNIQUE NOT NULL, -- unique id of app within given MIME type data_path TEXT, -- path to app peristent storage, relative to [APPS_STORAGE]/{epoch} created TEXT NOT NULL -- unix epoch timestamp of when the application entry was created ); -- table for installed applications in specific versions CREATE TABLE IF NOT EXISTS installed_apps ( idx INTEGER PRIMARY KEY, -- unique index for the application type/id/version app_idx INTEGER NOT NULL, -- reference to apps table, index of the application type/id version TEXT NOT NULL, -- version of the application name TEXT NOT NULL, -- name of the application category TEXT, -- category url TEXT, -- URL from which the application was downloaded app_path TEXT, -- path to app files, realtive to [APPS]/{epoch} created TEXT NOT NULL, -- unix epoch timestamp of when the application was installed resources TEXT, -- json object with downloaded resources metadata metadata TEXT, -- json object with auxiliary resources metadata FOREIGN KEY(app_idx) REFERENCES apps(idx), UNIQUE(app_idx, version) ); |
1. print tables
SELECT sql FROM sqlite_master WHERE name = 'apps';
SELECT sql FROM sqlite_master WHERE name = 'installed_apps';
...
6. set meatdata for given app/version
SELECT DISTINCT installed_apps.idx,installed_apps.metadata FROM installed_apps,apps WHERE apps.type='application/vnd.rdk-app.dac.native' AND apps.app_id='com.lgi.app3' AND installed_apps.version="1.0.0";
UPDATE installed_apps SET metadata = '{[{"description","New nice application."},{"parental":"5"}]}' WHERE idx=<idx>;
The logical storages: [APPS] and [APPS_STORAGE] should be defined per platform, to use concrete physical storages.
Epoch indicator {epoch} is used for easy invalidation of not supported or revoked format of apps on fundamental changes. May also be used for the antirollback (db authentication - TBD?)
Apps files are stored in [APPS] storage.
...
Apps persistent storage is located in [APPS_STORAGE].
...
Apps' persistent storage: [APPS_STORAGE]/dac/{epoch}/{id}/
draw.io Diagram border true diagramName LISA init simpleViewer false width links auto tbstyle top lbox true diagramWidth 1422 revision 1
draw.io Diagram | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
draw.io Diagram | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
draw.io Diagram | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
draw.io Diagram | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
LISA should be implemented as a Thunder plugin.
An implementation may be based on the Packager code.
Code Block | ||||
---|---|---|---|---|
| ||||
{ "$schema": "plugin.schema.json", "jsonrpc":"2.0", "info": { "title": "Local Inventory & Storage Manager of DAC Apps (LISA) Plugin", "class": "Lisa", "callsign": "org.rdk.dac.lisa", "locator": "libWPEFrameworkLisa.so", "status": "alpha", "autostart": true, "description": "The Local Inventory & Storage Manager of DAC Apps (LISA) plugin allows authenticated downloading and management of DAC bundles from a remote server. It also manages the persistent storage of the DAC applications.", "version": "1.0" }, "interface": { "$ref": "{interfacedir}/lisa.json#" }, "configuration": { "type": "object", "properties": { "configuration": { "type": "object", "properties": { "network": { "type": "object", "required": [ "timeout", "default_retryIn" ], "properties": { "timeout": { "type": "number", "description": "Single resource downloading timeout in seconds" }, "default_retryIn": { "type": "number", "description": "Default value of GET retry delay in seconds on HTTP/202, when no "Retry-After" header field is returned in the response." } } }, "storages": { "type": "object", "required": [ "apps", "apps_storage", "apps_tmp" ], "properties": { "apps": { "type": "string", "description": "Path to the persistent storage for downloaded applications top dir" }, "apps_storage": { "type": "string", "description": "Path to the persistent storage for downloaded applications persistent storage top dir" }, "apps_tmp": { "type": "string", "description": "Path to the temporary storage for applications being downloaded" } } } }, "required": [ "timeout", "storages" ] } } } } |
Code Block | ||||
---|---|---|---|---|
| ||||
{ "$schema": "plugin.schema.json", "jsonrpc":"2.0", "info": { "title": "Local Inventory & Storage Manager of DAC Apps (LISA) Plugin", "class": "Lisa", "callsign": "org.rdk.dac.lisa", "locator": "libWPEFrameworkLisa.so", "status": "alpha", "autostart": true, "description": [ "The Local Inventory & Storage Manager of DAC Apps (LISA) plugin allows authenticated downloading and management of DAC bundles from a remote server. It also manages the persistent storage of the DAC applications." ], "version": "1.0" }, "interface": { "$ref": "{interfacedir}/lisa.json" }, "configuration": { "storages": { "apps": "/mnt/apps", "apps_storage": "/mnt/apps_storage", "apps_tmp": "/mnt/apps_tmp" }, "network": { "timeout": 1800, "default_retryIn": 300 } } } |
...