The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
XML-Directory-0.81
River stage zero No dependents
/ XML::Directory

NAME

XML::Directory - returns a content of directory as XML.

SYNOPSIS

 use XML::Directory::String;
 $dir = new XML::Directory::String('/home/petr',3,10);
 $rc = $dir->parse;
 @res = $dir->get_array;

or

 use XML::Directory::SAX;
 use MyHandler;
 $dir = new XML::Directory::SAX('/home/petr',3,10);
 $h = new MyHandler;
 $dir->set_content_handler($h);
 $rc = $dir->parse;

DESCRIPTION

This extension provides two classes: XML::Directory::String and XML::Directory::SAX. Their methods make it possible to set parameters such as level of details or maximal number of nested sub-directories and generate either string containing the resulting XML or SAX events.

The SAX generator supports both SAX1 and SAX2 handlers. There are two SAX interfaces available: basic ContentHandler and optional ErrorHandler.

The original function (get_dir) is still supported via XML::Directory base class.

 use XML::Directory(qw(get_dir));
 my @xml = get_dir('/home/petr');

METHODS COMMON TO BOTH CLASSES

Methods common to both classes are defined in the XML::Directory base class.

new
 $dir = new XML::Directory('/home/petr',2,5);
 $dir = new XML::Directory('/home/petr',2);
 $dir = new XML::Directory('/home/petr');

The constructor accepts up to 3 parameters: path, details (1-3, brief or verbose XML) and depth (number of nested sub-directories). The last two parameters are optional (defaulted to 2 and 1000).

set_path
 $dir->set_path('/home/petr');

Resets path. An initial path is set using the constructor.

set_details
 $dir->set_details(3);

Sets or resets level of details to be returned. Can be also set using the constructor. Valid values are 1, 2 or 3.

 1 = brief

 Example:

 <?xml version="1.0" encoding="utf-8"?>
 <dirtree>
   <directory name="test">
     <file name="dir2xml.pl"/>
   </directory>
 </dirtree>

 2 = normal

 Example:

 <?xml version="1.0" encoding="utf-8"?>
 <dirtree>
   <head version="0.70">
     <path>/home/petr/test</path>
     <details>2</details>
     <depth>5</depth>
   </head>
   <directory name="test" depth="0">
     <path></path>
     <modify-time epoch="998300843">Mon Aug 20 11:47:23 2001</modify-time>
     <file name="dir2xml.pl">
       <mode code="33261">rwx</mode>
       <size unit="bytes">225</size>
       <modify-time epoch="998300843">Mon Aug 20 11:47:23 2001</modify-time>
     </file>
   </directory>
 </dirtree>

 3 = verbose

 Example:

 <?xml version="1.0" encoding="utf-8"?>
 <dirtree>
   <head version="0.70">
     <path>/home/petr/test</path>
     <details>3</details>
     <depth>5</depth>
   </head>
   <directory name="test" depth="0" uid="500" gid="100">
     <path></path>
     <access-time epoch="999857485">Fri Sep  7 12:11:25 2001</access-time>
     <modify-time epoch="998300843">Mon Aug 20 11:47:23 2001</modify-time>
     <file name="dir2xml.pl" uid="500" gid="100">
       <mode code="33261">rwx</mode>
       <size unit="bytes">225</size>
       <access-time epoch="998300843">Mon Aug 20 11:47:23 2001</access-time>
        <modify-time epoch="998300843">Mon Aug 20 11:47:23 2001</modify-time>
     </file>
   </directory>
 </dirtree>
set_maxdepth
 $dir->set_maxdepth(5);

Sets or resets number of nested sub-directories to be parsed. Can also be set using the constructor. 0 means that only a directory specified by path is parsed (no sub-directories).

parse
 $rc  = $dir->parse;

Scans directory tree specified by path. When used from the XML::Directory::String class instance it stores its XML representation in memory ($dir->{xml}) and returns a number of lines. For XML::Directory::SAX it generate SAX events and returns a result of the end_document function.

This method checks a validity of details and depth. In the event a parameter is out of valid range, an error occurs. The same is true if the path specified can't be found. For SAX, missing content handler is also treated as error.

get_path
 $path = $dir->get_path;

Returns current path.

get_details
 $details = $dir->get_details;

Returns current level of details.

get_maxdepth
 $maxdepth = $dir->get_maxdepth;

Returns current number of nested sub-directories.

enable_ns;
 $dir->enable_ns;

Enables a support for namespaces.

disable_ns;
 $dir->disable_ns;

Disables a support for namespaces.

get_ns_data;
 $ns  = $dir->get_ns_data;

Returns a hash reference with the following keys:

enabled

either 1 or 0

uri

namespace URI, 'http://gingerall.org/directory' by default

prefix

namespace prefix, 'xd' by default

encoding
 $encoding = $dir->encoding;
 $dir->encoding('utf-8');

Gets or sets an encoding of generated XML document. The encoding must be a string acceptable for an XML encoding declaration. The default value is 'utf-8'. The encoding doesn't apply to SAX so far.

enable_rdf
 $dir->enable_rdf('index.n3');

Enables a support of RDF/Notation3 meta-data. The parser looks for files with same name as an argument of this method in each directory. If found, the file is passed to RDF::Notation3 parser and properties of particular resources (files or directories) are merged to resulting XML. The N3 file itself is not listed in the XML. See http://www.w3.org/DesignIssues/Notation3.html for more details on RDF/Notation3.

If, for example, a directory contains a file named Apache.html:

 <xd:file name="Apache.html">
   <xd:mode code="33188">rw-</xd:mode>
   <xd:size unit="bytes">41913</xd:size>
   <xd:modify-time epoch="999344286">Sat Sep  1 13:38:06 2001</xd:modify-time>
 </xd:file>

Then a presence of the following Notation3 file

 @prefix dc: <http://purl.org/dc/elements/1.1/>.
 <Apache.html> 
         dc:Title "Apache";
         dc:Description "mod_perl Apache module".

results in:

 <xd:file name="Apache.html">
   <xd:mode code="33188">rw-</xd:mode>
   <xd:size unit="bytes">41913</xd:size>
   <xd:modify-time epoch="999344286">Sat Sep  1 13:38:06 2001</xd:modify-time>
   <dc:Title>Apache</dc:Title>
   <dc:Description>mod_perl Apache module</dc:Description>
 </xd:file>

Since using RDF meta-data requires to use namespaces, this method enables namespaces automatically. It also checks whether the RDF::Notation3 module is installed and issues an error if not.

disable_rdf
 $dir->disable_rdf;

Disables RDF/N3 support.

error_treatment
 $et = $dir->error_treatment;
 $dir->error_treatment('warn');

Gets or sets a way errors are treated in. There are two possible values:

die

The parse method dies (actually croaks) on an error. Default value.

warn

The parse methods catches the error. String generator returns an XML error message. SAX driver throws a SAX exception and calls an error handler if defined. String $dir->{error} property is set to an error number.

 Example of an error message:

 <?xml version="1.0" encoding="utf-8"?>
 <dirtree xmlns="http://gingerall.org/directory">
 <error number="3">Path /home/petr/work/done not found!</error>
 </dirtree>

XML::DIRECTORY::STRING

get_arrayref
 $res = $dir->get_arrayref;

Returns a parsed XML directory image as a reference to array (each field contains one line of the XML file).

get_array
 @res = $dir->get_array;

Returns a parsed XML directory image as an array (each field contains one line of the XML file).

get_string
 $res = $dir->get_string;

Returns a parsed XML directory image as a string.

XML::DIRECTORY::SAX

set_content_handler
 $h = new MyHandler;
 $dir->set_content_handler($h);

Sets SAX content handler.

set_error_handler
 $e = new MyErrorHandler;
 $dir->set_error_handler($e);

Sets SAX error handler.

ORIGINAL INTERFACE

get_dir();
 @xml = get_dir('/home/petr',2,5);

This functions takes a path as a mandatory parameter and details and depth as optional ones. It returns an array containing an XML representation of directory specified by the path. Each field of the array represents one line of the XML.

Optional arguments are defaulted to 2 and 1000.

XML::DIRECTORY::APACHE

This is a mod_perl module that serves as an Apache interface to XML::Directory::String. It allows to send parameters in http request and receive a result (XML representation of a directory tree) in http response. Errors are caught and sent as XML via http to prevent Apache error.

Parameters include:

path

absolute path to a directory to be parsed, mandatory

The path is not send in query but as an extra path instead. This seems to be more appropriate for this kind of parameter.

dets

level of details, optional

depth

maximal number of nested sub-directories, optional

ns

if set to 1, namespaces are used, optional

To use this module, add a similar section to your Apache config file

 <Location /xdir>
     SetHandler perl-script
     PerlHandler XML::Directory::Apache
     PerlSendHeader On
 </Location>

and send a request to:

 http://hostname/xdir/home/petr/work[?dets=1&depth=1&ns=1]

The path portion following 'xdir' is taken as path; other parameters can be send in query.

VERSION

Current version is 0.81.

LICENSING

Copyright (c) 2001 Ginger Alliance. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

AUTHOR

Petr Cimprich, petr@gingerall.cz, Duncan Cameron, dcameron@bcs.org.uk

SEE ALSO

perl(1).