git.roojs.org Git - gnome.introspection-doc-generator/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     canonical : function (path) {
  87         var f = Gio.file_new_for_path(String(path));
  88         var can = f.resolve_relative_path('');
  89         return can.get_path();
  90     },
  91     /**
  92      * write
  93      * @arg path {String} File to write to
  94      * @arg string {String} Contents of file.
  95      *
  96      */
  97     write : function (path, string) {
  98         var f = Gio.file_new_for_path(String(path));
  99         var data_out = new Gio.DataOutputStream({base_stream:f.replace(null, false, Gio.FileCreateFlags.NONE, null)});
 100         data_out.put_string(string, null);
 101         data_out.close(null);
 102     },
 103     /**
 104      * append
 105      * @arg path {String} File to write to
 106      * @arg string {String} string to append to file.
 107      *
 108      */
 109     append : function (path, string) {
 110         var f = Gio.file_new_for_path(String(path));
 111         var data_out = new Gio.DataOutputStream({
 112                 base_stream:f.append_to(Gio.FileCreateFlags.NONE, null)
 113         });
 114         data_out.put_string(string, null);
 115         data_out.close(null);
 116     },
 117     /**
 118      * remove
 119      * Delete a file.
 120      * @arg path {String} File to remove
 121      *
 122      *
 123      */
 124     remove : function (path)
 125     {
 126         var f = Gio.file_new_for_path(String(path));
 127         return f.delete();
 128     },
 129     // copy files recursively from fromDir, silently ignore them if they already exist in toDir
 130     silentRecursiveCopy : function (fromDir, toDir) {
 131         var filesToCopy = File.recursiveListing(fromDir);
 132         var srcPath, destPath, src, dest;
 133
 134         for (var index in filesToCopy) {
 135           srcPath = File.join(String(fromDir), filesToCopy[index]);
 136           destPath = File.join(String(toDir), filesToCopy[index]);
 137
 138           if (File.isFile(srcPath) && !File.isFile(destPath)) {
 139             File.copyFile(srcPath, destPath);
 140           }
 141           else if (File.isDirectory(srcPath) && !File.isDirectory(destPath)) {
 142             File.mkdir(destPath);
 143           }
 144
 145         }
 146     },
 147
 148     mkdir : function (destPath) {
 149         var dest = Gio.file_new_for_path(String(destPath));
 150         return dest.make_directory(null, null);
 151     },
 152
 153     copyFile : function (srcPath, destPath) {
 154         var dest = Gio.file_new_for_path(String(destPath));
 155         var src = Gio.file_new_for_path(String(srcPath));
 156
 157         // a bit of a hack for the fact that Gio.File.copy arguments
 158         // can be nulled, but not according to the GIR file
 159         return src.copy(dest, Gio.FileCopyFlags.NONE);
 160     },
 161
 162     recursiveListing : function (dir) {
 163
 164         function recursiveListingInternal(prefix, listing, dir) {
 165           var entries = File.list(dir);
 166           var next, fullPath;
 167
 168           for (var index in entries) {
 169             next = entries[index];
 170             fullPath = File.join(prefix, dir, next);
 171
 172             if (File.isDirectory(fullPath)) {
 173               listing.push(next);
 174               listing = listing.concat(recursiveListingInternal(next, [], fullPath));
 175             }
 176             else {
 177               if (prefix) {
 178                 next = File.join(prefix, next);
 179               }
 180               listing.push(next);
 181             }
 182           }
 183
 184           return listing;
 185         }
 186
 187         return recursiveListingInternal('', [], dir);
 188     }
 189
 190 };