/* copyright 2003-2010 LOGILAB S.A. (Paris, FRANCE), all rights reserved.

 * contact http://www.logilab.fr/ -- mailto:contact@logilab.fr

 *

 * This file is part of CubicWeb.

 *

 * CubicWeb is free software: you can redistribute it and/or modify it under the

 * terms of the GNU Lesser General Public License as published by the Free

 * Software Foundation, either version 2.1 of the License, or (at your option)

 * any later version.

 *

 * CubicWeb 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 Lesser General Public License for more

 * details.

 *

 * You should have received a copy of the GNU Lesser General Public License along

 * with CubicWeb.  If not, see <http://www.gnu.org/licenses/>.

//============= utility function handling remote calls responses. ==============//

            if (jQuery.inArray(this.getAttribute(srcattr), loaded) == -1) {

/**

 * .. function:: function loadAjaxHtmlHead(response)

 *

    if (response.childNodes.length == 1 && response.getAttribute('cubicweb:type') == 'cwResponseWrapper') {

function _postAjaxLoad(node) {

        setFormsTarget(node);

    _loadDynamicFragments(node);

    jQuery(node).trigger('server-response', [true, node]);

}

function remoteCallFailed(err, req) {

    cw.log(err);

    if (req.status == 500) {

        updateMessage(err);

    } else {

        updateMessage(_("an error occured while processing your request"));

    }

//============= base AJAX functions to make remote calls =====================//

/**

 * .. function:: ajaxFuncArgs(fname, form, *args)

 * extend `form` parameters to call the js_`fname` function of the json

 * controller with `args` arguments.

 */

function ajaxFuncArgs(fname, form /* ... */) {

    form = form || {};

    $.extend(form, {

        'fname': fname,

        'pageid': pageid,

        'arg': map(jQuery.toJSON, sliceList(arguments, 2))

    });

    return form;

}

/**

 * .. function:: loadxhtml(url, form, reqtype='get', mode='replace', cursor=true)

 * build url given by absolute or relative `url` and `form` parameters

 * (dictionary), fetch it using `reqtype` method, then evaluate the

 * returned XHTML and insert it according to `mode` in the

 * document. Possible modes are :

 *

 *

 * If `cursor`, turn mouse cursor into 'progress' cursor until the remote call

 * is back.

jQuery.fn.loadxhtml = function(url, form, reqtype, mode, cursor) {

    if (this.size() > 1) {

        cw.log('loadxhtml was called with more than one element');

    var callback = null;

    if (form && form.callback) {

        cw.log('[3.9] callback given through form.callback is deprecated, add ' + 'callback on the defered');

        callback = form.callback;

        delete form.callback;

    if (cursor) {

        setProgressCursor();

    var d = loadRemote(url, form, reqtype);

    d.addCallback(function(response) {

        domnode = loadAjaxHtmlHead(domnode);

        mode = mode || 'replace';

        // make sure the component is visible

        $(node).removeClass("hidden");

        _postAjaxLoad(node);

    if (cursor) {

        d.addCallback(resetCursor);

        d.addErrback(resetCursor);

        d.addErrback(remoteCallFailed);

    }

    return d;

}

/**

 * .. function:: loadRemote(url, form, reqtype='GET', async=true)

 *

 * Asynchronously (unless `async` argument is set to false) load an url or path

 * and return a deferred whose callbacks args are decoded according to the

 * Content-Type response header. `form` should be additional form params

 * dictionary, `reqtype` the HTTP request type (get 'GET' or 'POST').

 */

function loadRemote(url, form, reqtype, sync) {

    if (!url.startswith(baseuri())) {

        url = baseuri() + url;

    }

    if (!sync) {

        var deferred = new Deferred();

        jQuery.ajax({

            url: url,

            type: (reqtype || 'GET').toUpperCase(),

            data: form,

            async: true,

            beforeSend: function(xhr) {

                deferred._req = xhr;

            },

            success: function(data, status) {

                if (deferred._req.getResponseHeader("content-type") == 'application/json') {

                    data = cw.evalJSON(data);

                }

                deferred.success(data);

            },

            error: function(xhr, status, error) {

                try {

                    if (xhr.status == 500) {

                        var reason_dict = cw.evalJSON(xhr.responseText);

                        deferred.error(xhr, status, reason_dict['reason']);

                        return;

                    }

                } catch(exc) {

                    cw.log('error with server side error report:' + exc);

                }

                deferred.error(xhr, status, null);

            }

        });

        return deferred;

    } else {

        var result = jQuery.ajax({

            url: url,

            type: (reqtype || 'GET').toUpperCase(),

            data: form,

            async: false

        });

        if (result) {

            // XXX no good reason to force json here, 

            // it should depends on request content-type

            result = cw.evalJSON(result.responseText);

        }

        return result

    }

}

//============= higher level AJAX functions using remote calls ===============//

/**

 * .. function:: _(message)

 *

 * emulation of gettext's _ shortcut

 */

function _(message) {

    return loadRemote('json', ajaxFuncArgs('i18n', null, [message]), 'GET', true)[0];

}

/**

 * .. function:: _loadDynamicFragments(node)

 *

 * finds each dynamic fragment in the page and executes the

function _loadDynamicFragments(node) {

    for (var i = 0; i < fragments.length; i++) {

        var $fragment = jQuery(fragment);

        var url = $fragment.attr('cubicweb:loadurl');

            $fragment.loadxhtml(url);

        var rql = $fragment.attr('cubicweb:rql');

        var items = $fragment.attr('cubicweb:vid').split('&');

            cw.log("[3.5] you're using extraargs in cubicweb:vid " +

                   "attribute, this is deprecated, consider using " +

                   "loadurl instead");

            for (var j = 1; j < items.length; j++) {

        var actrql = $fragment.attr('cubicweb:actualrql');

        if (actrql) {

            extraparams['actualrql'] = actrql;

        }

        var fbvid = $fragment.attr('cubicweb:fallbackvid');

        if (fbvid) {

            extraparams['fallbackvid'] = fbvid;

        }

        extraparams['rql'] = rql;

        extraparams['vid'] = vid;

        $(fragment.id).loadxhtml('json', ajaxFuncArgs('view', extraparams));

jQuery(document).ready(function() {

    _loadDynamicFragments();

});

    loadRemote('json', ajaxFuncArgs('unload_page_data'), 'GET', true);

}

function removeBookmark(beid) {

    var d = loadRemote('json', ajaxFuncArgs('delete_bookmark', null, beid));

    d.addCallback(function(boxcontent) {

        $('#bookmarks_box').loadxhtml('json',

                                      ajaxFuncArgs('render', null, 'boxes',

                                                   'bookmarks_box'));

        document.location.hash = '#header';

        updateMessage(_("bookmark has been removed"));

    });

}

function userCallback(cbname) {

    setProgressCursor();

    var d = loadRemote('json', ajaxFuncArgs('user_callback', null, cbname));

    d.addCallback(resetCursor);

    d.addErrback(resetCursor);

    d.addErrback(remoteCallFailed);

    return d;

function userCallbackThenUpdateUI(cbname, compid, rql, msg, registry, nodeid) {