129 lines
4.4 KiB
TypeScript
129 lines
4.4 KiB
TypeScript
// (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';
|
|
|
|
import { CoreCourse } from '@features/course/services/course';
|
|
import { CoreCourseModuleData } from '@features/course/services/course-helper';
|
|
import { CorePlatform } from '@services/platform';
|
|
import { CoreSites } from '@services/sites';
|
|
import { CoreDomUtils } from '@services/utils/dom';
|
|
import { makeSingleton } from '@singletons';
|
|
import { CoreEvents } from '@singletons/events';
|
|
import { AddonModLti, AddonModLtiLti } from './lti';
|
|
|
|
/**
|
|
* Service that provides some helper functions for LTI.
|
|
*/
|
|
@Injectable({ providedIn: 'root' })
|
|
export class AddonModLtiHelperProvider {
|
|
|
|
protected pendingCheckCompletion: {[moduleId: string]: {courseId: number; module: CoreCourseModuleData}} = {};
|
|
|
|
constructor() {
|
|
// Clear pending completion on logout.
|
|
CoreEvents.on(CoreEvents.LOGOUT, () => {
|
|
this.pendingCheckCompletion = {};
|
|
});
|
|
}
|
|
|
|
watchPendingCompletions(): void {
|
|
CorePlatform.resume.subscribe(() => {
|
|
// User went back to the app, check pending completions.
|
|
for (const moduleId in this.pendingCheckCompletion) {
|
|
const data = this.pendingCheckCompletion[moduleId];
|
|
|
|
CoreCourse.checkModuleCompletion(data.courseId, data.module.completiondata);
|
|
}
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Get needed data and launch the LTI.
|
|
*
|
|
* @param courseId Course ID.
|
|
* @param module Module.
|
|
* @param lti LTI instance. If not provided it will be obtained.
|
|
* @param siteId Site ID. If not defined, current site.
|
|
* @return Promise resolved when done.
|
|
*/
|
|
async getDataAndLaunch(courseId: number, module: CoreCourseModuleData, lti?: AddonModLtiLti, siteId?: string): Promise<void> {
|
|
siteId = siteId || CoreSites.getCurrentSiteId();
|
|
|
|
const modal = await CoreDomUtils.showModalLoading();
|
|
|
|
try {
|
|
const openInBrowser = await AddonModLti.shouldLaunchInBrowser(siteId);
|
|
|
|
if (openInBrowser) {
|
|
const site = await CoreSites.getSite(siteId);
|
|
|
|
// The view event is triggered by the browser, mark the module as pending to check completion.
|
|
this.pendingCheckCompletion[module.id] = {
|
|
courseId,
|
|
module,
|
|
};
|
|
|
|
return site.openInBrowserWithAutoLogin(module.url || '');
|
|
}
|
|
|
|
// Open in app.
|
|
if (!lti) {
|
|
lti = await AddonModLti.getLti(courseId, module.id);
|
|
}
|
|
|
|
const launchData = await AddonModLti.getLtiLaunchData(lti.id);
|
|
|
|
// "View" LTI without blocking the UI.
|
|
this.logViewAndCheckCompletion(courseId, module, lti.id, lti.name, siteId);
|
|
|
|
// Launch LTI.
|
|
return AddonModLti.launch(launchData.endpoint, launchData.parameters);
|
|
} catch (error) {
|
|
CoreDomUtils.showErrorModalDefault(error, 'addon.mod_lti.errorgetlti', true);
|
|
} finally {
|
|
modal.dismiss();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Report the LTI as being viewed and check completion.
|
|
*
|
|
* @param courseId Course ID.
|
|
* @param module Module.
|
|
* @param ltiId LTI id.
|
|
* @param name Name of the lti.
|
|
* @param siteId Site ID. If not defined, current site.
|
|
* @return Promise resolved when done.
|
|
*/
|
|
async logViewAndCheckCompletion(
|
|
courseId: number,
|
|
module: CoreCourseModuleData,
|
|
ltiId: number,
|
|
name?: string,
|
|
siteId?: string,
|
|
): Promise<void> {
|
|
try {
|
|
await AddonModLti.logView(ltiId, name, siteId);
|
|
|
|
CoreCourse.checkModuleCompletion(courseId, module.completiondata);
|
|
} catch {
|
|
// Ignore errors.
|
|
}
|
|
}
|
|
|
|
}
|
|
|
|
export const AddonModLtiHelper = makeSingleton(AddonModLtiHelperProvider);
|