feat: add some plugins.

2021-09-15 00:49:39 +08:00
parent 01327ddfe0
commit 9166c80979
51 changed files with 4363 additions and 51 deletions
@@ -0,0 +1,68 @@
+// Copyright 2020 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.
+
+library xdg_directories;
+
+import 'package:universal_io/io.dart';
+
+import 'xdg_directories_web.dart' if (dart.library.io) 'xdg_directories_linux.dart';
+
+typedef EnvironmentAccessor = String? Function(String envVar);
+
+abstract class XDGDirectories {
+  factory XDGDirectories() => getXDGDirectories();
+
+  /// The base directory relative to which user-specific
+  /// non-essential (cached) data should be written. (Corresponds to
+  /// `$XDG_CACHE_HOME`).
+  ///
+  /// Throws [StateError] if the HOME environment variable is not set.
+  Directory get cacheHome;
+
+  /// The list of preference-ordered base directories relative to
+  /// which configuration files should be searched. (Corresponds to
+  /// `$XDG_CONFIG_DIRS`).
+  ///
+  /// Throws [StateError] if the HOME environment variable is not set.
+  List<Directory> get configDirs;
+
+  /// The a single base directory relative to which user-specific
+  /// configuration files should be written. (Corresponds to `$XDG_CONFIG_HOME`).
+  ///
+  /// Throws [StateError] if the HOME environment variable is not set.
+  Directory get configHome;
+
+  /// The list of preference-ordered base directories relative to
+  /// which data files should be searched. (Corresponds to `$XDG_DATA_DIRS`).
+  ///
+  /// Throws [StateError] if the HOME environment variable is not set.
+  List<Directory> get dataDirs;
+
+  /// The base directory relative to which user-specific data files should be
+  /// written. (Corresponds to `$XDG_DATA_HOME`).
+  ///
+  /// Throws [StateError] if the HOME environment variable is not set.
+  Directory get dataHome;
+
+  /// The base directory relative to which user-specific runtime
+  /// files and other file objects should be placed. (Corresponds to
+  /// `$XDG_RUNTIME_DIR`).
+  ///
+  /// Throws [StateError] if the HOME environment variable is not set.
+  Directory? get runtimeDir;
+
+  /// Gets the xdg user directory named by `dirName`.
+  ///
+  /// Use [getUserDirectoryNames] to find out the list of available names.
+  Directory? getUserDirectory(String dirName);
+
+  /// Gets the set of user directory names that xdg knows about.
+  ///
+  /// These are not paths, they are names of xdg values.  Call [getUserDirectory]
+  /// to get the associated directory.
+  ///
+  /// These are the names of the variables in "[configHome]/user-dirs.dirs", with
+  /// the `XDG_` prefix removed and the `_DIR` suffix removed.
+  Set<String> getUserDirectoryNames();
+}
@@ -0,0 +1,154 @@
+// Copyright 2020 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.
+
+library xdg_directories;
+
+import 'dart:convert';
+import 'dart:io';
+
+import 'package:path/path.dart' as path;
+import 'package:process/process.dart';
+
+import 'xdg_directories.dart';
+
+XDGDirectories getXDGDirectories() => XDGDirectoriesLinux();
+
+class XDGDirectoriesLinux implements XDGDirectories {
+  EnvironmentAccessor _getenv = (String value) => Platform.environment[value];
+
+  ProcessManager _processManager = const LocalProcessManager();
+
+  List<Directory> _directoryListFromEnvironment(String envVar, List<Directory> fallback) {
+    ArgumentError.checkNotNull(envVar);
+    ArgumentError.checkNotNull(fallback);
+    final String? value = _getenv(envVar);
+    if (value == null || value.isEmpty) {
+      return fallback;
+    }
+    return value.split(':').where((String value) {
+      return value.isNotEmpty;
+    }).map<Directory>((String entry) {
+      return Directory(entry);
+    }).toList();
+  }
+
+  Directory? _directoryFromEnvironment(String envVar) {
+    ArgumentError.checkNotNull(envVar);
+    final String? value = _getenv(envVar);
+    if (value == null || value.isEmpty) {
+      return null;
+    }
+    return Directory(value);
+  }
+
+  Directory _directoryFromEnvironmentWithFallback(String envVar, String fallback) {
+    ArgumentError.checkNotNull(envVar);
+    final String? value = _getenv(envVar);
+    if (value == null || value.isEmpty) {
+      return _getDirectory(fallback);
+    }
+    return Directory(value);
+  }
+
+// Creates a Directory from a fallback path.
+  Directory _getDirectory(String subdir) {
+    ArgumentError.checkNotNull(subdir);
+    assert(subdir.isNotEmpty);
+    final String? homeDir = _getenv('HOME');
+    if (homeDir == null || homeDir.isEmpty) {
+      throw StateError('The "HOME" environment variable is not set. This package (and POSIX) '
+          'requires that HOME be set.');
+    }
+    return Directory(path.joinAll(<String>[homeDir, subdir]));
+  }
+
+  /// The base directory relative to which user-specific
+  /// non-essential (cached) data should be written. (Corresponds to
+  /// `$XDG_CACHE_HOME`).
+  ///
+  /// Throws [StateError] if the HOME environment variable is not set.
+  Directory get cacheHome => _directoryFromEnvironmentWithFallback('XDG_CACHE_HOME', '.cache');
+
+  /// The list of preference-ordered base directories relative to
+  /// which configuration files should be searched. (Corresponds to
+  /// `$XDG_CONFIG_DIRS`).
+  ///
+  /// Throws [StateError] if the HOME environment variable is not set.
+  List<Directory> get configDirs {
+    return _directoryListFromEnvironment(
+      'XDG_CONFIG_DIRS',
+      <Directory>[Directory('/etc/xdg')],
+    );
+  }
+
+  /// The a single base directory relative to which user-specific
+  /// configuration files should be written. (Corresponds to `$XDG_CONFIG_HOME`).
+  ///
+  /// Throws [StateError] if the HOME environment variable is not set.
+  Directory get configHome => _directoryFromEnvironmentWithFallback('XDG_CONFIG_HOME', '.config');
+
+  /// The list of preference-ordered base directories relative to
+  /// which data files should be searched. (Corresponds to `$XDG_DATA_DIRS`).
+  ///
+  /// Throws [StateError] if the HOME environment variable is not set.
+  List<Directory> get dataDirs {
+    return _directoryListFromEnvironment(
+      'XDG_DATA_DIRS',
+      <Directory>[Directory('/usr/local/share'), Directory('/usr/share')],
+    );
+  }
+
+  /// The base directory relative to which user-specific data files should be
+  /// written. (Corresponds to `$XDG_DATA_HOME`).
+  ///
+  /// Throws [StateError] if the HOME environment variable is not set.
+  Directory get dataHome => _directoryFromEnvironmentWithFallback('XDG_DATA_HOME', '.local/share');
+
+  /// The base directory relative to which user-specific runtime
+  /// files and other file objects should be placed. (Corresponds to
+  /// `$XDG_RUNTIME_DIR`).
+  ///
+  /// Throws [StateError] if the HOME environment variable is not set.
+  Directory? get runtimeDir => _directoryFromEnvironment('XDG_RUNTIME_DIR');
+
+  /// Gets the xdg user directory named by `dirName`.
+  ///
+  /// Use [getUserDirectoryNames] to find out the list of available names.
+  Directory? getUserDirectory(String dirName) {
+    final ProcessResult result = _processManager.runSync(
+      <String>['xdg-user-dir', dirName],
+      includeParentEnvironment: true,
+      stdoutEncoding: utf8,
+    );
+    final String path = result.stdout.split('\n')[0];
+    return Directory(path);
+  }
+
+  /// Gets the set of user directory names that xdg knows about.
+  ///
+  /// These are not paths, they are names of xdg values.  Call [getUserDirectory]
+  /// to get the associated directory.
+  ///
+  /// These are the names of the variables in "[configHome]/user-dirs.dirs", with
+  /// the `XDG_` prefix removed and the `_DIR` suffix removed.
+  Set<String> getUserDirectoryNames() {
+    final File configFile = File(path.join(configHome.path, 'user-dirs.dirs'));
+    List<String> contents;
+    try {
+      contents = configFile.readAsLinesSync();
+    } on FileSystemException {
+      return const <String>{};
+    }
+    final Set<String> result = <String>{};
+    final RegExp dirRegExp = RegExp(r'^\s*XDG_(?<dirname>[^=]*)_DIR\s*=\s*(?<dir>.*)\s*$');
+    for (String line in contents) {
+      final RegExpMatch? match = dirRegExp.firstMatch(line);
+      if (match == null) {
+        continue;
+      }
+      result.add(match.namedGroup('dirname')!);
+    }
+    return result;
+  }
+}
@@ -0,0 +1,41 @@
+// Copyright 2020 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.
+
+library xdg_directories;
+
+import 'package:universal_io/io.dart';
+
+import 'xdg_directories.dart';
+
+XDGDirectories getXDGDirectories() => XDGDirectoriesWeb();
+
+class XDGDirectoriesWeb implements XDGDirectories {
+  @override
+  Directory get cacheHome => throw UnimplementedError();
+
+  @override
+  List<Directory> get configDirs => throw UnimplementedError();
+
+  @override
+  Directory get configHome => throw UnimplementedError();
+
+  @override
+  List<Directory> get dataDirs => throw UnimplementedError();
+
+  @override
+  Directory get dataHome => throw UnimplementedError();
+
+  @override
+  Directory? getUserDirectory(String dirName) {
+    throw UnimplementedError();
+  }
+
+  @override
+  Set<String> getUserDirectoryNames() {
+    throw UnimplementedError();
+  }
+
+  @override
+  Directory? get runtimeDir => throw UnimplementedError();
+}