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     doctype: 'pdf'
  12     success : function() {
  13         Roo.MessageBox.alert("File has downloaded");
  14     }
  15 });
  16
  17 </code></pre>
  18 *
  19 * @constructor
  20 * @param {Object} cfg   Configuration object.
  21 * @cfg {String} url     Location to download from.
  22 * @cfg {String} method     GET or POST (default GET), POST will create a form, and post that into the hidden frame.
  23 * @cfg {Boolean} newWindow (optional) download to new window
  24 * @cfg {String} doctype (optional) download PDF to new window
  25 * @cfg {Boolean} limit (optional) limit for grid downloads.
  26
  27  * @cfg {String} csvCols  - use '*' to override grid coluns
  28  * @cfg {String} csvTitles - use '*' to override grid coluns
  29  * @cfg {String} hiddenCols - default 'show'  (use 'hide' to not display them on download)
  30
  31
  32 * @cfg {Function} success (optional) MAY fire on download completed (fails on attachments)..
  33 * @cfg {Number} timeout (optional) in milliseconds before it gives up (default 30000 = 30s)
  34 * @cfg {Roo.grid.Grid} grid (optional) if you want to just download a grid, (without renderers..)
  35 *
  36 */
  37
  38 Pman.Download = function(cfg)
  39 {
  40
  41
  42
  43     this.params = {};
  44
  45     Roo.apply(this, cfg);
  46
  47     if (this.grid) {
  48
  49         this.buildFromGrid();
  50         Roo.log(this);
  51     }
  52
  53
  54     if (this.newWindow && this.method == 'GET') {
  55         // as ie seems buggy...
  56         window.open( this.url + '?' + Roo.urlEncode(this.params || {}), '_blank');
  57         return ;
  58
  59     }
  60
  61
  62
  63     //this.submit = false;
  64     //this.createCsvFrame();
  65
  66     //var requested = 0;
  67
  68     //Roo.EventManager.on( this.csvFrame, 'load', this.onLoad, this);
  69
  70
  71     //--- simple method..
  72     this.method = this.method || 'GET';
  73
  74     if (this.method == 'GET' && !this.params) {
  75         (function() {
  76
  77
  78             this.createCsvFrame();
  79             //Roo.EventManager.on( this.csvFrame, 'load', this.onLoad, this);
  80             this.submit = true;
  81             this.csvFrame.src = cfg.url;
  82             //this.cleanup.defer(cfg.timeout || 30000,this);
  83         }).defer(100, this);
  84
  85
  86         return;
  87     }
  88
  89
  90     Roo.log("creating form?");
  91
  92     this.form = new FormData();
  93     /*
  94     var b = Roo.get(document.body);
  95     this.form = b.createChild({
  96         tag: 'form',
  97         method : this.method,
  98         action : this.url,
  99         target : this.newWindow ? '_new' : this.csvFrame.id,
 100         enctype : 'multipart/form-data'
 101     });
 102     **/
 103 //
 104 //    if(this.doctype == 'pdf'){
 105 //        this.pdfEmbed = b.createChild({
 106 //            tag: 'embed',
 107 //            src : this.url,
 108 //            pluginspage : 'http://www.adobe.com/products/acrobat/readstep2.html',
 109 //            alt: this.doctype
 110 //        });
 111 //    }
 112
 113     //Roo.log(this.params);
 114     this.params._get = 1; // always do a post request, with _get passed
 115     for(var i in this.params) {
 116         this.form.append(i, this.params[i]);
 117         /*
 118         var el = this.form.createChild( {
 119             ns : 'html',
 120             tag : 'input',
 121
 122             type: 'hidden',
 123             name : i,
 124             value : this.params[i]
 125         });
 126         */
 127
 128
 129     }
 130     var req = new XMLHttpRequest();
 131     req.responseType = 'blob';
 132
 133     req.open('POST', this.url);
 134
 135     var _t = this;
 136     req.onload = function( ev )
 137     {
 138         if (req.status == 200) {
 139             Roo.log(ev);
 140             var cd = req.getResponseHeader('Content-Disposition');
 141
 142             var filename = '';
 143             var matches = /filename[^;=\n]*=((['"]).*?\2|[^;\n]*)/.exec(cd);
 144             if (matches != null && matches[1]) {
 145                 filename = matches[1].replace(/['"]/g, '');
 146             }
 147
 148             var blob = new Blob([req.response], {type: req.responseType });
 149
 150             var a = document.createElement("a");
 151             a.style = "display: none";
 152             document.body.appendChild(a);
 153             var url = window.URL.createObjectURL(blob);
 154             a.href = url;
 155             a.download = filename;
 156              a.click();
 157             //release the reference to the file by revoking the Object URL
 158             window.URL.revokeObjectURL(url);
 159
 160             _t.success ? _t.success(ev) : '';
 161         } else {
 162             _t.failure ? _t.failure(ev) : '';
 163         }
 164
 165     }
 166     Roo.MessageBox.alert("Downloading", "The file should download shortly");
 167     req.send(this.form);
 168     /*
 169     (function() {
 170         this.submit = true;
 171         this.form.dom.submit();
 172         this.cleanup.defer(this.timeout || 30000,this);
 173     }).defer(100, this);
 174     */
 175
 176
 177 }
 178
 179 Roo.apply(Pman.Download.prototype, {
 180
 181     /**
 182      * @type {HTMLIframe} the iframe to download into.
 183      */
 184
 185     csvFrame : false,
 186
 187     // private
 188     form : false,
 189
 190     limit : 9999,
 191
 192     newWindow : false,
 193
 194     method : 'GET',
 195
 196     success : false,
 197     failure : false,
 198
 199     hiddenCols : 'show', // set to 'hide' to hide them..
 200
 201
 202     // private..
 203     //used by simple GET method.
 204     createCsvFrame: function()
 205     {
 206         if (this.csvFrame) {
 207             document.body.removeChild(this.csvFrame);
 208         }
 209
 210         var id = Roo.id();
 211         this.csvFrame = document.createElement('iframe');
 212         this.csvFrame.id = id;
 213         this.csvFrame.name = id;
 214         this.csvFrame.className = 'x-hidden';
 215         //if(Roo.isIE){
 216             this.csvFrame.src = Roo.SSL_SECURE_URL;
 217         //}
 218         document.body.appendChild(this.csvFrame);
 219
 220         if(Roo.isIE){
 221             document.frames[id].name = id;
 222         }
 223
 224     },
 225     /* not used as it didn't work..
 226     onLoad : function()
 227     {
 228        // requested++; // second request is real one..
 229        // if (requested < 2) {
 230        //     return;
 231         //} // n
 232         Roo.log('onload?');
 233         if (!this.submit) {
 234             return false;
 235         }
 236         //return false;
 237
 238         var frame = this.csvFrame;
 239         var success  = true;
 240         try {
 241             var doc = Roo.isIE ?
 242                 frame.contentWindow.document :
 243                 (frame.contentDocument || window.frames[Pman.Download.csvFrame.id].document);
 244
 245
 246             if(doc && doc.body && doc.body.innerHTML.length){
 247               //  alert(doc.body.innerHTML);
 248
 249                 Roo.MessageBox.alert("Download Error", doc.body.innerHTML);
 250                 success  = false;
 251                 if (this.failure) {
 252                     this.failure();
 253                 }
 254                 return true;
 255             }
 256
 257             Roo.log(doc.body.innerHTML);
 258
 259         }
 260         catch(e) {
 261             Roo.log(e.toString());
 262             Roo.log(e);
 263         }
 264         if (this.success) {
 265             this.success();
 266         }
 267         // we can not actually do anything with the frame... as it may actually still be downloading..
 268         return true;
 269
 270         this.cleanup();
 271
 272         // this will never fire.. see
 273         // 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
 274         if (this.success && success) {
 275
 276             this.success();
 277         }
 278         return false;
 279
 280
 281     },
 282      */
 283     // private - clean up download elements.
 284     cleanup :function()
 285     {
 286        /* Roo.log('cleanup?');
 287         if (this.form) {
 288             this.form.remove();
 289             this.form= false;
 290
 291         }
 292
 293         if (this.csvFrame) {
 294             Roo.EventManager.removeListener(this.csvFrame, 'load', this.onLoad, this);
 295             Roo.get(this.csvFrame).remove();
 296             this.csvFrame= false;
 297         }
 298         */
 299
 300     },
 301
 302     buildFromGrid : function()
 303     {
 304         // get the params from beforeLoad
 305         var ds = this.grid.ds;
 306         ds.fireEvent('beforeload', ds, {
 307             params : this.params
 308
 309         });
 310
 311          if(ds.sortInfo && ds.remoteSort){
 312             var pn = ds.paramNames;
 313             this.params[pn["sort"]] = ds.sortInfo.field;
 314             this.params[pn["dir"]] = ds.sortInfo.direction;
 315         }
 316         if (ds.multiSort) {
 317             var pn = ds.paramNames;
 318             this.params[pn["multisort"]] = Roo.encode( { sort : ds.sortToggle, order: ds.sortOrder });
 319         }
 320
 321
 322
 323         this.url = this.grid.ds.proxy.conn.url;
 324         this.method = this.method || this.grid.ds.proxy.conn.method ;
 325         var t = this;
 326         // work out the cols
 327
 328         if (this.csvCols) {
 329             t.params.csvCols = this.csvCols;
 330             t.params.csvTitles = this.csvTitles;
 331         } else {
 332
 333             Roo.each(this.grid.cm.config, function(c,i) {
 334
 335                 if (t.hiddenCols != 'show' && t.grid.cm.isHidden(i)) {
 336                     return;
 337                 }
 338
 339                 t.params['csvCols['+i+']'] = c.dataIndex;
 340                 t.params['csvTitles['+i+']'] = c.header;
 341
 342             });
 343         }
 344         if (this.grid.loadMask) {
 345             this.grid.loadMask.onLoad();
 346         }
 347         this.params.limit = this.limit;
 348
 349         // do it as a post, as args can get long..
 350
 351         this.method =   'POST';
 352         if (this.method  == 'POST') {
 353             this.params._get = 1;
 354         }
 355     }
 356
 357 });