Sign in to follow this  
Followers 0
therks

Another recursive FileList function

2 posts in this topic

#1 ·  Posted (edited)

I know there's already several of these types of functions around the forum but there were some things I wanted to do different, so I wrote my own.

In the tests I've done this appears to be working fine, but I'd appreciate a second look.

The error returns and the first three parameters are the same as the vanilla _FileListToArray, but there are a couple new flags, and two new parameters.

The new flags include:

- enabling recursion (4)

- disabling file count in element [0] (8)

- enabling full path returns (16).

The new parameters are:

- $sCallback - this is the name of a function you want to run on each loop, it is passed an array with data relating to the current file search in the loop. If the callback function returns 0 then the item is processed normally. If it returns 1 the item is skipped (this can be used to skip entire folders being processed). If it returns -1 the entire function errors out with -1 and @extended is set to the callback function's @extended value.

- $sCallbackUserParam - just an extra parameter that can be passed through to the callback function.

Example with callback:

#include <Array.au3>
#include <_FileListToArrayRecursive.au3>

Global $sWFile
_FileListToArrayRecursive(@DesktopDir, '*', 4, '_Callback', 'Wfile')
If @error = -1 And @extended = 42 Then
    MsgBox(0, '', 'You have a W file:' & @LF & $sWFile)
Else
    MsgBox(0, '', 'No files/folders that start with W exist.')
EndIf

Global $aReadOnly = _FileListToArrayRecursive(@DesktopDir, '*', 1+4, '_Callback', 'readonly')
Global $aEmpty = _FileListToArrayRecursive(@DesktopDir, '*', 1+4, '_Callback', 'empty')

_ArrayDisplay($aReadOnly)
_ArrayDisplay($aEmpty)

Func _Callback($aParams)
    Switch $aParams[5]
        Case 'Wfile'
            If StringLeft($aParams[2], 1) == 'W' Then
                $sWFile = $aParams[1] & $aParams[2]
                Return SetExtended(42, -1)
            EndIf
        Case 'empty'
            If Not $aParams[3] Then
                If FileGetSize($aParams[0] & $aParams[1] & $aParams[2]) Then Return 1
            EndIf
        Case 'readonly'
            If Not $aParams[3] Then
                If Not StringInStr(FileGetAttrib($aParams[0] & $aParams[1] & $aParams[2]), 'R') Then Return 1
            EndIf
    EndSwitch
EndFunc

#include-once
; #FUNCTION# ====================================================================================================================
; Name...........: _FileListToArrayRecursive
; Description ...: Lists files and/or folders in a specified path recursively
; Syntax.........: _FileListToArrayRecursive($sPath[, $sFilter = '*'[, $iFlag = 0[, $sCallback = ''[, $sCallbackUserParam = '' ] ] ] ] )
; Parameters ....: $sPath             - Path to search
;                 $sFilter          - Optional: the filter to use, default is *
;                 $iFlag              - Optional: specifies options about return, add flags together
;                 |$iFlag =  0 (Default) Return both files and folders
;                 |$iFlag =  1 Return files only
;                 |$iFlag =  2 Return folders only
;                 |$iFlag =  4 Search subfolders (Enable recursion)
;                 |$iFlag =  8 Make array 0-based (Disable return count in first element)
;                 |$iFlag = 16 Return full paths (default only returns from the search folder down)
;                 $sCallback          - Optional: function to call on each loop. See remarks for details (default: none)
;                 $sCallbackUserParam - Optional: a parameter to pass to the Callback function (default: none)
; Return values .: @Error - 1 = Path not found or invalid
;                 |2 = Invalid $sFilter
;                 |3 = Invalid $iFilter
;                 |4 = No files found or folder inaccessible
;                 |5 = No files found or folder inaccessible
;                 |-1 = Callback function returned -1
; Author ........: Rob Saunders (therks at therks dot com)
; Modified.......:
; Remarks .......: If $sCallback is defined the function will be called on each loop and it can alter what files are recorded
;                 in the return array. The Callback function runs on every file result because it is called *before* the flag
;                 filter for files/folders ($iFlag 1 or 2).
;                   Return  0 = Item is added (depending on $iFlag 1 or 2)
;                   Return  1 = Item is skipped (note: if you skip a folder it will not be searched either)
;                   Return -1 = Stop searching. Main func returns false, @error = -1, @extended = Callback's @extended value
;                 The function is passed one parameter, a 6 item array with values as follows:
;                   [0] root search folder
;                   [1] current sub folder
;                   [2] current filename match
;                   [3] 1 if file is a folder; 0 if not
;                   [4] current file count
;                   [5] $sCallbackUserParam
;
; Related .......: _FileListToArray
; Link ..........:
; Example .......:
; Note ..........: Some parts from original function (by SolidSnake) and _FileListToArrayEx (by DXRW4E)
; ===============================================================================================================================

Func _FileListToArrayRecursive($sPath, $sFilter = '*', $iFlag = 0, $sCallback = '', $sCallbackUserParam = '')
    Local Const $FL_FILES = 1, $FL_FOLDERS = 2, $FL_RECURSE = 4, $FL_NOCOUNT = 8, $FL_FULLPATH = 16

    If Not StringInStr(FileGetAttrib($sPath), 'D') Then Return SetError(1, 1, '')
    If StringRegExp($sFilter, '[\\/:><\|]|(?s)\A\s*\z') Then Return SetError(2, 2, '')
    If $iFlag < 0 Or $iFlag > 1+2+4+8+16 Then Return SetError(3, 3, '')

    $sPath = StringRegExpReplace($sPath, '[\\/]+$', '') & '\'

    Local $sFileTrack, $iFileCount, $hParentSearch, $hSearch, $hSubCheck, $sSubDir, $sFile, $iIsFolder, $sRegExFilter, $sAddFullPath, _
        $iReturnFolders, $iReturnFiles, $iRecurse, $iReturnCount, $iSortOffset, _
        $aCallbackData[6], $vCallbackReturn, $iCallbackExt

    $aCallbackData[5] = $sCallbackUserParam

    If BitAND($iFlag, $FL_FULLPATH) Then $sAddFullPath = $sPath

    If BitAND($iFlag, $FL_RECURSE) Then
        $iRecurse = 1
        If StringReplace($sFilter, '*', '') Then ; If we ARE recursing, and the filter is something besides just * then initialize the regex filter
            $sRegExFilter = '(?i)^' & StringRegExpReplace(StringReplace(StringRegExpReplace($sFilter, '(\.|\||\+|\(|\)|\{|\}|\[|\]|\^|\$|\\)', "\\$1"), '?', '.'), '\*+', '.*') & '$'
            $sFilter = '*'
        EndIf
    EndIf

    If BitAND($iFlag, $FL_FILES) Then
        $iReturnFiles = 1
    ElseIf BitAND($iFlag, $FL_FOLDERS) Then
        $iReturnFolders = 1
    Else
        $iReturnFiles = 1
        $iReturnFolders = 1
    EndIf

    If BitAND($iFlag, $FL_NOCOUNT) Then
        $iReturnCount = 2 ; Param for StringSplit
        $iSortOffset = 0
    EndIf

    $hParentSearch = FileFindFirstFile($sPath & $sSubDir & $sFilter)
    If $hParentSearch = -1 Then Return SetError(4, 4, '')
    $hSearch = $hParentSearch
    While 1
        $sFile = FileFindNextFile($hSearch)
        If @error Then
            If $hParentSearch = $hSearch Then ExitLoop
            FileClose($hSearch)
            $hSearch -= 1
            $sSubDir = StringLeft($sSubDir, StringInStr(StringTrimRight($sSubDir, 1), '\', 0, -1))
            ContinueLoop
        EndIf
        $iIsFolder = @extended

        If $sCallback Then
            $aCallbackData[0] = $sPath
            $aCallbackData[1] = $sSubDir
            $aCallbackData[2] = $sFile
            $aCallbackData[3] = $iIsFolder
            $aCallbackData[4] = $iFileCount
            $vCallbackReturn = Call($sCallback, $aCallbackData)
            If @error = 0xDEAD And @extended = 0xBEEF Then
                FileClose($hSearch)
                FileClose($hParentSearch)
                Return SetError(5, 5, '')
            ElseIf $vCallbackReturn = -1 Then
                $iCallbackExt = @extended
                FileClose($hSearch)
                FileClose($hParentSearch)
                Return SetError(-1, $iCallbackExt, '')
            ElseIf $vCallbackReturn Then
                ContinueLoop
            EndIf
        EndIf

        If $iRecurse Then
            If ($iIsFolder And $iReturnFolders) Or (Not $iIsFolder And $iReturnFiles) Then
                If Not $sRegExFilter Or ($sRegExFilter And StringRegExp($sFile, $sRegExFilter)) Then
                    $sFileTrack &= '|' & $sAddFullPath & $sSubDir & $sFile
                    $iFileCount += 1
                EndIf
            EndIf

            If $iIsFolder Then
                $hSubCheck = FileFindFirstFile($sPath & $sSubDir & $sFile & '\' & $sFilter)
                If $hSubCheck = -1 Then ContinueLoop
                $sSubDir &= $sFile & '\'
                $hSearch = $hSubCheck
            EndIf
        Else
            If ($iIsFolder And $iReturnFolders) Or (Not $iIsFolder And $iReturnFiles) Then
                $sFileTrack &= '|' & $sAddFullPath & $sSubDir & $sFile
                $iFileCount += 1
            EndIf
        EndIf

    WEnd
    FileClose($hParentSearch)

    Local $aReturnList = StringSplit(StringTrimLeft($sFileTrack, 1), '|', $iReturnCount)
    If @error Then Return SetError(4, 4, '')
    Return $aReturnList
EndFunc

I'm still working on this as time goes by so the most up to date version can be found in my dropbox: http://db.tt/OqNgumLK

Edited by therks

Share this post


Link to post
Share on other sites

Helpful - thanks!

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!


Register a new account

Sign in

Already have an account? Sign in here.


Sign In Now
Sign in to follow this  
Followers 0

  • Similar Content

    • Ascer
      By Ascer
      1. Description.
      Udf working with MSDN System.Collections.ArrayList. Allow you to make fast operations on huge arrays, speed is even x10 better than basic _ArrayAdd.  Not prefered for small arrays < 600 items. 2. Requirements
      .NET Framework 1.1 - 4.5 (on this version Microsoft destroy old rules) System Windows 3. Possibilities.
      ;=============================================================================================================== ; UDF Name: List.au3 ; ; Date: 2018-02-17, 10:52 ; Description: Simple udf to create System Collections as ArrayList and make multiple actions on them. ; ; Function(s): _ListCreate -> Creates a new list ; _ListCapacity -> Gets a list size in bytes ; _ListCount -> Gets items count in list ; _ListIsFixedSize -> Get bool if list if fixed size ; _ListIsReadOnly -> Get bool if list is read only ; _ListIsSynchronized -> Get bool if list is synchronized ; _ListGetItem -> Get item on index ; _ListSetItem -> Set item on index ; ; _ListAdd -> Add item at end of list ; _ListClear -> Remove all list items ; _ListClone -> Duplicate list in new var ; _ListContains -> Get bool if item is in list ; _ListGetHashCode -> Get hash code for list ; _ListGetRange -> Get list with items between indexs ; _ListIndexOf -> Get index of item ; _ListInsert -> Insert a new item on index ; _ListInsertRange -> Insert list into list on index ; _ListLastIndexOf -> Get index last of item ; _ListRemove -> Remove first found item ; _ListRemoveAt -> Remove item in index ; _ListRemoveRange -> Remove items between indexs ; _ListReverse -> Reverse all items in list ; _ListSetRange -> Set new value for items in range ; _ListSort -> Sort items in list (speed of reading) ; _ListToString -> Get list object name ; _ListTrimToSize -> Remove unused space in list ; ; Author(s): Ascer ;=============================================================================================================== 4. Downloads
      List.au3 5. Examples
      SpeedTest _ArrayAdd vs ListAdd SpeedTest ArraySearch vs ListIndexOf Basic usage - crating guild with members  
    • ronmage
      By ronmage
      So I have a loop that keeps reading data from an array and searching it for the same value. If the value is no there it does work then adds the value to the array to prevent it from doing the same work.
      If _ArraySearch($ID,$filearray[$i]) = -1 Then Work.... _ArrayAdd($ID,$filearray[$i]) EndIf This is in a for loop hence $i
      So what is happening is the code works great for several hours. After a period of time _ArraySearch($ID,$filearray[$i]) will result in -1 even if $ID = $filearray. So it ready as if there is no data in the array. Anyone have this problem? 
       
      Also I am just running in using F5 not compiling it and running it if that makes a difference.
       
    • FMS
      By FMS
      Hello,
      I'm trying to read a binary file to an array but couln't get it to work.
      Also I coul not find any help in the forum around this subject whish was helpfull.
      Is there any way it could be done?
      I tried a lot of ways but maybe somebody know's the right way?
      #AutoIt3Wrapper_Au3Check_Parameters=-d -w 1 -w 2 -w 3 -w 4 -w 5 -w 6 -w 7 #include <File.au3> #include <Array.au3> #include <AutoItConstants.au3> Local $in=FileOpen("TEST_labels.idx1-ubyte",16) ; 16+0=Read binary Local $data = FileRead($in) Local $FileArray = BinaryToString($data,4) ;~ $FileArray = StringSplit($BinarydData, @CRLF, 1+2) ;~ Local $FileArray = StringRegExp($BinarydData, "[^\r\n]+", 3) FileClose($in) _ArrayDisplay($FileArray,"$FileArray","",32) MsgBox($MB_SYSTEMMODAL, "", "$FileArray = " & $FileArray )  
      TEST_labels.idx1-ubyte
    • ur
      By ur
      I am reading a CSV file which is tab seperated as below.
      Local $aArray = FileReadToArray($file) And now, I am splitting this main array record wise so that Array contains internally another arrow to represent each row.
      For $i = 0 to (UBound($aArray) - 1) ;MsgBox(0,"",$aArray[$i]) $aArray[$i] = StringSplit(StringStripCR($aArray[$i]), Chr(9),2);Chr(9) for tab ;_ArrayDisplay($aArray[$i]) Next Afther that, _ArrayDIsplay is able to see the individual internal arrays.
      _ArrayDisplay($aArray[1]) But If I try to access the individual element of it as below.It is not showing any result.
      MsgBox(0,"",$aArray[1][1]) Any suggestion, below is the sample csv file.
      New Text Document.csv
    • Jibsbrown
      By Jibsbrown
      Need some help understanding why the ConsoleWrite works inside 2nd For loop but not out side. Between Audit Wiki, Help file , Forum searching (lots of code reading), and YouTube ( shout out to TutsTeach), I have not been able to find the reason why. 
      $sIniPath = "installLog.ini" ; - Get section name $iniSctionNames = IniReadSectionNames($sIniPath) ; - Get Keys and Vaules For $a = 1 to UBound($iniSctionNames) - 1 $keys = IniReadSection($sIniPath , $iniSctionNames[$a]) For $b = 1 to UBound($keys) - 1 $oldSysInfo = IniRead($sIniPath , $iniSctionNames[1], $keys[$b][0], "") $PntIPInfo = IniRead($sIniPath , $iniSctionNames[2], $keys[$b][0], "") $NewPCInfor = IniRead($sIniPath , $iniSctionNames[3], $keys[$b][0], "") ;ConsoleWrite($oldSysInfo & @LF) Next ;ConsoleWrite($oldSysInfo & @LF) Next ConsoleWrite($oldSysInfo) My intention is to use the variables later for Listboxes. Any explanation, forum post links or whatever would help. Sorry also very very new to Autoit.
      Also here's the ini file.
      [OldSysInfo] 4=192.168.0.4|DESKTOP-RDIU2SN|R90M05Q8 5=192.168.0.5|SD0123456789101|R9WGP9P 6=192.168.0.6|SD0123456789102|R9WGP9PT 3=192.168.0.3|DESKTOP-3RS4LKL|R9WGP9P 23=192.168.0.23|SD0123456789102|MXL1234P5I [PrinterIp] 50=192.168.0.50 48=192.168.0.48 47=192.168.0.47 [NewSysInfo] newPC = SD0123456789adfs|192.168.0.185|2UA1234FTR Thank you for your time.