BinAffix

-=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- (c) WidthPadding Industries 1987 0\|715\|0 -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=-
SoCoder -> Snippet Home -> File Access

Teasy	Created : 21 August 2007 Edited : 21 August 2007 System : Windows Language : Blitz BinAffix Binary attacher, unloader and detacher
Note: Requires my String Library. ;------------------------------------------------------------------------------- ; * BinAffix ; Ver 2007 Jan 08 Rev 2 - (slightly) modified for C8 - Robotix ; Created by Teasy <TheChange@yahoo.com> ;------------------------------------------------------------------------------- ; Binary attacher, unloader and detacher ;------------------------------------------------------------------------------- ;------------------------------------------------------------------------------- ; Summary ;------------------------------------------------------------------------------- ; - Attach a single file or recursively attach directories to a single file ; (like an executable) to become one single package for easy distribution ; - The file(s)/folder(s) inside the attachment can be extracted (unloaded) ; from the package to any location of your desire during runtime ; - The attachment can also be removed (detached) from the original file ;------------------------------------------------------------------------------- ;------------------------------------------------------------------------------- ; Usage ;------------------------------------------------------------------------------- ; Available (public) functions: ; ; BinAffix_Attach( $ source file or folder , $ target file ) ; ; Attach a single file or entire directory structure ; to an existing (or new!) file ; ; BinAffix_Unload( $ source file , $ target folder ) ; ; Unload a single file or entire directory structure ; from an existing file (which holds the attachment) ; ; BinAffix_Detach( $ source file ) ; ; Remove an attachment from an existing file ;------------------------------------------------------------------------------- ; - All functions return False when failed and non-zero when successful ; When failed, BinAffix_Error contains the exact message ; ; - The following process related messages can be printed on screen ; during attaching or unloading: ; - Unable to open file: ; this file is skipped (and not attached) during attaching ; - Unable to create folder: ; this (empty) folder can't be created during unloading ; - File already exists: ; this file is skipped during unloading (files are never overwritten) ; These messages appear only if BinAffix_Feedback is True. ; Any other messages are considered fatal, and as such, ; will not be displayed. Instead, the error message will ; be passed onto BinAffix_Error, and the process will end. ; ; - When attaching, files/folders are appended to a file (if existent). ; When attaching another package, to a file that already contains ; an attachment, it is simply appended as well, and as such will be ; considered the top-most (and only) attachment when unloading. ; To access previously attached packages, attachments at the end ; have to be detached first. So it's probably best to attach ; a single package instead, depending on the circumstances.. ;------------------------------------------------------------------------------- ;------------------------------------------------------------------------------- ; Examples ;------------------------------------------------------------------------------- ; ; --- Attaching --- ; Print "Attaching media to executable.." ; Result = BinAffix_Attach( "Media" , "Game.EXE" ) ; If Result = False ; Print "Error: "+BinAffix_Error ; Else ; Print "Done ("+Result+" bytes)" ; EndIf ;------------------------------------------------------------------------------- ; ; --- Unloading --- ; If Not BinAffix_Unload( "Game.EXE" , "Temporary Folder" ) ; RuntimeError "Unable to unload media from executable" ; EndIf ;------------------------------------------------------------------------------- ; ; --- Detaching --- ; If BinAffix_Detach( "Game.EXE" ) ; Print "Media was stripped from executable" ; Else ; Print "Unable to strip media from executable" ; EndIf ;------------------------------------------------------------------------------- ;------------------------------------------------------------------------------- ; Limitations ;------------------------------------------------------------------------------- ; - File size (original file, single attachment or total combined) ; must not exceed 2,147,483,647 bytes. ;------------------------------------------------------------------------------- ;------------------------------------------------------------------------------- ; Format ;------------------------------------------------------------------------------- ; +--------------------------------------------------------------------------- ; \| Original binary ; +--------------------------------------------------------------------------- ; \| Attachment data ; \| +----------------------------------------------------------------------- ; \| \| File 1 ; \| \| +---------------+-------------------+------------------------------- ; \| \| \| 2 bytes \| Unsigned Int16 \| Size of file name (chars) ; \| \| \| * \| ASCII \| Relative path + file name ; \| \| \| 4 bytes \| Signed Int32 \| File size ; \| \| \| * \| Binary \| File contents ; \| +---+---------------+-------------------+------------------------------- ; \| \| File 2 ; \| \| +------------------------------------------------------------------- ; \| \| \| .. ; +---+---+------------------------------------------------------------------- ; \| Attachment information ; \| +---------------+-------------------+----------------------------------- ; \| \| 4 bytes \| Signed Int32 \| Size of attachment ; \| \| 4 bytes \| Signed Int32 \| Starting location of attachment ; \| \| * \| Binary \| Unique identification code ; +---+---------------+-------------------+----------------------------------- ;------------------------------------------------------------------------------- ; - Record fields (from left to right): Size, data type, description ; - Records containing byte count fields marked * ; contain the number of bytes defined by the value of the previous record ; - File name includes full (relative) path ; - If directory is empty, file name ends in "\NUL", file size is zero ; and there is no file contents ; - If a file is empty, file size is zero and there is no file contents ;------------------------------------------------------------------------------- ;\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\| ;------------------------------------------------------------------------------- Include "\Dev\Blitz\Lib\String.Lib.BB" Const BinAffix_Identification$ = "ºÚU¬ÎUÀÞ" Const BinAffix_FileCopy_BufferSize = 65536 Const BinAffix_Feedback = True Global BinAffix_FileCopy_Buffer Global BinAffix_Error$ ; Attach file/folder (attachfrom) to file (attachto) ;------------------------------------------------------------------------------- Function BinAffix_Attach ( attachfrom$ , attachto$ ) ;------------------------------------------------------------------------------- ; - attachto: file to append attachments to ; if it doesn't exist, it will be created ; - attachfrom: file or folder to attach ; a folder's entire contents will be added ;------------------------------------------------------------------------------- Local abs_source$,abs_target$ Local filehandle Local start,size Local OldDir$ ; validate source and target name abs_source = FullPath( attachfrom ) abs_target = FullPath( attachto ) If ValidateFoldername( abs_source ) = False Or ValidateFoldername( abs_target ) = False BinAffix_Error = "Invalid folder and/or file names" Return False EndIf ; source and target may not be the same If Upper( abs_source ) = Upper( abs_target ) BinAffix_Error = "Source and destination are identical" Return False EndIf ; check if target exists Select FileType( attachto ) Case 2 ; folder?! BinAffix_Error = "Unable to attach data to folder" Return False Case 1 ; file ; open for read/write filehandle = OpenFile( attachto ) If Not filehandle BinAffix_Error = "Unable to open file: "+attachto Return False EndIf ; append at end SeekFile filehandle , FileSize( attachto ) Case 0 ; doesn't exist ; create new file filehandle = WriteFile( attachto ) If Not filehandle BinAffix_Error = "Unable to create file: "+attachto Return False EndIf End Select ; remember starting position of attachment start = FilePos( filehandle ) ; * attachment data ; check what source to append (file or folder) Select FileType( attachfrom ) Case 2 ; folder BinAffix_FileCopy_Buffer = CreateBank( BinAffix_FileCopy_BufferSize ) ; enter folder first, ; so that the parent path is excluded from the entry names ; also remember the current dir, to go back to when done OldDir = CurrentDir() ChangeDir String_TrailingBackslash( attachfrom ) ; iterate recursively (current directory) size = BinAffix_AttachPath( "" , filehandle ) Case 1 ; file BinAffix_FileCopy_Buffer = CreateBank( BinAffix_FileCopy_BufferSize ) ; go into source folder first, ; so that the path is excluded from the entry name OldDir = CurrentDir() ChangeDir String_TrailingBackslash( String_GetPathname( attachfrom ) ) ; attach single file size = BinAffix_AttachFile( String_GetFilename( attachfrom ) , filehandle ) Case 0 ; doesn't exist!? CloseFile filehandle BinAffix_Error = "Attachment does not exist" Return False End Select ; * attachment info ; write trailing header ; but only if entire process was successful If size > 0 ; size of attachment WriteInt filehandle , size ; starting location of attachment WriteInt filehandle , start ; unique identification code (UIC) ; to recognize the attachment WriteText filehandle , BinAffix_Identification EndIf ; close file CloseFile filehandle FreeBank BinAffix_FileCopy_Buffer ; return to previous location ChangeDir OldDir ; passed! ; return size of total attachment (including trailer) Return size + 4+4+Len( BinAffix_Identification ) ;------------------------------------------------------------------------------- End Function ;------------------------------------------------------------------------------- ; Iterate through folders/path (source) to add files/folders to file (target) Function BinAffix_AttachPath( source$ , target ) ; target = filehandle Local dir,file$ Local result,size ; scan through folder looking for files (to add) and folder (to enter) If source = "" ; blitz doesn't use the current directory (but the root instead) ; when not specifying a location! oO dir = ReadDir( ".\" ) Else dir = ReadDir( source ) EndIf If Not dir BinAffix_Error = "Unable to open directory: "+source Return -1 EndIf ; keep going until no more entries in this folder file = NextFile( dir ) While file <> "" ; not a special directory entry (current, previous) If file <> "." And file <> ".." ; file or folder Select FileType( source+file ) Case 0 ; doesn't exist?! ; skip, in case you're lucky :) Case 1 ; file ; attach right away result = BinAffix_AttachFile( source+file , target ) ; if the file (including header) is zero ; means: can't read from file If result = 0 ; couldn't open the file If BinAffix_Feedback Print "Unable to open file: "+source+file EndIf ; if something bad happened (like unable to write to target) ElseIf result < 0 ; abort (pass on message, with recursion level) BinAffix_Error = "Unable to write to file: "+target Return -1 ; file size positive Else ; keep track of size of thingy added (includes header) size = size + result EndIf Case 2 ; folder ; look there -> iterate result = BinAffix_AttachPath( String_TrailingBackslash( source+file ) , target ) ; if something went wrong If result < 0 ; pass on the message (and add recursion level) Return result-1 ; empty folder ElseIf result = 0 ; add empty folder as entry NUL size = size + BinAffix_AttachFile( source+file+"\NUL" , target ) ; all okay Else ; update size size = size + result EndIf End Select EndIf file = NextFile( dir ) Wend Return size End Function ; Copy source (file) to target (file) with header and return copied size Function BinAffix_AttachFile( source$ , target ) ; target = filehandle Local namesize Local headersize Local FileSize Local totalsize ; header + data Local bytesread,byteswritten Local totalbytesread ; number of bytes read in total (all blocks together) ; if can't open file, skip it (don't have to abort, but feedback somehow) filehandle = ReadFile( source ) If Not filehandle ; "0" means: skip file Return 0 EndIf ; add file name size (2 bytes) and file name (ASCII) namesize = Len( source ) WriteShort target , namesize WriteText target , source ; add file data size (4 bytes) FileSize = FileSize( source ) WriteInt target , FileSize ; header: filenamesize, filename, filesize headersize = 2 + namesize + 4 totalbytesread = 0 ; progress feedback If BinAffix_Feedback Print source+" ("+FileSize+")" EndIf ; add file data (only transfer if anything to copy) If FileSize > 0 ; stream-copy Repeat ; read block from source into buffer bytesread = ReadBytes( BinAffix_FileCopy_Buffer,filehandle , 0,BinAffix_FileCopy_BufferSize ) ; if anything copied If bytesread > 0 ; write it from target to target byteswritten = WriteBytes( BinAffix_FileCopy_Buffer,target , 0,bytesread ) ; verify successful write If byteswritten < bytesread ; did not write all to target -> abort prematurely CloseFile source ; "-1" means: abort all Return -1 EndIf ; update total totalbytesread = totalbytesread + bytesread EndIf ; keep going until bytes read is below full buffer size ; or reaching end of file (file size MOD buffer size = 0) Until bytesread < BinAffix_FileCopy_BufferSize Or Eof( filehandle ) EndIf ; close source CloseFile filehandle ; compare file size (from file system) with actual bytes read If FileSize <> totalbytesread ; use the number of bytes read (and written) instead totalsize = headersize + totalbytesread ; if identical Else ; use file size straight-up totalsize = headersize + FileSize EndIf ; passed! ; resulting in actual number of bytes written; header + data Return totalsize End Function ; Extract (unpack) attachment from file (extractfrom) to folder (extractto) ;------------------------------------------------------------------------------- Function BinAffix_Unload ( unloadfrom$ , unloadto$ ) ;------------------------------------------------------------------------------- ; - attachfrom: file to unload attachments from ; - attachto: target folder to place attachments in ; if extracting to folders that do not exist, they will be created ; if extracting to files that already exist, they will be skipped ;------------------------------------------------------------------------------- Local abs_source$,abs_target$ Local FileSize,minimumfilesize Local identsize,ident$ Local filehandle,target ; source and target file handles Local start,size Local entrynamesize,entryname$,entrypath$ ; "path" is without filename, "name" is path+filename Local entrystart,entrysize Local bytesread,byteswritten,bytestocopy Local transfer,offset Local OldDir$ ; validate source and target name abs_source = FullPath( unloadfrom ) abs_target = FullPath( unloadto ) If ValidateFoldername( abs_source ) = False Or ValidateFoldername( abs_target ) = False BinAffix_Error = "Invalid folder and/or file names" Return False EndIf ; source and target may not be the same If Upper( abs_source ) = Upper( abs_target ) BinAffix_Error = "Source and destination are identical" Return False EndIf ; verify existence If FileType( unloadfrom ) <> 1 BinAffix_Error = "File not found: "+unloadfrom Return False EndIf ; verify size ; - must be at least: single attachment header + attachment info size = 23 bytes ; file name size (2 bytes) + file name (1 byte) + file size (4 bytes) + file data (0 bytes) = 7 bytes ; attachment size (4 bytes) + start location (4 bytes) + identification (8 bytes) = 16 bytes FileSize = FileSize( unloadfrom ) identsize = Len( BinAffix_Identification ) minimumfilesize = 2+1+4+0 + 4+4+identsize If FileSize < minimumfilesize BinAffix_Error = "File too small to contain attachments" Return False EndIf ; try open source filehandle = ReadFile( unloadfrom ) If Not filehandle BinAffix_Error = "Unable to open file: "+unloadfrom Return False EndIf ; identify source (validate ID, start, size) ; - identification (8 bytes) SeekFile filehandle , FileSize - identsize ident = ReadText( filehandle , identsize ) ; validate identification code If ident <> BinAffix_Identification CloseFile filehandle BinAffix_Error = "Invalid attachment: Identification ("+ident+")" Return False EndIf ; - start of attachment (4 bytes) SeekFile filehandle , FileSize - identsize - 4 start = ReadInt( filehandle ) ; start must not exceed either: ; - filesize (minus minimum attachment) ; - or be under 0 If start < 0 Or start > FileSize - minimumfilesize CloseFile filehandle BinAffix_Error = "Invalid attachment: Start of attachment ("+start+")" Return False EndIf ; - size of attachment (4 bytes) SeekFile filehandle , FileSize - identsize - 4 - 4 size = ReadInt( filehandle ) ; size must not exceed either: ; - filesize ; - or be under 0 If size < 0 Or size > FileSize CloseFile filehandle BinAffix_Error = "Invalid attachment: Size of attachment ("+size+")" Return False EndIf ; check if target folder exists Select FileType( unloadto ) Case 2 ; folder ; ready for extraction in existing folder (see below) Case 1 ; file CloseFile filehandle BinAffix_Error = "Unable to unload data to file" Return False Case 0 ; folder doesn't exist ; create new folder(s) ConstructFolder unloadto End Select ; make the destination the current folder ; but remember the current location, to return to when done OldDir = CurrentDir() ChangeDir String_TrailingBackslash( unloadto ) ; start reading entries from source BinAffix_FileCopy_Buffer = CreateBank( BinAffix_FileCopy_BufferSize ) SeekFile filehandle , start Repeat ; read size of entry name entrynamesize = ReadShort( filehandle ) ; - sanity check (keep name length limit rediculously high) If entrynamesize <= 0 Or entrynamesize > 65536 FreeBank BinAffix_FileCopy_Buffer CloseFile filehandle ChangeDir OldDir BinAffix_Error = "Invalid attachment: Entry name size ("+entrynamesize+")" Return False EndIf ; read entry name entryname = ReadText( filehandle , entrynamesize ) ; - validate folder/file name(s) If Not ValidateFoldername( entryname ) FreeBank BinAffix_FileCopy_Buffer CloseFile filehandle ChangeDir OldDir BinAffix_Error = "Invalid attachment: Entry name ("+entryname+")" Return False EndIf ; read entry size entrysize = ReadInt( filehandle ) ; - sanity check (empty entries are allowed) If entrysize < 0 Or entrysize > 2147483647 FreeBank BinAffix_FileCopy_Buffer CloseFile filehandle ChangeDir OldDir BinAffix_Error = "Invalid attachment: Entry size ("+entrysize+")" Return False EndIf ; verify entry to create ; - entry is an empty directory If Upper( Right( entryname , 3 ) ) = "NUL" ; cut filename (not used) entryname = Left( entryname , entrynamesize-3 ) ; check existence Select FileType( entryname ) ; doesn't exist at all Case 0 ; just create the folder(s) ConstructFolder entryname ; this is actually a file! Case 1 ; since folder would be empty, ; no harm done if just skipping this folder If BinAffix_Feedback Print "Unable to create folder: "+entryname EndIf ; the folder already exists Case 2 ; no need to create or change anything End Select ; - entry is not an empty folder Else ; - check existence of folder entrypath = String_GetPathname( entryname ) Select FileType( entrypath ) Case 0 ; folder does not exist at all ; just create the folder(s) ConstructFolder entrypath ; this is actually a file! Case 1 ; multiple files could be jeopardized ; so probably safer to abort here FreeBank BinAffix_FileCopy_Buffer CloseFile filehandle ChangeDir OldDir BinAffix_Error = "Unable to access or create folder: "+entrypath Return False ; the folder already exists Case 2 ; no need to create or change anything ; file can be placed inside it straight away End Select ; - check if file already exists Select FileType( entryname ) Case 0 ; file does not exist, yet ; create it! target = WriteFile( entryname ) If Not target ; unable to create file at destination ; maybe drive full or disconnected.. ; so abort just to be safe FreeBank BinAffix_FileCopy_Buffer CloseFile filehandle ChangeDir OldDir BinAffix_Error = "Unable to create file: "+entryname Return False EndIf transfer = True ; file already exists! ; or file is actually a folder?! Case 1,2 ; skip file cursor to next file (jump over file data) SeekFile filehandle , FilePos( filehandle ) + entrysize ; then continue with next file (start over) transfer = False If BinAffix_Feedback Print "File already exists: "+entryname EndIf End Select ; - transfer file (if possible, and if any data available to copy) If transfer = True And entrysize > 0 ; separate file to copy in blocks that fit in the buffer For offset = 0 To entrysize-1 Step BinAffix_FileCopy_BufferSize ; if would be exceeding size to copy If offset + BinAffix_FileCopy_BufferSize >= entrysize ; cut it where the end is bytestocopy = entrysize - offset ; not exceeding size (yet) Else ; use entire buffer size bytestocopy = BinAffix_FileCopy_BufferSize EndIf ; attempt to read entry data into buffer bytesread = ReadBytes( BinAffix_FileCopy_Buffer,filehandle , 0,bytestocopy ) If bytesread <> bytestocopy ; didn't read everything (or too much), ; maybe source went away or crazy ; so abort just to be sure CloseFile target FreeBank BinAffix_FileCopy_Buffer CloseFile filehandle ChangeDir OldDir BinAffix_Error = "Unable to read from file: "+unloadfrom Return False EndIf ; write to target byteswritten = WriteBytes( BinAffix_FileCopy_Buffer,target , 0,bytestocopy ) If byteswritten <> bytestocopy ; something went wrong in writing ; (too much or not enough) ; so abort just to be sure, ; in case target drive went crazy or something CloseFile target FreeBank BinAffix_FileCopy_Buffer CloseFile filehandle ChangeDir OldDir BinAffix_Error = "Unable to read from file: "+unloadfrom Return False EndIf ; all done when source file position ; is at start of next attachment Next ; wrap up copying CloseFile target EndIf EndIf ; entry = empty folder ; stop if current position exceeds attachment data ; (start of attachment + size of attachment) Until FilePos( filehandle ) >= start+size ; done copying FreeBank BinAffix_FileCopy_Buffer CloseFile filehandle ; restore previous location (as if nothing happened) ChangeDir OldDir ; passed! Return True ;------------------------------------------------------------------------------- End Function ;------------------------------------------------------------------------------- ; Detach (remove) attachment from file (detachfrom) ;------------------------------------------------------------------------------- Function BinAffix_Detach ( detachfrom$ ) ;------------------------------------------------------------------------------- ; 1) Copies the original file without the attachment to a new file ; 2) Removes the original ; 3) Renames the copy to the original ;------------------------------------------------------------------------------- Local filehandle Local identsize,ident$ Local minimumfilesize Local FileSize Local start,size Local targetfile$,target Local bytesread,byteswritten Local pos,bytestowrite Local result$ ; verify existence If FileType( detachfrom ) <> 1 BinAffix_Error = "File not found: "+detachfrom Return False EndIf ; verify size ; - must be at least: single attachment header + attachment info size = 23 bytes ; file name size (2 bytes) + file name (1 byte) + file size (4 bytes) + file data (0 bytes) = 7 bytes ; attachment size (4 bytes) + start location (4 bytes) + identification (8 bytes) = 16 bytes FileSize = FileSize( detachfrom ) identsize = Len( BinAffix_Identification ) minimumfilesize = 2+1+4+0 + 4+4+identsize If FileSize < minimumfilesize BinAffix_Error = "File too small to contain attachments" Return False EndIf ; try open source filehandle = ReadFile( detachfrom ) If Not filehandle BinAffix_Error = "Unable to open file: "+detachfrom Return False EndIf ; identify source (validate ID, start, size) ; - identification (8 bytes) SeekFile filehandle , FileSize - identsize ident = ReadText( filehandle , identsize ) ; validate identification code If ident <> BinAffix_Identification CloseFile filehandle BinAffix_Error = "Invalid attachment: Identification ("+ident+")" Return False EndIf ; - start of attachment (4 bytes) SeekFile filehandle , FileSize - identsize - 4 start = ReadInt( filehandle ) ; start must not exceed either: ; - filesize (minus minimum attachment) ; - or be under 0 If start < 0 Or start > FileSize - minimumfilesize CloseFile filehandle BinAffix_Error = "Invalid attachment: Start of attachment ("+start+")" Return False EndIf ; - size of attachment (4 bytes) SeekFile filehandle , FileSize - identsize - 4 - 4 size = ReadInt( filehandle ) ; size must not exceed either: ; - filesize ; - or be under 0 If size < 0 Or size > FileSize CloseFile filehandle BinAffix_Error = "Invalid attachment: Size of attachment ("+size+")" Return False EndIf ; if attachment size matches filesize ; e.g. file consists only of attachment ; excluding attachment info (trailer) If size = FileSize - identsize - 4 - 4 ; just delete the file (keeping a 0 byte file seems odd) CloseFile filehandle DeleteFile detachfrom ; all done! Return True EndIf ; create temporary file (to write portion to keep to) targetfile = detachfrom+".BinAffix_Copy" target = WriteFile( targetfile ) If Not target CloseFile filehandle BinAffix_Error = "Unable to create file: "+targetfile Return False EndIf ; stream-copy: source (0,start) -> target BinAffix_FileCopy_Buffer = CreateBank( BinAffix_FileCopy_BufferSize ) SeekFile filehandle , 0 Repeat ; read block from source into buffer bytesread = ReadBytes( BinAffix_FileCopy_Buffer,filehandle , 0,BinAffix_FileCopy_BufferSize ) ; check if current file position exceeds destination (start-1) pos = FilePos( filehandle ) If pos > start ; write the last (or only) bit to temp file (x..start-1) bytestowrite = start - ( pos - bytesread ) ; not yet at destination Else ; if copied something less than the full buffer size If bytesread < BinAffix_FileCopy_BufferSize FreeBank BinAffix_FileCopy_Buffer CloseFile target CloseFile filehandle BinAffix_Error = "Unable to read file: "+detachfrom Return False EndIf ; write the entire buffer to temp file bytestowrite = BinAffix_FileCopy_BufferSize EndIf ; copy to temp file byteswritten = WriteBytes( BinAffix_FileCopy_Buffer,target , 0,bytestowrite ) ; verify successful write If byteswritten < bytestowrite ; did not write everything FreeBank BinAffix_FileCopy_Buffer CloseFile target CloseFile filehandle BinAffix_Error = "Unable to write file: "+targetfile Return False EndIf ; keep going until bytes to write is below full buffer size Until bytestowrite < BinAffix_FileCopy_BufferSize ; done copying FreeBank BinAffix_FileCopy_Buffer CloseFile target CloseFile filehandle ; delete original DeleteFile detachfrom ; rename temp file to original result$ = MoveFile( targetfile , detachfrom ) ; everything okay? If Int result <> True ; if not, show what went wrong (in detail) BinAffix_Error = "Unable to rename file: "+targetfile+" ("+Right( result , Len( result ) - 5 )+")" Return False EndIf ; passed! Return True ;------------------------------------------------------------------------------- End Function ;------------------------------------------------------------------------------- ;------------------------------------------------------------------------------- ;\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\|\| ;------------------------------------------------------------------------------- ; BinAffix helper functions (generic file functions) ;------------------------------------------------------------------------------- ; FullPath$ ( path$ ) Convert relative to absolute path ; ValidateFilename ( Filename$ ) Make sure just file name is valid ; ValidateFoldername ( Foldername$ ) Make sure entire path name is valid ; ConstructFolder ( Foldername$ ) Create cascaded directory chain ; WriteText( FileHandle , Message$ ) Write ASCII text to open file ; ReadText$( FileHandle , Length ) Read ASCII text from open file ; MoveFile$( Source$ , Target$ ) Rename or move a file or folder ;------------------------------------------------------------------------------- ; Return full (absolute) path from a relative path Function FullPath$ ( path$ ) Local Current$ Local FirstChar$ Local Result$ ; check if path already absolute (contains drive) If Instr( path , ":" ) Result = path ; without drive Else ; remember current drive and path Current = CurrentDir() ; check if path is a root location (absolute without drive) FirstChar = Left( path , 1 ) If FirstChar = "\" Or FirstChar = "/" ; current drive + root location Result = Left( Current , 2 ) + path ; not a root location (relative) Else ; current drive, folder + relative path Result = String_TrailingBackslash( Current ) + path EndIf EndIf ; use a trailing backslash if resulting (absolute) path is a folder If FileType( Result ) = 2 Result = String_TrailingBackslash( Result ) EndIf Return Result End Function ; Fierce file name validation Function ValidateFilename ( Filename$ ) Local Charnum Local Length Local Char$ Local InvCharnum ; no be leading or trailing spaces (uses custom Trim to support extended chars) Filename = String_Trim( Filename ) ; hunt for invalid chars: "/:<>?\\|" and control characters (0..31) Length = Len( Filename ) For Charnum = 1 To Length Char = Mid( Filename , Charnum,1 ) ; control character If Asc( Char ) < 32 ; abort instantly Return False ; normal or extended character Else ; invalid (Windows) filename characters If Char="" Or Char="/" Or Char=":" Or Char="<" Or Char=">" Or Char="?" Or Char="\" Or Char="\|" Return False EndIf EndIf Next ; passed! Return True End Function ; Fierce folder name validation Function ValidateFoldername ( Foldername$ ) Local Letter Local Segment,Segments Local Check$ ; replace slashes with backslashes Foldername = Replace( Foldername , "/" , "\" ) ; * validate drive (if present) ; optional leading drive name format: "x:\" Select String_CountChars( Foldername , ":" ) Case 1 ; if only 1 colon, it must be on position 2 If Not Mid( Foldername , 2,1 ) = ":" Return False EndIf ; and drive letter must be valid on position 1 Letter = Asc( Upper( Left( Foldername , 1 ) ) ) If Letter < 65 Or Letter > 90 ; below A or above Z Return False EndIf ; clip drive (no longer required for validation) Foldername = Right( Foldername , Len( Foldername ) - 2 ) Case 2 ; multiple colons?! Return False End Select ; * now iterate through backslashes ; and run each name through the validate filename routine ; check number of sub-folders included Segments = String_ParameterCount( Foldername , "\" ) For Segment = 1 To Segments ; next backslash separated portion Check = String_Parameter( Foldername , Segment , "\" ) ; validate it If Not ValidateFilename( Check ) ; invalid Return False EndIf Next ; passed! Return True End Function ; Constructs a single chain of nested folders, e.g. "a\b\c" Function ConstructFolder ( Foldername$ ) Local Segment,Segments Local Separator Local FileType Local Construct$ ; using only backslashes for easy parameter tracking Foldername = Replace( Foldername , "/" , "\" ) ; number of sub-folders included Segments = String_ParameterCount( Foldername , "\" ) ; clip drive (if present) If Instr( Foldername , ":" ) Foldername = Right( Foldername , Len( Foldername ) - 2 ) EndIf ; start iterating at 1st character (1st backslash will be skipped) Separator = 1 For Segment = 1 To Segments ; find next backslash Separator = Instr( Foldername , "\" , Separator+1 ) ; in case this was the last (or none at all) If Separator <= 0 ; take full (relative) path as construction path Construct = Foldername ; not yet the last backslash Else ; select all of (relative) path up to next backslash Construct = Left( Foldername , Separator-1 ) EndIf ; make sure the segment to construct isn't a file FileType = FileType( Construct ) If FileType = 1 ; there's nothing construct from this point, ; (unless you remove the file :P) Return False ; if the folder already exists ElseIf FileType = 2 ; no need to create it ; no file or folder with that name, yet ElseIf FileType = 0 ; create it CreateDir Construct EndIf Next Return True End Function ; Write a string (without header) to current position of file Function WriteText( FileHandle , Message$ ) Local Char Local Length Local Buffer Length = Len( Message ) Buffer = CreateBank( Length ) ; convert string to bank For Char = 1 To Length PokeByte Buffer , Char-1 , Asc( Mid( Message , Char,1 ) ) Next ; then write bank to file (single write is faster) WriteBytes Buffer,FileHandle , 0,Length FreeBank Buffer End Function ; Read a string (without header) from current position of file Function ReadText$( FileHandle , Length ) Local Char Local Buffer Local Message$ Buffer = CreateBank( Length ) ; read block of data from file and put into bank ReadBytes Buffer,FileHandle , 0,Length ; then convert bank to string For Char = 1 To Length Message = Message + Chr( PeekByte( Buffer , Char-1 ) ) Next FreeBank Buffer Return Message End Function ;------------------------------------------------------------------------------- Function MoveFile$( Source$ , Target$ ) ;--------------------------------------------------------------------------- ; Version 05 Jul 2006 Revision 1 ;--------------------------------------------------------------------------- ; Rename or move a file or folder ;--------------------------------------------------------------------------- ; Uses API_MoveFile: ; file: kernel32.decls ; contents: .lib "KERNEL32.DLL" ; API_MoveFile%(source$,target$) : "MoveFileA" ;--------------------------------------------------------------------------- ; MoveFile always returns extended error info, with this format: ; Error code (2), Space, Colon (:), Space, Error message ; You can grab the unique error code using: ; - Automatic typecast: ; ErrorCode% = MoveFile( Source , Target ) ; - Manual typecast: ; If Int MoveFile( Source , Target ) = True Then Print "Woo!" ; You can grab the error message using: ; Result$ = MoveFile( Source , Target ) ; ErrorMsg$ = Right( Result , Len( Result ) - 5 ) ;--------------------------------------------------------------------------- ; List of extended error info: ; 1 : Operation succesful ; 0 : Unhandled exception ; -1 : Target already exists ; -2 : Source does not exist ; -3 : Unable to move Source to Target ; -4 : Target not created ; -5 : Source not moved ; -6 : Source not specified ; -7 : Target not specified ;--------------------------------------------------------------------------- Source = Trim( Source ) Target = Trim( Target ) If Source = "" Return "-6 : Source not specified" EndIf If Target = "" Return "-7 : Target not specified" EndIf ; Target already exists If FileType( Target ) <> 0 Return "-1 : Target ("+Target+") already exists" EndIf ; Source does not exist If FileType( Source ) = 0 Return "-2 : Source ("+Source+") does not exist" EndIf ; Attempt to move source to target If API_MoveFile( Source , Target ) = 0 Return "-3 : Unable to move ("+Source+") to ("+Target+")" EndIf ; Source removed, target created If FileType( Source ) = 0 And FileType( Target ) <> 0 Return " 1 : Operation succesful" Else ; Target not created If FileType( Target ) = 0 Return "-4 : Target ("+Target+") not created" EndIf ; Source not moved If FileType( Source ) <> 0 Return "-5 : Source ("+Source+") not moved" EndIf Return " 0 : Unhandled exception" EndIf ;------------------------------------------------------------------------------- End Function ;------------------------------------------------------------------------------- --v

Comments
Wednesday, 12 May 2010, 13:07
Longarm	HI, would this work on itself? (ie unpack resources from itself at runtime?)

Comments