Files
mono/mcs/class/System.Web/System.Web.Compilation/PageCompiler.cs
T
Marek Habersack e71f514f40 2008-01-24 Marek Habersack <[email protected]>
* WebHandlerBuildProvider.cs: derive from the new
	SimpleBuildProvider class.

	* BuildManager.cs: full implementation of the batch compilation
	for the 2.0 profile. The implementation is most probably different
	to MS.NET's but the effects are the same (or nearly the same -
	there are some minor differences). There are missing bits and
	pieces, but minor ones - to be added later.

	* SimpleBuildProvider.cs: new build provider abstract class
	deriving from the GenericBuildProvider that implements common code
	for building web handlers and web services.

	* GenericBuildProvider.cs: new generic abstract class used to
	implement base builder code for all the build provider types and
	maximize code reuse.

	* PageBuildProvider.cs: derive from the new TemplateBuildProvider
	class and implement all the necessary abstract members. 
	Handle "fake" virtual paths, to properly support generating of the
	WSDL helper code.

	* BuildProvider.cs: SetVirtualPath now converts the passed path to
	absolute URL.
	Added internal virtual method GenerateCode, used by derived
	classes.
	SetCommonParameters no longer sets the referenced assemblies, this
	is done in BuildManager now.
	Added an internal virtual property CodeUnit which returns the
	build provider's compilation unit.

	* PageCompiler.cs: fix assignment of base types for asynchronous
	pages, to match MS.NET.
	For asynchronous pages, add the necessary methods generation.

	* BaseCompiler.cs: default namespace is now set using a constant.
	Renamed the Init method into ConstructType, to better reflect its
	purpose and made the method internal - it is used by the build
	providers.
	Added several CreateProvider overloads for easier and more unified
	compilation provider creation.
	Added an internal MainClassType property to enable class type name
	retrieval from other parts of the class hierarchy.

	* ApplicationFileBuildProvider.cs: new build provider deriving
	from the TemplateBuildProvider class to compile the global.asax
	file.

	* AspGenerator.cs: properly handle parsers which have no input
	file path given, but use TextReader instead.
	Dependencies are virtual paths now, convert them to physical ones
	before creating cache dependency.

	* CachingCompiler.cs: parser dependencies are virtual paths now,
	convert them to physical ones before creating cache dependency.

	* AssemblyBuilder.cs: full implementation of the documented
	functionality as well as a lot of internal build code
	added. Produces assemblies using the same style what MS.NET for
	temporary and target file naming. Handles partial type squashing
	if the same partial type is used by several code compile units
	added to the same builder instance.

	* MasterPageBuildProvider.cs: use the new TemplateBuildProvider
	base class and add implementation of all the abstract methods
	required by it.

	* ThemeDirectoryBuildProvider.cs: new build provider to compile
	theme directories. Replaces the old ThemeDirectoryCompiler class.

	* UserControlBuildProvider.cs: use the new TemplateBuildProvider
	base class and add implementation of all the abstract methods
	required by it.

	* TemplateBuildProvider.cs: new internal abstract class which
	implements the common tasks for all the template control build
	providers.

	* WebServiceBuildProvider.cs: use the new SimpleBuildProvider base
	type to implement building.

2008-01-24  Marek Habersack  <[email protected]>

	* PageThemeFileParser.cs: the DefaultBaseType property removed.

	* ApplicationFileParser.cs: added constructor which takes a
	TextReader.
	Removed the DefaultBaseType property.
	Added the Reader property.

	* MasterPage.cs: use BuildManager to create page instance.

	* WebHandlerParser.cs: added a compatibility constructor.

	* TemplateControl.cs: GetTypeFromControlPath uses
	BuildManager.GetCompiledType for the 2.0+ profile.

	* WebServiceParser.cs: added a compatibility internal
	constructor.

	* SimpleWebHandlerParser.cs: properly treat context and
	physicalPath parameters to the constructor, especially for the
	2.0+ profile where they are obsolete.
	Dependencies are added using virtual paths.

	* PageThemeParser.cs: DefaultBaseType property removed.

	* Page.cs: Style sheets and themes are compiled using
	BuildManager.
	Previous page instance is compiled using BuildManager for the 2.0+
	profile.

	* MasterPageParser.cs: Use BuildManager to create instance and
	compile types.
	Dependencies are added using virtual paths.

	* SimpleHandlerFactory.cs: Use
	BuildManager.CreateInstanceFromVirtualPath for the 2.0+ profile.

	* UserControlParser.cs: if the parser is created using a
	TextReader, take the input file path from the virtual path.
	Added a new internal constructor which takes both a TextReader and
	an inputFile parameters.
	Set base type to the default in the constructors.
	Use virtual path when setting master page dependency.
	DefaultBaseTypename doesn't use a literal string in the 2.0+
	profile, it gets the base type from the application
	configuration.

	* TemplateControlParser.cs: Dependency on a control/page mentioned
	in the Reference directive is registered using the virtual path.
	TextReader property is an override now.

	* TemplateParser.cs: RegisterCustomControl adds a dependency on
	the virtual path, not the physical path. The custom control is
	compiled using BuildManager.GetCompiledType for the 2.0+ profile.
	RegisterNamespace does not add a dependency on the assembly.
	LoadType does not add a dependency on the assembly.
	Legacy Src attribute is handled properly now.
	Dependency on code-behind (Src and CodeFile directive attributes)
	is added using the code-behind file's virtual path.
	GetAssemblyFromSource adds a dependency using the virtual path.
	DefaultBaseType implemented here, using DefaultBaseTypeName which
	is implemented in the descendant classes.
	Added internal CodeBehindSource property, used by build
	providers.
	ClassName property works correctly if inputFile is missing
	(e.g. when the parser has been created using a TextReader)
	Added a virtual internal property TextReader to return the readed
	which has been used to create the parser instance.

	* PageHandlerFactory.cs: GetHandler uses
	BuildManager.CreateInstanceFromVirtualPath for the 2.0+ profile.

	* PageParser.cs: set the default base type in the constructors.
	If the input file is not passed to a constructor, take the input
	file path from the virtual path.
	GetCompiledPageInstance uses BuildManager.CreateInstanceFromVirtualPath
	for the 2.0+ profile.
	MasterPage dependency is set using the virtual path of the master
	page.
	MasterPage is compiled into a type using BuildManager.GetCompiledType.
	GetCompiledPageType uses BuildManager.GetCompiledType for the 2.0
	profile.
	DefaultBaseType override removed, it is implemented in the
	TemplateParser class.
	DefaultBaseTypename doesn't use a literal string in the 2.0+
	profile, it gets the base type from the application
	configuration.

2008-01-24  Marek Habersack  <[email protected]>

	* HttpApplicationFactory.cs: use BuildManager.GetCompiledType to
	build the application (global.asax) file.

svn path=/trunk/mcs/; revision=93848
2008-01-24 21:55:44 +00:00

464 lines
17 KiB
C#

//
// System.Web.Compilation.PageCompiler
//
// Authors:
// Gonzalo Paniagua Javier ([email protected])
//
// (C) 2002,2003 Ximian, Inc (http://www.ximian.com)
//
//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//
using System;
using System.CodeDom;
using System.Collections;
using System.IO;
using System.Reflection;
using System.Text;
using System.Web.Configuration;
using System.Web.UI;
using System.Web.SessionState;
using System.Web.Util;
#if NET_2_0
using System.Web.Profile;
#endif
namespace System.Web.Compilation
{
class PageCompiler : TemplateControlCompiler
{
PageParser pageParser;
static CodeTypeReference intRef = new CodeTypeReference (typeof (int));
public PageCompiler (PageParser pageParser)
: base (pageParser)
{
this.pageParser = pageParser;
}
#if NET_2_0
protected override void CreateStaticFields ()
{
base.CreateStaticFields ();
CodeMemberField fld = new CodeMemberField (typeof (object), "__fileDependencies");
fld.Attributes = MemberAttributes.Private | MemberAttributes.Static;
fld.InitExpression = new CodePrimitiveExpression (null);
mainClass.Members.Add (fld);
}
#endif
protected override void CreateConstructor (CodeStatementCollection localVars,
CodeStatementCollection trueStmt)
{
if (pageParser.ClientTarget != null) {
CodeExpression prop;
prop = new CodePropertyReferenceExpression (thisRef, "ClientTarget");
CodeExpression ct = new CodePrimitiveExpression (pageParser.ClientTarget);
if (localVars == null)
localVars = new CodeStatementCollection ();
localVars.Add (new CodeAssignStatement (prop, ct));
}
#if NET_2_0
ArrayList deps = pageParser.Dependencies;
int depsCount = deps != null ? deps.Count : 0;
if (depsCount > 0) {
if (localVars == null)
localVars = new CodeStatementCollection ();
if (trueStmt == null)
trueStmt = new CodeStatementCollection ();
localVars.Add (
new CodeVariableDeclarationStatement (
typeof (string[]),
"dependencies")
);
CodeVariableReferenceExpression dependencies = new CodeVariableReferenceExpression ("dependencies");
trueStmt.Add (
new CodeAssignStatement (dependencies, new CodeArrayCreateExpression (typeof (string), depsCount))
);
CodeArrayIndexerExpression arrayIndex;
CodeAssignStatement assign;
object o;
for (int i = 0; i < depsCount; i++) {
o = deps [i];
arrayIndex = new CodeArrayIndexerExpression (dependencies, new CodeExpression[] {new CodePrimitiveExpression (i)});
assign = new CodeAssignStatement (arrayIndex, new CodePrimitiveExpression (o));
trueStmt.Add (assign);
}
CodeMethodInvokeExpression getDepsCall = new CodeMethodInvokeExpression (
thisRef,
"GetWrappedFileDependencies",
new CodeExpression[] {dependencies}
);
assign = new CodeAssignStatement (GetMainClassFieldReferenceExpression ("__fileDependencies"), getDepsCall);
trueStmt.Add (assign);
}
#endif
base.CreateConstructor (localVars, trueStmt);
}
protected override void AddInterfaces ()
{
base.AddInterfaces ();
CodeTypeReference cref;
if (pageParser.EnableSessionState) {
cref = new CodeTypeReference (typeof (IRequiresSessionState));
#if NET_2_0
if (partialClass != null)
partialClass.BaseTypes.Add (cref);
else
#endif
mainClass.BaseTypes.Add (cref);
}
if (pageParser.ReadOnlySessionState) {
cref = new CodeTypeReference (typeof (IReadOnlySessionState));
#if NET_2_0
if (partialClass != null)
partialClass.BaseTypes.Add (cref);
else
#endif
mainClass.BaseTypes.Add (cref);
}
#if NET_2_0
if (pageParser.Async)
mainClass.BaseTypes.Add (new CodeTypeReference (typeof (System.Web.IHttpAsyncHandler)));
mainClass.BaseTypes.Add (new CodeTypeReference (typeof (System.Web.IHttpHandler)));
#endif
}
void CreateGetTypeHashCode ()
{
CodeMemberMethod method = new CodeMemberMethod ();
method.ReturnType = intRef;
method.Name = "GetTypeHashCode";
method.Attributes = MemberAttributes.Public | MemberAttributes.Override;
Random rnd = new Random (pageParser.InputFile.GetHashCode ());
method.Statements.Add (new CodeMethodReturnStatement (new CodePrimitiveExpression (rnd.Next ())));
mainClass.Members.Add (method);
}
static CodeAssignStatement CreatePropertyAssign (CodeExpression expr, string name, object value)
{
CodePropertyReferenceExpression prop;
prop = new CodePropertyReferenceExpression (expr, name);
CodePrimitiveExpression prim;
prim = new CodePrimitiveExpression (value);
return new CodeAssignStatement (prop, prim);
}
static CodeAssignStatement CreatePropertyAssign (string name, object value)
{
return CreatePropertyAssign (thisRef, name, value);
}
protected override void AddStatementsToInitMethod (CodeMemberMethod method)
{
#if NET_2_0
ILocation directiveLocation = pageParser.DirectiveLocation;
CodeArgumentReferenceExpression ctrlVar = new CodeArgumentReferenceExpression("__ctrl");
if (pageParser.Title != null)
method.Statements.Add (AddLinePragma (CreatePropertyAssign (ctrlVar, "Title", pageParser.Title), directiveLocation));
if (pageParser.MasterPageFile != null)
method.Statements.Add (AddLinePragma (CreatePropertyAssign (ctrlVar, "MasterPageFile", pageParser.MasterPageFile), directiveLocation));
if (pageParser.Theme != null)
method.Statements.Add (AddLinePragma (CreatePropertyAssign (ctrlVar, "Theme", pageParser.Theme), directiveLocation));
if (pageParser.StyleSheetTheme != null)
method.Statements.Add (AddLinePragma (CreatePropertyAssign (ctrlVar, "StyleSheetTheme", pageParser.StyleSheetTheme), directiveLocation));
if (pageParser.Async != false)
method.Statements.Add (AddLinePragma (CreatePropertyAssign (ctrlVar, "AsyncMode", pageParser.Async), directiveLocation));
if (pageParser.AsyncTimeout != -1)
method.Statements.Add (AddLinePragma (CreatePropertyAssign (ctrlVar, "AsyncTimeout",
TimeSpan.FromSeconds (pageParser.AsyncTimeout)), directiveLocation));
CodeMethodInvokeExpression expr = new CodeMethodInvokeExpression (thisRef, "InitializeCulture");
method.Statements.Add (AddLinePragma (new CodeExpressionStatement (expr), directiveLocation));
#endif
}
protected override void PrependStatementsToFrameworkInitialize (CodeMemberMethod method)
{
base.PrependStatementsToFrameworkInitialize (method);
#if NET_2_0
if (pageParser.StyleSheetTheme != null)
method.Statements.Add (CreatePropertyAssign ("StyleSheetTheme", pageParser.StyleSheetTheme));
#endif
}
protected override void AppendStatementsToFrameworkInitialize (CodeMemberMethod method)
{
base.AppendStatementsToFrameworkInitialize (method);
#if NET_2_0
ArrayList deps = pageParser.Dependencies;
int depsCount = deps != null ? deps.Count : 0;
if (depsCount > 0) {
CodeFieldReferenceExpression fileDependencies = GetMainClassFieldReferenceExpression ("__fileDependencies");
method.Statements.Add (
new CodeMethodInvokeExpression (
thisRef,
"AddWrappedFileDependencies",
new CodeExpression[] {fileDependencies})
);
}
#endif
string responseEncoding = pageParser.ResponseEncoding;
if (responseEncoding != null)
method.Statements.Add (CreatePropertyAssign ("ResponseEncoding", responseEncoding));
int codepage = pageParser.CodePage;
if (codepage != -1)
method.Statements.Add (CreatePropertyAssign ("CodePage", codepage));
string contentType = pageParser.ContentType;
if (contentType != null)
method.Statements.Add (CreatePropertyAssign ("ContentType", contentType));
if (pageParser.OutputCache) {
CodeMethodReferenceExpression init = new CodeMethodReferenceExpression (null,
"InitOutputCache");
CodeMethodInvokeExpression invoke = new CodeMethodInvokeExpression (init,
OutputCacheParams ());
method.Statements.Add (invoke);
}
int lcid = pageParser.LCID;
if (lcid != -1)
method.Statements.Add (CreatePropertyAssign ("LCID", lcid));
string culture = pageParser.Culture;
if (culture != null)
method.Statements.Add (CreatePropertyAssign ("Culture", culture));
culture = pageParser.UICulture;
if (culture != null)
method.Statements.Add (CreatePropertyAssign ("UICulture", culture));
string errorPage = pageParser.ErrorPage;
if (errorPage != null)
method.Statements.Add (CreatePropertyAssign ("ErrorPage", errorPage));
if (pageParser.HaveTrace) {
CodeAssignStatement stmt = new CodeAssignStatement ();
stmt.Left = new CodePropertyReferenceExpression (thisRef, "TraceEnabled");
stmt.Right = new CodePrimitiveExpression (pageParser.Trace);
method.Statements.Add (stmt);
}
if (pageParser.TraceMode != TraceMode.Default) {
CodeAssignStatement stmt = new CodeAssignStatement ();
CodeTypeReferenceExpression tm = new CodeTypeReferenceExpression ("System.Web.TraceMode");
stmt.Left = new CodePropertyReferenceExpression (thisRef, "TraceModeValue");
stmt.Right = new CodeFieldReferenceExpression (tm, pageParser.TraceMode.ToString ());
method.Statements.Add (stmt);
}
if (pageParser.NotBuffer) {
CodeAssignStatement stmt = new CodeAssignStatement ();
stmt.Left = new CodePropertyReferenceExpression (thisRef, "Buffer");
stmt.Right = new CodePrimitiveExpression (false);
method.Statements.Add (stmt);
}
#if NET_1_1
if (pageParser.ValidateRequest) {
CodeMethodInvokeExpression expr = new CodeMethodInvokeExpression ();
CodePropertyReferenceExpression prop;
prop = new CodePropertyReferenceExpression (thisRef, "Request");
expr.Method = new CodeMethodReferenceExpression (prop, "ValidateInput");
method.Statements.Add (expr);
}
#endif
#if NET_2_0
if (!pageParser.EnableEventValidation) {
CodeAssignStatement stmt = new CodeAssignStatement ();
CodePropertyReferenceExpression prop;
prop = new CodePropertyReferenceExpression (thisRef, "EnableEventValidation");
stmt.Left = prop;
stmt.Right = new CodePrimitiveExpression (pageParser.EnableEventValidation);
method.Statements.Add (stmt);
}
if (pageParser.MaintainScrollPositionOnPostBack) {
CodeAssignStatement stmt = new CodeAssignStatement ();
CodePropertyReferenceExpression prop;
prop = new CodePropertyReferenceExpression (thisRef, "MaintainScrollPositionOnPostBack");
stmt.Left = prop;
stmt.Right = new CodePrimitiveExpression (pageParser.MaintainScrollPositionOnPostBack);
method.Statements.Add (stmt);
}
#endif
}
private CodeExpression[] OutputCacheParams ()
{
return new CodeExpression [] {
new CodePrimitiveExpression (pageParser.OutputCacheDuration),
#if NET_2_0
new CodePrimitiveExpression (pageParser.OutputCacheVaryByContentEncodings),
#endif
new CodePrimitiveExpression (pageParser.OutputCacheVaryByHeader),
new CodePrimitiveExpression (pageParser.OutputCacheVaryByCustom),
new CodeSnippetExpression (typeof (OutputCacheLocation).ToString () +
"." + pageParser.OutputCacheLocation.ToString ()),
new CodePrimitiveExpression (pageParser.OutputCacheVaryByParam)
};
}
#if NET_2_0
void CreateStronglyTypedProperty (Type type, string name)
{
if (type == null)
return;
CodeMemberProperty mprop = new CodeMemberProperty ();
mprop.Name = name;
mprop.Type = new CodeTypeReference (type);
mprop.Attributes = MemberAttributes.Public | MemberAttributes.New;
CodeExpression prop = new CodePropertyReferenceExpression (new CodeBaseReferenceExpression (), name);
prop = new CodeCastExpression (type, prop);
mprop.GetStatements.Add (new CodeMethodReturnStatement (prop));
if (partialClass != null)
partialClass.Members.Add (mprop);
else
mainClass.Members.Add (mprop);
}
#endif
protected internal override void CreateMethods ()
{
base.CreateMethods ();
#if NET_2_0
CreateProfileProperty ();
CreateStronglyTypedProperty (pageParser.MasterType, "Master");
CreateStronglyTypedProperty (pageParser.PreviousPageType, "PreviousPage");
#endif
CreateGetTypeHashCode ();
#if NET_2_0
if (pageParser.Async)
CreateAsyncMethods ();
#endif
}
#if NET_2_0
void CreateAsyncMethods ()
{
CodeMemberMethod method = new CodeMemberMethod ();
CodeParameterDeclarationExpression arg;
CodeMethodInvokeExpression invoke;
// public virtual System.IAsyncResult BeginProcessRequest(System.Web.HttpContext context, System.AsyncCallback cb, object data);
method.ReturnType = new CodeTypeReference (typeof (IAsyncResult));
method.Name = "BeginProcessRequest";
method.Attributes = MemberAttributes.Public;
arg = new CodeParameterDeclarationExpression ();
arg.Type = new CodeTypeReference (typeof (HttpContext));
arg.Name = "context";
method.Parameters.Add (arg);
arg = new CodeParameterDeclarationExpression ();
arg.Type = new CodeTypeReference (typeof (AsyncCallback));
arg.Name = "cb";
method.Parameters.Add (arg);
arg = new CodeParameterDeclarationExpression ();
arg.Type = new CodeTypeReference (typeof (object));
arg.Name = "data";
method.Parameters.Add (arg);
invoke = new CodeMethodInvokeExpression (thisRef, "AsyncPageBeginProcessRequest");
invoke.Parameters.Add (new CodeArgumentReferenceExpression ("context"));
invoke.Parameters.Add (new CodeArgumentReferenceExpression ("cb"));
invoke.Parameters.Add (new CodeArgumentReferenceExpression ("data"));
method.Statements.Add (new CodeMethodReturnStatement (invoke));
mainClass.Members.Add (method);
// public virtual void EndProcessRequest(System.IAsyncResult ar);
method = new CodeMemberMethod ();
method.ReturnType = new CodeTypeReference (typeof (void));
method.Name = "EndProcessRequest";
method.Attributes = MemberAttributes.Public;
arg = new CodeParameterDeclarationExpression ();
arg.Type = new CodeTypeReference (typeof (IAsyncResult));
arg.Name = "ar";
method.Parameters.Add (arg);
invoke = new CodeMethodInvokeExpression (thisRef, "AsyncPageEndProcessRequest");
invoke.Parameters.Add (new CodeArgumentReferenceExpression ("ar"));
method.Statements.Add (invoke);
mainClass.Members.Add (method);
// public override void ProcessRequest(System.Web.HttpContext context);
method = new CodeMemberMethod ();
method.ReturnType = new CodeTypeReference (typeof (void));
method.Name = "ProcessRequest";
method.Attributes = MemberAttributes.Public | MemberAttributes.Override;
arg = new CodeParameterDeclarationExpression ();
arg.Type = new CodeTypeReference (typeof (HttpContext));
arg.Name = "context";
method.Parameters.Add (arg);
invoke = new CodeMethodInvokeExpression (new CodeBaseReferenceExpression (), "ProcessRequest");
invoke.Parameters.Add (new CodeArgumentReferenceExpression ("context"));
method.Statements.Add (invoke);
mainClass.Members.Add (method);
}
#endif
public static Type CompilePageType (PageParser pageParser)
{
PageCompiler compiler = new PageCompiler (pageParser);
return compiler.GetCompiledType ();
}
}
}