File size: 28,703 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 | // Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System.Management.Automation.Internal;
namespace System.Management.Automation.Provider
{
#region ItemCmdletProvider
/// <summary>
/// The base class for Cmdlet providers that expose an item as a PowerShell path.
/// </summary>
/// <remarks>
/// The ItemCmdletProvider class is a base class that a provider derives from to
/// inherit a set of methods that allows the PowerShell engine
/// to provide a core set of commands for getting and setting of data on one or
/// more items. A provider should derive from this class if they want
/// to take advantage of the item core commands that are
/// already implemented by the engine. This allows users to have common
/// commands and semantics across multiple providers.
/// </remarks>
public abstract class ItemCmdletProvider : DriveCmdletProvider
{
#region internal methods
/// <summary>
/// Internal wrapper for the GetItem protected method. It is called instead
/// of the protected method that is overridden by derived classes so that the
/// context of the command can be set.
/// </summary>
/// <param name="path">
/// The path to the item to retrieve.
/// </param>
/// <param name="context">
/// The context under which this method is being called.
/// </param>
/// <returns>
/// Nothing is returned, but all objects should be written to the WriteObject method.
/// </returns>
internal void GetItem(string path, CmdletProviderContext context)
{
Context = context;
// Call virtual method
GetItem(path);
}
/// <summary>
/// Gives the provider to attach additional parameters to
/// the get-item cmdlet.
/// </summary>
/// <param name="path">
/// If the path was specified on the command line, this is the path
/// to the item to get the dynamic parameters for.
/// </param>
/// <param name="context">
/// The context under which this method is being called.
/// </param>
/// <returns>
/// Overrides of this method should return an object that has properties and fields decorated with
/// parsing attributes similar to a cmdlet class or a
/// <see cref="System.Management.Automation.RuntimeDefinedParameterDictionary"/>.
///
/// The default implementation returns null. (no additional parameters)
/// </returns>
internal object GetItemDynamicParameters(string path, CmdletProviderContext context)
{
Context = context;
return GetItemDynamicParameters(path);
}
/// <summary>
/// Internal wrapper for the SetItem protected method. It is called instead
/// of the protected method that is overridden by derived classes so that the
/// context of the command can be set.
/// </summary>
/// <param name="path">
/// The path to the item to set.
/// </param>
/// <param name="value">
/// The value of the item specified by the path.
/// </param>
/// <param name="context">
/// The context under which this method is being called.
/// </param>
/// <returns>
/// The item that was set at the specified path.
/// </returns>
internal void SetItem(
string path,
object value,
CmdletProviderContext context)
{
providerBaseTracer.WriteLine("ItemCmdletProvider.SetItem");
Context = context;
// Call virtual method
SetItem(path, value);
}
/// <summary>
/// Gives the provider to attach additional parameters to
/// the set-item cmdlet.
/// </summary>
/// <param name="path">
/// If the path was specified on the command line, this is the path
/// to the item to get the dynamic parameters for.
/// </param>
/// <param name="value">
/// The value of the item specified by the path.
/// </param>
/// <param name="context">
/// The context under which this method is being called.
/// </param>
/// <returns>
/// Overrides of this method should return an object that has properties and fields decorated with
/// parsing attributes similar to a cmdlet class or a
/// <see cref="System.Management.Automation.RuntimeDefinedParameterDictionary"/>.
///
/// The default implementation returns null. (no additional parameters)
/// </returns>
internal object SetItemDynamicParameters(
string path,
object value,
CmdletProviderContext context)
{
Context = context;
return SetItemDynamicParameters(path, value);
}
/// <summary>
/// Internal wrapper for the ClearItem protected method. It is called instead
/// of the protected method that is overridden by derived classes so that the
/// context of the command can be set.
/// </summary>
/// <param name="path">
/// The path to the item to clear.
/// </param>
/// <param name="context">
/// The context under which this method is being called.
/// </param>
internal void ClearItem(
string path,
CmdletProviderContext context)
{
providerBaseTracer.WriteLine("ItemCmdletProvider.ClearItem");
Context = context;
// Call virtual method
ClearItem(path);
}
/// <summary>
/// Gives the provider to attach additional parameters to
/// the clear-item cmdlet.
/// </summary>
/// <param name="path">
/// If the path was specified on the command line, this is the path
/// to the item to get the dynamic parameters for.
/// </param>
/// <param name="context">
/// The context under which this method is being called.
/// </param>
/// <returns>
/// Overrides of this method should return an object that has properties and fields decorated with
/// parsing attributes similar to a cmdlet class or a
/// <see cref="System.Management.Automation.RuntimeDefinedParameterDictionary"/>.
///
/// The default implementation returns null. (no additional parameters)
/// </returns>
internal object ClearItemDynamicParameters(
string path,
CmdletProviderContext context)
{
Context = context;
return ClearItemDynamicParameters(path);
}
/// <summary>
/// Internal wrapper for the InvokeDefaultAction protected method. It is called instead
/// of the protected method that is overridden by derived classes so that the
/// context of the command can be set.
/// </summary>
/// <param name="path">
/// The path to the item to perform the default action on.
/// </param>
/// <param name="context">
/// The context under which this method is being called.
/// </param>
internal void InvokeDefaultAction(
string path,
CmdletProviderContext context)
{
providerBaseTracer.WriteLine("ItemCmdletProvider.InvokeDefaultAction");
Context = context;
// Call virtual method
InvokeDefaultAction(path);
}
/// <summary>
/// Gives the provider to attach additional parameters to
/// the invoke-item cmdlet.
/// </summary>
/// <param name="path">
/// If the path was specified on the command line, this is the path
/// to the item to get the dynamic parameters for.
/// </param>
/// <param name="context">
/// The context under which this method is being called.
/// </param>
/// <returns>
/// Overrides of this method should return an object that has properties and fields decorated with
/// parsing attributes similar to a cmdlet class or a
/// <see cref="System.Management.Automation.RuntimeDefinedParameterDictionary"/>.
///
/// The default implementation returns null. (no additional parameters)
/// </returns>
internal object InvokeDefaultActionDynamicParameters(
string path,
CmdletProviderContext context)
{
Context = context;
return InvokeDefaultActionDynamicParameters(path);
}
/// <summary>
/// Internal wrapper for the Exists protected method. It is called instead
/// of the protected method that is overridden by derived classes so that the
/// context of the command can be set.
/// </summary>
/// <param name="path">
/// The path to the item to see if it exists.
/// </param>
/// <param name="context">
/// The context under which this method is being called.
/// </param>
/// <returns>
/// True if the item exists, false otherwise.
/// </returns>
internal bool ItemExists(string path, CmdletProviderContext context)
{
Context = context;
// Call virtual method
bool itemExists = false;
try
{
// Some providers don't expect non-valid path elements, and instead
// throw an exception here.
itemExists = ItemExists(path);
}
catch (Exception)
{
}
return itemExists;
}
/// <summary>
/// Gives the provider to attach additional parameters to
/// the test-path cmdlet.
/// </summary>
/// <param name="path">
/// If the path was specified on the command line, this is the path
/// to the item to get the dynamic parameters for.
/// </param>
/// <param name="context">
/// The context under which this method is being called.
/// </param>
/// <returns>
/// Overrides of this method should return an object that has properties and fields decorated with
/// parsing attributes similar to a cmdlet class or a
/// <see cref="System.Management.Automation.RuntimeDefinedParameterDictionary"/>.
///
/// The default implementation returns null. (no additional parameters)
/// </returns>
internal object ItemExistsDynamicParameters(
string path,
CmdletProviderContext context)
{
Context = context;
return ItemExistsDynamicParameters(path);
}
/// <summary>
/// Internal wrapper for the IsValidPath protected method. It is called instead
/// of the protected method that is overridden by derived classes so that the
/// context of the command can be set.
/// </summary>
/// <param name="path">
/// The path to check for validity.
/// </param>
/// <param name="context">
/// The context under which this method is being called.
/// </param>
/// <returns>
/// True if the path is syntactically and semantically valid for the provider, or
/// false otherwise.
/// </returns>
/// <remarks>
/// This test should not verify the existence of the item at the path. It should
/// only perform syntactic and semantic validation of the path. For instance, for
/// the file system provider, that path should be canonicalized, syntactically verified,
/// and ensure that the path does not refer to a device.
/// </remarks>
internal bool IsValidPath(string path, CmdletProviderContext context)
{
Context = context;
// Call virtual method
return IsValidPath(path);
}
/// <summary>
/// Internal wrapper for the ExpandPath protected method. It is called instead
/// of the protected method that is overridden by derived classes so that the
/// context of the command can be set. Only called for providers that declare
/// the ExpandWildcards capability.
/// </summary>
/// <param name="path">
/// The path to expand. Expansion must be consistent with the wildcarding
/// rules of PowerShell's WildcardPattern class.
/// </param>
/// <param name="context">
/// The context under which this method is being called.
/// </param>
/// <returns>
/// A list of provider paths that this path expands to. They must all exist.
/// </returns>
internal string[] ExpandPath(string path, CmdletProviderContext context)
{
Context = context;
// Call virtual method
return ExpandPath(path);
}
#endregion internal methods
#region Protected methods
/// <summary>
/// Gets the item at the specified path.
/// </summary>
/// <param name="path">
/// The path to the item to retrieve.
/// </param>
/// <returns>
/// Nothing is returned, but all objects should be written to the WriteItemObject method.
/// </returns>
/// <remarks>
/// Providers override this method to give the user access to the provider objects using
/// the get-item and get-childitem cmdlets.
///
/// Providers that declare <see cref="System.Management.Automation.Provider.ProviderCapabilities"/>
/// of ExpandWildcards, Filter, Include, or Exclude should ensure that the path passed meets those
/// requirements by accessing the appropriate property from the base class.
///
/// By default overrides of this method should not write objects that are generally hidden from
/// the user unless the Force property is set to true. For instance, the FileSystem provider should
/// not call WriteItemObject for hidden or system files unless the Force property is set to true.
///
/// The default implementation of this method throws an <see cref="System.Management.Automation.PSNotSupportedException"/>.
/// </remarks>
protected virtual void GetItem(string path)
{
using (PSTransactionManager.GetEngineProtectionScope())
{
throw
PSTraceSource.NewNotSupportedException(
SessionStateStrings.CmdletProvider_NotSupported);
}
}
/// <summary>
/// Gives the provider an opportunity to attach additional parameters to
/// the get-item cmdlet.
/// </summary>
/// <param name="path">
/// If the path was specified on the command line, this is the path
/// to the item to get the dynamic parameters for.
/// </param>
/// <returns>
/// Overrides of this method should return an object that has properties and fields decorated with
/// parsing attributes similar to a cmdlet class or a
/// <see cref="System.Management.Automation.RuntimeDefinedParameterDictionary"/>.
///
/// The default implementation returns null. (no additional parameters)
/// </returns>
protected virtual object GetItemDynamicParameters(string path)
{
using (PSTransactionManager.GetEngineProtectionScope())
{
return null;
}
}
/// <summary>
/// Sets the item specified by the path.
/// </summary>
/// <param name="path">
/// The path to the item to set.
/// </param>
/// <param name="value">
/// The value of the item specified by the path.
/// </param>
/// <returns>
/// Nothing. The item that was set should be passed to the WriteItemObject method.
/// </returns>
/// <remarks>
/// Providers override this method to give the user the ability to modify provider objects using
/// the set-item cmdlet.
///
/// Providers that declare <see cref="System.Management.Automation.Provider.ProviderCapabilities"/>
/// of ExpandWildcards, Filter, Include, or Exclude should ensure that the path passed meets those
/// requirements by accessing the appropriate property from the base class.
///
/// By default overrides of this method should not set or write objects that are generally hidden from
/// the user unless the Force property is set to true. An error should be sent to the WriteError method if
/// the path represents an item that is hidden from the user and Force is set to false.
///
/// The default implementation of this method throws an <see cref="System.Management.Automation.PSNotSupportedException"/>.
/// </remarks>
protected virtual void SetItem(
string path,
object value)
{
using (PSTransactionManager.GetEngineProtectionScope())
{
throw
PSTraceSource.NewNotSupportedException(
SessionStateStrings.CmdletProvider_NotSupported);
}
}
/// <summary>
/// Gives the provider an opportunity to attach additional parameters to
/// the set-item cmdlet.
/// </summary>
/// <param name="path">
/// If the path was specified on the command line, this is the path
/// to the item to get the dynamic parameters for.
/// </param>
/// <param name="value">
/// The value of the item specified by the path.
/// </param>
/// <returns>
/// Overrides of this method should return an object that has properties and fields decorated with
/// parsing attributes similar to a cmdlet class or a
/// <see cref="System.Management.Automation.RuntimeDefinedParameterDictionary"/>.
///
/// The default implementation returns null. (no additional parameters)
/// </returns>
protected virtual object SetItemDynamicParameters(string path, object value)
{
using (PSTransactionManager.GetEngineProtectionScope())
{
return null;
}
}
/// <summary>
/// Clears the item specified by the path.
/// </summary>
/// <param name="path">
/// The path to the item to clear.
/// </param>
/// <returns>
/// Nothing. The item that was cleared should be passed to the WriteItemObject method.
/// </returns>
/// <remarks>
/// Providers override this method to give the user the ability to clear provider objects using
/// the clear-item cmdlet.
///
/// Providers that declare <see cref="System.Management.Automation.Provider.ProviderCapabilities"/>
/// of ExpandWildcards, Filter, Include, or Exclude should ensure that the path passed meets those
/// requirements by accessing the appropriate property from the base class.
///
/// By default overrides of this method should not clear or write objects that are generally hidden from
/// the user unless the Force property is set to true. An error should be sent to the WriteError method if
/// the path represents an item that is hidden from the user and Force is set to false.
///
/// The default implementation of this method throws an <see cref="System.Management.Automation.PSNotSupportedException"/>.
/// </remarks>
protected virtual void ClearItem(
string path)
{
using (PSTransactionManager.GetEngineProtectionScope())
{
throw
PSTraceSource.NewNotSupportedException(
SessionStateStrings.CmdletProvider_NotSupported);
}
}
/// <summary>
/// Gives the provider an opportunity to attach additional parameters to
/// the clear-item cmdlet.
/// </summary>
/// <param name="path">
/// If the path was specified on the command line, this is the path
/// to the item to get the dynamic parameters for.
/// </param>
/// <returns>
/// Overrides of this method should return an object that has properties and fields decorated with
/// parsing attributes similar to a cmdlet class or a
/// <see cref="System.Management.Automation.RuntimeDefinedParameterDictionary"/>.
///
/// The default implementation returns null. (no additional parameters)
/// </returns>
protected virtual object ClearItemDynamicParameters(string path)
{
using (PSTransactionManager.GetEngineProtectionScope())
{
return null;
}
}
/// <summary>
/// Invokes the default action on the specified item.
/// </summary>
/// <param name="path">
/// The path to the item to perform the default action on.
/// </param>
/// <returns>
/// Nothing. The item that was set should be passed to the WriteItemObject method.
/// </returns>
/// <remarks>
/// The default implementation does nothing.
///
/// Providers override this method to give the user the ability to invoke provider objects using
/// the invoke-item cmdlet. Think of the invocation as a double click in the Windows Shell. This
/// method provides a default action based on the path that was passed.
///
/// Providers that declare <see cref="System.Management.Automation.Provider.ProviderCapabilities"/>
/// of ExpandWildcards, Filter, Include, or Exclude should ensure that the path passed meets those
/// requirements by accessing the appropriate property from the base class.
///
/// By default overrides of this method should not invoke objects that are generally hidden from
/// the user unless the Force property is set to true. An error should be sent to the WriteError method if
/// the path represents an item that is hidden from the user and Force is set to false.
/// </remarks>
protected virtual void InvokeDefaultAction(
string path)
{
using (PSTransactionManager.GetEngineProtectionScope())
{
throw
PSTraceSource.NewNotSupportedException(
SessionStateStrings.CmdletProvider_NotSupported);
}
}
/// <summary>
/// Gives the provider an opportunity to attach additional parameters to
/// the invoke-item cmdlet.
/// </summary>
/// <param name="path">
/// If the path was specified on the command line, this is the path
/// to the item to get the dynamic parameters for.
/// </param>
/// <returns>
/// Overrides of this method should return an object that has properties and fields decorated with
/// parsing attributes similar to a cmdlet class or a
/// <see cref="System.Management.Automation.RuntimeDefinedParameterDictionary"/>.
///
/// The default implementation returns null. (no additional parameters)
/// </returns>
protected virtual object InvokeDefaultActionDynamicParameters(string path)
{
using (PSTransactionManager.GetEngineProtectionScope())
{
return null;
}
}
/// <summary>
/// Determines if an item exists at the specified path.
/// </summary>
/// <param name="path">
/// The path to the item to see if it exists.
/// </param>
/// <returns>
/// True if the item exists, false otherwise.
/// </returns>
/// <returns>
/// Nothing. The item that was set should be passed to the WriteItemObject method.
/// </returns>
/// <remarks>
/// Providers override this method to give the user the ability to check for the existence of provider objects using
/// the set-item cmdlet.
///
/// Providers that declare <see cref="System.Management.Automation.Provider.ProviderCapabilities"/>
/// of ExpandWildcards, Filter, Include, or Exclude should ensure that the path passed meets those
/// requirements by accessing the appropriate property from the base class.
///
/// The implementation of this method should take into account any form of access to the object that may
/// make it visible to the user. For instance, if a user has write access to a file in the file system
/// provider bug not read access, the file still exists and the method should return true. Sometimes this
/// may require checking the parent to see if the child can be enumerated.
///
/// The default implementation of this method throws an <see cref="System.Management.Automation.PSNotSupportedException"/>.
/// </remarks>
protected virtual bool ItemExists(string path)
{
using (PSTransactionManager.GetEngineProtectionScope())
{
throw
PSTraceSource.NewNotSupportedException(
SessionStateStrings.CmdletProvider_NotSupported);
}
}
/// <summary>
/// Gives the provider an opportunity to attach additional parameters to
/// the test-path cmdlet.
/// </summary>
/// <param name="path">
/// If the path was specified on the command line, this is the path
/// to the item to get the dynamic parameters for.
/// </param>
/// <returns>
/// Overrides of this method should return an object that has properties and fields decorated with
/// parsing attributes similar to a cmdlet class or a
/// <see cref="System.Management.Automation.RuntimeDefinedParameterDictionary"/>.
///
/// The default implementation returns null. (no additional parameters)
/// </returns>
protected virtual object ItemExistsDynamicParameters(string path)
{
using (PSTransactionManager.GetEngineProtectionScope())
{
return null;
}
}
/// <summary>
/// Providers must override this method to verify the syntax and semantics
/// of their paths.
/// </summary>
/// <param name="path">
/// The path to check for validity.
/// </param>
/// <returns>
/// True if the path is syntactically and semantically valid for the provider, or
/// false otherwise.
/// </returns>
/// <remarks>
/// This test should not verify the existence of the item at the path. It should
/// only perform syntactic and semantic validation of the path. For instance, for
/// the file system provider, that path should be canonicalized, syntactically verified,
/// and ensure that the path does not refer to a device.
/// </remarks>
protected abstract bool IsValidPath(string path);
/// <summary>
/// Expand a provider path that contains wildcards to a list of provider
/// paths that the path represents.Only called for providers that declare
/// the ExpandWildcards capability.
/// </summary>
/// <param name="path">
/// The path to expand. Expansion must be consistent with the wildcarding
/// rules of PowerShell's WildcardPattern class.
/// </param>
/// <returns>
/// A list of provider paths that this path expands to. They must all exist.
/// </returns>
protected virtual string[] ExpandPath(string path)
{
using (PSTransactionManager.GetEngineProtectionScope())
{
return new string[] { path };
}
}
#endregion Protected methods
}
#endregion ItemCmdletProvider
}
|