Proyectos de Subversion Moodle

// This file is part of Moodle - http://moodle.org/

//

// Moodle is free software: you can redistribute it and/or modify

// it under the terms of the GNU General Public License as published by

// the Free Software Foundation, either version 3 of the License, or

// (at your option) any later version.

//

// Moodle is distributed in the hope that it will be useful,

// but WITHOUT ANY WARRANTY; without even the implied warranty of

// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

// GNU General Public License for more details.

//

// You should have received a copy of the GNU General Public License

// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/**

 * Request actions.

 *

 * @module     tool_dataprivacy/requestactions

 * @copyright  2018 Jun Pataleta

 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

 */

define([

    'jquery',

    'core/ajax',

    'core/notification',

    'core/str',

    'core/modal_save_cancel',

    'core/modal_events',

    'core/templates',

    'tool_dataprivacy/data_request_modal',

    'tool_dataprivacy/events',

    'tool_dataprivacy/selectedcourses'

], function(

    $, Ajax, Notification, Str, ModalSaveCancel, ModalEvents, Templates, ModalDataRequest, DataPrivacyEvents, SelectedCourses

) {

    /**

     * List of action selectors.

     *

     * @type {{APPROVE_REQUEST: string}}

     * @type {{DENY_REQUEST: string}}

     * @type {{VIEW_REQUEST: string}}

     * @type {{MARK_COMPLETE: string}}

     * @type {{CHANGE_BULK_ACTION: string}}

     * @type {{CONFIRM_BULK_ACTION: string}}

     * @type {{SELECT_ALL: string}}

     */

    var ACTIONS = {

        APPROVE_REQUEST: '[data-action="approve"]',

        DENY_REQUEST: '[data-action="deny"]',

        VIEW_REQUEST: '[data-action="view"]',

        MARK_COMPLETE: '[data-action="complete"]',

        CHANGE_BULK_ACTION: '[id="bulk-action"]',

        CONFIRM_BULK_ACTION: '[id="confirm-bulk-action"]',

        SELECT_ALL: '[data-action="selectall"]',

        APPROVE_REQUEST_SELECT_COURSE: '[data-action="approve-selected-courses"]',

    };

    /**

     * List of available bulk actions.

     *

     * @type {{APPROVE: number}}

     * @type {{DENY: number}}

     */

    var BULK_ACTIONS = {

        APPROVE: 1,

        DENY: 2

    };

    /**

     * List of selectors.

     *

     * @type {{SELECT_REQUEST: string}}

     */

    var SELECTORS = {

        SELECT_REQUEST: '.selectrequests'

    };

    /**

     * RequestActions class.

     */

    var RequestActions = function() {

        this.registerEvents();

    };

    /**

     * Register event listeners.

     */

    RequestActions.prototype.registerEvents = function() {

        $(ACTIONS.VIEW_REQUEST).click(function(e) {

            e.preventDefault();

            var requestId = $(this).data('requestid');

            var contextId = $(this).data('contextid');

            // Cancel the request.

            var params = {

                'requestid': requestId

            };

            var request = {

                methodname: 'tool_dataprivacy_get_data_request',

                args: params

            };

            var promises = Ajax.call([request]);

            $.when(promises[0]).then(function(data) {

                if (data.result) {

                    return data.result;

                }

                // Fail.

                Notification.addNotification({

                    message: data.warnings[0].message,

                    type: 'error'

                });

                return false;

            }).then(function(data) {

                var body = Templates.render('tool_dataprivacy/request_details', data);

                var templateContext = {

                    approvedeny: data.approvedeny,

                    canmarkcomplete: data.canmarkcomplete,

                    allowfiltering: data.allowfiltering

                };

                return ModalDataRequest.create({

                    title: data.typename,

                    body: body,

                    large: true,

                    templateContext: templateContext

                });

            }).then(function(modal) {

                // Handle approve event.

                modal.getRoot().on(DataPrivacyEvents.approve, function() {

                    showConfirmation(DataPrivacyEvents.approve, approveEventWsData(requestId));

                });

                // Handle deny event.

                modal.getRoot().on(DataPrivacyEvents.deny, function() {

                    showConfirmation(DataPrivacyEvents.deny, denyEventWsData(requestId));

                });

                // Handle send event.

                modal.getRoot().on(DataPrivacyEvents.complete, function() {

                    var params = {

                        'requestid': requestId

                    };

                    handleSave('tool_dataprivacy_mark_complete', params);

                });

                // Handle hidden event.

                modal.getRoot().on(ModalEvents.hidden, function() {

                    // Destroy when hidden.

                    modal.destroy();

                });

                modal.getRoot().on(DataPrivacyEvents.approveSelectCourses, function() {

                    new SelectedCourses(contextId, requestId);

                });

                // Show the modal!

                modal.show();

                return;

            }).catch(Notification.exception);

        });

        $(ACTIONS.APPROVE_REQUEST_SELECT_COURSE).click(function(e) {

            e.preventDefault();

            var requestId = $(this).data('requestid');

            var contextId = $(this).data('contextid');

            new SelectedCourses(contextId, requestId);

        });

        $(ACTIONS.APPROVE_REQUEST).click(function(e) {

            e.preventDefault();

            var requestId = $(this).data('requestid');

            showConfirmation(DataPrivacyEvents.approve, approveEventWsData(requestId));

        });

        $(ACTIONS.DENY_REQUEST).click(function(e) {

            e.preventDefault();

            var requestId = $(this).data('requestid');

            showConfirmation(DataPrivacyEvents.deny, denyEventWsData(requestId));

        });

        $(ACTIONS.MARK_COMPLETE).click(function(e) {

            e.preventDefault();

            var requestId = $(this).data('requestid');

            showConfirmation(DataPrivacyEvents.complete, completeEventWsData(requestId));

        });

        $(ACTIONS.CONFIRM_BULK_ACTION).click(function() {

            var requestIds = [];

            var actionEvent = '';

            var wsdata = {};

            var bulkActionKeys = [

                {

                    key: 'selectbulkaction',

                    component: 'tool_dataprivacy'

                },

                {

                    key: 'selectdatarequests',

                    component: 'tool_dataprivacy'

                },

                {

                    key: 'ok'

                }

            ];

            var bulkaction = parseInt($('#bulk-action').val());

            if (bulkaction != BULK_ACTIONS.APPROVE && bulkaction != BULK_ACTIONS.DENY) {

                Str.get_strings(bulkActionKeys).done(function(langStrings) {

                    Notification.alert('', langStrings[0], langStrings[2]);

                }).fail(Notification.exception);

                return;

            }

            $(".selectrequests:checked").each(function() {

                requestIds.push($(this).val());

            });

            if (requestIds.length < 1) {

                Str.get_strings(bulkActionKeys).done(function(langStrings) {

                    Notification.alert('', langStrings[1], langStrings[2]);

                }).fail(Notification.exception);

                return;

            }

            switch (bulkaction) {

                case BULK_ACTIONS.APPROVE:

                    actionEvent = DataPrivacyEvents.bulkApprove;

                    wsdata = bulkApproveEventWsData(requestIds);

                    break;

                case BULK_ACTIONS.DENY:

                    actionEvent = DataPrivacyEvents.bulkDeny;

                    wsdata = bulkDenyEventWsData(requestIds);

            }

            showConfirmation(actionEvent, wsdata);

        });

        $(ACTIONS.SELECT_ALL).change(function(e) {

            e.preventDefault();

            var selectAll = $(this).is(':checked');

            $(SELECTORS.SELECT_REQUEST).prop('checked', selectAll);

        });

    };

    /**

     * Return the webservice data for the approve request action.

     *

     * @param {Number} requestId The ID of the request.

     * @return {Object}

     */

    function approveEventWsData(requestId) {

        return {

            'wsfunction': 'tool_dataprivacy_approve_data_request',

            'wsparams': {'requestid': requestId}

        };

    }

    /**

     * Return the webservice data for the bulk approve request action.

     *

     * @param {Array} requestIds The array of request ID's.

     * @return {Object}

     */

    function bulkApproveEventWsData(requestIds) {

        return {

            'wsfunction': 'tool_dataprivacy_bulk_approve_data_requests',

            'wsparams': {'requestids': requestIds}

        };

    }

    /**

     * Return the webservice data for the deny request action.

     *

     * @param {Number} requestId The ID of the request.

     * @return {Object}

     */

    function denyEventWsData(requestId) {

        return {

            'wsfunction': 'tool_dataprivacy_deny_data_request',

            'wsparams': {'requestid': requestId}

        };

    }

    /**

     * Return the webservice data for the bulk deny request action.

     *

     * @param {Array} requestIds The array of request ID's.

     * @return {Object}

     */

    function bulkDenyEventWsData(requestIds) {

        return {

            'wsfunction': 'tool_dataprivacy_bulk_deny_data_requests',

            'wsparams': {'requestids': requestIds}

        };

    }

    /**

     * Return the webservice data for the complete request action.

     *

     * @param {Number} requestId The ID of the request.

     * @return {Object}

     */

    function completeEventWsData(requestId) {

        return {

            'wsfunction': 'tool_dataprivacy_mark_complete',

            'wsparams': {'requestid': requestId}

        };

    }

    /**

     * Show the confirmation dialogue.

     *

     * @param {String} action The action name.

     * @param {Object} wsdata Object containing ws data.

     */

    function showConfirmation(action, wsdata) {

        var keys = [];

        switch (action) {

            case DataPrivacyEvents.approve:

                keys = [

                    {

                        key: 'approverequest',

                        component: 'tool_dataprivacy'

                    },

                    {

                        key: 'confirmapproval',

                        component: 'tool_dataprivacy'

                    }

                ];

                break;

            case DataPrivacyEvents.bulkApprove:

                keys = [

                    {

                        key: 'bulkapproverequests',

                        component: 'tool_dataprivacy'

                    },

                    {

                        key: 'confirmbulkapproval',

                        component: 'tool_dataprivacy'

                    }

                ];

                break;

            case DataPrivacyEvents.deny:

                keys = [

                    {

                        key: 'denyrequest',

                        component: 'tool_dataprivacy'

                    },

                    {

                        key: 'confirmdenial',

                        component: 'tool_dataprivacy'

                    }

                ];

                break;

            case DataPrivacyEvents.bulkDeny:

                keys = [

                    {

                        key: 'bulkdenyrequests',

                        component: 'tool_dataprivacy'

                    },

                    {

                        key: 'confirmbulkdenial',

                        component: 'tool_dataprivacy'

                    }

                ];

                break;

            case DataPrivacyEvents.complete:

                keys = [

                    {

                        key: 'markcomplete',

                        component: 'tool_dataprivacy'

                    },

                    {

                        key: 'confirmcompletion',

                        component: 'tool_dataprivacy'

                    }

                ];

                break;

        }

        var modalTitle = '';

        Str.get_strings(keys).then(function(langStrings) {

            modalTitle = langStrings[0];

            var confirmMessage = langStrings[1];

            return ModalSaveCancel.create({

                title: modalTitle,

                body: confirmMessage,

            });

        }).then(function(modal) {

            modal.setSaveButtonText(modalTitle);

            // Handle save event.

            modal.getRoot().on(ModalEvents.save, function() {

                handleSave(wsdata.wsfunction, wsdata.wsparams);

            });

            // Handle hidden event.

            modal.getRoot().on(ModalEvents.hidden, function() {

                // Destroy when hidden.

                modal.destroy();

            });

            modal.show();

            return;

        }).catch(Notification.exception);

    }

    /**

     * Calls a web service function and reloads the page on success and shows a notification.

     * Displays an error notification, otherwise.

     *

     * @param {String} wsfunction The web service function to call.

     * @param {Object} params The parameters for the web service functoon.

     */

    function handleSave(wsfunction, params) {

        // Confirm the request.

        var request = {

            methodname: wsfunction,

            args: params

        };

        Ajax.call([request])[0].done(function(data) {

            if (data.result) {

                // On success, reload the page so that the data request table will be updated.

                // TODO: Probably in the future, better to reload the table or the target data request via AJAX.

                window.location.reload();

            } else {

                // Add the notification.

                Notification.addNotification({

                    message: data.warnings[0].message,

                    type: 'error'

                });

            }

        }).fail(Notification.exception);

    }

    return RequestActions;

});