{"id":3279,"date":"2018-09-15T00:01:35","date_gmt":"2018-09-15T07:01:35","guid":{"rendered":"https:\/\/c-for-dummies.com\/blog\/?p=3279"},"modified":"2018-09-22T09:42:58","modified_gmt":"2018-09-22T16:42:58","slug":"directory-spelunking","status":"publish","type":"post","link":"https:\/\/c-for-dummies.com\/blog\/?p=3279","title":{"rendered":"Directory Spelunking"},"content":{"rendered":"

Exploring a folder tree — I mean directory<\/em> tree — is a procedure found in many file and media utilities. From an original directory, you scan the list of files looking for a subdirectory. When it’s found, you open it and recursively continue the scan.
\n
\nFor example, in Unix, you can use the du<\/em> command to recursively scan directories and discover how many blocks they consume. (A block is 512 bytes.) In Windows, both the cmd (command prompt) and PowerShell terminals use the TREE<\/code> command to list directories and subdirectories.<\/p>\n

To plumb these depths, you need a recursive function, which goes like this:<\/p>\n

    \n
  1. Change to a given directory, which is passed to the recursive function as an argument.<\/li>\n
  2. Open the current directory for reading.<\/li>\n
  3. Scan for any subdirectory entries, ignoring the . and .. entries.<\/li>\n
  4. If a subdirectory entry is found, dive into Step 2 again.<\/li>\n
  5. Change back to the parent directory and continue the scan at Step 3.<\/li>\n<\/ol>\n

    Not covered in last week’s Lesson<\/a> is the chdir()<\/em> function. Like its shell counterpart, the chdir()<\/em> function changes to the named directory:<\/p>\n

    int chdir(const char *path)<\/code><\/p>\n

    The path<\/code> is the name of a directory, and the . and .. abbreviations can be used. Upon success, the function returns zero, otherwise -1. The errno<\/a> variable can be checked to determine the specific reason chdir()<\/em> failed.<\/p>\n

    The chdir()<\/em> function is prototyped in the unistd.h<\/code> header file.<\/p>\n

    Using the code presented in last week’s Lesson as a base, I wrote the dir()<\/em> function. It requires two arguments, a directory (or pathname) and an integer depth<\/code> value:<\/p>\n

    void dir(char *directory,int depth)<\/code><\/p>\n

    This function changes to the named directory<\/em> and reads its listing, scanning for subdirectories. If found, the function calls itself (recurses). The depth<\/code> argument helps indent the directories in the output.<\/p>\n

    \r\n#include <stdio.h>\r\n#include <stdlib.h>\r\n#include <string.h>\r\n#include <unistd.h>\r\n#include <dirent.h>\r\n#include <sys\/stat.h>\r\n\r\nvoid dir(char *directory,int depth);\r\n\r\nint main(int argc, char *argv[])\r\n{\r\n    puts(\"Finding Directories\");\r\n\r\n    if(argc==2)\r\n        dir(argv[1],0);\r\n    else\r\n        dir(\".\",0);\r\n\r\n    return(0);\r\n}\r\n\r\nvoid dir(char *directory,int depth)\r\n{\r\n    DIR *folder;\r\n    struct dirent *entry;\r\n    struct stat filestat;\r\n\r\n    \/* Change to the named directory *\/<\/span>\r\n    if(chdir(directory))\r\n    {\r\n        fprintf(stderr,\"Error changing to %s\\n\",directory);\r\n        exit(1);\r\n    }\r\n\r\n    \/* open the directory *\/<\/span>\r\n    folder = opendir(\".\");\r\n    if(folder == NULL)\r\n    {\r\n        fprintf(stderr,\"Unable to read directory %s\\n\",directory);\r\n        exit(1);\r\n    }\r\n\r\n    printf(\"%*s%s\\n\",depth*2,\" \",directory);\r\n    \/* Look for a subdirectory *\/<\/span>\r\n    while( (entry=readdir(folder)) )\r\n    {\r\n        stat(entry->d_name,&filestat);\r\n        \/* look for only directories *\/<\/span>\r\n        if( S_ISDIR(filestat.st_mode) )\r\n        {\r\n            \/* skip the . and .. entries *\/<\/span>\r\n            if(strcmp(entry->d_name,\".\")==0 || strcmp(entry->d_name,\"..\")==0)\r\n                continue;\r\n            \/* recurse to the found directory *\/<\/span>\r\n            dir(entry->d_name,depth+1);\r\n        }\r\n    }\r\n\r\n    chdir(\"..\");\r\n    closedir(folder);\r\n}<\/pre>\n
    In the main()<\/em> function, you can specify a directory to plumb at the command line, otherwise the current directory is used by default.<\/p>\n
    At the start of the dir()<\/em> function, chdir()<\/em> changes to the named directory, which is opened at Line 36.<\/p>\n
    The while<\/em> loop scans the directory entries, with help from the if<\/em> statement at Line 49. At Line 52, the . and .. entries are skipped. Whatever remains is a subdirectory entry, which is explored recursively at Line 55, along with an incremented value for depth<\/code>.<\/p>\n
    As the recursive function rewinds, the chdir()<\/em> function at Line 59 returns to the parent directory.<\/p>\n
    This code does have some flaws. For example, it crashes when reading the root directory because you can’t change to .. (the root’s parent), which doesn’t exist. The code is unable to track the parent directories of symbolic links in some filesystems. If you encounter a folder that needs permissions to open, the program halts.<\/p>\n
    I address the symbolic link issue in next week’s Lesson<\/a>, which improves the code to better track parent directories.<\/p>\n","protected":false},"excerpt":{"rendered":"
    Use what you know about reading directories to recursively plumb the depths of a directory tree structure. Continue reading →<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[2],"tags":[],"class_list":["post-3279","post","type-post","status-publish","format-standard","hentry","category-main"],"_links":{"self":[{"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=\/wp\/v2\/posts\/3279","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=3279"}],"version-history":[{"count":8,"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=\/wp\/v2\/posts\/3279\/revisions"}],"predecessor-version":[{"id":3311,"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=\/wp\/v2\/posts\/3279\/revisions\/3311"}],"wp:attachment":[{"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=3279"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=3279"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=3279"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}
    The directory name is printed at Line 43. The depth<\/code> value is used to indent the name by a given number of spaces. (See this Lesson<\/a>.)<\/p>\n