Class StorageHelper

Namespace

CMS.IO

Assembly

CMS.IO.dll

Class providing helper methods for storage providers management.

public static class StorageHelper

Inheritance

object

StorageHelper

Methods

CopyFileAcrossProviders(string, string)

Copies two files across different storage providers

public static void CopyFileAcrossProviders(string sourceFileName, string destFileName)

Parameters

sourceFileName string

Source path

destFileName string

Destination path

DeleteOldFiles(DirectoryInfo, DateTime, bool, bool, Func<string, string, bool>)

Deletes files older than specified time from the file system.

public static void DeleteOldFiles(DirectoryInfo dir, DateTime olderThan, bool deleteEmptyFolder = true, bool recursively = true, Func<string, string, bool> deleteFileCallback = null)

Parameters

dir DirectoryInfo

Directory to process

olderThan DateTime

Limit time for deletion of a file

deleteEmptyFolder bool

Indicates if the specified folder should be deleted if there are no files left at the end

recursively bool

Indicates if the subfolders of the folder are to be processed.

deleteFileCallback Func<string, string, bool>

Callback accepting folder name and file respectively and returning a value indicating whether the file is to be deleted.

GetDirectoryInfo(string)

Returns new instance of directory info.

public static DirectoryInfo GetDirectoryInfo(string path)

Parameters

path string

Path

Returns

DirectoryInfo

GetFileInfo(string)

Returns new instance of FileInfo object.

public static FileInfo GetFileInfo(string filename)

Parameters

filename string

File name

Returns

FileInfo

GetFileStream(string, FileMode)

Returns new instance of file stream.

public static FileStream GetFileStream(string path, FileMode mode)

Parameters

path string

Path to file

mode FileMode

File mode

Returns

FileStream

GetFileStream(string, FileMode, FileAccess)

Returns new instance of file stream.

public static FileStream GetFileStream(string path, FileMode mode, FileAccess access)

Parameters

path string

Path to file

mode FileMode

File mode

access FileAccess

File access

Returns

FileStream

GetFileStream(string, FileMode, FileAccess, FileShare)

Returns new instance of file stream.

public static FileStream GetFileStream(string path, FileMode mode, FileAccess access, FileShare share)

Parameters

path string

Path to file

mode FileMode

File mode

access FileAccess

File access

share FileShare

Sharing permissions

Returns

FileStream

GetFileStream(string, FileMode, FileAccess, FileShare, int)

Returns new instance of file stream.

public static FileStream GetFileStream(string path, FileMode mode, FileAccess access, FileShare share, int bufferSize)

Parameters

path string

Path to file

mode FileMode

File mode

access FileAccess

File access

share FileShare

Sharing permissions

bufferSize int

Buffer size

Returns

FileStream

GetFullFilePhysicalPath(string, string)

Returns full physical path of a file or folder. Does not change the ending slash

public static string GetFullFilePhysicalPath(string path, string webFullPath = null)

Parameters

path string

Path

webFullPath string

Full path to the root of the web project (e.g. c:\WebProject)

Returns

string

GetFullFolderPhysicalPath(string, string)

Returns full physical path for a folder. Ensures the trailing backslash

public static string GetFullFolderPhysicalPath(string path, string webFullPath = null)

Parameters

path string

Path

webFullPath string

Full path to the root of the web project (e.g. c:\WebProject)

Returns

string

GetStorageProvider(string)

Gets the storage provider based on the given path, updates the path so it matches the provider internal structure

public static AbstractStorageProvider GetStorageProvider(string path)

Parameters

path string

Input path, output is path relative to the returned storage provider

Returns

AbstractStorageProvider

GetWebApplicationRelativePath(string)

Converts the given physical path to an application relative path

public static string GetWebApplicationRelativePath(string path)

Parameters

path string

Path to convert

Returns

string

IsExternalStorage(string)

Returns whether the path is targeting an external storage.

public static bool IsExternalStorage(string path)

Parameters

path string

File path to check (virtual or physical)

Returns

bool

IsSameStorageProvider(string, string)

Returns true, if two given paths use the same storage provider

public static bool IsSameStorageProvider(string path1, string path2)

Parameters

path1 string

First file path

path2 string

Second file path

Returns

bool

IsSharedStorage(string)

Returns whether the path is targeting a shared storage.

public static bool IsSharedStorage(string path)

Parameters

path string

File path to check (virtual or physical)

Returns

bool

MapStoragePath(string, AbstractStorageProvider)

Maps the given storage path to a specific provider

public static void MapStoragePath(string path, AbstractStorageProvider provider)

Parameters

path string

Path to map, e.g. ~/App_Data

provider AbstractStorageProvider

Provider to use for the given path and sub paths

MoveFileAcrossProviders(string, string)

Copies two files across different storage providers

public static void MoveFileAcrossProviders(string sourceFileName, string destFileName)

Parameters

sourceFileName string

Source path

destFileName string

Destination path

SaveFileToDisk(string, BinaryDataWrapper, bool)

Saves the given file to the disk file

public static void SaveFileToDisk(string filePath, BinaryDataWrapper data, bool closeStream = true)

Parameters

filePath string

File path

data BinaryDataWrapper

File data

closeStream bool

If true, and source data is stream, the stream gets closed

UnMapStoragePath(string)

Removes the mapping to a storage provider

public static AbstractStorageProvider UnMapStoragePath(string path)

Parameters

path string

Path to unmap

Returns

AbstractStorageProvider