NAME

Any::Daemon::HTTP::UserDirs - describe user directories

INHERITANCE

 Any::Daemon::HTTP::UserDirs
   is a Any::Daemon::HTTP::Directory
   is a Any::Daemon::HTTP::Source

SYNOPSIS

 # implicit creation of ::Directory object
 my $vh = Any::Daemon::HTTP::VirtualHost
   ->new(user_dirs => {location => ...})

 # explicit use
 my $ud = Any::Daemon::HTTP::Directory::UserDirs
   ->new(location => sub {...});
 my $vh = Any::Daemon::HTTP::VirtualHost->new(user_dirs => $ud);

DESCRIPTION

Each Any::Daemon::HTTP::VirtualHost may define user directories.

See documentation in the base class.

METHODS

See documentation in the base class.

Constructors

See documentation in the base class.

Any::Daemon::HTTP::UserDirs->new(OPTIONS|HASH-of-OPTIONS)

The user-dir rewrite routine has by default Apache-like behavior.

 -Option        --Defined in                  --Default
  allow           Any::Daemon::HTTP::Source     <undef>
  allow_users                                   undef
  charset         Any::Daemon::HTTP::Directory  utf-8
  deny            Any::Daemon::HTTP::Source     <undef>
  deny_users                                    []
  directory_list  Any::Daemon::HTTP::Directory  <false>
  index_file      Any::Daemon::HTTP::Directory  ['index.html', 'index.htm']
  location        Any::Daemon::HTTP::Directory  CODE
  name            Any::Daemon::HTTP::Source     path
  path            Any::Daemon::HTTP::Source     <ignored>
  user_subdirs                                  'public_html'

allow => CIDR|HOSTNAME|DOMAIN|CODE|ARRAY

allow_users => ARRAY

Lists the user homes which are available. Cannot be used together with deny_users. By default, all user homes are permitted, even those of system usernames like ftp and cups. Only used with the default user-dir rewrite rule.

charset => STRING

deny => CIDR|HOSTNAME|DOMAIN|CODE|ARRAY

deny_users => ARRAY

Only used with the default user-dir rewrite rule.

directory_list => BOOLEAN

index_file => STRING|ARRAY

location => DIRECTORY|CODE

name => STRING

path => PATH

user_subdirs => PATH

Only used with the default user-dir rewrite rule.

Attributes

See documentation in the base class.

$obj->charset()

See "Attributes" in Any::Daemon::HTTP::Directory

$obj->location()

See "Attributes" in Any::Daemon::HTTP::Directory

$obj->name()

See "Attributes" in Any::Daemon::HTTP::Source

$obj->path()

See "Attributes" in Any::Daemon::HTTP::Source

Permissions

See documentation in the base class.

$obj->allow(SESSION, REQUEST, URI)

See "Permissions" in Any::Daemon::HTTP::Source

$obj->collect(VHOST, SESSION, REQUEST, URI)

See "Permissions" in Any::Daemon::HTTP::Source

Actions

See documentation in the base class.

$obj->filename(PATH)

See "Actions" in Any::Daemon::HTTP::Directory

$obj->list(DIRECTORY, OPTIONS)

See "Actions" in Any::Daemon::HTTP::Directory

DETAILS

See documentation in the base class.

SEE ALSO

This module is part of Any-Daemon-HTTP distribution version 0.24, built on January 05, 2014. Website: http://perl.overmeer.net/any-daemon/

LICENSE

Copyrights 2013-2014 by [Mark Overmeer]. For other contributors see ChangeLog.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See http://www.perl.com/perl/misc/Artistic.html