Pman.Download.js
[Pman.Core] / Pman.Download.js
1 //<script type="text/javascript">
2 /**
3 * @class Pman.Download
4 * Handles file downloads in a hidden frame, or new window.
5 * Usage:
6 <pre><code>
7 var t = new Pman.Download({
8     url: baseURL + '/Images/Download/0/myfile.jpg',
9     newWindow : false,
10     params: { .... },
11     success : function() {
12         Roo.MessageBox.alert("File has downloaded");
13     }
14 });
15
16 </code></pre>
17
18 * @constructor
19 * @param {Object} cfg   Configuration object.
20 * @cfg {String} url     Location to download from.
21 * @cfg {String} method     GET or POST (default GET), POST will create a form, and post that into the hidden frame.
22 * @cfg {Boolean} newWindow (optional) download to new window
23 * @cfg {Function} success (optional) MAY fire on download completed (fails on attachments)..
24 * @cfg {Number} timeout (optional) in milliseconds before it gives up (default 30000 = 30s)
25 */
26
27 Pman.Download = function(cfg)
28 {
29  
30     
31     
32     if (cfg.newWindow) {
33             // as ie seems buggy...
34         window.open( cfg.url + '?' + Roo.urlEncode(cfg.params || {}), '_blank');
35         return ; 
36         
37     }
38     Roo.apply(this, cfg);
39     
40     var submit = false;
41     this.createCsvFrame();
42     
43     var requested = 0;
44      
45     Roo.EventManager.on( this.csvFrame, 'load', this.onLoad, this);
46     
47     
48     //--- simple method..
49     cfg.method = cfg.method || 'GET';
50     
51     if (cfg.method == 'GET' && !cfg.params) {
52         (function() {
53             submit = true;
54             this.csvFrame.src = cfg.url;
55             this.cleanup.defer(cfg.timeout || 30000,this);
56         }).defer(100, this);
57         
58        
59         return;
60     }
61     
62     
63     Roo.log("creating form?");
64     
65     var b = Roo.get(document.body);
66     this.form = b.createChild({
67         tag: 'form',
68         method : cfg.method,
69         action : cfg.url,
70         target : this.csvFrame.id,
71         enctype : 'multipart/form-data'
72
73
74         
75     });
76  
77     for(var i in cfg.params) {
78         
79         var el = this.form.createChild( {
80             ns : 'html',
81             tag : 'input',
82             
83             type: 'hidden',
84             name : i,
85             value : cfg.params[i]
86         });
87         
88         
89     }
90     
91     (function() {
92         submit = true;
93         this.form.dom.submit();
94         this.cleanup.defer(cfg.timeout || 30000,this);
95     }).defer(100, this);
96     
97      
98  
99 }
100
101 Roo.apply(Pman.Download.prototype, {
102     
103     /**
104      * @type {HTMLIframe} the iframe to download into.
105      */
106      
107     csvFrame : false,
108     
109     // private
110     form : false,
111     
112     // private..
113     createCsvFrame: function()
114     {
115         
116         if (this.csvFrame) {
117             document.body.removeChild(this.csvFrame);
118         }
119             
120         var id = Roo.id();
121         this.csvFrame = document.createElement('iframe');
122         this.csvFrame.id = id;
123         this.csvFrame.name = id;
124         this.csvFrame.className = 'x-hidden';
125         //if(Roo.isIE){
126             this.csvFrame.src = Roo.SSL_SECURE_URL;
127         //}
128         document.body.appendChild(this.csvFrame);
129
130         if(Roo.isIE){
131             document.frames[id].name = id;
132         }
133         
134     },
135     
136     onLoad : function()
137     {
138        // requested++; // second request is real one..
139        // if (requested < 2) {
140        //     return;
141         //} // n
142         if (!this.submit) {
143             return;
144         }
145         
146       
147         var frame = this.csvFrame;
148         var success  = true; 
149         try { 
150             var doc = Roo.isIE ? 
151                 frame.contentWindow.document : 
152                 (frame.contentDocument || window.frames[Pman.Download.csvFrame.id].document);
153             
154             
155             if(doc && doc.body && doc.body.innerHTML.length){
156               //  alert(doc.body.innerHTML);
157                   
158                 Roo.MessageBox.alert("Download Error", doc.body.innerHTML);
159                 success  = false;
160                  
161                 
162             }
163             
164             Roo.log(doc.body.innerHTML);
165              
166         }
167         catch(e) {
168             Roo.log(e.toString());
169             Roo.log(e);
170         }
171         
172         this.cleanup();
173         
174         // this will never fire.. see 
175         // http://www.atalasoft.com/cs/blogs/jake/archive/2009/08/18/events-to-expect-when-dynamically-loading-iframes-in-javascript-take-2-thanks-firefox-3-5.aspx
176         if (this.success && success) {
177             
178             this.success();
179         }
180        
181         
182
183     },
184     
185     // private - clean up download elements.
186     cleanup :function()
187     {
188         if (this.form) {
189             this.form.remove();
190             this.form= false;
191         
192         }
193         
194         if (this.csvFrame) {
195             Roo.EventManager.removeListener(this.csvFrame, 'load', this.onLoad, this);
196             Roo.get(this.csvFrame).remove();
197             this.csvFrame= false;
198         }
199          
200     }
201      
202      
203 });