Vmeda.Online/src/addons/privatefiles/pages/index/index.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 { Component, OnDestroy, OnInit, signal } from '@angular/core';
import { Md5 } from 'ts-md5/dist/md5';

import { CoreNetwork } from '@services/network';
import { CoreSites } from '@services/sites';
import { CoreDomUtils } from '@services/utils/dom';
import { CoreText } from '@singletons/text';
import { Translate } from '@singletons';
import { CoreEventObserver, CoreEvents } from '@singletons/events';
import {
    AddonPrivateFiles,
    AddonPrivateFilesProvider,
    AddonPrivateFilesFile,
    AddonPrivateFilesGetUserInfoWSResult,
    AddonPrivateFilesGetFilesWSParams,
} from '@addons/privatefiles/services/privatefiles';
import { AddonPrivateFilesHelper } from '@addons/privatefiles/services/privatefiles-helper';
import { CoreUtils } from '@services/utils/utils';
import { CoreNavigator } from '@services/navigator';
import { CoreTime } from '@singletons/time';
import { CoreAnalytics, CoreAnalyticsEventType } from '@services/analytics';
import { CoreModals } from '@services/modals';
import { CoreFilepool } from '@services/filepool';
import { CoreToasts, ToastDuration } from '@services/toasts';
import { CoreLoadings } from '@services/loadings';
import { AddonPrivateFilesFileComponent } from '@addons/privatefiles/components/file/file';

/**
 * Page that displays the list of files.
 */
@Component({
    selector: 'page-addon-privatefiles-index',
    templateUrl: 'index.html',
    styleUrls: ['./index.scss'],
})
export class AddonPrivateFilesIndexPage implements OnInit, OnDestroy {

    title!: string; // Page title.
    root?: 'my' | 'site'; // The root of the files loaded: 'my' or 'site'.
    path?: AddonPrivateFilesGetFilesWSParams; // The path of the directory being loaded. If empty path it means load the root.
    showPrivateFiles!: boolean; // Whether the user can view private files.
    showSiteFiles!: boolean; // Whether the user can view site files.
    showUpload!: boolean; // Whether the user can upload files.
    userQuota?: number; // The user quota (in bytes).
    filesInfo?: AddonPrivateFilesGetUserInfoWSResult; // Info about private files (size, number of files, etc.).
    spaceUsed?: string; // Space used in a readable format.
    userQuotaReadable?: string; // User quota in a readable format.
    files?: AddonPrivateFilesFile[]; // List of files.
    component!: string; // Component to link the file downloads to.
    filesLoaded = false; // Whether the files are loaded.
    selectFilesEnabled = signal(false);
    selectedFiles: AddonPrivateFilesFile[] = [];
    selectAll = false;
    canDeleteFiles = false;

    protected updateSiteObserver: CoreEventObserver;
    protected logView: () => void;

    constructor() {
        // Update visibility if current site info is updated.
        this.updateSiteObserver = CoreEvents.on(CoreEvents.SITE_UPDATED, () => {
            this.setVisibility();
        }, CoreSites.getCurrentSiteId());

        this.logView = CoreTime.once(async () => {
            CoreAnalytics.logEvent({
                type: CoreAnalyticsEventType.VIEW_ITEM_LIST,
                ws: 'core_files_get_files',
                name: Translate.instant('addon.privatefiles.files'),
                data: { category: 'files' },
                url: '/user/files.php',
            });
        });
    }

    /**
     * @inheritdoc
     */
    async ngOnInit(): Promise<void> {
        try {
            this.root = CoreNavigator.getRouteParam('root');
            const contextId = CoreNavigator.getRouteNumberParam('contextid');

            if (contextId) {
                // Loading a certain folder.
                this.path = {
                    contextid: contextId,
                    component: CoreNavigator.getRequiredRouteParam<string>('component'),
                    filearea: CoreNavigator.getRequiredRouteParam<string>('filearea'),
                    itemid: CoreNavigator.getRequiredRouteNumberParam('itemid'),
                    filepath: CoreNavigator.getRequiredRouteParam<string>('filepath'),
                    filename: CoreNavigator.getRequiredRouteParam<string>('filename'),
                };
            }
        } catch (error) {
            CoreDomUtils.showErrorModal(error);

            CoreNavigator.back();

            return;
        }

        this.title = this.path?.filename || Translate.instant('addon.privatefiles.files');

        this.setVisibility();
        this.userQuota = CoreSites.getCurrentSite()?.getInfo()?.userquota;

        if (!this.root) {
            // Load private files by default.
            if (this.showPrivateFiles) {
                this.root = 'my';
            } else if (this.showSiteFiles) {
                this.root = 'site';
            }
        }

        if (this.root) {
            this.rootChanged(this.root);
        } else {
            this.filesLoaded = true;
        }

        this.canDeleteFiles = await AddonPrivateFiles.canDeletePrivateFiles();
    }

    /**
     * Set visibility of some items based on site data.
     */
    protected setVisibility(): void {
        this.showPrivateFiles = AddonPrivateFiles.canViewPrivateFiles();
        this.showSiteFiles = AddonPrivateFiles.canViewSiteFiles();
        this.showUpload = AddonPrivateFiles.canUploadFiles();
    }

    /**
     * Refresh the data.
     *
     * @param refresher Refresher.
     */
    refreshData(refresher?: HTMLIonRefresherElement): void {
        this.refreshFiles().finally(() => {
            refresher?.complete();
        });
    }

    /**
     * Function called when the root has changed.
     *
     * @param root New root.
     */
    rootChanged(root: 'my' | 'site'): void {
        this.root = root;

        this.filesLoaded = false;
        this.component = this.root == 'my' ? AddonPrivateFilesProvider.PRIVATE_FILES_COMPONENT :
            AddonPrivateFilesProvider.SITE_FILES_COMPONENT;

        this.fetchFiles().finally(() => {
            this.filesLoaded = true;
        });

        this.cancelFileSelection();
    }

    /**
     * Upload a new file.
     */
    async uploadFile(): Promise<void> {
        if (!CoreNetwork.isOnline()) {
            CoreDomUtils.showErrorModal('core.fileuploader.errormustbeonlinetoupload', true);

            return;
        }

        try {
            await AddonPrivateFilesHelper.uploadPrivateFile(this.filesInfo);

            // File uploaded, refresh the list.
            this.filesLoaded = false;

            await CoreUtils.ignoreErrors(this.refreshFiles());

            this.filesLoaded = true;
        } catch (error) {
            CoreDomUtils.showErrorModalDefault(error, 'core.fileuploader.errorwhileuploading', true);
        }
    }

    /**
     * Fetch the files.
     *
     * @returns Promise resolved when done.
     */
    protected async fetchFiles(): Promise<void> {
        try {
            if (this.path) {
                // Path is set, serve the files the user requested.
                this.files = await AddonPrivateFiles.getFiles(this.path);

                return;
            }

            // The path is unknown, the user must be requesting a root.
            if (this.root == 'site') {
                this.title = Translate.instant('addon.privatefiles.sitefiles');

                this.files = await AddonPrivateFiles.getSiteFiles();
            } else if (this.root == 'my') {
                this.title = Translate.instant('addon.privatefiles.files');

                this.files = await AddonPrivateFiles.getPrivateFiles();

                if (this.showUpload && this.userQuota && this.userQuota > 0) {
                    // Get the info to calculate the available size.
                    this.filesInfo = await AddonPrivateFiles.getPrivateFilesInfo();

                    this.spaceUsed = CoreText.bytesToSize(this.filesInfo.filesizewithoutreferences, 1);
                    this.userQuotaReadable = CoreText.bytesToSize(this.userQuota, 1);
                } else {
                    // User quota isn't useful, delete it.
                    delete this.userQuota;
                }

                this.logView();
            } else {
                // Unknown root.
                CoreDomUtils.showErrorModal('addon.privatefiles.couldnotloadfiles', true);
            }
        } catch (error) {
            CoreDomUtils.showErrorModalDefault(error, 'addon.privatefiles.couldnotloadfiles', true);
        }
    }

    /**
     * Refresh the displayed files.
     *
     * @returns Promise resolved when done.
     */
    protected async refreshFiles(): Promise<void> {
        try {
            await Promise.all([
                AddonPrivateFiles.invalidateDirectory(this.root, this.path),
                AddonPrivateFiles.invalidatePrivateFilesInfoForUser(),
            ]);
        } finally {
            await this.fetchFiles();
        }
    }

    /**
     * Open a folder.
     *
     * @param folder Folder to open.
     */
    openFolder(folder: AddonPrivateFilesFile): void {
        const params = {
            contextid: folder.contextid,
            component: folder.component || '',
            filearea: folder.filearea || '',
            itemid: folder.itemid || 0,
            filepath: folder.filepath || '',
            filename: folder.filename || '',
            root: this.root,
        };

        if (folder.component) {
            // Delete unused elements that may break the request.
            params.filename = '';
        }

        const hash = Md5.hashAsciiStr(JSON.stringify(params));

        CoreNavigator.navigate(`../${hash}`, { params });
    }

    /**
     * Page destroyed.
     */
    ngOnDestroy(): void {
        this.updateSiteObserver?.off();
    }

    /**
     * Delete private files.
     */
    async deleteSelectedFiles(showConfirmation = false): Promise<void> {
        if (showConfirmation) {
            try {
                await CoreDomUtils.showDeleteConfirm('core.confirmremoveselectedfiles');
            } catch {
                return;
            }
        }

        const siteId = CoreSites.getCurrentSiteId();
        const loading = await CoreLoadings.show();

        try {
            await AddonPrivateFiles.deleteFiles(this.selectedFiles);
        } catch (error) {
            loading.dismiss();
            await CoreDomUtils.showErrorModalDefault(error, 'An error occourred while file was being deleted.');
            throw error;
        }

        for (const file of this.selectedFiles) {
            await this.deleteOfflineFile(file, siteId);
        }

        await this.refreshFiles();
        loading.dismiss();

        const message = Translate.instant(
            'core.filedeletedsuccessfully',
            {
                filename: this.selectedFiles.length === 1
                    ? this.selectedFiles[0].filename
                    : (this.selectedFiles.length + ' ' + Translate.instant('addon.privatefiles.files')),
            },
        );

        this.selectedFiles = [];
        this.selectFilesEnabled.set(false);
        await CoreToasts.show({ message, translateMessage: false, duration: ToastDuration.SHORT });
    }

    /**
     * File selection changes.
     *
     * @param selected selection value.
     * @param file File selection.
     */
    selectedFileValueChanged(selected: boolean, file: AddonPrivateFilesFile): void {
        if (selected) {
            this.selectedFiles.push(file);

            return;
        }

        this.selectedFiles = this.selectedFiles.filter(selectedFile => selectedFile !== file);
    }

    /**
     * Cancel file selection.
     */
    cancelFileSelection(): void {
        this.selectFilesEnabled.set(false);
        this.selectedFiles = [];
    }

    /**
     * Open file management menu.
     *
     * @param instance AddonPrivateFilesFileComponent instance.
     * @param file File to manage.
     *
     * @returns Promise done.
     */
    async openManagementFileMenu(instance: AddonPrivateFilesFileComponent, file: AddonPrivateFilesFile): Promise<void> {
        const siteId = CoreSites.getCurrentSiteId();
        const { AddonPrivateFilesFileActionsComponent } = await import('@addons/privatefiles/components/file-actions/file-actions');

        try {
            const { status } = await CoreModals.openSheet(
                AddonPrivateFilesFileActionsComponent,
                { isDownloaded: instance.isDownloaded, filename: file.filename, icon: instance.fileIcon },
                true,
            );

            if (status === 'cancel') {
                return;
            }

            if (status === 'deleteOnline') {
                await CoreDomUtils.showDeleteConfirm('core.confirmremoveselectedfile', { filename: file.filename });
                this.selectedFiles = [file];

                return await this.deleteSelectedFiles();
            }

            if (status === 'deleteOffline') {
                return await this.deleteOfflineFile(file, siteId);
            }

            await instance.download();
        } catch {
            return;
        }
    }

    /**
     * Select all changes
     *
     * @param checked Select all toggle value.
     */
    onSelectAllChanges(checked: boolean): void {
        if (!this.files) {
            return;
        }

        for (const file of this.files) {
            file.selected = checked;
        }

        this.selectedFiles = checked ? [...this.files] : [];
    }

    /**
     * Enables multiple file selection and mark as selected the passed file.
     *
     * @param file File to be selected.
     */
    enableMultipleSelection(file: AddonPrivateFilesFile): void {
        this.selectFilesEnabled.set(true);
        this.selectedFiles.push(file);
        file.selected = true;
    }

    /**
     * Remove offline file.
     *
     * @param file File to remove.
     * @param siteId Site ID.
     */
    async deleteOfflineFile(file: AddonPrivateFilesFile, siteId: string): Promise<void> {
        try {
            await CoreFilepool.removeFileByUrl(siteId, file.fileurl);
        } catch (error) {
            CoreDomUtils.showErrorModalDefault(error, 'core.errordeletefile', true);
        }
    }

}