mozilla-extension/content/jslib/io/fileUtils.js

   1 /*** -*- Mode: Javascript; tab-width: 2; -*-
   2
   3   The contents of this file are subject to the Mozilla Public
   4   License Version 1.1 (the "License"); you may not use this file
   5   except in compliance with the License. You may obtain a copy of
   6   the License at http://www.mozilla.org/MPL/
   7
   8   Software distributed under the License is distributed on an "AS
   9   IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
  10   implied. See the License for the specific language governing
  11   rights and limitations under the License.
  12
  13   The Original Code is Collabnet code.
  14   The Initial Developer of the Original Code is Collabnet.
  15
  16   Portions created by Collabnet are Copyright (C) 2000 Collabnet.
  17   All Rights Reserved.
  18
  19   Contributor(s): Pete Collins,
  20                   Doug Turner,
  21                   Brendan Eich,
  22                   Warren Harris,
  23                   Eric Plaster,
  24                   Martin Kutschker
  25                   Philip Lindsay
  26
  27
  28   JS FileUtils IO API (The purpose of this file is to make it a little easier to do file IO from js)
  29
  30       fileUtils.js
  31
  32   Function List
  33
  34       chromeToPath(aPath)              // Converts a chrome://bob/content uri to a path.
  35                                        // NOTE: although this gives you the
  36                                        // path to a file in the chrome directory, you will
  37                                        // most likely not have permisions
  38                                        // to create or write to files there.
  39       chromeToURL(aPath)               // Converts a chrome://bob/content file:// uri.
  40       urlToPath(aPath)                 // Converts a file:// url to a path
  41       exists(aPath);                   // check to see if a file exists
  42       append(aDirPath, aFileName);     // append is for abstracting platform specific file paths
  43       remove(aPath);                   // remove a file
  44       copy(aSource, aDest);            // copy a file from source to destination
  45       leaf(aPath);                     // leaf is the endmost file string
  46                                        //  eg: foo.html in /myDir/foo.html
  47       permissions(aPath);              // returns the files permissions
  48       dateModified(aPath);             // returns the last modified date in locale string
  49       size(aPath);                     // returns the file size
  50       ext(aPath);                      // returns a file extension if there is one
  51       parent(aPath)                    // returns the dir part of a path
  52       dirPath(aPath)                   // *Depriciated* use parent
  53       spawn(aPath, aArgs)              // spawns another program
  54       nsIFile(aPath)                   // returns an nsIFile obj
  55       help;                            // currently returns a list of available functions
  56
  57     Deprecated
  58
  59       chrome_to_path(aPath);           // synonym for chromeToPath
  60       URL_to_path(aPath)               // synonym for use urlToPath
  61       rm(aPath);                       // synonym for remove
  62       extension(aPath);                // synonym for ext
  63
  64   Instructions:
  65
  66     First include this js file
  67
  68      var file = new FileUtils();
  69
  70     Examples:
  71
  72      var path='/usr/X11R6/bin/Eterm';
  73      file.spawn(path, ['-e/usr/bin/vi']);
  74      *note* all args passed to spawn must be in the form of an array
  75
  76      // to list help
  77      dump(file.help);
  78
  79     Warning: these API's are not for religious types
  80
  81 *******************************************/
  82
  83   // Make sure jslib is loaded
  84   if (typeof(JS_LIB_LOADED)=='boolean')
  85   {
  86
  87   /****************** Globals **********************/
  88
  89   const JS_FILEUTILS_FILE                    = "fileUtils.js";
  90   const JS_FILEUTILS_LOADED                  = true;
  91
  92   const JS_FILEUTILS_LOCAL_CID               = "@mozilla.org/file/local;1";
  93   const JS_FILEUTILS_FILESPEC_PROGID         = '@mozilla.org/filespec;1';
  94   const JS_FILEUTILS_NETWORK_STD_CID         = '@mozilla.org/network/standard-url;1';
  95   const JS_FILEUTILS_SIMPLEURI_PROGID        = "@mozilla.org/network/simple-uri;1";
  96   const JS_FILEUTILS_CHROME_REG_PROGID       = '@mozilla.org/chrome/chrome-registry;1';
  97   const JS_FILEUTILS_DR_PROGID               = "@mozilla.org/file/directory_service;1";
  98   const JS_FILEUTILS_PROCESS_CID             = "@mozilla.org/process/util;1";
  99
 100   const JS_FILEUTILS_I_LOCAL_FILE            = "nsILocalFile";
 101   const JS_FILEUTILS_INIT_W_PATH             = "initWithPath";
 102   const JS_FILEUTILS_I_PROPS                 = "nsIProperties";
 103
 104   const JS_FILEUTILS_CHROME_DIR              = "AChrom";
 105
 106   const JS_FILEUTILS_OK                      = true;
 107   const JS_FILEUTILS_FilePath                = new C.Constructor(JS_FILEUTILS_LOCAL_CID,
 108                                                                  JS_FILEUTILS_I_LOCAL_FILE,
 109                                                                  JS_FILEUTILS_INIT_W_PATH);
 110
 111
 112   /****************** FileUtils Object Class *********************/
 113   function FileUtils ()
 114   {
 115     include (jslib_dirutils);
 116     this.mDirUtils = new DirUtils();
 117   } // constructor
 118
 119   FileUtils.prototype  =
 120   {
 121     mFileInst        : null,
 122     mDirUtils        : null,
 123
 124     /********************* CHROME_TO_PATH ***************************/
 125     // this is here for backward compatability but is deprecated --pete
 126     chrome_to_path : function (aPath) { return this.chromeToPath(aPath); },
 127
 128     chromeToPath : function (aPath)
 129     {
 130       if (!aPath)
 131         return jslibErrorMsg("NS_ERROR_INVALID_ARG");
 132
 133       return this.urlToPath(this.chromeToURL(aPath));
 134     },
 135
 136     chromeToURL : function (aPath)
 137     {
 138       if (!aPath)
 139         return jslibErrorMsg("NS_ERROR_INVALID_ARG");
 140
 141       var uri = jslibCreateInstance(JS_FILEUTILS_SIMPLEURI_PROGID, "nsIURI");
 142
 143       var rv = null;
 144       if (/^chrome:/.test(aPath)) {
 145         try {
 146           var cr        = jslibGetService(JS_FILEUTILS_CHROME_REG_PROGID);
 147           if (cr) {
 148             cr          = jslibQI(cr, "nsIChromeRegistry");
 149             uri.spec    = aPath;
 150             uri.spec    = cr.convertChromeURL(uri);
 151             rv          = uri.path;
 152
 153             // deal w/ jar resource files
 154             if (/.jar!/.test(rv)) {
 155               rv = rv.replace(/resource:/, "");
 156               rv =  "file://"+this.mDirUtils.getCurProcDir()+rv;
 157             }
 158           }
 159         } catch (e) {}
 160
 161         if (/^\/|\\|:chrome/.test(rv)) {
 162           try {
 163             // prepend the system path to this process dir
 164             rv = "file:///"+(''+this.mDirUtils.getCurProcDir()+rv)
 165                   .replace(/\\/g, "\/").replace(/^\s*\/?/, "").replace(/\ /g, "%20");
 166           } catch (e) {
 167             rv = jslibError(e);
 168           }
 169         }
 170       } else if (/^file:/.test(aPath)) {
 171         rv = this.urlToPath(aPath);
 172       }
 173
 174       return rv;
 175     },
 176
 177     /********************* URL_TO_PATH ***************************/
 178     URL_to_path : function (aPath) { return this.urlToPath(aPath); },
 179
 180   urlToPath : function (aPath)
 181   {
 182     if (!aPath)
 183       return jslibErrorMsg("NS_ERROR_INVALID_ARG");
 184
 185     // xpcshell doesn't have unescape func
 186     const hasUnescape = (typeof(unescape)=="function");
 187     var path = aPath;
 188     var rv;
 189
 190     if (/^file:/.test(path)) {
 191       try {
 192         var uri = jslibCreateInstance(JS_FILEUTILS_NETWORK_STD_CID, "nsIURI");
 193         uri.spec = path;
 194         rv = uri.path;
 195
 196         var file = jslibCreateInstance(JS_FILEUTILS_LOCAL_CID, "nsILocalFile");
 197
 198         // unix and friends
 199         try {
 200           file.initWithPath(rv);
 201           rv = hasUnescape ? unescape(file.path) : file.path;
 202           return rv;
 203         } catch (e) {}
 204
 205         // windows
 206         try {
 207           file.initWithPath(rv.replace(/^\//,"").replace(/\//g,"\\"));
 208           rv = hasUnescape ? unescape(file.path) : file.path;
 209           return rv;
 210         } catch (e) {}
 211
 212         // FIXME: add checking for Mac
 213
 214       } catch (e) {
 215         rv = jslibError(e);
 216       }
 217     }
 218
 219     return rv;
 220   },
 221
 222   /********************* EXISTS ***************************/
 223   exists : function (aPath)
 224   {
 225     if (!aPath)
 226       return jslibErrorMsg("NS_ERROR_INVALID_ARG");
 227
 228     var rv;
 229     try {
 230       var file = new JS_FILEUTILS_FilePath(aPath);
 231       rv = file.exists();
 232     } catch (e) {
 233       rv = jslibError(e);
 234     }
 235
 236     return rv;
 237   },
 238
 239   /********************* RM *******************************/
 240   rm : function (aPath) { return this.remove(aPath); },
 241
 242   remove : function (aPath)
 243   {
 244     if (!aPath)
 245       return jslibErrorMsg("NS_ERROR_INVALID_ARG");
 246
 247     if (!this.exists(aPath))
 248       return jslibErrorMsg("NS_ERROR_FILE_TARGET_DOES_NOT_EXIST");
 249
 250     var rv;
 251
 252     try {
 253       var fileInst = new JS_FILEUTILS_FilePath(aPath);
 254       if (fileInst.isDirectory())
 255         return jslibErrorMsg("NS_ERROR_INVALID_ARG");
 256
 257       fileInst.remove(false);
 258       rv = jslibRes.NS_OK;
 259     } catch (e) {
 260       rv = jslibError(e);
 261     }
 262
 263     return rv;
 264   },
 265
 266   /********************* COPY *****************************/
 267   copy  : function (aSource, aDest)
 268   {
 269     if (!aSource || !aDest)
 270       return jslibErrorMsg("NS_ERROR_INVALID_ARG");
 271
 272     if (!this.exists(aSource))
 273       return jslibErrorMsg("NS_ERROR_UNEXPECTED");
 274
 275     var rv;
 276
 277     try {
 278       var fileInst = new JS_FILEUTILS_FilePath(aSource);
 279       var dir      = new JS_FILEUTILS_FilePath(aDest);
 280       var copyName = fileInst.leafName;
 281
 282       if (fileInst.isDirectory())
 283         return jslibErrorMsg("NS_ERROR_FILE_COPY_OR_MOVE_FAILED");
 284
 285       if (!this.exists(aDest) || !dir.isDirectory()) {
 286         copyName   = dir.leafName;
 287         dir        = new JS_FILEUTILS_FilePath(dir.path.replace(copyName,''));
 288
 289         if (!this.exists(dir.path))
 290           return jslibErrorMsg("NS_ERROR_FILE_ALREADY_EXISTS");
 291
 292         if (!dir.isDirectory())
 293           return jslibErrorMsg("NS_ERROR_FILE_INVALID_PATH");
 294       }
 295
 296       if (this.exists(this.append(dir.path, copyName)))
 297         return jslibError("NS_ERROR_FILE_ALREADY_EXISTS");
 298
 299       rv = fileInst.copyTo(dir, copyName);
 300       rv = jslibRes.NS_OK;
 301     } catch (e) {
 302       return jslibError(e);
 303     }
 304
 305     return rv;
 306   },
 307
 308   /********************* LEAF *****************************/
 309   leaf  : function (aPath)
 310   {
 311     if (!aPath)
 312       return jslibErrorMsg("NS_ERROR_INVALID_ARG");
 313
 314     if (!this.exists(aPath))
 315       jslibErrorWarn("NS_ERROR_FILE_NOT_FOUND ["+aPath+"]")
 316
 317     var rv;
 318
 319     try {
 320       var fileInst = new JS_FILEUTILS_FilePath(aPath);
 321       rv=fileInst.leafName;
 322     }
 323
 324     catch (e) {
 325       return jslibError(e);
 326     }
 327
 328     return rv;
 329   },
 330
 331   /********************* APPEND ***************************/
 332   append : function (aDirPath, aFileName)
 333   {
 334     if (!aDirPath || !aFileName)
 335       jslibErrorMsg("NS_ERROR_INVALID_ARG");
 336
 337     if (!this.exists(aDirPath))
 338       return jslibErrorMsg("NS_ERROR_FILE_NOT_FOUND");
 339
 340     var rv;
 341
 342     try {
 343       var fileInst = new JS_FILEUTILS_FilePath(aDirPath);
 344       if (fileInst.exists() && !fileInst.isDirectory())
 345         return jslibErrorMsg("NS_ERROR_INVALID_ARG");
 346
 347       fileInst.append(aFileName);
 348       rv=fileInst.path;
 349       delete fileInst;
 350     } catch (e) {
 351       return jslibError(e);
 352     }
 353
 354     return rv;
 355   },
 356
 357   /********************* VALIDATE PERMISSIONS *************/
 358   validatePermissions : function(aNum)
 359   {
 360     if ( parseInt(aNum.toString(10).length) < 3 )
 361       return false;
 362
 363     return JS_FILEUTILS_OK;
 364   },
 365
 366   /********************* PERMISSIONS **********************/
 367   permissions : function (aPath)
 368   {
 369     if (!aPath)
 370       return jslibErrorMsg("NS_ERROR_INVALID_ARG");
 371
 372     if (!this.exists(aPath))
 373       return jslibErrorMsg("NS_ERROR_FILE_NOT_FOUND");
 374
 375     var rv;
 376
 377     try {
 378       rv=(new JS_FILEUTILS_FilePath(aPath)).permissions.toString(8);
 379     } catch (e) {
 380       rv = jslibError(e);
 381     }
 382
 383     return rv;
 384   },
 385
 386   /********************* MODIFIED *************************/
 387   dateModified  : function (aPath)
 388   {
 389     if (!aPath)
 390       return jslibErrorMsg("NS_ERROR_INVALID_ARG");
 391
 392     if (!this.exists(aPath))
 393       jslibErrorMsg("NS_ERROR_FILE_NOT_FOUND");
 394
 395     var rv;
 396
 397     try {
 398       var date = new Date((new JS_FILEUTILS_FilePath(aPath)).lastModifiedTime).toLocaleString();
 399       rv=date;
 400     } catch (e) {
 401       rv = jslibError(e);
 402     }
 403
 404     return rv;
 405   },
 406
 407   /********************* SIZE *****************************/
 408   size  : function (aPath)
 409   {
 410     if (!aPath)
 411       return jslibErrorMsg("NS_ERROR_INVALID_ARG");
 412
 413     if (!this.exists(aPath))
 414       return jslibErrorMsg("NS_ERROR_FILE_NOT_FOUND");
 415
 416     var rv;
 417
 418     try {
 419       rv = (new JS_FILEUTILS_FilePath(aPath)).fileSize;
 420     } catch (e) {
 421       jslibError(e);
 422       rv=0;
 423     }
 424
 425     return rv;
 426   },
 427
 428   /********************* EXTENSION ************************/
 429   extension  : function (aPath) { return this.ext(aPath); },
 430
 431   ext  : function (aPath)
 432   {
 433     if (!aPath)
 434       return jslibErrorMsg("NS_ERROR_INVALID_ARG");
 435
 436     if (!this.exists(aPath))
 437       return jslibErrorMsg("NS_ERROR_FILE_NOT_FOUND");
 438
 439     var rv;
 440
 441     try {
 442       var leafName  = (new JS_FILEUTILS_FilePath(aPath)).leafName;
 443       var dotIndex  = leafName.lastIndexOf('.');
 444       rv=(dotIndex >= 0) ? leafName.substring(dotIndex+1) : "";
 445     } catch (e) {
 446       return jslibError(e);
 447     }
 448
 449     return rv;
 450   },
 451
 452   /********************* DIRPATH **************************/
 453   dirPath   : function (aPath) { return this.parent(aPath); },
 454
 455   parent   : function (aPath)
 456   {
 457     if (!aPath)
 458       return jslibErrorMsg("NS_ERROR_INVALID_ARG");
 459
 460     var rv;
 461
 462     try {
 463       var fileInst = new JS_FILEUTILS_FilePath(aPath);
 464
 465       if (!fileInst.exists())
 466         return jslibErrorMsg("NS_ERROR_FILE_NOT_FOUND");
 467
 468       if (fileInst.isFile())
 469         rv = fileInst.parent.path;
 470
 471       else if (fileInst.isDirectory())
 472         rv = fileInst.path;
 473
 474       else
 475         rv = null;
 476     }
 477
 478     catch (e) {
 479       return jslibError(e);
 480     }
 481
 482     return rv;
 483   },
 484
 485   /********************* SPAWN ****************************/
 486   spawn : function (aPath, aArgs) { this.run(aPath, aArgs); },
 487   run : function (aPath, aArgs)
 488   /*
 489    * Trys to execute the requested file as a separate *non-blocking* process.
 490    *
 491    * Passes the supplied *array* of arguments on the command line if
 492    * the OS supports it.
 493    *
 494    */
 495   {
 496     if (!aPath)
 497       return jslibErrorMsg("NS_ERROR_INVALID_ARG");
 498
 499     if (!this.exists(aPath))
 500       return jslibErrorMsg("NS_ERROR_FILE_NOT_FOUND");
 501
 502     var len = 0;
 503     if (aArgs)
 504       len = aArgs.length;
 505     else
 506       aArgs = null;
 507
 508     var rv;
 509     try {
 510       var fileInst = new JS_FILEUTILS_FilePath(aPath);
 511
 512       if (!fileInst.isExecutable())
 513         return jslibErrorMsg("NS_ERROR_INVALID_ARG");
 514
 515       if (fileInst.isDirectory())
 516         return jslibErrorMsg("NS_ERROR_FILE_IS_DIRECTORY");
 517         // Create and execute the process...
 518         /*
 519          * NOTE: The first argument of the process instance's 'run' method
 520          *       below specifies the blocking state (false = non-blocking).
 521          *       The last argument, in theory, contains the process ID (PID)
 522          *       on return if a variable is supplied--not sure how to implement
 523          *       this with JavaScript though.
 524          */
 525         try {
 526           var theProcess = jslibCreateInstance(JS_FILEUTILS_PROCESS_CID, "nsIProcess");
 527
 528           theProcess.init(fileInst);
 529
 530           rv = theProcess.run(false, aArgs, len);
 531           jslib_debug("rv="+rv);
 532         } catch (e) {
 533           rv = jslibError(e);
 534         }
 535     } catch (e) {
 536       rv = jslibError(e);
 537     }
 538
 539     return rv;
 540   },
 541
 542   /********************* nsIFILE **************************/
 543   nsIFile : function (aPath)
 544   {
 545     if (!aPath)
 546       return jslibErrorMsg("NS_ERROR_INVALID_ARG");
 547
 548     var rv;
 549     try {
 550       rv = new JS_FILEUTILS_FilePath(aPath);
 551     } catch (e) {
 552       rv = jslibError(e);
 553     }
 554
 555     return rv;
 556   },
 557
 558   /********************* HELP *****************************/
 559   get help()
 560   {
 561     var help =
 562
 563       "\n\nFunction List:\n"                  +
 564       "\n"                                    +
 565       "   exists(aPath);\n"                   +
 566       "   chromeToPath(aPath);\n"             +
 567       "   chromeToURL(aPath);\n"              +
 568       "   urlToPath(aPath);\n"                +
 569       "   append(aDirPath, aFileName);\n"     +
 570       "   remove(aPath);\n"                   +
 571       "   copy(aSource, aDest);\n"            +
 572       "   leaf(aPath);\n"                     +
 573       "   permissions(aPath);\n"              +
 574       "   dateModified(aPath);\n"             +
 575       "   size(aPath);\n"                     +
 576       "   ext(aPath);\n"                      +
 577       "   parent(aPath);\n"                   +
 578       "   run(aPath, aArgs);\n"               +
 579       "   nsIFile(aPath);\n"                  +
 580       "   help;\n";
 581
 582     return help;
 583   }
 584
 585 };
 586
 587 jslibDebug('*** load: '+JS_FILEUTILS_FILE+' OK');
 588
 589 } // END BLOCK JS_LIB_LOADED CHECK
 590
 591 // If jslib base library is not loaded, dump this error.
 592 else
 593 {
 594     dump("JS_FILE library not loaded:\n"                                +
 595          " \tTo load use: chrome://jslib/content/jslib.js\n"            +
 596          " \tThen: include(jslib_fileutils);\n\n");
 597 }
 598