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

   1 //
   2 // System.Web.UI.TemplateControl.cs
   3 //
   4 // Authors:
   5 //   Duncan Mak  (duncan@ximian.com)
   6 //   Gonzalo Paniagua Javier (gonzalo@ximian.com)
   7 //   Andreas Nahr (ClassDevelopment@A-SoftTech.com)
   8 //
   9 // (C) 2002 Ximian, Inc. (http://www.ximian.com)
  10 // Copyright (C) 2005 Novell, Inc (http://www.novell.com)
  11 //
  12 // Permission is hereby granted, free of charge, to any person obtaining
  13 // a copy of this software and associated documentation files (the
  14 // "Software"), to deal in the Software without restriction, including
  15 // without limitation the rights to use, copy, modify, merge, publish,
  16 // distribute, sublicense, and/or sell copies of the Software, and to
  17 // permit persons to whom the Software is furnished to do so, subject to
  18 // the following conditions:
  19 //
  20 // The above copyright notice and this permission notice shall be
  21 // included in all copies or substantial portions of the Software.
  22 //
  23 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  24 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  25 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  26 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  27 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  28 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  29 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  30 //
  31
  32 using System.Collections;
  33 using System.ComponentModel;
  34 using System.Reflection;
  35 using System.Security.Permissions;
  36 using System.Web.Compilation;
  37 using System.Web.Util;
  38 using System.Xml;
  39
  40 namespace System.Web.UI {
  41
  42         // CAS
  43         [AspNetHostingPermission (SecurityAction.LinkDemand, Level = AspNetHostingPermissionLevel.Minimal)]
  44         [AspNetHostingPermission (SecurityAction.InheritanceDemand, Level = AspNetHostingPermissionLevel.Minimal)]
  45 #if NET_2_0
  46         public abstract class TemplateControl : Control, INamingContainer, IFilterResolutionService {
  47 #else
  48         public abstract class TemplateControl : Control, INamingContainer {
  49 #endif
  50                 static readonly Assembly _System_Web_Assembly = typeof (TemplateControl).Assembly;
  51                 static object abortTransaction = new object ();
  52                 static object commitTransaction = new object ();
  53                 static object error = new object ();
  54                 static string [] methodNames = { "Page_Init",
  55 #if NET_2_0
  56                                                  "Page_PreInit",
  57                                                  "Page_PreLoad",
  58                                                  "Page_LoadComplete",
  59                                                  "Page_PreRenderComplete",
  60                                                  "Page_SaveStateComplete",
  61                                                  "Page_InitComplete",
  62 #endif
  63                                                  "Page_Load",
  64                                                  "Page_DataBind",
  65                                                  "Page_PreRender",
  66                                                  "Page_Disposed",
  67                                                  "Page_Error",
  68                                                  "Page_Unload",
  69                                                  "Page_AbortTransaction",
  70                                                  "Page_CommitTransaction"};
  71
  72                 const BindingFlags bflags = BindingFlags.Public |
  73                                             BindingFlags.NonPublic |
  74                                             BindingFlags.Instance;
  75
  76 #if NET_2_0
  77                 string _appRelativeVirtualPath;
  78 #endif
  79
  80                 #region Constructor
  81                 protected TemplateControl ()
  82                 {
  83                         Construct ();
  84                 }
  85
  86                 #endregion
  87
  88                 #region Properties
  89                 [EditorBrowsable (EditorBrowsableState.Never)]
  90 #if NET_2_0
  91                 [Obsolete]
  92 #endif
  93                 protected virtual int AutoHandlers {
  94                         get { return 0; }
  95                         set { }
  96                 }
  97
  98                 [EditorBrowsable (EditorBrowsableState.Never)]
  99                 protected virtual bool SupportAutoEvents {
 100                         get { return true; }
 101                 }
 102
 103 #if NET_2_0
 104                 public string AppRelativeVirtualPath {
 105                         get { return _appRelativeVirtualPath; }
 106                         set { _appRelativeVirtualPath = value; }
 107                 }
 108 #endif
 109
 110                 #endregion
 111
 112                 #region Methods
 113
 114                 protected virtual void Construct ()
 115                 {
 116                 }
 117
 118                 [MonoTODO ("Not implemented")]
 119                 protected LiteralControl CreateResourceBasedLiteralControl (int offset,
 120                                                                                     int size,
 121                                                                                     bool fAsciiOnly)
 122                 {
 123                         return null;
 124                 }
 125
 126                 internal void WireupAutomaticEvents ()
 127                 {
 128                         if (!SupportAutoEvents || !AutoEventWireup)
 129                                 return;
 130
 131                         foreach (string methodName in methodNames) {
 132                                 MethodInfo method = null;
 133                                 Type type;
 134                                 for (type = GetType (); type.Assembly != _System_Web_Assembly; type = type.BaseType) {
 135                                         method = type.GetMethod (methodName, bflags);
 136                                         if (method != null)
 137                                                 break;
 138                                 }
 139                                 if (method == null)
 140                                         continue;
 141
 142                                 if (method.DeclaringType != type) {
 143                                         if (!method.IsPublic && !method.IsFamilyOrAssembly &&
 144                                             !method.IsFamilyAndAssembly && !method.IsFamily)
 145                                                 continue;
 146                                 }
 147
 148                                 if (method.ReturnType != typeof (void))
 149                                         continue;
 150
 151                                 ParameterInfo [] parms = method.GetParameters ();
 152                                 int length = parms.Length;
 153                                 bool noParams = (length == 0);
 154                                 if (!noParams && (length != 2 ||
 155                                     parms [0].ParameterType != typeof (object) ||
 156                                     parms [1].ParameterType != typeof (EventArgs)))
 157                                     continue;
 158
 159                                 int pos = methodName.IndexOf ("_");
 160                                 string eventName = methodName.Substring (pos + 1);
 161                                 EventInfo evt = type.GetEvent (eventName);
 162                                 if (evt == null) {
 163                                         /* This should never happen */
 164                                         continue;
 165                                 }
 166
 167                                 if (noParams) {
 168                                         NoParamsInvoker npi = new NoParamsInvoker (this, methodName);
 169                                         evt.AddEventHandler (this, npi.FakeDelegate);
 170                                 } else {
 171                                         evt.AddEventHandler (this, Delegate.CreateDelegate (
 172                                                         typeof (EventHandler), this, methodName));
 173                                 }
 174                         }
 175                 }
 176
 177                 [EditorBrowsable (EditorBrowsableState.Never)]
 178                 protected virtual void FrameworkInitialize ()
 179                 {
 180                 }
 181
 182                 Type GetTypeFromControlPath (string virtualPath)
 183                 {
 184                         if (virtualPath == null)
 185                                 throw new ArgumentNullException ("virtualPath");
 186
 187                         string vpath = UrlUtils.Combine (TemplateSourceDirectory, virtualPath);
 188                         string realpath = Context.Request.MapPath (vpath);
 189                         return UserControlParser.GetCompiledType (vpath, realpath, Context);
 190                 }
 191
 192                 public Control LoadControl (string virtualPath)
 193                 {
 194 #if NET_2_0
 195                         if (virtualPath == null)
 196                                 throw new ArgumentNullException ("virtualPath");
 197 #else
 198                         if (virtualPath == null)
 199                                 throw new HttpException ("virtualPath is null");
 200 #endif
 201                         Type type = GetTypeFromControlPath (virtualPath);
 202                         object [] attrs = type.GetCustomAttributes (typeof (PartialCachingAttribute), true);
 203                         if (attrs != null && attrs.Length == 1) {
 204                                 PartialCachingAttribute attr = (PartialCachingAttribute) attrs [0];
 205                                 PartialCachingControl ctrl = new PartialCachingControl (type);
 206                                 ctrl.VaryByParams = attr.VaryByParams;
 207                                 ctrl.VaryByControls = attr.VaryByControls;
 208                                 ctrl.VaryByCustom = attr.VaryByCustom;
 209                                 return ctrl;
 210                         }
 211
 212                         object control = Activator.CreateInstance (type);
 213                         if (control is UserControl)
 214                                 ((UserControl) control).InitializeAsUserControl (Page);
 215
 216                         return (Control) control;
 217                 }
 218
 219                 public ITemplate LoadTemplate (string virtualPath)
 220                 {
 221 #if NET_2_0
 222                         if (virtualPath == null)
 223                                 throw new ArgumentNullException ("virtualPath");
 224 #else
 225                         if (virtualPath == null)
 226                                 throw new HttpException ("virtualPath is null");
 227 #endif
 228                         Type t = GetTypeFromControlPath (virtualPath);
 229                         return new SimpleTemplate (t);
 230                 }
 231
 232                 protected virtual void OnAbortTransaction (EventArgs e)
 233                 {
 234                         EventHandler eh = Events [abortTransaction] as EventHandler;
 235                         if (eh != null)
 236                                 eh (this, e);
 237                 }
 238
 239                 protected virtual void OnCommitTransaction (EventArgs e)
 240                 {
 241                         EventHandler eh = Events [commitTransaction] as EventHandler;
 242                         if (eh != null)
 243                                 eh (this, e);
 244                 }
 245
 246                 protected virtual void OnError (EventArgs e)
 247                 {
 248                         EventHandler eh = Events [error] as EventHandler;
 249                         if (eh != null)
 250                                 eh (this, e);
 251                 }
 252
 253                 [MonoTODO ("Not implemented, always returns null")]
 254                 public Control ParseControl (string content)
 255                 {
 256                         if (content == null)
 257                                 throw new ArgumentNullException ("content");
 258
 259                         return null;
 260                 }
 261
 262                 [EditorBrowsable (EditorBrowsableState.Never)]
 263                 public
 264 #if !NET_2_0
 265                 static
 266 #endif
 267                 object ReadStringResource ()
 268                 {
 269                         throw new NotSupportedException ();
 270                 }
 271
 272 #if NET_2_0
 273                 protected object GetGlobalResourceObject (string className, string resourceKey)
 274                 {
 275                         return HttpContext.GetGlobalResourceObject (className, resourceKey);
 276                 }
 277
 278                 [MonoTODO ("Not implemented")]
 279                 protected object GetGlobalResourceObject (string className, string resourceKey, Type objType, string propName)
 280                 {
 281                         // FIXME: not sure how to implement that one yet
 282                         throw new NotSupportedException();
 283                 }
 284
 285                 protected object GetLocalResourceObject (string resourceKey)
 286                 {
 287                         return HttpContext.GetLocalResourceObject (Context.Request.CurrentExecutionFilePath, resourceKey);
 288                 }
 289
 290                 protected object GetLocalResourceObject (string resourceKey, Type objType, string propName)
 291                 {
 292                         // FIXME: not sure how to implement that one yet
 293                         throw new NotSupportedException();
 294                 }
 295 #endif
 296
 297                 [EditorBrowsable (EditorBrowsableState.Never)]
 298                 public static object ReadStringResource (Type t)
 299                 {
 300                         throw new NotSupportedException ();
 301                 }
 302
 303                 [MonoTODO ("Not implemented, does nothing")]
 304                 [EditorBrowsable (EditorBrowsableState.Never)]
 305                 protected void SetStringResourcePointer (object stringResourcePointer,
 306                                                          int maxResourceOffset)
 307                 {
 308                 }
 309
 310                 [MonoTODO ("Not implemented, does nothing")]
 311                 [EditorBrowsable (EditorBrowsableState.Never)]
 312                 protected void WriteUTF8ResourceString (HtmlTextWriter output, int offset,
 313                                                         int size, bool fAsciiOnly)
 314                 {
 315                 }
 316
 317                 #endregion
 318
 319                 #region Events
 320
 321                 [WebSysDescription ("Raised when the user aborts a transaction.")]
 322                 public event EventHandler AbortTransaction {
 323                         add { Events.AddHandler (abortTransaction, value); }
 324                         remove { Events.RemoveHandler (abortTransaction, value); }
 325                 }
 326
 327                 [WebSysDescription ("Raised when the user initiates a transaction.")]
 328                 public event EventHandler CommitTransaction {
 329                         add { Events.AddHandler (commitTransaction, value); }
 330                         remove { Events.RemoveHandler (commitTransaction, value); }
 331                 }
 332
 333                 [WebSysDescription ("Raised when an exception occurs that cannot be handled.")]
 334                 public event EventHandler Error {
 335                         add { Events.AddHandler (error, value); }
 336                         remove { Events.RemoveHandler (error, value); }
 337                 }
 338
 339                 #endregion
 340
 341                 class SimpleTemplate : ITemplate
 342                 {
 343                         Type type;
 344
 345                         public SimpleTemplate (Type type)
 346                         {
 347                                 this.type = type;
 348                         }
 349
 350                         public void InstantiateIn (Control control)
 351                         {
 352                                 Control template = Activator.CreateInstance (type) as Control;
 353                                 template.SetBindingContainer (false);
 354                                 control.Controls.Add (template);
 355                         }
 356                 }
 357
 358 #if NET_2_0
 359                 protected internal object Eval (string expression)
 360                 {
 361                         return DataBinder.Eval (Page.GetDataItem(), expression);
 362                 }
 363
 364                 protected internal string Eval (string expression, string format)
 365                 {
 366                         return DataBinder.Eval (Page.GetDataItem(), expression, format);
 367                 }
 368
 369                 protected internal object XPath (string xpathexpression)
 370                 {
 371                         return XPathBinder.Eval (Page.GetDataItem(), xpathexpression);
 372                 }
 373
 374                 protected internal object XPath (string xpathexpression, IXmlNamespaceResolver resolver)
 375                 {
 376                         return XPathBinder.Eval (Page.GetDataItem (), xpathexpression, null, resolver);
 377                 }
 378
 379                 protected internal string XPath (string xpathexpression, string format)
 380                 {
 381                         return XPathBinder.Eval (Page.GetDataItem(), xpathexpression, format);
 382                 }
 383
 384                 protected internal string XPath (string xpathexpression, string format, IXmlNamespaceResolver resolver)
 385                 {
 386                         return XPathBinder.Eval (Page.GetDataItem (), xpathexpression, format, resolver);
 387                 }
 388
 389                 protected internal IEnumerable XPathSelect (string xpathexpression)
 390                 {
 391                         return XPathBinder.Select (Page.GetDataItem(), xpathexpression);
 392                 }
 393
 394                 protected internal IEnumerable XPathSelect (string xpathexpression, IXmlNamespaceResolver resolver)
 395                 {
 396                         return XPathBinder.Select (Page.GetDataItem (), xpathexpression, resolver);
 397                 }
 398
 399                 // IFilterResolutionService
 400
 401                 [MonoTODO ("Not implemented")]
 402                 int IFilterResolutionService.CompareFilters (string filter1, string filter2)
 403                 {
 404                         throw new NotImplementedException ();
 405                 }
 406
 407                 [MonoTODO ("Not implemented")]
 408                 bool IFilterResolutionService.EvaluateFilter (string filterName)
 409                 {
 410                         throw new NotImplementedException ();
 411                 }
 412 #endif
 413         }
 414 }