brl.mod/filesystem.mod/filesystem.bmx

SuperStrict

Rem
bbdoc: System/File system
End Rem
Module BRL.FileSystem

ModuleInfo "Version: 1.13"
ModuleInfo "Author: Mark Sibly"
ModuleInfo "License: zlib/libpng"
ModuleInfo "Copyright: Blitz Research Ltd"
ModuleInfo "Modserver: BRL"

ModuleInfo "History: 1.13"
ModuleInfo "History: Added SetFileTime"
ModuleInfo "History: Added MaxIO file tree walking"
ModuleInfo "History: 1.12"
ModuleInfo "History: Added file tree walker"
ModuleInfo "History: 1.11"
ModuleInfo "History: Added optional parameter timetype to FileTime"
ModuleInfo "History: 1.10"
ModuleInfo "History: Module is now SuperStrict"
ModuleInfo "History: 1.09 Release"
ModuleInfo "History: Fixed RealPath breaking win32 //server paths"
ModuleInfo "History: 1.08 Release"
ModuleInfo "History: Rebuild for StdC chmod_ linkage"
ModuleInfo "History: 1.07 Release"
ModuleInfo "History: Fixed RealPath failing with 'hidden' dirs"
ModuleInfo "History: 1.06 Release"
ModuleInfo "History: 1.05 Release"
ModuleInfo "History: Fixed Win32 CreateDir"
ModuleInfo "History: 1.04 Release"
ModuleInfo "History: Cleaned up FixPath and RealPath"
ModuleInfo "History: Added optional resurse parameter to CreateDir"

Import Pub.StdC
Import BRL.BankStream

Import "glue.c"

Const FILETYPE_NONE:Int=0,FILETYPE_FILE:Int=1,FILETYPE_DIR:Int=2,FILETYPE_SYM:Int=3
Const FILETIME_MODIFIED:Int=0,FILETIME_CREATED:Int=1,FILETIME_ACCESSED:Int=2

Private

Function _RootPath:String( path:String )
	If MaxIO.ioInitialized Then
		Return "/"
	End If
?Win32
	If path.StartsWith( "//" )
		Return path[ ..path.Find( "/",2 )+1 ]
	EndIf
	Local i:Int=path.Find( ":" )
	If i<>-1 And path.Find( "/" )=i+1 Return path[..i+2]
?
	If path.StartsWith( "/" ) Return "/"
End Function

Function _IsRootPath:Int( path:String )
	Return path And _RootPath( path )=path
End Function

Function _IsRealPath:Int( path:String )
	Return _RootPath( path )<>""
End Function

?Win32
Function _CurrentDrive:String()
	Local cd:String=getcwd_()
	Local i:Int=cd.Find( ":" )
	If i<>-1 Return cd[..i]
End Function
?

Public

Function FixPath( path:String Var,dirPath:Int=False )
	path=path.Replace("\","/")
	If Not MaxIO.ioInitialized Then
?Win32
	If path.StartsWith( "//" )
		If path.Find( "/",2 )=-1 path:+"/"
	Else
		Local i:Int=path.Find( ":" )
		If i<>-1 And ( i=path.length-1 Or path[i+1]<>Asc(":") )
			Local i2:Int=path.Find( "/" )
			If i2=-1 Or i2>i+1 path=path[..i+1]+"/"+path[i+1..]
		EndIf
	EndIf
?
	End If
	If dirPath And path.EndsWith( "/" ) 
		If Not _IsRootPath( path ) path=path[..path.length-1]
	EndIf

End Function

Rem
bbdoc: Strips the directory from a file path
End Rem
Function StripDir:String( path:String )
	FixPath path
	Local i:Int=path.FindLast( "/" )
	If i<>-1 Return path[i+1..]
	Return path
End Function

Rem
bbdoc: Strips the extension from a file path
End Rem
Function StripExt:String( path:String )
	FixPath path
	Local i:Int=path.FindLast( "." )
	If i<>-1 And path.Find( "/",i+1 )=-1 Return path[..i]
	Return path
End Function

Rem
bbdoc: Strips the directory and extension from a file path
End Rem
Function StripAll:String( path:String )
	Return StripDir( StripExt( path ) )
End Function

Rem
bbdoc: Strips trailing slash from a file path
about:
#StripSlash will not remove the trailing slash from a 'root' path. For example, "/"
or (on Win32 only) "C:/".
End Rem
Function StripSlash:String( path:String )
	FixPath path
	If path.EndsWith( "/" ) And Not _IsRootPath( path ) path=path[..path.length-1]
	Return path
End Function

Rem
bbdoc: Extracts the directory from a file path
End Rem
Function ExtractDir:String( path:String )
	FixPath path
	If path="." Or path=".." Or _IsRootPath( path ) Return path

	Local i:Int=path.FindLast( "/" )
	If i=-1 Return ""
	
	If _IsRootPath( path[..i+1] ) i:+1
	Return path[..i]
End Function

Rem
bbdoc: Extracts the extension from a file path
End Rem
Function ExtractExt:String( path:String )
	FixPath path
	Local i:Int=path.FindLast( "." )
	If i<>-1 And path.Find( "/",i+1 )=-1 Return path[i+1..]
End Function

Rem
bbdoc: Gets the Current Directory
returns: The current directory
End Rem
Function CurrentDir:String()
	If MaxIO.ioInitialized Then
		Return "/"
	End If
	Local path:String=getcwd_()
	FixPath path
	Return path
End Function

Rem
bbdoc: Gets the real, absolute path of a file path
End Rem
Function RealPath:String( path:String )
?Win32
	If Not MaxIO.ioInitialized And path.StartsWith( "/" ) And Not path.StartsWith( "//" )
		path=_CurrentDrive()+":"+path
	EndIf
?
	FixPath path
	Local cd:String=_RootPath( path )

	If cd
		If Not MaxIO.ioInitialized Then
			path=path[cd.length..]
		End If
	Else
		cd=CurrentDir()
	EndIf
	
	path:+"/"
	While path
		Local i:Int=path.Find( "/" )
		Local t:String=path[..i]
		path=path[i+1..]
		Select t
		Case ""
		Case "."
		Case ".."
			If Not _IsRootPath( cd ) cd=cd[..cd.FindLast("/")]
		Default
			If Not cd.EndsWith( "/" ) cd:+"/"
			cd:+t
		End Select
	Wend
	
	Return cd
End Function

Rem
bbdoc: Gets the file type
returns: 0 if file at @path doesn't exist, FILETYPE_FILE (1) if the file is a plain file or FILETYPE_DIR (2) if the file is a directory
End Rem
Function FileType:Int( path:String )
	FixPath path
	If MaxIO.ioInitialized Then
		Local stat:SMaxIO_Stat
		If Not MaxIO.Stat(path, stat) Return 0
		Select stat._filetype
			Case EMaxIOFileType.REGULAR Return FILETYPE_FILE
			Case EMaxIOFileType.DIRECTORY Return FILETYPE_DIR
		End Select
	Else
		Local Mode:Int,size:Long,mtime:Int,ctime:Int,atime:Int
		If stat_( path,Mode,size,mtime,ctime,atime ) Return 0
		Select Mode & S_IFMT_
		Case S_IFREG_ Return FILETYPE_FILE
		Case S_IFDIR_ Return FILETYPE_DIR
		End Select
	End If
	Return FILETYPE_NONE
End Function

Rem
bbdoc: Checks if a file or directory exists
returns: #True if the file or directory at @path exists
about: Use #FileType to check if the file is a directory or a plain file.
End Rem
Function FileExists:Int( path:String )
	Return FileType( path ) <> FILETYPE_NONE
End Function

Rem
bbdoc: Gets file time
returns: The time the file at @path was last modified.
End Rem
Function FileTime:Long( path:String, timetype:Int=FILETIME_MODIFIED )
	FixPath path
	If MaxIO.ioInitialized Then
		Local stat:SMaxIO_Stat
		If Not MaxIO.Stat(path, stat) Return 0
		Select timetype
			Case FILETIME_CREATED
				Return stat._createtime
			Case FILETIME_MODIFIED
				Return stat._modtime
			Case FILETIME_ACCESSED
				Return stat._accesstime
		EndSelect
	Else
		Local Mode:Int,size:Long,mtime:Int,ctime:Int,atime:Int
		If stat_( path,Mode,size,mtime,ctime,atime ) Return 0
		Select timetype
			Case FILETIME_CREATED
				Return ctime
			Case FILETIME_MODIFIED
				Return mtime
			Case FILETIME_ACCESSED
				Return atime
		EndSelect
	End If
End Function

Rem
bbdoc: Sets the file modified or last accessed time.
about: @time should be number of seconds since epoch.
End Rem
Function SetFileTime( path:String, time:Long, timeType:Int=FILETIME_MODIFIED)
	FixPath path
	If MaxIO.ioInitialized Then
		' Not available
	Else
		Select timetype
			Case FILETIME_MODIFIED
				utime_(path, timeType, time)
			Case FILETIME_ACCESSED
				utime_(path, timeType, time)
		End Select
	End If
End Function

Rem
bbdoc: Sets the file modified or last accessed time.
about: @dateTime is the basic DateTime struct defined in pub.stdc .
End Rem
Function SetFileTime( path:String, dateTime:SDateTime, timeType:Int=FILETIME_MODIFIED)
	SetFileTime(path, dateTime.ToEpochSecs(), timeType) 
End Function

Rem
bbdoc: Gets file time
returns: The time the file at @path was last modified as SDatetime struct.
End Rem
Function FileDateTime:SDateTime( path:String, timetype:Int=FILETIME_MODIFIED )
	Return SDateTime.FromEpoch( FileTime(path, timetype) )
End Function

Rem
bbdoc: Sets the file modified or last accessed time.
about: @dateTime is the basic DateTime struct defined in pub.stdc .
End Rem
Function SetFileDateTime( path:String, dateTime:SDateTime, timeType:Int=FILETIME_MODIFIED)
	SetFileTime(path, dateTime.ToEpochSecs(), timeType) 
End Function

Rem
bbdoc: Gets the file size
returns: The size, in bytes, of the file at @path, or -1 if the file does not exist
End Rem
Function FileSize:Long( path:String )
	FixPath path
	If MaxIO.ioInitialized Then
		Local stat:SMaxIO_Stat
		If Not MaxIO.Stat(path, stat) Return -1
		Return stat._filesize
	Else
		Local Mode:Int,size:Long,mtime:Int,ctime:Int,atime:Int
		If stat_( path,Mode,size,mtime,ctime,atime ) Return -1
		Return size
	End If
End Function

Rem
bbdoc: Gets the file mode
returns: The file mode flags
End Rem
Function FileMode:Int( path:String )
	FixPath path
	If Not MaxIO.ioInitialized Then
		Local Mode:Int,size:Long,mtime:Int,ctime:Int,atime:Int
		If stat_( path,Mode,size,mtime,ctime,atime ) Return -1
		Return Mode & 511
	End If
End Function

Rem
bbdoc: Sets file mode
End Rem
Function SetFileMode( path:String,Mode:Int )
	FixPath path
	If Not MaxIO.ioInitialized Then
		chmod_ path,Mode
	End If
End Function

Rem
bbdoc: Creates a file
returns: #True if successful
End Rem
Function CreateFile:Int( path:String )
	FixPath path
	If MaxIO.ioInitialized Then
		MaxIO.DeletePath(path)
		Local t:Byte Ptr = MaxIO.OpenWrite(path)
		If t MaxIO.Close(t)
	Else
		remove_ path
		Local t:Byte Ptr=fopen_( path,"wb" )
		If t fclose_ t
	End If
	If FileType( path )=FILETYPE_FILE Return True
End Function

Rem
bbdoc: Creates a directory
returns: #True if successful
about:
If @recurse is #True, any required subdirectories are also created.
End Rem
Function CreateDir:Int( path:String,recurse:Int=False )
	FixPath path,True
	If MaxIO.ioInitialized Then
		Return MaxIO.MkDir(path)
	Else
		If Not recurse
			mkdir_ path,1023
			Return FileType(path)=FILETYPE_DIR
		EndIf
		Local t:String
		path=RealPath(path)+"/"
		While path
			Local i:Int=path.find("/")+1
			t:+path[..i]
			path=path[i..]
			Select FileType(t)
			Case FILETYPE_DIR
			Case FILETYPE_NONE
				Local s:String=StripSlash(t)
				mkdir_ StripSlash(s),1023
				If FileType(s)<>FILETYPE_DIR Return False
			Default
				Return False
			End Select
		Wend
		Return True
	End If
End Function

Rem
bbdoc: Deletes a file
returns: #True if successful
End Rem
Function DeleteFile:Int( path:String )
	FixPath path
	If MaxIO.ioInitialized Then
		MaxIO.DeletePath(path)
	Else
		remove_ path
	End If
	Return FileType(path)=FILETYPE_NONE
End Function

Rem
bbdoc: Renames a file
returns: #True if successful
End Rem
Function RenameFile:Int( oldpath:String,newpath:String )
	If MaxIO.ioInitialized Then
		Return False
	End If
	FixPath oldpath
	FixPath newpath
	Return rename_( oldpath,newpath)=0
End Function

Rem
bbdoc: Copies a file
returns: #True if successful
End Rem
Function CopyFile:Int( src:String,dst:String )
	Local in:TStream=ReadStream( src ),ok:Int
	If in
		Local out:TStream=WriteStream( dst )
		If out
			Try
				CopyStream in,out
				ok=True
			Catch ex:TStreamWriteException
			End Try
			out.Close
		EndIf
		in.Close
	EndIf
	Return ok
End Function

Rem
bbdoc: Copies a directory
returns: #True if successful
End Rem
Function CopyDir:Int( src:String,dst:String )

	Function CopyDir_:Int( src:String,dst:String )
		If FileType( dst )=FILETYPE_NONE CreateDir dst
		If FileType( dst )<>FILETYPE_DIR Return False
		For Local file:String=EachIn LoadDir( src )
			Select FileType( src+"/"+file )
			Case FILETYPE_DIR
				If Not CopyDir_( src+"/"+file,dst+"/"+file ) Return False
			Case FILETYPE_FILE
				If Not CopyFile( src+"/"+file,dst+"/"+file ) Return False
			End Select
		Next
		Return True
	End Function
	
	FixPath src
	If FileType( src )<>FILETYPE_DIR Return False

	FixPath dst
	
	Return CopyDir_( src,dst )

End Function

Rem
bbdoc: Deletes a directory
returns: #True if successful
about: Set @recurse to #True to delete all subdirectories and files recursively - 
but be careful!
End Rem
Function DeleteDir:Int( path:String,recurse:Int=False )
	FixPath path,True
	If recurse
		Local dir:Byte Ptr=ReadDir( path )
		If Not dir Return False
		Repeat
			Local t:String=NextFile( dir )
			If t="" Exit
			If t="." Or t=".." Continue
			Local f:String=path+"/"+t
			Select FileType( f )
				Case 1 DeleteFile f
				Case 2 DeleteDir f,True
			End Select
		Forever
		CloseDir dir
	EndIf
	rmdir_ path
	If FileType( path )=0 Return True
End Function

Rem
bbdoc: Changes the current directory
returns: True if successful
End Rem
Function ChangeDir:Int( path:String )
	If MaxIO.ioInitialized Then
		Return False
	Else
		FixPath path,True
		If chdir_( path )=0 Return True
	End If
End Function

Rem
bbdoc: Opens a directory
returns: A directory handle, or #Null if the directory does not exist
about: Use #NextFile to get the next file in the directory.
The directory must be closed with #CloseDir.
End Rem
Function ReadDir:Byte Ptr( path:String )
	FixPath path,True
	If MaxIO.ioInitialized Then
		Return bmx_blitzio_readdir(path)
	Else
		Return opendir_( path )
	End If
End Function

Rem
bbdoc: Returns the next file in a directory
returns: File name of next file in the directory opened using #ReadDir, or an empty #String if there are no more files to read.
End Rem
Function NextFile:String( dir:Byte Ptr )
	If MaxIO.ioInitialized Then
		Return bmx_blitzio_nextFile(dir)
	Else
		Return readdir_( dir )
	End If
End Function

Rem
bbdoc: Closes a directory.
about: Closes a directory opened with #ReadDir.
End Rem
Function CloseDir( dir:Byte Ptr )
	If MaxIO.ioInitialized Then
		bmx_blitzio_closeDir(dir)
	Else
		closedir_ dir
	End If
End Function

Rem
bbdoc: Loads a directory
returns: A string array containing contents of @dir
about: The @skip_dots parameter, if true, removes the '.' (current) and '..'
(parent) directories from the returned array.
End Rem
Function LoadDir:String[]( dir:String,skip_dots:Int=True )
	FixPath dir,True
	Local d:Byte Ptr=ReadDir( dir )
	If Not d Return Null
	Local i:String[100],n:Int
	Repeat
		Local f:String=NextFile( d )
		If Not f Exit
		If skip_dots And (f="." Or f="..") Continue
		If n=i.length i=i[..n+100]
		i[n]=f
		n=n+1
	Forever
	CloseDir d
	Return i[..n]
End Function

Rem
bbdoc: Opens a file for input and/or output.
about:
This command is similar to the #OpenStream command but will attempt
to cache the contents of the file to ensure serial streams such as 
http: based url's are seekable. Use the #CloseStream command when
finished reading and or writing to a Stream returned by #OpenFile.
End Rem
Function OpenFile:TStream( url:Object,readable:Int=True,writeable:Int=True )
	Local stream:TStream=OpenStream( url,readable,writeable )
	If Not stream Return Null
	If stream.Pos()=-1 Return TBankStream.Create( TBank.Load(stream) )
	Return stream
End Function

Rem
bbdoc: Opens a file For Input.
about:
This command is similar to the #ReadStream command but will attempt
to cache the contents of the file to ensure serial streams such as 
http: based url's are seekable. Use the #CloseStream command when
finished reading and or writing to a Stream returned by #OpenFile.
End Rem
Function ReadFile:TStream( url:Object )
	Return OpenFile( url,True,False )
End Function

Rem
bbdoc: Opens a file for output.
about:
This command is identical to the #WriteStream command.
End Rem
Function WriteFile:TStream( url:Object )
	Return OpenFile( url,False,True )
End Function

Rem
bbdoc: Closes a file stream.
about:
After performing file operations on an open file make sure to
close the file stream with either #CloseFile or the identical
#CloseStream command.
End Rem
Function CloseFile( stream:TStream )
	stream.Close
End Function

Rem
bbdoc: Walks a file tree.
End Rem
Function WalkFileTree:Int(path:String, fileWalker:IFileWalker, options:EFileWalkOption = EFileWalkOption.None, maxDepth:Int = 0)
	FixPath(path)
	If MaxIO.ioInitialized Then
		If FileType(path) = FILETYPE_DIR Then
			Return FSWalkFileTree(path, fileWalker, options, 0, maxDepth)
		End If
	Else
		Return bmx_filesystem_walkfiletree(path, _walkfile, fileWalker, options, maxDepth)
	End If
End Function

Rem
bbdoc: An interface for file tree traversal.
End rem
Interface IFileWalker
	Rem
	bbdoc: Called once for each file/folder traversed.
	about: Return EFileWalkResult.OK to continue the tree traversal, or EFileWalkResult.Terminate to exit early.

	The contents of @attributes is only valid for the duration of the call.
	End Rem
	Method WalkFile:EFileWalkResult(attributes:SFileAttributes Var)
End Interface

Rem
bbdoc: File attributes
End rem
Struct SFileAttributes
?win32
	Field StaticArray name:Short[8192]
?not win32
	Field StaticArray name:Byte[8192]
?
	Field fileType:Short
	Field depth:Short
	Rem
	bbdoc: The size, in bytes, of the file.
	End Rem
	Field size:ULong
	Field creationTime:Int
	Field modifiedTime:Int

	Rem
	bbdoc: Returns the name of the file/directory.
	End rem
	Method GetName:String()
?win32
		Return String.FromWString(name)
?not win32
		Return String.FromUTF8String(name)
?
	End Method

	Method IsRegularFile:Int()
		Return fileType = FILETYPE_FILE
	End Method

	Method IsDirectory:Int()
		Return fileType = FILETYPE_DIR
	End Method

	Method IsSymbolicLink:Int()
		Return fileType = FILETYPE_SYM
	End Method

End Struct

Rem
bbdoc: 
End rem
Enum EFileWalkOption
	None
	FollowLinks
End Enum

Rem
bbdoc: 
End rem
Enum EFileWalkResult
	OK
	Terminate
	SkipSubtree
	SkipSiblings
End Enum

Private
Function _walkFile:EFileWalkResult(fileWalker:IFileWalker, attributes:SFileAttributes Var) { nomangle }
	Return fileWalker.WalkFile(attributes)
End Function

Function FSWalkFileTree:Int(dir:string, fileWalker:IFileWalker, options:EFileWalkOption, depth:Int, maxDepth:Int)

	Local attributes:SFileAttributes
	ApplyAttributes(dir, depth, VarPtr attributes)

	Local res:EFileWalkResult = fileWalker.WalkFile(attributes)

	If res = EFileWalkResult.Terminate Then
		Return 1
	End If

	Local d:Byte Ptr = ReadDir(dir)

	If d Then
		Local f:String = NextFile(d)

		While f
			Local path:String = dir + "/" + f

			If ApplyAttributes(path, depth + 1, VarPtr attributes) Then
				If attributes.fileType = FILETYPE_DIR Then
					Local ret:Int = FSWalkFileTree(path, fileWalker, options, depth + 1, maxDepth)
					If ret Then
						CloseDir(d)
						Return ret
					End If
				Else
					res = fileWalker.WalkFile(attributes)

					If res = EFileWalkResult.Terminate Then
						CloseDir(d)
						Return 1
					End If
				End If
			End IF

			f = NextFile(d)
		Wend

		CloseDir(d)
	End If

End Function

Function ApplyAttributes:Int(path:String, depth:Int, attributes:SFileAttributes Ptr)
	Local stat:SMaxIO_Stat
	If Not MaxIO.Stat(path, stat) Then
		Return False
	End If

	Select stat._filetype
		Case EMaxIOFileType.REGULAR
			attributes.fileType = FILETYPE_FILE
		Case EMaxIOFileType.DIRECTORY
			attributes.fileType = FILETYPE_DIR
		Case EMaxIOFileType.SYMLINK
			attributes.fileType = FILETYPE_SYM
	End Select

	Local length:Size_T = 8192
?win32
	path.ToWStringBuffer(attributes.name, length)
?not win32
	path.ToUTF8StringBuffer(attributes.name, length)
?

	attributes.depth = depth
	attributes.size = stat._filesize
	attributes.creationTime = stat._createtime
	attributes.modifiedTime = stat._modtime

	Return True
End Function

Extern
	Function bmx_filesystem_walkfiletree:Int(path:String, callback:EFileWalkResult(fileWalker:IFileWalker, attributes:SFileAttributes Var), walker:IFileWalker, options:EFileWalkOption, maxDepth:Int)
End Extern