Add temporary directory support for POSIX (#222)

Author: brianquinlan

pkgs/io_file/README.md

@@ -15,7 +15,7 @@ See
 |  create directory     |         |   ✓   |   ✓   |   ✓   |    ✓    |            |              |
 |  create hard link     |         |       |       |       |         |            |              |
 |  create symbolic link |         |       |       |       |         |            |              |
-|  create tmp directory |         |       |       |       |         |            |              |
+|  create tmp directory |         |   ✓   |   ✓   |   ✓   |    ✓    |            |              |
 |  create tmp file      |         |       |       |       |         |            |              |
 |  delete directory     |         |   ✓   |   ✓   |   ✓   |    ✓    |            |              |
 |  delete file          |         |       |       |       |         |            |              |

pkgs/io_file/lib/src/vm_windows_file_system.dart

@@ -10,6 +10,7 @@ import 'dart:typed_data';
 
 import 'package:ffi/ffi.dart';
 import 'package:ffi/ffi.dart' as ffi;
+import 'package:path/path.dart' as p;
 import 'package:win32/win32.dart' as win32;
 
 import 'file_system.dart';
@@ -44,33 +45,37 @@ String _formatMessage(int errorCode) {
   }
 }
 
-Exception _getError(int errorCode, String message, String path) {
+Exception _getError(int errorCode, String message, [String? path]) {
   final osError = io.OSError(_formatMessage(errorCode), errorCode);
 
-  switch (errorCode) {
-    case win32.ERROR_ACCESS_DENIED:
-    case win32.ERROR_CURRENT_DIRECTORY:
-    case win32.ERROR_WRITE_PROTECT:
-    case win32.ERROR_BAD_LENGTH:
-    case win32.ERROR_SHARING_VIOLATION:
-    case win32.ERROR_LOCK_VIOLATION:
-    case win32.ERROR_NETWORK_ACCESS_DENIED:
-    case win32.ERROR_DRIVE_LOCKED:
-      return io.PathAccessException(path, osError, message);
-    case win32.ERROR_FILE_EXISTS:
-    case win32.ERROR_ALREADY_EXISTS:
-      return io.PathExistsException(path, osError, message);
-    case win32.ERROR_FILE_NOT_FOUND:
-    case win32.ERROR_PATH_NOT_FOUND:
-    case win32.ERROR_INVALID_DRIVE:
-    case win32.ERROR_INVALID_NAME:
-    case win32.ERROR_NO_MORE_FILES:
-    case win32.ERROR_BAD_NETPATH:
-    case win32.ERROR_BAD_NET_NAME:
-    case win32.ERROR_BAD_PATHNAME:
-      return io.PathNotFoundException(path, osError, message);
-    default:
-      return io.FileSystemException(message, path, osError);
+  if (path != null) {
+    switch (errorCode) {
+      case win32.ERROR_ACCESS_DENIED:
+      case win32.ERROR_CURRENT_DIRECTORY:
+      case win32.ERROR_WRITE_PROTECT:
+      case win32.ERROR_BAD_LENGTH:
+      case win32.ERROR_SHARING_VIOLATION:
+      case win32.ERROR_LOCK_VIOLATION:
+      case win32.ERROR_NETWORK_ACCESS_DENIED:
+      case win32.ERROR_DRIVE_LOCKED:
+        return io.PathAccessException(path, osError, message);
+      case win32.ERROR_FILE_EXISTS:
+      case win32.ERROR_ALREADY_EXISTS:
+        return io.PathExistsException(path, osError, message);
+      case win32.ERROR_FILE_NOT_FOUND:
+      case win32.ERROR_PATH_NOT_FOUND:
+      case win32.ERROR_INVALID_DRIVE:
+      case win32.ERROR_INVALID_NAME:
+      case win32.ERROR_NO_MORE_FILES:
+      case win32.ERROR_BAD_NETPATH:
+      case win32.ERROR_BAD_NET_NAME:
+      case win32.ERROR_BAD_PATHNAME:
+        return io.PathNotFoundException(path, osError, message);
+      default:
+        return io.FileSystemException(message, path, osError);
+    }
+  } else {
+    return io.FileSystemException(message, path, osError);
   }
 }
 
@@ -132,6 +137,17 @@ base class WindowsFileSystem extends FileSystem {
     }
   });
 
+  @override
+  String createTemporaryDirectory({String? parent, String? prefix}) {
+    _primeGetLastError();
+
+    final suffix = win32.Guid.generate().toString();
+    final directory = parent ?? temporaryDirectory;
+    final path = p.join(directory, '${prefix ?? ''}$suffix');
+    createDirectory(path);
+    return path;
+  }
+
   @override
   void removeDirectory(String path) => using((arena) {
     _primeGetLastError();
@@ -266,6 +282,22 @@ base class WindowsFileSystem extends FileSystem {
     }
   }
 
+  @override
+  String get temporaryDirectory {
+    const maxLength = win32.MAX_PATH + 1;
+    final buffer = win32.wsalloc(maxLength);
+    try {
+      final length = win32.GetTempPath2(maxLength, buffer);
+      if (length == 0) {
+        final errorCode = win32.GetLastError();
+        throw _getError(errorCode, 'GetTempPath failed');
+      }
+      return p.canonicalize(buffer.toDartString());
+    } finally {
+      win32.free(buffer);
+    }
+  }
+
   @override
   void writeAsBytes(
     String path,

pkgs/io_file/test/create_temporary_directory_test.dart

@@ -2,7 +2,7 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
-@TestOn('posix')
+@TestOn('vm')
 library;
 
 import 'dart:io';
@@ -11,6 +11,7 @@ import 'package:io_file/io_file.dart';
 import 'package:path/path.dart' as p;
 import 'package:stdlibc/stdlibc.dart' as stdlibc;
 import 'package:test/test.dart';
+import 'package:win32/win32.dart' as win32;
 
 import 'test_utils.dart';
 
@@ -107,7 +108,7 @@ void main() {
           isA<PathNotFoundException>().having(
             (e) => e.osError?.errorCode,
             'errorCode',
-            stdlibc.ENOENT,
+            Platform.isWindows ? win32.ERROR_PATH_NOT_FOUND : stdlibc.ENOENT,
           ),
         ),
       );
@@ -146,7 +147,7 @@ void main() {
           isA<PathNotFoundException>().having(
             (e) => e.osError?.errorCode,
             'errorCode',
-            stdlibc.ENOENT,
+            Platform.isWindows ? win32.ERROR_PATH_NOT_FOUND : stdlibc.ENOENT,
           ),
         ),
       );
@@ -160,7 +161,7 @@ void main() {
         parent: tmp,
         prefix: 'dir1/file',
       );
-      expect(tmp1, startsWith(subdir1));
+      expect(p.canonicalize(tmp1), startsWith(p.canonicalize(subdir1)));
       expect(Directory(tmp1).existsSync(), isTrue);
     });
   });

pkgs/io_file/test/temporary_directory_test.dart

@@ -2,7 +2,7 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
-@TestOn('posix')
+@TestOn('vm')
 library;
 
 import 'package:io_file/io_file.dart';