This repository has been archived by the owner on Oct 30, 2019. It is now read-only.
forked from MonoGame/MonoGame
-
Notifications
You must be signed in to change notification settings - Fork 37
/
StorageDevice.cs
402 lines (348 loc) · 10.1 KB
/
StorageDevice.cs
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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
#region License
/* FNA - XNA4 Reimplementation for Desktop Platforms
* Copyright 2009-2014 Ethan Lee and the MonoGame Team
*
* Released under the Microsoft Public License.
* See LICENSE for details.
*/
#endregion
#region Using Statements
using System;
using System.IO;
using System.Runtime.Remoting.Messaging;
#endregion
namespace Microsoft.Xna.Framework.Storage
{
/// <summary>
/// Exposes a storage device for storing user data.
/// </summary>
/// <remarks>
/// MSDN documentation contains related conceptual article:
/// http://msdn.microsoft.com/en-us/library/bb200105.aspx
/// </remarks>
public sealed class StorageDevice
{
#region Public Properties
/// <summary>
/// Returns the amount of free space.
/// </summary>
public long FreeSpace
{
get
{
try
{
return new DriveInfo(storageRoot).AvailableFreeSpace;
}
catch
{
// Storage root was invalid or unavailable.
return 0;
}
}
}
/// <summary>
/// Returns true if this StorageDevice path is accessible, false otherwise.
/// </summary>
public bool IsConnected
{
get
{
if ( Game.Instance.Platform.OSVersion.Equals("Linux") ||
Game.Instance.Platform.OSVersion.Equals("Mac OS X") )
{
/* Linux and Mac use locally connected storage in the user's
* home location, which should always be "connected".
*/
return true;
}
else if (Game.Instance.Platform.OSVersion.Equals("Windows"))
{
try
{
return new DriveInfo(storageRoot).IsReady;
}
catch
{
// The storageRoot path is invalid / has been removed.
return false;
}
}
throw new Exception("StorageDevice: Platform.OSVersion not handled!");
}
}
/// <summary>
/// Returns the total size of device.
/// </summary>
public long TotalSpace
{
get
{
try
{
return new DriveInfo(storageRoot).TotalSize;
}
catch
{
// Storage root is invalid or removed.
return 0;
}
}
}
#endregion
#region Internal Variables
internal static readonly string storageRoot = GetStorageRoot();
#endregion
#region Private Variables
private PlayerIndex? devicePlayer;
private StorageContainer deviceContainer;
#endregion
#region Events
/// <summary>
/// Fired when a device is removed or inserted.
/// </summary>
public static event EventHandler<EventArgs> DeviceChanged;
private void OnDeviceChanged()
{
if (DeviceChanged != null)
{
DeviceChanged(this, null);
}
}
#endregion
#region Private Delegates
private delegate StorageDevice ShowSelectorAsynchronous(
PlayerIndex? player,
int sizeInBytes,
int directoryCount
);
private delegate StorageContainer OpenContainerAsynchronous(string displayName);
#endregion
#region Internal Constructors
/// <summary>
/// Creates a new <see cref="StorageDevice"/> instance.
/// </summary>
/// <param name="player">The playerIndex of the player.</param>
/// <param name="sizeInBytes">Size of the storage device.</param>
/// <param name="directoryCount"></param>
internal StorageDevice(PlayerIndex? player, int sizeInBytes, int directoryCount)
{
devicePlayer = player;
}
#endregion
#region Public OpenContainer Methods
/// <summary>
/// Begins the open for a StorageContainer.
/// </summary>
/// <returns>The open StorageContainer.</returns>
/// <param name="displayName">Name of file.</param>
/// <param name="callback">Method to call on completion.</param>
/// <param name="state">Request identifier object for callback (can be null).</param>
public IAsyncResult BeginOpenContainer(
string displayName,
AsyncCallback callback,
object state
) {
try
{
OpenContainerAsynchronous AsynchronousOpen = new OpenContainerAsynchronous(Open);
return AsynchronousOpen.BeginInvoke(displayName, callback, state);
}
finally
{
// TODO: No resources to clean up? Remove this finally block?
}
}
/// <summary>
/// Ends the open container process.
/// </summary>
/// <returns>The open StorageContainer.</returns>
/// <param name="result">Result of BeginOpenContainer.</param>
public StorageContainer EndOpenContainer(IAsyncResult result)
{
StorageContainer returnValue = null;
try
{
// Retrieve the delegate.
AsyncResult asyncResult = result as AsyncResult;
if (asyncResult != null)
{
OpenContainerAsynchronous asyncDelegate = asyncResult.AsyncDelegate
as OpenContainerAsynchronous;
// Wait for the WaitHandle to become signaled.
result.AsyncWaitHandle.WaitOne();
// Call EndInvoke to retrieve the results.
if (asyncDelegate != null)
{
returnValue = asyncDelegate.EndInvoke(result);
}
}
}
finally
{
// Close the wait handle.
result.AsyncWaitHandle.Dispose();
}
return returnValue;
}
#endregion
#region Public ShowSelector Methods
/// <summary>
/// Begin process to display the StorageDevice selector UI.
/// </summary>
/// <returns>The show selector.</returns>
/// <param name="callback">Method to invoke when device is selected by player.</param>
/// <param name="state">Request identifier object for callback (can be null).</param>
public static IAsyncResult BeginShowSelector(
AsyncCallback callback,
object state
) {
return BeginShowSelector(
0,
0,
callback,
state
);
}
/// <summary>
/// Begin process to display the StorageDevice selector UI.
/// </summary>
/// <returns>The show selector.</returns>
/// <param name="player">The PlayerIndex. Only PlayerIndex.One is valid on Windows.</param>
/// <param name="callback">Method to invoke when device is selected by player.</param>
/// <param name="state">Request identifier object for callback (can be null).</param>
public static IAsyncResult BeginShowSelector(
PlayerIndex player,
AsyncCallback callback,
object state
) {
return BeginShowSelector(
player,
0,
0,
callback,
state
);
}
/// <summary>
/// Begin process to display the StorageDevice selector UI.
/// </summary>
/// <returns>The show selector.</returns>
/// <param name="sizeInBytes">Size (in bytes) of data to write.</param>
/// <param name="directoryCount">Number of directories to write.</param>
/// <param name="callback">Method to invoke when device is selected by player.</param>
/// <param name="state">Request identifier object for callback (can be null).</param>
public static IAsyncResult BeginShowSelector(
int sizeInBytes,
int directoryCount,
AsyncCallback callback,
object state
) {
ShowSelectorAsynchronous del = new ShowSelectorAsynchronous(Show);
return del.BeginInvoke(null, sizeInBytes, directoryCount, callback, state);
}
/// <summary>
/// Begin process to display the StorageDevice selector UI.
/// </summary>
/// <returns>The show selector.</returns>
/// <param name="player">The PlayerIndex. Only PlayerIndex.One is valid on Windows.</param>
/// <param name="sizeInBytes">Size (in bytes) of data to write.</param>
/// <param name="directoryCount">Number of directories to write.</param>
/// <param name="callback">Method to invoke when device is selected by player.</param>
/// <param name="state">Request identifier object for callback (can be null).</param>
public static IAsyncResult BeginShowSelector(
PlayerIndex player,
int sizeInBytes,
int directoryCount,
AsyncCallback callback,
object state
) {
ShowSelectorAsynchronous del = new ShowSelectorAsynchronous(Show);
return del.BeginInvoke(player, sizeInBytes, directoryCount, callback, state);
}
/// <summary>
/// Ends the show selector user interface display.
/// </summary>
/// <returns>The storage device.</returns>
/// <param name="result">The result of BeginShowSelector.</param>
public static StorageDevice EndShowSelector(IAsyncResult result)
{
if (!result.IsCompleted)
{
// Wait for the WaitHandle to become signaled.
try
{
result.AsyncWaitHandle.WaitOne();
}
finally
{
}
}
// Retrieve the delegate.
AsyncResult asyncResult = (AsyncResult) result;
ShowSelectorAsynchronous del = asyncResult.AsyncDelegate as ShowSelectorAsynchronous;
if (del != null)
{
return del.EndInvoke(result);
}
throw new ArgumentException("result");
}
#endregion
#region Public StorageContainer Delete Method
public void DeleteContainer(string titleName)
{
throw new NotImplementedException();
}
#endregion
#region Private OpenContainer Async Method
// Private method to handle the creation of the StorageDevice.
private StorageContainer Open(string displayName)
{
deviceContainer = new StorageContainer(this, displayName, devicePlayer);
return deviceContainer;
}
#endregion
#region Private ShowSelector Async Method
// Private method to handle the creation of the StorageDevice.
private static StorageDevice Show(PlayerIndex? player, int sizeInBytes, int directoryCount)
{
return new StorageDevice(player, sizeInBytes, directoryCount);
}
#endregion
#region Private Static OS User Directory Path Method
private static string GetStorageRoot()
{
if (Game.Instance.Platform.OSVersion.Equals("Windows"))
{
return Environment.GetFolderPath(Environment.SpecialFolder.MyDocuments);
}
if (Game.Instance.Platform.OSVersion.Equals("Mac OS X"))
{
string osConfigDir = Environment.GetEnvironmentVariable("HOME");
if (String.IsNullOrEmpty(osConfigDir))
{
return "."; // Oh well.
}
osConfigDir += "/Library/Application Support";
return osConfigDir;
}
if (Game.Instance.Platform.OSVersion.Equals("Linux"))
{
// Assuming a non-OSX Unix platform will follow the XDG. Which it should.
string osConfigDir = Environment.GetEnvironmentVariable("XDG_DATA_HOME");
if (String.IsNullOrEmpty(osConfigDir))
{
osConfigDir = Environment.GetEnvironmentVariable("HOME");
if (String.IsNullOrEmpty(osConfigDir))
{
return "."; // Oh well.
}
osConfigDir += "/.local/share";
}
return osConfigDir;
}
throw new Exception("StorageDevice: Platform.OSVersion not handled!");
}
#endregion
}
}