2020-10-07 08:53:19 +00:00
|
|
|
// (C) Copyright 2015 Moodle Pty Ltd.
|
|
|
|
//
|
|
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
// you may not use this file except in compliance with the License.
|
|
|
|
// You may obtain a copy of the License at
|
|
|
|
//
|
|
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
//
|
|
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
// See the License for the specific language governing permissions and
|
|
|
|
// limitations under the License.
|
|
|
|
|
|
|
|
import { Injectable } from '@angular/core';
|
|
|
|
|
2020-10-28 13:25:18 +00:00
|
|
|
import { CoreApp } from '@services/app';
|
2020-10-07 08:53:19 +00:00
|
|
|
import { SQLiteDB } from '@classes/sqlitedb';
|
|
|
|
import { makeSingleton } from '@singletons/core.singletons';
|
2020-10-28 13:25:18 +00:00
|
|
|
import { CONFIG_TABLE_NAME, APP_SCHEMA, ConfigDBEntry } from '@services/config.db';
|
2020-10-14 06:29:32 +00:00
|
|
|
|
2020-10-07 08:53:19 +00:00
|
|
|
/**
|
|
|
|
* Factory to provide access to dynamic and permanent config and settings.
|
|
|
|
* It should not be abused into a temporary storage.
|
|
|
|
*/
|
2020-11-19 15:35:17 +00:00
|
|
|
@Injectable({ providedIn: 'root' })
|
2020-10-07 08:53:19 +00:00
|
|
|
export class CoreConfigProvider {
|
2020-10-14 06:29:32 +00:00
|
|
|
|
2020-10-07 08:53:19 +00:00
|
|
|
protected appDB: SQLiteDB;
|
2020-10-14 06:29:32 +00:00
|
|
|
protected dbReady: Promise<void>; // Promise resolved when the app DB is initialized.
|
2020-10-07 08:53:19 +00:00
|
|
|
|
|
|
|
constructor() {
|
|
|
|
this.appDB = CoreApp.instance.getDB();
|
2020-10-28 13:25:18 +00:00
|
|
|
this.dbReady = CoreApp.instance.createTablesFromSchema(APP_SCHEMA).catch(() => {
|
2020-10-07 08:53:19 +00:00
|
|
|
// Ignore errors.
|
|
|
|
});
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Deletes an app setting.
|
|
|
|
*
|
|
|
|
* @param name The config name.
|
|
|
|
* @return Promise resolved when done.
|
|
|
|
*/
|
2020-10-14 06:29:32 +00:00
|
|
|
async delete(name: string): Promise<void> {
|
2020-10-07 08:53:19 +00:00
|
|
|
await this.dbReady;
|
|
|
|
|
2020-10-28 13:25:18 +00:00
|
|
|
await this.appDB.deleteRecords(CONFIG_TABLE_NAME, { name });
|
2020-10-07 08:53:19 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get an app setting.
|
|
|
|
*
|
|
|
|
* @param name The config name.
|
|
|
|
* @param defaultValue Default value to use if the entry is not found.
|
|
|
|
* @return Resolves upon success along with the config data. Reject on failure.
|
|
|
|
*/
|
2020-10-14 06:29:32 +00:00
|
|
|
async get<T>(name: string, defaultValue?: T): Promise<T> {
|
2020-10-07 08:53:19 +00:00
|
|
|
await this.dbReady;
|
|
|
|
|
|
|
|
try {
|
2020-10-28 13:25:18 +00:00
|
|
|
const entry = await this.appDB.getRecord<ConfigDBEntry>(CONFIG_TABLE_NAME, { name });
|
2020-10-07 08:53:19 +00:00
|
|
|
|
|
|
|
return entry.value;
|
|
|
|
} catch (error) {
|
|
|
|
if (typeof defaultValue != 'undefined') {
|
|
|
|
return defaultValue;
|
|
|
|
}
|
|
|
|
|
|
|
|
throw error;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Set an app setting.
|
|
|
|
*
|
|
|
|
* @param name The config name.
|
|
|
|
* @param value The config value. Can only store number or strings.
|
|
|
|
* @return Promise resolved when done.
|
|
|
|
*/
|
2020-10-14 06:29:32 +00:00
|
|
|
async set(name: string, value: number | string): Promise<void> {
|
2020-10-07 08:53:19 +00:00
|
|
|
await this.dbReady;
|
|
|
|
|
2020-10-28 13:25:18 +00:00
|
|
|
await this.appDB.insertRecord(CONFIG_TABLE_NAME, { name, value });
|
2020-10-07 08:53:19 +00:00
|
|
|
}
|
2020-10-14 06:29:32 +00:00
|
|
|
|
2020-10-07 08:53:19 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
export class CoreConfig extends makeSingleton(CoreConfigProvider) {}
|