packages/path_provider/path_provider_windows/lib/src/path_provider_windows_real.dart - mirrors/plugins - Git at Google

 // Copyright 2013 The Flutter Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.

 import 'dart:ffi';
 import 'dart:io';

 import 'package:ffi/ffi.dart';
 import 'package:flutter/foundation.dart' show visibleForTesting;
 import 'package:path/path.dart' as path;
 import 'package:path_provider_platform_interface/path_provider_platform_interface.dart';
 import 'package:win32/win32.dart';

 import 'folders.dart';

 /// Constant for en-US language used in VersionInfo keys.
 @visibleForTesting
 const String languageEn = '0409';

 /// Constant for CP1252 encoding used in VersionInfo keys
 @visibleForTesting
 const String encodingCP1252 = '04e4';

 /// Constant for Unicode encoding used in VersionInfo keys
 @visibleForTesting
 const String encodingUnicode = '04b0';

 /// Wraps the Win32 VerQueryValue API call.
 ///
 /// This class exists to allow injecting alternate metadata in tests without
 /// building multiple custom test binaries.
 @visibleForTesting
 class VersionInfoQuerier {
   /// Returns the value for [key] in [versionInfo]s in section with given
   /// language and encoding, or null if there is no such entry,
   /// or if versionInfo is null.
   ///
   /// See https://docs.microsoft.com/en-us/windows/win32/menurc/versioninfo-resource
   /// for list of possible language and encoding values.
   String? getStringValue(
     Pointer<Uint8>? versionInfo,
     String key, {
     required String language,
     required String encoding,
   }) {
     assert(language.isNotEmpty);
     assert(encoding.isNotEmpty);
     if (versionInfo == null) {
       return null;
     }
     final Pointer<Utf16> keyPath =
         TEXT('\\StringFileInfo\\$language$encoding\\$key');
     final Pointer<UINT> length = calloc<UINT>();
     final Pointer<Pointer<Utf16>> valueAddress = calloc<Pointer<Utf16>>();
     try {
       if (VerQueryValue(versionInfo, keyPath, valueAddress, length) == 0) {
         return null;
       }
       return valueAddress.value.toDartString();
     } finally {
       calloc.free(keyPath);
       calloc.free(length);
       calloc.free(valueAddress);
     }
   }
 }

 /// The Windows implementation of [PathProviderPlatform]
 ///
 /// This class implements the `package:path_provider` functionality for Windows.
 class PathProviderWindows extends PathProviderPlatform {
   /// Registers the Windows implementation.
   static void registerWith() {
     PathProviderPlatform.instance = PathProviderWindows();
   }

   /// The object to use for performing VerQueryValue calls.
   @visibleForTesting
   VersionInfoQuerier versionInfoQuerier = VersionInfoQuerier();

   /// This is typically the same as the TMP environment variable.
   @override
   Future<String?> getTemporaryPath() async {
     final Pointer<Utf16> buffer = calloc<Uint16>(MAX_PATH + 1).cast<Utf16>();
     String path;

     try {
       final int length = GetTempPath(MAX_PATH, buffer);

       if (length == 0) {
         final int error = GetLastError();
         throw WindowsException(error);
       } else {
         path = buffer.toDartString();

         // GetTempPath adds a trailing backslash, but SHGetKnownFolderPath does
         // not. Strip off trailing backslash for consistency with other methods
         // here.
         if (path.endsWith(r'\')) {
           path = path.substring(0, path.length - 1);
         }
       }

       // Ensure that the directory exists, since GetTempPath doesn't.
       final Directory directory = Directory(path);
       if (!directory.existsSync()) {
         await directory.create(recursive: true);
       }

       return path;
     } finally {
       calloc.free(buffer);
     }
   }

   @override
   Future<String?> getApplicationSupportPath() async {
     final String? appDataRoot =
         await getPath(WindowsKnownFolder.RoamingAppData);
     if (appDataRoot == null) {
       return null;
     }
     final Directory directory = Directory(
         path.join(appDataRoot, _getApplicationSpecificSubdirectory()));
     // Ensure that the directory exists if possible, since it will on other
     // platforms. If the name is longer than MAXPATH, creating will fail, so
     // skip that step; it's up to the client to decide what to do with the path
     // in that case (e.g., using a short path).
     if (directory.path.length <= MAX_PATH) {
       if (!directory.existsSync()) {
         await directory.create(recursive: true);
       }
     }
     return directory.path;
   }

   @override
   Future<String?> getApplicationDocumentsPath() =>
       getPath(WindowsKnownFolder.Documents);

   @override
   Future<String?> getDownloadsPath() => getPath(WindowsKnownFolder.Downloads);

   /// Retrieve any known folder from Windows.
   ///
   /// folderID is a GUID that represents a specific known folder ID, drawn from
   /// [WindowsKnownFolder].
   Future<String?> getPath(String folderID) {
     final Pointer<Pointer<Utf16>> pathPtrPtr = calloc<Pointer<Utf16>>();
     final Pointer<GUID> knownFolderID = calloc<GUID>()..ref.setGUID(folderID);

     try {
       final int hr = SHGetKnownFolderPath(
         knownFolderID,
         KF_FLAG_DEFAULT,
         NULL,
         pathPtrPtr,
       );

       if (FAILED(hr)) {
         if (hr == E_INVALIDARG || hr == E_FAIL) {
           throw WindowsException(hr);
         }
         return Future<String?>.value();
       }

       final String path = pathPtrPtr.value.toDartString();
       return Future<String>.value(path);
     } finally {
       calloc.free(pathPtrPtr);
       calloc.free(knownFolderID);
     }
   }

   String? _getStringValue(Pointer<Uint8>? infoBuffer, String key) =>
       versionInfoQuerier.getStringValue(infoBuffer, key,
           language: languageEn, encoding: encodingCP1252) ??
       versionInfoQuerier.getStringValue(infoBuffer, key,
           language: languageEn, encoding: encodingUnicode);

   /// Returns the relative path string to append to the root directory returned
   /// by Win32 APIs for application storage (such as RoamingAppDir) to get a
   /// directory that is unique to the application.
   ///
   /// The convention is to use company-name\product-name\. This will use that if
   /// possible, using the data in the VERSIONINFO resource, with the following
   /// fallbacks:
   /// - If the company name isn't there, that component will be dropped.
   /// - If the product name isn't there, it will use the exe's filename (without
   ///   extension).
   String _getApplicationSpecificSubdirectory() {
     String? companyName;
     String? productName;

     final Pointer<Utf16> moduleNameBuffer = wsalloc(MAX_PATH + 1);
     final Pointer<DWORD> unused = calloc<DWORD>();
     Pointer<BYTE>? infoBuffer;
     try {
       // Get the module name.
       final int moduleNameLength =
           GetModuleFileName(0, moduleNameBuffer, MAX_PATH);
       if (moduleNameLength == 0) {
         final int error = GetLastError();
         throw WindowsException(error);
       }

       // From that, load the VERSIONINFO resource
       final int infoSize = GetFileVersionInfoSize(moduleNameBuffer, unused);
       if (infoSize != 0) {
         infoBuffer = calloc<BYTE>(infoSize);
         if (GetFileVersionInfo(moduleNameBuffer, 0, infoSize, infoBuffer) ==
             0) {
           calloc.free(infoBuffer);
           infoBuffer = null;
         }
       }
       companyName =
           _sanitizedDirectoryName(_getStringValue(infoBuffer, 'CompanyName'));
       productName =
           _sanitizedDirectoryName(_getStringValue(infoBuffer, 'ProductName'));

       // If there was no product name, use the executable name.
       productName ??=
           path.basenameWithoutExtension(moduleNameBuffer.toDartString());

       return companyName != null
           ? path.join(companyName, productName)
           : productName;
     } finally {
       calloc.free(moduleNameBuffer);
       calloc.free(unused);
       if (infoBuffer != null) {
         calloc.free(infoBuffer);
       }
     }
   }

   /// Makes [rawString] safe as a directory component. See
   /// https://docs.microsoft.com/en-us/windows/win32/fileio/naming-a-file#naming-conventions
   ///
   /// If after sanitizing the string is empty, returns null.
   String? _sanitizedDirectoryName(String? rawString) {
     if (rawString == null) {
       return null;
     }
     String sanitized = rawString
         // Replace banned characters.
         .replaceAll(RegExp(r'[<>:"/\\|?*]'), '_')
         // Remove trailing whitespace.
         .trimRight()
         // Ensure that it does not end with a '.'.
         .replaceAll(RegExp(r'[.]+$'), '');
     const int kMaxComponentLength = 255;
     if (sanitized.length > kMaxComponentLength) {
       sanitized = sanitized.substring(0, kMaxComponentLength);
     }
     return sanitized.isEmpty ? null : sanitized;
   }
 }
	// Copyright 2013 The Flutter Authors. All rights reserved.
	// Use of this source code is governed by a BSD-style license that can be
	// found in the LICENSE file.

	import 'dart:ffi';
	import 'dart:io';

	import 'package:ffi/ffi.dart';
	import 'package:flutter/foundation.dart' show visibleForTesting;
	import 'package:path/path.dart' as path;
	import 'package:path_provider_platform_interface/path_provider_platform_interface.dart';
	import 'package:win32/win32.dart';

	import 'folders.dart';

	/// Constant for en-US language used in VersionInfo keys.
	@visibleForTesting
	const String languageEn = '0409';

	/// Constant for CP1252 encoding used in VersionInfo keys
	@visibleForTesting
	const String encodingCP1252 = '04e4';

	/// Constant for Unicode encoding used in VersionInfo keys
	@visibleForTesting
	const String encodingUnicode = '04b0';

	/// Wraps the Win32 VerQueryValue API call.
	///
	/// This class exists to allow injecting alternate metadata in tests without
	/// building multiple custom test binaries.
	@visibleForTesting
	class VersionInfoQuerier {
	/// Returns the value for [key] in [versionInfo]s in section with given
	/// language and encoding, or null if there is no such entry,
	/// or if versionInfo is null.
	///
	/// See https://docs.microsoft.com/en-us/windows/win32/menurc/versioninfo-resource
	/// for list of possible language and encoding values.
	String? getStringValue(
	Pointer<Uint8>? versionInfo,
	String key, {
	required String language,
	required String encoding,
	}) {
	assert(language.isNotEmpty);
	assert(encoding.isNotEmpty);
	if (versionInfo == null) {
	return null;
	}
	final Pointer<Utf16> keyPath =
	TEXT('\\StringFileInfo\\$language$encoding\\$key');
	final Pointer<UINT> length = calloc<UINT>();
	final Pointer<Pointer<Utf16>> valueAddress = calloc<Pointer<Utf16>>();
	try {
	if (VerQueryValue(versionInfo, keyPath, valueAddress, length) == 0) {
	return null;
	}
	return valueAddress.value.toDartString();
	} finally {
	calloc.free(keyPath);
	calloc.free(length);
	calloc.free(valueAddress);
	}
	}
	}

	/// The Windows implementation of [PathProviderPlatform]
	///
	/// This class implements the `package:path_provider` functionality for Windows.
	class PathProviderWindows extends PathProviderPlatform {
	/// Registers the Windows implementation.
	static void registerWith() {
	PathProviderPlatform.instance = PathProviderWindows();
	}

	/// The object to use for performing VerQueryValue calls.
	@visibleForTesting
	VersionInfoQuerier versionInfoQuerier = VersionInfoQuerier();

	/// This is typically the same as the TMP environment variable.
	@override
	Future<String?> getTemporaryPath() async {
	final Pointer<Utf16> buffer = calloc<Uint16>(MAX_PATH + 1).cast<Utf16>();
	String path;

	try {
	final int length = GetTempPath(MAX_PATH, buffer);

	if (length == 0) {
	final int error = GetLastError();
	throw WindowsException(error);
	} else {
	path = buffer.toDartString();

	// GetTempPath adds a trailing backslash, but SHGetKnownFolderPath does
	// not. Strip off trailing backslash for consistency with other methods
	// here.
	if (path.endsWith(r'\')) {
	path = path.substring(0, path.length - 1);
	}
	}

	// Ensure that the directory exists, since GetTempPath doesn't.
	final Directory directory = Directory(path);
	if (!directory.existsSync()) {
	await directory.create(recursive: true);
	}

	return path;
	} finally {
	calloc.free(buffer);
	}
	}

	@override
	Future<String?> getApplicationSupportPath() async {
	final String? appDataRoot =
	await getPath(WindowsKnownFolder.RoamingAppData);
	if (appDataRoot == null) {
	return null;
	}
	final Directory directory = Directory(
	path.join(appDataRoot, _getApplicationSpecificSubdirectory()));
	// Ensure that the directory exists if possible, since it will on other
	// platforms. If the name is longer than MAXPATH, creating will fail, so
	// skip that step; it's up to the client to decide what to do with the path
	// in that case (e.g., using a short path).
	if (directory.path.length <= MAX_PATH) {
	if (!directory.existsSync()) {
	await directory.create(recursive: true);
	}
	}
	return directory.path;
	}

	@override
	Future<String?> getApplicationDocumentsPath() =>
	getPath(WindowsKnownFolder.Documents);

	@override
	Future<String?> getDownloadsPath() => getPath(WindowsKnownFolder.Downloads);

	/// Retrieve any known folder from Windows.
	///
	/// folderID is a GUID that represents a specific known folder ID, drawn from
	/// [WindowsKnownFolder].
	Future<String?> getPath(String folderID) {
	final Pointer<Pointer<Utf16>> pathPtrPtr = calloc<Pointer<Utf16>>();
	final Pointer<GUID> knownFolderID = calloc<GUID>()..ref.setGUID(folderID);

	try {
	final int hr = SHGetKnownFolderPath(
	knownFolderID,
	KF_FLAG_DEFAULT,
	NULL,
	pathPtrPtr,
	);

	if (FAILED(hr)) {
	if (hr == E_INVALIDARG \|\| hr == E_FAIL) {
	throw WindowsException(hr);
	}
	return Future<String?>.value();
	}

	final String path = pathPtrPtr.value.toDartString();
	return Future<String>.value(path);
	} finally {
	calloc.free(pathPtrPtr);
	calloc.free(knownFolderID);
	}
	}

	String? _getStringValue(Pointer<Uint8>? infoBuffer, String key) =>
	versionInfoQuerier.getStringValue(infoBuffer, key,
	language: languageEn, encoding: encodingCP1252) ??
	versionInfoQuerier.getStringValue(infoBuffer, key,
	language: languageEn, encoding: encodingUnicode);

	/// Returns the relative path string to append to the root directory returned
	/// by Win32 APIs for application storage (such as RoamingAppDir) to get a
	/// directory that is unique to the application.
	///
	/// The convention is to use company-name\product-name\. This will use that if
	/// possible, using the data in the VERSIONINFO resource, with the following
	/// fallbacks:
	/// - If the company name isn't there, that component will be dropped.
	/// - If the product name isn't there, it will use the exe's filename (without
	/// extension).
	String _getApplicationSpecificSubdirectory() {
	String? companyName;
	String? productName;

	final Pointer<Utf16> moduleNameBuffer = wsalloc(MAX_PATH + 1);
	final Pointer<DWORD> unused = calloc<DWORD>();
	Pointer<BYTE>? infoBuffer;
	try {
	// Get the module name.
	final int moduleNameLength =
	GetModuleFileName(0, moduleNameBuffer, MAX_PATH);
	if (moduleNameLength == 0) {
	final int error = GetLastError();
	throw WindowsException(error);
	}

	// From that, load the VERSIONINFO resource
	final int infoSize = GetFileVersionInfoSize(moduleNameBuffer, unused);
	if (infoSize != 0) {
	infoBuffer = calloc<BYTE>(infoSize);
	if (GetFileVersionInfo(moduleNameBuffer, 0, infoSize, infoBuffer) ==
	0) {
	calloc.free(infoBuffer);
	infoBuffer = null;
	}
	}
	companyName =
	_sanitizedDirectoryName(_getStringValue(infoBuffer, 'CompanyName'));
	productName =
	_sanitizedDirectoryName(_getStringValue(infoBuffer, 'ProductName'));

	// If there was no product name, use the executable name.
	productName ??=
	path.basenameWithoutExtension(moduleNameBuffer.toDartString());

	return companyName != null
	? path.join(companyName, productName)
	: productName;
	} finally {
	calloc.free(moduleNameBuffer);
	calloc.free(unused);
	if (infoBuffer != null) {
	calloc.free(infoBuffer);
	}
	}
	}

	/// Makes [rawString] safe as a directory component. See
	/// https://docs.microsoft.com/en-us/windows/win32/fileio/naming-a-file#naming-conventions
	///
	/// If after sanitizing the string is empty, returns null.
	String? _sanitizedDirectoryName(String? rawString) {
	if (rawString == null) {
	return null;
	}
	String sanitized = rawString
	// Replace banned characters.
	.replaceAll(RegExp(r'[<>:"/\\\|?*]'), '_')
	// Remove trailing whitespace.
	.trimRight()
	// Ensure that it does not end with a '.'.
	.replaceAll(RegExp(r'[.]+$'), '');
	const int kMaxComponentLength = 255;
	if (sanitized.length > kMaxComponentLength) {
	sanitized = sanitized.substring(0, kMaxComponentLength);
	}
	return sanitized.isEmpty ? null : sanitized;
	}
	}