317 lines
15 KiB
C#
317 lines
15 KiB
C#
//------------------------------------------------------------------------------
|
|
// <copyright file="ScriptControlManager.cs" company="Microsoft">
|
|
// Copyright (c) Microsoft Corporation. All rights reserved.
|
|
// </copyright>
|
|
//------------------------------------------------------------------------------
|
|
|
|
namespace System.Web.UI {
|
|
using System;
|
|
using System.Collections.ObjectModel;
|
|
using System.Collections.Generic;
|
|
using System.Globalization;
|
|
using System.Text;
|
|
using System.Web.UI;
|
|
using System.Web.Resources;
|
|
using System.Web.Util;
|
|
|
|
using Debug = System.Diagnostics.Debug;
|
|
|
|
internal class ScriptControlManager {
|
|
private OrderedDictionary<IExtenderControl, List<Control>> _extenderControls;
|
|
private bool _pagePreRenderRaised;
|
|
private OrderedDictionary<IScriptControl, int> _scriptControls;
|
|
private ScriptManager _scriptManager;
|
|
private bool _scriptReferencesRegistered;
|
|
|
|
public ScriptControlManager(ScriptManager scriptManager) {
|
|
_scriptManager = scriptManager;
|
|
}
|
|
|
|
private OrderedDictionary<IExtenderControl, List<Control>> ExtenderControls {
|
|
get {
|
|
if (_extenderControls == null) {
|
|
_extenderControls = new OrderedDictionary<IExtenderControl, List<Control>>();
|
|
}
|
|
return _extenderControls;
|
|
}
|
|
}
|
|
|
|
private OrderedDictionary<IScriptControl, int> ScriptControls {
|
|
get {
|
|
if (_scriptControls == null) {
|
|
_scriptControls = new OrderedDictionary<IScriptControl, int>();
|
|
}
|
|
return _scriptControls;
|
|
}
|
|
}
|
|
|
|
public void AddScriptReferences(List<ScriptReferenceBase> scriptReferences) {
|
|
#if DEBUG
|
|
if (_scriptReferencesRegistered) {
|
|
Debug.Fail("AddScriptReferences should only be called once per request but it was already called during this request.");
|
|
}
|
|
#endif
|
|
AddScriptReferencesForScriptControls(scriptReferences);
|
|
AddScriptReferencesForExtenderControls(scriptReferences);
|
|
|
|
_scriptReferencesRegistered = true;
|
|
}
|
|
|
|
private void AddScriptReferencesForScriptControls(List<ScriptReferenceBase> scriptReferences) {
|
|
// PERF: Use field directly to avoid creating Dictionary if not already created
|
|
if (_scriptControls != null) {
|
|
foreach (IScriptControl scriptControl in _scriptControls.Keys) {
|
|
AddScriptReferenceForScriptControl(scriptReferences, scriptControl);
|
|
}
|
|
}
|
|
}
|
|
|
|
private static void AddScriptReferenceForScriptControl(List<ScriptReferenceBase> scriptReferences,
|
|
IScriptControl scriptControl) {
|
|
IEnumerable<ScriptReference> scriptControlReferences = scriptControl.GetScriptReferences();
|
|
|
|
if (scriptControlReferences != null) {
|
|
Control scriptControlAsControl = (Control)scriptControl;
|
|
ClientUrlResolverWrapper urlResolverWrapper = null;
|
|
foreach (ScriptReference scriptControlReference in scriptControlReferences) {
|
|
if (scriptControlReference != null) {
|
|
if (urlResolverWrapper == null) {
|
|
urlResolverWrapper = new ClientUrlResolverWrapper(scriptControlAsControl);
|
|
}
|
|
// set containing control on each script reference for client url resolution
|
|
scriptControlReference.ClientUrlResolver = urlResolverWrapper;
|
|
scriptControlReference.IsStaticReference = false;
|
|
scriptControlReference.ContainingControl = scriptControlAsControl;
|
|
|
|
// add to collection of all references
|
|
scriptReferences.Add(scriptControlReference);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
private void AddScriptReferencesForExtenderControls(List<ScriptReferenceBase> scriptReferences) {
|
|
// PERF: Use field directly to avoid creating Dictionary if not already created
|
|
if (_extenderControls != null) {
|
|
foreach (IExtenderControl extenderControl in _extenderControls.Keys) {
|
|
AddScriptReferenceForExtenderControl(scriptReferences, extenderControl);
|
|
}
|
|
}
|
|
}
|
|
|
|
private static void AddScriptReferenceForExtenderControl(List<ScriptReferenceBase> scriptReferences, IExtenderControl extenderControl) {
|
|
IEnumerable<ScriptReference> extenderControlReferences = extenderControl.GetScriptReferences();
|
|
if (extenderControlReferences != null) {
|
|
Control extenderControlAsControl = (Control)extenderControl;
|
|
ClientUrlResolverWrapper urlResolverWrapper = null;
|
|
foreach (ScriptReference extenderControlReference in extenderControlReferences) {
|
|
if (extenderControlReference != null) {
|
|
if (urlResolverWrapper == null) {
|
|
urlResolverWrapper = new ClientUrlResolverWrapper(extenderControlAsControl);
|
|
}
|
|
// set containing control on each script reference for client url resolution
|
|
extenderControlReference.ClientUrlResolver = urlResolverWrapper;
|
|
extenderControlReference.IsStaticReference = false;
|
|
extenderControlReference.ContainingControl = extenderControlAsControl;
|
|
|
|
// add to collection of all references
|
|
scriptReferences.Add(extenderControlReference);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
private bool InControlTree(Control targetControl) {
|
|
for (Control parent = targetControl.Parent; parent != null; parent = parent.Parent) {
|
|
if (parent == _scriptManager.Page) {
|
|
return true;
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
|
|
public void OnPagePreRender(object sender, EventArgs e) {
|
|
_pagePreRenderRaised = true;
|
|
}
|
|
|
|
public void RegisterExtenderControl<TExtenderControl>(TExtenderControl extenderControl, Control targetControl)
|
|
where TExtenderControl : Control, IExtenderControl {
|
|
|
|
if (extenderControl == null) {
|
|
throw new ArgumentNullException("extenderControl");
|
|
}
|
|
if (targetControl == null) {
|
|
throw new ArgumentNullException("targetControl");
|
|
}
|
|
|
|
VerifyTargetControlType(extenderControl, targetControl);
|
|
|
|
if (!_pagePreRenderRaised) {
|
|
throw new InvalidOperationException(AtlasWeb.ScriptControlManager_RegisterExtenderControlTooEarly);
|
|
}
|
|
if (_scriptReferencesRegistered) {
|
|
throw new InvalidOperationException(AtlasWeb.ScriptControlManager_RegisterExtenderControlTooLate);
|
|
}
|
|
|
|
// A single ExtenderControl may theoretically be registered multiple times
|
|
List<Control> targetControls;
|
|
if (!ExtenderControls.TryGetValue(extenderControl, out targetControls)) {
|
|
targetControls = new List<Control>();
|
|
ExtenderControls[extenderControl] = targetControls;
|
|
}
|
|
targetControls.Add(targetControl);
|
|
}
|
|
|
|
public void RegisterScriptControl<TScriptControl>(TScriptControl scriptControl)
|
|
where TScriptControl : Control, IScriptControl {
|
|
|
|
if (scriptControl == null) {
|
|
throw new ArgumentNullException("scriptControl");
|
|
}
|
|
|
|
if (!_pagePreRenderRaised) {
|
|
throw new InvalidOperationException(AtlasWeb.ScriptControlManager_RegisterScriptControlTooEarly);
|
|
}
|
|
if (_scriptReferencesRegistered) {
|
|
throw new InvalidOperationException(AtlasWeb.ScriptControlManager_RegisterScriptControlTooLate);
|
|
}
|
|
|
|
// A single ScriptControl may theoretically be registered multiple times
|
|
int timesRegistered;
|
|
ScriptControls.TryGetValue(scriptControl, out timesRegistered);
|
|
timesRegistered++;
|
|
ScriptControls[scriptControl] = timesRegistered;
|
|
}
|
|
|
|
public void RegisterScriptDescriptors(IExtenderControl extenderControl) {
|
|
if (extenderControl == null) {
|
|
throw new ArgumentNullException("extenderControl");
|
|
}
|
|
|
|
Control extenderControlAsControl = extenderControl as Control;
|
|
if (extenderControlAsControl == null) {
|
|
throw new ArgumentException(
|
|
String.Format(CultureInfo.InvariantCulture,
|
|
AtlasWeb.Common_ArgumentInvalidType,
|
|
typeof(Control).FullName),
|
|
"extenderControl");
|
|
}
|
|
|
|
List<Control> targetControls;
|
|
if (!ExtenderControls.TryGetValue(extenderControl, out targetControls)) {
|
|
throw new ArgumentException(
|
|
String.Format(CultureInfo.InvariantCulture,
|
|
AtlasWeb.ScriptControlManager_ExtenderControlNotRegistered,
|
|
extenderControlAsControl.ID),
|
|
"extenderControl");
|
|
}
|
|
|
|
Debug.Assert(targetControls != null && targetControls.Count > 0);
|
|
|
|
// A single ExtenderControl may theoretically be registered multiple times
|
|
foreach (Control targetControl in targetControls) {
|
|
// Only register ExtenderControl scripts if the target control is visible and in the control tree.
|
|
// Else, we assume the target was not rendered.
|
|
if (targetControl.Visible && InControlTree(targetControl)) {
|
|
IEnumerable<ScriptDescriptor> scriptDescriptors = extenderControl.GetScriptDescriptors(targetControl);
|
|
RegisterScriptsForScriptDescriptors(scriptDescriptors, extenderControlAsControl);
|
|
}
|
|
}
|
|
}
|
|
|
|
public void RegisterScriptDescriptors(IScriptControl scriptControl) {
|
|
if (scriptControl == null) {
|
|
throw new ArgumentNullException("scriptControl");
|
|
}
|
|
|
|
Control scriptControlAsControl = scriptControl as Control;
|
|
if (scriptControlAsControl == null) {
|
|
throw new ArgumentException(
|
|
String.Format(CultureInfo.InvariantCulture,
|
|
AtlasWeb.Common_ArgumentInvalidType,
|
|
typeof(Control).FullName),
|
|
"scriptControl");
|
|
}
|
|
|
|
// Verify that ScriptControl was previously registered
|
|
int timesRegistered;
|
|
if (!ScriptControls.TryGetValue(scriptControl, out timesRegistered)) {
|
|
throw new ArgumentException(
|
|
String.Format(CultureInfo.InvariantCulture,
|
|
AtlasWeb.ScriptControlManager_ScriptControlNotRegistered,
|
|
scriptControlAsControl.ID),
|
|
"scriptControl");
|
|
}
|
|
|
|
// A single ScriptControl may theoretically be registered multiple times
|
|
for (int i = 0; i < timesRegistered; i++) {
|
|
IEnumerable<ScriptDescriptor> scriptDescriptors = scriptControl.GetScriptDescriptors();
|
|
RegisterScriptsForScriptDescriptors(scriptDescriptors, scriptControlAsControl);
|
|
}
|
|
}
|
|
|
|
private void RegisterScriptsForScriptDescriptors(IEnumerable<ScriptDescriptor> scriptDescriptors,
|
|
Control control) {
|
|
if (scriptDescriptors != null) {
|
|
StringBuilder initBuilder = null;
|
|
foreach (ScriptDescriptor scriptDescriptor in scriptDescriptors) {
|
|
if (scriptDescriptor != null) {
|
|
if (initBuilder == null) {
|
|
initBuilder = new StringBuilder();
|
|
initBuilder.AppendLine("Sys.Application.add_init(function() {");
|
|
}
|
|
|
|
initBuilder.Append(" ");
|
|
initBuilder.AppendLine(scriptDescriptor.GetScript());
|
|
|
|
// Call into the descriptor to possibly register dispose functionality for async posts
|
|
scriptDescriptor.RegisterDisposeForDescriptor(_scriptManager, control);
|
|
}
|
|
}
|
|
|
|
// If scriptDescriptors enumeration is empty, we don't want to register any script.
|
|
if (initBuilder != null) {
|
|
initBuilder.AppendLine("});");
|
|
|
|
string initScript = initBuilder.ToString();
|
|
// DevDiv 35243: Do not use the script itself as the key, since different controls could
|
|
// possibly register the exact same script, or the same control may want to register the
|
|
// same script more than once.
|
|
// Generate a unique script key for every registration.
|
|
string initScriptKey = _scriptManager.CreateUniqueScriptKey();
|
|
_scriptManager.RegisterStartupScriptInternal(
|
|
control, typeof(ScriptManager), initScriptKey, initScript, true);
|
|
}
|
|
}
|
|
}
|
|
|
|
private static void VerifyTargetControlType<TExtenderControl>(
|
|
TExtenderControl extenderControl, Control targetControl)
|
|
where TExtenderControl : Control, IExtenderControl {
|
|
|
|
Type extenderControlType = extenderControl.GetType();
|
|
|
|
// Use TargetControlTypeCache instead of directly calling Type.GetCustomAttributes().
|
|
// Increases requests/second by nearly 100% in ScriptControlScenario.aspx test.
|
|
Type[] types = TargetControlTypeCache.GetTargetControlTypes(extenderControlType);
|
|
|
|
if (types.Length == 0) {
|
|
throw new InvalidOperationException(String.Format(CultureInfo.InvariantCulture,
|
|
AtlasWeb.ScriptControlManager_NoTargetControlTypes,
|
|
extenderControlType, typeof(TargetControlTypeAttribute)));
|
|
}
|
|
|
|
Type targetControlType = targetControl.GetType();
|
|
foreach (Type type in types) {
|
|
if (type.IsAssignableFrom(targetControlType)) {
|
|
return;
|
|
}
|
|
}
|
|
|
|
throw new InvalidOperationException(String.Format(CultureInfo.InvariantCulture,
|
|
AtlasWeb.ScriptControlManager_TargetControlTypeInvalid,
|
|
extenderControl.ID, targetControl.ID, extenderControlType, targetControlType));
|
|
}
|
|
}
|
|
}
|