Table of Contents

Class MediaFileInfoProvider

Namespace
CMS.MediaLibrary
Assembly
CMS.MediaLibrary.dll

Class providing media file info management.

[ProviderInterface(typeof(IMediaFileInfoProvider))]
[Obsolete("Media libraries and their APIs are obsolete and will be discontinued in the future. Please migrate all media library files to Content hub and use their corresponding content item APIs.")]
public class MediaFileInfoProvider : AbstractInfoProvider<MediaFileInfo, MediaFileInfoProvider>, IInfoProvider, ICustomizableProvider, IBulkOperationProvider, IWebFarmProvider, IInfoValidator<MediaFileInfo>, IInfoByNameProvider<MediaFileInfo>, IBulkInfoProvider<MediaFileInfo>, IMediaFileInfoProvider, IInfoProvider<MediaFileInfo>, IInfoByIdProvider<MediaFileInfo>, IInfoByGuidProvider<MediaFileInfo>
Inheritance
object
MediaFileInfoProvider
Implements
Inherited Members
Extension Methods

Constructors

MediaFileInfoProvider()

Creates new instance of MediaFileInfoProvider.

public MediaFileInfoProvider()

Methods

CanResizeImage(MediaFileInfo, int, int, int)

Checks whether the image should be processed (resized) by the Image manager (if the destination size is smaller).

public static bool CanResizeImage(MediaFileInfo fileInfo, int width, int height, int maxSideSize)

Parameters

fileInfo MediaFileInfo

Media file info to check

width int

New width

height int

New height

maxSideSize int

Max side size

Returns

bool

CanResizeImage(string, int, int, int)

Checks whether the image should be processed (resized) by the Image manager (if the destination size is smaller).

public static bool CanResizeImage(string filePath, int width, int height, int maxSideSize)

Parameters

filePath string

File path

width int

New width

height int

New height

maxSideSize int

Max side size

Returns

bool

CopyMediaFile(int, string, string, bool, int)

Copy media file.

public static void CopyMediaFile(int libraryID, string origPath, string newPath, bool synchronization = false, int userId = 0)

Parameters

libraryID int

Library ID

origPath string

Old file path within the library folder

newPath string

New file path within the library folder

synchronization bool

Indicates if method is running by web farms synchronization

userId int

ID of the user performing copy action

CopyMediaFileInternal(int, string, string, bool, int)

Copy media file.

protected virtual void CopyMediaFileInternal(int libraryID, string origPath, string newPath, bool synchronization, int userId)

Parameters

libraryID int

Library ID

origPath string

Old file path within the library folder

newPath string

New file path within the library folder

synchronization bool

Indicates if method is running by web farms synchronization

userId int

ID of the user performing copy action

Delete(MediaFileInfo)

Deletes the info object from the underlying data store.

public override void Delete(MediaFileInfo info)

Parameters

info MediaFileInfo

Info object to be deleted.

Exceptions

ArgumentNullException

Thrown when info is null.

DeleteMediaFile(int, string, bool, bool)

Deletes media file from file system.

public static void DeleteMediaFile(int libraryId, string filePath, bool onlyFile = false, bool synchronization = false)

Parameters

libraryId int

Library id

filePath string

Sub path to file

onlyFile bool

Indicates if only file should be deleted

synchronization bool

Indicates if method is running by web farms synchronization

DeleteMediaFileInternal(int, string, bool, bool)

Deletes media file from filesystem.

protected virtual void DeleteMediaFileInternal(int libraryID, string filePath, bool onlyFile, bool synchronization)

Parameters

libraryID int

Library id

filePath string

Sub path to file

onlyFile bool

Indicates if only file should be deleted

synchronization bool

Indicates if method is running by web farms synchronization

DeleteMediaFilePreview(int, string, bool)

Deletes media file preview from file system.

public static void DeleteMediaFilePreview(int libraryId, string filePath, bool synchronization = false)

Parameters

libraryId int

Library ID

filePath string

File path

synchronization bool

Indicates if method is running by web farms synchronization

DeleteMediaFilePreviewInternal(int, string, bool)

Deletes media file preview from filesystem.

protected virtual void DeleteMediaFilePreviewInternal(int libraryID, string filePath, bool synchronization)

Parameters

libraryID int

Library ID

filePath string

File path

synchronization bool

Indicates if method is running by web farms synchronization

DeleteMediaFilePreviewThumbnails(MediaFileInfo)

Deletes media file preview thumbnails.

public static void DeleteMediaFilePreviewThumbnails(MediaFileInfo fileInfo)

Parameters

fileInfo MediaFileInfo

File info

DeleteMediaFilePreviewThumbnailsInternal(MediaFileInfo)

Deletes media file preview thumbnails.

protected virtual void DeleteMediaFilePreviewThumbnailsInternal(MediaFileInfo fileInfo)

Parameters

fileInfo MediaFileInfo

File info

DeleteMediaFileThumbnails(MediaFileInfo)

Deletes media file thumbnails.

public static void DeleteMediaFileThumbnails(MediaFileInfo fileInfo)

Parameters

fileInfo MediaFileInfo

File info

DeleteMediaFileThumbnailsInternal(MediaFileInfo)

Deletes media file thumbnails.

protected virtual void DeleteMediaFileThumbnailsInternal(MediaFileInfo fileInfo)

Parameters

fileInfo MediaFileInfo

File info

DeleteMediaFiles(string, int)

Deletes file records of files matching specified criteria.

public static void DeleteMediaFiles(string path, int libraryId)

Parameters

path string

Path of the files to delete

libraryId int

ID of the library where the files belongs to

DeleteMediaFilesInternal(string, int)

Deletes file records of files matching specified criteria.

protected virtual void DeleteMediaFilesInternal(string path, int libraryId)

Parameters

path string

Path of the files to delete

libraryId int

ID of the library where the files belongs to

EnsureThumbnailFile(MediaFileInfo, int, int, int, bool)

Ensures the thumbnail file.

public static string EnsureThumbnailFile(MediaFileInfo fileInfo, int width = 0, int height = 0, int maxSideSize = 0, bool usePreview = false)

Parameters

fileInfo MediaFileInfo

File info

width int

File width

height int

File height

maxSideSize int

Maximum side size

usePreview bool

Use preview file

Returns

string

EnsureThumbnailFileInternal(MediaFileInfo, int, int, int, bool)

Ensures the thumbnail file.

protected virtual string EnsureThumbnailFileInternal(MediaFileInfo fileInfo, int width, int height, int maxSideSize, bool usePreview = false)

Parameters

fileInfo MediaFileInfo

File info

width int

File width

height int

File height

maxSideSize int

Maximum side size

usePreview bool

Use preview file

Returns

string

GetDependencyCacheKeys(MediaFileInfo, bool)

Gets the cache key dependencies array for the media file (cache item keys affected when the meta file changes).

public static string[] GetDependencyCacheKeys(MediaFileInfo fi, bool preview)

Parameters

fi MediaFileInfo

File

preview bool

Indicates if preview cache key should be created

Returns

string[]

GetDependencyCacheKeysInternal(MediaFileInfo, bool)

Gets the cache key dependencies array for the media file (cache item keys affected when the meta file changes).

protected virtual string[] GetDependencyCacheKeysInternal(MediaFileInfo fi, bool preview)

Parameters

fi MediaFileInfo

File

preview bool

Indicates if preview cache key should be created

Returns

string[]

GetFile(MediaFileInfo, string)

Returns the file from disk or (if not available on the disk) from database.

public static byte[] GetFile(MediaFileInfo fileInfo, string libraryFolder)

Parameters

fileInfo MediaFileInfo

File info

libraryFolder string

Library folder

Returns

byte[]

GetFileInternal(MediaFileInfo, string)

Returns the file from disk or (if not available on the disk) from database.

protected virtual byte[] GetFileInternal(MediaFileInfo fileInfo, string libraryFolder)

Parameters

fileInfo MediaFileInfo

File info

libraryFolder string

Library folder

Returns

byte[]

GetImageThumbnail(MediaFileInfo, string, int, int, int)

Returns image thumbnail from the disk or create a new one if doesn't exist yet.

public static byte[] GetImageThumbnail(MediaFileInfo fileInfo, string libraryFolder, int width = 0, int height = 0, int maxSideSize = 0)

Parameters

fileInfo MediaFileInfo

File info

libraryFolder string

Library folder

width int

Image width

height int

Image height

maxSideSize int

Maximum side size

Returns

byte[]

GetImageThumbnailInternal(MediaFileInfo, string, int, int, int)

Returns image thumbnail from the disk or create a new one if doesn't exist yet.

protected virtual byte[] GetImageThumbnailInternal(MediaFileInfo fileInfo, string libraryFolder, int width, int height, int maxSideSize)

Parameters

fileInfo MediaFileInfo

File info

libraryFolder string

Library folder

width int

Image width

height int

Image height

maxSideSize int

Maximum side size

Returns

byte[]

GetMediaFileInfo(int, string)

Returns the MediaFileInfo structure for the specified media file.

public static MediaFileInfo GetMediaFileInfo(int mediaLibraryId, string mediaFilePath)

Parameters

mediaLibraryId int

Media library ID

mediaFilePath string

File path

Returns

MediaFileInfo

GetMediaFileInfo(string, string)

Returns the MediaFileInfo structure for the specified media file.

public static MediaFileInfo GetMediaFileInfo(string mediaFilePath, string libraryFolder)

Parameters

mediaFilePath string

File path

libraryFolder string

Library folder name

Returns

MediaFileInfo

GetMediaFileInfoInternal(Guid)

Returns media file with specified GUID.

protected virtual MediaFileInfo GetMediaFileInfoInternal(Guid guid)

Parameters

guid Guid

Media file GUID

Returns

MediaFileInfo

GetMediaFileInfoInternal(int, string)

Returns the MediaFileInfo structure for the specified media file.

protected virtual MediaFileInfo GetMediaFileInfoInternal(int mediaLibraryId, string mediaFilePath)

Parameters

mediaLibraryId int

Media library ID

mediaFilePath string

File path

Returns

MediaFileInfo

GetMediaFileInfoInternal(string, string)

Returns the MediaFileInfo structure for the specified media file.

protected virtual MediaFileInfo GetMediaFileInfoInternal(string mediaFilePath, string libraryFolder)

Parameters

mediaFilePath string

File path

libraryFolder string

Library folder name

Returns

MediaFileInfo

GetMediaFilePath(MediaFileInfo, string)

Returns physical path to the media file.

public static string GetMediaFilePath(MediaFileInfo fileInfo, string webFullPath)

Parameters

fileInfo MediaFileInfo

Media file info

webFullPath string

Physical path to the root of the web project (e.g. c:\WebProject), if it is not specified web application physical path is used

Returns

string

GetMediaFilePath(int, string)

Returns physical path to the media file.

public static string GetMediaFilePath(int libraryId, string filePath)

Parameters

libraryId int

Media library ID

filePath string

File path

Returns

string

GetMediaFilePath(string, int, string)

Returns physical path to the given file path and library.

public static string GetMediaFilePath(string filePath, int fileLibraryId, string webFullPath = null)

Parameters

filePath string

Media file path

fileLibraryId int

Library ID of the media file

webFullPath string

Physical path to the root of the web project (e.g. c:\WebProject), if it is not specified web application physical path is used

Returns

string

GetMediaFilePath(string, string, string)

Returns physical path to the media file.

public static string GetMediaFilePath(string libraryFolder, string filePath, string webFullPath = null)

Parameters

libraryFolder string

Library folder name

filePath string

File path within the library folder

webFullPath string

Physical path to the root of the web project (e.g. c:\WebProject), if it is not specified web application physical path is used

Returns

string

GetMediaFilePathInternal(string, string, string)

Returns physical path to the media file.

protected virtual string GetMediaFilePathInternal(string libraryFolder, string filePath, string webFullPath)

Parameters

libraryFolder string

Library folder name

filePath string

File path within the library folder

webFullPath string

Physical path to the root of the web project (e.g. c:\WebProject), if it is not specified web application physical path is used

Returns

string

GetMediaFiles(string, string, int, string)

Returns dataset of files matching given criteria from database.

public static ObjectQuery<MediaFileInfo> GetMediaFiles(string where, string orderBy = null, int topN = -1, string columns = null)

Parameters

where string

WHERE condition

orderBy string

ORDER BY parameter

topN int

TOP N parameter

columns string

Selected columns

Returns

ObjectQuery<MediaFileInfo>

GetMediaFilesInternal()

Returns the query for all media files.

protected virtual ObjectQuery<MediaFileInfo> GetMediaFilesInternal()

Returns

ObjectQuery<MediaFileInfo>

GetPreviewFilePath(MediaFileInfo)

Returns preview file path for media file info. If no preview found returns NULL

public static string GetPreviewFilePath(MediaFileInfo fileInfo)

Parameters

fileInfo MediaFileInfo

Media file info

Returns

string

GetPreviewFilePath(string, int)

Returns preview file path for search pattern (.* as extension).

public static string GetPreviewFilePath(string filePath, int libraryId)

Parameters

filePath string

File path from database

libraryId int

Library ID

Returns

string

GetPreviewFilePathInternal(string, int)

Returns preview file path for search pattern (.* as extension).

protected virtual string GetPreviewFilePathInternal(string filePath, int libraryId)

Parameters

filePath string

File path from database

libraryId int

Library ID

Returns

string

GetThumbnail(string, int, int, int, int)

Returns image thumbnail from the disk or create a new one if doesn't exist yet.

public static byte[] GetThumbnail(string originalFilePath, int originalWidth, int originalHeight, int width, int height)

Parameters

originalFilePath string

Original file path

originalWidth int

Original width

originalHeight int

Original height

width int

Width

height int

Height

Returns

byte[]

GetThumbnailInternal(string, int, int, int, int)

Returns image thumbnail from the disk or create a new one if doesn't exist yet.

protected virtual byte[] GetThumbnailInternal(string originalFilePath, int originalWidth, int originalHeight, int width, int height)

Parameters

originalFilePath string

Original file path

originalWidth int

Original width

originalHeight int

Original height

width int

Width

height int

Height

Returns

byte[]

GetThumbnailPath(int, string)

Returns physical path to the thumbnail folder.

public static string GetThumbnailPath(int libraryId, string filePath)

Parameters

libraryId int

Media library ID

filePath string

File path from database

Returns

string

GetThumbnailPath(string, int, string)

Returns physical path to the thumbnail folder.

public static string GetThumbnailPath(string filePath, int libraryId, string webFullPath = null)

Parameters

filePath string

File path from database

libraryId int

Media library ID

webFullPath string

Physical path to the root of the web project (e.g. c:\WebProject), if it is not specified web application physical path is used

Returns

string

GetThumbnailPath(string, string, string, int, int, bool, bool)

Returns physical path to the thumbnail.

public static string GetThumbnailPath(string fileName, string fileExtension, string path, int width, int height, bool addHiddenFolder, bool addFileExtension)

Parameters

fileName string

File name of the file thumbnail is related to

fileExtension string

Extension of the file thumbnail is related to

path string

Path of the original file

width int

Width of the thumbnail file

height int

Height of the thumbnail file

addHiddenFolder bool

Indicates if hidden folder should be inserted into path

addFileExtension bool

Indicates if file extension should be inserted into thumbnail file name

Returns

string

GetThumbnailPathInternal(string, int, string)

Returns physical path to the thumbnail folder.

protected virtual string GetThumbnailPathInternal(string filePath, int libraryId, string webFullPath = null)

Parameters

filePath string

File path from database

libraryId int

Media library ID

webFullPath string

Physical path to the root of the web project (e.g. c:\WebProject), if it is not specified web application physical path is used

Returns

string

GetThumbnailPathInternal(string, string, string, int, int, bool, bool)

Returns physical path to the thumbnail.

protected virtual string GetThumbnailPathInternal(string fileName, string fileExtension, string path, int width, int height, bool addHiddenFolder, bool addFileExtension)

Parameters

fileName string

File name of the file thumbnail is related to

fileExtension string

Extension of the file thumbnail is related to

path string

Path of the original file

width int

Width of the thumbnail file

height int

Height of the thumbnail file

addHiddenFolder bool

Indicates if hidden folder should be inserted into path

addFileExtension bool

Indicates if file extension should be inserted into thumbnail file name

Returns

string

ImportMediaFileInfo(MediaFileInfo, int)

Import media file into database.

public static void ImportMediaFileInfo(MediaFileInfo mediaFile, int userId = 0)

Parameters

mediaFile MediaFileInfo

Media file to import

userId int

ID of the user performing set action

ImportMediaFileInfoInternal(MediaFileInfo, int)

Import media file into database.

protected virtual void ImportMediaFileInfoInternal(MediaFileInfo mediaFile, int userId)

Parameters

mediaFile MediaFileInfo

Media file to import

userId int

ID of the user performing set action

MoveMediaFile(int, int, string, string, bool)

Moves media file.

public static void MoveMediaFile(int originalLibraryID, int newLibraryID, string origPath, string newPath, bool synchronization = false)

Parameters

originalLibraryID int

Original library ID

newLibraryID int

New library ID

origPath string

Old file path within the library folder

newPath string

New file path within the library folder

synchronization bool

Indicates if method is running by web farms synchronization

MoveMediaFile(int, string, string, bool)

Moves media file within one library.

public static void MoveMediaFile(int libraryID, string origPath, string newPath, bool synchronization = false)

Parameters

libraryID int

Library ID

origPath string

Old file path within the library folder

newPath string

New file path within the library folder

synchronization bool

Indicates if method is running by web farms synchronization

MoveMediaFileInternal(int, int, string, string, bool)

Moves media file.

protected virtual void MoveMediaFileInternal(int originalLibraryID, int newLibraryID, string origPath, string newPath, bool synchronization)

Parameters

originalLibraryID int

Original library ID

newLibraryID int

New library ID

origPath string

Old file path within the library folder

newPath string

New file path within the library folder

synchronization bool

Indicates if method is running by web farms synchronization

SaveFileToDisk(string, string, string, string, Guid, BinaryDataWrapper, bool, bool)

Saves media file to disk and returns the applied file path.

public static string SaveFileToDisk(string libraryFolder, string librarySubFolderPath, string fileName, string fileExtension, Guid fileGuid, BinaryDataWrapper fileData, bool synchronization, bool ensureUniqueFileName = true)

Parameters

libraryFolder string

Media library root folder

librarySubFolderPath string

Subfolder path

fileName string

Name of the file

fileExtension string

Extension of the file

fileGuid Guid

File GUID

fileData BinaryDataWrapper

File data

synchronization bool

Indicates if method is running by web farms synchronization

ensureUniqueFileName bool

Indicates if unique file name should be ensured

Returns

string

SaveFileToDiskInternal(string, string, string, string, Guid, BinaryDataWrapper, bool, bool, bool, string, string)

Saves media file to disk and returns the applied file path.

protected virtual string SaveFileToDiskInternal(string libraryFolder, string librarySubFolderPath, string fileName, string fileExtension, Guid fileGuid, BinaryDataWrapper fileData, bool synchronization, bool ensureUniqueFileName, bool skipChecks, string filePath, string fileSubFolderPath)

Parameters

libraryFolder string

Media library root folder

librarySubFolderPath string

Subfolder path

fileName string

Name of the file

fileExtension string

Extension of the file

fileGuid Guid

File GUID

fileData BinaryDataWrapper

File data

synchronization bool

Indicates if method is running by web farms synchronization

ensureUniqueFileName bool

Indicates if unique file name should be ensured

skipChecks bool

Skip check for file path and ensuring physical file path

filePath string

File path

fileSubFolderPath string

File subfolder path

Returns

string

Set(MediaFileInfo)

Inserts or updates the info object in the underlying data store.

public override void Set(MediaFileInfo info)

Parameters

info MediaFileInfo

Info object to be inserted or updated.

Exceptions

ArgumentNullException

Thrown when info is null.

See Also

ShouldResize(int, int, int, int, int)

Returns true if image should be scaled down.

public static bool ShouldResize(int maxSideSize, int width, int height, int imageWidth, int imageHeight)

Parameters

maxSideSize int

Max side size

width int

Width

height int

Height

imageWidth int

Image width

imageHeight int

Image height

Returns

bool

ShouldResizeInternal(int, int, int, int, int)

Returns true if image should be scaled down.

protected virtual bool ShouldResizeInternal(int maxSideSize, int width, int height, int imageWidth, int imageHeight)

Parameters

maxSideSize int

Max side size

width int

Width

height int

Height

imageWidth int

Image width

imageHeight int

Image height

Returns

bool