ABSTRACT

This class contains installation dependent constants of the VIP application. It is generated by the installation script vip_install, but may be edited. This class does not exist in the SOURCE TREE of a VIP application, but in every INSTALLED APPLICATION. It contains all code, that is installation dependent.

There are only class methods. There is no such thing as a Vip object.


METHODS

$string = Vip->abs_path($path)
Returns an absolute path of $path. If $path begins with a /, it is already an absolute path (and hence returned as is). If $path begins with a ~/, it is considdered a relative path to the login directory of the user who installed the application (not of the one who is logged in, so they are usually the same). If $path begins with a ~xxx/, it is considdered a relative path to the login directory of user xxx. Otherwise it is considdered relative to the current directory.

$string = Vip->application_name
The name of the application, used in CGIsession connects.
  CGIsession->connect( -application=>Vip->application_name,
                       -session_init=>Vip->door );

$string = Vip->base_dir
An absolute file path to the cgi-bin of the application. Directories are not terminated with a /

$string = Vip->base_dir_htdocs
An absolute file path to the document root directory of the application. Directories are not terminated with a /

$string = Vip->base_url
An absolute URL to the cgi-bin of the application. Not a full path with protocol and host. Base URLs are terminated with a /

$string = Vip->commands_dir
Absolute file path to the command directory. This directory contains shell commands for VIP programmers and cronjobs to clean up unused user registrations. Directories are not terminated with a /

$string = Vip->base_url_htdocs
The absolute URL of document root of this application. Not a full path with protocol and host. Base URLs are terminated with a /

$string = Vip->DB;
Returns 'Oracle' or 'mysql';

($db, $user, $pw) = Vip->DB_access
DB connection arguments to connect to the relational DB of the application.

$coderef = Vip->door
Returns a reference to a session_init subroutine. Used in door scripts as follows:
  CGIsession->connect( -application=>Vip->application_name,
                       -session_init=>Vip->door );

$string = Vip->login_dir
Returns the absolute path of the login directory of the user who installed this application.

$string = Vip->main_cgi
The URL of the main door script of the application. Used in non-door scripts as follows:
  CGIsession->connect( -application=>Vip->application_name,
                       -session_init=>Vip->main_cgi );

@array = Vip->nethz_ldap_admin_bind
Returns the arguments for a bind to nethz LDAP as an admin. It is used in NethzLDAP in a bind call: $msg = $ldap->bind(Vip->nethz_ldap_admin_bind); to connect as an admin to search a username.

$ary_ref = Vip->nethz_ldap_hosts
Returns a reference to an array of nethz LDAP hosts. It is used in NethzLDAP.

$string = Vip->nethz_ldap_search_base
Returns The base DN to search a username on a nethz LDAP.

$string = Vip->perl_lib
The absolute file path to the Perl module library of this application. If the Perm modules are installed in a system library (in the standard INC path), perl_lib returns an empty string. Directories are not terminated with a /

$string = Vip->perl_lib_dir
The absolute file path to the Perl module library of this application, wherever it is. Directories are not terminated with a /

$string = Vip->source_tree_dir
Absolute file path to the source tree. This is the directory of the original sources, from which the application was installed with vip_install script. Directories are not terminated with a /


COPYRIGHT

Copyright 2004-2013 Thedi gerber@id.ethz.ch