BadScript2.Container.BadLayeredFileSystem Class Reference

Inheritance diagram for BadScript2.Container.BadLayeredFileSystem:

Public Member Functions
BadLayeredFileSystemStackInfo	GetInfo ()
	BadLayeredFileSystem (params BadLayeredFileSystemLayer[] layers)
void	Optimize ()
bool	Restore (string path)
string	GetStartupDirectory ()
	The Startup Directory of the Application.
bool	Exists (string path)
	Returns true if the given path is a file or directory.
bool	IsFile (string path)
	Returns true if the given path is a file.
bool	IsDirectory (string path)
	Returns true if the given path is a directory.
IEnumerable< string >	GetFiles (string path, string extension, bool recursive)
	Returns all files in the given directory that match the specified extension.
IEnumerable< string >	GetDirectories (string path, bool recursive)
	Returns all directories in the given directory.
void	CreateDirectory (string path, bool recursive=false)
	Creates a new directory.
void	DeleteDirectory (string path, bool recursive)
	Deletes a directory.
void	DeleteFile (string path)
	Deletes a file.
string	GetFullPath (string path)
	Returns the full path of the given path.
Stream	OpenRead (string path)
	Opens a file for reading.
Stream	OpenWrite (string path, BadWriteMode mode)
	Opens a file for writing.
string	GetCurrentDirectory ()
	Returns the Current Directory.
void	SetCurrentDirectory (string path)
	Sets the current Directory.
void	Copy (string src, string dst, bool overwrite=true)
	Copies a file or directory to a new location.
void	Move (string src, string dst, bool overwrite=true)
	Moves a file or directory to a new location.
BadVirtualFileSystem	GetWritable ()

Private Member Functions
bool	ContentEquals (Stream s1, Stream s2)
bool	IsSubfolderOf (string root, string sub)
void	CopyDirectoryToDirectory (string src, string dst)
void	CopyFileToFile (string src, string dst)

Private Attributes
readonly BadLayeredFileSystemLayer[]	m_Layers

Detailed Description

Definition at line 12 of file BadLayeredFileSystem.cs.

Constructor & Destructor Documentation

BadLayeredFileSystem()

BadScript2.Container.BadLayeredFileSystem.BadLayeredFileSystem

(

params BadLayeredFileSystemLayer[]

layers

)

Definition at line 42 of file BadLayeredFileSystem.cs.

        {
            m_Layers = layers;
        }

Member Function Documentation

ContentEquals()

bool BadScript2.Container.BadLayeredFileSystem.ContentEquals ( Stream  s1, Stream  s2  )

private

Definition at line 47 of file BadLayeredFileSystem.cs.

        {
            if (s1.Length != s2.Length) return false;
            int b1, b2;
            do
            {
                b1 = s1.ReadByte();
                b2 = s2.ReadByte();
                if (b1 != b2) return false;
            } while (b1 != -1);
            return true;
        }

Copy()

void BadScript2.Container.BadLayeredFileSystem.Copy	(	string	src,
		string	dst,
		bool	overwrite = true
	)

Copies a file or directory to a new location.

Parameters

src	Source path
dst	Destination path
overwrite	Should file entries be overwritten?

Implements BadScript2.IO.IFileSystem.

Definition at line 196 of file BadLayeredFileSystem.cs.

        {
            if (IsDirectory(src))
            {
                if (IsSubfolderOf(src, dst)) throw new IOException("Cannot copy a directory to a subfolder of itself.");
 
                if (!overwrite && IsDirectory(src)) throw new IOException("Directory already exists.");
 
                CopyDirectoryToDirectory(src, dst);
            }
            else if (IsFile(src))
            {
                if (!overwrite && IsFile(src)) throw new IOException("File already exists.");
 
                CopyFileToFile(src, dst);
            }
            else
            {
                throw new IOException("Source path is not a file or directory");
            }
        }

CopyDirectoryToDirectory()

void BadScript2.Container.BadLayeredFileSystem.CopyDirectoryToDirectory ( string  src, string  dst  )

private

Definition at line 238 of file BadLayeredFileSystem.cs.

        {
            foreach (var directory in GetDirectories(src, true)) CreateDirectory(directory);
 
            foreach (var file in GetFiles(src, "*", true)) CopyFileToFile(file, file.Replace(src, dst));
        }

CopyFileToFile()

void BadScript2.Container.BadLayeredFileSystem.CopyFileToFile ( string  src, string  dst  )

private

Definition at line 245 of file BadLayeredFileSystem.cs.

        {
            using var s = OpenRead(src);
            using var d = OpenWrite(dst, BadWriteMode.CreateNew);
            s.CopyTo(d);
        }

CreateDirectory()

void BadScript2.Container.BadLayeredFileSystem.CreateDirectory	(	string	path,
		bool	recursive = false
	)

Creates a new directory.

Parameters

path	The path to the directory
recursive	If true, all parent directories will be created if they do not exist

Implements BadScript2.IO.IFileSystem.

Definition at line 139 of file BadLayeredFileSystem.cs.

        {
            GetWritable().CreateDirectory(path, recursive);
        }

DeleteDirectory()

void BadScript2.Container.BadLayeredFileSystem.DeleteDirectory	(	string	path,
		bool	recursive
	)

Deletes a directory.

Parameters

path	The path to the directory
recursive	If true, all subdirectories will be deleted

Implements BadScript2.IO.IFileSystem.

Definition at line 144 of file BadLayeredFileSystem.cs.

        {
            if (!GetWritable().IsDirectory(path)) throw new Exception("Is Readonly");
            GetWritable().DeleteDirectory(path, recursive);
        }

DeleteFile()

void BadScript2.Container.BadLayeredFileSystem.DeleteFile

(

string

path

)

Deletes a file.

Parameters

path	The path to the directory

Implements BadScript2.IO.IFileSystem.

Definition at line 150 of file BadLayeredFileSystem.cs.

        {
            if (!GetWritable().IsFile(path)) throw new Exception("Is Readonly");
            GetWritable().DeleteFile(path);
        }

Exists()

bool BadScript2.Container.BadLayeredFileSystem.Exists

(

string

path

)

Returns true if the given path is a file or directory.

Parameters

path	The path to check

Returns

true if the given path is a file or directory

Implements BadScript2.IO.IFileSystem.

Definition at line 106 of file BadLayeredFileSystem.cs.

        {
            return m_Layers.Any(x => x.FileSystem.Exists(path));
        }

GetCurrentDirectory()

string BadScript2.Container.BadLayeredFileSystem.GetCurrentDirectory

(

)

Returns the Current Directory.

Returns

The Current Directory

Implements BadScript2.IO.IFileSystem.

Definition at line 186 of file BadLayeredFileSystem.cs.

        {
            return GetWritable().GetCurrentDirectory();
        }

GetDirectories()

IEnumerable< string > BadScript2.Container.BadLayeredFileSystem.GetDirectories	(	string	path,
		bool	recursive
	)

Returns all directories in the given directory.

Parameters

path	The path to the directory
recursive	True if the search should be recursive

Returns

Enumeration of all directories in the given directory that match the specified extension

Implements BadScript2.IO.IFileSystem.

Definition at line 130 of file BadLayeredFileSystem.cs.

        {
            return m_Layers.SelectMany(x => 
                x.FileSystem.Exists(path) && 
                x.FileSystem.IsDirectory(path) ? 
                    x.FileSystem.GetDirectories(path, recursive) : 
                    Enumerable.Empty<string>()).Distinct();
        }

GetFiles()

IEnumerable< string > BadScript2.Container.BadLayeredFileSystem.GetFiles	(	string	path,
		string	extension,
		bool	recursive
	)

Returns all files in the given directory that match the specified extension.

Parameters

path	The path to the directory
extension	The extension to match
recursive	True if the search should be recursive

Returns

Enumeration of all files in the given directory that match the specified extension

Implements BadScript2.IO.IFileSystem.

Definition at line 121 of file BadLayeredFileSystem.cs.

        {
            return m_Layers.SelectMany(x => 
                x.FileSystem.Exists(path) && 
                x.FileSystem.IsDirectory(path) ? 
                    x.FileSystem.GetFiles(path, extension, recursive) : 
                    Enumerable.Empty<string>()).Distinct();
        }

GetFullPath()

string BadScript2.Container.BadLayeredFileSystem.GetFullPath

(

string

path

)

Returns the full path of the given path.

Parameters

path

Path

Returns

Full Path

Implements BadScript2.IO.IFileSystem.

Definition at line 156 of file BadLayeredFileSystem.cs.

        {
            return GetWritable().GetFullPath(path);
        }

GetInfo()

BadLayeredFileSystemStackInfo BadScript2.Container.BadLayeredFileSystem.GetInfo

(

)

Definition at line 16 of file BadLayeredFileSystem.cs.

        {
            List<BadLayeredFileSystemInfo> fileSystems = new List<BadLayeredFileSystemInfo>();
            Dictionary<string,BadLayeredFileSystemFileInfo> files = new Dictionary<string,BadLayeredFileSystemFileInfo>();
            foreach (var layer in m_Layers)
            {
                var fs = layer.FileSystem;
                fileSystems.Add(new BadLayeredFileSystemInfo() { Writable = fs == GetWritable(), Name = layer.Name, MetaData = layer.MetaData });
                foreach (var file in fs.GetFiles("/", "", true))
                {
                    if (!files.TryGetValue(file, out var info))
                    {
                        info = new BadLayeredFileSystemFileInfo()
                        {
                            Path = file,
                            PresentIn = new List<string>()
                        };
                        files[file] = info;
                    }
                    
                    info.PresentIn.Add(layer.Name);
                }
            }
            
            return new BadLayeredFileSystemStackInfo() { FileSystems = fileSystems.ToArray(), Files = files.Values.ToArray() };
        }

GetStartupDirectory()

string BadScript2.Container.BadLayeredFileSystem.GetStartupDirectory

(

)

The Startup Directory of the Application.

Returns

The Startup Directory of the Application

Implements BadScript2.IO.IFileSystem.

Definition at line 101 of file BadLayeredFileSystem.cs.

        {
            return GetWritable().GetStartupDirectory();
        }

GetWritable()

BadVirtualFileSystem BadScript2.Container.BadLayeredFileSystem.GetWritable

(

)

Definition at line 228 of file BadLayeredFileSystem.cs.

        {
            return m_Layers.Last().FileSystem;
        }

IsDirectory()

bool BadScript2.Container.BadLayeredFileSystem.IsDirectory

(

string

path

)

Returns true if the given path is a directory.

Parameters

path	The path to check

Returns

true if the given path is a directory

Implements BadScript2.IO.IFileSystem.

Definition at line 116 of file BadLayeredFileSystem.cs.

        {
            return m_Layers.Any(x => x.FileSystem.IsDirectory(path));
        }

IsFile()

bool BadScript2.Container.BadLayeredFileSystem.IsFile

(

string

path

)

Returns true if the given path is a file.

Parameters

path	The path to check

Returns

true if the given path is a file

Implements BadScript2.IO.IFileSystem.

Definition at line 111 of file BadLayeredFileSystem.cs.

        {
            return m_Layers.Any(x => x.FileSystem.IsFile(path));
        }

IsSubfolderOf()

bool BadScript2.Container.BadLayeredFileSystem.IsSubfolderOf ( string  root, string  sub  )

private

Definition at line 233 of file BadLayeredFileSystem.cs.

        {
            return GetFullPath(sub).StartsWith(GetFullPath(root));
        }

Move()

void BadScript2.Container.BadLayeredFileSystem.Move	(	string	src,
		string	dst,
		bool	overwrite = true
	)

Moves a file or directory to a new location.

Parameters

src	Source path
dst	Destination path
overwrite	Should file entries be overwritten?

Implements BadScript2.IO.IFileSystem.

Definition at line 218 of file BadLayeredFileSystem.cs.

        {
            Copy(src, dst, overwrite);
 
            if (IsDirectory(src))
                DeleteDirectory(src, true);
            else
                DeleteFile(src);
        }

OpenRead()

Stream BadScript2.Container.BadLayeredFileSystem.OpenRead

(

string

path

)

Opens a file for reading.

Parameters

path	The path to the file

Returns

File Stream

Implements BadScript2.IO.IFileSystem.

Definition at line 161 of file BadLayeredFileSystem.cs.

        {
            var fs = m_Layers.Last(x => x.FileSystem.IsFile(path))?.FileSystem ?? GetWritable();
            return fs.OpenRead(path);
        }

OpenWrite()

Stream BadScript2.Container.BadLayeredFileSystem.OpenWrite	(	string	path,
		BadWriteMode	mode
	)

Opens a file for writing.

Parameters

path	The path to the file
mode	The Write Mode

Returns

File Stream

Implements BadScript2.IO.IFileSystem.

Definition at line 167 of file BadLayeredFileSystem.cs.

        {
            var writable = GetWritable();
            var dir = Path.GetDirectoryName(path);
            if (dir != null && IsDirectory(dir) && !writable.IsDirectory(dir))
            {
                //Create the directory if it does not exist(it exists in some other layer, we need to create it in the writable layer)
                writable.CreateDirectory(dir, true);
            }
            //In order to properly work with Append mode, we need to copy the file to the writable file system if it does not exist
            if (mode == BadWriteMode.Append && !writable.IsFile(path))
            {
                using var src = OpenRead(path);
                using var dst = writable.OpenWrite(path, BadWriteMode.CreateNew);
                src.CopyTo(dst);
            }
            return writable.OpenWrite(path, mode);
        }

Optimize()

void BadScript2.Container.BadLayeredFileSystem.Optimize

(

)

Definition at line 59 of file BadLayeredFileSystem.cs.

        {
            //Ensure that the writable layer does not have a file that already exists in a read-only layer and has the same content
            var writable = GetWritable();
            foreach (var file in writable.GetFiles("/", "", true).ToArray())
            {
                foreach (var layer in m_Layers.SkipLast(1))
                {
                    if (layer.FileSystem.Exists(file) && layer.FileSystem.IsFile(file))
                    {
                        bool equals;
                        using (var wStream = writable.OpenRead(file))
                        {
                            using var rStream = layer.FileSystem.OpenRead(file);
                            equals = ContentEquals(wStream, rStream);
                        }
                        if (equals)
                        {
                            writable.DeleteFile(file);
                            break;
                        }
                    }
                }
            }
        }

Restore()

bool BadScript2.Container.BadLayeredFileSystem.Restore

(

string

path

)

Definition at line 84 of file BadLayeredFileSystem.cs.

        {
            var writable = GetWritable();
            if (writable.Exists(path))
            {
                if (writable.IsFile(path))
                {
                    writable.DeleteFile(path);
                }
                else
                {
                    writable.DeleteDirectory(path, true);
                }
                return true;
            }
            return false;
        }

SetCurrentDirectory()

void BadScript2.Container.BadLayeredFileSystem.SetCurrentDirectory

(

string

path

)

Sets the current Directory.

Parameters

path	the new current directory

Implements BadScript2.IO.IFileSystem.

Definition at line 191 of file BadLayeredFileSystem.cs.

        {
            foreach (var fs in m_Layers) fs.FileSystem.SetCurrentDirectory(path);
        }

Member Data Documentation

m_Layers

readonly BadLayeredFileSystemLayer [] BadScript2.Container.BadLayeredFileSystem.m_Layers

private

Definition at line 14 of file BadLayeredFileSystem.cs.

---

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

• src/BadScript2.Container/BadLayeredFileSystem.cs