Recursive Directory Listing (Show full directory structure)
This function will read the full structure of a directory. It's recursive becuase it doesn't stop with the one directory, it just keeps going through all of the directories in the folder you specify.
<?php
function getDirectory( $path = '.', $level = 0 ){
$ignore = array( 'cgi-bin', '.', '..' );
// Directories to ignore when listing output. Many hosts
// will deny PHP access to the cgi-bin.
$dh = @opendir( $path );
// Open the directory to the handle $dh
while( false !== ( $file = readdir( $dh ) ) ){
// Loop through the directory
if( !in_array( $file, $ignore ) ){
// Check that this file is not to be ignored
$spaces = str_repeat( ' ', ( $level * 4 ) );
// Just to add spacing to the list, to better
// show the directory tree.
if( is_dir( "$path/$file" ) ){
// Its a directory, so we need to keep reading down...
echo "<strong>$spaces $file</strong><br />";
getDirectory( "$path/$file", ($level+1) );
// Re-call this same function but on a new directory.
// this is what makes function recursive.
} else {
echo "$spaces $file<br />";
// Just print out the filename
}
}
}
closedir( $dh );
// Close the directory handle
}
?>
Example Calls:
getDirectory( "." );
// Get the current directory
getDirectory( "./files/includes" );
// Get contents of the "files/includes" folder
Thanks man. I didn't want to spend the time writing and thinking about doing this. Helped alot with this little snippet ^^ Thanks again :)
I also wanted to say thanks a lot. This is exactly what I was looking for. :thumbsup:
sorry but this doesn't work on my php server.. I NEED HELP lol.. if i want to show a directory /public_html/flash/ what do i have to put? and what is the "level" variable about??
thanx.
Jamez.
ok peeps, soz to double post, just solved it - you need the full directory path including this /home/user/public/foldername/
thanx.
Jamez.
This function does the same thing but is a _LOT_ faster:
Both code don't work for me, I only see a blank page.
Can someone help ?
Peuplarchie, did you actually call the function or did you just copy/paste the code from above into your php page? Because you have to include the above code in <?PHP and ?> and then actually call it inside the php tags like so:
<?
//Function code
//....
//Now call it by using one of these,
//depending on which function you chose above:
getdirectory('.');
//or
get_dir_iterative(/*etc.*/);
?>
marek_mar, Dude, that code is lightening fast but I'm finding it only goes two levels deep.
Not being sniffy, should probably rewrite/repost myself: but the function is both getting the directory listing and printing the result, would be nice if it returned the data from the recursive directory scan (probably in an array) so programmer can specify how it is shown, either print or send to HTML template etc. keep functions doing one thing, getting data from filesystem or printing the result makes it more re-usable.
Not Sure if it's the best, and likely is not, but I modified the first function to get things working for now. This returns an array so that when i go back through the array, I can concatenate my keys with my values for use with something like fopen...
The getDirectory function is totally awesome! and exactly what i needed. here's the thing tho: when i was hacking it up on my dev box it was working great. but then, once i got it the way i wanted it, i uploaded the files to the web server, and now everything is coming up in random order.
is there a way to force it to read alphabetically? Is is my web server? is it something else entirely? :confused: anybody know of this issue?
TIA
~joel
The getDirectory function is totally awesome! and exactly what i needed. here's the thing tho: when i was hacking it up on my dev box it was working great. but then, once i got it the way i wanted it, i uploaded the files to the web server, and now everything is coming up in random order.
is there a way to force it to read alphabetically? Is is my web server? is it something else entirely? :confused: anybody know of this issue?
/*
** Put the following line into an index.php,
** with first line: include_once("dirLister.class.php");
** Then erase the following line.
*/
$dirLister = new dirLister();
/*
** After running this once you will find two new files in the current directory:
** config.ini
** links.ini
** Once they exist, you might want to edit them, as needed, to get what you want.
*/
class dirLister
{
var $searchRootUrlPath;
var $searchRootFilePath;
var $currentDirUrlPath;
var $currentDirFilePath;
var $currentDisplayName=null;
var $defaultDisplayName;
var $linkTypes=array();
var $links=array();
var $allowedLinkTypesfile;
var $config=array();
var $dbg=false;
function __construct()
{
$this->init();
$this->readLinkTypes();
$this->getLinks();
$this->getDefaultDisplay();
$this->show();
}
function init()
{
if(@stat("config.ini"))
{
/* A config.ini file does exist. You can edit this file, as needed, to search any permissable directory. */
$lines = file("config.ini");
foreach ($lines as $aline)
{
$tokens = explode("=",$aline);
$label = trim($tokens[0]);
$value = trim($tokens[1]);
if(stristr($label, "path")){
if(strlen(strrchr($value,'/')) != 1){
$value .= '/';
}
}
$this->config[$label] = $value;
}
$this->searchRootUrlPath = $this->config['searchRootUrlPath'];
$this->searchRootFilePath = $this->config['searchRootFilePath'];
}
else
{
if(strstr($_SERVER['SCRIPT_FILENAME'],"home"))
{
/* no config.ini file exists. If "home" appears in the path
** we'll make a desperate attempt to make this work. We'll assume
** the current path looks something like this (which it may not):
** /home/sandy/public_html/images/
*/
$dirs = explode('/',dirname($_SERVER['SCRIPT_FILENAME']));
$tmpUrlPath='/~' . $dirs[2] ;
$zapper = '/' . $dirs[1] . '/'. $dirs[2] . '/' . $dirs[3] . '/';
$tmp = ereg_replace($zapper,"", dirname($_SERVER['SCRIPT_FILENAME']));
$tmpUrlPath .= '/'.$tmp . '/';
$this->config['searchRootFilePath'] = dirname($_SERVER['SCRIPT_FILENAME']);
$this->config['searchRootUrlPath'] = $tmpUrlPath;
$this->searchRootFilePath = $this->config['searchRootFilePath'];
$this->searchRootUrlPath = $this->config['searchRootUrlPath'];
}
else
{
/*
** No config.ini file exists. "home" does not appear in the path.
** So we'll assume we're in the global document root instead of a ~user/public_html directory
** This should work, regardless $_SERVER['DOCUMENT_ROOT']
*/
$this->searchRootFilePath = dirname($_SERVER['SCRIPT_FILENAME']).'/';
$this->searchRootUrlPath = '/' . ereg_replace($_SERVER['DOCUMENT_ROOT'],"", $this->searchRootFilePath);
}
}
Before sorting the listed files/directories alphabetically, I coverted the function into the way listing the files/directories in list(ul/li) manner instead of the current 'intent' one. I reckon the list way is the most proper way to list nested items. Here is the new function:
function getDirectory( $path = '.'){
$ignore = array( 'cgi-bin', '.', '..' );
// Directories to ignore when listing output. Many hosts
// will deny PHP access to the cgi-bin.
$dh = @opendir( $path );
// Open the directory to the handle $dh
while( false !== ( $file = readdir( $dh ) ) ){
// Loop through the directory
if( !in_array( $file, $ignore ) ){
// Check that this file is not to be ignored
// Just to add spacing to the list, to better
// show the directory tree.
if( is_dir( "$path/$file" ) ){
// Its a directory, so we need to keep reading down...
//Add a class as selector for the jQuery sorting later.
echo "<li>$file<ul class='has-children'>";
getDirectory( "$path/$file");
// Re-call this same function but on a new directory.
// this is what makes function recursive.
echo "</li>";
} else {
echo "<li>$file</li>";
// Just print out the filename
}
}
}
echo "</ul>";
closedir( $dh );
// Close the directory handle
}
//Add a class as selector for the jQuery sorting later.
echo "<ul class='has-children'>";
getDirectory( "." );
Then add the following jQuery codes to sort the lists:
<script src="http://code.jquery.com/jquery-latest.js"></script>
<script>
$(function() {
$('ul.has-children').each(function() {
var $t=$(this);
var Li=$t.find('>li').get();
Li.sort(function(a, b) {
var A = $(a).text().toUpperCase();
var B = $(b).text().toUpperCase();
if (A < B) return -1; // changing to 1 to sort in DESC order...
if (A > B) return 1; // changing to -1 to sort in DESC order...
return 0;
});
$.each(Li,function(i,v) {
$t.append(v);
});
});
</script>
Have fun :)
Hi! I was looking for a code snippet for directory traversal and i found tours (i feel too lazy tonight to do it by myself) :)
I tested on linux and works ok, on windows ok except for long paths.
And I actually need to index some dirs and files that have a really deep dir structure.
It just freezes when the path is longer than 255...
Do you have any ideas on how i can traverse such a structure?
Thank you very much!
Any help is really appreciated!
I like (turtles) natcasesort($files);
To be honest, I don't really like the supressing of potentional errors( @opendir ).
I was actually creating an online file management system, and already had this coded. (Currently secured it by IP Access).
<?php
if($_SERVER['REMOTE_ADDR'] != 'YOUR_IP') {
die("Only the webmaster can access this page's content. Please go back and open another file.");
echo '</table>';
echo '<br /><br />';
echo '<a href="./create.php?is_dir=1&dir='.$dir.'">Create a Directory</a> - <a href="./create.php?is_dir=0&dir='.$dir.'">Create a File</a>';
}
?>
(Not going to give the other pages tho, I might release the full source when I've got it done).
{
How it eventually looks:
http://img716.imageshack.us/img716/521/managementr.png
}
(only thing that needs to be added that it takes you to the actual page, instead of trying to open it as a dir when you click a file)
# system call do recursive dir listing. assign listing to array and sort on each
# pass with foreach loop.
# once you have array you can go further as sorting & recursion done.
$rtv = `ls -RAFr /home/web.symfony/`; // system call to start listing
$dir = array();
foreach( preg_split("/\n/", $rtv) as $line ) {
if(preg_match("/:$/", $line)) { // if directory
if($line && $current_path) { // after first pass
asort($dir[$current_path]); // cool & easy sort
}
$current_path = preg_replace("/:$/", '', $line); // discard : from the path
}else if ($line != '') {
$dir[$current_path][] = $line; // listing of the previous pass
}
}
print_r($dir);
Before sorting the listed files/directories alphabetically, I coverted the function into the way listing the files/directories in list(ul/li) manner instead of the current 'intent' one. I reckon the list way is the most proper way to list nested items. Here is the new function:
function getDirectory( $path = '.'){
$ignore = array( 'cgi-bin', '.', '..' );
// Directories to ignore when listing output. Many hosts
// will deny PHP access to the cgi-bin.
$dh = @opendir( $path );
// Open the directory to the handle $dh
while( false !== ( $file = readdir( $dh ) ) ){
// Loop through the directory
if( !in_array( $file, $ignore ) ){
// Check that this file is not to be ignored
// Just to add spacing to the list, to better
// show the directory tree.
if( is_dir( "$path/$file" ) ){
// Its a directory, so we need to keep reading down...
//Add a class as selector for the jQuery sorting later.
echo "<li>$file<ul class='has-children'>";
getDirectory( "$path/$file");
// Re-call this same function but on a new directory.
// this is what makes function recursive.
echo "</li>";
} else {
echo "<li>$file</li>";
// Just print out the filename
}
}
}
echo "</ul>";
closedir( $dh );
// Close the directory handle
}
//Add a class as selector for the jQuery sorting later.
echo "<ul class='has-children'>";
getDirectory( "." );
Then add the following jQuery codes to sort the lists:
<script src="http://code.jquery.com/jquery-latest.js"></script>
<script>
$(function() {
$('ul.has-children').each(function() {
var $t=$(this);
var Li=$t.find('>li').get();
Li.sort(function(a, b) {
var A = $(a).text().toUpperCase();
var B = $(b).text().toUpperCase();
if (A < B) return -1; // changing to 1 to sort in DESC order...
if (A > B) return 1; // changing to -1 to sort in DESC order...
return 0;
});
$.each(Li,function(i,v) {
$t.append(v);
});
});
</script>
Have fun :)
Here is the PHP way to do the same sorting as the above with jQuery:
<?
$tree=array();
function getDirectory( $path = '.'){
$ignore = array( 'cgi-bin', '.', '..' );
// Directories to ignore when listing output. Many hosts
// will deny PHP access to the cgi-bin.
$dh = @opendir( $path );
// Open the directory to the handle $dh
//Make counter
$j=0;
$temp=array();
while( false !== ( $file = readdir( $dh ) ) ){
// Loop through the directory
if( !in_array( $file, $ignore ) ){
// Check that this file is not to be ignored
// Feed with file name
$temp[$j]['name']=$file;
if( is_dir( "$path/$file" ) ){
// Its a directory, so we need to keep reading down...
$temp[$j]['children']=getDirectory( "$path/$file");
}
}
$j++; //counting
}
return $temp;
closedir( $dh );
// Close the directory handle
}//end of function
//Put the file directory system in an array first...
$tree=getDirectory("/your-dirtory/here");
$type='desc'; //set sorting type 'desc' or 'asc'
//recursive function for sorting arrays
function getSort(&$temp) {
global $type;
switch ($type) {
case 'desc':
rsort($temp);
break;
case 'asc':
sort($temp);
break;
}
foreach($temp as &$t) {
if(is_array($t['children']))
getSort($t['children']);
}
} //end of function
//Go through arrays again for sorting...now we have new sorted array $tree...
getSort($tree);
?>
<pre>
<?
print_r($tree); // output
?>
</pre>
Have funs:thumbsup:
hello,
well for me this function make the error :
Warning: readdir() expects parameter 1 to be resource, boolean given
for
while (false !== ($file = readdir($dh))) {
any idea? :)
I must say I don't think it's a good practice to put html in your code, it's better to separate front presentation from back, so this function will be more logic to integrate to make others operations (of course it's not a big deal to modify)
ok it was a problem with directory which doesn't exist, the strnage is function doesn't stop and go to infinite recursive
another list function I found useful : http://www.webmaster-talk.com/php-forum/41811-list-files-in-directory-sub-directories.html
I just want to say thank you for the information.
It is very valuable for me..newbie here and encountering the same situation.
Thanks and keep up the good work..
The functions on this site did not work for me.
I wrote one myself.
It converts the directory structure into an array.
It returns some relevant data in the {data} key and loops through the rest.
It might not be the cleanest script but it does the job for me.
Maybe it helps someone.
//$include overrides $exclude. $include should be an array of file extensions eg. array("jpg", "png", "gif")
function readDirectory($path="./", $exclude=array(".", "..", ".htaccess"), $include=false){
$ds = "/";
if(!$path){ $path=$this->path;}
$return = array();
$return['{data}']['path'] = $path;
$return['{data}']['has_files'] = 0;
$return['{data}']['has_dirs'] = 0;
if(is_dir($path)){
$dir = opendir($path);
while ($file = readdir($dir)) {
thank for your code. but i want to call getDirectory() function with parameter like below example:
getDirectory("http://updatesofts.com");
does it work?
if not how to i can?
thanks.