mcs/class/System.Web/System.Web.Hosting/VirtualPathProvider.cs

   1 //
   2 // System.Web.Hosting.VirtualPathProvider
   3 //
   4 // Author:
   5 //      Gonzalo Paniagua Javier (gonzalo@ximian.com)
   6 //
   7 //
   8 // Copyright (C) 2006 Novell, Inc (http://www.novell.com)
   9 //
  10 // Permission is hereby granted, free of charge, to any person obtaining
  11 // a copy of this software and associated documentation files (the
  12 // "Software"), to deal in the Software without restriction, including
  13 // without limitation the rights to use, copy, modify, merge, publish,
  14 // distribute, sublicense, and/or sell copies of the Software, and to
  15 // permit persons to whom the Software is furnished to do so, subject to
  16 // the following conditions:
  17 //
  18 // The above copyright notice and this permission notice shall be
  19 // included in all copies or substantial portions of the Software.
  20 //
  21 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  22 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  23 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  24 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  25 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  26 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  27 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  28 //
  29 #if NET_2_0
  30 using System;
  31 using System.Collections;
  32 using System.IO;
  33 using System.Web.Caching;
  34 using System.Web.Util;
  35
  36 namespace System.Web.Hosting {
  37
  38         public abstract class VirtualPathProvider : MarshalByRefObject
  39         {
  40                 VirtualPathProvider prev;
  41
  42                 protected VirtualPathProvider ()
  43                 {
  44                 }
  45
  46                 internal void SetPrevious (VirtualPathProvider prev)
  47                 {
  48                         this.prev = prev;
  49                 }
  50
  51                 protected internal VirtualPathProvider Previous {
  52                         get { return prev; }
  53                 }
  54
  55                 protected virtual void Initialize ()
  56                 {
  57                 }
  58
  59                 public virtual string CombineVirtualPaths (string basePath, string relativePath)
  60                 {
  61                         return VirtualPathUtility.Combine (basePath, relativePath);
  62                 }
  63
  64                 public virtual bool DirectoryExists (string virtualDir)
  65                 {
  66                         return false;
  67                 }
  68
  69                 public virtual bool FileExists (string virtualPath)
  70                 {
  71                         return false;
  72                 }
  73
  74                 public virtual CacheDependency GetCacheDependency (string virtualPath,
  75                                                                 IEnumerable virtualPathDependencies,
  76                                                                 DateTime utcStart)
  77                 {
  78                         return null;
  79                 }
  80
  81                 public virtual string GetCacheKey (string virtualPath)
  82                 {
  83                         return null;
  84                 }
  85
  86                 public virtual VirtualDirectory GetDirectory (string virtualDir)
  87                 {
  88                         return null;
  89                 }
  90
  91                 public virtual VirtualFile GetFile (string virtualPath)
  92                 {
  93                         return null;
  94                 }
  95
  96                 public virtual string GetFileHash (string virtualPath, IEnumerable virtualPathDependencies)
  97                 {
  98                         return null;
  99                 }
 100
 101                 public override object InitializeLifetimeService ()
 102                 {
 103                         return null; // forever young
 104                 }
 105
 106                 public static Stream OpenFile (string virtualPath)
 107                 {
 108                         // This thing throws a nullref when we're not inside an ASP.NET appdomain, which is what MS does.
 109                         VirtualPathProvider provider = HostingEnvironment.VirtualPathProvider;
 110                         VirtualFile file = provider.GetFile (virtualPath);
 111                         return file.Open ();
 112                 }
 113         }
 114 }
 115 #endif
 116