git.roojs.org Git - Pman.Core/blob - 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     Roo.log("creating form?");
  63
  64     var b = Roo.get(document.body);
  65     this.form = b.createChild({
  66         tag: 'form',
  67         method : cfg.method,
  68         action : cfg.url,
  69         target : this.csvFrame.id,
  70         enctype : 'multipart/form-data'
  71
  72
  73
  74     });
  75
  76     for(var i in cfg.params) {
  77
  78         var el = this.form.createChild( {
  79             ns : 'html',
  80             tag : 'input',
  81
  82             type: 'hidden',
  83             name : i,
  84             value : cfg.params[i]
  85         });
  86
  87
  88     }
  89
  90     (function() {
  91         submit = true;
  92         this.form.dom.submit();
  93         this.cleanup.defer(cfg.timeout || 30000,this);
  94     }).defer(100, this);
  95
  96
  97
  98 }
  99
 100 Roo.apply(Pman.Download.prototype, {
 101
 102     /**
 103      * @type {HTMLIframe} the iframe to download into.
 104      */
 105
 106     csvFrame : false,
 107
 108     // private
 109     form : false,
 110
 111     // private..
 112     createCsvFrame: function()
 113     {
 114
 115         if (this.csvFrame) {
 116             document.body.removeChild(this.csvFrame);
 117         }
 118
 119         var id = Roo.id();
 120         this.csvFrame = document.createElement('iframe');
 121         this.csvFrame.id = id;
 122         this.csvFrame.name = id;
 123         this.csvFrame.className = 'x-hidden';
 124         //if(Roo.isIE){
 125             this.csvFrame.src = Roo.SSL_SECURE_URL;
 126         //}
 127         document.body.appendChild(this.csvFrame);
 128
 129         if(Roo.isIE){
 130             document.frames[id].name = id;
 131         }
 132
 133     },
 134
 135     onLoad : function()
 136     {
 137        // requested++; // second request is real one..
 138        // if (requested < 2) {
 139        //     return;
 140         //} // n
 141         if (!this.submit) {
 142             return;
 143         }
 144
 145
 146         var frame = this.csvFrame;
 147         var success  = true;
 148         try {
 149             var doc = Roo.isIE ?
 150                 frame.contentWindow.document :
 151                 (frame.contentDocument || window.frames[Pman.Download.csvFrame.id].document);
 152
 153
 154             if(doc && doc.body && doc.body.innerHTML.length){
 155               //  alert(doc.body.innerHTML);
 156
 157                 Roo.MessageBox.alert("Download Error", doc.body.innerHTML);
 158                 success  = false;
 159
 160
 161             }
 162
 163             Roo.log(doc.body.innerHTML);
 164
 165         }
 166         catch(e) {
 167             Roo.log(e.toString());
 168             Roo.log(e);
 169         }
 170
 171         this.cleanup();
 172
 173         // this will never fire.. see
 174         // 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
 175         if (this.success && success) {
 176
 177             this.success();
 178         }
 179
 180
 181
 182     },
 183
 184     // private - clean up download elements.
 185     cleanup :function()
 186     {
 187         if (this.form) {
 188             this.form.remove();
 189             this.form= false;
 190
 191         }
 192
 193         if (this.csvFrame) {
 194             Roo.EventManager.removeListener(this.csvFrame, 'load', this.onLoad, this);
 195             Roo.get(this.csvFrame).remove();
 196             this.csvFrame= false;
 197         }
 198
 199     }
 200
 201
 202 });