File size: 63,892 Bytes
8c763fb | 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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 | // Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Diagnostics.CodeAnalysis;
using System.Management.Automation;
using System.Management.Automation.Internal;
using System.Management.Automation.Remoting;
using System.Management.Automation.Remoting.Client;
using System.Management.Automation.Runspaces;
using System.Management.Automation.Runspaces.Internal;
using System.Threading;
using Dbg = System.Management.Automation.Diagnostics;
namespace Microsoft.PowerShell.Commands
{
/// <summary>
/// This cmdlet establishes a new Runspace either on the local machine or
/// on the specified remote machine(s). The runspace established can be used
/// to invoke expressions remotely.
///
/// The cmdlet can be used in the following ways:
///
/// Open a local runspace
/// $rs = New-PSSession
///
/// Open a runspace to a remote system.
/// $rs = New-PSSession -Machine PowerShellWorld
///
/// Create a runspace specifying that it is globally scoped.
/// $global:rs = New-PSSession -Machine PowerShellWorld
///
/// Create a collection of runspaces
/// $runspaces = New-PSSession -Machine PowerShellWorld,PowerShellPublish,PowerShellRepo
///
/// Create a set of Runspaces using the Secure Socket Layer by specifying the URI form.
/// This assumes that an shell by the name of E12 exists on the remote server.
/// $serverURIs = 1..8 | ForEach-Object { "SSL://server${_}:443/E12" }
/// $rs = New-PSSession -URI $serverURIs
///
/// Create a runspace by connecting to port 8081 on servers s1, s2 and s3
/// $rs = New-PSSession -computername s1,s2,s3 -port 8081
///
/// Create a runspace by connecting to port 443 using ssl on servers s1, s2 and s3
/// $rs = New-PSSession -computername s1,s2,s3 -port 443 -useSSL
///
/// Create a runspace by connecting to port 8081 on server s1 and run shell named E12.
/// This assumes that a shell by the name E12 exists on the remote server
/// $rs = New-PSSession -computername s1 -port 8061 -ShellName E12.
/// </summary>
[Cmdlet(VerbsCommon.New, "PSSession", DefaultParameterSetName = "ComputerName",
HelpUri = "https://go.microsoft.com/fwlink/?LinkID=2096484", RemotingCapability = RemotingCapability.OwnedByCommand)]
[OutputType(typeof(PSSession))]
public class NewPSSessionCommand : PSRemotingBaseCmdlet, IDisposable
{
#region Parameters
/// <summary>
/// This parameter represents the address(es) of the remote
/// computer(s). The following formats are supported:
/// (a) Computer name
/// (b) IPv4 address : 132.3.4.5
/// (c) IPv6 address: 3ffe:8311:ffff:f70f:0:5efe:172.30.162.18.
/// </summary>
[Parameter(Position = 0,
ValueFromPipeline = true,
ValueFromPipelineByPropertyName = true,
ParameterSetName = NewPSSessionCommand.ComputerNameParameterSet)]
[Alias("Cn")]
[ValidateNotNullOrEmpty]
public override string[] ComputerName { get; set; }
/// <summary>
/// Specifies the credentials of the user to impersonate in the
/// remote machine. If this parameter is not specified then the
/// credentials of the current user process will be assumed.
/// </summary>
[Parameter(ValueFromPipelineByPropertyName = true,
ParameterSetName = PSRemotingBaseCmdlet.ComputerNameParameterSet)]
[Parameter(ValueFromPipelineByPropertyName = true,
ParameterSetName = PSRemotingBaseCmdlet.UriParameterSet)]
[Parameter(Mandatory = true,
ValueFromPipelineByPropertyName = true,
ParameterSetName = PSRemotingBaseCmdlet.VMIdParameterSet)]
[Parameter(Mandatory = true,
ValueFromPipelineByPropertyName = true,
ParameterSetName = PSRemotingBaseCmdlet.VMNameParameterSet)]
[Credential]
public override PSCredential Credential
{
get
{
return base.Credential;
}
set
{
base.Credential = value;
}
}
/// <summary>
/// The PSSession object describing the remote runspace
/// using which the specified cmdlet operation will be performed.
/// </summary>
[Parameter(Position = 0,
ValueFromPipelineByPropertyName = true,
ValueFromPipeline = true,
ParameterSetName = NewPSSessionCommand.SessionParameterSet)]
[ValidateNotNullOrEmpty]
public override PSSession[] Session
{
get
{
return _remoteRunspaceInfos;
}
set
{
_remoteRunspaceInfos = value;
}
}
private PSSession[] _remoteRunspaceInfos;
/// <summary>
/// Friendly names for the new PSSessions.
/// </summary>
[Parameter]
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
public string[] Name { get; set; }
/// <summary>
/// When set and in loopback scenario (localhost) this enables creation of WSMan
/// host process with the user interactive token, allowing PowerShell script network access,
/// i.e., allows going off box. When this property is true and a PSSession is disconnected,
/// reconnection is allowed only if reconnecting from a PowerShell session on the same box.
/// </summary>
[Parameter(ParameterSetName = NewPSSessionCommand.ComputerNameParameterSet)]
[Parameter(ParameterSetName = NewPSSessionCommand.SessionParameterSet)]
[Parameter(ParameterSetName = NewPSSessionCommand.UriParameterSet)]
public SwitchParameter EnableNetworkAccess { get; set; }
/// <summary>
/// For WSMan sessions:
/// If this parameter is not specified then the value specified in
/// the environment variable DEFAULTREMOTESHELLNAME will be used. If
/// this is not set as well, then Microsoft.PowerShell is used.
///
/// For VM/Container sessions:
/// If this parameter is not specified then no configuration is used.
/// </summary>
[Parameter(ValueFromPipelineByPropertyName = true,
ParameterSetName = NewPSSessionCommand.ComputerNameParameterSet)]
[Parameter(ValueFromPipelineByPropertyName = true,
ParameterSetName = NewPSSessionCommand.UriParameterSet)]
[Parameter(ValueFromPipelineByPropertyName = true,
ParameterSetName = NewPSSessionCommand.ContainerIdParameterSet)]
[Parameter(ValueFromPipelineByPropertyName = true,
ParameterSetName = NewPSSessionCommand.VMIdParameterSet)]
[Parameter(ValueFromPipelineByPropertyName = true,
ParameterSetName = NewPSSessionCommand.VMNameParameterSet)]
public string ConfigurationName { get; set; }
/// <summary>
/// Gets or sets parameter value that creates connection to a Windows PowerShell process.
/// </summary>
[Parameter(Mandatory = true, ParameterSetName = NewPSSessionCommand.UseWindowsPowerShellParameterSet)]
public SwitchParameter UseWindowsPowerShell { get; set; }
#endregion Parameters
#region Cmdlet Overrides
/// <summary>
/// The throttle limit will be set here as it needs to be done
/// only once per cmdlet and not for every call.
/// </summary>
protected override void BeginProcessing()
{
base.BeginProcessing();
_operationsComplete.Reset();
_throttleManager.ThrottleLimit = ThrottleLimit;
_throttleManager.ThrottleComplete += HandleThrottleComplete;
if (string.IsNullOrEmpty(ConfigurationName))
{
if ((ParameterSetName == NewPSSessionCommand.ComputerNameParameterSet) ||
(ParameterSetName == NewPSSessionCommand.UriParameterSet))
{
// set to default value for WSMan session
ConfigurationName = ResolveShell(null);
}
else
{
// convert null to string.Empty for VM/Container session
ConfigurationName = string.Empty;
}
}
}
/// <summary>
/// The runspace objects will be created using OpenAsync.
/// At the end, the method will check if any runspace
/// opened has already become available. If so, then it
/// will be written to the pipeline.
/// </summary>
protected override void ProcessRecord()
{
List<RemoteRunspace> remoteRunspaces = null;
List<IThrottleOperation> operations = new List<IThrottleOperation>();
switch (ParameterSetName)
{
case NewPSSessionCommand.SessionParameterSet:
{
remoteRunspaces = CreateRunspacesWhenRunspaceParameterSpecified();
}
break;
case "Uri":
{
remoteRunspaces = CreateRunspacesWhenUriParameterSpecified();
}
break;
case NewPSSessionCommand.ComputerNameParameterSet:
{
remoteRunspaces = CreateRunspacesWhenComputerNameParameterSpecified();
}
break;
case NewPSSessionCommand.VMIdParameterSet:
case NewPSSessionCommand.VMNameParameterSet:
{
remoteRunspaces = CreateRunspacesWhenVMParameterSpecified();
}
break;
case NewPSSessionCommand.ContainerIdParameterSet:
{
remoteRunspaces = CreateRunspacesWhenContainerParameterSpecified();
}
break;
case NewPSSessionCommand.SSHHostParameterSet:
{
remoteRunspaces = CreateRunspacesForSSHHostParameterSet();
}
break;
case NewPSSessionCommand.SSHHostHashParameterSet:
{
remoteRunspaces = CreateRunspacesForSSHHostHashParameterSet();
}
break;
case NewPSSessionCommand.UseWindowsPowerShellParameterSet:
{
if (UseWindowsPowerShell)
{
remoteRunspaces = CreateRunspacesForUseWindowsPowerShellParameterSet();
}
else
{
// When -UseWindowsPowerShell:$false is explicitly specified,
// fall back to the default ComputerName parameter set behavior
goto case NewPSSessionCommand.ComputerNameParameterSet;
}
}
break;
default:
{
Dbg.Assert(false, "Missing parameter set in switch statement");
remoteRunspaces = new List<RemoteRunspace>(); // added to avoid prefast warning
}
break;
}
foreach (RemoteRunspace remoteRunspace in remoteRunspaces)
{
remoteRunspace.Events.ReceivedEvents.PSEventReceived += OnRunspacePSEventReceived;
OpenRunspaceOperation operation = new OpenRunspaceOperation(remoteRunspace);
// HandleRunspaceStateChanged callback is added before ThrottleManager complete
// callback handlers so HandleRunspaceStateChanged will always be called first.
operation.OperationComplete += HandleRunspaceStateChanged;
remoteRunspace.URIRedirectionReported += HandleURIDirectionReported;
operations.Add(operation);
}
// submit list of operations to throttle manager to start opening
// runspaces
_throttleManager.SubmitOperations(operations);
// Add to list for clean up.
_allOperations.Add(operations);
// If there are any runspaces opened asynchronously
// that are ready now, check their status and do
// necessary action. If there are any error records
// or verbose messages write them as well
Collection<object> streamObjects =
_stream.ObjectReader.NonBlockingRead();
foreach (object streamObject in streamObjects)
{
WriteStreamObject((Action<Cmdlet>)streamObject);
}
}
/// <summary>
/// OpenAsync would have been called from ProcessRecord. This method
/// will wait until all runspaces are opened and then write them to
/// the pipeline as and when they become available.
/// </summary>
protected override void EndProcessing()
{
// signal to throttle manager end of submit operations
_throttleManager.EndSubmitOperations();
while (true)
{
// Keep reading objects until end of pipeline is encountered
_stream.ObjectReader.WaitHandle.WaitOne();
if (!_stream.ObjectReader.EndOfPipeline)
{
object streamObject = _stream.ObjectReader.Read();
WriteStreamObject((Action<Cmdlet>)streamObject);
}
else
{
break;
}
}
}
/// <summary>
/// This method is called when the user sends a stop signal to the
/// cmdlet. The cmdlet will not exit until it has completed
/// creating all the runspaces (basically the runspaces its
/// waiting on OpenAsync is made available). However, when a stop
/// signal is sent, CloseAsyn needs to be called to close all the
/// pending runspaces.
/// </summary>
/// <remarks>This is called from a separate thread so need to worry
/// about concurrency issues
/// </remarks>
protected override void StopProcessing()
{
// close the outputStream so that further writes to the outputStream
// are not possible
_stream.ObjectWriter.Close();
// for all the runspaces that have been submitted for opening
// call StopOperation on each object and quit
_throttleManager.StopAllOperations();
}
#endregion Cmdlet Overrides
#region IDisposable Overrides
/// <summary>
/// Dispose method of IDisposable. Gets called in the following cases:
/// 1. Pipeline explicitly calls dispose on cmdlets
/// 2. Called by the garbage collector.
/// </summary>
public void Dispose()
{
Dispose(true);
GC.SuppressFinalize(this);
}
#endregion IDisposable Overrides
#region Private Methods
/// <summary>
/// Adds forwarded events to the local queue.
/// </summary>
private void OnRunspacePSEventReceived(object sender, PSEventArgs e) => this.Events?.AddForwardedEvent(e);
/// <summary>
/// When the client remote session reports a URI redirection, this method will report the
/// message to the user as a Warning using Host method calls.
/// </summary>
/// <param name="sender"></param>
/// <param name="eventArgs"></param>
private void HandleURIDirectionReported(object sender, RemoteDataEventArgs<Uri> eventArgs)
{
string message = StringUtil.Format(RemotingErrorIdStrings.URIRedirectWarningToHost, eventArgs.Data.OriginalString);
Action<Cmdlet> warningWriter = (Cmdlet cmdlet) => cmdlet.WriteWarning(message);
_stream.Write(warningWriter);
}
/// <summary>
/// Handles state changes for Runspace.
/// </summary>
/// <param name="sender">Sender of this event.</param>
/// <param name="stateEventArgs">Event information object which describes
/// the event which triggered this method</param>
private void HandleRunspaceStateChanged(object sender, OperationStateEventArgs stateEventArgs)
{
if (sender == null)
{
throw PSTraceSource.NewArgumentNullException(nameof(sender));
}
if (stateEventArgs == null)
{
throw PSTraceSource.NewArgumentNullException(nameof(stateEventArgs));
}
RunspaceStateEventArgs runspaceStateEventArgs =
stateEventArgs.BaseEvent as RunspaceStateEventArgs;
RunspaceStateInfo stateInfo = runspaceStateEventArgs.RunspaceStateInfo;
RunspaceState state = stateInfo.State;
OpenRunspaceOperation operation = sender as OpenRunspaceOperation;
RemoteRunspace remoteRunspace = operation.OperatedRunspace;
// since we got state changed event..we dont need to listen on
// URI redirections anymore
if (remoteRunspace != null)
{
remoteRunspace.URIRedirectionReported -= HandleURIDirectionReported;
}
PipelineWriter writer = _stream.ObjectWriter;
Exception reason = runspaceStateEventArgs.RunspaceStateInfo.Reason;
switch (state)
{
case RunspaceState.Opened:
{
// Indicates that runspace is successfully opened
// Write it to PipelineWriter to be handled in
// HandleRemoteRunspace
PSSession remoteRunspaceInfo = new PSSession(remoteRunspace);
this.RunspaceRepository.Add(remoteRunspaceInfo);
Action<Cmdlet> outputWriter = (Cmdlet cmdlet) => cmdlet.WriteObject(remoteRunspaceInfo);
if (writer.IsOpen)
{
writer.Write(outputWriter);
}
}
break;
case RunspaceState.Broken:
{
// Open resulted in a broken state. Extract reason
// and write an error record
// set the transport message in the error detail so that
// the user can directly get to see the message without
// having to mine through the error record details
PSRemotingTransportException transException =
reason as PSRemotingTransportException;
string errorDetails = null;
int transErrorCode = 0;
if (transException != null)
{
OpenRunspaceOperation senderAsOp = sender as OpenRunspaceOperation;
transErrorCode = transException.ErrorCode;
if (senderAsOp != null)
{
string host = senderAsOp.OperatedRunspace.ConnectionInfo.ComputerName;
if (transException.ErrorCode ==
System.Management.Automation.Remoting.Client.WSManNativeApi.ERROR_WSMAN_REDIRECT_REQUESTED)
{
// Handling a special case for redirection..we should talk about
// AllowRedirection parameter and WSManMaxRedirectionCount preference
// variables
string message = PSRemotingErrorInvariants.FormatResourceString(
RemotingErrorIdStrings.URIRedirectionReported,
transException.Message,
"MaximumConnectionRedirectionCount",
Microsoft.PowerShell.Commands.PSRemotingBaseCmdlet.DEFAULT_SESSION_OPTION,
"AllowRedirection");
errorDetails = "[" + host + "] " + message;
}
else
{
errorDetails = "[" + host + "] ";
if (!string.IsNullOrEmpty(transException.Message))
{
errorDetails += transException.Message;
}
else if (!string.IsNullOrEmpty(transException.TransportMessage))
{
errorDetails += transException.TransportMessage;
}
}
}
}
// add host identification information in data structure handler message
PSRemotingDataStructureException protoException = reason as PSRemotingDataStructureException;
if (protoException != null)
{
OpenRunspaceOperation senderAsOp = sender as OpenRunspaceOperation;
if (senderAsOp != null)
{
string host = senderAsOp.OperatedRunspace.ConnectionInfo.ComputerName;
errorDetails = "[" + host + "] " + protoException.Message;
}
}
reason ??= new RuntimeException(this.GetMessage(RemotingErrorIdStrings.RemoteRunspaceOpenUnknownState, state));
string fullyQualifiedErrorId = WSManTransportManagerUtils.GetFQEIDFromTransportError(
transErrorCode,
_defaultFQEID);
if (transErrorCode == WSManNativeApi.ERROR_WSMAN_NO_LOGON_SESSION_EXIST)
{
errorDetails += System.Environment.NewLine + string.Format(System.Globalization.CultureInfo.CurrentCulture, RemotingErrorIdStrings.RemotingErrorNoLogonSessionExist);
}
ErrorRecord errorRecord = new ErrorRecord(reason,
remoteRunspace, fullyQualifiedErrorId,
ErrorCategory.OpenError, null, null,
null, null, null, errorDetails, null);
Action<Cmdlet> errorWriter = (Cmdlet cmdlet) =>
{
//
// In case of PSDirectException, we should output the precise error message
// in inner exception instead of the generic one in outer exception.
//
if ((errorRecord.Exception != null) &&
(errorRecord.Exception.InnerException != null))
{
PSDirectException ex = errorRecord.Exception.InnerException as PSDirectException;
if (ex != null)
{
errorRecord = new ErrorRecord(errorRecord.Exception.InnerException,
errorRecord.FullyQualifiedErrorId,
errorRecord.CategoryInfo.Category,
errorRecord.TargetObject);
}
}
cmdlet.WriteError(errorRecord);
};
if (writer.IsOpen)
{
writer.Write(errorWriter);
}
_toDispose.Add(remoteRunspace);
}
break;
case RunspaceState.Closed:
{
// The runspace was closed possibly because the user
// hit ctrl-C when runspaces were being opened or Dispose has been
// called when there are open runspaces
Uri connectionUri = WSManConnectionInfo.ExtractPropertyAsWsManConnectionInfo<Uri>(remoteRunspace.ConnectionInfo,
"ConnectionUri", null);
string message =
GetMessage(RemotingErrorIdStrings.RemoteRunspaceClosed,
(connectionUri != null) ?
connectionUri.AbsoluteUri : string.Empty);
Action<Cmdlet> verboseWriter = (Cmdlet cmdlet) => cmdlet.WriteVerbose(message);
if (writer.IsOpen)
{
writer.Write(verboseWriter);
}
// runspace may not have been opened in certain cases
// like when the max memory is set to 25MB, in such
// cases write an error record
if (reason != null)
{
ErrorRecord errorRecord = new ErrorRecord(reason,
"PSSessionStateClosed",
ErrorCategory.OpenError, remoteRunspace);
Action<Cmdlet> errorWriter = (Cmdlet cmdlet) => cmdlet.WriteError(errorRecord);
if (writer.IsOpen)
{
writer.Write(errorWriter);
}
}
}
break;
}
}
/// <summary>
/// Creates the remote runspace objects when PSSession
/// parameter is specified
/// It now supports PSSession based on VM/container connection info as well.
/// </summary>
[SuppressMessage("Microsoft.Usage", "CA2208:InstantiateArgumentExceptionsCorrectly")]
private List<RemoteRunspace> CreateRunspacesWhenRunspaceParameterSpecified()
{
List<RemoteRunspace> remoteRunspaces = new List<RemoteRunspace>();
// validate the runspaces specified before processing them.
// The function will result in terminating errors, if any
// validation failure is encountered
ValidateRemoteRunspacesSpecified();
int rsIndex = 0;
foreach (PSSession remoteRunspaceInfo in _remoteRunspaceInfos)
{
if (remoteRunspaceInfo == null || remoteRunspaceInfo.Runspace == null)
{
ThrowTerminatingError(new ErrorRecord(
new ArgumentNullException("PSSession"), "PSSessionArgumentNull",
ErrorCategory.InvalidArgument, null));
}
else
{
// clone the object based on what's specified in the input parameter
try
{
RemoteRunspace remoteRunspace = (RemoteRunspace)remoteRunspaceInfo.Runspace;
RunspaceConnectionInfo newConnectionInfo = null;
if (remoteRunspace.ConnectionInfo is VMConnectionInfo)
{
newConnectionInfo = remoteRunspace.ConnectionInfo.Clone();
}
else if (remoteRunspace.ConnectionInfo is ContainerConnectionInfo)
{
ContainerConnectionInfo newContainerConnectionInfo = remoteRunspace.ConnectionInfo.Clone() as ContainerConnectionInfo;
newContainerConnectionInfo.CreateContainerProcess();
newConnectionInfo = newContainerConnectionInfo;
}
else
{
// WSMan case
WSManConnectionInfo originalWSManConnectionInfo = remoteRunspace.ConnectionInfo as WSManConnectionInfo;
WSManConnectionInfo newWSManConnectionInfo = null;
if (originalWSManConnectionInfo != null)
{
newWSManConnectionInfo = originalWSManConnectionInfo.Copy();
newWSManConnectionInfo.EnableNetworkAccess = newWSManConnectionInfo.EnableNetworkAccess || EnableNetworkAccess;
newConnectionInfo = newWSManConnectionInfo;
}
else
{
Uri connectionUri = WSManConnectionInfo.ExtractPropertyAsWsManConnectionInfo<Uri>(remoteRunspace.ConnectionInfo,
"ConnectionUri", null);
string shellUri = WSManConnectionInfo.ExtractPropertyAsWsManConnectionInfo<string>(remoteRunspace.ConnectionInfo,
"ShellUri", string.Empty);
newWSManConnectionInfo = new WSManConnectionInfo(connectionUri,
shellUri,
remoteRunspace.ConnectionInfo.Credential);
UpdateConnectionInfo(newWSManConnectionInfo);
newWSManConnectionInfo.EnableNetworkAccess = EnableNetworkAccess;
newConnectionInfo = newWSManConnectionInfo;
}
}
RemoteRunspacePoolInternal rrsPool = remoteRunspace.RunspacePool.RemoteRunspacePoolInternal;
TypeTable typeTable = null;
if ((rrsPool != null) &&
(rrsPool.DataStructureHandler != null) &&
(rrsPool.DataStructureHandler.TransportManager != null))
{
typeTable = rrsPool.DataStructureHandler.TransportManager.Fragmentor.TypeTable;
}
// Create new remote runspace with name and Id.
int rsId;
string rsName = GetRunspaceName(rsIndex, out rsId);
RemoteRunspace newRemoteRunspace = new RemoteRunspace(
typeTable, newConnectionInfo, this.Host, this.SessionOption.ApplicationArguments,
rsName, rsId);
remoteRunspaces.Add(newRemoteRunspace);
}
catch (UriFormatException e)
{
PipelineWriter writer = _stream.ObjectWriter;
ErrorRecord errorRecord = new ErrorRecord(e, "CreateRemoteRunspaceFailed",
ErrorCategory.InvalidArgument, remoteRunspaceInfo);
Action<Cmdlet> errorWriter = (Cmdlet cmdlet) => cmdlet.WriteError(errorRecord);
writer.Write(errorWriter);
}
}
++rsIndex;
}
return remoteRunspaces;
}
/// <summary>
/// Creates the remote runspace objects when the URI parameter
/// is specified.
/// </summary>
private List<RemoteRunspace> CreateRunspacesWhenUriParameterSpecified()
{
List<RemoteRunspace> remoteRunspaces = new List<RemoteRunspace>();
// parse the Uri to obtain information about the runspace
// required
for (int i = 0; i < ConnectionUri.Length; i++)
{
try
{
WSManConnectionInfo connectionInfo = new WSManConnectionInfo();
connectionInfo.ConnectionUri = ConnectionUri[i];
connectionInfo.ShellUri = ConfigurationName;
if (CertificateThumbprint != null)
{
connectionInfo.CertificateThumbprint = CertificateThumbprint;
}
else
{
connectionInfo.Credential = Credential;
}
connectionInfo.AuthenticationMechanism = Authentication;
UpdateConnectionInfo(connectionInfo);
connectionInfo.EnableNetworkAccess = EnableNetworkAccess;
// Create new remote runspace with name and Id.
int rsId;
string rsName = GetRunspaceName(i, out rsId);
RemoteRunspace remoteRunspace = new RemoteRunspace(
Utils.GetTypeTableFromExecutionContextTLS(), connectionInfo, this.Host,
this.SessionOption.ApplicationArguments, rsName, rsId);
Dbg.Assert(remoteRunspace != null,
"RemoteRunspace object created using URI is null");
remoteRunspaces.Add(remoteRunspace);
}
catch (UriFormatException e)
{
WriteErrorCreateRemoteRunspaceFailed(e, ConnectionUri[i]);
}
catch (InvalidOperationException e)
{
WriteErrorCreateRemoteRunspaceFailed(e, ConnectionUri[i]);
}
catch (ArgumentException e)
{
WriteErrorCreateRemoteRunspaceFailed(e, ConnectionUri[i]);
}
catch (NotSupportedException e)
{
WriteErrorCreateRemoteRunspaceFailed(e, ConnectionUri[i]);
}
}
return remoteRunspaces;
}
/// <summary>
/// Creates the remote runspace objects when the ComputerName parameter
/// is specified.
/// </summary>
private List<RemoteRunspace> CreateRunspacesWhenComputerNameParameterSpecified()
{
List<RemoteRunspace> remoteRunspaces =
new List<RemoteRunspace>();
// Resolve all the machine names
string[] resolvedComputerNames;
ResolveComputerNames(ComputerName, out resolvedComputerNames);
ValidateComputerName(resolvedComputerNames);
// Do for each machine
for (int i = 0; i < resolvedComputerNames.Length; i++)
{
try
{
WSManConnectionInfo connectionInfo = null;
connectionInfo = new WSManConnectionInfo();
string scheme = UseSSL.IsPresent ? WSManConnectionInfo.HttpsScheme : WSManConnectionInfo.HttpScheme;
connectionInfo.ComputerName = resolvedComputerNames[i];
connectionInfo.Port = Port;
connectionInfo.AppName = ApplicationName;
connectionInfo.ShellUri = ConfigurationName;
connectionInfo.Scheme = scheme;
if (CertificateThumbprint != null)
{
connectionInfo.CertificateThumbprint = CertificateThumbprint;
}
else
{
connectionInfo.Credential = Credential;
}
connectionInfo.AuthenticationMechanism = Authentication;
UpdateConnectionInfo(connectionInfo);
connectionInfo.EnableNetworkAccess = EnableNetworkAccess;
// Create new remote runspace with name and Id.
int rsId;
string rsName = GetRunspaceName(i, out rsId);
RemoteRunspace runspace = new RemoteRunspace(
Utils.GetTypeTableFromExecutionContextTLS(), connectionInfo, this.Host,
this.SessionOption.ApplicationArguments, rsName, rsId);
remoteRunspaces.Add(runspace);
}
catch (UriFormatException e)
{
PipelineWriter writer = _stream.ObjectWriter;
ErrorRecord errorRecord = new ErrorRecord(e, "CreateRemoteRunspaceFailed",
ErrorCategory.InvalidArgument, resolvedComputerNames[i]);
Action<Cmdlet> errorWriter = (Cmdlet cmdlet) => cmdlet.WriteError(errorRecord);
writer.Write(errorWriter);
}
}
return remoteRunspaces;
}
/// <summary>
/// Creates the remote runspace objects when the VMId or VMName parameter
/// is specified.
/// </summary>
private List<RemoteRunspace> CreateRunspacesWhenVMParameterSpecified()
{
int inputArraySize;
bool isVMIdSet = false;
int index;
string command;
Collection<PSObject> results;
List<RemoteRunspace> remoteRunspaces = new List<RemoteRunspace>();
if (ParameterSetName == PSExecutionCmdlet.VMIdParameterSet)
{
isVMIdSet = true;
inputArraySize = this.VMId.Length;
this.VMName = new string[inputArraySize];
command = "Get-VM -Id $args[0]";
}
else
{
Dbg.Assert((ParameterSetName == PSExecutionCmdlet.VMNameParameterSet),
"Expected ParameterSetName == VMId or VMName");
inputArraySize = this.VMName.Length;
this.VMId = new Guid[inputArraySize];
command = "Get-VM -Name $args";
}
for (index = 0; index < inputArraySize; index++)
{
try
{
results = this.InvokeCommand.InvokeScript(
command, false, PipelineResultTypes.None, null,
isVMIdSet ? this.VMId[index].ToString() : this.VMName[index]);
}
catch (CommandNotFoundException)
{
ThrowTerminatingError(
new ErrorRecord(
new ArgumentException(RemotingErrorIdStrings.HyperVModuleNotAvailable),
nameof(PSRemotingErrorId.HyperVModuleNotAvailable),
ErrorCategory.NotInstalled,
null));
return null;
}
// handle invalid input
if (results.Count != 1)
{
if (isVMIdSet)
{
this.VMName[index] = string.Empty;
WriteError(
new ErrorRecord(
new ArgumentException(GetMessage(RemotingErrorIdStrings.InvalidVMIdNotSingle,
this.VMId[index].ToString(null))),
nameof(PSRemotingErrorId.InvalidVMIdNotSingle),
ErrorCategory.InvalidArgument,
null));
continue;
}
else
{
this.VMId[index] = Guid.Empty;
WriteError(
new ErrorRecord(
new ArgumentException(GetMessage(RemotingErrorIdStrings.InvalidVMNameNotSingle,
this.VMName[index])),
nameof(PSRemotingErrorId.InvalidVMNameNotSingle),
ErrorCategory.InvalidArgument,
null));
continue;
}
}
else
{
this.VMId[index] = (Guid)results[0].Properties["VMId"].Value;
this.VMName[index] = (string)results[0].Properties["VMName"].Value;
//
// VM should be in running state.
//
if (GetVMStateProperty(results[0]) != VMState.Running)
{
WriteError(
new ErrorRecord(
new ArgumentException(GetMessage(RemotingErrorIdStrings.InvalidVMState,
this.VMName[index])),
nameof(PSRemotingErrorId.InvalidVMState),
ErrorCategory.InvalidArgument,
null));
continue;
}
}
// create helper objects for VM GUIDs or names
RemoteRunspace runspace = null;
VMConnectionInfo connectionInfo;
int rsId;
string rsName = GetRunspaceName(index, out rsId);
try
{
connectionInfo = new VMConnectionInfo(this.Credential, this.VMId[index], this.VMName[index], this.ConfigurationName);
runspace = new RemoteRunspace(Utils.GetTypeTableFromExecutionContextTLS(),
connectionInfo, this.Host, null, rsName, rsId);
remoteRunspaces.Add(runspace);
}
catch (InvalidOperationException e)
{
ErrorRecord errorRecord = new ErrorRecord(e,
"CreateRemoteRunspaceForVMFailed",
ErrorCategory.InvalidOperation,
null);
WriteError(errorRecord);
}
catch (ArgumentException e)
{
ErrorRecord errorRecord = new ErrorRecord(e,
"CreateRemoteRunspaceForVMFailed",
ErrorCategory.InvalidArgument,
null);
WriteError(errorRecord);
}
}
ResolvedComputerNames = this.VMName;
return remoteRunspaces;
}
/// <summary>
/// Creates the remote runspace objects when the ContainerId parameter is specified.
/// </summary>
private List<RemoteRunspace> CreateRunspacesWhenContainerParameterSpecified()
{
int index = 0;
List<string> resolvedNameList = new List<string>();
List<RemoteRunspace> remoteRunspaces = new List<RemoteRunspace>();
Dbg.Assert((ParameterSetName == PSExecutionCmdlet.ContainerIdParameterSet),
"Expected ParameterSetName == ContainerId");
foreach (var input in ContainerId)
{
//
// Create helper objects for container ID or name.
//
RemoteRunspace runspace = null;
ContainerConnectionInfo connectionInfo = null;
int rsId;
string rsName = GetRunspaceName(index, out rsId);
index++;
try
{
//
// Hyper-V container uses Hype-V socket as transport.
// Windows Server container uses named pipe as transport.
//
connectionInfo = ContainerConnectionInfo.CreateContainerConnectionInfo(input, RunAsAdministrator.IsPresent, this.ConfigurationName);
resolvedNameList.Add(connectionInfo.ComputerName);
connectionInfo.CreateContainerProcess();
runspace = new RemoteRunspace(Utils.GetTypeTableFromExecutionContextTLS(),
connectionInfo, this.Host, null, rsName, rsId);
remoteRunspaces.Add(runspace);
}
catch (InvalidOperationException e)
{
ErrorRecord errorRecord = new ErrorRecord(e,
"CreateRemoteRunspaceForContainerFailed",
ErrorCategory.InvalidOperation,
null);
WriteError(errorRecord);
continue;
}
catch (ArgumentException e)
{
ErrorRecord errorRecord = new ErrorRecord(e,
"CreateRemoteRunspaceForContainerFailed",
ErrorCategory.InvalidArgument,
null);
WriteError(errorRecord);
continue;
}
catch (Exception e)
{
ErrorRecord errorRecord = new ErrorRecord(e,
"CreateRemoteRunspaceForContainerFailed",
ErrorCategory.InvalidOperation,
null);
WriteError(errorRecord);
continue;
}
}
ResolvedComputerNames = resolvedNameList.ToArray();
return remoteRunspaces;
}
/// <summary>
/// CreateRunspacesForSSHHostParameterSet.
/// </summary>
/// <returns></returns>
private List<RemoteRunspace> CreateRunspacesForSSHHostParameterSet()
{
// Resolve all the machine names
string[] resolvedComputerNames;
ResolveComputerNames(HostName, out resolvedComputerNames);
var remoteRunspaces = new List<RemoteRunspace>();
int index = 0;
foreach (var computerName in resolvedComputerNames)
{
ParseSshHostName(computerName, out string host, out string userName, out int port);
var sshConnectionInfo = new SSHConnectionInfo(
userName,
host,
this.KeyFilePath,
port,
Subsystem,
ConnectingTimeout,
Options);
var typeTable = TypeTable.LoadDefaultTypeFiles();
string rsName = GetRunspaceName(index, out int rsIdUnused);
index++;
remoteRunspaces.Add(RunspaceFactory.CreateRunspace(connectionInfo: sshConnectionInfo,
host: this.Host,
typeTable: typeTable,
applicationArguments: null,
name: rsName) as RemoteRunspace);
}
return remoteRunspaces;
}
private List<RemoteRunspace> CreateRunspacesForSSHHostHashParameterSet()
{
var sshConnections = ParseSSHConnectionHashTable();
var remoteRunspaces = new List<RemoteRunspace>();
int index = 0;
foreach (var sshConnection in sshConnections)
{
var sshConnectionInfo = new SSHConnectionInfo(
sshConnection.UserName,
sshConnection.ComputerName,
sshConnection.KeyFilePath,
sshConnection.Port,
sshConnection.Subsystem,
sshConnection.ConnectingTimeout,
sshConnection.Options);
var typeTable = TypeTable.LoadDefaultTypeFiles();
string rsName = GetRunspaceName(index, out int rsIdUnused);
index++;
remoteRunspaces.Add(RunspaceFactory.CreateRunspace(connectionInfo: sshConnectionInfo,
host: this.Host,
typeTable: typeTable,
applicationArguments: null,
name: rsName) as RemoteRunspace);
}
return remoteRunspaces;
}
/// <summary>
/// Helper method to create remote runspace based on UseWindowsPowerShell parameter set.
/// </summary>
/// <returns>Remote runspace that was created.</returns>
private List<RemoteRunspace> CreateRunspacesForUseWindowsPowerShellParameterSet()
{
var remoteRunspaces = new List<RemoteRunspace>();
NewProcessConnectionInfo connectionInfo = new NewProcessConnectionInfo(this.Credential);
connectionInfo.AuthenticationMechanism = this.Authentication;
#if !UNIX
connectionInfo.PSVersion = new Version(5, 1);
#endif
var typeTable = TypeTable.LoadDefaultTypeFiles();
string runspaceName = GetRunspaceName(0, out int runspaceIdUnused);
remoteRunspaces.Add(RunspaceFactory.CreateRunspace(connectionInfo: connectionInfo,
host: this.Host,
typeTable: typeTable,
applicationArguments: null,
name: runspaceName) as RemoteRunspace);
return remoteRunspaces;
}
/// <summary>
/// Helper method to either get a user supplied runspace/session name
/// or to generate one along with a unique Id.
/// </summary>
/// <param name="rsIndex">Runspace name array index.</param>
/// <param name="rsId">Runspace Id.</param>
/// <returns>Runspace name.</returns>
private string GetRunspaceName(int rsIndex, out int rsId)
{
// Get a unique session/runspace Id and default Name.
string rsName = PSSession.GenerateRunspaceName(out rsId);
// If there is a friendly name for the runspace, we need to pass it to the
// runspace pool object, which in turn passes it on to the server during
// construction. This way the friendly name can be returned when querying
// the sever for disconnected sessions/runspaces.
if (Name != null && rsIndex < Name.Length)
{
rsName = Name[rsIndex];
}
return rsName;
}
/// <summary>
/// Internal dispose method which does the actual
/// dispose operations and finalize suppressions.
/// </summary>
/// <param name="disposing">Whether method is called
/// from Dispose or destructor</param>
protected void Dispose(bool disposing)
{
if (disposing)
{
_throttleManager.Dispose();
// wait for all runspace operations to be complete
_operationsComplete.WaitOne();
_operationsComplete.Dispose();
_throttleManager.ThrottleComplete -= HandleThrottleComplete;
_throttleManager = null;
foreach (RemoteRunspace remoteRunspace in _toDispose)
{
remoteRunspace.Dispose();
}
// Dispose all open operation objects, to remove runspace event callback.
foreach (List<IThrottleOperation> operationList in _allOperations)
{
foreach (OpenRunspaceOperation operation in operationList)
{
operation.Dispose();
}
}
_stream.Dispose();
}
}
/// <summary>
/// Handles the throttling complete event of the throttle manager.
/// </summary>
/// <param name="sender">Sender of this event.</param>
/// <param name="eventArgs"></param>
private void HandleThrottleComplete(object sender, EventArgs eventArgs)
{
// all operations are complete close the stream
_stream.ObjectWriter.Close();
_operationsComplete.Set();
}
/// <summary>
/// Writes an error record specifying that creation of remote runspace
/// failed.
/// </summary>
/// <param name="e">exception which is causing this error record
/// to be written</param>
/// <param name="uri">Uri which caused this exception.</param>
private void WriteErrorCreateRemoteRunspaceFailed(Exception e, Uri uri)
{
Dbg.Assert(e is UriFormatException || e is InvalidOperationException ||
e is ArgumentException || e is NotSupportedException,
"Exception has to be of type UriFormatException or InvalidOperationException or ArgumentException or NotSupportedException");
PipelineWriter writer = _stream.ObjectWriter;
ErrorRecord errorRecord = new ErrorRecord(e, "CreateRemoteRunspaceFailed",
ErrorCategory.InvalidArgument, uri);
Action<Cmdlet> errorWriter = (Cmdlet cmdlet) => cmdlet.WriteError(errorRecord);
writer.Write(errorWriter);
}
#endregion Private Methods
#region Private Members
private ThrottleManager _throttleManager = new ThrottleManager();
private readonly ObjectStream _stream = new ObjectStream();
// event that signals that all operations are
// complete (including closing if any)
private readonly ManualResetEvent _operationsComplete = new ManualResetEvent(true);
// the initial state is true because when no
// operations actually take place as in case of a
// parameter binding exception, then Dispose is
// called. Since Dispose waits on this handler
// it is set to true initially and is Reset() in
// BeginProcessing()
// list of runspaces to dispose
private readonly List<RemoteRunspace> _toDispose = new List<RemoteRunspace>();
// List of runspace connect operations. Need to keep for cleanup.
private readonly Collection<List<IThrottleOperation>> _allOperations = new Collection<List<IThrottleOperation>>();
// Default FQEID.
private readonly string _defaultFQEID = "PSSessionOpenFailed";
#endregion Private Members
}
#region Helper Classes
/// <summary>
/// Class that implements the IThrottleOperation in turn wrapping the
/// opening of a runspace asynchronously within it.
/// </summary>
internal class OpenRunspaceOperation : IThrottleOperation, IDisposable
{
// Member variables to ensure that the ThrottleManager gets StartComplete
// or StopComplete called only once per Start or Stop operation.
private bool _startComplete;
private bool _stopComplete;
private readonly object _syncObject = new object();
internal RemoteRunspace OperatedRunspace { get; }
internal OpenRunspaceOperation(RemoteRunspace runspace)
{
_startComplete = true;
_stopComplete = true;
OperatedRunspace = runspace;
OperatedRunspace.StateChanged += HandleRunspaceStateChanged;
}
/// <summary>
/// Opens the runspace asynchronously.
/// </summary>
internal override void StartOperation()
{
lock (_syncObject)
{
_startComplete = false;
}
OperatedRunspace.OpenAsync();
}
/// <summary>
/// Closes the runspace already opened asynchronously.
/// </summary>
internal override void StopOperation()
{
OperationStateEventArgs operationStateEventArgs = null;
lock (_syncObject)
{
// Ignore stop operation if start operation has completed.
if (_startComplete)
{
_stopComplete = true;
_startComplete = true;
operationStateEventArgs = new OperationStateEventArgs();
operationStateEventArgs.BaseEvent = new RunspaceStateEventArgs(OperatedRunspace.RunspaceStateInfo);
operationStateEventArgs.OperationState = OperationState.StopComplete;
}
else
{
_stopComplete = false;
}
}
if (operationStateEventArgs != null)
{
FireEvent(operationStateEventArgs);
}
else
{
OperatedRunspace.CloseAsync();
}
}
// OperationComplete event handler uses an internal collection of event handler
// callbacks for two reasons:
// a) To ensure callbacks are made in list order (first added, first called).
// b) To ensure all callbacks are fired by manually invoking callbacks and handling
// any exceptions thrown on this thread. (ThrottleManager will not respond if it doesn't
// get a start/stop complete callback).
private readonly List<EventHandler<OperationStateEventArgs>> _internalCallbacks = new List<EventHandler<OperationStateEventArgs>>();
internal override event EventHandler<OperationStateEventArgs> OperationComplete
{
add
{
lock (_internalCallbacks)
{
_internalCallbacks.Add(value);
}
}
remove
{
lock (_internalCallbacks)
{
_internalCallbacks.Remove(value);
}
}
}
/// <summary>
/// Handler for handling runspace state changed events. This method will be
/// registered in the StartOperation and StopOperation methods. This handler
/// will in turn invoke the OperationComplete event for all events that are
/// necessary - Opened, Closed, Disconnected, Broken. It will ignore all other state
/// changes.
/// </summary>
/// <remarks>
/// There are two problems that need to be handled.
/// 1) We need to make sure that the ThrottleManager StartComplete and StopComplete
/// operation events are called or the ThrottleManager will never end (will stop responding).
/// 2) The HandleRunspaceStateChanged event handler remains in the Runspace
/// StateChanged event call chain until this object is disposed. We have to
/// disallow the HandleRunspaceStateChanged event from running and throwing
/// an exception since this prevents other event handlers in the chain from
/// being called.
/// </remarks>
/// <param name="source">Source of this event.</param>
/// <param name="stateEventArgs">object describing state information of the
/// runspace</param>
private void HandleRunspaceStateChanged(object source, RunspaceStateEventArgs stateEventArgs)
{
// Disregard intermediate states.
switch (stateEventArgs.RunspaceStateInfo.State)
{
case RunspaceState.Opening:
case RunspaceState.BeforeOpen:
case RunspaceState.Closing:
return;
}
OperationStateEventArgs operationStateEventArgs = null;
lock (_syncObject)
{
// We must call OperationComplete ony *once* for each Start/Stop operation.
if (!_stopComplete)
{
// Note that the StopComplete callback removes *both* the Start and Stop
// operations from their respective queues. So update the member vars
// accordingly.
_stopComplete = true;
_startComplete = true;
operationStateEventArgs = new OperationStateEventArgs();
operationStateEventArgs.BaseEvent = stateEventArgs;
operationStateEventArgs.OperationState = OperationState.StopComplete;
}
else if (!_startComplete)
{
_startComplete = true;
operationStateEventArgs = new OperationStateEventArgs();
operationStateEventArgs.BaseEvent = stateEventArgs;
operationStateEventArgs.OperationState = OperationState.StartComplete;
}
}
if (operationStateEventArgs != null)
{
// Fire callbacks in list order.
FireEvent(operationStateEventArgs);
}
}
private void FireEvent(OperationStateEventArgs operationStateEventArgs)
{
EventHandler<OperationStateEventArgs>[] copyCallbacks;
lock (_internalCallbacks)
{
copyCallbacks = new EventHandler<OperationStateEventArgs>[_internalCallbacks.Count];
_internalCallbacks.CopyTo(copyCallbacks);
}
foreach (var callbackDelegate in copyCallbacks)
{
// Ensure all callbacks get called to prevent ThrottleManager from not responding.
try
{
callbackDelegate.SafeInvoke(this, operationStateEventArgs);
}
catch (Exception)
{
}
}
}
/// <summary>
/// Implements IDisposable.
/// </summary>
public void Dispose()
{
// Must remove the event callback from the new runspace or it will block other event
// handling by throwing an exception on the event thread.
OperatedRunspace.StateChanged -= HandleRunspaceStateChanged;
GC.SuppressFinalize(this);
}
}
#endregion Helper Classes
}
|