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
|
namespace System.Workflow.Activities
{
#region Imports
using System;
using System.Text;
using System.Reflection;
using System.Collections;
using System.CodeDom;
using System.ComponentModel;
using System.ComponentModel.Design;
using System.Drawing.Design;
using System.Drawing;
using System.Diagnostics;
using System.Workflow.ComponentModel;
using System.Workflow.ComponentModel.Design;
using System.Workflow.Runtime;
using System.Runtime.Serialization;
using System.Collections.Generic;
using System.ComponentModel.Design.Serialization;
using System.Xml.Serialization;
using System.Workflow.ComponentModel.Compiler;
#endregion
[SRDescription(SR.StateActivityDescription)]
[ToolboxItem(typeof(ActivityToolboxItem))]
[Designer(typeof(StateDesigner), typeof(IDesigner))]
[ToolboxBitmap(typeof(StateActivity), "Resources.StateActivity.png")]
[ActivityValidator(typeof(StateActivityValidator))]
[SRCategory(SR.Standard)]
[System.Runtime.InteropServices.ComVisible(false)]
[Obsolete("The System.Workflow.* types are deprecated. Instead, please use the new types from System.Activities.*")]
public class StateActivity : CompositeActivity
{
#region Fields
public const string StateChangeTrackingDataKey = "StateActivity.StateChange";
internal static DependencyProperty StateMachineExecutionStateProperty = DependencyProperty.Register(StateMachineExecutionState.StateMachineExecutionStateKey, typeof(StateMachineExecutionState), typeof(StateActivity), new PropertyMetadata());
#endregion Fields
#region Constructor
public StateActivity()
{
}
public StateActivity(string name)
: base(name)
{
}
#endregion Constructor
#region Methods
protected override void OnClosed(IServiceProvider provider)
{
base.RemoveProperty(StateActivity.StateMachineExecutionStateProperty);
}
#region Public Methods
[Browsable(false)]
[DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
internal Activity GetDynamicActivity(Activity childActivity)
{
if (childActivity == null)
throw new ArgumentNullException("childActivity");
if (!this.EnabledActivities.Contains(childActivity))
throw new ArgumentException(SR.GetString(SR.Error_StateChildNotFound), "childActivity");
else
{
Activity[] dynamicChildActivity = this.GetDynamicActivities(childActivity);
if (dynamicChildActivity.Length != 0)
return dynamicChildActivity[0];
else
return null;
}
}
public Activity GetDynamicActivity(String childActivityName)
{
if (childActivityName == null)
throw new ArgumentNullException("childActivityName");
Activity childActivity = null;
for (int i = 0; i < this.EnabledActivities.Count; ++i)
{
if (this.EnabledActivities[i].QualifiedName.Equals(childActivityName))
{
childActivity = this.EnabledActivities[i];
break;
}
}
if (childActivity != null)
return GetDynamicActivity(childActivity);
throw new ArgumentException(SR.GetString(SR.Error_StateChildNotFound), "childActivityName");
}
#endregion Public Methods
protected override void Initialize(IServiceProvider provider)
{
base.Initialize(provider);
ActivityExecutionContext context = (ActivityExecutionContext)provider;
StateActivity rootState = StateMachineHelpers.GetRootState(this);
if (!StateMachineHelpers.IsStateMachine(rootState))
throw new InvalidOperationException(SR.GetError_StateActivityMustBeContainedInAStateMachine());
string initialStateName = StateMachineHelpers.GetInitialStateName(this);
if (String.IsNullOrEmpty(initialStateName))
throw new InvalidOperationException(SR.GetError_CannotExecuteStateMachineWithoutInitialState());
//
if (this.QualifiedName != initialStateName)
StateMachineSubscriptionManager.DisableStateWorkflowQueues(context, this);
}
protected override ActivityExecutionStatus Execute(ActivityExecutionContext executionContext)
{
if (executionContext == null)
throw new ArgumentNullException("executionContext");
if (StateMachineHelpers.IsRootState(this))
{
ExecuteRootState(executionContext);
}
else
{
if (StateMachineHelpers.IsLeafState(this))
{
ExecuteLeafState(executionContext);
}
else
{
ExecuteState(executionContext);
}
}
return this.ExecutionStatus;
}
private void ExecuteRootState(ActivityExecutionContext context)
{
StateActivity state = (StateActivity)context.Activity;
StateMachineExecutionState executionState = new StateMachineExecutionState(this.WorkflowInstanceId);
executionState.SchedulerBusy = false;
state.SetValue(StateActivity.StateMachineExecutionStateProperty, executionState);
executionState.SubscriptionManager.CreateSetStateEventQueue(context);
string initialStateName = StateMachineHelpers.GetInitialStateName(state);
executionState.CalculateStateTransition(this, initialStateName);
executionState.ProcessActions(context);
}
private static void ExecuteState(ActivityExecutionContext context)
{
StateMachineExecutionState executionState = GetExecutionState(context);
executionState.SchedulerBusy = false;
executionState.ProcessActions(context);
}
private static void ExecuteLeafState(ActivityExecutionContext context)
{
StateActivity state = (StateActivity)context.Activity;
StateMachineExecutionState executionState = GetExecutionState(state);
executionState.SchedulerBusy = false;
executionState.CurrentStateName = state.QualifiedName;
StateInitializationActivity stateInitialization = GetStateInitialization(context);
if (stateInitialization != null)
{
ExecuteStateInitialization(context, stateInitialization);
}
else
{
EnteringLeafState(context);
}
}
private static void EnteringLeafState(ActivityExecutionContext context)
{
if (context == null)
throw new ArgumentNullException("context");
StateActivity state = (StateActivity)context.Activity;
Debug.Assert(StateMachineHelpers.IsLeafState(state));
StateMachineExecutionState executionState = GetExecutionState(state);
executionState.SubscriptionManager.SubscribeToSetStateEvent(context);
string completedStateName = StateMachineHelpers.GetCompletedStateName(state);
if (StateMachineHelpers.IsCompletedState(state))
{
// make sure that we track that we entered the completed state
EnteringStateAction enteringState = new EnteringStateAction(state.QualifiedName);
executionState.EnqueueAction(enteringState);
executionState.ProcessActions(context);
// this is the final state, so we start completing this tree
executionState.Completed = true;
LeavingState(context);
}
else
{
if (String.IsNullOrEmpty(executionState.NextStateName))
{
executionState.SubscriptionManager.ReevaluateSubscriptions(context);
EnteringStateAction enteringState = new EnteringStateAction(state.QualifiedName);
executionState.EnqueueAction(enteringState);
executionState.LockQueue();
}
else
{
// The StateInitialization requested a state transtion
EnteringStateAction enteringState = new EnteringStateAction(state.QualifiedName);
executionState.EnqueueAction(enteringState);
executionState.ProcessTransitionRequest(context);
}
executionState.ProcessActions(context);
}
}
internal static void LeavingState(ActivityExecutionContext context)
{
if (context == null)
throw new ArgumentNullException("context");
StateActivity state = (StateActivity)context.Activity;
if (StateMachineHelpers.IsLeafState(state))
{
StateFinalizationActivity stateFinalization = GetStateFinalization(context);
if (stateFinalization == null)
Complete(context);
else
ExecuteStateFinalization(context, stateFinalization);
}
else
Complete(context);
}
private static void CleanUp(ActivityExecutionContext context)
{
if (context == null)
throw new ArgumentNullException("context");
StateActivity state = (StateActivity)context.Activity;
if (state.ExecutionStatus == ActivityExecutionStatus.Faulting)
return; // if we're faulting, then we're already in a bad state, so we don't try to unsubscribe
StateMachineExecutionState executionState = GetExecutionState(state);
StateMachineSubscriptionManager subscriptionManager = executionState.SubscriptionManager;
subscriptionManager.UnsubscribeState(context);
if (StateMachineHelpers.IsRootState(state))
subscriptionManager.DeleteSetStateEventQueue(context);
else if (StateMachineHelpers.IsLeafState(state))
subscriptionManager.UnsubscribeToSetStateEvent(context);
}
protected override ActivityExecutionStatus Cancel(ActivityExecutionContext executionContext)
{
if (executionContext == null)
throw new ArgumentNullException("executionContext");
CleanUp(executionContext);
Debug.Assert(executionContext.Activity == this);
bool canCloseNow = true;
ActivityExecutionContextManager contextManager = executionContext.ExecutionContextManager;
foreach (ActivityExecutionContext existingContext in contextManager.ExecutionContexts)
{
if (existingContext.Activity.Parent == this)
{
canCloseNow = false;
if (existingContext.Activity.ExecutionStatus == ActivityExecutionStatus.Executing)
existingContext.CancelActivity(existingContext.Activity);
}
}
return canCloseNow ? ActivityExecutionStatus.Closed : this.ExecutionStatus;
}
private static void Complete(ActivityExecutionContext context)
{
if (context == null)
throw new ArgumentNullException("context");
StateActivity state = (StateActivity)context.Activity;
StateMachineExecutionState executionState = GetExecutionState(state);
if (StateMachineHelpers.IsLeafState(state))
{
executionState.PreviousStateName = state.Name;
}
CleanUp(context);
executionState.SchedulerBusy = true;
context.CloseActivity();
}
private static void ExecuteChild(ActivityExecutionContext context, Activity childActivity)
{
if (context == null)
throw new ArgumentNullException("context");
if (childActivity == null)
throw new ArgumentNullException("childActivity");
StateActivity state = (StateActivity)context.Activity;
StateMachineExecutionState executionState = GetExecutionState(state);
Debug.Assert(!executionState.SchedulerBusy);
executionState.SchedulerBusy = true;
ActivityExecutionContextManager contextManager = context.ExecutionContextManager;
ActivityExecutionContext childContext = contextManager.CreateExecutionContext(childActivity);
childContext.Activity.Closed += state.HandleChildActivityClosed;
childContext.ExecuteActivity(childContext.Activity);
}
private static void CleanupChildAtClosure(ActivityExecutionContext context, Activity childActivity)
{
if (context == null)
throw new ArgumentNullException("context");
if (childActivity == null)
throw new ArgumentNullException("childActivity");
StateActivity state = (StateActivity)context.Activity;
StateMachineExecutionState executionState = GetExecutionState(state);
childActivity.Closed -= state.HandleChildActivityClosed;
ActivityExecutionContextManager contextManager = context.ExecutionContextManager;
ActivityExecutionContext childContext = contextManager.GetExecutionContext(childActivity);
contextManager.CompleteExecutionContext(childContext);
}
internal void RaiseProcessActionEvent(ActivityExecutionContext context)
{
StateMachineExecutionState executionState = GetExecutionState(context);
Debug.Assert(!executionState.SchedulerBusy);
executionState.SchedulerBusy = true;
base.Invoke<EventArgs>(this.HandleProcessActionEvent, new EventArgs());
}
private void HandleProcessActionEvent(object sender,
EventArgs eventArgs)
{
ActivityExecutionContext context = sender as ActivityExecutionContext;
if (context == null)
throw new ArgumentException(SR.Error_SenderMustBeActivityExecutionContext, "sender");
StateMachineExecutionState executionState = GetExecutionState(context);
executionState.SchedulerBusy = false;
executionState.ProcessActions(context);
}
#region HandleStatusChange
private void HandleChildActivityClosed(object sender, ActivityExecutionStatusChangedEventArgs eventArgs)
{
ActivityExecutionContext context = sender as ActivityExecutionContext;
if (context == null)
throw new ArgumentException(SR.Error_SenderMustBeActivityExecutionContext, "sender");
if (eventArgs == null)
throw new ArgumentNullException("eventArgs");
Activity completedChildActivity = eventArgs.Activity;
StateActivity state = (StateActivity)context.Activity;
StateMachineExecutionState executionState = GetExecutionState(context);
executionState.SchedulerBusy = false;
CleanupChildAtClosure(context, completedChildActivity);
switch (state.ExecutionStatus)
{
case ActivityExecutionStatus.Canceling:
case ActivityExecutionStatus.Faulting:
context.CloseActivity();
return;
case ActivityExecutionStatus.Executing:
if (completedChildActivity is EventDrivenActivity)
{
HandleEventDrivenCompleted(context);
return;
}
StateInitializationActivity stateInitialization = completedChildActivity as StateInitializationActivity;
if (stateInitialization != null)
{
HandleStateInitializationCompleted(context, stateInitialization);
return;
}
if (completedChildActivity is StateFinalizationActivity)
{
HandleStateFinalizationCompleted(context);
return;
}
if (completedChildActivity is StateActivity)
{
HandleSubStateCompleted(context);
return;
}
InvalidChildActivity(state);
break;
default:
throw new InvalidOperationException(SR.GetInvalidActivityStatus(context.Activity));
}
}
private static void InvalidChildActivity(StateActivity state)
{
if (StateMachineHelpers.IsLeafState(state))
throw new InvalidOperationException(SR.GetError_InvalidLeafStateChild());
else
throw new InvalidOperationException(SR.GetError_InvalidCompositeStateChild());
}
internal static void ExecuteEventDriven(ActivityExecutionContext context, EventDrivenActivity eventDriven)
{
StateMachineExecutionState executionState = GetExecutionState(context);
Debug.Assert(!executionState.HasEnqueuedActions);
ExecuteChild(context, eventDriven);
}
private static void HandleEventDrivenCompleted(ActivityExecutionContext context)
{
if (context == null)
throw new ArgumentNullException("context");
StateActivity state = (StateActivity)context.Activity;
StateMachineExecutionState executionState = GetExecutionState(context);
if (String.IsNullOrEmpty(executionState.NextStateName))
{
executionState.SubscriptionManager.ReevaluateSubscriptions(context);
executionState.LockQueue();
}
else
executionState.ProcessTransitionRequest(context);
executionState.ProcessActions(context);
}
private static void ExecuteStateInitialization(ActivityExecutionContext context, StateInitializationActivity stateInitialization)
{
StateMachineExecutionState executionState = GetExecutionState(context);
Debug.Assert(!executionState.HasEnqueuedActions);
ExecuteChild(context, stateInitialization);
}
private static void HandleStateInitializationCompleted(ActivityExecutionContext context, StateInitializationActivity stateInitialization)
{
if (context == null)
throw new ArgumentNullException("context");
if (stateInitialization == null)
throw new ArgumentNullException("stateInitialization");
StateActivity state = (StateActivity)context.Activity;
StateMachineExecutionState executionState = GetExecutionState(state);
if (!String.IsNullOrEmpty(executionState.NextStateName) && executionState.NextStateName.Equals(state.QualifiedName))
throw new InvalidOperationException(SR.GetInvalidSetStateInStateInitialization());
EnteringLeafState(context);
}
private static void ExecuteStateFinalization(ActivityExecutionContext context, StateFinalizationActivity stateFinalization)
{
StateMachineExecutionState executionState = GetExecutionState(context);
ExecuteChild(context, stateFinalization);
}
private static void HandleStateFinalizationCompleted(ActivityExecutionContext context)
{
if (context == null)
throw new ArgumentNullException("context");
StateMachineExecutionState executionState = GetExecutionState(context);
Complete(context);
}
internal static void ExecuteState(ActivityExecutionContext context, StateActivity state)
{
StateMachineExecutionState executionState = GetExecutionState(context);
ExecuteChild(context, state);
}
private static void HandleSubStateCompleted(ActivityExecutionContext context)
{
if (context == null)
throw new ArgumentNullException("context");
StateMachineExecutionState executionState = GetExecutionState(context);
if (executionState.Completed)
{
// We're closing the state machine
LeavingState(context);
}
else
{
executionState.ProcessActions(context);
}
}
#endregion
#region Helper methods
private static StateInitializationActivity GetStateInitialization(ActivityExecutionContext context)
{
StateActivity state = (StateActivity)context.Activity;
Debug.Assert(StateMachineHelpers.IsLeafState(state),
"GetStateInitialization: StateInitialization is only allowed in a leaf node state");
return GetHandlerActivity<StateInitializationActivity>(context);
}
private static StateFinalizationActivity GetStateFinalization(ActivityExecutionContext context)
{
StateActivity state = (StateActivity)context.Activity;
Debug.Assert(StateMachineHelpers.IsLeafState(state),
"GetStateFinalization: StateFinalization is only allowed in a leaf node state");
return GetHandlerActivity<StateFinalizationActivity>(context);
}
private static T GetHandlerActivity<T>(ActivityExecutionContext context) where T : class
{
StateActivity state = (StateActivity)context.Activity;
foreach (Activity activity in state.EnabledActivities)
{
T handler = activity as T;
if (handler != null)
{
return handler;
}
}
return null;
}
private static StateMachineExecutionState GetExecutionState(ActivityExecutionContext context)
{
if (context == null)
throw new ArgumentNullException("context");
StateActivity state = (StateActivity)context.Activity;
StateMachineExecutionState executionState = GetExecutionState(state);
return executionState;
}
private static StateMachineExecutionState GetExecutionState(StateActivity state)
{
if (state == null)
throw new ArgumentNullException("state");
StateActivity rootState = StateMachineHelpers.GetRootState(state);
StateMachineExecutionState executionState = StateMachineExecutionState.Get(rootState);
return executionState;
}
#endregion
#endregion Methods
#region Dynamic Update Functions
protected override void OnActivityChangeAdd(ActivityExecutionContext executionContext, Activity addedActivity)
{
if (executionContext == null)
throw new ArgumentNullException("executionContext");
if (addedActivity == null)
throw new ArgumentNullException("addedActivity");
if (!addedActivity.Enabled)
return;
if (executionContext.Activity.ExecutionStatus != ActivityExecutionStatus.Executing)
return; // activity is not executing
EventDrivenActivity eventDriven = addedActivity as EventDrivenActivity;
if (eventDriven == null)
return;
// Activity we added is an EventDrivenActivity
// First we disable the queue
StateMachineSubscriptionManager.ChangeEventDrivenQueueState(executionContext, eventDriven, false);
StateActivity rootState = StateMachineHelpers.GetRootState(executionContext.Activity as StateActivity);
StateMachineExecutionState executionState = StateMachineExecutionState.Get(rootState);
StateActivity currentState = StateMachineHelpers.GetCurrentState(executionContext);
if (currentState == null)
return; // Dynamic update happened before we entered the initial state
StateMachineSubscriptionManager subscriptionManager = executionState.SubscriptionManager;
subscriptionManager.ReevaluateSubscriptions(executionContext);
executionState.LockQueue();
executionState.ProcessActions(executionContext);
}
#endregion
}
}
|