1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
// Copyright 2014 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 'package:process/process.dart';
import 'package:xml/xml.dart';
import '../base/file_system.dart';
import '../base/io.dart';
import '../base/logger.dart';
import '../base/process.dart';
import '../convert.dart';
class PlistParser {
PlistParser({
required FileSystem fileSystem,
required Logger logger,
required ProcessManager processManager,
}) : _fileSystem = fileSystem,
_logger = logger,
_processUtils = ProcessUtils(logger: logger, processManager: processManager);
final FileSystem _fileSystem;
final Logger _logger;
final ProcessUtils _processUtils;
// info.pList keys
static const String kCFBundleIdentifierKey = 'CFBundleIdentifier';
static const String kCFBundleShortVersionStringKey = 'CFBundleShortVersionString';
static const String kCFBundleExecutableKey = 'CFBundleExecutable';
static const String kCFBundleVersionKey = 'CFBundleVersion';
static const String kCFBundleDisplayNameKey = 'CFBundleDisplayName';
static const String kCFBundleNameKey = 'CFBundleName';
static const String kFLTEnableImpellerKey = 'FLTEnableImpeller';
static const String kMinimumOSVersionKey = 'MinimumOSVersion';
static const String kNSPrincipalClassKey = 'NSPrincipalClass';
// entitlement file keys
static const String kAssociatedDomainsKey = 'com.apple.developer.associated-domains';
static const String _plutilExecutable = '/usr/bin/plutil';
/// Returns the content, converted to XML, of the plist file located at
/// [plistFilePath].
///
/// If [plistFilePath] points to a non-existent file or a file that's not a
/// valid property list file, this will return null.
String? plistXmlContent(String plistFilePath) {
if (!_fileSystem.isFileSync(_plutilExecutable)) {
throw const FileNotFoundException(_plutilExecutable);
}
final List<String> args = <String>[
_plutilExecutable, '-convert', 'xml1', '-o', '-', plistFilePath,
];
try {
final String xmlContent = _processUtils.runSync(
args,
throwOnError: true,
).stdout.trim();
return xmlContent;
} on ProcessException catch (error) {
_logger.printError('$error');
return null;
}
}
/// Replaces the string key in the given plist file with the given value.
///
/// If the value is null, then the key will be removed.
///
/// Returns true if successful.
bool replaceKey(String plistFilePath, {required String key, String? value }) {
if (!_fileSystem.isFileSync(_plutilExecutable)) {
throw const FileNotFoundException(_plutilExecutable);
}
final List<String> args;
if (value == null) {
args = <String>[
_plutilExecutable, '-remove', key, plistFilePath,
];
} else {
args = <String>[
_plutilExecutable, '-replace', key, '-string', value, plistFilePath,
];
}
try {
_processUtils.runSync(
args,
throwOnError: true,
);
} on ProcessException catch (error) {
_logger.printError('$error');
return false;
}
return true;
}
/// Parses the plist file located at [plistFilePath] and returns the
/// associated map of key/value property list pairs.
///
/// If [plistFilePath] points to a non-existent file or a file that's not a
/// valid property list file, this will return an empty map.
Map<String, Object> parseFile(String plistFilePath) {
if (!_fileSystem.isFileSync(plistFilePath)) {
return const <String, Object>{};
}
final String normalizedPlistPath = _fileSystem.path.absolute(plistFilePath);
final String? xmlContent = plistXmlContent(normalizedPlistPath);
if (xmlContent == null) {
return const <String, Object>{};
}
return _parseXml(xmlContent);
}
Map<String, Object> _parseXml(String xmlContent) {
final XmlDocument document = XmlDocument.parse(xmlContent);
// First element child is <plist>. The first element child of plist is <dict>.
final XmlElement dictObject = document.firstElementChild!.firstElementChild!;
return _parseXmlDict(dictObject);
}
Map<String, Object> _parseXmlDict(XmlElement node) {
String? lastKey;
final Map<String, Object> result = <String, Object>{};
for (final XmlNode child in node.children) {
if (child is XmlElement) {
if (child.name.local == 'key') {
lastKey = child.innerText;
} else {
assert(lastKey != null);
result[lastKey!] = _parseXmlNode(child)!;
lastKey = null;
}
}
}
return result;
}
static final RegExp _nonBase64Pattern = RegExp('[^a-zA-Z0-9+/=]+');
Object? _parseXmlNode(XmlElement node) {
switch (node.name.local){
case 'string':
return node.innerText;
case 'real':
return double.parse(node.innerText);
case 'integer':
return int.parse(node.innerText);
case 'true':
return true;
case 'false':
return false;
case 'date':
return DateTime.parse(node.innerText);
case 'data':
return base64.decode(node.innerText.replaceAll(_nonBase64Pattern, ''));
case 'array':
return node.children.whereType<XmlElement>().map<Object?>(_parseXmlNode).whereType<Object>().toList();
case 'dict':
return _parseXmlDict(node);
}
return null;
}
/// Parses the Plist file located at [plistFilePath] and returns the value
/// that's associated with the specified [key] within the property list.
///
/// If [plistFilePath] points to a non-existent file or a file that's not a
/// valid property list file, this will return null.
///
/// If [key] is not found in the property list, this will return null.
T? getValueFromFile<T>(String plistFilePath, String key) {
final Map<String, dynamic> parsed = parseFile(plistFilePath);
return parsed[key] as T?;
}
}