EVOgeek
/
Vmeda.Online
1
0
Fork 1
Code Issues Pull Requests Packages Projects Releases Wiki Activity

MOBILE-1979 course: Save offline log calls

main
Pau Ferrer Ocaña 2019-02-04 12:06:05 +01:00
parent 8280694383
commit 56eaafdeda
29 changed files with 403 additions and 136 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
src/addon/mod/assign/providers/assign.ts
View File

@ -23,6 +23,7 @@ import { CoreUtilsProvider } from '@providers/utils/utils';
import { CoreCommentsProvider } from '@core/comments/providers/comments';
import { CoreUserProvider } from '@core/user/providers/user';
import { CoreGradesProvider } from '@core/grades/providers/grades';
import { CoreCourseLogHelperProvider } from '@core/course/providers/log-helper';
import { AddonModAssignSubmissionDelegate } from './submission-delegate';
import { AddonModAssignOfflineProvider } from './assign-offline';
import { CoreSiteWSPreSets } from '@classes/site';
@ -68,7 +69,8 @@ export class AddonModAssignProvider {
private timeUtils: CoreTimeUtilsProvider, private appProvider: CoreAppProvider, private utils: CoreUtilsProvider,
private userProvider: CoreUserProvider, private submissionDelegate: AddonModAssignSubmissionDelegate,
private gradesProvider: CoreGradesProvider, private filepoolProvider: CoreFilepoolProvider,
private assignOffline: AddonModAssignOfflineProvider, private commentsProvider: CoreCommentsProvider) {
private assignOffline: AddonModAssignOfflineProvider, private commentsProvider: CoreCommentsProvider,
private logHelper: CoreCourseLogHelperProvider) {
this.logger = logger.getInstance('AddonModAssignProvider');
}
@ -976,13 +978,11 @@ export class AddonModAssignProvider {
* @return {Promise<any>} Promise resolved when the WS call is successful.
*/
logGradingView(assignId: number, siteId?: string): Promise<any> {
return this.sitesProvider.getSite(siteId).then((site) => {
const params = {
assignid: assignId
};
const params = {
assignid: assignId
};
return site.write('mod_assign_view_grading_table', params);
});
return this.logHelper.log('mod_assign_view_grading_table', params, AddonModAssignProvider.COMPONENT, assignId, siteId);
}
/**
@ -993,13 +993,11 @@ export class AddonModAssignProvider {
* @return {Promise<any>} Promise resolved when the WS call is successful.
*/
logView(assignId: number, siteId?: string): Promise<any> {
return this.sitesProvider.getSite(siteId).then((site) => {
const params = {
assignid: assignId
};
const params = {
assignid: assignId
};
return site.write('mod_assign_view_assign', params);
});
return this.logHelper.log('mod_assign_view_assign', params, AddonModAssignProvider.COMPONENT, assignId, siteId);
}
/**

9
src/addon/mod/book/providers/book.ts
View File

@ -22,6 +22,7 @@ import { CoreDomUtilsProvider } from '@providers/utils/dom';
import { CoreTextUtilsProvider } from '@providers/utils/text';
import { CoreUtilsProvider } from '@providers/utils/utils';
import { CoreCourseProvider } from '@core/course/providers/course';
import { CoreCourseLogHelperProvider } from '@core/course/providers/log-helper';
/**
* A book chapter inside the toc list.
@ -64,7 +65,8 @@ export class AddonModBookProvider {
constructor(logger: CoreLoggerProvider, private sitesProvider: CoreSitesProvider, private textUtils: CoreTextUtilsProvider,
private fileProvider: CoreFileProvider, private filepoolProvider: CoreFilepoolProvider, private http: Http,
private utils: CoreUtilsProvider, private courseProvider: CoreCourseProvider, private domUtils: CoreDomUtilsProvider) {
private utils: CoreUtilsProvider, private courseProvider: CoreCourseProvider, private domUtils: CoreDomUtilsProvider,
private logHelper: CoreCourseLogHelperProvider) {
this.logger = logger.getInstance('AddonModBookProvider');
}
@ -378,14 +380,15 @@ export class AddonModBookProvider {
*
* @param {number} id Module ID.
* @param {string} chapterId Chapter ID.
* @param {string} [siteId] Site ID. If not defined, current site.
* @return {Promise<any>} Promise resolved when the WS call is successful.
*/
logView(id: number, chapterId: string): Promise<any> {
logView(id: number, chapterId: string, siteId?: string): Promise<any> {
const params = {
bookid: id,
chapterid: chapterId
};
return this.sitesProvider.getCurrentSite().write('mod_book_view_book', params);
return this.logHelper.log('mod_book_view_book', params, AddonModBookProvider.COMPONENT, id, siteId);
}
}

15
src/addon/mod/chat/providers/chat.ts
View File

@ -15,6 +15,7 @@
import { Injectable } from '@angular/core';
import { CoreSitesProvider } from '@providers/sites';
import { CoreUserProvider } from '@core/user/providers/user';
import { CoreCourseLogHelperProvider } from '@core/course/providers/log-helper';
/**
* Service that provides some features for chats.
@ -24,7 +25,8 @@ export class AddonModChatProvider {
static COMPONENT = 'mmaModChat';
static POLL_INTERVAL = 4000;
constructor(private sitesProvider: CoreSitesProvider, private userProvider: CoreUserProvider) {}
constructor(private sitesProvider: CoreSitesProvider, private userProvider: CoreUserProvider,
private logHelper: CoreCourseLogHelperProvider) {}
/**
* Get a chat.
@ -77,15 +79,16 @@ export class AddonModChatProvider {
/**
* Report a chat as being viewed.
*
* @param {number} chatId Chat instance ID.
* @return {Promise<any>} Promise resolved when the WS call is executed.
* @param {number} id Chat instance ID.
* @param {string} [siteId] Site ID. If not defined, current site.
* @return {Promise<any>} Promise resolved when the WS call is successful.
*/
logView(chatId: number): Promise<any> {
logView(id: number, siteId?: string): Promise<any> {
const params = {
chatid: chatId
chatid: id
};
return this.sitesProvider.getCurrentSite().write('mod_chat_view_chat', params);
return this.logHelper.log('mod_chat_view_chat', params, AddonModChatProvider.COMPONENT, id, siteId);
}
/**

10
src/addon/mod/choice/providers/choice.ts
View File

@ -17,6 +17,7 @@ import { CoreSitesProvider } from '@providers/sites';
import { CoreUtilsProvider } from '@providers/utils/utils';
import { CoreAppProvider } from '@providers/app';
import { CoreFilepoolProvider } from '@providers/filepool';
import { CoreCourseLogHelperProvider } from '@core/course/providers/log-helper';
import { AddonModChoiceOfflineProvider } from './offline';
/**
@ -38,7 +39,7 @@ export class AddonModChoiceProvider {
constructor(private sitesProvider: CoreSitesProvider, private appProvider: CoreAppProvider,
private filepoolProvider: CoreFilepoolProvider, private utils: CoreUtilsProvider,
private choiceOffline: AddonModChoiceOfflineProvider) {}
private choiceOffline: AddonModChoiceOfflineProvider, private logHelper: CoreCourseLogHelperProvider) {}
/**
* Check if results can be seen by a student. The student can see the results if:
@ -346,14 +347,15 @@ export class AddonModChoiceProvider {
* Report the choice as being viewed.
*
* @param {string} id Choice ID.
* @return {Promise<any>} Promise resolved when the WS call is successful.
* @param {string} [siteId] Site ID. If not defined, current site.
* @return {Promise<any>} Promise resolved when the WS call is successful.
*/
logView(id: string): Promise<any> {
logView(id: number, siteId?: string): Promise<any> {
const params = {
choiceid: id
};
return this.sitesProvider.getCurrentSite().write('mod_choice_view_choice', params);
return this.logHelper.log('mod_choice_view_choice', params, AddonModChoiceProvider.COMPONENT, id, siteId);
}
/**

9
src/addon/mod/data/providers/data.ts
View File

@ -18,6 +18,7 @@ import { CoreLoggerProvider } from '@providers/logger';
import { CoreSitesProvider } from '@providers/sites';
import { CoreUtilsProvider } from '@providers/utils/utils';
import { CoreFilepoolProvider } from '@providers/filepool';
import { CoreCourseLogHelperProvider } from '@core/course/providers/log-helper';
import { AddonModDataOfflineProvider } from './offline';
import { AddonModDataFieldsDelegate } from './fields-delegate';
@ -35,7 +36,8 @@ export class AddonModDataProvider {
constructor(logger: CoreLoggerProvider, private sitesProvider: CoreSitesProvider, private utils: CoreUtilsProvider,
private filepoolProvider: CoreFilepoolProvider, private dataOffline: AddonModDataOfflineProvider,
private appProvider: CoreAppProvider, private fieldsDelegate: AddonModDataFieldsDelegate) {
private appProvider: CoreAppProvider, private fieldsDelegate: AddonModDataFieldsDelegate,
private logHelper: CoreCourseLogHelperProvider) {
this.logger = logger.getInstance('AddonModDataProvider');
}
@ -846,14 +848,15 @@ export class AddonModDataProvider {
* Report the database as being viewed.
*
* @param {number} id Module ID.
* @param {string} [siteId] Site ID. If not defined, current site.
* @return {Promise<any>} Promise resolved when the WS call is successful.
*/
logView(id: number): Promise<any> {
logView(id: number, siteId?: string): Promise<any> {
const params = {
databaseid: id
};
return this.sitesProvider.getCurrentSite().write('mod_data_view_database', params);
return this.logHelper.log('mod_data_view_database', params, AddonModDataProvider.COMPONENT, id, siteId);
}
/**

8
src/addon/mod/feedback/providers/feedback.ts
View File

@ -18,6 +18,7 @@ import { CoreSitesProvider } from '@providers/sites';
import { CoreUtilsProvider } from '@providers/utils/utils';
import { CoreFilepoolProvider } from '@providers/filepool';
import { CoreAppProvider } from '@providers/app';
import { CoreCourseLogHelperProvider } from '@core/course/providers/log-helper';
import { AddonModFeedbackOfflineProvider } from './offline';
/**
@ -38,7 +39,7 @@ export class AddonModFeedbackProvider {
constructor(logger: CoreLoggerProvider, private sitesProvider: CoreSitesProvider, private utils: CoreUtilsProvider,
private filepoolProvider: CoreFilepoolProvider, private feedbackOffline: AddonModFeedbackOfflineProvider,
private appProvider: CoreAppProvider) {
private appProvider: CoreAppProvider, private logHelper: CoreCourseLogHelperProvider) {
this.logger = logger.getInstance('AddonModFeedbackProvider');
}
@ -1071,15 +1072,16 @@ export class AddonModFeedbackProvider {
*
* @param {number} id Module ID.
* @param {boolean} [formViewed=false] True if form was viewed.
* @param {string} [siteId] Site ID. If not defined, current site.
* @return {Promise<any>} Promise resolved when the WS call is successful.
*/
logView(id: number, formViewed: boolean = false): Promise<any> {
logView(id: number, formViewed: boolean = false, siteId?: string): Promise<any> {
const params = {
feedbackid: id,
moduleviewed: formViewed ? 1 : 0
};
return this.sitesProvider.getCurrentSite().write('mod_feedback_view_feedback', params);
return this.logHelper.log('mod_feedback_view_feedback', params, AddonModFeedbackProvider.COMPONENT, id, siteId);
}
/**

8
src/addon/mod/folder/providers/folder.ts
View File

@ -17,6 +17,7 @@ import { CoreLoggerProvider } from '@providers/logger';
import { CoreSitesProvider } from '@providers/sites';
import { CoreUtilsProvider } from '@providers/utils/utils';
import { CoreCourseProvider } from '@core/course/providers/course';
import { CoreCourseLogHelperProvider } from '@core/course/providers/log-helper';
/**
* Service that provides some features for folder.
@ -29,7 +30,7 @@ export class AddonModFolderProvider {
protected logger;
constructor(logger: CoreLoggerProvider, private sitesProvider: CoreSitesProvider, private courseProvider: CoreCourseProvider,
private utils: CoreUtilsProvider) {
private utils: CoreUtilsProvider, private logHelper: CoreCourseLogHelperProvider) {
this.logger = logger.getInstance('AddonModFolderProvider');
}
@ -132,13 +133,14 @@ export class AddonModFolderProvider {
* Report a folder as being viewed.
*
* @param {number} id Module ID.
* @param {string} [siteId] Site ID. If not defined, current site.
* @return {Promise<any>} Promise resolved when the WS call is successful.
*/
logView(id: number): Promise<any> {
logView(id: number, siteId?: string): Promise<any> {
const params = {
folderid: id
};
return this.sitesProvider.getCurrentSite().write('mod_folder_view_folder', params);
return this.logHelper.log('mod_folder_view_folder', params, AddonModFolderProvider.COMPONENT, id, siteId);
}
}

2
src/addon/mod/forum/pages/discussion/discussion.ts
View File

@ -299,7 +299,7 @@ export class AddonModForumDiscussionPage implements OnDestroy {
if (forceMarkAsRead || (hasUnreadPosts && this.trackPosts)) {
// // Add log in Moodle and mark unread posts as readed.
this.forumProvider.logDiscussionView(this.discussionId).catch(() => {
this.forumProvider.logDiscussionView(this.discussionId, this.forumId).catch(() => {
// Ignore errors.
}).finally(() => {
// Trigger mark read posts.

17
src/addon/mod/forum/providers/forum.ts
View File

@ -20,6 +20,7 @@ import { CoreGroupsProvider } from '@providers/groups';
import { CoreSitesProvider } from '@providers/sites';
import { CoreUserProvider } from '@core/user/providers/user';
import { CoreUtilsProvider } from '@providers/utils/utils';
import { CoreCourseLogHelperProvider } from '@core/course/providers/log-helper';
import { AddonModForumOfflineProvider } from './offline';
/**
@ -43,7 +44,8 @@ export class AddonModForumProvider {
private userProvider: CoreUserProvider,
private translate: TranslateService,
private utils: CoreUtilsProvider,
private forumOffline: AddonModForumOfflineProvider) {}
private forumOffline: AddonModForumOfflineProvider,
private logHelper: CoreCourseLogHelperProvider) {}
/**
* Get cache key for can add discussion WS calls.
@ -596,28 +598,31 @@ export class AddonModForumProvider {
* Report a forum as being viewed.
*
* @param {number} id Module ID.
* @return {Promise<any>} Promise resolved when the WS call is successful.
* @param {string} [siteId] Site ID. If not defined, current site.
* @return {Promise<any>} Promise resolved when the WS call is successful.
*/
logView(id: number): Promise<any> {
logView(id: number, siteId?: string): Promise<any> {
const params = {
forumid: id
};
return this.sitesProvider.getCurrentSite().write('mod_forum_view_forum', params);
return this.logHelper.log('mod_forum_view_forum', params, AddonModForumProvider.COMPONENT, id, siteId);
}
/**
* Report a forum discussion as being viewed.
*
* @param {number} id Discussion ID.
* @param {number} forumId Forum ID.
* @param {string} [siteId] Site ID. If not defined, current site.
* @return {Promise<any>} Promise resolved when the WS call is successful.
*/
logDiscussionView(id: number): Promise<any> {
logDiscussionView(id: number, forumId: number, siteId?: string): Promise<any> {
const params = {
discussionid: id
};
return this.sitesProvider.getCurrentSite().write('mod_forum_view_forum_discussion', params);
return this.logHelper.log('mod_forum_view_forum_discussion', params, AddonModForumProvider.COMPONENT, forumId, siteId);
}
/**

2
src/addon/mod/glossary/pages/entry/entry.ts
View File

@ -48,7 +48,7 @@ export class AddonModGlossaryEntryPage {
*/
ionViewDidLoad(): void {
this.fetchEntry().then(() => {
this.glossaryProvider.logEntryView(this.entry.id).catch(() => {
this.glossaryProvider.logEntryView(this.entry.id, this.componentId).catch(() => {
// Ignore errors.
});
}).finally(() => {

15
src/addon/mod/glossary/providers/glossary.ts
View File

@ -20,6 +20,7 @@ import { CoreFilepoolProvider } from '@providers/filepool';
import { CoreSitesProvider } from '@providers/sites';
import { CoreTextUtilsProvider } from '@providers/utils/text';
import { CoreUtilsProvider } from '@providers/utils/utils';
import { CoreCourseLogHelperProvider } from '@core/course/providers/log-helper';
import { AddonModGlossaryOfflineProvider } from './offline';
/**
@ -43,7 +44,8 @@ export class AddonModGlossaryProvider {
private translate: TranslateService,
private textUtils: CoreTextUtilsProvider,
private utils: CoreUtilsProvider,
private glossaryOffline: AddonModGlossaryOfflineProvider) {}
private glossaryOffline: AddonModGlossaryOfflineProvider,
private logHelper: CoreCourseLogHelperProvider) {}
/**
* Get the course glossary cache key.
@ -860,28 +862,31 @@ export class AddonModGlossaryProvider {
*
* @param {number} glossaryId Glossary ID.
* @param {string} mode The mode in which the glossary was viewed.
* @param {string} [siteId] Site ID. If not defined, current site.
* @return {Promise<any>} Promise resolved when the WS call is successful.
*/
logView(glossaryId: number, mode: string): Promise<any> {
logView(glossaryId: number, mode: string, siteId?: string): Promise<any> {
const params = {
id: glossaryId,
mode: mode
};
return this.sitesProvider.getCurrentSite().write('mod_glossary_view_glossary', params);
return this.logHelper.log('mod_glossary_view_glossary', params, AddonModGlossaryProvider.COMPONENT, glossaryId, siteId);
}
/**
* Report a glossary entry as being viewed.
*
* @param {number} entryId Entry ID.
* @param {number} glossaryId Glossary ID.
* @param {string} [siteId] Site ID. If not defined, current site.
* @return {Promise<any>} Promise resolved when the WS call is successful.
*/
logEntryView(entryId: number): Promise<any> {
logEntryView(entryId: number, glossaryId: number, siteId?: string): Promise<any> {
const params = {
id: entryId
};
return this.sitesProvider.getCurrentSite().write('mod_glossary_view_entry', params);
return this.logHelper.log('mod_glossary_view_entry', params, AddonModGlossaryProvider.COMPONENT, glossaryId, siteId);
}
}

11
src/addon/mod/imscp/providers/imscp.ts
View File

@ -19,6 +19,7 @@ import { CoreSitesProvider } from '@providers/sites';
import { CoreTextUtilsProvider } from '@providers/utils/text';
import { CoreUtilsProvider } from '@providers/utils/utils';
import { CoreCourseProvider } from '@core/course/providers/course';
import { CoreCourseLogHelperProvider } from '@core/course/providers/log-helper';
/**
* Service that provides some features for IMSCP.
@ -31,7 +32,8 @@ export class AddonModImscpProvider {
constructor(private appProvider: CoreAppProvider, private courseProvider: CoreCourseProvider,
private filepoolProvider: CoreFilepoolProvider, private sitesProvider: CoreSitesProvider,
private textUtils: CoreTextUtilsProvider, private utils: CoreUtilsProvider) {}
private textUtils: CoreTextUtilsProvider, private utils: CoreUtilsProvider,
private logHelper: CoreCourseLogHelperProvider) {}
/**
* Get the IMSCP toc as an array.
@ -307,13 +309,14 @@ export class AddonModImscpProvider {
* Report a IMSCP as being viewed.
*
* @param {string} id Module ID.
* @return {Promise<any>} Promise resolved when the WS call is successful.
* @param {string} [siteId] Site ID. If not defined, current site.
* @return {Promise<any>} Promise resolved when the WS call is successful.
*/
logView(id: string): Promise<any> {
logView(id: number, siteId?: string): Promise<any> {
const params = {
imscpid: id
};
return this.sitesProvider.getCurrentSite().write('mod_imscp_view_imscp', params);
return this.logHelper.log('mod_imscp_view_imscp', params, AddonModImscpProvider.COMPONENT, id, siteId);
}
}

12
src/addon/mod/lesson/providers/lesson.ts
View File

@ -20,6 +20,7 @@ import { CoreTextUtilsProvider } from '@providers/utils/text';
import { CoreDomUtilsProvider } from '@providers/utils/dom';
import { CoreUtilsProvider } from '@providers/utils/utils';
import { CoreGradesProvider } from '@core/grades/providers/grades';
import { CoreCourseLogHelperProvider } from '@core/course/providers/log-helper';
import { CoreSiteWSPreSets } from '@classes/site';
import { AddonModLessonOfflineProvider } from './lesson-offline';
@ -179,7 +180,7 @@ export class AddonModLessonProvider {
constructor(logger: CoreLoggerProvider, private sitesProvider: CoreSitesProvider, private utils: CoreUtilsProvider,
private translate: TranslateService, private textUtils: CoreTextUtilsProvider, private domUtils: CoreDomUtilsProvider,
private lessonOfflineProvider: AddonModLessonOfflineProvider) {
private lessonOfflineProvider: AddonModLessonOfflineProvider, private logHelper: CoreCourseLogHelperProvider) {
this.logger = logger.getInstance('AddonModLessonProvider');
this.sitesProvider.createTableFromSchema(this.tablesSchema);
@ -2960,14 +2961,9 @@ export class AddonModLessonProvider {
params.password = password;
}
return site.write('mod_lesson_view_lesson', params).then((result) => {
if (!result.status) {
return Promise.reject(null);
}
return result;
});
return this.logHelper.log('mod_lesson_view_lesson', params, AddonModLessonProvider.COMPONENT, id, siteId);
});
}
/**

11
src/addon/mod/lti/providers/lti.ts
View File

@ -20,6 +20,7 @@ import { CoreSitesProvider } from '@providers/sites';
import { CoreTextUtilsProvider } from '@providers/utils/text';
import { CoreUtilsProvider } from '@providers/utils/utils';
import { CoreUrlUtilsProvider } from '@providers/utils/url';
import { CoreCourseLogHelperProvider } from '@core/course/providers/log-helper';
export interface AddonModLtiParam {
name: string;
@ -42,7 +43,8 @@ export class AddonModLtiProvider {
private urlUtils: CoreUrlUtilsProvider,
private utils: CoreUtilsProvider,
private translate: TranslateService,
private appProvider: CoreAppProvider) {}
private appProvider: CoreAppProvider,
private logHelper: CoreCourseLogHelperProvider) {}
/**
* Delete launcher.
@ -211,13 +213,14 @@ export class AddonModLtiProvider {
* Report the LTI as being viewed.
*
* @param {string} id LTI id.
* @return {Promise<any>} Promise resolved when the WS call is successful.
* @param {string} [siteId] Site ID. If not defined, current site.
* @return {Promise<any>} Promise resolved when the WS call is successful.
*/
logView(id: string): Promise<any> {
logView(id: number, siteId?: string): Promise<any> {
const params: any = {
ltiid: id
};
return this.sitesProvider.getCurrentSite().write('mod_lti_view_lti', params);
return this.logHelper.log('mod_lti_view_lti', params, AddonModLtiProvider.COMPONENT, id, siteId);
}
}

9
src/addon/mod/page/providers/page.ts
View File

@ -17,6 +17,7 @@ import { CoreLoggerProvider } from '@providers/logger';
import { CoreSitesProvider } from '@providers/sites';
import { CoreUtilsProvider } from '@providers/utils/utils';
import { CoreCourseProvider } from '@core/course/providers/course';
import { CoreCourseLogHelperProvider } from '@core/course/providers/log-helper';
import { CoreFilepoolProvider } from '@providers/filepool';
/**
@ -30,7 +31,8 @@ export class AddonModPageProvider {
protected logger;
constructor(logger: CoreLoggerProvider, private sitesProvider: CoreSitesProvider, private courseProvider: CoreCourseProvider,
private utils: CoreUtilsProvider, private filepoolProvider: CoreFilepoolProvider) {
private utils: CoreUtilsProvider, private filepoolProvider: CoreFilepoolProvider,
private logHelper: CoreCourseLogHelperProvider) {
this.logger = logger.getInstance('AddonModPageProvider');
}
@ -146,13 +148,14 @@ export class AddonModPageProvider {
* Report a page as being viewed.
*
* @param {number} id Module ID.
* @param {string} [siteId] Site ID. If not defined, current site.
* @return {Promise<any>} Promise resolved when the WS call is successful.
*/
logView(id: number): Promise<any> {
logView(id: number, siteId?: string): Promise<any> {
const params = {
pageid: id
};
return this.sitesProvider.getCurrentSite().write('mod_page_view_page', params);
return this.logHelper.log('mod_page_view_page', params, AddonModPageProvider.COMPONENT, id, siteId);
}
}

5
src/addon/mod/quiz/pages/player/player.ts
View File

@ -428,7 +428,8 @@ export class AddonModQuizPlayerPage implements OnInit, OnDestroy {
});
// Mark the page as viewed. We'll ignore errors in this call.
this.quizProvider.logViewAttempt(this.attempt.id, page, this.preflightData, this.offline).catch((error) => {
this.quizProvider.logViewAttempt(this.attempt.id, this.quizId, page, this.preflightData, this.offline)
.catch((error) => {
// Ignore errors.
});
@ -455,7 +456,7 @@ export class AddonModQuizPlayerPage implements OnInit, OnDestroy {
this.attempt.dueDateWarning = this.quizProvider.getAttemptDueDateWarning(this.quiz, this.attempt);
// Log summary as viewed.
this.quizProvider.logViewAttemptSummary(this.attempt.id, this.preflightData).catch((error) => {
this.quizProvider.logViewAttemptSummary(this.attempt.id, this.preflightData, this.quizId).catch((error) => {
// Ignore errors.
});
});

2
src/addon/mod/quiz/pages/review/review.ts
View File

@ -77,7 +77,7 @@ export class AddonModQuizReviewPage implements OnInit {
*/
ngOnInit(): void {
this.fetchData().then(() => {
this.quizProvider.logViewAttemptReview(this.attemptId).catch((error) => {
this.quizProvider.logViewAttemptReview(this.attemptId, this.quizId).catch((error) => {
// Ignore errors.
});
}).finally(() => {

4
src/addon/mod/quiz/providers/quiz-sync.ts
View File

@ -341,8 +341,8 @@ export class AddonModQuizSyncProvider extends CoreSyncBaseProvider {
// Answers sent, now set the current page if the attempt isn't finished.
if (!finish) {
return this.quizProvider.logViewAttempt(onlineAttempt.id, offlineAttempt.currentpage, preflightData,
false).catch(() => {
return this.quizProvider.logViewAttempt(onlineAttempt.id, quiz.id, offlineAttempt.currentpage,
preflightData, false).catch(() => {
// Ignore errors.
});
}

27
src/addon/mod/quiz/providers/quiz.ts
View File

@ -24,6 +24,7 @@ import { CoreUtilsProvider } from '@providers/utils/utils';
import { CoreSiteWSPreSets } from '@classes/site';
import { CoreGradesHelperProvider } from '@core/grades/providers/helper';
import { CoreQuestionDelegate } from '@core/question/providers/delegate';
import { CoreCourseLogHelperProvider } from '@core/course/providers/log-helper';
import { AddonModQuizAccessRuleDelegate } from './access-rules-delegate';
import { AddonModQuizOfflineProvider } from './quiz-offline';
@ -62,7 +63,7 @@ export class AddonModQuizProvider {
private gradesHelper: CoreGradesHelperProvider, private questionDelegate: CoreQuestionDelegate,
private filepoolProvider: CoreFilepoolProvider, private timeUtils: CoreTimeUtilsProvider,
private accessRulesDelegate: AddonModQuizAccessRuleDelegate, private quizOfflineProvider: AddonModQuizOfflineProvider,
private domUtils: CoreDomUtilsProvider) {
private domUtils: CoreDomUtilsProvider, private logHelper: CoreCourseLogHelperProvider) {
this.logger = logger.getInstance('AddonModQuizProvider');
}
@ -1523,9 +1524,12 @@ export class AddonModQuizProvider {
* @param {number} [page=0] Page number.
* @param {any} [preflightData] Preflight required data (like password).
* @param {boolean} [offline] Whether attempt is offline.
* @param {number} quizId Quiz ID.
* @param {string} [siteId] Site ID. If not defined, current site.
* @return {Promise<any>} Promise resolved when the WS call is successful.
*/
logViewAttempt(attemptId: number, page: number = 0, preflightData: any = {}, offline?: boolean): Promise<any> {
logViewAttempt(attemptId: number, quizId: number, page: number = 0, preflightData: any = {}, offline?: boolean,
siteId?: string): Promise<any> {
const params = {
attemptid: attemptId,
page: page,
@ -1533,7 +1537,7 @@ export class AddonModQuizProvider {
},
promises = [];
promises.push(this.sitesProvider.getCurrentSite().write('mod_quiz_view_attempt', params));
promises.push(this.logHelper.log('mod_quiz_view_attempt', params, AddonModQuizProvider.COMPONENT, quizId, siteId));
if (offline) {
promises.push(this.quizOfflineProvider.setAttemptCurrentPage(attemptId, page));
}
@ -1545,14 +1549,16 @@ export class AddonModQuizProvider {
* Report an attempt's review as being viewed.
*
* @param {number} attemptId Attempt ID.
* @param {number} quizId Quiz ID.
* @param {string} [siteId] Site ID. If not defined, current site.
* @return {Promise<any>} Promise resolved when the WS call is successful.
*/
logViewAttemptReview(attemptId: number): Promise<any> {
logViewAttemptReview(attemptId: number, quizId: number, siteId?: string): Promise<any> {
const params = {
attemptid: attemptId
};
return this.sitesProvider.getCurrentSite().write('mod_quiz_view_attempt_review', params);
return this.logHelper.log('mod_quiz_view_attempt_review', params, AddonModQuizProvider.COMPONENT, quizId, siteId);
}
/**
@ -1560,29 +1566,32 @@ export class AddonModQuizProvider {
*
* @param {number} attemptId Attempt ID.
* @param {any} preflightData Preflight required data (like password).
* @param {number} quizId Quiz ID.
* @param {string} [siteId] Site ID. If not defined, current site.
* @return {Promise<any>} Promise resolved when the WS call is successful.
*/
logViewAttemptSummary(attemptId: number, preflightData: any): Promise<any> {
logViewAttemptSummary(attemptId: number, preflightData: any, quizId: number, siteId?: string): Promise<any> {
const params = {
attemptid: attemptId,
preflightdata: this.utils.objectToArrayOfObjects(preflightData, 'name', 'value', true)
};
return this.sitesProvider.getCurrentSite().write('mod_quiz_view_attempt_summary', params);
return this.logHelper.log('mod_quiz_view_attempt_summary', params, AddonModQuizProvider.COMPONENT, quizId, siteId);
}
/**
* Report a quiz as being viewed.
*
* @param {number} id Module ID.
* @param {string} [siteId] Site ID. If not defined, current site.
* @return {Promise<any>} Promise resolved when the WS call is successful.
*/
logViewQuiz(id: number): Promise<any> {
logViewQuiz(id: number, siteId?: string): Promise<any> {
const params = {
quizid: id
};
return this.sitesProvider.getCurrentSite().write('mod_quiz_view_quiz', params);
return this.logHelper.log('mod_quiz_view_quiz', params, AddonModQuizProvider.COMPONENT, id, siteId);
}
/**

9
src/addon/mod/resource/providers/resource.ts
View File

@ -17,6 +17,7 @@ import { CoreLoggerProvider } from '@providers/logger';
import { CoreSitesProvider } from '@providers/sites';
import { CoreUtilsProvider } from '@providers/utils/utils';
import { CoreCourseProvider } from '@core/course/providers/course';
import { CoreCourseLogHelperProvider } from '@core/course/providers/log-helper';
import { CoreFilepoolProvider } from '@providers/filepool';
/**
@ -30,7 +31,8 @@ export class AddonModResourceProvider {
protected logger;
constructor(logger: CoreLoggerProvider, private sitesProvider: CoreSitesProvider, private courseProvider: CoreCourseProvider,
private filepoolProvider: CoreFilepoolProvider, private utils: CoreUtilsProvider) {
private filepoolProvider: CoreFilepoolProvider, private utils: CoreUtilsProvider,
private logHelper: CoreCourseLogHelperProvider) {
this.logger = logger.getInstance('AddonModResourceProvider');
}
@ -148,13 +150,14 @@ export class AddonModResourceProvider {
* Report the resource as being viewed.
*
* @param {number} id Module ID.
* @param {string} [siteId] Site ID. If not defined, current site.
* @return {Promise<any>} Promise resolved when the WS call is successful.
*/
logView(id: number): Promise<any> {
logView(id: number, siteId?: string): Promise<any> {
const params = {
resourceid: id
};
return this.sitesProvider.getCurrentSite().write('mod_resource_view_resource', params);
return this.logHelper.log('mod_resource_view_resource', params, AddonModResourceProvider.COMPONENT, id, siteId);
}
}

19
src/addon/mod/scorm/providers/scorm.ts
View File

@ -26,6 +26,7 @@ import { CoreUtilsProvider } from '@providers/utils/utils';
import { AddonModScormOfflineProvider } from './scorm-offline';
import { CoreSiteWSPreSets } from '@classes/site';
import { CoreConstants } from '@core/constants';
import { CoreCourseLogHelperProvider } from '@core/course/providers/log-helper';
/**
* Result of getAttemptCount.
@ -113,7 +114,7 @@ export class AddonModScormProvider {
private wsProvider: CoreWSProvider, private textUtils: CoreTextUtilsProvider, private utils: CoreUtilsProvider,
private filepoolProvider: CoreFilepoolProvider, private scormOfflineProvider: AddonModScormOfflineProvider,
private timeUtils: CoreTimeUtilsProvider, private syncProvider: CoreSyncProvider,
private eventsProvider: CoreEventsProvider) {
private eventsProvider: CoreEventsProvider, private logHelper: CoreCourseLogHelperProvider) {
this.logger = logger.getInstance('AddonModScormProvider');
}
@ -1446,18 +1447,12 @@ export class AddonModScormProvider {
* @return {Promise<any>} Promise resolved when the WS call is successful.
*/
logView(id: number, siteId?: string): Promise<any> {
return this.sitesProvider.getSite(siteId).then((site) => {
const params = {
scormid: id
};
const params = {
scormid: id
};
return site.write('mod_scorm_view_scorm', params).then((response) => {
if (!response || !response.status) {
return Promise.reject(null);
}
});
});
}
return this.logHelper.log('mod_scorm_view_scorm', params, AddonModScormProvider.COMPONENT, id, siteId);
}
/**
* Saves a SCORM tracking record.

8
src/addon/mod/survey/providers/survey.ts
View File

@ -18,6 +18,7 @@ import { CoreSitesProvider } from '@providers/sites';
import { CoreUtilsProvider } from '@providers/utils/utils';
import { CoreAppProvider } from '@providers/app';
import { CoreFilepoolProvider } from '@providers/filepool';
import { CoreCourseLogHelperProvider } from '@core/course/providers/log-helper';
import { AddonModSurveyOfflineProvider } from './offline';
/**
@ -32,7 +33,7 @@ export class AddonModSurveyProvider {
constructor(logger: CoreLoggerProvider, private sitesProvider: CoreSitesProvider, private appProvider: CoreAppProvider,
private filepoolProvider: CoreFilepoolProvider, private utils: CoreUtilsProvider,
private surveyOffline: AddonModSurveyOfflineProvider) {
private surveyOffline: AddonModSurveyOfflineProvider, private logHelper: CoreCourseLogHelperProvider) {
this.logger = logger.getInstance('AddonModSurveyProvider');
}
@ -197,14 +198,15 @@ export class AddonModSurveyProvider {
* Report the survey as being viewed.
*
* @param {number} id Module ID.
* @param {string} [siteId] Site ID. If not defined, current site.
* @return {Promise<any>} Promise resolved when the WS call is successful.
*/
logView(id: number): Promise<any> {
logView(id: number, siteId?: string): Promise<any> {
const params = {
surveyid: id
};
return this.sitesProvider.getCurrentSite().write('mod_survey_view_survey', params);
return this.logHelper.log('mod_survey_view_survey', params, AddonModSurveyProvider.COMPONENT, id, siteId);
}
/**

9
src/addon/mod/url/providers/url.ts
View File

@ -18,6 +18,7 @@ import { CoreSitesProvider } from '@providers/sites';
import { CoreMimetypeUtilsProvider } from '@providers/utils/mimetype';
import { CoreUtilsProvider } from '@providers/utils/utils';
import { CoreCourseProvider } from '@core/course/providers/course';
import { CoreCourseLogHelperProvider } from '@core/course/providers/log-helper';
import { CoreConstants } from '@core/constants';
/**
@ -31,7 +32,8 @@ export class AddonModUrlProvider {
protected logger;
constructor(logger: CoreLoggerProvider, private sitesProvider: CoreSitesProvider, private courseProvider: CoreCourseProvider,
private utils: CoreUtilsProvider, private mimeUtils: CoreMimetypeUtilsProvider) {
private utils: CoreUtilsProvider, private mimeUtils: CoreMimetypeUtilsProvider,
private logHelper: CoreCourseLogHelperProvider) {
this.logger = logger.getInstance('AddonModUrlProvider');
}
@ -215,13 +217,14 @@ export class AddonModUrlProvider {
* Report the url as being viewed.
*
* @param {number} id Module ID.
* @param {string} [siteId] Site ID. If not defined, current site.
* @return {Promise<any>} Promise resolved when the WS call is successful.
*/
logView(id: number): Promise<any> {
logView(id: number, siteId?: string): Promise<any> {
const params = {
urlid: id
};
return this.sitesProvider.getCurrentSite().write('mod_url_view_url', params);
return this.logHelper.log('mod_url_view_url', params, AddonModUrlProvider.COMPONENT, id, siteId);
}
}

4
src/addon/mod/wiki/components/index/index.ts
View File

@ -110,7 +110,7 @@ export class AddonModWikiIndexComponent extends CoreCourseModuleMainActivityComp
// Ignore errors.
});
} else {
this.wikiProvider.logPageView(this.pageId).catch(() => {
this.wikiProvider.logPageView(this.pageId, this.wikiId).catch(() => {
// Ignore errors.
});
}
@ -341,7 +341,7 @@ export class AddonModWikiIndexComponent extends CoreCourseModuleMainActivityComp
this.currentPage = data.pageId;
this.showLoadingAndFetch(true, false).then(() => {
this.wikiProvider.logPageView(this.currentPage).catch(() => {
this.wikiProvider.logPageView(this.currentPage, this.wikiId).catch(() => {
// Ignore errors.
});
});

29
src/addon/mod/wiki/providers/wiki.ts
View File

@ -20,6 +20,7 @@ import { CoreSitesProvider } from '@providers/sites';
import { CoreUtilsProvider } from '@providers/utils/utils';
import { CoreAppProvider } from '@providers/app';
import { CoreFilepoolProvider } from '@providers/filepool';
import { CoreCourseLogHelperProvider } from '@core/course/providers/log-helper';
import { AddonModWikiOfflineProvider } from './wiki-offline';
import { CoreSiteWSPreSets } from '@classes/site';
@ -70,7 +71,8 @@ export class AddonModWikiProvider {
constructor(logger: CoreLoggerProvider, private sitesProvider: CoreSitesProvider, private appProvider: CoreAppProvider,
private filepoolProvider: CoreFilepoolProvider, private utils: CoreUtilsProvider, private translate: TranslateService,
private wikiOffline: AddonModWikiOfflineProvider, eventsProvider: CoreEventsProvider) {
private wikiOffline: AddonModWikiOfflineProvider, eventsProvider: CoreEventsProvider,
private logHelper: CoreCourseLogHelperProvider) {
this.logger = logger.getInstance('AddonModWikiProvider');
// Clear subwiki lists cache on logout.
@ -651,18 +653,17 @@ export class AddonModWikiProvider {
/**
* Report a wiki page as being viewed.
*
* @param {string} id Page ID.
* @param {number} id Page ID.
* @param {number} wikiId Wiki ID.
* @param {string} [siteId] Site ID. If not defined, current site.
* @return {Promise<any>} Promise resolved when the WS call is successful.
*/
logPageView(id: number, siteId?: string): Promise<any> {
return this.sitesProvider.getSite(siteId).then((site) => {
const params = {
pageid: id
};
logPageView(id: number, wikiId: number, siteId?: string): Promise<any> {
const params = {
pageid: id
};
return site.write('mod_wiki_view_page', params);
});
return this.logHelper.log('mod_wiki_view_page', params, AddonModWikiProvider.COMPONENT, wikiId, siteId);
}
/**
@ -673,13 +674,11 @@ export class AddonModWikiProvider {
* @return {Promise<any>} Promise resolved when the WS call is successful.
*/
logView(id: number, siteId?: string): Promise<any> {
return this.sitesProvider.getSite(siteId).then((site) => {
const params = {
wikiid: id
};
const params = {
wikiid: id
};
return site.write('mod_wiki_view_wiki', params);
});
return this.logHelper.log('mod_wiki_view_wiki', params, AddonModWikiProvider.COMPONENT, id, siteId);
}
/**

2
src/addon/mod/workshop/pages/submission/submission.ts
View File

@ -130,7 +130,7 @@ export class AddonModWorkshopSubmissionPage implements OnInit, OnDestroy {
*/
ngOnInit(): void {
this.fetchSubmissionData().then(() => {
this.workshopProvider.logViewSubmission(this.submissionId).then(() => {
this.workshopProvider.logViewSubmission(this.submissionId, this.workshopId).then(() => {
this.courseProvider.checkModuleCompletion(this.courseId, this.module.completiondata);
}).catch(() => {
// Ignore errors.

31
src/addon/mod/workshop/providers/workshop.ts
View File

@ -17,6 +17,7 @@ import { CoreAppProvider } from '@providers/app';
import { CoreFilepoolProvider } from '@providers/filepool';
import { CoreSitesProvider } from '@providers/sites';
import { CoreUtilsProvider } from '@providers/utils/utils';
import { CoreCourseLogHelperProvider } from '@core/course/providers/log-helper';
import { AddonModWorkshopOfflineProvider } from './offline';
/**
@ -49,7 +50,8 @@ export class AddonModWorkshopProvider {
private filepoolProvider: CoreFilepoolProvider,
private sitesProvider: CoreSitesProvider,
private utils: CoreUtilsProvider,
private workshopOffline: AddonModWorkshopOfflineProvider) {}
private workshopOffline: AddonModWorkshopOfflineProvider,
private logHelper: CoreCourseLogHelperProvider) {}
/**
* Get cache key for workshop data WS calls.
@ -1359,34 +1361,31 @@ export class AddonModWorkshopProvider {
/**
* Report the workshop as being viewed.
*
* @param {string} id Workshop ID.
* @param {number} id Workshop ID.
* @param {string} [siteId] Site ID. If not defined, current site.
* @return {Promise<any>} Promise resolved when the WS call is successful.
*/
logView(id: number, siteId?: string): Promise<any> {
return this.sitesProvider.getSite(siteId).then((site) => {
const params = {
workshopid: id
};
const params = {
workshopid: id
};
return site.write('mod_workshop_view_workshop', params);
});
return this.logHelper.log('mod_workshop_view_workshop', params, AddonModWorkshopProvider.COMPONENT, id, siteId);
}
/**
* Report the workshop submission as being viewed.
*
* @param {string} id Submission ID.
* @param {number} id Submission ID.
* @param {number} workshopId Workshop ID.
* @param {string} [siteId] Site ID. If not defined, current site.
* @return {Promise<any>} Promise resolved when the WS call is successful.
*/
logViewSubmission(id: number, siteId?: string): Promise<any> {
return this.sitesProvider.getSite(siteId).then((site) => {
const params = {
submissionid: id
};
logViewSubmission(id: number, workshopId: number, siteId?: string): Promise<any> {
const params = {
submissionid: id
};
return site.write('mod_workshop_view_submission', params);
});
return this.logHelper.log('mod_workshop_view_submission', params, AddonModWorkshopProvider.COMPONENT, workshopId, siteId);
}
}

3
src/core/course/course.module.ts
View File

@ -18,6 +18,7 @@ import { CoreCronDelegate } from '@providers/cron';
import { CoreEventsProvider } from '@providers/events';
import { CoreCourseProvider } from './providers/course';
import { CoreCourseHelperProvider } from './providers/helper';
import { CoreCourseLogHelperProvider } from './providers/log-helper';
import { CoreCourseFormatDelegate } from './providers/format-delegate';
import { CoreCourseModuleDelegate } from './providers/module-delegate';
import { CoreCourseOfflineProvider } from './providers/course-offline';
@ -37,6 +38,7 @@ import { CoreCourseLogCronHandler } from './providers/log-cron-handler';
export const CORE_COURSE_PROVIDERS: any[] = [
CoreCourseProvider,
CoreCourseHelperProvider,
CoreCourseLogHelperProvider,
CoreCourseFormatDelegate,
CoreCourseModuleDelegate,
CoreCourseModulePrefetchDelegate,
@ -56,6 +58,7 @@ export const CORE_COURSE_PROVIDERS: any[] = [
providers: [
CoreCourseProvider,
CoreCourseHelperProvider,
CoreCourseLogHelperProvider,
CoreCourseFormatDelegate,
CoreCourseModuleDelegate,
CoreCourseModulePrefetchDelegate,

225
src/core/course/providers/log-helper.ts 100644
View File

@ -0,0 +1,225 @@
// (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 { CoreSitesProvider } from '@providers/sites';
import { CoreTextUtilsProvider } from '@providers/utils/text';
import { CoreTimeUtilsProvider } from '@providers/utils/time';
import { CoreUtilsProvider } from '@providers/utils/utils';
import { CoreAppProvider } from '@providers/app';
/**
* Helper to manage logging to Moodle.
*/
@Injectable()
export class CoreCourseLogHelperProvider {
// Variables for database.
static ACTIVITY_LOG_TABLE = 'course_activity_log';
protected tablesSchema = [
{
name: CoreCourseLogHelperProvider.ACTIVITY_LOG_TABLE,
columns: [
{
name: 'component',
type: 'TEXT'
},
{
name: 'componentid',
type: 'INTEGER'
},
{
name: 'ws',
type: 'TEXT'
},
{
name: 'data',
type: 'TEXT'
},
{
name: 'time',
type: 'INTEGER'
}
],
primaryKeys: ['component', 'componentid', 'ws', 'time']
}
];
constructor(protected sitesProvider: CoreSitesProvider, protected timeUtils: CoreTimeUtilsProvider,
protected textUtils: CoreTextUtilsProvider, protected utils: CoreUtilsProvider,
protected appProvider: CoreAppProvider) {
this.sitesProvider.createTablesFromSchema(this.tablesSchema);
}
/**
* Delete the offline saved activity logs.
*
* @param {string} component Component name.
* @param {number} componentId Component ID.
* @param {string} siteId Site ID. If not defined, current site.
* @return {Promise<any>} Promise resolved when deleted, rejected if failure.
*/
protected deleteLogs(component: string, componentId: number, siteId?: string): Promise<any> {
return this.sitesProvider.getSite(siteId).then((site) => {
return site.getDb().deleteRecords(CoreCourseLogHelperProvider.ACTIVITY_LOG_TABLE,
{component: component, componentid: componentId});
});
}
/**
* Delete the offline saved activity logs using call data.
*
* @param {string} ws WS name.
* @param {any} data Data to send to the WS.
* @param {string} siteId Site ID. If not defined, current site.
* @return {Promise<any>} Promise resolved when deleted, rejected if failure.
*/
protected deleteWSLogs(ws: string, data: any, siteId?: string): Promise<any> {
return this.sitesProvider.getSite(siteId).then((site) => {
return site.getDb().deleteRecords(CoreCourseLogHelperProvider.ACTIVITY_LOG_TABLE,
{ws: ws, data: JSON.stringify(data)});
});
}
/**
* Get the offline saved activity logs.
*
* @param {string} component Component name.
* @param {number} componentId Component ID.
* @param {string} siteId Site ID. If not defined, current site.
* @return {Promise<any[]>} Promise resolved with the list of offline logs.
*/
protected getLogs(component: string, componentId: number, siteId?: string): Promise<any[]> {
return this.sitesProvider.getSite(siteId).then((site) => {
return site.getDb().getRecords(CoreCourseLogHelperProvider.ACTIVITY_LOG_TABLE,
{component: component, componentid: componentId});
});
}
/**
* Perform log online. Data will be saved offline for syncing.
*
* @param {string} ws WS name.
* @param {any} data Data to send to the WS.
* @param {string} component Component name.
* @param {number} componentId Component ID.
* @param {string} siteId Site ID. If not defined, current site.
* @return {Promise<any>} Promise resolved when done.
*/
log(ws: string, data: any, component: string, componentId: number, siteId?: string): Promise<any> {
return this.sitesProvider.getSite(siteId).then((site) => {
if (!this.appProvider.isOnline()) {
// App is offline, store the action.
return this.storeOffline(ws, data, component, componentId, site.getId());
}
return this.logOnline(ws, data, site.getId()).catch((error) => {
if (this.utils.isWebServiceError(error)) {
// The WebService has thrown an error, this means that responses cannot be submitted.
return Promise.reject(error);
}
// Couldn't connect to server, store in offline.
return this.storeOffline(ws, data, component, componentId, site.getId());
});
});
}
/**
* Perform the log online.
*
* @param {string} ws WS name.
* @param {any} data Data to send to the WS.
* @param {string} siteId Site ID. If not defined, current site.
* @return {Promise<any>} Promise resolved when log is successfully submitted. Rejected with object containing
* the error message (if any) and a boolean indicating if the error was returned by WS.
*/
protected logOnline(ws: string, data: any, siteId?: string): Promise<any> {
return this.sitesProvider.getSite(siteId).then((site) => {
return site.write(ws, data).then((response) => {
if (!response.status) {
return Promise.reject(this.utils.createFakeWSError(''));
}
// Remove all the logs performed.
// TODO: Remove this lines when time is accepted in logs.
return this.deleteWSLogs(ws, data);
}).catch((error) => {
return Promise.reject(this.utils.createFakeWSError(error));
});
});
}
/**
* Save activity log for offline sync.
*
* @param {string} ws WS name.
* @param {any} data Data to send to the WS.
* @param {string} component Component name.
* @param {number} componentId Component ID.
* @param {string} siteId Site ID. If not defined, current site.
* @return {Promise<number>} Resolved with the inserted rowId field.
*/
protected storeOffline(ws: string, data: any, component: string, componentId: number, siteId?: string):
Promise<number> {
return this.sitesProvider.getSite(siteId).then((site) => {
const log = {
ws: ws,
data: JSON.stringify(data),
component: component,
componentid: componentId,
time: this.timeUtils.timestamp()
};
return site.getDb().insertRecord(CoreCourseLogHelperProvider.ACTIVITY_LOG_TABLE, log);
});
}
/**
* Sync the offline saved activity logs.
*
* @param {string} component Component name.
* @param {number} componentId Component ID.
* @param {string} siteId Site ID. If not defined, current site.
* @return {Promise<any>} Promise resolved when done.
*/
syncIfNeeded(component: string, componentId: number, siteId?: string): Promise<any> {
return this.sitesProvider.getSite(siteId).then((site) => {
const siteId = site.getId();
return this.getLogs(component, componentId, siteId).then((logs) => {
const done = [];
// TODO: When time is accepted on log, do not discard same logs.
return Promise.all(logs.map((log) => {
// Just perform unique syncs.
const found = done.find((doneLog) => {
return log.ws == doneLog.ws && log.data == doneLog.data;
});
if (found) {
return Promise.resolve();
}
done.push(log);
return this.logOnline(log.ws, this.textUtils.parseJSON(log.data), siteId);
}));
});
});
}
}