102 lines
4.5 KiB
TypeScript
102 lines
4.5 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 { NavController } from 'ionic-angular';
|
|
import { CoreContentLinksAction } from '../providers/delegate';
|
|
import { CoreContentLinksHandlerBase } from './base-handler';
|
|
import { CoreSitesProvider } from '../../../providers/sites';
|
|
import { CoreDomUtilsProvider } from '../../../providers/utils/dom';
|
|
import { CoreCourseHelperProvider } from '../../course/providers/helper';
|
|
|
|
/**
|
|
* Handler to handle URLs pointing to the grade of a module.
|
|
*/
|
|
export class CoreContentLinksModuleGradeHandler extends CoreContentLinksHandlerBase {
|
|
|
|
/**
|
|
* Whether the module can be reviewed in the app. If true, the handler needs to implement the goToReview function.
|
|
* @type {boolean}
|
|
*/
|
|
canReview: boolean;
|
|
|
|
/**
|
|
* Construct the handler.
|
|
*
|
|
* @param {CoreCourseHelperProvider} courseHelper The CoreCourseHelperProvider instance.
|
|
* @param {CoreDomUtilsProvider} domUtils The CoreDomUtilsProvider instance.
|
|
* @param {CoreSitesProvider} sitesProvider The CoreSitesProvider instance.
|
|
* @param {string} addon Name of the addon as it's registered in course delegate. It'll be used to check if it's disabled.
|
|
* @param {string} modName Name of the module (assign, book, ...).
|
|
*/
|
|
constructor(protected courseHelper: CoreCourseHelperProvider, protected domUtils: CoreDomUtilsProvider,
|
|
protected sitesProvider: CoreSitesProvider, public addon: string, public modName: string) {
|
|
super();
|
|
|
|
// Match the grade.php URL with an id param.
|
|
this.pattern = new RegExp('\/mod\/' + modName + '\/grade\.php.*([\&\?]id=\\d+)');
|
|
this.featureName = '$mmCourseDelegate_' + addon;
|
|
}
|
|
|
|
/**
|
|
* Get the list of actions for a link (url).
|
|
*
|
|
* @param {string[]} siteIds List of sites the URL belongs to.
|
|
* @param {string} url The URL to treat.
|
|
* @param {any} params The params of the URL. E.g. 'mysite.com?id=1' -> {id: 1}
|
|
* @param {number} [courseId] Course ID related to the URL. Optional but recommended.
|
|
* @return {CoreContentLinksAction[]|Promise<CoreContentLinksAction[]>} List of (or promise resolved with list of) actions.
|
|
*/
|
|
getActions(siteIds: string[], url: string, params: any, courseId?: number):
|
|
CoreContentLinksAction[] | Promise<CoreContentLinksAction[]> {
|
|
|
|
courseId = courseId || params.courseid || params.cid;
|
|
|
|
return [{
|
|
action: (siteId, navCtrl?): void => {
|
|
// Check if userid is the site's current user.
|
|
const modal = this.domUtils.showModalLoading();
|
|
this.sitesProvider.getSite(siteId).then((site) => {
|
|
if (!params.userid || params.userid == site.getUserId()) {
|
|
// No user specified or current user. Navigate to module.
|
|
this.courseHelper.navigateToModule(parseInt(params.id, 10), siteId, courseId);
|
|
} else if (this.canReview) {
|
|
// Use the goToReview function.
|
|
this.goToReview(url, params, courseId, siteId, navCtrl);
|
|
} else {
|
|
// Not current user and cannot review it in the app, open it in browser.
|
|
site.openInBrowserWithAutoLogin(url);
|
|
}
|
|
}).finally(() => {
|
|
modal.dismiss();
|
|
});
|
|
}
|
|
}];
|
|
}
|
|
|
|
/**
|
|
* Go to the page to review.
|
|
*
|
|
* @param {string} url The URL to treat.
|
|
* @param {any} params The params of the URL. E.g. 'mysite.com?id=1' -> {id: 1}
|
|
* @param {number} courseId Course ID related to the URL.
|
|
* @param {string} siteId Site to use.
|
|
* @param {NavController} [navCtrl] Nav Controller to use to navigate.
|
|
* @return {Promise<any>} Promise resolved when done.
|
|
*/
|
|
protected goToReview(url: string, params: any, courseId: number, siteId: string, navCtrl?: NavController): Promise<any> {
|
|
// This function should be overridden.
|
|
return Promise.resolve();
|
|
}
|
|
}
|