APR::Finfo - Perl API for APR fileinfo structure

  use APR::Finfo ();
  use APR::Const -compile => qw(FINFO_NORM);
  my $finfo = APR::Finfo::stat("/tmp/test", APR::Const::FINFO_NORM, $pool);

  $device = $finfo->device;     # (stat $file)[0]
  $inode  = $finfo->inode;      # (stat $file)[1]
  $prot   = $finfo->protection; # (stat $file)[2]
  $nlink  = $finfo->nlink;      # (stat $file)[3]
  $gid    = $finfo->group;      # (stat $file)[4]
  $uid    = $finfo->user;       # (stat $file)[5]
  $size   = $finfo->size;       # (stat $file)[7]
  $atime  = $finfo->atime;      # (stat $file)[8]
  $mtime  = $finfo->mtime;      # (stat $file)[9]
  $ctime  = $finfo->ctime;      # (stat $file)[10]

  $csize = $finfo->csize; # consumed size: not portable!

  $filetype = $finfo->filetype; # file/dir/socket/etc

  $fname = $finfo->fname;
  $name  = $finfo->name;  # in filesystem case:

  # valid fields that can be queried
  $valid = $finfo->valid;

APR fileinfo structure provides somewhat similar information to Perl's CWstat() call, but you will want to use this module's API to query an already CWstat()'ed filehandle to avoid an extra system call or to query attributes specific to APR file handles.

During the HTTP request handlers coming after CWPerlMapToStorageHandler, CW$r->finfo already contains the cached values from the apr's CWstat() call. So you don't want to perform it again, but instead get the CWARP::Finfo object via:

  my $finfo = $r->finfo;

CWAPR::Finfo provides the following functions and/or methods: Get the time the file was last accessed:

  $atime = $finfo->atime;

since: 2.0.00

This method returns the same value as Perl's:

  (stat $filename)[8]

Note that this method may not be reliable on all platforms, most notably Win32 FAT32 filesystems appear to work properly, but NTFS filesystems do not. Get the storage size consumed by the file

  $csize = $finfo->csize;

since: 2.0.00

Chances are that you don't want to use this method, since its functionality is not supported on most platforms (in which case it always returns 0). Get the time the file was last changed

  $ctime = $finfo->ctime;

since: 2.0.00

This method returns the same value as Perl's:

  (stat $filename)[10]

The ctime field is non-portable. In particular, you cannot expect it to be a creation time, see Files and Filesystems in the perlport manpage for details. Get the id of the device the file is on.

  $device = $finfo->device;

since: 2.0.00

This method returns the same value as Perl's:

  (stat $filename)[0]

Note that this method is non-portable. It doesn't work on all platforms, most notably Win32. Get the type of file.

  $filetype = $finfo->filetype;

since: 2.0.00

For example:

  use APR::Pool;
  use APR::Finfo;
  use APR::Const -compile => qw(FILETYPE_DIR FILETYPE_REG FINFO_NORM);
  my $pool  = APR::Pool->new();
  my $finfo = APR::Finfo::stat("/tmp", APR::Const::FINFO_NORM, $pool);
  my $finfo = $finfo->filetype;
  if ($finfo == APR::Const::FILETYPE_REG) {
      print "regular file";
  }
  elsif ($finfo == APR::Const::FILETYPE_REG) {
      print "directory";
  }
  else {
      print "other file";
  }

Since /tmp is a directory, this will print:

  directory

  $fname = $finfo->fname;

since: 2.0.00

Get the group id that owns the file:

  $gid = $finfo->group;

since: 2.0.00

This method returns the same value as Perl's:

  (stat $filename)[5]

Note that this method may not be meaningful on all platforms, most notably Win32. Incorrect results have also been reported on some versions of OSX. Get the inode of the file.

  $inode = $finfo->inode;

since: 2.0.00

This method returns the same value as Perl's:

  (stat $filename)[1]

Note that this method may not be meaningful on all platforms, most notably Win32. The time the file was last modified

  $mtime = $finfo->mtime;

since: 2.0.00

This method returns the same value as Perl's:

  (stat $filename)[9]

  $name = $finfo->name;

since: 2.0.00

Get the number of hard links to the file.

  $nlink = $finfo->nlink;

since: 2.0.00

This method returns the same value as Perl's:

  (stat $filename)[3]

  $prot = $finfo->protection;

since: 2.0.00

This method returns the same value as Perl's:

  (stat $filename)[2]

  $size = $finfo->size;

since: 2.0.00

This method returns the same value as Perl's:

  (stat $filename)[7]

  $finfo = APR::Finfo::stat($fname, $wanted_fields, $p);

since: 2.0.00

For example, here is how to get most of the CWstat fields:

  use APR::Pool ();
  use APR::Finfo ();
  use APR::Const -compile => qw(FINFO_NORM);
  my $pool = APR::Pool->new();
  my $finfo = APR::Finfo::stat("/tmp/test", APR::Const::FINFO_NORM, $pool);

  $uid = $finfo->user;

since: 2.0.00

This method returns the same value as Perl's:

  (stat $filename)[4]

Note that this method may not be meaningful on all platforms, most notably Win32. The bitmask describing valid fields of this apr_finfo_t structure including all available 'wanted' fields and potentially more

  $valid = $finfo->valid;

since: 2.0.00

mod_perl 2.0 documentation.

mod_perl 2.0 and its core modules are copyrighted under The Apache Software License, Version 2.0.

The mod_perl development team and numerous contributors.