/// <summary> /// Construct a new control collection that will house all controls defined by the given set of /// registrations and assemblies. /// </summary> /// <param name="tagRegistrations">The tag registrations (from either the "web.config" file or /// from <%@ Register %%gt; directives in the markup).</param> /// <param name="assemblies">The set of known assemblies, preloaded.</param> public ReflectedControlCollection(IEnumerable <TagRegistration> tagRegistrations, ReferencedAssembliesContext assemblies) { _tagRegistrations = tagRegistrations; _assemblies = assemblies; }
/// <summary> /// Given a set of tag registrations for user controls, attempt to connect those tag registrations to actual /// .NET class types in the main website assembly. This will update the Typename field for each TagRegistration /// where a matching class type is found; or if no matching class type is found, this will throw an exception. /// </summary> /// <param name="compileContext">The context in which errors should be reported.</param> /// <param name="tagRegistrations">The set of user-control registrations to resolve to real class types.</param> /// <param name="assemblies">The full set of preloaded assemblies.</param> /// <param name="assemblyDirectory">The directory where the main website DLL can be found.</param> /// <param name="rootPath">The real disk path to the root of the website's virtual directory.</param> /// <param name="currentDirectory">The current directory (for resolving relative paths).</param> public static void ResolveUserControls(ICompileContext compileContext, IEnumerable <TagRegistration> tagRegistrations, ReferencedAssembliesContext assemblies, string rootPath, string currentDirectory) { foreach (TagRegistration tagRegistration in tagRegistrations.Where(t => t.Kind == TagRegistrationKind.SingleUserControl)) { compileContext.Verbose("Registering user control <{0}:{1}> as \"{2}\".", tagRegistration.TagPrefix, tagRegistration.TagName, tagRegistration.SourceFilename); compileContext.VerboseNesting++; string filename = VistualPathUtils.ResolveWebsitePath(compileContext, tagRegistration.SourceFilename, rootPath, currentDirectory); MarkupReader userControlReader = new MarkupReader(); // todo: how to handle references to user controls not found within rootpath? Tag userControlMainDirective = userControlReader.ReadMainDirective(compileContext, filename, assemblies, rootPath); if (string.IsNullOrEmpty(userControlMainDirective.TagName) && string.Compare(userControlMainDirective.TagName, "control", StringComparison.InvariantCultureIgnoreCase) != 0) { throw new RedesignerException("Cannot register user control \"{0}\": Its main <% ... %> directive does not start with the \"Control\" keyword. Is this actually a user control?", tagRegistration.SourceFilename); } string inheritsAttribute = userControlMainDirective["inherits"]; if (string.IsNullOrEmpty(inheritsAttribute)) { throw new RedesignerException("Cannot register user control \"{0}\": Its main <% Control ... %> directive is missing the required Inherits=\"...\" attribute.", tagRegistration.SourceFilename); } tagRegistration.Typename = inheritsAttribute; compileContext.Verbose("User control registered as type \"{0}\".", inheritsAttribute); compileContext.VerboseNesting--; } }
private Type FindMatchingHtmlControlType(Tag tag, ReferencedAssembliesContext assemblies) { var systemWebAssy = assemblies.SystemWebAssembly; switch (tag.TagName) { case "a": return(systemWebAssy.GetType("System.Web.UI.HtmlControls.HtmlAnchor")); case "button": return(systemWebAssy.GetType("System.Web.UI.HtmlControls.HtmlButton")); case "form": return(systemWebAssy.GetType("System.Web.UI.HtmlControls.HtmlForm")); case "head": return(systemWebAssy.GetType("System.Web.UI.HtmlControls.HtmlHead")); case "img": return(systemWebAssy.GetType("System.Web.UI.HtmlControls.HtmlImage")); case "link": return(systemWebAssy.GetType("System.Web.UI.HtmlControls.HtmlLink")); case "meta": return(systemWebAssy.GetType("System.Web.UI.HtmlControls.HtmlMeta")); case "select": return(systemWebAssy.GetType("System.Web.UI.HtmlControls.HtmlSelect")); case "table": return(systemWebAssy.GetType("System.Web.UI.HtmlControls.HtmlTable")); case "td": return(systemWebAssy.GetType("System.Web.UI.HtmlControls.HtmlTableCell")); case "th": return(systemWebAssy.GetType("System.Web.UI.HtmlControls.HtmlTableCell")); case "tr": return(systemWebAssy.GetType("System.Web.UI.HtmlControls.HtmlTableRow")); case "textarea": return(systemWebAssy.GetType("System.Web.UI.HtmlControls.HtmlTextArea")); case "title": return(systemWebAssy.GetType("System.Web.UI.HtmlControls.HtmlTitle")); case "input": string type = tag["type"]; if (!string.IsNullOrEmpty(type)) { switch (type.ToLower()) { case "button": return(systemWebAssy.GetType("System.Web.UI.HtmlControls.HtmlInputButton")); case "checkbox": return(systemWebAssy.GetType("System.Web.UI.HtmlControls.HtmlInputCheckBox")); case "file": return(systemWebAssy.GetType("System.Web.UI.HtmlControls.HtmlInputFile")); case "hidden": return(systemWebAssy.GetType("System.Web.UI.HtmlControls.HtmlInputHidden")); case "image": return(systemWebAssy.GetType("System.Web.UI.HtmlControls.HtmlInputImage")); case "password": return(systemWebAssy.GetType("System.Web.UI.HtmlControls.HtmlInputPassword")); case "radio": return(systemWebAssy.GetType("System.Web.UI.HtmlControls.HtmlInputRadioButton")); case "reset": return(systemWebAssy.GetType("System.Web.UI.HtmlControls.HtmlInputReset")); case "submit": return(systemWebAssy.GetType("System.Web.UI.HtmlControls.HtmlInputSubmit")); case "text": return(systemWebAssy.GetType("System.Web.UI.HtmlControls.HtmlInputText")); } } return(systemWebAssy.GetType("System.Web.UI.HtmlControls.HtmlGenericControl")); default: return(systemWebAssy.GetType("System.Web.UI.HtmlControls.HtmlGenericControl")); } }
/// <summary> /// Search through the given set of tag registrations and assemblies to find a suitable .NET class type that /// matches the given tag prefix and tag name. (This method handles server controls and user controls, not HTML /// controls; the tag prefix must not be empty.) /// </summary> /// <param name="tagPrefix">The tag prefix of the tag we're searching for.</param> /// <param name="tagName">The tag name of the tag we're searching for.</param> /// <param name="tagRegistrations">The known list of registrations, formed from the directives in the /// "web.config" and any <%@ Register %> directives in the markup.</param> /// <param name="assemblies">The complete list of known pre-loaded assemblies for reflection.</param> /// <param name="matchingTagRegistration">The matching tag registration for this tag prefix/name, if there is one.</param> /// <returns>The matching class type, if one exists, or null if there is no matching class type.</returns> private static Type FindMatchingControlType(string tagPrefix, string tagName, IEnumerable <TagRegistration> tagRegistrations, ReferencedAssembliesContext assemblies, out TagRegistration matchingTagRegistration) { // Since multiple tag registrations could match this declaration, we have no choice but to walk through // all of the tag registrations and just try to find the first one that matches. foreach (TagRegistration tagRegistration in tagRegistrations) { // Try the prefix first. If that doesn't match, it's definitely not what we're looking for. if (string.Compare(tagRegistration.TagPrefix, tagPrefix, StringComparison.InvariantCultureIgnoreCase) != 0) { continue; } switch (tagRegistration.Kind) { case TagRegistrationKind.SingleUserControl: if (string.Compare(tagRegistration.TagName, tagName, StringComparison.InvariantCultureIgnoreCase) == 0) { //We matched a registered user control, so we have to partially parse it to find out //what namespace in the website assembly is associated with it. Assembly assembly = assemblies.ProjectOutputAssembly; if (assembly == null) { // may not have built the output assembly yet.. break; } Type type = assembly.GetType(tagRegistration.Typename); // Make sure we found it, and that it's actually a UserControl of some kind. if (type == null || !typeof(System.Web.UI.UserControl).IsAssignableFrom(type)) { break; } // We found it, so return it. matchingTagRegistration = tagRegistration; return(type); } break; case TagRegistrationKind.Namespace: { // This registration describes an entire namespace worth of controls in an assembly somewhere. // So check see if tagName matches a class inside the given namespace in that assembly. Assembly assembly = assemblies.GetAssembly(tagRegistration.AssemblyFilename); Type type = assembly.GetType(tagRegistration.Namespace + "." + tagName, false, true); //Type type = Type.ReflectionOnlyGetType(tagRegistration.Namespace + "." + tagName, false, true); // Make sure we found it. if (type == null) { break; } // We found it, so return it. matchingTagRegistration = tagRegistration; return(type); } case TagRegistrationKind.HtmlControl: // Shouldn't be able to get here. throw new InvalidOperationException("Internal error; got an HtmlControl when attempting to process a registered user control or namespace."); } } matchingTagRegistration = null; return(null); }
/// <summary> /// Construct a new blob of metadata for a single control, performing any reflection needed to determine its /// structure and parsing behavior. /// </summary> /// <param name="compileContext">The context in which errors should be reported.</param> /// <param name="tag">The complete tag for this control, as found in the markup.</param> /// <param name="tagRegistrations">The known list of registrations, formed from the directives in the /// "web.config" and any <%@ Register %> directives in the markup.</param> /// <param name="assemblies">The complete list of known pre-loaded assemblies for reflection.</param> /// <param name="allowedTypes">The allowable types of control that may be returned. If the matching /// .NET class type for this control does not match one of these types (or is not derivable from one /// of these types), this constructor will throw an exception.</param> public ReflectedControl(ICompileContext compileContext, Tag tag, IEnumerable <TagRegistration> tagRegistrations, ReferencedAssembliesContext assemblies, IEnumerable <Type> allowedTypes) { // Decode the tag declaration. DecodeFullTagNameWithPrefix(tag.TagName, out TagPrefix, out TagName); // Find the matching C# type for that tag declaration. if (string.IsNullOrEmpty(TagPrefix)) { TagRegistration = GetHtmlTagRegistration(assemblies.SystemWebAssembly); ControlType = FindMatchingHtmlControlType(tag, assemblies); } else { ControlType = FindMatchingControlType(TagPrefix, TagName, tagRegistrations, assemblies, out TagRegistration); } if (ControlType == null) { throw new InvalidOperationException(string.Format("No matching type for <{0}> was found in any of the loaded assemblies.", tag.TagName)); } // If we are restricted to only load certain types (such as the nested not-a-control instances inside a DataPager control), // check that the control we have found matches one of those types. var enumerable = allowedTypes as Type[] ?? allowedTypes.ToArray(); if (!enumerable.Any(t => IsSameOrSubclass(t, ControlType))) { StringBuilder stringBuilder = new StringBuilder(); stringBuilder.AppendFormat("Found matching type for <{0}>, but it is a {1}, not one of the {2} allowed types:\r\n", tag.TagName, ControlType.FullName, enumerable.Count()); foreach (Type allowedType in enumerable) { stringBuilder.AppendFormat("- {0}\r\n", allowedType.FullName); } throw new InvalidOperationException(stringBuilder.ToString()); } // Extract the [ParseChildren] attribute, if it has one. var custAtts = CustomAttributeData.GetCustomAttributes(ControlType).Where(a => a.AttributeType == typeof(System.Web.UI.ParseChildrenAttribute)); if (custAtts.Any()) { var parseAtt = custAtts.First(); if (!parseAtt.ConstructorArguments.Any()) { ParseChildrenAttribute = new ParseChildrenAttribute(); //public ParseChildrenAttribute(); } else if (parseAtt.ConstructorArguments.Count == 1) { //public ParseChildrenAttribute(bool childrenAsProperties); //public ParseChildrenAttribute(Type childControlType); if (parseAtt.ConstructorArguments[0].ArgumentType == typeof(bool)) { bool val = (bool)parseAtt.ConstructorArguments[0].Value; ParseChildrenAttribute = new ParseChildrenAttribute(val); } else if (parseAtt.ConstructorArguments[0].ArgumentType == typeof(Type)) { Type val = (Type)parseAtt.ConstructorArguments[0].Value; ParseChildrenAttribute = new ParseChildrenAttribute(val); } } else { //public ParseChildrenAttribute(bool childrenAsProperties, string defaultProperty); bool val = (bool)parseAtt.ConstructorArguments[0].Value; String defaultPropVal = (string)parseAtt.ConstructorArguments[1].Value; ParseChildrenAttribute = new ParseChildrenAttribute(val, defaultPropVal); } } //System.Web.UI.ParseChildrenAttribute[] parseChildrenAttributes = (System.Web.UI.ParseChildrenAttribute[])ControlType.GetCustomAttributes(typeof(System.Web.UI.ParseChildrenAttribute), true); //ParseChildrenAttribute = parseChildrenAttributes.Length == 0 ? null : parseChildrenAttributes[0]; // Extract the [ControlBuilder] attribute, if it has one. var controlBuilderAttsData = CustomAttributeData.GetCustomAttributes(ControlType).Where(a => a.AttributeType == typeof(System.Web.UI.ControlBuilderAttribute)); if (controlBuilderAttsData.Any()) { var controlBuilderAttData = custAtts.First(); if (controlBuilderAttData.ConstructorArguments.Count() == 1) { Type val = (Type)controlBuilderAttData.ConstructorArguments[0].Value; ControlBuilderAttribute = new System.Web.UI.ControlBuilderAttribute(val); } } //System.Web.UI.ControlBuilderAttribute[] controlBuilderAttributes = (System.Web.UI.ControlBuilderAttribute[])ControlType.GetCustomAttributes(typeof(System.Web.UI.ControlBuilderAttribute), true); //ControlBuilderAttribute = controlBuilderAttributes.Length == 0 ? null : controlBuilderAttributes[0]; // Extract the type's properties, since their declarations control what's legal in the markup. ControlProperties = CollectControlProperties(compileContext, ControlType, this); // HtmlControls have to be handled specially, since they have [ParseChildren(true)] in many cases but // aren't really using it for anything. if (ControlType.Namespace == GetHtmlTagRegistration(assemblies.SystemWebAssembly).Namespace) { ParseChildrenAttribute = new ParseChildrenAttribute(false); } // Validate the ParseChildrenAttribute, which may be broken or weird. if (ParseChildrenAttribute != null) { if (!string.IsNullOrEmpty(ParseChildrenAttribute.DefaultProperty)) { string propertyName = ParseChildrenAttribute.DefaultProperty.ToLower(); // ASP.NET also ignores case on this; see internals of ControlBuilder.CreateChildBuilder() for details. if (!ControlProperties.ContainsKey(propertyName)) { throw new InvalidOperationException(string.Format("The [ParseChildren] attribute on class \"{0}\" names a default property \"{1}\" that does not exist in that class.", ControlType.FullName, ParseChildrenAttribute.DefaultProperty)); } DefaultCollectionProperty = ControlProperties[propertyName]; if (!DefaultCollectionProperty.IsCollectionProperty) { throw new InvalidOperationException(string.Format("The [ParseChildren] attribute on class \"{0}\" names a default property \"{1}\" that is not a collection property. The default property must always be a collection property.", ControlType.FullName, ParseChildrenAttribute.DefaultProperty)); } } } }