Vmeda.Online/src/addons/mod/lesson/services/handlers/report-link.ts

// (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 { CoreContentLinksHandlerBase } from '@features/contentlinks/classes/base-handler';
import { CoreContentLinksAction } from '@features/contentlinks/services/contentlinks-delegate';
import { CoreCourse } from '@features/course/services/course';
import { CoreNavigator } from '@services/navigator';
import { CoreDomUtils } from '@services/utils/dom';
import { makeSingleton } from '@singletons';
import { AddonModLesson } from '../lesson';
import { AddonModLessonModuleHandlerService } from './module';

/**
 * Handler to treat links to lesson report.
 */
@Injectable({ providedIn: 'root' })
export class AddonModLessonReportLinkHandlerService extends CoreContentLinksHandlerBase {

    name = 'AddonModLessonReportLinkHandler';
    featureName = 'CoreCourseModuleDelegate_AddonModLesson';
    pattern = /\/mod\/lesson\/report\.php.*([&?]id=\d+)/;

    /**
     * Get the list of actions for a link (url).
     *
     * @param siteIds List of sites the URL belongs to.
     * @param url The URL to treat.
     * @param params The params of the URL. E.g. 'mysite.com?id=1' -> {id: 1}
     * @param courseId Course ID related to the URL. Optional but recommended.
     * @param data Extra data to handle the URL.
     * @return List of (or promise resolved with list of) actions.
     */
    getActions(
        siteIds: string[],
        url: string,
        params: Record<string, string>,
        courseId?: number,
        data?: unknown, // eslint-disable-line @typescript-eslint/no-unused-vars
    ): CoreContentLinksAction[] | Promise<CoreContentLinksAction[]> {
        courseId = Number(courseId || params.courseid || params.cid);

        return [{
            action: (siteId) => {
                if (!params.action || params.action == 'reportoverview') {
                    // Go to overview.
                    this.openReportOverview(Number(params.id), courseId, Number(params.group), siteId);
                } else if (params.action == 'reportdetail') {
                    this.openUserRetake(Number(params.id), Number(params.userid), Number(params.try), siteId, courseId);
                }
            },
        }];
    }

    /**
     * Check if the handler is enabled for a certain site (site + user) and a URL.
     * If not defined, defaults to true.
     *
     * @param siteId The site ID.
     * @param url The URL to treat.
     * @param params The params of the URL. E.g. 'mysite.com?id=1' -> {id: 1}
     * @param courseId Course ID related to the URL. Optional but recommended.
     * @return Whether the handler is enabled for the URL and site.
     */
    // eslint-disable-next-line @typescript-eslint/no-unused-vars
    async isEnabled(siteId: string, url: string, params: Record<string, string>, courseId?: number): Promise<boolean> {
        if (params.action == 'reportdetail' && !params.userid) {
            // Individual details are only available if the teacher is seeing a certain user.
            return false;
        }

        return AddonModLesson.instance.isPluginEnabled(siteId);
    }

    /**
     * Open report overview.
     *
     * @param moduleId Module ID.
     * @param courseId Course ID.
     * @param groupId Group ID.
     * @param siteId Site ID.
     * @param navCtrl The NavController to use to navigate.
     * @return Promise resolved when done.
     */
    protected async openReportOverview(moduleId: number, courseId?: number, groupId?: number, siteId?: string): Promise<void> {

        const modal = await CoreDomUtils.instance.showModalLoading();

        try {
            // Get the module object.
            const module = await CoreCourse.instance.getModuleBasicInfo(moduleId, siteId);

            const params = {
                module: module,
                courseId: courseId || module.course,
                action: 'report',
                group: groupId === undefined || isNaN(groupId) ? null : groupId,
            };

            CoreNavigator.instance.navigateToSitePath(AddonModLessonModuleHandlerService.PAGE_NAME, { params, siteId });
        } catch (error) {
            CoreDomUtils.instance.showErrorModalDefault(error, 'Error processing link.');
        } finally {
            modal.dismiss();
        }
    }

    /**
     * Open a user's retake.
     *
     * @param moduleId Module ID.
     * @param userId User ID.
     * @param courseId Course ID.
     * @param retake Retake to open.
     * @param groupId Group ID.
     * @param siteId Site ID.
     * @param navCtrl The NavController to use to navigate.
     * @return Promise resolved when done.
     */
    protected async openUserRetake(
        moduleId: number,
        userId: number,
        retake: number,
        siteId: string,
        courseId?: number,
    ): Promise<void> {

        const modal = await CoreDomUtils.instance.showModalLoading();

        try {
            // Get the module object.
            const module = await CoreCourse.instance.getModuleBasicInfo(moduleId, siteId);

            courseId = courseId || module.course;
            const params = {
                userId: userId,
                retake: retake || 0,
            };

            CoreNavigator.instance.navigateToSitePath(
                AddonModLessonModuleHandlerService.PAGE_NAME + `/user-retake/${courseId}/${module.instance}`,
                { params, siteId },
            );
        } catch (error) {
            CoreDomUtils.instance.showErrorModalDefault(error, 'Error processing link.');
        } finally {
            modal.dismiss();
        }
    }

}

export class AddonModLessonReportLinkHandler extends makeSingleton(AddonModLessonReportLinkHandlerService) {}