281 lines
11 KiB
TypeScript
281 lines
11 KiB
TypeScript
|
// (C) Copyright 2015 Martin Dougiamas
|
||
|
|
//
|
||
|
|
// 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';
|
||
|
|
import { CoreFileProvider } from '@providers/file';
|
||
|
|
import { CoreSitesProvider } from '@providers/sites';
|
||
|
|
import { CoreUtilsProvider } from '@providers/utils/utils';
|
||
|
|
import { CoreTextUtilsProvider } from '@providers/utils/text';
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Service to handle offline glossary.
|
||
|
|
*/
|
||
|
|
@Injectable()
|
||
|
|
export class AddonModGlossaryOfflineProvider {
|
||
|
|
|
||
|
|
// Variables for database.
|
||
|
|
protected ENTRIES_TABLE = 'addon_mod_glossary_entrues';
|
||
|
|
|
||
|
|
protected tablesSchema = [
|
||
|
|
{
|
||
|
|
name: this.ENTRIES_TABLE,
|
||
|
|
columns: [
|
||
|
|
{
|
||
|
|
name: 'glossaryid',
|
||
|
|
type: 'INTEGER',
|
||
|
|
},
|
||
|
|
{
|
||
|
|
name: 'courseid',
|
||
|
|
type: 'INTEGER',
|
||
|
|
},
|
||
|
|
{
|
||
|
|
name: 'concept',
|
||
|
|
type: 'TEXT',
|
||
|
|
},
|
||
|
|
{
|
||
|
|
name: 'definition',
|
||
|
|
type: 'TEXT',
|
||
|
|
},
|
||
|
|
{
|
||
|
|
name: 'definitionformat',
|
||
|
|
type: 'TEXT',
|
||
|
|
},
|
||
|
|
{
|
||
|
|
name: 'userid',
|
||
|
|
type: 'INTEGER',
|
||
|
|
},
|
||
|
|
{
|
||
|
|
name: 'timecreated',
|
||
|
|
type: 'INTEGER',
|
||
|
|
},
|
||
|
|
{
|
||
|
|
name: 'options',
|
||
|
|
type: 'TEXT',
|
||
|
|
},
|
||
|
|
{
|
||
|
|
name: 'attachments',
|
||
|
|
type: 'TEXT',
|
||
|
|
},
|
||
|
|
],
|
||
|
|
primaryKeys: ['glossaryid', 'concept', 'timecreated']
|
||
|
|
}
|
||
|
|
];
|
||
|
|
|
||
|
|
constructor(private fileProvider: CoreFileProvider,
|
||
|
|
private sitesProvider: CoreSitesProvider,
|
||
|
|
private textUtils: CoreTextUtilsProvider,
|
||
|
|
private utils: CoreUtilsProvider) {
|
||
|
|
this.sitesProvider.createTablesFromSchema(this.tablesSchema);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Delete a new entry.
|
||
|
|
*
|
||
|
|
* @param {number} glossaryId Glossary ID.
|
||
|
|
* @param {string} concept Glossary entry concept.
|
||
|
|
* @param {number} timeCreated The time the entry was created.
|
||
|
|
* @param {string} [siteId] Site ID. If not defined, current site.
|
||
|
|
* @return {Promise<void>} Promise resolved if deleted, rejected if failure.
|
||
|
|
*/
|
||
|
|
deleteNewEntry(glossaryId: number, concept: string, timeCreated: number, siteId?: string): Promise<any> {
|
||
|
|
return this.sitesProvider.getSite(siteId).then((site) => {
|
||
|
|
const conditions = {
|
||
|
|
glossaryid: glossaryId,
|
||
|
|
concept: concept,
|
||
|
|
timecreated: timeCreated,
|
||
|
|
};
|
||
|
|
|
||
|
|
return site.getDb().deleteRecords(this.ENTRIES_TABLE, conditions);
|
||
|
|
});
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get all the stored new entries from all the glossaries.
|
||
|
|
*
|
||
|
|
* @param {string} [siteId] Site ID. If not defined, current site.
|
||
|
|
* @return {Promise<any[]>} Promise resolved with entries.
|
||
|
|
*/
|
||
|
|
getAllNewEntries(siteId?: string): Promise<any[]> {
|
||
|
|
return this.sitesProvider.getSite(siteId).then((site) => {
|
||
|
|
return site.getDb().getRecords(this.ENTRIES_TABLE).then((records: any[]) => {
|
||
|
|
return records.map(this.parseRecord.bind(this));
|
||
|
|
});
|
||
|
|
});
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get a stored new entry.
|
||
|
|
*
|
||
|
|
* @param {number} glossaryId Glossary ID.
|
||
|
|
* @param {string} concept Glossary entry concept.
|
||
|
|
* @param {number} timeCreated The time the entry was created.
|
||
|
|
* @param {string} [siteId] Site ID. If not defined, current site.
|
||
|
|
* @return {Promise<any>} Promise resolved with entry.
|
||
|
|
*/
|
||
|
|
getNewEntry(glossaryId: number, concept: string, timeCreated: number, siteId?: string): Promise<any> {
|
||
|
|
return this.sitesProvider.getSite(siteId).then((site) => {
|
||
|
|
const conditions = {
|
||
|
|
glossaryid: glossaryId,
|
||
|
|
concept: concept,
|
||
|
|
timecreated: timeCreated,
|
||
|
|
};
|
||
|
|
|
||
|
|
return site.getDb().getRecord(this.ENTRIES_TABLE, conditions).then(this.parseRecord.bind(this));
|
||
|
|
});
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get all the stored add entry data from a certain glossary.
|
||
|
|
*
|
||
|
|
* @param {number} glossaryId Glossary ID.
|
||
|
|
* @param {string} [siteId] Site ID. If not defined, current site.
|
||
|
|
* @param {number} [userId] User the entries belong to. If not defined, current user in site.
|
||
|
|
* @return {Promise<any[]>} Promise resolved with entries.
|
||
|
|
*/
|
||
|
|
getGlossaryNewEntries(glossaryId: number, siteId?: string, userId?: number): Promise<any[]> {
|
||
|
|
return this.sitesProvider.getSite(siteId).then((site) => {
|
||
|
|
const conditions = {
|
||
|
|
glossaryid: glossaryId,
|
||
|
|
userId: userId || site.getUserId(),
|
||
|
|
};
|
||
|
|
|
||
|
|
return site.getDb().getRecords(this.ENTRIES_TABLE, conditions).then((records: any[]) => {
|
||
|
|
return records.map(this.parseRecord.bind(this));
|
||
|
|
});
|
||
|
|
});
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Check if a concept is used offline.
|
||
|
|
*
|
||
|
|
* @param {number} glossaryId Glossary ID.
|
||
|
|
* @param {string} concept Concept to check.
|
||
|
|
* @param {number} [timeCreated] Time of the entry we are editing.
|
||
|
|
* @param {string} [siteId] Site ID. If not defined, current site.
|
||
|
|
* @return {Promise<boolean>} Promise resolved with true if concept is found, false otherwise.
|
||
|
|
*/
|
||
|
|
isConceptUsed(glossaryId: number, concept: string, timeCreated?: number, siteId?: string): Promise<boolean> {
|
||
|
|
return this.sitesProvider.getSite(siteId).then((site) => {
|
||
|
|
const conditions = {
|
||
|
|
glossaryid: glossaryId,
|
||
|
|
concept: concept,
|
||
|
|
};
|
||
|
|
|
||
|
|
return site.getDb().getRecords(this.ENTRIES_TABLE, conditions).then((entries) => {
|
||
|
|
if (!entries.length) {
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
|
||
|
|
if (entries.length > 1 || !timeCreated) {
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
|
||
|
|
// If there's only one entry, check that is not the one we are editing.
|
||
|
|
return this.utils.promiseFails(this.getNewEntry(glossaryId, concept, timeCreated, siteId));
|
||
|
|
});
|
||
|
|
}).catch(() => {
|
||
|
|
// No offline data found, return false.
|
||
|
|
return false;
|
||
|
|
});
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Save a new entry to be sent later.
|
||
|
|
*
|
||
|
|
* @param {number} glossaryId Glossary ID.
|
||
|
|
* @param {string} concept Glossary entry concept.
|
||
|
|
* @param {string} definition Glossary entry concept definition.
|
||
|
|
* @param {number} courseId Course ID of the glossary.
|
||
|
|
* @param {any} [options] Options for the entry.
|
||
|
|
* @param {any} [attachments] Result of CoreFileUploaderProvider#storeFilesToUpload for attachments.
|
||
|
|
* @param {number} [timeCreated] The time the entry was created. If not defined, current time.
|
||
|
|
* @param {string} [siteId] Site ID. If not defined, current site.
|
||
|
|
* @param {number} [userId] User the entry belong to. If not defined, current user in site.
|
||
|
|
* @param {any} [discardEntry] The entry provided will be discarded if found.
|
||
|
|
* @return {Promise<false>} Promise resolved if stored, rejected if failure.
|
||
|
|
*/
|
||
|
|
addNewEntry(glossaryId: number, concept: string, definition: string, courseId: number, options?: any, attachments?: any,
|
||
|
|
timeCreated?: number, siteId?: string, userId?: number, discardEntry?: any): Promise<false> {
|
||
|
|
return this.sitesProvider.getSite(siteId).then((site) => {
|
||
|
|
const entry = {
|
||
|
|
glossaryid: glossaryId,
|
||
|
|
courseid: courseId,
|
||
|
|
concept: concept,
|
||
|
|
definition: definition,
|
||
|
|
definitionformat: 'html',
|
||
|
|
options: JSON.stringify(options),
|
||
|
|
attachments: JSON.stringify(attachments),
|
||
|
|
userid: userId || site.getUserId(),
|
||
|
|
timecreated: timeCreated || new Date().getTime()
|
||
|
|
};
|
||
|
|
|
||
|
|
// If editing an offline entry, delete previous first.
|
||
|
|
let discardPromise;
|
||
|
|
if (discardEntry) {
|
||
|
|
discardPromise = this.deleteNewEntry(glossaryId, discardEntry.concept, discardEntry.timecreated, site.getId());
|
||
|
|
} else {
|
||
|
|
discardPromise = Promise.resolve();
|
||
|
|
}
|
||
|
|
|
||
|
|
return discardPromise.then(() => {
|
||
|
|
return site.getDb().insertRecord(this.ENTRIES_TABLE, entry).then(() => false);
|
||
|
|
});
|
||
|
|
});
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the path to the folder where to store files for offline attachments in a glossary.
|
||
|
|
*
|
||
|
|
* @param {number} glossaryId Glossary ID.
|
||
|
|
* @param {string} [siteId] Site ID. If not defined, current site.
|
||
|
|
* @return {Promise<string>} Promise resolved with the path.
|
||
|
|
*/
|
||
|
|
getGlossaryFolder(glossaryId: number, siteId?: string): Promise<string> {
|
||
|
|
return this.sitesProvider.getSite(siteId).then((site) => {
|
||
|
|
const siteFolderPath = this.fileProvider.getSiteFolder(site.getId());
|
||
|
|
const folderPath = 'offlineglossary/' + glossaryId;
|
||
|
|
|
||
|
|
return this.textUtils.concatenatePaths(siteFolderPath, folderPath);
|
||
|
|
});
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the path to the folder where to store files for a new offline entry.
|
||
|
|
*
|
||
|
|
* @param {number} glossaryId Glossary ID.
|
||
|
|
* @param {string} concept The name of the entry.
|
||
|
|
* @param {number} timeCreated Time to allow duplicated entries.
|
||
|
|
* @param {string} [siteId] Site ID. If not defined, current site.
|
||
|
|
* @return {Promise<string>} Promise resolved with the path.
|
||
|
|
*/
|
||
|
|
getEntryFolder(glossaryId: number, concept: string, timeCreated: number, siteId?: string): Promise<string> {
|
||
|
|
return this.getGlossaryFolder(glossaryId, siteId).then((folderPath) => {
|
||
|
|
return this.textUtils.concatenatePaths(folderPath, 'newentry_' + concept + '_' + timeCreated);
|
||
|
|
});
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Parse "options" and "attachments" columns of a fetched record.
|
||
|
|
*
|
||
|
|
* @param {any} records Record object
|
||
|
|
* @return {any} Record object with columns parsed.
|
||
|
|
*/
|
||
|
|
protected parseRecord(record: any): any {
|
||
|
|
record.options = this.textUtils.parseJSON(record.options);
|
||
|
|
record.attachments = this.textUtils.parseJSON(record.attachments);
|
||
|
|
|
||
|
|
return record;
|
||
|
|
}
|
||
|
|
}
|