Roo/form/Action.js
[roojs1] / Roo / form / Action.js
1 /*
2  * Based on:
3  * Ext JS Library 1.1.1
4  * Copyright(c) 2006-2007, Ext JS, LLC.
5  *
6  * Originally Released Under LGPL - original licence link has changed is not relivant.
7  *
8  * Fork - LGPL
9  * <script type="text/javascript">
10  */
11  
12  /**
13  * @class Roo.form.Action
14  * Internal Class used to handle form actions
15  * @constructor
16  * @param {Roo.form.BasicForm} el The form element or its id
17  * @param {Object} config Configuration options
18  */
19  
20  
21 // define the action interface
22 Roo.form.Action = function(form, options){
23     this.form = form;
24     this.options = options || {};
25 };
26 /**
27  * Client Validation Failed
28  * @const 
29  */
30 Roo.form.Action.CLIENT_INVALID = 'client';
31 /**
32  * Server Validation Failed
33  * @const 
34  */
35  Roo.form.Action.SERVER_INVALID = 'server';
36  /**
37  * Connect to Server Failed
38  * @const 
39  */
40 Roo.form.Action.CONNECT_FAILURE = 'connect';
41 /**
42  * Reading Data from Server Failed
43  * @const 
44  */
45 Roo.form.Action.LOAD_FAILURE = 'load';
46
47 Roo.form.Action.prototype = {
48     type : 'default',
49     failureType : undefined,
50     response : undefined,
51     result : undefined,
52
53     // interface method
54     run : function(options){
55
56     },
57
58     // interface method
59     success : function(response){
60
61     },
62
63     // interface method
64     handleResponse : function(response){
65
66     },
67
68     // default connection failure
69     failure : function(response){
70         this.response = response;
71         this.failureType = Roo.form.Action.CONNECT_FAILURE;
72         this.form.afterAction(this, false);
73     },
74
75     processResponse : function(response){
76         this.response = response;
77         if(!response.responseText){
78             return true;
79         }
80         this.result = this.handleResponse(response);
81         return this.result;
82     },
83
84     // utility functions used internally
85     getUrl : function(appendParams){
86         var url = this.options.url || this.form.url || this.form.el.dom.action;
87         if(appendParams){
88             var p = this.getParams();
89             if(p){
90                 url += (url.indexOf('?') != -1 ? '&' : '?') + p;
91             }
92         }
93         return url;
94     },
95
96     getMethod : function(){
97         return (this.options.method || this.form.method || this.form.el.dom.method || 'POST').toUpperCase();
98     },
99
100     getParams : function(){
101         var bp = this.form.baseParams;
102         var p = this.options.params;
103         if(p){
104             if(typeof p == "object"){
105                 p = Roo.urlEncode(Roo.applyIf(p, bp));
106             }else if(typeof p == 'string' && bp){
107                 p += '&' + Roo.urlEncode(bp);
108             }
109         }else if(bp){
110             p = Roo.urlEncode(bp);
111         }
112         return p;
113     },
114
115     createCallback : function(){
116         return {
117             success: this.success,
118             failure: this.failure,
119             scope: this,
120             timeout: (this.form.timeout*1000),
121             upload: this.form.fileUpload ? this.success : undefined
122         };
123     }
124 };
125
126 Roo.form.Action.Submit = function(form, options){
127     Roo.form.Action.Submit.superclass.constructor.call(this, form, options);
128 };
129
130 Roo.extend(Roo.form.Action.Submit, Roo.form.Action, {
131     type : 'submit',
132
133     run : function()
134     {
135         // run get Values on the form, so it syncs any secondary forms.
136         this.form.getValues();
137         
138         var o = this.options;
139         var method = this.getMethod();
140         var isPost = method == 'POST';
141         if(o.clientValidation === false || this.form.isValid()){
142             Roo.Ajax.request(Roo.apply(this.createCallback(), {
143                 form:this.form.el.dom,
144                 url:this.getUrl(!isPost),
145                 method: method,
146                 params:isPost ? this.getParams() : null,
147                 isUpload: this.form.fileUpload
148             }));
149
150         }else if (o.clientValidation !== false){ // client validation failed
151             this.failureType = Roo.form.Action.CLIENT_INVALID;
152             this.form.afterAction(this, false);
153         }
154     },
155
156     success : function(response){
157         var result = this.processResponse(response);
158         if(result === true || result.success){
159             this.form.afterAction(this, true);
160             return;
161         }
162         if(result.errors){
163             this.form.markInvalid(result.errors);
164             this.failureType = Roo.form.Action.SERVER_INVALID;
165         }
166         this.form.afterAction(this, false);
167     },
168
169     handleResponse : function(response){
170         if(this.form.errorReader){
171             var rs = this.form.errorReader.read(response);
172             var errors = [];
173             if(rs.records){
174                 for(var i = 0, len = rs.records.length; i < len; i++) {
175                     var r = rs.records[i];
176                     errors[i] = r.data;
177                 }
178             }
179             if(errors.length < 1){
180                 errors = null;
181             }
182             return {
183                 success : rs.success,
184                 errors : errors
185             };
186         }
187         var ret = false;
188         try {
189             ret = Roo.decode(response.responseText);
190         } catch (e) {
191             ret = {
192                 success: false,
193                 errorMsg: "Failed to read server message: " + (response ? response.responseText : ' - no message'),
194                 errors : []
195             };
196         }
197         return ret;
198         
199     }
200 });
201
202
203 Roo.form.Action.Load = function(form, options){
204     Roo.form.Action.Load.superclass.constructor.call(this, form, options);
205     this.reader = this.form.reader;
206 };
207
208 Roo.extend(Roo.form.Action.Load, Roo.form.Action, {
209     type : 'load',
210
211     run : function(){
212         Roo.Ajax.request(Roo.apply(
213                 this.createCallback(), {
214                     method:this.getMethod(),
215                     url:this.getUrl(false),
216                     params:this.getParams()
217         }));
218     },
219
220     success : function(response){
221         var result = this.processResponse(response);
222         if(result === true || !result.success || !result.data){
223             this.failureType = Roo.form.Action.LOAD_FAILURE;
224             this.form.afterAction(this, false);
225             return;
226         }
227         this.form.clearInvalid();
228         this.form.setValues(result.data);
229         this.form.afterAction(this, true);
230     },
231
232     handleResponse : function(response){
233         if(this.form.reader){
234             var rs = this.form.reader.read(response);
235             var data = rs.records && rs.records[0] ? rs.records[0].data : null;
236             return {
237                 success : rs.success,
238                 data : data
239             };
240         }
241         return Roo.decode(response.responseText);
242     }
243 });
244
245 Roo.form.Action.ACTION_TYPES = {
246     'load' : Roo.form.Action.Load,
247     'submit' : Roo.form.Action.Submit
248 };