Specialized VirtualPathProvider that allows accessing database images as if they are on disk. More...

Inheritance diagram for ImageResizer.Plugins.SqlReader.SqlReaderPlugin:

[legend]

Collaboration diagram for ImageResizer.Plugins.SqlReader.SqlReaderPlugin:

[legend]

Public Member Functions
	SqlReaderPlugin (NameValueCollection args)

	SqlReaderPlugin (SqlReaderSettings s)

IPlugin	Install (Configuration.Config c)
	Installes the plugin into the specified configuration. Once installed, it cannot be uninstalled. More...

bool	Uninstall (Configuration.Config c)
	This plugin cannot be uninstalled as ASP.NET does not provide a 'undo' function for RegisterVirtualPathProvider More...

virtual void	FireAuthorizeEvent (string id)
	Called before any database op. Fires the BeforeAccess event More...

Stream	GetStream (string id)
	Returns a stream to the More...

SqlParameter	CreateIdParameter (string id)
	Creates a SQL paramater of the correct type for the row id More...

bool	RowExists (string id)
	Executes existsQuery, and returns true if the value is greater than 0 More...

DateTime	GetDateModifiedUtc (string id)
	Returns DateTime.MinValue if there are no rows, or no values on the row. Executes ModifiedDateQuery, then returns the first non-null datetime value on the first row. More...

SqlConnection	GetConnectionObj ()
	Creates and returns a SqlConnection object for the database based on the configuration. More...

SqlCommand	GetCacheDependencyQuery (string id)
	Returns a SqlCommand cache dependency using the modifiedQuery. More...

virtual string	ParseIdFromVirtualPath (string virtualPath)
	Supports int, string, and GUID IDs. Override this to modify ID parsing if you can't do it with rewrite rules. More...

override bool	FileExists (string virtualPath)
	VPP method - not for external use More...

override VirtualFile	GetFile (string virtualPath)
	VPP method, not for external use More...

bool	FileExists (string virtualPath, NameValueCollection queryString)
	Returns true if the specified virtual file should be provided by this reader and it exists. False if this provider cannot/should not provide it, or it doesn't exist. More...

IVirtualFile	GetFile (string virtualPath, NameValueCollection queryString)
	Returns an IVirtualFile instance if the file exists in this provider. More...

override CacheDependency	GetCacheDependency (string virtualPath, System.Collections.IEnumerable virtualPathDependencies, DateTime utcStart)
	VPP method, not for external use More...

IEnumerable< IIssue >	GetIssues ()
	Provides the diagnostics system with a list of configuration issues More...

Configuration.Xml.Node	RedactFrom (Node resizer)

Public Member Functions inherited from ImageResizer.Plugins.IPlugin
IPlugin	Install (Config c)
	Installs the plugin in the specified Config instance. The plugin must handle all the work of loading settings, registering the plugin etc. More...

bool	Uninstall (Config c)
	Uninstalls the plugin. Should reverse all changes made during Install More...

Protected Member Functions
override void	Initialize ()
	No initialization needed for this VPP More...

Properties
SqlReaderSettings	Settings `[get]`
	Provides all the configuration options for the plugin. More...

bool	FailedToRegisterVpp `[get]`
	True if the provider attempted to register itself as a VirtualPathProvider and failed due to limited security clearance. False if it did not attempt, or if it succeeded. More...

bool	IsStringKey `[get]`
	Returns true if Settings.ImageIdType is a string type More...

bool	IsIntKey `[get]`
	Returns true if Settings.ImageIdType is an integer type More...

Detailed Description

Specialized VirtualPathProvider that allows accessing database images as if they are on disk.

Definition at line 21 of file SqlReader.cs.

Member Function Documentation

SqlParameter ImageResizer.Plugins.SqlReader.SqlReaderPlugin.CreateIdParameter ( string id )

inline

Creates a SQL paramater of the correct type for the row id

Parameters

id

Returns

Definition at line 138 of file SqlReader.cs.

         {
             SqlParameter sp = new SqlParameter("id", s.ImageIdType);
             if (IsIntKey) {
                 sp.Size = 4;
                 sp.Value = long.Parse(id);
             } else if (s.ImageIdType == System.Data.SqlDbType.UniqueIdentifier)
                 sp.Value = new Guid(id);
             else if (IsStringKey)
                 sp.Value = id;
             
             return sp;
         }

override bool ImageResizer.Plugins.SqlReader.SqlReaderPlugin.FileExists ( string virtualPath )

inline

VPP method - not for external use

Parameters

virtualPath

Returns

Definition at line 333 of file SqlReader.cs.

         {
             if (IsPathVirtual(virtualPath))
             {
                 return !s.CheckForModifiedFiles || RowExists(ParseIdFromVirtualPath(virtualPath));
             }
             else
                 return Previous.FileExists(virtualPath);
         }

bool ImageResizer.Plugins.SqlReader.SqlReaderPlugin.FileExists	(	string	virtualPath,
		NameValueCollection	queryString
	)

inline

Returns true if the specified virtual file should be provided by this reader and it exists. False if this provider cannot/should not provide it, or it doesn't exist.

Parameters

virtualPath
queryString

Returns

Implements ImageResizer.Plugins.IVirtualImageProvider.

Definition at line 362 of file SqlReader.cs.

                                                                                     {
             return IsPathVirtual(virtualPath) && (!s.CheckForModifiedFiles || RowExists(ParseIdFromVirtualPath(virtualPath)));
         }

virtual void ImageResizer.Plugins.SqlReader.SqlReaderPlugin.FireAuthorizeEvent ( string id )

inlinevirtual

Called before any database op. Fires the BeforeAccess event

Parameters

id

Definition at line 105 of file SqlReader.cs.

                                                          {
             s.FireBeforeAccess(id);
         }

override CacheDependency ImageResizer.Plugins.SqlReader.SqlReaderPlugin.GetCacheDependency	(	string	virtualPath,
		System.Collections.IEnumerable	virtualPathDependencies,
		DateTime	utcStart
	)

inline

VPP method, not for external use

Parameters

virtualPath
virtualPathDependencies
utcStart

Returns

Definition at line 383 of file SqlReader.cs.

         {
             if (IsPathVirtual(virtualPath))
                 return new SqlCacheDependency(GetCacheDependencyQuery(ParseIdFromVirtualPath(virtualPath)));
             else
                 return Previous.GetCacheDependency(virtualPath, virtualPathDependencies, utcStart);
         }

SqlCommand ImageResizer.Plugins.SqlReader.SqlReaderPlugin.GetCacheDependencyQuery ( string id )

inline

Returns a SqlCommand cache dependency using the modifiedQuery.

Parameters

id

Returns

Definition at line 254 of file SqlReader.cs.

                                                             {
             SqlCommand sc = new SqlCommand(s.ModifiedDateQuery, GetConnectionObj());
             sc.CommandType = s.QueriesAreStoredProcedures ? System.Data.CommandType.StoredProcedure : System.Data.CommandType.Text;
             sc.Parameters.Add(CreateIdParameter(id));
             return sc;
         }

SqlConnection ImageResizer.Plugins.SqlReader.SqlReaderPlugin.GetConnectionObj ( )

inline

Creates and returns a SqlConnection object for the database based on the configuration.

Returns

Definition at line 227 of file SqlReader.cs.

                                                {
 
             //First, try the connection string as a connection string key.
             if (System.Configuration.ConfigurationManager.ConnectionStrings[s.ConnectionString] != null)
                 return new SqlConnection(System.Configuration.ConfigurationManager.ConnectionStrings[s.ConnectionString].ConnectionString);
 
             //Second, try the .NET syntax
             string prefix = "ConnectionStrings:";
             //ConnectionStrings:namedString convention
             if (s.ConnectionString.Trim().StartsWith(prefix, StringComparison.OrdinalIgnoreCase)) {
                 string key = s.ConnectionString.Trim().Substring(prefix.Length).Trim();
                 if (System.Configuration.ConfigurationManager.ConnectionStrings[key] != null)
                     return new SqlConnection(System.Configuration.ConfigurationManager.ConnectionStrings[key].ConnectionString);
                 else
                     throw new ImageResizer.ImageProcessingException("SqlReader: Failed to locate the named connection string '" + key + "' in web.config");
 
             }
 
             //Third, try it as an actual connection string
             return new SqlConnection(s.ConnectionString);
         }

DateTime ImageResizer.Plugins.SqlReader.SqlReaderPlugin.GetDateModifiedUtc ( string id )

inline

Returns DateTime.MinValue if there are no rows, or no values on the row. Executes ModifiedDateQuery, then returns the first non-null datetime value on the first row.

Parameters

id

Returns

Definition at line 195 of file SqlReader.cs.

                                                      {
             FireAuthorizeEvent(id);
             SqlConnection conn = GetConnectionObj();
             conn.Open();
             using (conn)
             {
                 SqlCommand sc = new SqlCommand(s.ModifiedDateQuery, conn);
                 sc.Parameters.Add(CreateIdParameter(id));
                 sc.CommandType = s.QueriesAreStoredProcedures ? System.Data.CommandType.StoredProcedure : System.Data.CommandType.Text;
                 SqlDataReader sdr = sc.ExecuteReader();
                 using (sdr)
                 {
                     if (!sdr.Read()) return DateTime.MinValue; //0 rows
 
                     for (int i = 0; i < sdr.FieldCount; i++)
                     {
                         if (!sdr.IsDBNull(i) && sdr.GetValue(i) is DateTime)
                         {
                             DateTime val = (DateTime)sdr.GetValue(i);
                             if (val.Kind == DateTimeKind.Unspecified) val = DateTime.SpecifyKind(val, DateTimeKind.Utc);
                             return val; //Return the first non-null datetime instance in the row. Regardless of value.
                         }
                     }
                 }
             }
             return DateTime.MinValue;
         }

override VirtualFile ImageResizer.Plugins.SqlReader.SqlReaderPlugin.GetFile ( string virtualPath )

inline

VPP method, not for external use

Parameters

virtualPath

Returns

Definition at line 348 of file SqlReader.cs.

         {
             if (IsPathVirtual(virtualPath))
 
                 return new DatabaseFile(virtualPath, this);
             else
                 return Previous.GetFile(virtualPath);
         }

IVirtualFile ImageResizer.Plugins.SqlReader.SqlReaderPlugin.GetFile	(	string	virtualPath,
		NameValueCollection	queryString
	)

inline

Returns an IVirtualFile instance if the file exists in this provider.

Parameters

virtualPath
queryString

Returns

Implements ImageResizer.Plugins.IVirtualImageProvider.

Definition at line 372 of file SqlReader.cs.

                                                                                          {
             return IsPathVirtual(virtualPath) ? new DatabaseFile(virtualPath, this) : null;
         }

IEnumerable<IIssue> ImageResizer.Plugins.SqlReader.SqlReaderPlugin.GetIssues ( )

inline

Provides the diagnostics system with a list of configuration issues

Returns

Implements ImageResizer.Configuration.Issues.IIssueProvider.

Definition at line 398 of file SqlReader.cs.

                                                {
             List<IIssue> issues = new List<IIssue>();
 
             //1) Verify named connection strings exist
             string prefix = "ConnectionStrings:";
             //ConnectionStrings:namedString convention
             if (s != null && s.ConnectionString != null && s.ConnectionString.Trim().StartsWith(prefix, StringComparison.OrdinalIgnoreCase)) {
                 string key = s.ConnectionString.Trim().Substring(prefix.Length).Trim();
                 if (System.Configuration.ConfigurationManager.ConnectionStrings[key] == null)
                     issues.Add(new Issue("SqlReader", "Failed to locate the named connection string '" + key + "' in web.config","", IssueSeverity.ConfigurationError));
 
             }
 
             if (FailedToRegisterVpp)
                 issues.Add(new Issue("SqlReader", "Failed to register as VirtualPathProvider.",
                     "Only the image resizer will be able to access files located in SQL - other systems will not be able to.", IssueSeverity.Error));
             
 
             return issues;
         }

Stream ImageResizer.Plugins.SqlReader.SqlReaderPlugin.GetStream ( string id )

inline

Returns a stream to the

Parameters

id

Returns

Definition at line 113 of file SqlReader.cs.

         {
             FireAuthorizeEvent(id);
             SqlConnection conn = GetConnectionObj();
             conn.Open();
             using (conn)
             {
                 SqlCommand sc = new SqlCommand(s.ImageBlobQuery, conn);
                 sc.CommandType = s.QueriesAreStoredProcedures ? System.Data.CommandType.StoredProcedure : System.Data.CommandType.Text;
                 sc.Parameters.Add(CreateIdParameter(id));
                 SqlDataReader sdr = sc.ExecuteReader();
                 using (sdr)
                 {
                     if (!sdr.Read()) throw new FileNotFoundException("Failed to find the specified image " + id + " in the database"); //0 rows
 
                     return sdr.GetSqlBytes(0).Stream; //No connection required for the stream, all cloned in memory.
                 }
             }
         }

override void ImageResizer.Plugins.SqlReader.SqlReaderPlugin.Initialize ( )

inlineprotected

No initialization needed for this VPP

Definition at line 264 of file SqlReader.cs.

265 {

266 }

IPlugin ImageResizer.Plugins.SqlReader.SqlReaderPlugin.Install ( Configuration.Config c )

inline

Installes the plugin into the specified configuration. Once installed, it cannot be uninstalled.

Parameters

c

Returns

Definition at line 53 of file SqlReader.cs.

                                                        {
             c.Plugins.add_plugin(this);
             
             c.Pipeline.PostAuthorizeRequestStart += delegate(IHttpModule sender2, HttpContext context) {
                     //Only work with database images
                     //This allows us to resize database images without putting ".jpg" after the ID in the path.
                     if ((!s.RequireImageExtension || s.UntrustedData) && c.Pipeline.PreRewritePath.StartsWith(s.VirtualPathPrefix, StringComparison.OrdinalIgnoreCase))
                         c.Pipeline.SkipFileTypeCheck = true; //Skip the file extension check. FakeExtensions will still be stripped.
             };
             
 
             c.Pipeline.RewriteDefaults += delegate(IHttpModule sender, HttpContext context, Configuration.IUrlEventArgs e) {
                 //Only work with database images
                 //Non-images will be served as-is
                 //Cache all file types, whether they are processed or not.
                 if (s.CacheUnmodifiedFiles && e.VirtualPath.StartsWith(s.VirtualPathPrefix, StringComparison.OrdinalIgnoreCase))
                     e.QueryString["cache"] = ServerCacheMode.Always.ToString();
 
 
             };
             c.Pipeline.PostRewrite += delegate(IHttpModule sender, HttpContext context, Configuration.IUrlEventArgs e) {
                 //Only work with database images
                 //If the data is untrusted, always re-encode each file.
                 if (s.UntrustedData && e.VirtualPath.StartsWith(s.VirtualPathPrefix, StringComparison.OrdinalIgnoreCase))
                     e.QueryString["process"] = ImageResizer.ProcessWhen.Always.ToString();
 
             };
             if (s.RegisterAsVirtualPathProvider) {
                 try {
                     HostingEnvironment.RegisterVirtualPathProvider(this);
                 } catch (SecurityException) {
                     this._failedToRegisterVpp = true;
                 }
             }
 
             return this;
         }

virtual string ImageResizer.Plugins.SqlReader.SqlReaderPlugin.ParseIdFromVirtualPath ( string virtualPath )

inlinevirtual

Supports int, string, and GUID IDs. Override this to modify ID parsing if you can't do it with rewrite rules.

Parameters

virtualPath

Returns

Definition at line 273 of file SqlReader.cs.

         {
             String checkPath = ImageResizer.Util.PathUtils.ResolveAppRelative(virtualPath);
             //Check for prefix
             if (!checkPath.StartsWith(s.VirtualPathPrefix, StringComparison.OrdinalIgnoreCase)) return null;
             string id = checkPath.Substring(s.VirtualPathPrefix.Length); //Strip prefix
             //Strip slashes at beginning 
             id = id.TrimStart(new char[] { '/', '\\' });
             //Strip extension if not a string 
             if (!IsStringKey || s.StripFileExtension) {
                 int length = id.LastIndexOf('.');
                 if (length > -1) id = id.Substring(0, length);
             }
             //Can't be empty.
             if (id.Length < 1) return null;
             //Verify only valid characters present
             if (IsIntKey)
             {
                 long val =0;
                 if (!long.TryParse(id, out val)) return null; // not a valid integer
             }
             else if (s.ImageIdType == System.Data.SqlDbType.UniqueIdentifier)
             {
                 try
                 {
                     Guid test = new Guid(id);
                 }
                 catch
                 {
                     return null; //Not a valid guid.
                 }
 
             } else if (IsStringKey) {
                 return id;
             }else {
                 throw new ImageProcessingException("Only Integer, String, and GUID identifiers are suported by SqlReader");
             }
  
             return id;
         }

bool ImageResizer.Plugins.SqlReader.SqlReaderPlugin.RowExists ( string id )

inline

Executes existsQuery, and returns true if the value is greater than 0

Parameters

id

Returns

Definition at line 174 of file SqlReader.cs.

                                         {
             FireAuthorizeEvent(id);
             SqlConnection conn = GetConnectionObj();
             conn.Open();
             using (conn)
             {
                 SqlCommand sc = new SqlCommand(s.ImageExistsQuery, conn);
                 sc.CommandType = s.QueriesAreStoredProcedures ? System.Data.CommandType.StoredProcedure : System.Data.CommandType.Text;
                 sc.Parameters.Add(CreateIdParameter(id));
                 int count = (int)sc.ExecuteScalar();
                 if (count > 0) return true;
             }
             return false;
         }

bool ImageResizer.Plugins.SqlReader.SqlReaderPlugin.Uninstall ( Configuration.Config c )

inline

This plugin cannot be uninstalled as ASP.NET does not provide a 'undo' function for RegisterVirtualPathProvider

Parameters

c

Returns

Definition at line 96 of file SqlReader.cs.

                                                       {
             return false;
         }

Property Documentation

bool ImageResizer.Plugins.SqlReader.SqlReaderPlugin.FailedToRegisterVpp

get

True if the provider attempted to register itself as a VirtualPathProvider and failed due to limited security clearance. False if it did not attempt, or if it succeeded.

Definition at line 44 of file SqlReader.cs.

bool ImageResizer.Plugins.SqlReader.SqlReaderPlugin.IsIntKey

get

Returns true if Settings.ImageIdType is an integer type

Definition at line 162 of file SqlReader.cs.

bool ImageResizer.Plugins.SqlReader.SqlReaderPlugin.IsStringKey

get

Returns true if Settings.ImageIdType is a string type

Definition at line 154 of file SqlReader.cs.

SqlReaderSettings ImageResizer.Plugins.SqlReader.SqlReaderPlugin.Settings

get

Provides all the configuration options for the plugin.

Definition at line 36 of file SqlReader.cs.

The documentation for this class was generated from the following file:

C:/Users/nathanael/Documents/resizer/Plugins/SqlReader/SqlReader.cs

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Member Function Documentation

Property Documentation