File size: 62,005 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 | // Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System.Collections;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Diagnostics.CodeAnalysis;
using System.Globalization;
using System.IO;
using System.Linq;
using System.Linq.Expressions;
using System.Management.Automation.Internal;
using System.Management.Automation.Language;
using System.Management.Automation.Runspaces;
using System.Reflection;
using System.Runtime.CompilerServices;
using System.Runtime.ExceptionServices;
using System.Runtime.Serialization;
namespace System.Management.Automation
{
/// <summary>
/// An object representing a pre-compiled block of powershell script.
/// </summary>
/// <remarks>
/// This class track a block of script in a compiled form. It is also
/// used for direct invocation of the script block.
///
/// 1. Overview
///
/// Script block comes in two forms,
///
/// a. Full form (cmdlet form)
///
/// This comes in following format
///
/// {
/// begin
/// {
/// statementlist;
/// }
/// process
/// {
/// statementlist;
/// }
/// end
/// {
/// statementlist;
/// }
/// }
///
/// This form is used for running the script in a pipeline like
/// a cmdlet.
///
/// b. Simple form
///
/// This comes in following format
///
/// {
/// statementlist;
/// }
///
/// 2. Script block execution
///
/// For the full form (or cmdlet form) of script block, the script
/// block itself is part of a pipeline. Its execution is handled through
/// ScriptCommandProcessor, which involves execution of begin/process/end
/// blocks like a cmdlet. If a scriptblock in simple form is used in
/// a pipeline, its execution is done through ScriptCommandProcessor
/// also, with some of begin/process/end blocks default to be empty.
///
/// A script block in simple form can be directly invoked (outside
/// of a pipeline context). For example,
///
/// {"text"}.Invoke()
///
/// A scriptblock can be directly invoked internally or externally through
/// runspace API.
///
/// This class will handle the logic for direct invocation of script blocks.
/// </remarks>
public partial class ScriptBlock
{
/// <summary>
/// Create a script block object based on a script string to be parsed immediately.
/// </summary>
/// <param name="context">Engine context for this script block.</param>
/// <param name="script">The string to compile.</param>
internal static ScriptBlock Create(ExecutionContext context, string script)
{
ScriptBlock sb = Create(context.Engine.EngineParser, null, script);
if (context.EngineSessionState != null && context.EngineSessionState.Module != null)
{
sb.SessionStateInternal = context.EngineSessionState;
}
return sb;
}
/// <summary>
/// Create a script block based on a script to be parsed when execution
/// context is provided.
/// </summary>
/// <param name="script">The string to compile.</param>
public static ScriptBlock Create(string script) => Create(
parser: new Parser(),
fileName: null,
fileContents: script);
internal static ScriptBlock CreateDelayParsedScriptBlock(string script, bool isProductCode)
=> new ScriptBlock(new CompiledScriptBlockData(script, isProductCode)) { DebuggerHidden = true };
/// <summary>
/// Returns a new scriptblock bound to a module. Any local variables in the
/// callers context will be copied into the module.
/// </summary>
/// <returns></returns>
public ScriptBlock GetNewClosure()
{
PSModuleInfo m = new PSModuleInfo(true);
m.CaptureLocals();
return m.NewBoundScriptBlock(this);
}
/// <summary>
/// Returns PowerShell object representing the pipeline contained in this ScriptBlock.
/// </summary>
/// <remarks>
/// Some ScriptBlocks are too complicated to be converted into a PowerShell object.
/// For those ScriptBlocks a <see cref="ScriptBlockToPowerShellNotSupportedException"/> is thrown.
///
/// ScriptBlock cannot be converted into a PowerShell object if
/// - It contains more than one statement
/// - It references variables undeclared in <c>param(...)</c> block
/// - It uses redirection to a file
/// - It uses dot sourcing
/// - Command names can't be resolved (i.e. if an element of a pipeline is another scriptblock)
///
/// Declaration of variables in a <c>param(...)</c> block is enforced,
/// because undeclared variables are assumed to be variables from a remoting server.
/// Since we need to fully evaluate parameters of commands of a PowerShell object's
/// we reject all variables references that refer to a variable from a remoting server.
/// </remarks>
/// <param name="args">
/// arguments for the ScriptBlock (providing values for variables used within the ScriptBlock);
/// can be null
/// </param>
/// <returns>
/// PowerShell object representing the pipeline contained in this ScriptBlock
/// </returns>
/// <exception cref="ScriptBlockToPowerShellNotSupportedException">
/// Thrown when this ScriptBlock cannot be expressed as a PowerShell object.
/// For example thrown when there is more than one statement, if there
/// are undeclared variables, if redirection to a file is used.
/// </exception>
/// <exception cref="RuntimeException">
/// Thrown when evaluation of command arguments results in an exception.
/// Might depend on the value of $errorActionPreference variable.
/// For example trying to translate the following ScriptBlock will result in this exception:
/// <c>$errorActionPreference = "stop"; $sb = { get-foo $( throw ) }; $sb.GetPowerShell()</c>
/// </exception>
/// <exception cref="InvalidOperationException">
/// Thrown when there is no ExecutionContext associated with this ScriptBlock object.
/// </exception>
public PowerShell GetPowerShell(params object[] args) => GetPowerShellImpl(
context: LocalPipeline.GetExecutionContextFromTLS(),
variables: null,
isTrustedInput: false,
filterNonUsingVariables: false,
createLocalScope: null,
args);
/// <summary>
/// Returns PowerShell object representing the pipeline contained in this ScriptBlock,
/// similar to the GetPowerShell() method. If the 'isTrustedInput' flag parameter is set
/// to True, then the GetPowerShell() implementation supports extended conversion operations
/// (such as replacing variable values with their current values) that might otherwise
/// be unsafe if applied to untrusted input.
/// </summary>
/// <param name="isTrustedInput">
/// Specifies whether the scriptblock being converted comes from a trusted source.
/// The default is False.
/// </param>
/// <param name="args">
/// arguments for the ScriptBlock (providing values for variables used within the ScriptBlock);
/// can be null
/// </param>
public PowerShell GetPowerShell(bool isTrustedInput, params object[] args)
=> GetPowerShellImpl(
context: LocalPipeline.GetExecutionContextFromTLS(),
variables: null,
isTrustedInput,
filterNonUsingVariables: false,
createLocalScope: null,
args);
/// <summary>
/// Returns PowerShell object representing the pipeline contained in this ScriptBlock, using variables
/// supplied in the dictionary.
/// </summary>
/// <param name="variables">
/// variables to be supplied as context to the ScriptBlock (providing values for variables explicitly
/// requested by the 'using:' prefix.
/// </param>
/// <param name="args">
/// arguments for the ScriptBlock (providing values for variables used within the ScriptBlock);
/// can be null
/// </param>
/// <returns>
/// PowerShell object representing the pipeline contained in this ScriptBlock
/// </returns>
/// <exception cref="ScriptBlockToPowerShellNotSupportedException">
/// Thrown when this ScriptBlock cannot be expressed as a PowerShell object.
/// For example thrown when there is more than one statement, if there
/// are undeclared variables, if redirection to a file is used.
/// </exception>
/// <exception cref="RuntimeException">
/// Thrown when evaluation of command arguments results in an exception.
/// Might depend on the value of $errorActionPreference variable.
/// For example trying to translate the following ScriptBlock will result in this exception:
/// <c>$errorActionPreference = "stop"; $sb = { get-foo $( throw ) }; $sb.GetPowerShell()</c>
/// </exception>
/// <exception cref="InvalidOperationException">
/// Thrown when there is no ExecutionContext associated with this ScriptBlock object and no
/// variables are supplied.
/// </exception>
public PowerShell GetPowerShell(Dictionary<string, object> variables, params object[] args)
{
ExecutionContext context = LocalPipeline.GetExecutionContextFromTLS();
Dictionary<string, object> suppliedVariables = null;
if (variables != null)
{
suppliedVariables = new Dictionary<string, object>(variables, StringComparer.OrdinalIgnoreCase);
context = null;
}
return GetPowerShellImpl(context, suppliedVariables, false, false, null, args);
}
/// <summary>
/// Returns PowerShell object representing the pipeline contained in this ScriptBlock, using variables
/// supplied in the dictionary.
/// </summary>
/// <param name="variables">
/// variables to be supplied as context to the ScriptBlock (providing values for variables explicitly
/// requested by the 'using:' prefix.
/// </param>
/// <param name="usingVariables">
/// key-value pairs from the <para>variables</para> that actually get used by the 'using:' prefix variables
/// </param>
/// <param name="args">
/// arguments for the ScriptBlock (providing values for variables used within the ScriptBlock);
/// can be null
/// </param>
/// <returns>
/// PowerShell object representing the pipeline contained in this ScriptBlock
/// </returns>
/// <exception cref="ScriptBlockToPowerShellNotSupportedException">
/// Thrown when this ScriptBlock cannot be expressed as a PowerShell object.
/// For example thrown when there is more than one statement, if there
/// are undeclared variables, if redirection to a file is used.
/// </exception>
/// <exception cref="RuntimeException">
/// Thrown when evaluation of command arguments results in an exception.
/// Might depend on the value of $errorActionPreference variable.
/// For example trying to translate the following ScriptBlock will result in this exception:
/// <c>$errorActionPreference = "stop"; $sb = { get-foo $( throw ) }; $sb.GetPowerShell()</c>
/// </exception>
/// <exception cref="InvalidOperationException">
/// Thrown when there is no ExecutionContext associated with this ScriptBlock object and no
/// variables are supplied.
/// </exception>
public PowerShell GetPowerShell(
Dictionary<string, object> variables,
out Dictionary<string, object> usingVariables,
params object[] args)
=> GetPowerShell(variables, out usingVariables, isTrustedInput: false, args);
/// <summary>
/// Returns PowerShell object representing the pipeline contained in this ScriptBlock, using variables
/// supplied in the dictionary.
/// </summary>
/// <param name="variables">
/// variables to be supplied as context to the ScriptBlock (providing values for variables explicitly
/// requested by the 'using:' prefix.
/// </param>
/// <param name="usingVariables">
/// key-value pairs from the <para>variables</para> that actually get used by the 'using:' prefix variables
/// </param>
/// <param name="args">
/// arguments for the ScriptBlock (providing values for variables used within the ScriptBlock);
/// can be null
/// </param>
/// <param name="isTrustedInput">
/// Specifies whether the scriptblock being converted comes from a trusted source.
/// The default is False.
/// </param>
/// <returns>
/// PowerShell object representing the pipeline contained in this ScriptBlock
/// </returns>
/// <exception cref="ScriptBlockToPowerShellNotSupportedException">
/// Thrown when this ScriptBlock cannot be expressed as a PowerShell object.
/// For example thrown when there is more than one statement, if there
/// are undeclared variables, if redirection to a file is used.
/// </exception>
/// <exception cref="RuntimeException">
/// Thrown when evaluation of command arguments results in an exception.
/// Might depend on the value of $errorActionPreference variable.
/// For example trying to translate the following ScriptBlock will result in this exception:
/// <c>$errorActionPreference = "stop"; $sb = { get-foo $( throw ) }; $sb.GetPowerShell()</c>
/// </exception>
/// <exception cref="InvalidOperationException">
/// Thrown when there is no ExecutionContext associated with this ScriptBlock object and no
/// variables are supplied.
/// </exception>
public PowerShell GetPowerShell(
Dictionary<string, object> variables,
out Dictionary<string, object> usingVariables,
bool isTrustedInput,
params object[] args)
{
ExecutionContext context = LocalPipeline.GetExecutionContextFromTLS();
Dictionary<string, object> suppliedVariables = null;
if (variables != null)
{
suppliedVariables = new Dictionary<string, object>(variables, StringComparer.OrdinalIgnoreCase);
context = null;
}
PowerShell powershell = GetPowerShellImpl(context, suppliedVariables, isTrustedInput, true, null, args);
usingVariables = suppliedVariables;
return powershell;
}
internal PowerShell GetPowerShell(
ExecutionContext context,
bool isTrustedInput,
bool? useLocalScope,
object[] args)
=> GetPowerShellImpl(
context,
variables: null,
isTrustedInput,
filterNonUsingVariables: false,
useLocalScope,
args);
/// <summary>
/// Get a steppable pipeline object.
/// </summary>
/// <returns>A steppable pipeline object.</returns>
[SuppressMessage(
"Microsoft.Naming",
"CA1704:IdentifiersShouldBeSpelledCorrectly",
MessageId = "Steppable",
Justification = "Review this during API naming")]
public SteppablePipeline GetSteppablePipeline()
=> GetSteppablePipelineImpl(commandOrigin: CommandOrigin.Internal, args: null);
/// <summary>
/// Get a steppable pipeline object.
/// </summary>
/// <returns>A steppable pipeline object.</returns>
[SuppressMessage(
"Microsoft.Naming",
"CA1704:IdentifiersShouldBeSpelledCorrectly",
MessageId = "Steppable",
Justification = "Review this during API naming")]
public SteppablePipeline GetSteppablePipeline(CommandOrigin commandOrigin)
=> GetSteppablePipelineImpl(commandOrigin, args: null);
/// <summary>
/// Get a steppable pipeline object.
/// </summary>
/// <returns>A steppable pipeline object.</returns>
[SuppressMessage(
"Microsoft.Naming",
"CA1704:IdentifiersShouldBeSpelledCorrectly",
MessageId = "Steppable",
Justification = "Review this during API naming")]
public SteppablePipeline GetSteppablePipeline(CommandOrigin commandOrigin, object[] args)
=> GetSteppablePipelineImpl(commandOrigin, args);
/// <summary>
/// Execute this node with the specified arguments. The arguments show
/// up in the script as $args with $_ being the first argument.
/// </summary>
/// <param name="args">The arguments to this script.</param>
/// <returns>The object(s) generated during the execution of
/// the script block returned as a collection of PSObjects.</returns>
/// <exception cref="RuntimeException">Thrown if a script runtime exceptionexception occurred.</exception>
/// <exception cref="FlowControlException">An internal (non-public) exception from a flow control statement.</exception>
public Collection<PSObject> Invoke(params object[] args) =>
DoInvoke(dollarUnder: AutomationNull.Value, input: AutomationNull.Value, args);
/// <summary>
/// A method that allows a scriptblock to be invoked with additional context in the form of a
/// set of local functions and variables to be defined in the scriptblock's scope. The list of
/// variables may include the special variables $input, $_ and $this.
///
/// This overload of the function takes a hashtable and converts it to the
/// required dictionary which makes the API easier to use from within a PowerShell script.
/// </summary>
/// <param name="functionsToDefine">A dictionary of functions to define.</param>
/// <param name="variablesToDefine">A list of variables to define.</param>
/// <param name="args">The arguments to the actual scriptblock.</param>
/// <returns></returns>
public Collection<PSObject> InvokeWithContext(
IDictionary functionsToDefine,
List<PSVariable> variablesToDefine,
params object[] args)
{
Dictionary<string, ScriptBlock> functionsToDefineDictionary = null;
if (functionsToDefine != null)
{
functionsToDefineDictionary = new Dictionary<string, ScriptBlock>();
foreach (DictionaryEntry pair in functionsToDefine)
{
string functionName = pair.Key as string;
if (string.IsNullOrWhiteSpace(functionName))
{
PSInvalidOperationException e = PSTraceSource.NewInvalidOperationException(
ParserStrings.EmptyFunctionNameInFunctionDefinitionDictionary);
e.SetErrorId("EmptyFunctionNameInFunctionDefinitionDictionary");
throw e;
}
ScriptBlock functionBody = pair.Value as ScriptBlock;
// null check for functionBody is done at the lower layer.
functionsToDefineDictionary.Add(functionName, functionBody);
}
}
return InvokeWithContext(
functionsToDefineDictionary,
variablesToDefine,
args);
}
/// <summary>
/// A method that allows a scriptblock to be invoked with additional context in the form of a
/// set of local functions and variables to be defined in the scriptblock's scope. The list of
/// variables may include the special variables $input, $_ and $this.
/// </summary>
/// <param name="functionsToDefine">A dictionary of functions to define.</param>
/// <param name="variablesToDefine">A list of variables to define.</param>
/// <param name="args">The arguments to the actual scriptblock.</param>
/// <returns></returns>
public Collection<PSObject> InvokeWithContext(
Dictionary<string, ScriptBlock> functionsToDefine,
List<PSVariable> variablesToDefine,
params object[] args)
{
object input = AutomationNull.Value;
object dollarUnder = AutomationNull.Value;
object scriptThis = AutomationNull.Value;
if (variablesToDefine != null)
{
// Extract the special variables "this", "input" and "_"
PSVariable located = variablesToDefine.Find(
v => string.Equals(v.Name, "this", StringComparison.OrdinalIgnoreCase));
if (located != null)
{
scriptThis = located.Value;
variablesToDefine.Remove(located);
}
located = variablesToDefine.Find(
v => string.Equals(v.Name, "_", StringComparison.Ordinal));
if (located != null)
{
dollarUnder = located.Value;
variablesToDefine.Remove(located);
}
located = variablesToDefine.Find(
v => string.Equals(v.Name, "input", StringComparison.OrdinalIgnoreCase));
if (located != null)
{
input = located.Value;
variablesToDefine.Remove(located);
}
}
List<object> result = new List<object>();
Pipe outputPipe = new Pipe(result);
InvokeWithPipe(
useLocalScope: true,
functionsToDefine: functionsToDefine,
variablesToDefine: variablesToDefine,
errorHandlingBehavior: ErrorHandlingBehavior.WriteToCurrentErrorPipe,
dollarUnder: dollarUnder,
input: input,
scriptThis: scriptThis,
outputPipe: outputPipe,
invocationInfo: null,
args: args);
return GetWrappedResult(result);
}
/// <summary>
/// Execute this node with the specified arguments. The arguments show
/// up in the script as $args. This overload return the raw (unwrapped) result
/// so it can be more efficient.
/// </summary>
/// <param name="args">The arguments to pass to this scriptblock.</param>
/// <returns>The object(s) generated during the execution of the
/// script block. They may or may not be wrapped in PSObject. It's up to the caller to check.</returns>
/// <exception cref="RuntimeException">Thrown if a script runtime exceptionexception occurred.</exception>
/// <exception cref="FlowControlException">An internal (non-public) exception from a flow control statement.</exception>
public object InvokeReturnAsIs(params object[] args)
=> DoInvokeReturnAsIs(
useLocalScope: true,
errorHandlingBehavior: ErrorHandlingBehavior.WriteToExternalErrorPipe,
dollarUnder: AutomationNull.Value,
input: AutomationNull.Value,
scriptThis: AutomationNull.Value,
args: args);
internal T InvokeAsMemberFunctionT<T>(object instance, object[] args)
{
List<object> result = new List<object>();
Pipe pipe = new Pipe(result);
InvokeWithPipe(
useLocalScope: true,
errorHandlingBehavior: ErrorHandlingBehavior.WriteToExternalErrorPipe,
dollarUnder: AutomationNull.Value,
input: AutomationNull.Value,
scriptThis: instance ?? AutomationNull.Value,
outputPipe: pipe,
invocationInfo: null,
propagateAllExceptionsToTop: true,
args: args);
// This is needed only for the case where the
// method returns [object]. If the argument to 'return'
// is a pipeline that emits nothing then result.Count will
// be zero so we catch that and "convert" it to null. Note that
// the return statement is still required in the method, it
// just receives nothing from it's argument.
if (result.Count == 0)
{
return default(T);
}
return (T)result[0];
}
internal void InvokeAsMemberFunction(object instance, object[] args)
{
List<object> result = new List<object>();
Pipe pipe = new Pipe(result);
InvokeWithPipe(
useLocalScope: true,
errorHandlingBehavior: ErrorHandlingBehavior.WriteToCurrentErrorPipe,
dollarUnder: AutomationNull.Value,
input: AutomationNull.Value,
scriptThis: instance ?? AutomationNull.Value,
outputPipe: pipe,
invocationInfo: null,
propagateAllExceptionsToTop: true,
args: args);
Diagnostics.Assert(result.Count == 0, "Code generation ensures we return the correct type");
}
/// <summary>
/// Return all attributes on a script block.
/// </summary>
public List<Attribute> Attributes { get => GetAttributes(); }
/// <summary>
/// The script file that defined this script block.
/// </summary>
public string File { get => GetFileName(); }
/// <summary>
/// Get/set whether this scriptblock is a filter.
/// </summary>
public bool IsFilter { get => _scriptBlockData.IsFilter; }
/// <summary>
/// Get/set whether this scriptblock is a Configuration.
/// </summary>
public bool IsConfiguration { get => _scriptBlockData.GetIsConfiguration(); }
/// <summary>
/// Get the PSModuleInfo object for the module that defined this
/// scriptblock.
/// </summary>
public PSModuleInfo Module { get => SessionStateInternal?.Module; }
/// <summary>
/// Return the PSToken object for this function definition...
/// </summary>
public PSToken StartPosition { get => GetStartPosition(); }
// LanguageMode is a nullable PSLanguageMode enumeration because script blocks
// need to inherit the language mode from the context in which they are executing.
// We can't assume FullLanguage by default when there is no context, as there are
// script blocks (such as the script blocks used in Workflow activities) that are
// created by the host without a "current language mode" to inherit. They ultimately
// get their language mode set when they are finally invoked in a constrained
// language runspace.
// Script blocks that should always be run under FullLanguage mode (i.e.: set in
// InitialSessionState, etc.) should explicitly set the LanguageMode to FullLanguage
// when they are created.
internal PSLanguageMode? LanguageMode { get; set; }
internal enum ErrorHandlingBehavior
{
WriteToCurrentErrorPipe = 1,
WriteToExternalErrorPipe = 2,
SwallowErrors = 3,
}
internal ReadOnlyCollection<PSTypeName> OutputType
{
get
{
List<PSTypeName> result = new List<PSTypeName>();
foreach (Attribute attribute in Attributes)
{
OutputTypeAttribute outputType = attribute as OutputTypeAttribute;
if (outputType != null)
{
result.AddRange(outputType.Type);
}
}
return new ReadOnlyCollection<PSTypeName>(result);
}
}
/// <summary>
/// This is a helper function to process script invocation result.
/// </summary>
/// <remarks>
/// This does normal array reduction in the case of a one-element array.
/// </remarks>
internal static object GetRawResult(List<object> result, bool wrapToPSObject)
{
switch (result.Count)
{
case 0:
return AutomationNull.Value;
case 1:
return wrapToPSObject ? LanguagePrimitives.AsPSObjectOrNull(result[0]) : result[0];
default:
object resultArray = result.ToArray();
return wrapToPSObject ? LanguagePrimitives.AsPSObjectOrNull(resultArray) : resultArray;
}
}
internal void InvokeUsingCmdlet(
Cmdlet contextCmdlet,
bool useLocalScope,
ErrorHandlingBehavior errorHandlingBehavior,
object dollarUnder,
object input,
object scriptThis,
object[] args)
{
Diagnostics.Assert(contextCmdlet != null, "caller to verify contextCmdlet parameter");
Pipe outputPipe = ((MshCommandRuntime)contextCmdlet.CommandRuntime).OutputPipe;
ExecutionContext context = GetContextFromTLS();
var myInv = context.EngineSessionState.CurrentScope.GetAutomaticVariableValue(AutomaticVariable.MyInvocation);
InvocationInfo inInfo = myInv == AutomationNull.Value ? null : (InvocationInfo)myInv;
InvokeWithPipe(
useLocalScope,
errorHandlingBehavior,
dollarUnder,
input,
scriptThis,
outputPipe,
inInfo,
propagateAllExceptionsToTop: false,
args: args);
}
/// <summary>
/// The internal session state object associated with this scriptblock.
/// </summary>
internal SessionStateInternal SessionStateInternal { get; set; }
/// <summary>
/// The session state instance that should be used when evaluating
/// this scriptblock.
/// </summary>
internal SessionState SessionState
{
get
{
if (SessionStateInternal == null)
{
ExecutionContext context = LocalPipeline.GetExecutionContextFromTLS();
if (context != null)
{
SessionStateInternal = context.EngineSessionState.PublicSessionState.Internal;
}
}
return SessionStateInternal?.PublicSessionState;
}
set
{
if (value == null)
{
throw PSTraceSource.NewArgumentNullException(nameof(value));
}
SessionStateInternal = value.Internal;
}
}
#region Delegates
private static readonly ConditionalWeakTable<ScriptBlock, ConcurrentDictionary<Type, Delegate>> s_delegateTable =
new ConditionalWeakTable<ScriptBlock, ConcurrentDictionary<Type, Delegate>>();
internal Delegate GetDelegate(Type delegateType)
=> s_delegateTable.GetOrCreateValue(this).GetOrAdd(delegateType, CreateDelegate);
/// <summary>
/// Get the delegate method as a call back.
/// </summary>
internal Delegate CreateDelegate(Type delegateType)
{
MethodInfo invokeMethod = delegateType.GetMethod("Invoke");
ParameterInfo[] parameters = invokeMethod.GetParameters();
if (invokeMethod.ContainsGenericParameters)
{
throw new ScriptBlockToPowerShellNotSupportedException(
"CantConvertScriptBlockToOpenGenericType",
null,
"AutomationExceptions",
"CantConvertScriptBlockToOpenGenericType",
delegateType);
}
var parameterExprs = new List<ParameterExpression>();
foreach (var parameter in parameters)
{
parameterExprs.Add(Expression.Parameter(parameter.ParameterType));
}
bool returnsSomething = !invokeMethod.ReturnType.Equals(typeof(void));
Expression dollarUnderExpr;
Expression dollarThisExpr;
if (parameters.Length == 2 && !returnsSomething)
{
// V1 was designed for System.EventHandler and not much else.
// The first arg (sender) was bound to $this, the second (e or EventArgs) was bound to $_.
// We do this for backwards compatibility, but we also bind the parameters (or $args) for
// consistency w/ delegates that take more or fewer parameters.
dollarUnderExpr = parameterExprs[1].Cast(typeof(object));
dollarThisExpr = parameterExprs[0].Cast(typeof(object));
}
else
{
dollarUnderExpr = ExpressionCache.AutomationNullConstant;
dollarThisExpr = ExpressionCache.AutomationNullConstant;
}
Expression call = Expression.Call(
Expression.Constant(this),
CachedReflectionInfo.ScriptBlock_InvokeAsDelegateHelper,
dollarUnderExpr,
dollarThisExpr,
Expression.NewArrayInit(typeof(object), parameterExprs.Select(static p => p.Cast(typeof(object)))));
if (returnsSomething)
{
call = DynamicExpression.Dynamic(
PSConvertBinder.Get(invokeMethod.ReturnType),
invokeMethod.ReturnType,
call);
}
return Expression.Lambda(delegateType, call, parameterExprs).Compile();
}
internal object InvokeAsDelegateHelper(object dollarUnder, object dollarThis, object[] args)
{
// Retrieve context and current runspace to ensure that we throw exception, if this is non-default runspace.
ExecutionContext context = GetContextFromTLS();
RunspaceBase runspace = (RunspaceBase)context.CurrentRunspace;
List<object> rawResult = new List<object>();
Pipe outputPipe = new Pipe(rawResult);
InvokeWithPipe(
useLocalScope: true,
errorHandlingBehavior: ErrorHandlingBehavior.WriteToCurrentErrorPipe,
dollarUnder: dollarUnder,
input: null,
scriptThis: dollarThis,
outputPipe: outputPipe,
invocationInfo: null,
args: args);
return GetRawResult(rawResult, wrapToPSObject: false);
}
#endregion
/// <summary>
/// Returns the current execution context from TLS, or raises an exception if it is null.
/// </summary>
/// <exception cref="InvalidOperationException">
/// An attempt was made to use the scriptblock outside the engine.
/// </exception>
internal ExecutionContext GetContextFromTLS()
{
ExecutionContext context = LocalPipeline.GetExecutionContextFromTLS();
// If ExecutionContext from TLS is null then we are not in powershell engine thread.
if (context == null)
{
string scriptText = this.ToString();
scriptText = ErrorCategoryInfo.Ellipsize(CultureInfo.CurrentUICulture, scriptText);
PSInvalidOperationException e = PSTraceSource.NewInvalidOperationException(
ParserStrings.ScriptBlockDelegateInvokedFromWrongThread,
scriptText);
e.SetErrorId("ScriptBlockDelegateInvokedFromWrongThread");
throw e;
}
return context;
}
/// <summary>
/// Execute this node with the specified arguments. The arguments show
/// up in the script as $args with $_ being the first argument.
/// </summary>
/// <param name="dollarUnder">
/// The value of the $_ variable for the script block. If AutomationNull.Value,
/// the $_ variable is not created.
/// </param>
/// <param name="input">
/// The value of the $input variable for the script block. If AutomationNull.Value,
/// the $input variable is not created.
/// </param>
/// <param name="args">The arguments to this script.</param>
/// <returns>The object(s) generated during the execution of
/// the script block returned as a collection of PSObjects.</returns>
/// <exception cref="RuntimeException">A script exception occurred.</exception>
/// <exception cref="FlowControlException">Internal exception from a flow control statement.</exception>
internal Collection<PSObject> DoInvoke(object dollarUnder, object input, object[] args)
{
List<object> result = new List<object>();
Pipe outputPipe = new Pipe(result);
InvokeWithPipe(
useLocalScope: true,
errorHandlingBehavior: ErrorHandlingBehavior.WriteToExternalErrorPipe,
dollarUnder: dollarUnder,
input: input,
scriptThis: AutomationNull.Value,
outputPipe: outputPipe,
invocationInfo: null,
args: args);
return GetWrappedResult(result);
}
/// <summary>
/// This is a helper function to wrap script execution results
/// in PSObjects.
/// </summary>
/// <param name="result"></param>
/// <returns></returns>
private static Collection<PSObject> GetWrappedResult(List<object> result)
{
if (result == null || result.Count == 0)
{
return new Collection<PSObject>();
}
Collection<PSObject> wrappedResult = new Collection<PSObject>();
for (int i = 0; i < result.Count; i++)
{
wrappedResult.Add(LanguagePrimitives.AsPSObjectOrNull(result[i]));
}
return wrappedResult;
}
/// <summary>
/// Execute this node with the specified arguments. The arguments show
/// up in the script as $args with $_ being the first argument.
/// </summary>
/// <param name="useLocalScope"></param>
/// <param name="errorHandlingBehavior"></param>
/// <param name="dollarUnder">
/// The value of the $_ variable for the script block. If AutomationNull.Value,
/// the $_ variable is not created.
/// </param>
/// <param name="input">
/// The value of the $input variable for the script block. If AutomationNull.Value,
/// the $input variable is not created.
/// </param>
/// <param name="scriptThis"></param>
/// <param name="args">The arguments to this script.</param>
/// <returns>The object(s) generated during the execution of
/// the script block returned as a collection of PSObjects.</returns>
/// <exception cref="RuntimeException">A script exception occurred.</exception>
/// <exception cref="FlowControlException">Internal exception from a flow control statement.</exception>
internal object DoInvokeReturnAsIs(
bool useLocalScope,
ErrorHandlingBehavior errorHandlingBehavior,
object dollarUnder,
object input,
object scriptThis,
object[] args)
{
List<object> result = new List<object>();
Pipe outputPipe = new Pipe(result);
InvokeWithPipe(
useLocalScope: useLocalScope,
errorHandlingBehavior: errorHandlingBehavior,
dollarUnder: dollarUnder,
input: input,
scriptThis: scriptThis,
outputPipe: outputPipe,
invocationInfo: null,
args: args);
return GetRawResult(result, wrapToPSObject: true);
}
internal void InvokeWithPipe(
bool useLocalScope,
ErrorHandlingBehavior errorHandlingBehavior,
object dollarUnder,
object input,
object scriptThis,
Pipe outputPipe,
InvocationInfo invocationInfo,
bool propagateAllExceptionsToTop = false,
List<PSVariable> variablesToDefine = null,
Dictionary<string, ScriptBlock> functionsToDefine = null,
object[] args = null)
{
bool shouldGenerateEvent = false;
bool oldPropagateExceptions = false;
ExecutionContext context = LocalPipeline.GetExecutionContextFromTLS();
if (SessionStateInternal != null && SessionStateInternal.ExecutionContext != context)
{
context = SessionStateInternal.ExecutionContext;
shouldGenerateEvent = true;
}
else if (context == null)
{
// This will throw.
GetContextFromTLS();
}
else
{
if (propagateAllExceptionsToTop)
{
oldPropagateExceptions = context.PropagateExceptionsToEnclosingStatementBlock;
context.PropagateExceptionsToEnclosingStatementBlock = true;
}
try
{
var runspace = (RunspaceBase)context.CurrentRunspace;
if (runspace.CanRunActionInCurrentPipeline())
{
InvokeWithPipeImpl(
useLocalScope,
functionsToDefine,
variablesToDefine,
errorHandlingBehavior,
dollarUnder,
input,
scriptThis,
outputPipe,
invocationInfo,
args);
}
else
{
shouldGenerateEvent = true;
}
}
finally
{
if (propagateAllExceptionsToTop)
{
context.PropagateExceptionsToEnclosingStatementBlock = oldPropagateExceptions;
}
}
}
if (shouldGenerateEvent)
{
context.Events.SubscribeEvent(
source: null,
eventName: PSEngineEvent.OnScriptBlockInvoke,
sourceIdentifier: PSEngineEvent.OnScriptBlockInvoke,
data: null,
handlerDelegate: new PSEventReceivedEventHandler(OnScriptBlockInvokeEventHandler),
supportEvent: true,
forwardEvent: false,
shouldQueueAndProcessInExecutionThread: true,
maxTriggerCount: 1);
var scriptBlockInvocationEventArgs = new ScriptBlockInvocationEventArgs(
scriptBlock: this,
useLocalScope,
errorHandlingBehavior,
dollarUnder,
input,
scriptThis,
outputPipe,
invocationInfo,
args);
context.Events.GenerateEvent(
sourceIdentifier: PSEngineEvent.OnScriptBlockInvoke,
sender: null,
args: new object[1] { scriptBlockInvocationEventArgs },
extraData: null,
processInCurrentThread: true,
waitForCompletionInCurrentThread: true);
scriptBlockInvocationEventArgs.Exception?.Throw();
}
}
/// <summary>
/// Handles OnScriptBlockInvoke event, this is called by the event manager.
/// </summary>
private static void OnScriptBlockInvokeEventHandler(object sender, PSEventArgs args)
{
var eventArgs = (object)args.SourceEventArgs as ScriptBlockInvocationEventArgs;
Diagnostics.Assert(eventArgs != null,
"Event Arguments to OnScriptBlockInvokeEventHandler should not be null");
try
{
ScriptBlock sb = eventArgs.ScriptBlock;
sb.InvokeWithPipeImpl(
eventArgs.UseLocalScope,
functionsToDefine: null,
variablesToDefine: null,
eventArgs.ErrorHandlingBehavior,
eventArgs.DollarUnder,
eventArgs.Input,
eventArgs.ScriptThis,
eventArgs.OutputPipe,
eventArgs.InvocationInfo,
eventArgs.Args);
}
catch (Exception e)
{
eventArgs.Exception = ExceptionDispatchInfo.Capture(e);
}
}
internal void SetPSScriptRootAndPSCommandPath(MutableTuple locals, ExecutionContext context)
{
var psScriptRoot = string.Empty;
var psCommandPath = string.Empty;
if (!string.IsNullOrEmpty(File))
{
psScriptRoot = Path.GetDirectoryName(File);
psCommandPath = File;
}
locals.SetAutomaticVariable(AutomaticVariable.PSScriptRoot, psScriptRoot, context);
locals.SetAutomaticVariable(AutomaticVariable.PSCommandPath, psCommandPath, context);
}
}
/// <summary>
/// A steppable pipeline wrapper object...
/// </summary>
[SuppressMessage(
"Microsoft.Naming",
"CA1704:IdentifiersShouldBeSpelledCorrectly",
MessageId = "Steppable",
Justification = "Consider Name change during API review")]
public sealed class SteppablePipeline : IDisposable
{
internal SteppablePipeline(ExecutionContext context, PipelineProcessor pipeline)
{
ArgumentNullException.ThrowIfNull(pipeline);
ArgumentNullException.ThrowIfNull(context);
_pipeline = pipeline;
_context = context;
}
private readonly PipelineProcessor _pipeline;
private readonly ExecutionContext _context;
private bool _expectInput;
/// <summary>
/// Begin execution of a steppable pipeline. This overload doesn't reroute output and error pipes.
/// </summary>
/// <param name="expectInput"><see langword="true"/> if you plan to write input into this pipe; <see langword="false"/> otherwise.</param>
public void Begin(bool expectInput) => Begin(expectInput, commandRuntime: (ICommandRuntime)null);
/// <summary>
/// Begin execution of a steppable pipeline, using the command running currently in the specified context to figure
/// out how to route the output and errors.
/// </summary>
/// <param name="expectInput"><see langword="true"/> if you plan to write input into this pipe; <see langword="false"/> otherwise.</param>
/// <param name="contextToRedirectTo">Context used to figure out how to route the output and errors.</param>
public void Begin(bool expectInput, EngineIntrinsics contextToRedirectTo)
{
ArgumentNullException.ThrowIfNull(contextToRedirectTo);
ExecutionContext executionContext = contextToRedirectTo.SessionState.Internal.ExecutionContext;
CommandProcessorBase commandProcessor = executionContext.CurrentCommandProcessor;
ICommandRuntime crt = commandProcessor?.CommandRuntime;
Begin(expectInput, crt);
}
/// <summary>
/// Begin execution of a steppable pipeline, using the calling command to figure
/// out how to route the output and errors. This is the most effective
/// way to start stepping.
/// </summary>
/// <param name="command">The command you're calling this from (i.e. instance of PSCmdlet or value of $PSCmdlet variable).</param>
public void Begin(InternalCommand command)
{
if (command is null || command.MyInvocation is null)
{
throw new ArgumentNullException(nameof(command));
}
Begin(command.MyInvocation.ExpectingInput, command.commandRuntime);
}
private void Begin(bool expectInput, ICommandRuntime commandRuntime)
{
try
{
_pipeline.ExecutionScope = _context.EngineSessionState.CurrentScope;
_context.PushPipelineProcessor(_pipeline);
_expectInput = expectInput;
// Start the pipeline, if the command calling this pipeline is
// not expecting input (as indicated by it's position in the pipeline
// then neither should we.
MshCommandRuntime crt = commandRuntime as MshCommandRuntime;
if (crt != null)
{
if (crt.OutputPipe != null)
{
_pipeline.LinkPipelineSuccessOutput(crt.OutputPipe);
}
if (crt.ErrorOutputPipe != null)
{
_pipeline.LinkPipelineErrorOutput(crt.ErrorOutputPipe);
}
}
_pipeline.StartStepping(_expectInput);
}
finally
{
// then pop this pipeline...
_context.PopPipelineProcessor(true);
}
}
/// <summary>
/// Process a single input object.
/// </summary>
/// <param name="input">The object to process.</param>
/// <returns>A collection of 0 or more result objects.</returns>
public Array Process(object input)
{
try
{
_context.PushPipelineProcessor(_pipeline);
if (_expectInput)
{
return _pipeline.Step(input);
}
else
{
return _pipeline.Step(AutomationNull.Value);
}
}
finally
{
// then pop this pipeline...
_context.PopPipelineProcessor(true);
}
}
/// <summary>
/// Process a single PSObject. This overload exists to deal with the fact
/// that the PowerShell runtime will PSBase an object before passing it to
/// a .NET API call with argument type object.
/// </summary>
/// <param name="input">The input object to process.</param>
/// <returns></returns>
public Array Process(PSObject input)
{
try
{
_context.PushPipelineProcessor(_pipeline);
if (_expectInput)
{
return _pipeline.Step(input);
}
else
{
return _pipeline.Step(AutomationNull.Value);
}
}
finally
{
// then pop this pipeline...
_context.PopPipelineProcessor(true);
}
}
/// <summary>
/// Process with no input. This is used in the case where
/// Begin() was called with $false so we won't send any
/// input to be processed.
/// </summary>
/// <returns>The result of the execution.</returns>
public Array Process()
{
try
{
_context.PushPipelineProcessor(_pipeline);
return _pipeline.Step(AutomationNull.Value);
}
finally
{
// then pop this pipeline...
_context.PopPipelineProcessor(true);
}
}
/// <summary>
/// End the execution of this steppable pipeline. This will
/// complete the execution and dispose the results.
/// </summary>
public Array End()
{
try
{
_context.PushPipelineProcessor(_pipeline);
return _pipeline.DoComplete();
}
finally
{
// then pop this pipeline and dispose it...
_context.PopPipelineProcessor(true);
Dispose();
}
}
/// <summary>
/// Clean resources for script commands of this steppable pipeline.
/// </summary>
/// <remarks>
/// <para>
/// The way we handle 'Clean' blocks in a steppable pipeline makes sure that:</para>
/// <para>1. The 'Clean' blocks get to run if any exception is thrown from 'Begin/Process/End'.</para>
/// <para>2. The 'Clean' blocks get to run if 'End' finished successfully.</para>
/// <para>
/// However, this is not enough for a steppable pipeline, because the function, where the steppable
/// pipeline gets used, may fail (think about a proxy function). And that may lead to the situation
/// where "no exception was thrown from the steppable pipeline" but "the steppable pipeline didn't
/// run to the end". In that case, 'Clean' won't run unless it's triggered explicitly on the steppable
/// pipeline. This method allows a user to do that from the 'Clean' block of the proxy function.</para>
/// </remarks>
public void Clean()
{
if (_pipeline.Commands is null)
{
// The pipeline commands have been disposed. In this case, 'Clean'
// should have already been called on the pipeline processor.
return;
}
try
{
_context.PushPipelineProcessor(_pipeline);
_pipeline.DoCleanup();
}
finally
{
// then pop this pipeline and dispose it...
_context.PopPipelineProcessor(true);
Dispose();
}
}
#region IDispose
private bool _disposed;
/// <summary>
/// IDisposable implementation
/// When this object is disposed, the contained pipeline should also be disposed.
/// </summary>
public void Dispose()
{
if (_disposed)
{
return;
}
_pipeline.Dispose();
_disposed = true;
}
#endregion IDispose
}
/// <summary>
/// Defines the exception thrown when conversion from ScriptBlock to PowerShell is forbidden
/// (i.e. when the script block has undeclared variables or more than one statement)
/// </summary>
public class ScriptBlockToPowerShellNotSupportedException : RuntimeException
{
#region ctor
/// <summary>
/// Initializes a new instance of ScriptBlockToPowerShellNotSupportedException
/// with the message set to typeof(ScriptBlockToPowerShellNotSupportedException).FullName.
/// </summary>
public ScriptBlockToPowerShellNotSupportedException()
: base(typeof(ScriptBlockToPowerShellNotSupportedException).FullName)
{
}
/// <summary>
/// Initializes a new instance of ScriptBlockToPowerShellNotSupportedException setting the message.
/// </summary>
/// <param name="message">The exception's message.</param>
public ScriptBlockToPowerShellNotSupportedException(string message)
: base(message)
{
}
/// <summary>
/// Initializes a new instance of ScriptBlockToPowerShellNotSupportedException setting the message and innerException.
/// </summary>
/// <param name="message">The exception's message.</param>
/// <param name="innerException">The exception's inner exception.</param>
public ScriptBlockToPowerShellNotSupportedException(string message, Exception innerException)
: base(message, innerException)
{
}
/// <summary>
/// Recommended constructor for the class.
/// </summary>
/// <param name="errorId">String that uniquely identifies each thrown Exception.</param>
/// <param name="innerException">The inner exception.</param>
/// <param name="message">The error message.</param>
/// <param name="arguments">Arguments to the resource string.</param>
internal ScriptBlockToPowerShellNotSupportedException(
string errorId,
Exception innerException,
string message,
params object[] arguments)
: base(string.Format(CultureInfo.CurrentCulture, message, arguments), innerException)
=> this.SetErrorId(errorId);
#region Serialization
/// <summary>
/// Initializes a new instance of ScriptBlockToPowerShellNotSupportedException with serialization parameters.
/// </summary>
/// <param name="info">Serialization information.</param>
/// <param name="context">Streaming context.</param>
[Obsolete("Legacy serialization support is deprecated since .NET 8", DiagnosticId = "SYSLIB0051")]
protected ScriptBlockToPowerShellNotSupportedException(SerializationInfo info, StreamingContext context)
{
throw new NotSupportedException();
}
#endregion Serialization
#endregion ctor
}
/// <summary>
/// Defines Event arguments passed to OnScriptBlockInvocationEventHandler.
/// </summary>
internal sealed class ScriptBlockInvocationEventArgs : EventArgs
{
/// <summary>
/// Constructs ScriptBlockInvocationEventArgs.
/// </summary>
/// <param name="scriptBlock">The scriptblock to invoke
/// </param>
/// /// <param name="useLocalScope"></param>
/// <param name="errorHandlingBehavior"></param>
/// <param name="dollarUnder">
/// The value of the $_ variable for the script block. If AutomationNull.Value,
/// the $_ variable is not created.
/// </param>
/// <param name="input">
/// The value of the $input variable for the script block. If AutomationNull.Value,
/// the $input variable is not created.
/// </param>
/// <param name="scriptThis"></param>
/// <param name="outputPipe">The output pipe which has the results of the invocation
/// </param>
/// <param name="invocationInfo">The information about current state of the runspace.</param>
/// <param name="args">The arguments to this script.</param>
/// <exception cref="ArgumentNullException">ScriptBlock is null
/// </exception>
internal ScriptBlockInvocationEventArgs(
ScriptBlock scriptBlock,
bool useLocalScope,
ScriptBlock.ErrorHandlingBehavior errorHandlingBehavior,
object dollarUnder,
object input,
object scriptThis,
Pipe outputPipe,
InvocationInfo invocationInfo,
object[] args)
{
if (scriptBlock == null)
{
throw PSTraceSource.NewArgumentNullException(nameof(scriptBlock));
}
ScriptBlock = scriptBlock;
OutputPipe = outputPipe;
UseLocalScope = useLocalScope;
ErrorHandlingBehavior = errorHandlingBehavior;
DollarUnder = dollarUnder;
Input = input;
ScriptThis = scriptThis;
InvocationInfo = invocationInfo;
Args = args;
}
internal ScriptBlock ScriptBlock { get; set; }
internal bool UseLocalScope { get; set; }
internal ScriptBlock.ErrorHandlingBehavior ErrorHandlingBehavior { get; set; }
internal object DollarUnder { get; set; }
internal object Input { get; set; }
internal object ScriptThis { get; set; }
internal Pipe OutputPipe { get; set; }
internal InvocationInfo InvocationInfo { get; set; }
internal object[] Args { get; set; }
/// <summary>
/// Holds the exception thrown during scriptblock invocation.
/// </summary>
internal ExceptionDispatchInfo Exception { get; set; }
}
}
|