/*

 * jQuery form plugin

 * @requires jQuery v1.0.3

 *

 * Dual licensed under the MIT and GPL licenses:

 *   http://www.opensource.org/licenses/mit-license.php

 *   http://www.gnu.org/licenses/gpl.html

 *

 * Revision: $Id$

 * Version: 0.9

 */



/**

 * ajaxSubmit() provides a mechanism for submitting an HTML form using AJAX.

 *

 * ajaxSubmit accepts a single argument which can be either a success callback function

 * or an options Object.  If a function is provided it will be invoked upon successful

 * completion of the submit and will be passed the response from the server.

 * If an options Object is provided, the following attributes are supported:

 *

 *  target:   Identifies the element(s) in the page to be updated with the server response.

 *            This value may be specified as a jQuery selection string, a jQuery object,

 *            or a DOM element.

 *            default value: null

 *

 *  url:      URL to which the form data will be submitted.

 *            default value: value of form's 'action' attribute

 *

 *  method:   @deprecated use 'type'

 *  type:     The method in which the form data should be submitted, 'GET' or 'POST'.

 *            default value: value of form's 'method' attribute (or 'GET' if none found)

 *

 *  before:   @deprecated use 'beforeSubmit'

 *  beforeSubmit:  Callback method to be invoked before the form is submitted.

 *            default value: null

 *

 *  after:    @deprecated use 'success'

 *  success:  Callback method to be invoked after the form has been successfully submitted

 *            and the response has been returned from the server

 *            default value: null

 *

 *  dataType: Expected dataType of the response.  One of: null, 'xml', 'script', or 'json'

 *            default value: null

 *

 *  semantic: Boolean flag indicating whether data must be submitted in semantic order (slower).

 *            default value: false

 *

 *  resetForm: Boolean flag indicating whether the form should be reset if the submit is successful

 *

 *  clearForm: Boolean flag indicating whether the form should be cleared if the submit is successful

 *

 *

 * The 'beforeSubmit' callback can be provided as a hook for running pre-submit logic or for

 * validating the form data.  If the 'beforeSubmit' callback returns false then the form will

 * not be submitted. The 'beforeSubmit' callback is invoked with three arguments: the form data

 * in array format, the jQuery object, and the options object passed into ajaxSubmit.

 * The form data array takes the following form:

 *

 *     [ { name: 'username', value: 'jresig' }, { name: 'password', value: 'secret' } ]

 *

 * If a 'success' callback method is provided it is invoked after the response has been returned

 * from the server.  It is passed the responseText or responseXML value (depending on dataType).

 * See jQuery.ajax for further details.

 *

 *

 * The dataType option provides a means for specifying how the server response should be handled.

 * This maps directly to the jQuery.httpData method.  The following values are supported:

 *

 *      'xml':    if dataType == 'xml' the server response is treated as XML and the 'after'

 *                   callback method, if specified, will be passed the responseXML value

 *      'json':   if dataType == 'json' the server response will be evaluted and passed to

 *                   the 'after' callback, if specified

 *      'script': if dataType == 'script' the server response is evaluated in the global context

 *

 *

 * Note that it does not make sense to use both the 'target' and 'dataType' options.  If both

 * are provided the target will be ignored.

 *

 * The semantic argument can be used to force form serialization in semantic order.

 * This is normally true anyway, unless the form contains input elements of type='image'.

 * If your form must be submitted with name/value pairs in semantic order and your form

 * contains an input of type='image" then pass true for this arg, otherwise pass false

 * (or nothing) to avoid the overhead for this logic.

 *

 *

 * When used on its own, ajaxSubmit() is typically bound to a form's submit event like this:

 *

 * $("#form-id").submit(function() {

 *     $(this).ajaxSubmit(options);

 *     return false; // cancel conventional submit

 * });

 *

 * When using ajaxForm(), however, this is done for you.

 *

 * @example

 * $('#myForm').ajaxSubmit(function(data) {

 *     alert('Form submit succeeded! Server returned: ' + data);

 * });

 * @desc Submit form and alert server response

 *

 *

 * @example

 * var options = {

 *     target: '#myTargetDiv'

 * };

 * $('#myForm').ajaxSubmit(options);

 * @desc Submit form and update page element with server response

 *

 *

 * @example

 * var options = {

 *     success: function(responseText) {

 *         alert(responseText);

 *     }

 * };

 * $('#myForm').ajaxSubmit(options);

 * @desc Submit form and alert the server response

 *

 *

 * @example

 * var options = {

 *     beforeSubmit: function(formArray, jqForm) {

 *         if (formArray.length == 0) {

 *             alert('Please enter data.');

 *             return false;

 *         }

 *     }

 * };

 * $('#myForm').ajaxSubmit(options);

 * @desc Pre-submit validation which aborts the submit operation if form data is empty

 *

 *

 * @example

 * var options = {

 *     url: myJsonUrl.php,

 *     dataType: 'json',

 *     success: function(data) {

 *        // 'data' is an object representing the the evaluated json data

 *     }

 * };

 * $('#myForm').ajaxSubmit(options);

 * @desc json data returned and evaluated

 *

 *

 * @example

 * var options = {

 *     url: myXmlUrl.php,

 *     dataType: 'xml',

 *     success: function(responseXML) {

 *        // responseXML is XML document object

 *        var data = $('myElement', responseXML).text();

 *     }

 * };

 * $('#myForm').ajaxSubmit(options);

 * @desc XML data returned from server

 *

 *

 * @example

 * var options = {

 *     resetForm: true

 * };

 * $('#myForm').ajaxSubmit(options);

 * @desc submit form and reset it if successful

 *

 * @example

 * $('#myForm).submit(function() {

 *    $(this).ajaxSubmit();

 *    return false;

 * });

 * @desc Bind form's submit event to use ajaxSubmit

 *

 *

 * @name ajaxSubmit

 * @type jQuery

 * @param options  object literal containing options which control the form submission process

 * @cat Plugins/Form

 * @return jQuery

 * @see formToArray

 * @see ajaxForm

 * @see $.ajax

 * @author jQuery Community

 */

jQuery.fn.ajaxSubmit = function(options) {

    if (typeof options == 'function')

        options = { success: options };



    options = jQuery.extend({

        url:    this.attr('action') || '',

        method: this.attr('method') || 'GET'

    }, options || {});



    // remap deprecated options (temporarily)

    options.success = options.success || options.after;

    options.beforeSubmit = options.beforeSubmit || options.before;

    options.type = options.type || options.method;



    var a = this.formToArray(options.semantic);



    // give pre-submit callback an opportunity to abort the submit

    if (options.beforeSubmit && options.beforeSubmit(a, this, options) === false) return this;



    var q = jQuery.param(a);



    if (options.type.toUpperCase() == 'GET') {

        // if url already has a '?' then append args after '&'

        options.url += (options.url.indexOf('?') >= 0 ? '&' : '?') + q;

        options.data = null;  // data is null for 'get'

    }

    else

        options.data = q; // data is the query string for 'post'



    var $form = this, callbacks = [];

    if (options.resetForm) callbacks.push(function() { $form.resetForm(); });

    if (options.clearForm) callbacks.push(function() { $form.clearForm(); });



    // perform a load on the target only if dataType is not provided

    if (!options.dataType && options.target) {

        var oldSuccess = options.success || function(){};

        callbacks.push(function(data, status) {

            jQuery(options.target).attr("innerHTML", data).evalScripts().each(oldSuccess, [data, status]);

        });

    }

    else if (options.success)

        callbacks.push(options.success);



    options.success = function(data, status) {

        for (var i=0, max=callbacks.length; i < max; i++)

            callbacks[i](data, status);

    };



    jQuery.ajax(options);

    return this;

};



/**

 * ajaxForm() provides a mechanism for fully automating form submission.

 *

 * The advantages of using this method instead of ajaxSubmit() are:

 *

 * 1: This method will include coordinates for <input type="image" /> elements (if the element

 *    is used to submit the form).

 * 2. This method will include the submit element's name/value data (for the element that was

 *    used to submit the form).

 * 3. This method binds the submit() method to the form for you.

 *

 * Note that for accurate x/y coordinates of image submit elements in all browsers

 * you need to also use the "dimensions" plugin (this method will auto-detect its presence).

 *

 * The options argument for ajaxForm works exactly as it does for ajaxSubmit.  ajaxForm merely

 * passes the options argument along after properly binding events for submit elements and

 * the form itself.  See ajaxSubmit for a full description of the options argument.

 *

 *

 * @example

 * var options = {

 *     target: '#myTargetDiv'

 * };

 * $('#myForm').ajaxSForm(options);

 * @desc Bind form's submit event so that 'myTargetDiv' is updated with the server response

 *       when the form is submitted.

 *

 *

 * @example

 * var options = {

 *     success: function(responseText) {

 *         alert(responseText);

 *     }

 * };

 * $('#myForm').ajaxSubmit(options);

 * @desc Bind form's submit event so that server response is alerted after the form is submitted.

 *

 *

 * @example

 * var options = {

 *     beforeSubmit: function(formArray, jqForm) {

 *         if (formArray.length == 0) {

 *             alert('Please enter data.');

 *             return false;

 *         }

 *     }

 * };

 * $('#myForm').ajaxSubmit(options);

 * @desc Bind form's submit event so that pre-submit callback is invoked before the form

 *       is submitted.

 *

 *

 * @name   ajaxForm

 * @param  options  object literal containing options which control the form submission process

 * @return jQuery

 * @cat    Plugins/Form

 * @type   jQuery

 * @see    ajaxSubmit

 * @author jQuery Community

 */

jQuery.fn.ajaxForm = function(options) {

    return this.each(function() {

        jQuery("input:submit,input:image,button:submit", this).click(function(ev) {

            var $form = this.form;

            $form.clk = this;

            if (this.type == 'image') {

                if (ev.offsetX != undefined) {

                    $form.clk_x = ev.offsetX;

                    $form.clk_y = ev.offsetY;

                } else if (typeof jQuery.fn.offset == 'function') { // try to use dimensions plugin

                    var offset = jQuery(this).offset();

                    $form.clk_x = ev.pageX - offset.left;

                    $form.clk_y = ev.pageY - offset.top;

                } else {

                    $form.clk_x = ev.pageX - this.offsetLeft;

                    $form.clk_y = ev.pageY - this.offsetTop;

                }

            }

            // clear form vars

            setTimeout(function() {

                $form.clk = $form.clk_x = $form.clk_y = null;

                }, 10);

        })

    }).submit(function(e) {

        jQuery(this).ajaxSubmit(options);

        return false;

    });

};





/**

 * formToArray() gathers form element data into an array of objects that can

 * be passed to any of the following ajax functions: $.get, $.post, or load.

 * Each object in the array has both a 'name' and 'value' property.  An example of

 * an array for a simple login form might be:

 *

 * [ { name: 'username', value: 'jresig' }, { name: 'password', value: 'secret' } ]

 *

 * It is this array that is passed to pre-submit callback functions provided to the

 * ajaxSubmit() and ajaxForm() methods.

 *

 * The semantic argument can be used to force form serialization in semantic order.

 * This is normally true anyway, unless the form contains input elements of type='image'.

 * If your form must be submitted with name/value pairs in semantic order and your form

 * contains an input of type='image" then pass true for this arg, otherwise pass false

 * (or nothing) to avoid the overhead for this logic.

 *

 * @example var data = $("#myForm").formToArray();

 * $.post( "myscript.cgi", data );

 * @desc Collect all the data from a form and submit it to the server.

 *

 * @name formToArray

 * @param semantic true if serialization must maintain strict semantic ordering of elements (slower)

 * @type Array<Object>

 * @cat Plugins/Form

 * @see ajaxForm

 * @see ajaxSubmit

 * @author jQuery Community

 */

jQuery.fn.formToArray = function(semantic) {

    var a = [];

    if (this.length == 0) return a;



    var form = this[0];

    var els = semantic ? form.getElementsByTagName('*') : form.elements;

    if (!els) return a;

    for(var i=0, max=els.length; i < max; i++) {

        var el = els[i];

        var n = el.name;

        if (!n) continue;



        if (semantic && form.clk && el.type == "image") {

            // handle image inputs on the fly when semantic == true

            if(!el.disabled && form.clk == el)

                a.push({name: n+'.x', value: form.clk_x}, {name: n+'.y', value: form.clk_y});

            continue;

        }

        var v = jQuery.fieldValue(el, true);

        if (v === null) continue;

        if (v.constructor == Array) {

            for(var j=0, jmax=v.length; j < jmax; j++)

                a.push({name: n, value: v[j]});

        }

        else

            a.push({name: n, value: v});

    }



    if (!semantic && form.clk) {

        // input type=='image' are not found in elements array! handle them here

        var inputs = form.getElementsByTagName("input");

        for(var i=0, max=inputs.length; i < max; i++) {

            var input = inputs[i];

            var n = input.name;

            if(n && !input.disabled && input.type == "image" && form.clk == input)

                a.push({name: n+'.x', value: form.clk_x}, {name: n+'.y', value: form.clk_y});

        }

    }

    return a;

};





/**

 * Serializes form data into a 'submittable' string. This method will return a string

 * in the format: name1=value1&amp;name2=value2

 *

 * The semantic argument can be used to force form serialization in semantic order.

 * If your form must be submitted with name/value pairs in semantic order then pass

 * true for this arg, otherwise pass false (or nothing) to avoid the overhead for

 * this logic (which can be significant for very large forms).

 *

 * @example var data = $("#myForm").formSerialize();

 * $.ajax('POST', "myscript.cgi", data);

 * @desc Collect all the data from a form into a single string

 *

 * @name formSerialize

 * @param semantic true if serialization must maintain strict semantic ordering of elements (slower)

 * @type String

 * @cat Plugins/Form

 * @see formToArray

 * @author jQuery Community

 */

jQuery.fn.formSerialize = function(semantic) {

    //hand off to jQuery.param for proper encoding

    return jQuery.param(this.formToArray(semantic));

};





/**

 * Serializes all field elements in the jQuery object into a query string.

 * This method will return a string in the format: name1=value1&amp;name2=value2

 *

 * The successful argument controls whether or not serialization is limited to

 * 'successful' controls (per http://www.w3.org/TR/html4/interact/forms.html#successful-controls).

 * The default value of the successful argument is true.

 *

 * @example var data = $("input").formSerialize();

 * @desc Collect the data from all successful input elements into a query string

 *

 * @example var data = $(":radio").formSerialize();

 * @desc Collect the data from all successful radio input elements into a query string

 *

 * @example var data = $("#myForm :checkbox").formSerialize();

 * @desc Collect the data from all successful checkbox input elements in myForm into a query string

 *

 * @example var data = $("#myForm :checkbox").formSerialize(false);

 * @desc Collect the data from all checkbox elements in myForm (even the unchecked ones) into a query string

 *

 * @example var data = $(":input").formSerialize();

 * @desc Collect the data from all successful input, select, textarea and button elements into a query string

 *

 * @name fieldSerialize

 * @param successful true if only successful controls should be serialized (default is true)

 * @type String

 * @cat Plugins/Form

 */

jQuery.fn.fieldSerialize = function(successful) {

    var a = [];

    this.each(function() {

        var n = this.name;

        if (!n) return;

        var v = jQuery.fieldValue(this, successful);

        if (v && v.constructor == Array) {

            for (var i=0,max=v.length; i < max; i++)

                a.push({name: n, value: v[i]});

        }

        else if (v !== null && typeof v != 'undefined')

            a.push({name: this.name, value: v});

    });

    //hand off to jQuery.param for proper encoding

    return jQuery.param(a);

};





/**

 * Returns the value of the field element in the jQuery object.  If there is more than one field element

 * in the jQuery object the value of the first successful one is returned.

 *

 * The successful argument controls whether or not the field element must be 'successful'

 * (per http://www.w3.org/TR/html4/interact/forms.html#successful-controls).

 * The default value of the successful argument is true.  If this value is false then

 * the value of the first field element in the jQuery object is returned.

 *

 * Note: If no valid value can be determined the return value will be undifined.

 *

 * Note: The fieldValue returned for a select-multiple element or for a checkbox input will

 *       always be an array if it is not undefined.

 *

 *

 * @example var data = $("#myPasswordElement").formValue();

 * @desc Gets the current value of the myPasswordElement element

 *

 * @example var data = $("#myForm :input").formValue();

 * @desc Get the value of the first successful control in the jQuery object.

 *

 * @example var data = $("#myForm :checkbox").formValue();

 * @desc Get the array of values for the first set of successful checkbox controls in the jQuery object.

 *

 * @example var data = $("#mySingleSelect").formValue();

 * @desc Get the value of the select control

 *

 * @example var data = $("#myMultiSelect").formValue();

 * @desc Get the array of selected values for the select-multiple control

 *

 * @name fieldValue

 * @param Boolean successful true if value returned must be for a successful controls (default is true)

 * @type String or Array<String>

 * @cat Plugins/Form

 */

jQuery.fn.fieldValue = function(successful) {

    var cbVal, cbName;



    // loop until we find a value

    for (var i=0, max=this.length; i < max; i++) {

        var el = this[i];

        var v = jQuery.fieldValue(el, successful);

        if (v === null || typeof v == 'undefined' || (v.constructor == Array && !v.length))

            continue;



        // for checkboxes, consider multiple elements, for everything else just return first valid value

        if (el.type != 'checkbox') return v;



        cbName = cbName || el.name;

        if (cbName != el.name) // return if we hit a checkbox with a different name

            return cbVal;

        cbVal = cbVal || [];

        cbVal.push(v);

    }

    return cbVal;

};



/**

 * Returns the value of the field element.

 *

 * The successful argument controls whether or not the field element must be 'successful'

 * (per http://www.w3.org/TR/html4/interact/forms.html#successful-controls).

 * The default value of the successful argument is true.  If the given element is not

 * successful and the successful arg is not false then the returned value will be null.

 *

 * Note: The fieldValue returned for a select-multiple element will always be an array.

 *

 * @example var data = jQuery.fieldValue($("#myPasswordElement")[0]);

 * @desc Gets the current value of the myPasswordElement element

 *

 * @name fieldValue

 * @param Element el The DOM element for which the value will be returned

 * @param Boolean successful true if value returned must be for a successful controls (default is true)

 * @type String or Array<String>

 * @cat Plugins/Form

 */

jQuery.fieldValue = function(el, successful) {

    var n = el.name, t = el.type, tag = el.tagName.toLowerCase();

    if (typeof successful == 'undefined') successful = true;



    if (successful && ( !n || el.disabled || t == 'reset' ||

        (t == 'checkbox' || t == 'radio') && !el.checked ||

        (t == 'submit' || t == 'image') && el.form && el.form.clk != el ||

        tag == 'select' && el.selectedIndex == -1))

            return null;



    if (tag == 'select') {

        var index = el.selectedIndex;

        if (index < 0) return null;

        var a = [], ops = el.options;

        var one = (t == 'select-one');

        var max = (one ? index+1 : ops.length);

        for(var i=(one ? index : 0); i < max; i++) {

            var op = ops[i];

            if (op.selected) {

                // extra pain for IE...

                var v = jQuery.browser.msie && !(op.attributes['value'].specified) ? op.text : op.value;

                if (one) return v;

                a.push(v);

            }

        }

        return a;

    }

    return el.value;

};





/**

 * Clears the form data.  Takes the following actions on the form's input fields:

 *  - input text fields will have their 'value' property set to the empty string

 *  - select elements will have their 'selectedIndex' property set to -1

 *  - checkbox and radio inputs will have their 'checked' property set to false

 *  - inputs of type submit, button, reset, and hidden will *not* be effected

 *  - button elements will *not* be effected

 *

 * @example $('form').clearForm();

 * @desc Clears all forms on the page.

 *

 * @name clearForm

 * @type jQuery

 * @cat Plugins/Form

 * @see resetForm

 */

jQuery.fn.clearForm = function() {

    return this.each(function() {

        jQuery('input,select,textarea', this).clearFields();

    });

};



/**

 * Clears the selected form elements.  Takes the following actions on the matched elements:

 *  - input text fields will have their 'value' property set to the empty string

 *  - select elements will have their 'selectedIndex' property set to -1

 *  - checkbox and radio inputs will have their 'checked' property set to false

 *  - inputs of type submit, button, reset, and hidden will *not* be effected

 *  - button elements will *not* be effected

 *

 * @example $('.myInputs').clearFields();

 * @desc Clears all inputs with class myInputs

 *

 * @name clearFields

 * @type jQuery

 * @cat Plugins/Form

 * @see clearForm

 */

jQuery.fn.clearFields = jQuery.fn.clearInputs = function() {

    return this.each(function() {

        var t = this.type, tag = this.tagName.toLowerCase();

        if (t == 'text' || t == 'password' || tag == 'textarea')

            this.value = '';

        else if (t == 'checkbox' || t == 'radio')

            this.checked = false;

        else if (tag == 'select')

            this.selectedIndex = -1;

    });

};





/**

 * Resets the form data.  Causes all form elements to be reset to their original value.

 *

 * @example $('form').resetForm();

 * @desc Resets all forms on the page.

 *

 * @name resetForm

 * @type jQuery

 * @cat Plugins/Form

 * @see clearForm

 */

jQuery.fn.resetForm = function() {

    return this.each(function() {

        // guard against an input with the name of 'reset'

        // note that IE reports the reset function as an 'object'

        if (typeof this.reset == 'function' || (typeof this.reset == 'object' && !this.reset.nodeType))

            this.reset();

    });

};