-
Notifications
You must be signed in to change notification settings - Fork 942
/
MasterNodeManager.cs
3320 lines (2853 loc) · 127 KB
/
MasterNodeManager.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
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
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* ========================================================================
* Copyright (c) 2005-2020 The OPC Foundation, Inc. All rights reserved.
*
* OPC Foundation MIT License 1.00
*
* Permission is hereby granted, free of charge, to any person
* obtaining a copy of this software and associated documentation
* files (the "Software"), to deal in the Software without
* restriction, including without limitation the rights to use,
* copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following
* conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
*
* The complete license agreement can be found here:
* http://opcfoundation.org/License/MIT/1.00/
* ======================================================================*/
using System;
using System.Collections.Generic;
using System.Text;
using System.Diagnostics;
namespace Opc.Ua.Server
{
/// <summary>
/// The master node manager for the server.
/// </summary>
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Maintainability", "CA1506:AvoidExcessiveClassCoupling")]
public class MasterNodeManager : IDisposable
{
#region Constructors
/// <summary>
/// Initializes the object with default values.
/// </summary>
public MasterNodeManager(
IServerInternal server,
ApplicationConfiguration configuration,
string dynamicNamespaceUri,
params INodeManager[] additionalManagers)
{
if (server == null) throw new ArgumentNullException(nameof(server));
if (configuration == null) throw new ArgumentNullException(nameof(configuration));
m_server = server;
m_nodeManagers = new List<INodeManager>();
m_maxContinuationPointsPerBrowse = (uint)configuration.ServerConfiguration.MaxBrowseContinuationPoints;
// ensure the dynamic namespace uris.
int dynamicNamespaceIndex = 1;
if (!String.IsNullOrEmpty(dynamicNamespaceUri))
{
dynamicNamespaceIndex = server.NamespaceUris.GetIndex(dynamicNamespaceUri);
if (dynamicNamespaceIndex == -1)
{
dynamicNamespaceIndex = server.NamespaceUris.Append(dynamicNamespaceUri);
}
}
// need to build a table of NamespaceIndexes and their NodeManagers.
List<INodeManager> registeredManagers = null;
Dictionary<int, List<INodeManager>> namespaceManagers = new Dictionary<int, List<INodeManager>>();
namespaceManagers[0] = registeredManagers = new List<INodeManager>();
namespaceManagers[1] = registeredManagers = new List<INodeManager>();
// always add the diagnostics and configuration node manager to the start of the list.
ConfigurationNodeManager configurationAndDiagnosticsManager = new ConfigurationNodeManager(server, configuration);
RegisterNodeManager(configurationAndDiagnosticsManager, registeredManagers, namespaceManagers);
// add the core node manager second because the diagnostics node manager takes priority.
// always add the core node manager to the second of the list.
m_nodeManagers.Add(new CoreNodeManager(m_server, configuration, (ushort)dynamicNamespaceIndex));
// register core node manager for default UA namespace.
namespaceManagers[0].Add(m_nodeManagers[1]);
// register core node manager for built-in server namespace.
namespaceManagers[1].Add(m_nodeManagers[1]);
// add the custom NodeManagers provided by the application.
if (additionalManagers != null)
{
foreach (INodeManager nodeManager in additionalManagers)
{
RegisterNodeManager(nodeManager, registeredManagers, namespaceManagers);
}
// build table from dictionary.
m_namespaceManagers = new INodeManager[m_server.NamespaceUris.Count][];
for (int ii = 0; ii < m_namespaceManagers.Length; ii++)
{
if (namespaceManagers.TryGetValue(ii, out registeredManagers))
{
m_namespaceManagers[ii] = registeredManagers.ToArray();
}
}
}
}
/// <summary>
/// Registers the node manager with the master node manager.
/// </summary>
private void RegisterNodeManager(
INodeManager nodeManager,
List<INodeManager> registeredManagers,
Dictionary<int, List<INodeManager>> namespaceManagers)
{
m_nodeManagers.Add(nodeManager);
// ensure the NamespaceUris supported by the NodeManager are in the Server's NamespaceTable.
if (nodeManager.NamespaceUris != null)
{
foreach (string namespaceUri in nodeManager.NamespaceUris)
{
// look up the namespace uri.
int index = m_server.NamespaceUris.GetIndex(namespaceUri);
if (index == -1)
{
index = m_server.NamespaceUris.Append(namespaceUri);
}
// add manager to list for the namespace.
if (!namespaceManagers.TryGetValue(index, out registeredManagers))
{
namespaceManagers[index] = registeredManagers = new List<INodeManager>();
}
registeredManagers.Add(nodeManager);
}
}
}
#endregion
#region IDisposable Members
/// <summary>
/// Frees any unmanaged resources.
/// </summary>
public void Dispose()
{
Dispose(true);
}
/// <summary>
/// An overrideable version of the Dispose.
/// </summary>
protected virtual void Dispose(bool disposing)
{
if (disposing)
{
List<INodeManager> nodeManagers = null;
lock (m_lock)
{
nodeManagers = new List<INodeManager>(m_nodeManagers);
m_nodeManagers.Clear();
}
foreach (INodeManager nodeManager in nodeManagers)
{
Utils.SilentDispose(nodeManager);
}
}
}
#endregion
#region Static Methods
/// <summary>
/// Adds a reference to the table of external references.
/// </summary>
/// <remarks>
/// This is a convenience function used by custom NodeManagers.
/// </remarks>
public static void CreateExternalReference(
IDictionary<NodeId, IList<IReference>> externalReferences,
NodeId sourceId,
NodeId referenceTypeId,
bool isInverse,
NodeId targetId)
{
ReferenceNode reference = new ReferenceNode();
reference.ReferenceTypeId = referenceTypeId;
reference.IsInverse = isInverse;
reference.TargetId = targetId;
IList<IReference> references = null;
if (!externalReferences.TryGetValue(sourceId, out references))
{
externalReferences[sourceId] = references = new List<IReference>();
}
references.Add(reference);
}
/// <summary>
/// Determine the required history access permission depending on the HistoryUpdateDetails
/// </summary>
/// <param name="historyUpdateDetails">The HistoryUpdateDetails passed in</param>
/// <returns>The corresponding history access permission</returns>
protected static PermissionType DetermineHistoryAccessPermission(HistoryUpdateDetails historyUpdateDetails)
{
Type detailsType = historyUpdateDetails.GetType();
if (detailsType == typeof(UpdateDataDetails))
{
UpdateDataDetails updateDataDetails = (UpdateDataDetails)historyUpdateDetails;
return GetHistoryPermissionType(updateDataDetails.PerformInsertReplace);
}
else if (detailsType == typeof(UpdateStructureDataDetails))
{
UpdateStructureDataDetails updateStructureDataDetails = (UpdateStructureDataDetails)historyUpdateDetails;
return GetHistoryPermissionType(updateStructureDataDetails.PerformInsertReplace);
}
else if (detailsType == typeof(UpdateEventDetails))
{
UpdateEventDetails updateEventDetails = (UpdateEventDetails)historyUpdateDetails;
return GetHistoryPermissionType(updateEventDetails.PerformInsertReplace);
}
else if (detailsType == typeof(DeleteRawModifiedDetails) ||
detailsType == typeof(DeleteAtTimeDetails) ||
detailsType == typeof(DeleteEventDetails))
{
return PermissionType.DeleteHistory;
}
return PermissionType.ModifyHistory;
}
/// <summary>
/// Determine the History PermissionType depending on PerformUpdateType
/// </summary>
/// <param name="updateType"></param>
/// <returns>The corresponding PermissionType</returns>
protected static PermissionType GetHistoryPermissionType(PerformUpdateType updateType)
{
switch (updateType)
{
case PerformUpdateType.Insert:
return PermissionType.InsertHistory;
case PerformUpdateType.Update:
return PermissionType.InsertHistory | PermissionType.ModifyHistory;
default: // PerformUpdateType.Replace or PerformUpdateType.Remove
return PermissionType.ModifyHistory;
}
}
#endregion
#region Public Interface
/// <summary>
/// Returns the core node manager.
/// </summary>
public CoreNodeManager CoreNodeManager
{
get
{
return m_nodeManagers[1] as CoreNodeManager;
}
}
/// <summary>
/// Returns the diagnostics node manager.
/// </summary>
public DiagnosticsNodeManager DiagnosticsNodeManager
{
get
{
return m_nodeManagers[0] as DiagnosticsNodeManager;
}
}
/// <summary>
/// Returns the configuration node manager.
/// </summary>
public ConfigurationNodeManager ConfigurationNodeManager
{
get
{
return m_nodeManagers[0] as ConfigurationNodeManager;
}
}
/// <summary>
/// Creates the node managers and start them
/// </summary>
public virtual void Startup()
{
lock (m_lock)
{
Utils.LogInfo(
Utils.TraceMasks.StartStop,
"MasterNodeManager.Startup - NodeManagers={0}",
m_nodeManagers.Count);
// create the address spaces.
Dictionary<NodeId, IList<IReference>> externalReferences = new Dictionary<NodeId, IList<IReference>>();
for (int ii = 0; ii < m_nodeManagers.Count; ii++)
{
INodeManager nodeManager = m_nodeManagers[ii];
try
{
nodeManager.CreateAddressSpace(externalReferences);
}
catch (Exception e)
{
Utils.LogError(e, "Unexpected error creating address space for NodeManager #{0}.", ii);
}
}
// update external references.
for (int ii = 0; ii < m_nodeManagers.Count; ii++)
{
INodeManager nodeManager = m_nodeManagers[ii];
try
{
nodeManager.AddReferences(externalReferences);
}
catch (Exception e)
{
Utils.LogError(e, "Unexpected error adding references for NodeManager #{0}.", ii);
}
}
}
}
/// <summary>
/// Signals that a session is closing.
/// </summary>
public virtual void SessionClosing(OperationContext context, NodeId sessionId, bool deleteSubscriptions)
{
lock (m_lock)
{
for (int ii = 0; ii < m_nodeManagers.Count; ii++)
{
INodeManager2 nodeManager = m_nodeManagers[ii] as INodeManager2;
if (nodeManager != null)
{
try
{
nodeManager.SessionClosing(context, sessionId, deleteSubscriptions);
}
catch (Exception e)
{
Utils.LogError(e, "Unexpected error closing session for NodeManager #{0}.", ii);
}
}
}
}
}
/// <summary>
/// Shuts down the node managers.
/// </summary>
public virtual void Shutdown()
{
lock (m_lock)
{
Utils.LogInfo(
Utils.TraceMasks.StartStop,
"MasterNodeManager.Shutdown - NodeManagers={0}",
m_nodeManagers.Count);
foreach (INodeManager nodeManager in m_nodeManagers)
{
nodeManager.DeleteAddressSpace();
}
}
}
/// <summary>
/// Registers the node manager as the node manager for Nodes in the specified namespace.
/// </summary>
/// <param name="namespaceUri">The URI of the namespace.</param>
/// <param name="nodeManager">The NodeManager which owns node in the namespace.</param>
/// <remarks>
/// Multiple NodeManagers may register interest in a Namespace.
/// The order in which this method is called determines the precedence if multiple NodeManagers exist.
/// This method adds the namespaceUri to the Server's Namespace table if it does not already exist.
///
/// This method is thread safe and can be called at anytime.
///
/// This method does not have to be called for any namespaces that were in the NodeManager's
/// NamespaceUri property when the MasterNodeManager was created.
/// </remarks>
/// <exception cref="ArgumentNullException">Throw if the namespaceUri or the nodeManager are null.</exception>
public void RegisterNamespaceManager(string namespaceUri, INodeManager nodeManager)
{
if (String.IsNullOrEmpty(namespaceUri)) throw new ArgumentNullException(nameof(namespaceUri));
if (nodeManager == null) throw new ArgumentNullException(nameof(nodeManager));
// look up the namespace uri.
int index = m_server.NamespaceUris.GetIndex(namespaceUri);
if (index < 0)
{
index = m_server.NamespaceUris.Append(namespaceUri);
}
// allocate a new table (using arrays instead of collections because lookup efficiency is critical).
INodeManager[][] namespaceManagers = new INodeManager[m_server.NamespaceUris.Count][];
lock (m_namespaceManagers.SyncRoot)
{
// copy existing values.
for (int ii = 0; ii < m_namespaceManagers.Length; ii++)
{
if (m_namespaceManagers.Length >= ii)
{
namespaceManagers[ii] = m_namespaceManagers[ii];
}
}
// allocate a new array for the index being updated.
INodeManager[] registeredManagers = namespaceManagers[index];
if (registeredManagers == null)
{
registeredManagers = new INodeManager[1];
}
else
{
registeredManagers = new INodeManager[registeredManagers.Length + 1];
Array.Copy(namespaceManagers[index], registeredManagers, namespaceManagers[index].Length);
}
// add new node manager to the end of the list.
registeredManagers[registeredManagers.Length - 1] = nodeManager;
namespaceManagers[index] = registeredManagers;
// replace the table.
m_namespaceManagers = namespaceManagers;
}
}
/// <summary>
/// Returns node handle and its node manager.
/// </summary>
public virtual object GetManagerHandle(NodeId nodeId, out INodeManager nodeManager)
{
nodeManager = null;
object handle = null;
// null node ids have no manager.
if (NodeId.IsNull(nodeId))
{
return null;
}
// use the namespace index to select the node manager.
int index = nodeId.NamespaceIndex;
lock (m_namespaceManagers.SyncRoot)
{
// check if node managers are registered - use the core node manager if unknown.
if (index >= m_namespaceManagers.Length || m_namespaceManagers[index] == null)
{
handle = m_nodeManagers[1].GetManagerHandle(nodeId);
if (handle != null)
{
nodeManager = m_nodeManagers[1];
return handle;
}
return null;
}
// check each of the registered node managers.
INodeManager[] nodeManagers = m_namespaceManagers[index];
for (int ii = 0; ii < nodeManagers.Length; ii++)
{
handle = nodeManagers[ii].GetManagerHandle(nodeId);
if (handle != null)
{
nodeManager = nodeManagers[ii];
return handle;
}
}
}
// node not recognized.
return null;
}
/// <summary>
/// Adds the references to the target.
/// </summary>
public virtual void AddReferences(NodeId sourceId, IList<IReference> references)
{
foreach (IReference reference in references)
{
// find source node.
INodeManager nodeManager = null;
object sourceHandle = GetManagerHandle(sourceId, out nodeManager);
if (sourceHandle == null)
{
continue;
}
// delete the reference.
Dictionary<NodeId, IList<IReference>> map = new Dictionary<NodeId, IList<IReference>>();
map.Add(sourceId, references);
nodeManager.AddReferences(map);
}
}
/// <summary>
/// Deletes the references to the target.
/// </summary>
public virtual void DeleteReferences(NodeId targetId, IList<IReference> references)
{
foreach (ReferenceNode reference in references)
{
NodeId sourceId = ExpandedNodeId.ToNodeId(reference.TargetId, m_server.NamespaceUris);
// find source node.
INodeManager nodeManager = null;
object sourceHandle = GetManagerHandle(sourceId, out nodeManager);
if (sourceHandle == null)
{
continue;
}
// delete the reference.
nodeManager.DeleteReference(sourceHandle, reference.ReferenceTypeId, !reference.IsInverse, targetId, false);
}
}
/// <summary>
/// Deletes the specified references.
/// </summary>
public void RemoveReferences(List<LocalReference> referencesToRemove)
{
for (int ii = 0; ii < referencesToRemove.Count; ii++)
{
LocalReference reference = referencesToRemove[ii];
// find source node.
INodeManager nodeManager = null;
object sourceHandle = GetManagerHandle(reference.SourceId, out nodeManager);
if (sourceHandle == null)
{
continue;
}
// delete the reference.
nodeManager.DeleteReference(sourceHandle, reference.ReferenceTypeId, reference.IsInverse, reference.TargetId, false);
}
}
#region Register/Unregister Nodes
/// <summary>
/// Registers a set of node ids.
/// </summary>
public virtual void RegisterNodes(
OperationContext context,
NodeIdCollection nodesToRegister,
out NodeIdCollection registeredNodeIds)
{
if (nodesToRegister == null) throw new ArgumentNullException(nameof(nodesToRegister));
// return the node id provided.
registeredNodeIds = new NodeIdCollection(nodesToRegister.Count);
for (int ii = 0; ii < nodesToRegister.Count; ii++)
{
registeredNodeIds.Add(nodesToRegister[ii]);
}
Utils.LogTrace(
(int)Utils.TraceMasks.ServiceDetail,
"MasterNodeManager.RegisterNodes - Count={0}",
nodesToRegister.Count);
// it is up to the node managers to assign the handles.
/*
List<bool> processedNodes = new List<bool>(new bool[itemsToDelete.Count]);
for (int ii = 0; ii < m_nodeManagers.Count; ii++)
{
m_nodeManagers[ii].RegisterNodes(
context,
nodesToRegister,
registeredNodeIds,
processedNodes);
}
*/
}
/// <summary>
/// Unregisters a set of node ids.
/// </summary>
public virtual void UnregisterNodes(
OperationContext context,
NodeIdCollection nodesToUnregister)
{
if (nodesToUnregister == null) throw new ArgumentNullException(nameof(nodesToUnregister));
Utils.LogTrace(
(int)Utils.TraceMasks.ServiceDetail,
"MasterNodeManager.UnregisterNodes - Count={0}",
nodesToUnregister.Count);
// it is up to the node managers to assign the handles.
/*
List<bool> processedNodes = new List<bool>(new bool[itemsToDelete.Count]);
for (int ii = 0; ii < m_nodeManagers.Count; ii++)
{
m_nodeManagers[ii].RegisterNodes(
context,
nodesToUnregister,
processedNodes);
}
*/
}
#endregion
#region TranslateBrowsePathsToNodeIds
/// <summary>
/// Translates a start node id plus a relative paths into a node id.
/// </summary>
public virtual void TranslateBrowsePathsToNodeIds(
OperationContext context,
BrowsePathCollection browsePaths,
out BrowsePathResultCollection results,
out DiagnosticInfoCollection diagnosticInfos)
{
if (browsePaths == null) throw new ArgumentNullException(nameof(browsePaths));
bool diagnosticsExist = false;
results = new BrowsePathResultCollection(browsePaths.Count);
diagnosticInfos = new DiagnosticInfoCollection(browsePaths.Count);
for (int ii = 0; ii < browsePaths.Count; ii++)
{
// check if request has timed out or been cancelled.
if (StatusCode.IsBad(context.OperationStatus))
{
throw new ServiceResultException(context.OperationStatus);
}
BrowsePath browsePath = browsePaths[ii];
BrowsePathResult result = new BrowsePathResult();
result.StatusCode = StatusCodes.Good;
results.Add(result);
ServiceResult error = null;
// need to trap unexpected exceptions to handle bugs in the node managers.
try
{
error = TranslateBrowsePath(context, browsePath, result);
}
catch (Exception e)
{
error = ServiceResult.Create(e, StatusCodes.BadUnexpectedError, "Unexpected error translating browse path.");
}
if (ServiceResult.IsGood(error))
{
// check for no match.
if (result.Targets.Count == 0)
{
error = StatusCodes.BadNoMatch;
}
// put a placeholder for diagnostics.
else if ((context.DiagnosticsMask & DiagnosticsMasks.OperationAll) != 0)
{
diagnosticInfos.Add(null);
}
}
// check for error.
if (error != null && error.Code != StatusCodes.Good)
{
result.StatusCode = error.StatusCode;
if ((context.DiagnosticsMask & DiagnosticsMasks.OperationAll) != 0)
{
DiagnosticInfo diagnosticInfo = ServerUtils.CreateDiagnosticInfo(m_server, context, error);
diagnosticInfos.Add(diagnosticInfo);
diagnosticsExist = true;
}
}
}
// clear the diagnostics array if no diagnostics requested or no errors occurred.
UpdateDiagnostics(context, diagnosticsExist, ref diagnosticInfos);
}
/// <summary>
/// Updates the diagnostics return parameter.
/// </summary>
private void UpdateDiagnostics(
OperationContext context,
bool diagnosticsExist,
ref DiagnosticInfoCollection diagnosticInfos)
{
if (diagnosticInfos == null)
{
return;
}
if (diagnosticsExist && context.StringTable.Count == 0)
{
diagnosticsExist = false;
for (int ii = 0; !diagnosticsExist && ii < diagnosticInfos.Count; ii++)
{
DiagnosticInfo diagnosticInfo = diagnosticInfos[ii];
while (diagnosticInfo != null)
{
if (!String.IsNullOrEmpty(diagnosticInfo.AdditionalInfo))
{
diagnosticsExist = true;
break;
}
diagnosticInfo = diagnosticInfo.InnerDiagnosticInfo;
}
}
}
if (!diagnosticsExist)
{
diagnosticInfos = null;
}
}
/// <summary>
/// Translates a browse path.
/// </summary>
protected ServiceResult TranslateBrowsePath(
OperationContext context,
BrowsePath browsePath,
BrowsePathResult result)
{
Debug.Assert(browsePath != null);
Debug.Assert(result != null);
// check for valid start node.
INodeManager nodeManager = null;
object sourceHandle = GetManagerHandle(browsePath.StartingNode, out nodeManager);
if (sourceHandle == null)
{
return StatusCodes.BadNodeIdUnknown;
}
// check the relative path.
RelativePath relativePath = browsePath.RelativePath;
if (relativePath.Elements == null || relativePath.Elements.Count == 0)
{
return StatusCodes.BadNothingToDo;
}
for (int ii = 0; ii < relativePath.Elements.Count; ii++)
{
RelativePathElement element = relativePath.Elements[ii];
if (element == null || QualifiedName.IsNull(relativePath.Elements[ii].TargetName))
{
return StatusCodes.BadBrowseNameInvalid;
}
if (NodeId.IsNull(element.ReferenceTypeId))
{
element.ReferenceTypeId = ReferenceTypeIds.References;
element.IncludeSubtypes = true;
}
}
// validate access rights and role permissions
ServiceResult serviceResult = ValidatePermissions(context, nodeManager, sourceHandle, PermissionType.Browse, null, true);
if (ServiceResult.IsGood(serviceResult))
{
// translate path only if validation is passing
TranslateBrowsePath(
context,
nodeManager,
sourceHandle,
relativePath,
result.Targets,
0);
}
return serviceResult;
}
/// <summary>
/// Recursively processes the elements in the RelativePath starting at the specified index.
/// </summary>
private void TranslateBrowsePath(
OperationContext context,
INodeManager nodeManager,
object sourceHandle,
RelativePath relativePath,
BrowsePathTargetCollection targets,
int index)
{
Debug.Assert(nodeManager != null);
Debug.Assert(sourceHandle != null);
Debug.Assert(relativePath != null);
Debug.Assert(targets != null);
// check for end of list.
if (index < 0 || index >= relativePath.Elements.Count)
{
return;
}
// follow the next hop.
RelativePathElement element = relativePath.Elements[index];
// check for valid reference type.
if (!element.IncludeSubtypes && NodeId.IsNull(element.ReferenceTypeId))
{
return;
}
// check for valid target name.
if (QualifiedName.IsNull(element.TargetName))
{
throw new ServiceResultException(StatusCodes.BadBrowseNameInvalid);
}
List<ExpandedNodeId> targetIds = new List<ExpandedNodeId>();
List<NodeId> externalTargetIds = new List<NodeId>();
try
{
nodeManager.TranslateBrowsePath(
context,
sourceHandle,
element,
targetIds,
externalTargetIds);
}
catch (Exception e)
{
Utils.LogError(e, "Unexpected error translating browse path.");
return;
}
// must check the browse name on all external targets.
for (int ii = 0; ii < externalTargetIds.Count; ii++)
{
// get the browse name from another node manager.
ReferenceDescription description = new ReferenceDescription();
UpdateReferenceDescription(
context,
externalTargetIds[ii],
NodeClass.Unspecified,
BrowseResultMask.BrowseName,
description);
// add to list if target name matches.
if (description.BrowseName == element.TargetName)
{
bool found = false;
for (int jj = 0; jj < targetIds.Count; jj++)
{
if (targetIds[jj] == externalTargetIds[ii])
{
found = true;
break;
}
}
if (!found)
{
targetIds.Add(externalTargetIds[ii]);
}
}
}
// check if done after a final hop.
if (index == relativePath.Elements.Count - 1)
{
for (int ii = 0; ii < targetIds.Count; ii++)
{
// Check the role permissions for target nodes
INodeManager targetNodeManager = null;
object targetHandle = GetManagerHandle(ExpandedNodeId.ToNodeId(targetIds[ii], Server.NamespaceUris), out targetNodeManager);
if (targetHandle != null && targetNodeManager != null)
{
NodeMetadata nodeMetadata = targetNodeManager.GetNodeMetadata(context, targetHandle, BrowseResultMask.All);
ServiceResult serviceResult = ValidateRolePermissions(context, nodeMetadata, PermissionType.Browse);
if (ServiceResult.IsBad(serviceResult))
{
// Remove target node without role permissions.
continue;
}
}
BrowsePathTarget target = new BrowsePathTarget();
target.TargetId = targetIds[ii];
target.RemainingPathIndex = UInt32.MaxValue;
targets.Add(target);
}
return;
}
// process next hops.
for (int ii = 0; ii < targetIds.Count; ii++)
{
ExpandedNodeId targetId = targetIds[ii];
// check for external reference.
if (targetId.IsAbsolute)
{
BrowsePathTarget target = new BrowsePathTarget();
target.TargetId = targetId;
target.RemainingPathIndex = (uint)(index + 1);
targets.Add(target);
continue;
}
// check for valid start node.
sourceHandle = GetManagerHandle((NodeId)targetId, out nodeManager);
if (sourceHandle == null)
{
continue;
}
// recursively follow hops.
TranslateBrowsePath(
context,
nodeManager,
sourceHandle,
relativePath,
targets,
index + 1);
}
}
#endregion
#region Browse
/// <summary>
/// Returns the set of references that meet the filter criteria.
/// </summary>
public virtual void Browse(
OperationContext context,
ViewDescription view,
uint maxReferencesPerNode,
BrowseDescriptionCollection nodesToBrowse,
out BrowseResultCollection results,
out DiagnosticInfoCollection diagnosticInfos)
{
if (context == null) throw new ArgumentNullException(nameof(context));
if (nodesToBrowse == null) throw new ArgumentNullException(nameof(nodesToBrowse));
if (view != null && !NodeId.IsNull(view.ViewId))
{
INodeManager viewManager = null;
object viewHandle = GetManagerHandle(view.ViewId, out viewManager);
if (viewHandle == null)
{
throw new ServiceResultException(StatusCodes.BadViewIdUnknown);