yii.js 11 KB
Newer Older
Qiang Xue committed
1 2 3 4 5 6 7 8 9
/**
 * Yii JavaScript module.
 *
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
Qiang Xue committed
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34

/**
 * yii is the root module for all Yii JavaScript modules.
 * It implements a mechanism of organizing JavaScript code in modules through the function "yii.initModule()".
 *
 * Each module should be named as "x.y.z", where "x" stands for the root module (for the Yii core code, this is "yii").
 *
 * A module may be structured as follows:
 *
 * ~~~
 * yii.sample = (function($) {
 *     var pub = {
 *         // whether this module is currently active. If false, init() will not be called for this module
 *         // it will also not be called for all its child modules. If this property is undefined, it means true.
 *         isActive: true,
 *         init: function() {
 *             // ... module initialization code go here ...
 *         },
 *
 *         // ... other public functions and properties go here ...
 *     };
 *
 *     // ... private functions and properties go here ...
 *
 *     return pub;
Qiang Xue committed
35
 * })(jQuery);
Qiang Xue committed
36 37 38 39
 * ~~~
 *
 * Using this structure, you can define public and private functions/properties for a module.
 * Private functions/properties are only visible within the module, while public functions/properties
40
 * may be accessed outside of the module. For example, you can access "yii.sample.isActive".
Qiang Xue committed
41 42 43
 *
 * You must call "yii.initModule()" once for the root module of all your modules.
 */
Qiang Xue committed
44
yii = (function ($) {
Qiang Xue committed
45 46
    var pub = {
        /**
47
         * List of JS or CSS URLs that can be loaded multiple times via AJAX requests. Each script can be represented
Qiang Xue committed
48 49 50 51 52 53 54 55 56 57 58
         * as either an absolute URL or a relative one.
         */
        reloadableScripts: [],
        /**
         * The selector for clickable elements that need to support confirmation and form submission.
         */
        clickableSelector: 'a, button, input[type="submit"], input[type="button"], input[type="reset"], input[type="image"]',
        /**
         * The selector for changeable elements that need to support confirmation and form submission.
         */
        changeableSelector: 'select, input, textarea',
59

Qiang Xue committed
60 61 62 63 64 65
        /**
         * @return string|undefined the CSRF parameter name. Undefined is returned if CSRF validation is not enabled.
         */
        getCsrfParam: function () {
            return $('meta[name=csrf-param]').prop('content');
        },
66

Qiang Xue committed
67 68 69 70 71 72
        /**
         * @return string|undefined the CSRF token. Undefined is returned if CSRF validation is not enabled.
         */
        getCsrfToken: function () {
            return $('meta[name=csrf-token]').prop('content');
        },
73

74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95
        /**
         * Sets the CSRF token in the meta elements.
         * This method is provided so that you can update the CSRF token with the latest one you obtain from the server.
         * @param name the CSRF token name
         * @param value the CSRF token value
         */
        setCsrfToken: function (name, value) {
            $('meta[name=csrf-param]').prop('content', name);
            $('meta[name=csrf-token]').prop('content', value)
        },

        /**
         * Updates all form CSRF input fields with the latest CSRF token.
         * This method is provided to avoid cached forms containing outdated CSRF tokens.
         */
        refreshCsrfToken: function () {
            var token = pub.getCsrfToken();
            if (token) {
                $('form input[name="' + pub.getCsrfParam() + '"]').val(token);
            }
        },

Qiang Xue committed
96 97 98 99 100
        /**
         * Displays a confirmation dialog.
         * The default implementation simply displays a js confirmation dialog.
         * You may override this by setting `yii.confirm`.
         * @param message the confirmation message.
101 102
         * @param ok a callback to be called when the user confirms the message
         * @param cancel a callback to be called when the user cancels the confirmation
Qiang Xue committed
103
         */
104 105 106 107 108 109
        confirm: function (message, ok, cancel) {
            if (confirm(message)) {
                !ok || ok();
            } else {
                !cancel || cancel();
            }
Qiang Xue committed
110
        },
111

Qiang Xue committed
112 113 114 115 116 117 118 119 120
        /**
         * Handles the action triggered by user.
         * This method recognizes the `data-method` attribute of the element. If the attribute exists,
         * the method will submit the form containing this element. If there is no containing form, a form
         * will be created and submitted using the method given by this attribute value (e.g. "post", "put").
         * For hyperlinks, the form action will take the value of the "href" attribute of the link.
         * For other elements, either the containing form action or the current page URL will be used
         * as the form action URL.
         *
Qiang Xue committed
121 122
         * If the `data-method` attribute is not defined, the `href` attribute (if any) of the element
         * will be assigned to `window.location`.
Qiang Xue committed
123 124 125 126
         *
         * @param $e the jQuery representation of the element
         */
        handleAction: function ($e) {
Qiang Xue committed
127 128 129 130
            var method = $e.data('method'),
                $form = $e.closest('form'),
                action = $e.attr('href');

Qiang Xue committed
131
            if (method === undefined) {
Qiang Xue committed
132 133
                if (action && action != '#') {
                    window.location = action;
134
                } else if ($e.is(':submit') && $form.length) {
135
                    $form.trigger('submit');
Qiang Xue committed
136
                }
137
                return;
Qiang Xue committed
138
            }
139

140
            var newForm = !$form.length || action && action != '#';
Qiang Xue committed
141 142 143 144
            if (newForm) {
                if (!action || !action.match(/(^\/|:\/\/)/)) {
                    action = window.location.href;
                }
145 146
                $form = $('<form method="' + method + '"></form>');
                $form.prop('action', action);
Qiang Xue committed
147 148 149 150 151 152
                var target = $e.prop('target');
                if (target) {
                    $form.attr('target', target);
                }
                if (!method.match(/(get|post)/i)) {
                    $form.append('<input name="_method" value="' + method + '" type="hidden">');
Qiang Xue committed
153
                    method = 'POST';
Qiang Xue committed
154
                }
Qiang Xue committed
155 156 157 158 159
                if (!method.match(/(get|head|options)/i)) {
                    var csrfParam = pub.getCsrfParam();
                    if (csrfParam) {
                        $form.append('<input name="' + csrfParam + '" value="' + pub.getCsrfToken() + '" type="hidden">');
                    }
Qiang Xue committed
160 161 162
                }
                $form.hide().appendTo('body');
            }
163

Qiang Xue committed
164 165 166 167 168
            var activeFormData = $form.data('yiiActiveForm');
            if (activeFormData) {
                // remember who triggers the form submission. This is used by yii.activeForm.js
                activeFormData.submitObject = $e;
            }
169

Qiang Xue committed
170 171 172
            var oldMethod = $form.prop('method');
            $form.prop('method', method);

Qiang Xue committed
173
            $form.trigger('submit');
174

Qiang Xue committed
175 176
            $form.prop('method', oldMethod);

Qiang Xue committed
177 178 179 180
            if (newForm) {
                $form.remove();
            }
        },
181

Qiang Xue committed
182 183 184 185 186 187 188 189 190 191 192 193
        getQueryParams: function (url) {
            var pos = url.indexOf('?');
            if (pos < 0) {
                return {};
            }
            var qs = url.substring(pos + 1).split('&');
            for (var i = 0, result = {}; i < qs.length; i++) {
                qs[i] = qs[i].split('=');
                result[decodeURIComponent(qs[i][0])] = decodeURIComponent(qs[i][1]);
            }
            return result;
        },
194

Qiang Xue committed
195 196 197 198 199 200 201 202 203 204 205 206
        initModule: function (module) {
            if (module.isActive === undefined || module.isActive) {
                if ($.isFunction(module.init)) {
                    module.init();
                }
                $.each(module, function () {
                    if ($.isPlainObject(this)) {
                        pub.initModule(this);
                    }
                });
            }
        },
207

Qiang Xue committed
208 209 210 211 212 213 214
        init: function () {
            initCsrfHandler();
            initRedirectHandler();
            initScriptFilter();
            initDataMethods();
        }
    };
215

Qiang Xue committed
216 217 218 219 220 221 222 223 224
    function initRedirectHandler() {
        // handle AJAX redirection
        $(document).ajaxComplete(function (event, xhr, settings) {
            var url = xhr.getResponseHeader('X-Redirect');
            if (url) {
                window.location = url;
            }
        });
    }
225

Qiang Xue committed
226 227 228 229 230 231 232
    function initCsrfHandler() {
        // automatically send CSRF token for all AJAX requests
        $.ajaxPrefilter(function (options, originalOptions, xhr) {
            if (!options.crossDomain && pub.getCsrfParam()) {
                xhr.setRequestHeader('X-CSRF-Token', pub.getCsrfToken());
            }
        });
233
        pub.refreshCsrfToken();
Qiang Xue committed
234
    }
235

Qiang Xue committed
236
    function initDataMethods() {
237
        var handler = function (event) {
Qiang Xue committed
238 239 240 241 242
            var $this = $(this),
                method = $this.data('method'),
                message = $this.data('confirm');

            if (method === undefined && message === undefined) {
243
                return true;
Qiang Xue committed
244
            }
Qiang Xue committed
245

246 247 248 249
            if (message !== undefined) {
                pub.confirm(message, function () {
                    pub.handleAction($this);
                });
Qiang Xue committed
250
            } else {
251
                pub.handleAction($this);
Qiang Xue committed
252
            }
253 254 255 256 257 258 259
            event.stopImmediatePropagation();
            return false;
        };

        // handle data-confirm and data-method for clickable and changeable elements
        $(document).on('click.yii', pub.clickableSelector, handler)
            .on('change.yii', pub.changeableSelector, handler);
Qiang Xue committed
260
    }
261

Qiang Xue committed
262 263 264 265 266
    function initScriptFilter() {
        var hostInfo = location.protocol + '//' + location.host;
        var loadedScripts = $('script[src]').map(function () {
            return this.src.charAt(0) === '/' ? hostInfo + this.src : this.src;
        }).toArray();
267

Qiang Xue committed
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
        $.ajaxPrefilter('script', function (options, originalOptions, xhr) {
            if (options.dataType == 'jsonp') {
                return;
            }
            var url = options.url.charAt(0) === '/' ? hostInfo + options.url : options.url;
            if ($.inArray(url, loadedScripts) === -1) {
                loadedScripts.push(url);
            } else {
                var found = $.inArray(url, $.map(pub.reloadableScripts, function (script) {
                    return script.charAt(0) === '/' ? hostInfo + script : script;
                })) !== -1;
                if (!found) {
                    xhr.abort();
                }
            }
        });
284 285 286 287 288 289 290 291 292 293 294 295 296 297

        $(document).ajaxComplete(function (event, xhr, settings) {
            var styleSheets = [];
            $('link[rel=stylesheet]').each(function () {
                if ($.inArray(this.href, pub.reloadableScripts) !== -1) {
                    return;
                }
                if ($.inArray(this.href, styleSheets) == -1) {
                    styleSheets.push(this.href)
                } else {
                    $(this).remove();
                }
            })
        });
Qiang Xue committed
298
    }
299

Qiang Xue committed
300
    return pub;
Qiang Xue committed
301
})(jQuery);
Qiang Xue committed
302

Qiang Xue committed
303
jQuery(document).ready(function () {
Qiang Xue committed
304
    yii.initModule(yii);
Qiang Xue committed
305
});