tao-test/app/tao/views/js/controller/backoffice.js

/**
 * This program 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; under version 2
 * of the License (non-upgradable).
 *
 * This program 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 this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 * Copyright (c) 2014 (original work) Open Assessment Technologies SA (under the project TAO-PRODUCT);
 */

/**
 * @author Bertrand Chevrier <bertrand@taotesting.com>
 */
define([
    'jquery',
    'lodash',
    'i18n',
    'context',
    'helpers',
    'core/router',
    'uikitLoader',
    'core/history',
    'ui/feedback',
    'layout/logout-event'
], function ($, _, __, context, helpers, router, uikitLoader, history, feedback, logoutEvent) {
    'use strict';

    function hasAjaxResponse(ajaxResponse) {
        return ajaxResponse && ajaxResponse !== null;
    }

    function hasAjaxResponseProperties(ajaxResponse) {
        return typeof ajaxResponse.success !== 'undefined' &&
            typeof ajaxResponse.type !== 'undefined' &&
            typeof ajaxResponse.message !== 'undefined' &&
            typeof ajaxResponse.data !== 'undefined'
    }

    /**
     * The backoffice controller.
     * Starts the ajax based router, the automated error reporting and the UI listeners.
     */
    return {
        /**
         * Controller entry point
         */
        start: function start() {
            var $doc = $(document);
            var $container = $('body > .content-wrap');

            //fix backspace going back into the history
            history.fixBrokenBrowsers();

            //contextual loading, do a dispatch each time an ajax request loads an HTML page
            $doc.ajaxComplete(function (event, request, settings) {
                var urls;
                var forward;
                if (_.contains(settings.dataTypes, 'html')) {
                    urls = [settings.url];
                    forward = request.getResponseHeader('X-Tao-Forward');
                    if (forward) {
                        urls.push(forward);
                    }

                    router.dispatch(urls, function () {
                        uikitLoader.startDomComponent($container);
                    });
                }
            });

            //dispatch also the current page (or the forward)
            router.dispatchUrl(helpers._url(context.action, context.module, context.extension));

            //intercept errors
            //TODO this should belongs to the Router
            $doc.ajaxError(function (event, request, settings, thrownError) {
                var ajaxResponse;
                var errorMessage = __('Unknown Error');

                // Request was manually aborted, isn't a error
                if (thrownError === 'abort') return;

                try {
                    ajaxResponse = $.parseJSON(request.responseText);
                } catch (err) {
                    errorMessage = `${request.status}: ${request.responseText}`;
                }

                // Specific error tooManyFolders in sharedStimulus
                if (ajaxResponse && ajaxResponse.code === 999) { return; }

                if ((request.status === 404 || request.status === 0) && settings.type === 'HEAD') {
                    //consider it as a "test" to check if resource exists
                    return;
                } else if (request.status === 404 || request.status === 500) {
                    if (hasAjaxResponse() && hasAjaxResponseProperties()) {
                        errorMessage = `${request.status}: ${ajaxResponse.message}`;
                    } else {
                        errorMessage = `${request.status}: ${request.responseText}`;
                    }
                }

                if (request.status === 403) {
                    logoutEvent();
                } else {
                    feedback().error(errorMessage);
                }
            });

            //initialize new components
            uikitLoader.startEventComponents($container);
        }
    };
});