NAME

Meta::Utils::File::Dir - library to do stuff on directories in the file system.

COPYRIGHT

Copyright (C) 2001, 2002 Mark Veltzer; All rights reserved.

LICENSE

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.

DETAILS

        MANIFEST: Dir.pm
        PROJECT: meta
        VERSION: 0.30

SYNOPSIS

        package foo;
        use Meta::Utils::File::Dir qw();
        my($dire)="/etc";
        if(Meta::Utils::File::Dir::empty($dire)) {
                # do that
        } else {
                # do other
        }

DESCRIPTION

This is a library to help you do things with directories. For instance: create a directory (also creating its parents) and dying if something goes wrong, checking if a directory is empty etc...

FUNCTIONS

        empty($)
        check_exist($)
        check_notexist($)
        fixdir($)
        get_relative_path($$)
        file_list($)
        TEST($)

FUNCTION DOCUMENTATION

empty($)

This returns a boolean value according to whether the directory is empty or not. The current implementation seems slow since it lists our all the files in that directory and checks to see that we have only one (the ".." link which points to the father...:) A speedup would be to find a better way in perl to do this... Using stat maybe ?

check_exist($)

This routine checks if a directory given to it exists. If the directory does not exist it throws an exception.

check_notexist($)

This routine checks if a directory given to it does not exist. If the directory exists it throws an exception.

fixdir($)

This routine gets a name of a file or directory and eliminated bad stuff from it: 0. [pref] slash [a] slash [..] slash [suff] is turned to [pref] slash [suff] Currently it will only do this (removed trailing slashes) using a regexp.

get_relative_path($$)

This method will return a relative path which leads from the first file or directory to the second assuming that they both start from the same root.

file_list($)

This method will return the file list in a specific directory. This method will throw eceptions if something bad happens.

TEST($)

Test suite for this module.

SUPER CLASSES

None.

BUGS

None.

AUTHOR

        Name: Mark Veltzer
        Email: mailto:veltzer@cpan.org
        WWW: http://www.veltzer.org
        CPAN id: VELTZER

HISTORY

        0.00 MV initial code brought in
        0.01 MV make quality checks on perl code
        0.02 MV more perl checks
        0.03 MV make Meta::Utils::Opts object oriented
        0.04 MV check that all uses have qw
        0.05 MV fix todo items look in pod documentation
        0.06 MV more on tests/more checks to perl
        0.07 MV correct die usage
        0.08 MV perl code quality
        0.09 MV more perl quality
        0.10 MV more perl quality
        0.11 MV perl documentation
        0.12 MV more perl quality
        0.13 MV perl qulity code
        0.14 MV more perl code quality
        0.15 MV revision change
        0.16 MV languages.pl test online
        0.17 MV web site and docbook style sheets
        0.18 MV perl packaging
        0.19 MV md5 project
        0.20 MV database
        0.21 MV perl module versions in files
        0.22 MV movies and small fixes
        0.23 MV thumbnail user interface
        0.24 MV more thumbnail issues
        0.25 MV website construction
        0.26 MV more web page stuff
        0.27 MV web site automation
        0.28 MV SEE ALSO section fix
        0.29 MV weblog issues
        0.30 MV md5 issues

SEE ALSO

Error(3), strict(3)

TODO

-cant we do the empty routine more efficiently ? (some stat or something...)