vibe.core.file 0/180(0%) line coverage

      
10
20
30
40
50
60
70
80
90
100
110
120
130
140
150
160
170
180
190
200
210
220
230
240
250
260
270
280
290
300
310
320
330
340
350
360
370
380
390
400
410
420
430
440
450
460
470
480
490
500
510
520
530
540
550
560
570
580
590
600
610
620
630
640
650
660
670
680
690
700
710
720
730
740
750
760
770
780
790
800
810
820
830
840
850
860
870
880
890
900
910
920
930
940
950
960
970
980
990
1000
1010
1020
1030
1040
1050
1060
1070
1080
1090
1100
1110
1120
1130
1140
1150
1160
1170
1180
1190
1200
1210
1220
1230
1240
1250
1260
1270
1280
1290
1300
1310
1320
1330
1340
1350
1360
1370
1380
1390
1400
1410
1420
1430
1440
1450
1460
1470
1480
1490
1500
1510
1520
1530
1540
1550
1560
1570
1580
1590
1600
1610
1620
1630
1640
1650
1660
1670
1680
1690
1700
1710
1720
1730
1740
1750
1760
1770
1780
1790
1800
1810
1820
1830
1840
1850
1860
1870
1880
1890
1900
1910
1920
1930
1940
1950
1960
1970
1980
1990
2000
2010
2020
2030
2040
2050
2060
2070
2080
2090
2100
2110
2120
2130
2140
2150
2160
2170
2180
2190
2200
2210
2220
2230
2240
2250
2260
2270
2280
2290
2300
2310
2320
2330
2340
2350
2360
2370
2380
2390
2400
2410
2420
2430
2440
2450
2460
2470
2480
2490
2500
2510
2520
2530
2540
2550
2560
2570
2580
2590
2600
2610
2620
2630
2640
2650
2660
2670
2680
2690
2700
2710
2720
2730
2740
2750
2760
2770
2780
2790
2800
2810
2820
2830
2840
2850
2860
2870
2880
2890
2900
2910
2920
2930
2940
2950
2960
2970
2980
2990
3000
3010
3020
3030
3040
3050
3060
3070
3080
3090
3100
3110
3120
3130
3140
3150
3160
3170
3180
3190
3200
3210
3220
3230
3240
3250
3260
3270
3280
3290
3300
3310
3320
3330
3340
3350
3360
3370
3380
3390
3400
3410
3420
3430
3440
3450
3460
3470
3480
3490
3500
3510
3520
3530
3540
3550
3560
3570
3580
3590
3600
3610
3620
3630
3640
3650
3660
3670
3680
3690
3700
3710
3720
3730
3740
3750
3760
3770
3780
3790
3800
3810
3820
3830
3840
3850
3860
3870
3880
3890
3900
3910
3920
3930
3940
3950
3960
3970
3980
3990
4000
4010
4020
4030
4040
4050
4060
4070
4080
4090
4100
4110
4120
4130
4140
4150
4160
4170
4180
4190
4200
4210
4220
4230
4240
4250
4260
4270
4280
4290
4300
4310
4320
4330
4340
4350
4360
4370
4380
4390
4400
4410
4420
4430
4440
4450
4460
4470
4480
4490
4500
4510
4520
4530
4540
4550
4560
4570
4580
4590
4600
4610
4620
4630
4640
4650
4660
4670
4680
4690
4700
4710
4720
4730
4740
4750
4760
4770
4780
4790
4800
4810
4820
4830
4840
4850
4860
4870
4880
4890
4900
4910
4920
4930
4940
4950
4960
4970
4980
4990
5000
5010
5020
5030
5040
5050
5060
5070
5080
5090
5100
5110
5120
5130
5140
5150
5160
5170
5180
5190
5200
5210
5220
5230
5240
5250
5260
5270
5280
5290
5300
5310
5320
5330
5340
5350
5360
5370
5380
5390
5400
5410
5420
5430
5440
5450
5460
5470
5480
5490
5500
5510
5520
5530
5540
5550
5560
5570
5580
5590
5600
5610
5620
5630
5640
5650
5660
5670
5680
5690
5700
5710
5720
5730
5740
5750
5760
5770
5780
5790
5800
5810
5820
5830
5840
5850
5860
5870
5880
5890
5900
5910
5920
5930
5940
5950
5960
5970
5980
5990
6000
6010
6020
6030
6040
6050
6060
6070
6080
6090
6100
6110
6120
6130
6140
6150
6160
6170
6180
6190
6200
6210
6220
6230
6240
6250
6260
6270
6280
6290
6300
6310
6320
6330
6340
6350
6360
6370
6380
6390
6400
6410
6420
6430
6440
6450
6460
6470
6480
6490
6500
6510
6520
6530
6540
6550
6560
6570
6580
6590
6600
6610
6620
6630
6640
6650
6660
6670
6680
6690
6700
6710
6720
6730
6740
6750
6760
6770
6780
6790
6800
6810
6820
6830
6840
6850
6860
6870
6880
6890
6900
6910
6920
6930
6940
6950
6960
6970
6980
6990
7000
7010
7020
7030
/** File handling functions and types. Copyright: © 2012-2016 RejectedSoftware e.K. License: Subject to the terms of the MIT license, as written in the included LICENSE.txt file. Authors: Sönke Ludwig */ module vibe.core.file; import eventcore.core : eventDriver; import eventcore.driver; import vibe.core.log; import vibe.core.path; import vibe.core.stream; import vibe.internal.async : asyncAwait; import core.stdc.stdio; import core.sys.posix.unistd; import core.sys.posix.fcntl; import core.sys.posix.sys.stat; import std.conv : octal; import std.datetime; import std.exception; import std.file; import std.path; import std.string; version(Posix){ private extern(C) int mkstemps(char* templ, int suffixlen); } @safe: /** Opens a file stream with the specified mode. */ FileStream openFile(NativePath path, FileMode mode = FileMode.read) { auto fil = eventDriver.files.open(path.toNativeString(), cast(FileOpenMode)mode); enforce(fil != FileFD.invalid, "Failed to open file '"~path.toNativeString~"'"); return FileStream(fil, path, mode); } /// ditto FileStream openFile(string path, FileMode mode = FileMode.read) { return openFile(NativePath(path), mode); } /** Read a whole file into a buffer. If the supplied buffer is large enough, it will be used to store the contents of the file. Otherwise, a new buffer will be allocated. Params: path = The path of the file to read buffer = An optional buffer to use for storing the file contents */ ubyte[] readFile(NativePath path, ubyte[] buffer = null, size_t max_size = size_t.max) { auto fil = openFile(path); scope (exit) fil.close(); enforce(fil.size <= max_size, "File is too big."); auto sz = cast(size_t)fil.size; auto ret = sz <= buffer.length ? buffer[0 .. sz] : new ubyte[sz]; fil.read(ret); return ret; } /// ditto ubyte[] readFile(string path, ubyte[] buffer = null, size_t max_size = size_t.max) { return readFile(NativePath(path), buffer, max_size); } /** Write a whole file at once. */ void writeFile(NativePath path, in ubyte[] contents) { auto fil = openFile(path, FileMode.createTrunc); scope (exit) fil.close(); fil.write(contents); } /// ditto void writeFile(string path, in ubyte[] contents) { writeFile(NativePath(path), contents); } /** Convenience function to append to a file. */ void appendToFile(NativePath path, string data) { auto fil = openFile(path, FileMode.append); scope(exit) fil.close(); fil.write(data); } /// ditto void appendToFile(string path, string data) { appendToFile(NativePath(path), data); } /** Read a whole UTF-8 encoded file into a string. The resulting string will be sanitized and will have the optional byte order mark (BOM) removed. */ string readFileUTF8(NativePath path) { import vibe.internal.string; return stripUTF8Bom(sanitizeUTF8(readFile(path))); } /// ditto string readFileUTF8(string path) { return readFileUTF8(NativePath(path)); } /** Write a string into a UTF-8 encoded file. The file will have a byte order mark (BOM) prepended. */ void writeFileUTF8(NativePath path, string contents) { static immutable ubyte[] bom = [0xEF, 0xBB, 0xBF]; auto fil = openFile(path, FileMode.createTrunc); scope (exit) fil.close(); fil.write(bom); fil.write(contents); } /** Creates and opens a temporary file for writing. */ FileStream createTempFile(string suffix = null) { version(Windows){ import std.conv : to; string tmpname; () @trusted { auto fn = tmpnam(null); enforce(fn !is null, "Failed to generate temporary name."); tmpname = to!string(fn); } (); if (tmpname.startsWith("\\")) tmpname = tmpname[1 .. $]; tmpname ~= suffix; return openFile(tmpname, FileMode.createTrunc); } else { enum pattern ="/tmp/vtmp.XXXXXX"; scope templ = new char[pattern.length+suffix.length+1]; templ[0 .. pattern.length] = pattern; templ[pattern.length .. $-1] = (suffix)[]; templ[$-1] = '\0'; assert(suffix.length <= int.max); auto fd = () @trusted { return mkstemps(templ.ptr, cast(int)suffix.length); } (); enforce(fd >= 0, "Failed to create temporary file."); auto efd = eventDriver.files.adopt(fd); return FileStream(efd, NativePath(templ[0 .. $-1].idup), FileMode.createTrunc); } } /** Moves or renames a file. Params: from = Path to the file/directory to move/rename. to = The target path copy_fallback = Determines if copy/remove should be used in case of the source and destination path pointing to different devices. */ void moveFile(NativePath from, NativePath to, bool copy_fallback = false) { moveFile(from.toNativeString(), to.toNativeString(), copy_fallback); } /// ditto void moveFile(string from, string to, bool copy_fallback = false) { if (!copy_fallback) { std.file.rename(from, to); } else { try { std.file.rename(from, to); } catch (FileException e) { std.file.copy(from, to); std.file.remove(from); } } } /** Copies a file. Note that attributes and time stamps are currently not retained. Params: from = Path of the source file to = Path for the destination file overwrite = If true, any file existing at the destination path will be overwritten. If this is false, an exception will be thrown should a file already exist at the destination path. Throws: An Exception if the copy operation fails for some reason. */ void copyFile(NativePath from, NativePath to, bool overwrite = false) { { auto src = openFile(from, FileMode.read); scope(exit) src.close(); enforce(overwrite || !existsFile(to), "Destination file already exists."); auto dst = openFile(to, FileMode.createTrunc); scope(exit) dst.close(); dst.write(src); } // TODO: retain attributes and time stamps } /// ditto void copyFile(string from, string to) { copyFile(NativePath(from), NativePath(to)); } /** Removes a file */ void removeFile(NativePath path) { removeFile(path.toNativeString()); } /// ditto void removeFile(string path) { std.file.remove(path); } /** Checks if a file exists */ bool existsFile(NativePath path) nothrow { return existsFile(path.toNativeString()); } /// ditto bool existsFile(string path) nothrow { // This was *annotated* nothrow in 2.067. static if (__VERSION__ < 2067) scope(failure) assert(0, "Error: existsFile should never throw"); return std.file.exists(path); } /** Stores information about the specified file/directory into 'info' Throws: A `FileException` is thrown if the file does not exist. */ FileInfo getFileInfo(NativePath path) @trusted { auto ent = DirEntry(path.toNativeString()); return makeFileInfo(ent); } /// ditto FileInfo getFileInfo(string path) { return getFileInfo(NativePath(path)); } /** Creates a new directory. */ void createDirectory(NativePath path) { () @trusted { mkdir(path.toNativeString()); } (); } /// ditto void createDirectory(string path) { createDirectory(NativePath(path)); } /** Enumerates all files in the specified directory. */ void listDirectory(NativePath path, scope bool delegate(FileInfo info) del) @trusted { foreach( DirEntry ent; dirEntries(path.toNativeString(), SpanMode.shallow) ) if( !del(makeFileInfo(ent)) ) break; } /// ditto void listDirectory(string path, scope bool delegate(FileInfo info) del) { listDirectory(NativePath(path), del); } /// ditto int delegate(scope int delegate(ref FileInfo)) iterateDirectory(NativePath path) { int iterator(scope int delegate(ref FileInfo) del){ int ret = 0; listDirectory(path, (fi){ ret = del(fi); return ret == 0; }); return ret; } return &iterator; } /// ditto int delegate(scope int delegate(ref FileInfo)) iterateDirectory(string path) { return iterateDirectory(NativePath(path)); } /** Starts watching a directory for changes. */ DirectoryWatcher watchDirectory(NativePath path, bool recursive = true) { return DirectoryWatcher(path, recursive); } // ditto DirectoryWatcher watchDirectory(string path, bool recursive = true) { return watchDirectory(NativePath(path), recursive); } /** Returns the current working directory. */ NativePath getWorkingDirectory() { return NativePath(() @trusted { return std.file.getcwd(); } ()); } /** Contains general information about a file. */ struct FileInfo { /// Name of the file (not including the path) string name; /// Size of the file (zero for directories) ulong size; /// Time of the last modification SysTime timeModified; /// Time of creation (not available on all operating systems/file systems) SysTime timeCreated; /// True if this is a symlink to an actual file bool isSymlink; /// True if this is a directory or a symlink pointing to a directory bool isDirectory; /** True if the file's hidden attribute is set. On systems that don't support a hidden attribute, any file starting with a single dot will be treated as hidden. */ bool hidden; } /** Specifies how a file is manipulated on disk. */ enum FileMode { /// The file is opened read-only. read = FileOpenMode.read, /// The file is opened for read-write random access. readWrite = FileOpenMode.readWrite, /// The file is truncated if it exists or created otherwise and then opened for read-write access. createTrunc = FileOpenMode.createTrunc, /// The file is opened for appending data to it and created if it does not exist. append = FileOpenMode.append } /** Accesses the contents of a file as a stream. */ struct FileStream { @safe: private struct CTX { NativePath path; ulong size; FileMode mode; ulong ptr; } private { FileFD m_fd; CTX* m_ctx; } private this(FileFD fd, NativePath path, FileMode mode) { assert(fd != FileFD.invalid, "Constructing FileStream from invalid file descriptor."); m_fd = fd; m_ctx = new CTX; // TODO: use FD custom storage m_ctx.path = path; m_ctx.mode = mode; m_ctx.size = eventDriver.files.getSize(fd); } this(this) { if (m_fd != FileFD.invalid) eventDriver.files.addRef(m_fd); } ~this() { if (m_fd != FileFD.invalid) eventDriver.files.releaseRef(m_fd); } @property int fd() { return cast(int)m_fd; } /// The path of the file. @property NativePath path() const { return ctx.path; } /// Determines if the file stream is still open @property bool isOpen() const { return m_fd != FileFD.invalid; } @property ulong size() const nothrow { return ctx.size; } @property bool readable() const nothrow { return ctx.mode != FileMode.append; } @property bool writable() const nothrow { return ctx.mode != FileMode.read; } bool opCast(T)() if (is (T == bool)) { return m_fd != FileFD.invalid; } void takeOwnershipOfFD() { assert(false, "TODO!"); } void seek(ulong offset) { ctx.ptr = offset; } ulong tell() nothrow { return ctx.ptr; } /// Closes the file handle. void close() { if (m_fd != FileFD.init) { eventDriver.files.close(m_fd); eventDriver.files.releaseRef(m_fd); m_fd = FileFD.init; } } @property bool empty() const { assert(this.readable); return ctx.ptr >= ctx.size; } @property ulong leastSize() const { assert(this.readable); return ctx.size - ctx.ptr; } @property bool dataAvailableForRead() { return true; } const(ubyte)[] peek() { return null; } size_t read(ubyte[] dst, IOMode mode) { auto res = asyncAwait!(FileIOCallback, cb => eventDriver.files.read(m_fd, ctx.ptr, dst, mode, cb), cb => eventDriver.files.cancelRead(m_fd) ); ctx.ptr += res[2]; enforce(res[1] == IOStatus.ok, "Failed to read data from disk."); return res[2]; } void read(ubyte[] dst) { auto ret = read(dst, IOMode.all); assert(ret == dst.length, "File.read returned less data than requested for IOMode.all."); } size_t write(in ubyte[] bytes, IOMode mode) { auto res = asyncAwait!(FileIOCallback, cb => eventDriver.files.write(m_fd, ctx.ptr, bytes, mode, cb), cb => eventDriver.files.cancelWrite(m_fd) ); ctx.ptr += res[2]; if (ctx.ptr > ctx.size) ctx.size = ctx.ptr; enforce(res[1] == IOStatus.ok, "Failed to read data from disk."); return res[2]; } void write(in ubyte[] bytes) { write(bytes, IOMode.all); } void write(in char[] bytes) { write(cast(const(ubyte)[])bytes); } void write(InputStream)(InputStream stream, ulong nbytes = ulong.max) if (isInputStream!InputStream) { writeDefault(this, stream, nbytes); } void flush() { assert(this.writable); } void finalize() { flush(); } private inout(CTX)* ctx() inout nothrow { return m_ctx; } } mixin validateRandomAccessStream!FileStream; private void writeDefault(OutputStream, InputStream)(ref OutputStream dst, InputStream stream, ulong nbytes = ulong.max) if (isOutputStream!OutputStream && isInputStream!InputStream) { import vibe.internal.allocator : theAllocator, make, dispose; import std.algorithm.comparison : min; static struct Buffer { ubyte[64*1024] bytes = void; } auto bufferobj = () @trusted { return theAllocator.make!Buffer(); } (); scope (exit) () @trusted { theAllocator.dispose(bufferobj); } (); auto buffer = bufferobj.bytes[]; //logTrace("default write %d bytes, empty=%s", nbytes, stream.empty); if (nbytes == ulong.max) { while (!stream.empty) { size_t chunk = min(stream.leastSize, buffer.length); assert(chunk > 0, "leastSize returned zero for non-empty stream."); //logTrace("read pipe chunk %d", chunk); stream.read(buffer[0 .. chunk]); dst.write(buffer[0 .. chunk]); } } else { while (nbytes > 0) { size_t chunk = min(nbytes, buffer.length); //logTrace("read pipe chunk %d", chunk); stream.read(buffer[0 .. chunk]); dst.write(buffer[0 .. chunk]); nbytes -= chunk; } } } /** Interface for directory watcher implementations. Directory watchers monitor the contents of a directory (wither recursively or non-recursively) for changes, such as file additions, deletions or modifications. */ struct DirectoryWatcher { // TODO: avoid all those heap allocations! import std.array : Appender, appender; import vibe.core.sync : LocalManualEvent, createManualEvent; @safe: private static struct Context { NativePath path; bool recursive; Appender!(DirectoryChange[]) changes; LocalManualEvent changeEvent; void onChange(WatcherID, in ref FileChange change) nothrow { DirectoryChangeType ct; final switch (change.kind) { case FileChangeKind.added: ct = DirectoryChangeType.added; break; case FileChangeKind.removed: ct = DirectoryChangeType.removed; break; case FileChangeKind.modified: ct = DirectoryChangeType.modified; break; } static if (is(typeof(change.baseDirectory))) { // eventcore 0.8.23 and up this.changes ~= DirectoryChange(ct, NativePath.fromTrustedString(change.baseDirectory) ~ NativePath.fromTrustedString(change.directory) ~ NativePath.fromTrustedString(change.name.idup)); } else { this.changes ~= DirectoryChange(ct, NativePath.fromTrustedString(change.directory) ~ NativePath.fromTrustedString(change.name.idup)); } this.changeEvent.emit(); } } private { WatcherID m_watcher; Context* m_context; } private this(NativePath path, bool recursive) { m_context = new Context; // FIME: avoid GC allocation (use FD user data slot) m_context.changeEvent = createManualEvent(); m_watcher = eventDriver.watchers.watchDirectory(path.toNativeString, recursive, &m_context.onChange); m_context.path = path; m_context.recursive = recursive; m_context.changes = appender!(DirectoryChange[]); } this(this) nothrow { if (m_watcher != WatcherID.invalid) eventDriver.watchers.addRef(m_watcher); } ~this() nothrow { if (m_watcher != WatcherID.invalid) eventDriver.watchers.releaseRef(m_watcher); } /// The path of the watched directory @property NativePath path() const nothrow { return m_context.path; } /// Indicates if the directory is watched recursively @property bool recursive() const nothrow { return m_context.recursive; } /** Fills the destination array with all changes that occurred since the last call. The function will block until either directory changes have occurred or until the timeout has elapsed. Specifying a negative duration will cause the function to wait without a timeout. Params: dst = The destination array to which the changes will be appended timeout = Optional timeout for the read operation. A value of `Duration.max` will wait indefinitely. Returns: If the call completed successfully, true is returned. */ bool readChanges(ref DirectoryChange[] dst, Duration timeout = Duration.max) { if (timeout == Duration.max) { while (!m_context.changes.data.length) m_context.changeEvent.wait(Duration.max, m_context.changeEvent.emitCount); } else { SysTime now = Clock.currTime(UTC()); SysTime final_time = now + timeout; while (!m_context.changes.data.length) { m_context.changeEvent.wait(final_time - now, m_context.changeEvent.emitCount); now = Clock.currTime(UTC()); if (now >= final_time) break; } if (!m_context.changes.data.length) return false; } dst = m_context.changes.data; m_context.changes = appender!(DirectoryChange[]); return true; } } /** Specifies the kind of change in a watched directory. */ enum DirectoryChangeType { /// A file or directory was added added, /// A file or directory was deleted removed, /// A file or directory was modified modified } /** Describes a single change in a watched directory. */ struct DirectoryChange { /// The type of change DirectoryChangeType type; /// Path of the file/directory that was changed NativePath path; } private FileInfo makeFileInfo(DirEntry ent) @trusted { FileInfo ret; auto fullname = ent.name.endsWith('/') || ent.name.endsWith('\\') ? ent.name[0 .. $-1] : ent.name; ret.name = baseName(fullname); if (ret.name.length == 0) ret.name = fullname; ret.size = ent.size; ret.timeModified = ent.timeLastModified; version(Windows) ret.timeCreated = ent.timeCreated; else ret.timeCreated = ent.timeLastModified; ret.isSymlink = ent.isSymlink; ret.isDirectory = ent.isDir; version (Windows) { import core.sys.windows.windows : FILE_ATTRIBUTE_HIDDEN; ret.hidden = (ent.attributes & FILE_ATTRIBUTE_HIDDEN) != 0; } else ret.hidden = ret.name.startsWith('.'); return ret; }