mcs/class/System.Web/System.Web.UI/MasterPageParser.cs

   1 //
   2 // System.Web.UI.MasterPageParser
   3 //
   4 // Authors:
   5 //   Lluis Sanchez Gual (lluis@novell.com)
   6 //
   7 // (C) 2005-2010 Novell, Inc.
   8 //
   9
  10 //
  11 // Permission is hereby granted, free of charge, to any person obtaining
  12 // a copy of this software and associated documentation files (the
  13 // "Software"), to deal in the Software without restriction, including
  14 // without limitation the rights to use, copy, modify, merge, publish,
  15 // distribute, sublicense, and/or sell copies of the Software, and to
  16 // permit persons to whom the Software is furnished to do so, subject to
  17 // the following conditions:
  18 //
  19 // The above copyright notice and this permission notice shall be
  20 // included in all copies or substantial portions of the Software.
  21 //
  22 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  23 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  24 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  25 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  26 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  27 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  28 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  29 //
  30
  31 using System;
  32 using System.Collections;
  33 using System.Collections.Generic;
  34 using System.Globalization;
  35 using System.IO;
  36 using System.Web;
  37 using System.Web.Compilation;
  38 using System.Web.Hosting;
  39 using System.Web.Util;
  40
  41 namespace System.Web.UI
  42 {
  43         internal sealed class MasterPageParser: UserControlParser
  44         {
  45                 Type masterType;
  46                 string masterTypeVirtualPath;
  47                 List <string> contentPlaceHolderIds;
  48                 string cacheEntryName;
  49
  50                 internal MasterPageParser (VirtualPath virtualPath, string inputFile, HttpContext context)
  51                         : base (virtualPath, inputFile, context, "System.Web.UI.MasterPage")
  52                 {
  53                         this.cacheEntryName = String.Concat ("@@MasterPagePHIDS:", virtualPath, ":", inputFile);
  54
  55                         contentPlaceHolderIds = HttpRuntime.InternalCache.Get (this.cacheEntryName) as List <string>;
  56                         LoadConfigDefaults ();
  57                 }
  58
  59                 internal MasterPageParser (VirtualPath virtualPath, TextReader reader, HttpContext context)
  60                         : this (virtualPath, null, reader, context)
  61                 {
  62                 }
  63
  64                 internal MasterPageParser (VirtualPath virtualPath, string inputFile, TextReader reader, HttpContext context)
  65                         : base (virtualPath, inputFile, reader, context)
  66                 {
  67                         this.cacheEntryName = String.Concat ("@@MasterPagePHIDS:", virtualPath, ":", InputFile);
  68
  69                         contentPlaceHolderIds = HttpRuntime.InternalCache.Get (this.cacheEntryName) as List <string>;
  70                         LoadConfigDefaults ();
  71                 }
  72
  73                 public static MasterPage GetCompiledMasterInstance (string virtualPath, string inputFile, HttpContext context)
  74                 {
  75                         return BuildManager.CreateInstanceFromVirtualPath (virtualPath, typeof (MasterPage)) as MasterPage;
  76                 }
  77
  78                 public static Type GetCompiledMasterType (string virtualPath, string inputFile, HttpContext context)
  79                 {
  80                         return BuildManager.GetCompiledType (virtualPath);
  81                 }
  82
  83                 internal override void HandleOptions (object obj)
  84                 {
  85                         base.HandleOptions (obj);
  86
  87                         MasterPage mp = (MasterPage)obj;
  88                         mp.MasterPageFile = MasterPageFile;
  89                 }
  90
  91                 internal override void AddDirective (string directive, IDictionary atts)
  92                 {
  93                         if (String.Compare ("MasterType", directive, StringComparison.OrdinalIgnoreCase) == 0) {
  94                                 PageParserFilter pfilter = PageParserFilter;
  95                                 if (pfilter != null)
  96                                         pfilter.PreprocessDirective (directive.ToLowerInvariant (), atts);
  97
  98                                 string type = GetString (atts, "TypeName", null);
  99                                 if (type != null) {
 100                                         masterType = LoadType (type);
 101                                         if (masterType == null)
 102                                                 ThrowParseException ("Could not load type '" + type + "'.");
 103                                 } else {
 104                                         string path = GetString (atts, "VirtualPath", null);
 105                                         if (!String.IsNullOrEmpty (path)) {
 106                                                 var vpp = HostingEnvironment.VirtualPathProvider;
 107                                                 if (!vpp.FileExists (path))
 108                                                         ThrowParseFileNotFound (path);
 109
 110                                                 path = vpp.CombineVirtualPaths (VirtualPath.Absolute, VirtualPathUtility.ToAbsolute (path));
 111                                                 masterTypeVirtualPath = path;
 112                                                 AddDependency (path);
 113                                         } else
 114                                                 ThrowParseException ("The MasterType directive must have either a TypeName or a VirtualPath attribute.");
 115                                 }
 116                                 if (masterType != null)
 117                                         AddAssembly (masterType.Assembly, true);
 118                         }
 119                         else
 120                                 base.AddDirective (directive, atts);
 121                 }
 122
 123                 internal void AddContentPlaceHolderId (string id)
 124                 {
 125                         if (contentPlaceHolderIds == null) {
 126                                 contentPlaceHolderIds = new List <string> (1);
 127                                 HttpRuntime.InternalCache.Insert (cacheEntryName, contentPlaceHolderIds);
 128                         }
 129
 130                         contentPlaceHolderIds.Add (id);
 131                 }
 132
 133                 internal Type MasterType {
 134                         get {
 135                                 if (masterType == null && !String.IsNullOrEmpty (masterTypeVirtualPath))
 136                                         masterType = BuildManager.GetCompiledType (masterTypeVirtualPath);
 137
 138                                 return masterType;
 139                         }
 140                 }
 141
 142                 internal override string DefaultBaseTypeName {
 143                         get { return "System.Web.UI.MasterPage"; }
 144                 }
 145
 146                 internal override string DefaultDirectiveName {
 147                         get { return "master"; }
 148                 }
 149         }
 150 }