NAME

File::Find::Closures - functions you can use with File::Find

SYNOPSIS

        use File::Find;
        use File::Find::Closures qw(:all);

        my( $list_reporter, $wanted ) = find_by_name( qw(README) );

        File::Find::find( $wanted, @directories );
        File::Find::find( { wanted => $wanted, ... }, @directories );

        my @readmes = $list_reporter->();

DESCRIPTION

NOTHING IS IMPLEMENTED YET! THIS IS ALPHA ALPHA SOFTWARE: A MERE SHELL OF AN IDEA.

When I use File::Find, I have two headaches---coming up with the \&wanted function to pass to find(), and acculumating the files.

This module provides the \&wanted functions as a closures that I can pass directly to find(). Actually, for each pre-made closure, I provide a closure to access the list of files too, so I don't have to create a new array to hold the results.

The filenames are the full path to the file as reported by File::Find.

The closure factories

Each factory returns two closures. The first one is for find(), and the second one is the reporter.

find_by_minimum_size( SIZE );

Find files whose size is equal to or greater than SIZE bytes.

UNIMPLEMENTED!

find_by_maximum_size( SIZE );

Find files whose size is equal to or less than SIZE bytes.

UNIMPLEMENTED!

find_by_zero_size();

Find files whose size is equal to 0 bytes.

UNIMPLEMENTED!

find_by_directory_contains( @names );

Find directories which contain files with the same name as any of the values in @names.

UNIMPLEMENTED!

find_by_name( @names );

Find files with the names in @names.

UNIMPLEMENTED!

find_by_name_regex( @regexen );

Find files whose names match any of the regexen in @regexen.

UNIMPLEMENTED!

find_by_owner( OWNER_NAME | OWNER_UID );

Find files that are owned by the owner with the name OWNER_NAME. You can also use the owner's UID.

UNIMPLEMENTED!

find_by_group( GROUP_NAME | GROUP_GID );

Find files that are owned by the owner with the name GROUP_NAME. You can also use the group's GID.

UNIMPLEMENTED!

find_by_executable();

Find files that are executable. This may not work on some operating systems (like Windows) unless someone can provide me with an alternate version.

UNIMPLEMENTED!

find_by_writeable();

Find files that are writable. This may not work on some operating systems (like Windows) unless someone can provide me with an alternate version.

UNIMPLEMENTED!

find_by_umask( UMASK );

Find files that fit the umask UMASK. The files will not have those permissions.

UNIMPLEMENTED!

find_by_modified_before( EPOCH_TIME );

Find files modified before EPOCH_TIME, which is in seconds since the local epoch (I may need to adjust this for some operating systems).

UNIMPLEMENTED!

find_by_modified_after( EPOCH_TIME );

Find files modified after EPOCH_TIME, which is in seconds since the local epoch (I may need to adjust this for some operating systems).

UNIMPLEMENTED!

find_by_created_before( EPOCH_TIME );

Find files created before EPOCH_TIME, which is in seconds since the local epoch (I may need to adjust this for some operating systems).

UNIMPLEMENTED!

find_by_created_after( EPOCH_TIME );

Find files created after EPOCH_TIME, which is in seconds since the local epoch (I may need to adjust this for some operating systems).

UNIMPLEMENTED!

ADD A CLOSURE

I want to add as many of these little functions as I can, so please send me ones that you create!

You can follow the examples in the source code, but here is how you should write your closures.

You need to provide both closures. Start of with the basic subroutine stub to do this. Create a lexical array in the scope of the subroutine. The two closures will share this variable. Create two closures: one of give to find() and one to access the lexical array.

        sub find_by_foo
                {
                my @args = @_;

                my @found = ();

                my $finder   = sub { push @found, $File::Find::name if ... };
                my $reporter = sub { @found };

                return( $finder, $reporter );
                }

The filename should be the full path to the file that you get from $File::Find::name, unless you are doing something wierd, like find_by_directory_contains().

Once you have something, send it to me at <bdfoy@cpan.org>. You must release your code under the Perl Artistic License.

TO DO

* more functions!

* need input on how things like mod times work on other operating systems

SEE ALSO

File::Find

Randal Schwartz's File::Finder, which does the same task, but differently.

SOURCE AVAILABILITY

This source is part of a SourceForge project which always has the latest sources in CVS, as well as all of the previous releases.

        http://sourceforge.net/projects/brian-d-foy/

If, for some reason, I disappear from the world, one of the other members of the project can shepherd this module appropriately.

AUTHOR

brian d foy, <bdfoy@cpan.org>

COPYRIGHT

Copyright (c) 2004, brian d foy, All Rights Reserved.

You may redistribute this under the same terms as Perl itself.

cpanm File::Find::Closures

perl -MCPAN -e shell
install File::Find::Closures