git.roojs.org Git - app.Builder.js/blob - File.js

   1 // <script type ="text/Javascript">
   2 GLib = imports.gi.GLib;
   3 Gio = imports.gi.Gio;
   4
   5 imports['String.js'].load(String);
   6
   7 /**
   8 * @namespace File
   9 *
  10 * Library to wrap GLib and Gio basic File related methods
  11 *
  12 * usage:
  13 *
  14 * File = import.File.File;
  15 *
  16 * var contents = File.read("/tmp/test.txt");
  17 *
  18 *
  19 *
  20 */
  21 var File = {
  22
  23     SEPARATOR : '/',
  24
  25     join : function () {
  26         var out = "";
  27         for (var i = 0; i < arguments.length; i++) {
  28             if (i == 0) {
  29               out += arguments[i].rtrim(File.SEPARATOR);
  30             }
  31             else if (i == arguments.length - 1) {
  32               out += File.SEPARATOR + arguments[i].ltrim(File.SEPARATOR);
  33             }
  34             else {
  35               out += File.SEPARATOR + arguments[i].trim(File.SEPARATOR);
  36             }
  37         }
  38         return out;
  39     },
  40
  41     read : function (path) {
  42         var out = {};
  43         GLib.file_get_contents(path, out, null, null);
  44         return out['value'];
  45     },
  46
  47     isFile : function (path) {
  48       return GLib.file_test(path, GLib.FileTest.IS_REGULAR);
  49     },
  50     exists : function (path) {
  51       return GLib.file_test(path, GLib.FileTest.EXISTS);
  52     },
  53     isDirectory : function (path) {
  54       return GLib.file_test(path, GLib.FileTest.IS_DIR);
  55     },
  56
  57     list : function (path) {
  58         var listing = [];
  59
  60         var f = Gio.file_new_for_path(String(path));
  61         var file_enum = f.enumerate_children(Gio.FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME, Gio.FileQueryInfoFlags.NONE, null);
  62
  63         var next_file = null;
  64
  65         while ((next_file = file_enum.next_file(null)) != null) {
  66           listing.push(next_file.get_display_name());
  67         }
  68
  69         file_enum.close(null);
  70
  71         listing.sort();
  72
  73         return listing;
  74     },
  75
  76     mtime : function (path) {
  77         var f = Gio.file_new_for_path(String(path));
  78         var mtime = new GLib.TimeVal();
  79
  80         var info = f.query_info(Gio.FILE_ATTRIBUTE_TIME_MODIFIED, Gio.FileQueryInfoFlags.NONE, null);
  81         info.get_modification_time(mtime);
  82
  83         return new Date(mtime.tv_sec * 1000);
  84     },
  85
  86     /**
  87      * resolve the real path
  88      * @arg path {String} Path to resolve
  89      * @returns {String} the resolved path path.
  90      *
  91      */
  92     realpath :  function (path) {
  93         return this.canonical(path);
  94     },
  95     canonical : function (path) {
  96         var f = Gio.file_new_for_path(String(path));
  97         var can = f.resolve_relative_path('');
  98         return can.get_path();
  99     },
 100     /**
 101      * write a string to a file
 102      * @arg path {String} File to write to alwasy overwrites.
 103      * @arg string {String} Contents of file.
 104      *
 105      */
 106     write : function (path, string) {
 107         var f = Gio.file_new_for_path(String(path));
 108         var data_out = new Gio.DataOutputStream({base_stream:f.replace(null, false, Gio.FileCreateFlags.NONE, null)});
 109         data_out.put_string(string, null);
 110         data_out.close(null);
 111     },
 112     /**
 113      * append
 114      * @arg path {String} File to write to
 115      * @arg string {String} string to append to file.
 116      *
 117      */
 118     append : function (path, string) {
 119         var f = Gio.file_new_for_path(String(path));
 120         var data_out = new Gio.DataOutputStream({
 121                 base_stream:f.append_to(Gio.FileCreateFlags.NONE, null)
 122         });
 123         data_out.put_string(string, null);
 124         data_out.close(null);
 125     },
 126     /**
 127      * remove
 128      * Delete a file.
 129      * @arg path {String} File to remove
 130      *
 131      *
 132      */
 133     remove : function (path)
 134     {
 135         var f = Gio.file_new_for_path(String(path));
 136         return f['delete']();
 137     },
 138     // copy files recursively from fromDir, silently ignore them if they already exist in toDir
 139     silentRecursiveCopy : function (fromDir, toDir) {
 140         var filesToCopy = File.recursiveListing(fromDir);
 141         var srcPath, destPath, src, dest;
 142
 143         for (var index in filesToCopy) {
 144           srcPath = File.join(String(fromDir), filesToCopy[index]);
 145           destPath = File.join(String(toDir), filesToCopy[index]);
 146
 147           if (File.isFile(srcPath) && !File.isFile(destPath)) {
 148             File.copyFile(srcPath, destPath);
 149           }
 150           else if (File.isDirectory(srcPath) && !File.isDirectory(destPath)) {
 151             File.mkdir(destPath);
 152           }
 153
 154         }
 155     },
 156     /**
 157      * Make a symbolic link
 158      * @arg  new_link {String} The new link
 159      * @arg  target    {String} Where it links to.
 160      */
 161     link : function (new_link, target) {
 162         var dest = Gio.file_new_for_path(String(new_link));
 163         return dest.make_symbolic_link(target, null);
 164     },
 165     /**
 166      * Make a directory
 167      * FIXME - needs perms setting..
 168      *
 169      * @arg  directory  {String} Directory to make
 170      */
 171
 172     mkdir : function (destPath) {
 173         var dest = Gio.file_new_for_path(String(destPath));
 174         return dest.make_directory(null);
 175     },
 176
 177     /**
 178      * Copy a file or (directory maybe?)
 179      * @arg  srcPath {String} source file
 180      * @arg  destPath {String} destination file
 181      * @arg  flags {Gio.FileCopyFlags} to overwrite etc...  Gio.FileCopyFlags.OVERWRITE
 182      */
 183     copy : function (srcPath, destPath, flags) {
 184         return this.copyFile(srcPath, destPath, flags);
 185     },
 186     copyFile : function (srcPath, destPath, flags) {
 187
 188         flags = typeof(flags) == 'undefined' ? Gio.FileCopyFlags.NONE : flags;
 189         var dest = Gio.file_new_for_path(String(destPath));
 190         var src = Gio.file_new_for_path(String(srcPath));
 191
 192         // a bit of a hack for the fact that Gio.File.copy arguments
 193         // can be nulled, but not according to the GIR file
 194         return src.copy(dest, flags);
 195     },
 196
 197
 198
 199
 200     recursiveListing : function (dir) {
 201
 202         function recursiveListingInternal(prefix, listing, dir) {
 203           var entries = File.list(dir);
 204           var next, fullPath;
 205
 206           for (var index in entries) {
 207             next = entries[index];
 208             fullPath = File.join(prefix, dir, next);
 209
 210             if (File.isDirectory(fullPath)) {
 211               listing.push(next);
 212               listing = listing.concat(recursiveListingInternal(next, [], fullPath));
 213             }
 214             else {
 215               if (prefix) {
 216                 next = File.join(prefix, next);
 217               }
 218               listing.push(next);
 219             }
 220           }
 221
 222           return listing;
 223         }
 224
 225         return recursiveListingInternal('', [], dir);
 226     }
 227
 228 };