XRPackageMetadata.cs
37.5 KB
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
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using UnityEngine;
using UnityEditor.PackageManager;
using UnityEditor.PackageManager.Requests;
using UnityEngine.XR.Management;
namespace UnityEditor.XR.Management.Metadata
{
/// <summary>
/// Provides an interface for describing specific loader metadata. Package authors should implement
/// this interface for each loader they provide in their package.
/// </summary>
public interface IXRLoaderMetadata
{
/// <summary>
/// The user facing name for this loader. Will be used to populate the
/// list in the XR Plug-in Management UI.
/// </summary>
string loaderName { get; }
/// <summary>
/// The full type name for this loader. This is used to allow management to find and
/// create instances of supported loaders for your package.
///
/// When your package is first installed, the XR Plug-in Management system will
/// use this information to create instances of your loaders in Assets/XR/Loaders.
/// </summary>
string loaderType { get; }
/// <summary>
/// The full list of supported buildtargets for this loader. This allows the UI to only show the
/// loaders appropriate for a specific build target.
///
/// Returning an empty list or a list containing just <a href="https://docs.unity3d.com/ScriptReference/BuildTargetGroup.Unknown.html">BuildTargetGroup.Unknown</a>. will make this
/// loader invisible in the ui.
/// </summary>
List<BuildTargetGroup> supportedBuildTargets { get; }
}
/// <summary>
/// Top level package metadata interface. Create an instance oif this interface to
/// provide metadata information for your package.
/// </summary>
public interface IXRPackageMetadata
{
/// <summary>
/// User facing package name. Should be the same as the value for the
/// displayName keyword in the package.json file.
/// </summary>
string packageName { get; }
/// <summary>
/// The package id used to track and install the package. Must be the same value
/// as the name keyword in the package.json file, otherwise installation will
/// not be possible.
/// </summary>
string packageId { get; }
/// <summary>
/// This is the full type name for the settings type for your package.
///
/// When your package is first installed, the XR Plug-in Management system will
/// use this information to create an instance of your settings in Assets/XR/Settings.
/// </summary>
string settingsType { get; }
/// <summary>
/// List of <see cref="IXRLoaderMetadata"/> instances describing the data about the loaders
/// your package supports.
/// </summary>
List<IXRLoaderMetadata> loaderMetadata { get; }
}
/// <summary>
/// Provide access to the metadata store. Currently only usable as a way to assign and remove loaders
/// to/from an <see cref="XRManagerSettings"/> instance.
/// </summary>
[InitializeOnLoad]
public class XRPackageMetadataStore
{
const string k_WaitingPackmanQuery = "XRMGT Waiting Packman Query.";
const string k_RebuildCache = "XRMGT Rebuilding Cache.";
const string k_InstallingPackage = "XRMGT Installing XR Package.";
const string k_AssigningPackage = "XRMGT Assigning XR Package.";
const string k_UninstallingPackage = "XRMGT Uninstalling XR Package.";
const string k_CachedMDStoreKey = "XR Metadata Store";
static float k_TimeOutDelta = 30f;
[Serializable]
struct KnownPackageInfo
{
public string packageId;
public string verifiedVersion;
}
[Serializable]
struct CachedMDStoreInformation
{
public bool hasAlreadyRequestedData;
public KnownPackageInfo[] knownPackageInfos;
public string[] installedPackages;
public string[] installablePackages;
}
static CachedMDStoreInformation s_CachedMDStoreInformation = new CachedMDStoreInformation()
{
hasAlreadyRequestedData = false,
knownPackageInfos = { },
installedPackages = { },
installablePackages = { },
};
static void LoadCachedMDStoreInformation()
{
string data = SessionState.GetString(k_CachedMDStoreKey, "{}");
s_CachedMDStoreInformation = JsonUtility.FromJson<CachedMDStoreInformation>(data);
}
static void StoreCachedMDStoreInformation()
{
SessionState.EraseString(k_CachedMDStoreKey);
string data = JsonUtility.ToJson(s_CachedMDStoreInformation, true);
SessionState.SetString(k_CachedMDStoreKey, data);
}
enum InstallationState
{
New,
RebuildInstalledCache,
StartInstallation,
Installing,
Assigning,
Complete,
Uninstalling,
Log
}
enum LogLevel
{
Info,
Warning,
Error
}
[Serializable]
struct LoaderAssignmentRequest
{
[SerializeField]
public string packageId;
[SerializeField]
public string loaderType;
[SerializeField]
public BuildTargetGroup buildTargetGroup;
[SerializeField]
public bool needsAddRequest;
[SerializeField]
public ListRequest packageListRequest;
[SerializeField]
public AddRequest packageAddRequest;
[SerializeField]
#pragma warning disable CS0649
public RemoveRequest packageRemoveRequest;
#pragma warning disable CS0649
[SerializeField]
public float timeOut;
[SerializeField]
public InstallationState installationState;
[SerializeField]
public string logMessage;
[SerializeField]
public LogLevel logLevel;
}
[Serializable]
struct LoaderAssignmentRequests
{
[SerializeField]
public List<LoaderAssignmentRequest> activeRequests;
}
static List<LoaderAssignmentRequest> m_AddRequests = new List<LoaderAssignmentRequest>();
static Dictionary<string, IXRPackage> s_Packages = new Dictionary<string, IXRPackage>();
static SearchRequest s_SearchRequest = null;
const string k_DefaultSessionStateString = "DEADBEEF";
static bool SessionStateHasStoredData(string queueName)
{
return SessionState.GetString(queueName, k_DefaultSessionStateString) != XRPackageMetadataStore.k_DefaultSessionStateString;
}
internal static bool isCheckingInstallationRequirements => XRPackageMetadataStore.SessionStateHasStoredData(k_WaitingPackmanQuery);
internal static bool isRebuildingCache => XRPackageMetadataStore.SessionStateHasStoredData(k_RebuildCache);
internal static bool isInstallingPackages => XRPackageMetadataStore.SessionStateHasStoredData(k_InstallingPackage);
internal static bool isUninstallingPackages => XRPackageMetadataStore.SessionStateHasStoredData(k_UninstallingPackage);
internal static bool isAssigningLoaders => XRPackageMetadataStore.SessionStateHasStoredData(k_AssigningPackage);
internal static bool isDoingQueueProcessing
{
get
{
return isCheckingInstallationRequirements || isRebuildingCache || isInstallingPackages || isUninstallingPackages || isAssigningLoaders;
}
}
internal struct LoaderBuildTargetQueryResult
{
public string packageName;
public string packageId;
public string loaderName;
public string loaderType;
}
internal static void MoveMockInListToEnd(List<LoaderBuildTargetQueryResult> loaderList)
{
int index = loaderList.FindIndex((x) => { return String.Compare(x.loaderType, KnownPackages.k_KnownPackageMockHMDLoader) == 0; });
if (index >= 0)
{
var mock = loaderList[index];
loaderList.RemoveAt(index);
loaderList.Add(mock);
}
}
internal static List<LoaderBuildTargetQueryResult> GetAllLoadersForBuildTarget(BuildTargetGroup buildTarget)
{
var ret = from pm in (from p in s_Packages.Values select p.metadata)
from lm in pm.loaderMetadata
where lm.supportedBuildTargets.Contains(buildTarget)
orderby lm.loaderName
select new LoaderBuildTargetQueryResult() { packageName = pm.packageName, packageId = pm.packageId, loaderName = lm.loaderName, loaderType = lm.loaderType };
var retList = ret.Distinct().ToList<LoaderBuildTargetQueryResult>();
MoveMockInListToEnd(retList);
return retList;
}
internal static List<LoaderBuildTargetQueryResult> GetLoadersForBuildTarget(BuildTargetGroup buildTargetGroup)
{
var ret = from pm in (from p in s_Packages.Values select p.metadata)
from lm in pm.loaderMetadata
where lm.supportedBuildTargets.Contains(buildTargetGroup)
orderby lm.loaderName
select new LoaderBuildTargetQueryResult() { packageName = pm.packageName, packageId = pm.packageId, loaderName = lm.loaderName, loaderType = lm.loaderType };
var retList = ret.ToList<LoaderBuildTargetQueryResult>();
MoveMockInListToEnd(retList);
return retList;
}
internal static IXRPackageMetadata GetMetadataForPackage(string packageId)
{
return s_Packages.Values.
Select(x => x.metadata).
FirstOrDefault(xmd => String.Compare(xmd.packageId, packageId) == 0);
}
internal static bool HasInstallablePackageData()
{
return s_CachedMDStoreInformation.installablePackages?.Any() ?? false;
}
internal static bool IsPackageInstalled(string package)
{
return (s_CachedMDStoreInformation.installedPackages?.Contains(package) ?? false)
&& File.Exists($"Packages/{package}/package.json");
}
internal static bool IsPackageInstallable(string package)
{
return s_CachedMDStoreInformation.installablePackages?.Contains(package) ?? false;
}
internal static bool IsLoaderAssigned(string loaderTypeName, BuildTargetGroup buildTargetGroup)
{
var settings = XRGeneralSettingsPerBuildTarget.XRGeneralSettingsForBuildTarget(buildTargetGroup);
if (settings == null)
return false;
foreach (var loader in settings.AssignedSettings.activeLoaders)
{
if (loader != null && String.Compare(loader.GetType().FullName, loaderTypeName) == 0)
return true;
}
return false;
}
internal static bool IsLoaderAssigned(XRManagerSettings settings, string loaderTypeName)
{
if (settings == null)
return false;
foreach (var l in settings.activeLoaders)
{
if (l != null && String.Compare(l.GetType().FullName, loaderTypeName) == 0)
return true;
}
return false;
}
internal static void InstallPackageAndAssignLoaderForBuildTarget(string package, string loaderType, BuildTargetGroup buildTargetGroup)
{
var req = new LoaderAssignmentRequest();
req.packageId = package;
req.loaderType = loaderType;
req.buildTargetGroup = buildTargetGroup;
req.installationState = InstallationState.New;
QueueLoaderRequest(req);
}
/// <summary>
/// Assigns a loader of type loaderTypeName to the settings instance. Will instantiate an
/// instance if one can't be found in the users project folder before assigning it.
/// </summary>
/// <param name="settings">An instance of <see cref="XRManagerSettings"/> to add the loader to.</param>
/// <param name="loaderTypeName">The full type name for the loader instance to assign to settings.</param>
/// <param name="buildTargetGroup">The build target group being assigned to.</param>
/// <returns>True if assignment succeeds, false if not.</returns>
public static bool AssignLoader(XRManagerSettings settings, string loaderTypeName, BuildTargetGroup buildTargetGroup)
{
if (EditorApplication.isPlaying || EditorApplication.isPaused)
{
Debug.LogError($"Attempt to add {loaderTypeName} for {buildTargetGroup} while in Play mode. XR Plug-in Management can not make changes to the loader list when running.");
return false;
}
var instance = EditorUtilities.GetInstanceOfTypeWithNameFromAssetDatabase(loaderTypeName);
if (instance == null || !(instance is XRLoader))
{
instance = EditorUtilities.CreateScriptableObjectInstance(loaderTypeName,
EditorUtilities.GetAssetPathForComponents(EditorUtilities.s_DefaultLoaderPath));
if (instance == null)
return false;
}
XRLoader newLoader = instance as XRLoader;
if (settings.TryAddLoader(newLoader))
{
var assignedLoaders = settings.activeLoaders;
var orderedLoaders = new List<XRLoader>();
var allLoaders = GetAllLoadersForBuildTarget(buildTargetGroup);
foreach (var ldr in allLoaders)
{
var newInstance = EditorUtilities.GetInstanceOfTypeWithNameFromAssetDatabase(ldr.loaderType) as XRLoader;
if (newInstance != null && assignedLoaders.Contains(newInstance))
{
orderedLoaders.Add(newInstance);
#if UNITY_EDITOR
var loaderHelper = newLoader as XRLoaderHelper;
loaderHelper?.WasAssignedToBuildTarget(buildTargetGroup);
#endif
}
}
if (!settings.TrySetLoaders(orderedLoaders))
return false;
EditorUtility.SetDirty(settings);
AssetDatabase.SaveAssets();
}
return true;
}
/// <summary>
/// Remove a previously assigned loader from settings. If the loader type is unknown or
/// an instance of the loader can't be found in the project folder no action is taken.
///
/// Removal will not delete the instance from the project folder.
/// </summary>
/// <param name="settings">An instance of <see cref="XRManagerSettings"/> to add the loader to.</param>
/// <param name="loaderTypeName">The full type name for the loader instance to remove from settings.</param>
/// <param name="buildTargetGroup">The build target group being removed from.</param>
/// <returns>True if removal succeeds, false if not.</returns>
public static bool RemoveLoader(XRManagerSettings settings, string loaderTypeName, BuildTargetGroup buildTargetGroup)
{
if (EditorApplication.isPlaying || EditorApplication.isPaused)
{
Debug.LogError($"Attempt to remove {loaderTypeName} for {buildTargetGroup} while in Play mode. XR Plug-in Management can not make changes to the loader list when running.");
return false;
}
var instance = EditorUtilities.GetInstanceOfTypeWithNameFromAssetDatabase(loaderTypeName);
if (instance == null || !(instance is XRLoader))
return false;
XRLoader loader = instance as XRLoader;
if (settings.TryRemoveLoader(loader))
{
EditorUtility.SetDirty(settings);
AssetDatabase.SaveAssets();
#if UNITY_EDITOR
var loaderHelper = loader as XRLoaderHelper;
loaderHelper?.WasUnassignedFromBuildTarget(buildTargetGroup);
#endif
return true;
}
return false;
}
internal static IXRPackage GetPackageForSettingsTypeNamed(string settingsTypeName)
{
var ret = s_Packages.Values.
Where((p => String.Compare(p.metadata.settingsType, settingsTypeName, true) == 0)).
Select((p) => p);
return ret.Any() ? ret.First() : null;
}
internal static string GetCurrentStatusDisplayText()
{
if (XRPackageMetadataStore.isCheckingInstallationRequirements)
{
return "Checking installation requirements for packages...";
}
else if (XRPackageMetadataStore.isRebuildingCache)
{
return "Querying Package Manager for currently installed packages...";
}
else if (XRPackageMetadataStore.isInstallingPackages)
{
return "Installing packages...";
}
else if (XRPackageMetadataStore.isUninstallingPackages)
{
return "Uninstalling packages...";
}
else if (XRPackageMetadataStore.isAssigningLoaders)
{
return "Assigning all requested loaders...";
}
return "";
}
internal static void AddPluginPackage(IXRPackage package)
{
if (s_CachedMDStoreInformation.installedPackages != null && !s_CachedMDStoreInformation.installedPackages.Contains(package.metadata.packageId))
{
List<string> installedPackages = s_CachedMDStoreInformation.installedPackages.ToList<string>();
installedPackages.Add(package.metadata.packageId);
s_CachedMDStoreInformation.installedPackages = installedPackages.ToArray();
StoreCachedMDStoreInformation();
}
InternalAddPluginPackage(package);
}
static void InternalAddPluginPackage(IXRPackage package)
{
s_Packages[package.metadata.packageId] = package;
}
internal static void InitKnownPluginPackages()
{
foreach (var knownPackage in KnownPackages.Packages)
{
InternalAddPluginPackage(knownPackage);
}
}
static XRPackageMetadataStore()
{
InitKnownPluginPackages();
EditorApplication.playModeStateChanged += PlayModeStateChanged;
if (IsEditorInPlayMode())
return;
AssemblyReloadEvents.afterAssemblyReload += AssemblyReloadEvents_afterAssemblyReload;
}
static void AssemblyReloadEvents_afterAssemblyReload()
{
LoadCachedMDStoreInformation();
if (!IsEditorInPlayMode())
{
if (!s_CachedMDStoreInformation.hasAlreadyRequestedData)
{
s_SearchRequest = Client.SearchAll(true);
}
RebuildInstalledCache();
StartAllQueues();
}
}
static bool IsEditorInPlayMode()
{
return EditorApplication.isPlayingOrWillChangePlaymode ||
EditorApplication.isPlaying ||
EditorApplication.isPaused;
}
static void PlayModeStateChanged(PlayModeStateChange state)
{
switch (state)
{
case PlayModeStateChange.ExitingEditMode:
StopAllQueues();
StoreCachedMDStoreInformation();
break;
case PlayModeStateChange.EnteredPlayMode:
break;
case PlayModeStateChange.EnteredEditMode:
LoadCachedMDStoreInformation();
StartAllQueues();
break;
}
}
static void StopAllQueues()
{
EditorApplication.update -= UpdateInstallablePackages;
EditorApplication.update -= WaitingOnSearchQuery;
EditorApplication.update -= MonitorPackageInstallation;
EditorApplication.update -= MonitorPackageUninstall;
EditorApplication.update -= AssignAnyRequestedLoadersUpdate;
EditorApplication.update -= RebuildCache;
}
static void StartAllQueues()
{
EditorApplication.update += UpdateInstallablePackages;
EditorApplication.update += WaitingOnSearchQuery;
EditorApplication.update += MonitorPackageInstallation;
EditorApplication.update += MonitorPackageUninstall;
EditorApplication.update += AssignAnyRequestedLoadersUpdate;
EditorApplication.update += RebuildCache;
}
static void UpdateInstallablePackages()
{
EditorApplication.update -= UpdateInstallablePackages;
if (s_SearchRequest == null || IsEditorInPlayMode() || s_CachedMDStoreInformation.hasAlreadyRequestedData)
{
return;
}
if (!s_SearchRequest.IsCompleted)
{
EditorApplication.update += UpdateInstallablePackages;
return;
}
var installablePackages = new List<string>();
var knownPackageInfos = new List<KnownPackageInfo>();
foreach (var package in s_SearchRequest.Result)
{
if (s_Packages.ContainsKey(package.name))
{
var kpi = new KnownPackageInfo();
kpi.packageId = package.name;
kpi.verifiedVersion = package.versions.verified;
if (string.IsNullOrEmpty(kpi.verifiedVersion))
kpi.verifiedVersion = package.versions.latestCompatible;
knownPackageInfos.Add(kpi);
installablePackages.Add(package.name);
}
}
s_CachedMDStoreInformation.knownPackageInfos = knownPackageInfos.ToArray();
s_CachedMDStoreInformation.installablePackages = installablePackages.ToArray();
s_CachedMDStoreInformation.hasAlreadyRequestedData = true;
s_SearchRequest = null;
StoreCachedMDStoreInformation();
}
static void AddRequestToQueue(LoaderAssignmentRequest request, string queueName)
{
LoaderAssignmentRequests reqs;
if (XRPackageMetadataStore.SessionStateHasStoredData(queueName))
{
string fromJson = SessionState.GetString(queueName, k_DefaultSessionStateString);
reqs = JsonUtility.FromJson<LoaderAssignmentRequests>(fromJson);
}
else
{
reqs = new LoaderAssignmentRequests();
reqs.activeRequests = new List<LoaderAssignmentRequest>();
}
reqs.activeRequests.Add(request);
string json = JsonUtility.ToJson(reqs);
SessionState.SetString(queueName, json);
}
static void SetRequestsInQueue(LoaderAssignmentRequests reqs, string queueName)
{
string json = JsonUtility.ToJson(reqs);
SessionState.SetString(queueName, json);
}
static LoaderAssignmentRequests GetAllRequestsInQueue(string queueName)
{
var reqs = new LoaderAssignmentRequests();
reqs.activeRequests = new List<LoaderAssignmentRequest>();
if (XRPackageMetadataStore.SessionStateHasStoredData(queueName))
{
string fromJson = SessionState.GetString(queueName, k_DefaultSessionStateString);
reqs = JsonUtility.FromJson<LoaderAssignmentRequests>(fromJson);
SessionState.EraseString(queueName);
}
return reqs;
}
internal static void RebuildInstalledCache()
{
if (isRebuildingCache)
return;
var req = new LoaderAssignmentRequest();
req.packageListRequest = Client.List(true, false);
req.installationState = InstallationState.RebuildInstalledCache;
req.timeOut = Time.realtimeSinceStartup + k_TimeOutDelta;
QueueLoaderRequest(req);
}
static void RebuildCache()
{
EditorApplication.update -= RebuildCache;
if (IsEditorInPlayMode())
{
return; // Use the cached data that should have been passed in the play state change.
}
LoaderAssignmentRequests reqs = GetAllRequestsInQueue(k_RebuildCache);
if (reqs.activeRequests == null || reqs.activeRequests.Count == 0)
{
return;
}
var req = reqs.activeRequests[0];
reqs.activeRequests.Remove(req);
if (req.timeOut < Time.realtimeSinceStartup)
{
req.logMessage = $"Timeout trying to get package list after {k_TimeOutDelta}s.";
req.logLevel = LogLevel.Warning;
req.installationState = InstallationState.Log;
QueueLoaderRequest(req);
}
else if (req.packageListRequest.IsCompleted)
{
if (req.packageListRequest.Status == StatusCode.Success)
{
var installedPackages = new List<string>();
foreach (var packageInfo in req.packageListRequest.Result)
{
installedPackages.Add(packageInfo.name);
}
var packageIds = s_Packages.Values.
Where((p) => installedPackages.Contains(p.metadata.packageId)).
Select((p) => p.metadata.packageId);
s_CachedMDStoreInformation.installedPackages = packageIds.ToArray();
}
StoreCachedMDStoreInformation();
}
else if (!req.packageListRequest.IsCompleted)
{
QueueLoaderRequest(req);
}
else
{
req.logMessage = $"Unable to rebuild installed package cache. Some state may be missing or incorrect.";
req.logLevel = LogLevel.Warning;
req.installationState = InstallationState.Log;
QueueLoaderRequest(req);
}
if (reqs.activeRequests.Count > 0)
{
SetRequestsInQueue(reqs, k_RebuildCache);
EditorApplication.update += RebuildCache;
}
}
static void ResetManagerUiIfAvailable()
{
if (XRSettingsManager.Instance != null) XRSettingsManager.Instance.ResetUi = true;
}
static void AssignAnyRequestedLoadersUpdate()
{
EditorApplication.update -= AssignAnyRequestedLoadersUpdate;
LoaderAssignmentRequests reqs = GetAllRequestsInQueue(k_AssigningPackage);
if (reqs.activeRequests == null || reqs.activeRequests.Count == 0)
return;
while (reqs.activeRequests.Count > 0)
{
var req = reqs.activeRequests[0];
reqs.activeRequests.RemoveAt(0);
var settings = XRGeneralSettingsPerBuildTarget.XRGeneralSettingsForBuildTarget(req.buildTargetGroup);
if (settings == null)
continue;
if (settings.AssignedSettings == null)
{
var assignedSettings = ScriptableObject.CreateInstance<XRManagerSettings>() as XRManagerSettings;
settings.AssignedSettings = assignedSettings;
EditorUtility.SetDirty(settings);
}
if (!XRPackageMetadataStore.AssignLoader(settings.AssignedSettings, req.loaderType, req.buildTargetGroup))
{
req.installationState = InstallationState.Log;
req.logMessage = $"Unable to assign {req.packageId} for build target {req.buildTargetGroup}.";
req.logLevel = LogLevel.Error;
QueueLoaderRequest(req);
}
}
ResetManagerUiIfAvailable();
}
internal static void AssignAnyRequestedLoaders()
{
EditorApplication.update += AssignAnyRequestedLoadersUpdate;
}
static void MonitorPackageInstallation()
{
EditorApplication.update -= MonitorPackageInstallation;
LoaderAssignmentRequests reqs = GetAllRequestsInQueue(k_InstallingPackage);
if (reqs.activeRequests.Count > 0)
{
var request = reqs.activeRequests[0];
reqs.activeRequests.RemoveAt(0);
if (request.needsAddRequest)
{
var versionToInstallQ = s_CachedMDStoreInformation.knownPackageInfos.
Where((kpi) => String.Compare(request.packageId, kpi.packageId) == 0).
Select((kpi) => kpi.verifiedVersion);
var versionToInstall = versionToInstallQ.FirstOrDefault();
var packageToInstall = String.IsNullOrEmpty(versionToInstall) ?
request.packageId :
$"{request.packageId}@{versionToInstall}";
request.packageAddRequest = Client.Add(packageToInstall);
request.needsAddRequest = false;
request.installationState = InstallationState.Installing;
s_CachedMDStoreInformation.hasAlreadyRequestedData = true;
StoreCachedMDStoreInformation();
QueueLoaderRequest(request);
}
else if (request.packageAddRequest.IsCompleted && File.Exists($"Packages/{request.packageId}/package.json"))
{
if (request.packageAddRequest.Status == StatusCode.Success)
{
if (!String.IsNullOrEmpty(request.loaderType))
{
request.packageAddRequest = null;
request.installationState = InstallationState.Assigning;
QueueLoaderRequest(request);
}
else
{
request.logMessage = $"Missing loader type. Unable to assign loader.";
request.logLevel = LogLevel.Error;
request.installationState = InstallationState.Log;
QueueLoaderRequest(request);
}
}
}
else if (request.packageAddRequest.IsCompleted && request.packageAddRequest.Status != StatusCode.Success)
{
if (String.IsNullOrEmpty(request.packageId))
{
request.logMessage = $"Error installing package with no package id.";
}
else
{
request.logMessage = $"Error Message: {request.packageAddRequest?.Error?.message ?? "UNKNOWN" }.\nError installing package {request.packageId ?? "UNKNOWN PACKAGE ID" }.";
}
request.logLevel = LogLevel.Error;
request.installationState = InstallationState.Log;
QueueLoaderRequest(request);
}
else if (request.timeOut < Time.realtimeSinceStartup)
{
if (String.IsNullOrEmpty(request.packageId))
{
request.logMessage = $"Time out while installing pacakge with no package id.";
}
else
{
request.logMessage = $"Error installing package {request.packageId}. Package installation timed out. Check Package Manager UI to see if the package is installed and/or retry your operation.";
}
request.logLevel = LogLevel.Error;
if (request.packageAddRequest.IsCompleted)
{
request.logMessage += $" Error message: {request.packageAddRequest.Error.message}";
}
request.installationState = InstallationState.Log;
QueueLoaderRequest(request);
}
else
{
QueueLoaderRequest(request);
}
}
}
static void WaitingOnSearchQuery()
{
EditorApplication.update -= WaitingOnSearchQuery;
if (s_SearchRequest != null)
{
if (s_SearchRequest.IsCompleted)
EditorApplication.update += UpdateInstallablePackages;
else
EditorApplication.update += WaitingOnSearchQuery;
return;
}
LoaderAssignmentRequests reqs = GetAllRequestsInQueue(k_WaitingPackmanQuery);
if (reqs.activeRequests.Count > 0)
{
for (int i = 0; i < reqs.activeRequests.Count; i++)
{
var req = reqs.activeRequests[i];
req.installationState = IsPackageInstalled(req.packageId) ? InstallationState.Assigning : InstallationState.StartInstallation;
req.timeOut = Time.realtimeSinceStartup + k_TimeOutDelta;
QueueLoaderRequest(req);
}
}
}
static void MonitorPackageUninstall()
{
EditorApplication.update -= MonitorPackageUninstall;
LoaderAssignmentRequests reqs = GetAllRequestsInQueue(k_UninstallingPackage);
if (reqs.activeRequests.Count > 0)
{
for (int i = 0; i < reqs.activeRequests.Count; i++)
{
var req = reqs.activeRequests[i];
if (!req.packageRemoveRequest.IsCompleted)
QueueLoaderRequest(req);
if (req.packageRemoveRequest.Status == StatusCode.Failure)
{
req.installationState = InstallationState.Log;
req.logMessage = req.packageRemoveRequest.Error.message;
req.logLevel = LogLevel.Warning;
QueueLoaderRequest(req);
}
}
}
}
static void QueueLoaderRequest(LoaderAssignmentRequest req)
{
switch (req.installationState)
{
case InstallationState.New:
if (!s_CachedMDStoreInformation.hasAlreadyRequestedData && !HasInstallablePackageData() && s_SearchRequest == null)
{
s_SearchRequest = Client.SearchAll(false);
EditorApplication.update += UpdateInstallablePackages;
}
AddRequestToQueue(req, k_WaitingPackmanQuery);
EditorApplication.update += WaitingOnSearchQuery;
break;
case InstallationState.RebuildInstalledCache:
AddRequestToQueue(req, k_RebuildCache);
EditorApplication.update += RebuildCache;
break;
case InstallationState.StartInstallation:
req.needsAddRequest = true;
req.packageAddRequest = null;
req.timeOut = Time.realtimeSinceStartup + k_TimeOutDelta;
AddRequestToQueue(req, k_InstallingPackage);
EditorApplication.update += MonitorPackageInstallation;
break;
case InstallationState.Installing:
AddRequestToQueue(req, k_InstallingPackage);
EditorApplication.update += MonitorPackageInstallation;
break;
case InstallationState.Assigning:
AddRequestToQueue(req, k_AssigningPackage);
EditorApplication.update += AssignAnyRequestedLoadersUpdate;
break;
case InstallationState.Uninstalling:
AddRequestToQueue(req, k_UninstallingPackage);
EditorApplication.update += MonitorPackageUninstall;
break;
case InstallationState.Log:
const string header = "XR Plug-in Management";
switch(req.logLevel)
{
case LogLevel.Info:
Debug.Log($"{header}: {req.logMessage}");
break;
case LogLevel.Warning:
Debug.LogWarning($"{header} Warning: {req.logMessage}");
break;
case LogLevel.Error:
Debug.LogError($"{header} error. Failure reason: {req.logMessage}.\n Check if there are any other errors in the console and make sure they are corrected before trying again.");
break;
}
ResetManagerUiIfAvailable();
break;
}
}
}
}