defaultconfig.inc.php

<?php
/**
 * This file is part of the ATK distribution on GitHub.
 * Detailed copyright and licensing information can be found
 * in the doc/COPYRIGHT and doc/LICENSE files which should be
 * included in the distribution.
 *
 * The file contains the default values for most configuration
 * settings.
 *
 * @package atk
 *
 * @copyright (c)2000-2004 Ibuildings.nl BV
 * @copyright (c)2000-2004 Ivo Jansch
 * @license http://www.achievo.org/atk/licensing ATK Open Source License
 *
 * @todo Make sure EVERY config variable is located here and properly
 * documented.
 *
 * @version $Revision: 7116 $
 * $Id: defaultconfig.inc.php 7116 2011-04-29 12:32:28Z mvdvelden $
 */
/* * ******************* FILE LOCATIONS & PATHS ***************************** */

/**
 * The application root, used to set the cookiepath when using PHP sessions.
 *
 * If you're using urlrewrites within your httpd or htaccess configuration this should be '/'
 * be careful with this setting because it could create a security vulnerability.
 *
 * @var String The application root
 */
$config_application_root = "/";

if ($config_atkroot == "" || (ini_get('register_globals') && isset($_REQUEST['config_atkroot']))) { // may not be passed in request (register_globals danger)
    /**
     * The root of the ATK application, where the atk/ directory resides
     * @var String The root
     */
    $config_atkroot = "./";
}

if (!isset($config_application_dir) || empty($config_application_dir) || (ini_get('register_globals') && isset($_REQUEST['config_application_dir']))) {
    /**
     * Root directory of your application code (modules/themes/configuration files/etc)
     * relative to the script calling ATK.
     * Defaults to the atkroot.
     *
     * @var String Directory where the application code can be found
     */
    $config_application_dir = $config_atkroot;
}

/**
 * Module path (without trailing slash!) where the modules directory resides,
 * defaults to the atk root, so not IN the atk/ directory, but more likely in
 * the application root
 * @var String
 */
$config_module_path = $config_application_dir . "modules";

$config_corporate_node_base = "";
$config_corporate_module_base = "";

/**
 * The location of a directory that is writable to ATK and that ATK can
 * store it's temporary files in.
 * @var String
 */
$config_atktempdir = $config_application_dir . "atktmp/";

/**
 * The location of the module specific configuration files.
 * @var String
 */
$config_configdir = $config_application_dir . "configs/";

/**
 * Use the built-in ATK error handler (highly recommended!)
 * @var Bool
 */
$config_use_atkerrorhandler = true;

/**
 * Use the given meta policy as the default meta policy.
 * @var String
 */
$config_meta_policy = "atk.meta.atkmetapolicy";

/**
 * Use the given meta grammar as the default meta grammar.
 * @var String
 */
$config_meta_grammar = "atk.meta.grammar.atkmetagrammar";

/**
 * Use the given meta compiler as the default meta compiler.
 * @var String
 */
$config_meta_compiler = "atk.meta.compiler.atkmetacompiler";

/**
 * Cache table meta data and compiled meta node code.
 *
 * On development environments this option should be set to false, but
 * on production environments you should really enable it. If you enable
 * this option and your table structure changes you should manually clear
 * the cache in the atktmp directory!
 *
 * @var bool
 */
$config_meta_caching = true;

/**
 * Use the given class for creating datagrids.
 */
$config_datagrid_class = "atk.datagrid.atkdatagrid";


/**
 * The dispatcher, all request (should) lead to this setting.
 */
$config_dispatcher = 'index.php';

/* * ************************ DATABASE SETTINGS ***************************** */

/**
 * The IP or hostname of the database host
 * @var String
 */
$config_db["default"]["host"] = "localhost";

/**
 * The name of the database to use
 * @var String
 */
$config_db["default"]["db"] = "";

/**
 * The name of the database user with which to connect to the host
 * @var String
 */
$config_db["default"]["user"] = "";

/**
 * The password for the database user, used to connect to the databasehost
 * @var String
 */
$config_db["default"]["password"] = "";

/**
 * Wether or not to use a persistent connection.
 *
 * Note that this is usefull if you don't have a lot of applications doing
 * this as the application won't constantly have to connect to the database.
 * However, the database server won't be able to handle a lot of persistent
 * connections.
 * @var boolean
 */
$config_databasepersistent = true;

/**
 * The databasetype.
 *
 * Currently supported are:
 *   mysql:   MySQL (3.X ?)
 *   mysqli:  MySQL > 4.1.3
 *   oci8:    Oracle 8i
 *   oci9:    Oracle 9i and 10g
 *   pgsql:   PostgreSQL
 *   mssql:   Microsoft SQL Server
 * @var String
 */
$config_db["default"]["driver"] = "mysqli";

/**
 * Test database mapping. Maps normal databases to their test database.
 * Most of the applications only use one database in that case the default
 * should be sufficient. But in case you use multiple database and also
 * want to run tests on all these database you can override this mapping
 * or add your own mappings.
 *
 * @var array
 */
$config_test_db_mapping = array('default' => 'test');

/**
 * Backwardscompatibility setting. Set this to MYSQL_BOTH if your
 * software relies on numerical indexes (WHICH IS A BAD IDEA!!)
 * @var int
 */
$config_mysqlfetchmode = defined("MYSQL_ASSOC") ? MYSQL_ASSOC : 0;

/**
 * Backwardscompatibility setting. Set this to PGSQL_BOTH if your
 * software relies on numerical indexes (WHICH IS A BAD IDEA!!)
 * @var int
 */
$config_pgsqlfetchmode = defined("PGSQL_ASSOC") ? PGSQL_ASSOC : 0;

/**
 * Database Cluster nodes
 * $config_db_cluster["default"] = array("master","slave","slave2");
 */
$config_db_cluster = array();

/* * ******************************** SECURITY ****************************** */

/**
 * The password to use for administrator login.
 * An administrator password that is empty will *DISABLE* administrator login!
 * @var mixed
 */
$config_administratorpassword = "";

/**
 * The password to use for guest login.
 * A guest password that is empty will *DISABLE* guest login!
 * @var String
 */
$config_guestpassword = "";

/**
 * The method to use for user/password validation.
 *
 * Currently supported are:
 * - "none": No authentication
 * - "db"  : the credentials are stored in the database.
 * - "pop3": the passwords are validated against a pop3 server.
 * - "config": the credentials are stored in the configurationfile.
 * - "imap": the passwords are validated against an IMAP server.
 * - "ldap": the passwords are validated against an LDAP server.
 * - "server": Authentication is done through the webserver.
 *
 * @var String
 */
$config_authentication = "none";

/**
 * Wether your authentication method supports MD5 passwords
 * @var boolean
 */
$config_authentication_md5 = true;

/**
 * Use a cookie to store authentication information.
 * @var boolean
 */
$config_authentication_cookie = false;

/**
 * The default cookie expiry time (in minutes) (7 days)
 * @var int
 */
$config_authentication_cookie_expire = 10080;

/**
 * The default state cookie expiry time (in minutes) (7 days)
 * @var int
 */
$config_state_cookie_expire = 10080;

/**
 * Use the session to store authentication information.
 * @var boolean
 */
$config_authentication_session = true;

/**
 * The scheme to use for security.
 *
 * Currently supported are:
 * - "none": No security scheme is used.
 * - "group": Use group-based security.
 * - "level": Use level-based security.
 *
 * @var String
 */
$config_securityscheme = "none";

/**
 *
 * @var boolean
 */
$config_restrictive = true;

/**
 *
 * @var boolean
 */
$config_security_attributes = false;

/**
 * By default, there is no 'grantall' privilege. Apps can set this if necessary.
 * Syntax: "module.nodename.privilege"
 */
$config_auth_grantall_privilege = "";

/**
 * Security logging
 * @var int
 * 0 No logging
 * 1 log login failures
 * 2 log login failures and logins/logouts
 * 3 log login failures, logins/logouts and
 */
$config_logging = 0;

/**
 *
 * @var String
 */
$config_logfile = "/tmp/atk-security.log";

/**
 * @var string  - name of security listener name in ATK import format
 * or
 * @var array   - array of security listener names
 */
//$config_security_listeners = "atk.security.atksecuritylistener";


/**
 * Password Restrictions if required
 * @var integer
 * 0 => ignore restriction
 * >0 => implement restriction
 * Special characters are    !@#$%^&*()-+_=[]{}\|;:'\",.<>/?
 */
$config_password_minsize = 0;
$config_password_minupperchars = 0;
$config_password_minlowerchars = 0;
$config_password_minalphabeticchars = 0;
$config_password_minnumbers = 0;
$config_password_minspecialchars = 0;

/* * ************************ AUTHENTICATION ******************************** */

/**
 *
 * @var String
 */
$config_auth_database = "default";

/**
 *
 * @var String
 */
$config_auth_usertable = "user";

/**
 * Defaults to usertable
 * @var String
 */
$config_auth_leveltable = "";

/**
 *
 * @var String
 */
$config_auth_accesstable = "access";

/**
 * If left empty auth_levelfield is used.
 *
 * @var String
 */
$config_auth_accessfield = "";

/**
 *
 * @var String
 */
$config_auth_userfield = "userid";

/**
 * Primary key of usertable
 * @var String
 */
$config_auth_userpk = "userid";

/**
 *
 * @var String
 */
$config_auth_passwordfield = "password";

/**
 *
 * @var String
 */
$config_auth_languagefield = "lng";

/**
 *
 * @var String
 */
$config_auth_accountdisablefield = "";

/**
 *
 * @var String
 */
$config_auth_levelfield = "entity";

/**
 * Name of table containing the groups.
 * (only necessary to support hierarchical groups!).
 * @var String
 */
$config_auth_grouptable = "";

/**
 * Name of primary key attribute in group table.
 * (only necessary to support hierarchical groups!)
 * @var String
 */
$config_auth_groupfield = "";

/**
 * Name of parent attribute in group table.
 * (only necessary to support hierarchical groups!)
 * @var String
 */
$config_auth_groupparentfield = "";

/**
 * Default pop3 port
 * @var String
 */
$config_auth_mail_port = "110";

/**
 * No vmail.
 * @var boolean
 */
$config_auth_mail_virtual = false;

/**
 * Use bugzilla-style crypted password storage
 * @var boolean
 */
$config_auth_usecryptedpassword = false;

/**
 * When changerealm is true, the authentication realm is changed on every
 * login.
 *
 * Advantage: the user is able to logout using the logout link.
 * Disadvantage: browser's 'remember password' feature won't work.
 *
 * This setting only affects the http login box, so it is only relevant if
 * $config_auth_loginform is set to false.
 *
 * The default is true for backwardscompatibility reasons. For new
 * applications, it defaults to false since the skel setting is set to false
 * by default.
 * @var boolean
 */
$config_auth_changerealm = true;

/**
 * 0 = no maximum.
 * @var int
 */
$config_max_loginattempts = 5;


/**
 *
 * @var boolean
 */
$config_auth_dropdown = false;

/**
 *
 * @var String
 */
$config_auth_userdescriptor = "[" . $config_auth_userfield . "]";

/**
 * This parameter can be used to specify a where clause which will be used
 * to validate users login credentials
 * @var String
 */
$config_auth_accountenableexpression = "";


/* * *************************** LDAP settings ****************************** */
/**
 * To use LDAP you should fill this config_variables with the right values
 */
/**
 *
 * @var String
 */
$config_authentication_ldap_host = "";

/**
 *
 * @var String
 */
$config_authentication_ldap_context = "";

/**
 *
 * @var String
 */
$config_authentication_ldap_field = "";

/* * *************** DEBUGGING AND ERROR HANDLING *************************** */

/**
 *
 * @var int
 */
$config_debug = 0;

/**
 *
 * @var String
 */
$config_debuglog = "";

/**
 *
 * @var Array
 */
$config_smart_debug = array();

/**
 *
 * @var boolean
 */
$config_display_errors = true;

/**
 *
 * @var String
 */
$config_halt_on_error = "critical";

/**
 * Automatic error reporting is turned off by default.
 * @var String
 */
$config_mailreport = "";

/**
 * Output missing translation "errors".
 * @var String
 */
$config_debug_translations = false;

/* * ********************************** LAYOUT ****************************** */

/**
 *
 * @var String
 */
$config_doctype = '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
        "http://www.w3.org/TR/html4/loose.dtd">';

/**
 *
 * @var String
 */
$config_menu_delimiter = "<br>";

/**
 *
 * @var String
 */
$config_menu_pos = "left";

/**
 *
 * @var String
 */
$config_menu_layout = "plain";

/**
 *
 * @var String
 */
$config_menu_align = "center";

/**
 * Auto-include logout link in menu? (only supported for atkDropDownMenu
 * at the moment).
 *
 * @var Boolean
 */
$config_menu_logout_link = false;

/**
 * 0 = no   - 1 = yes
 * @var int
 */
$config_top_frame = 0;

/**
 *
 * @var String
 */
$config_defaulttheme = "stillblue";

/**
 * Fullscreen mode (IE only)
 * @var String
 */
$config_fullscreen = false;

/**
 * Whatever tabs are enabled or not
 * @var boolean
 */
$config_tabs = true;

/**
 * Whatever DHTML tabs should be stateful or not
 * (E.g. the current tab is saved for the current node/selector combination)
 * @var boolean
 */
$config_dhtml_tabs_stateful = true;

/**
 * The default number of records to display on a single page
 * @var int
 */
$config_recordsperpage = 25;

/**
 * The number of records per page options to display on drop down list
 * @var array
 */
$config_recordsperpage_options = array(15, 25, 50, 100, 500);

/**
 * Add a 'show all' option to the records per page selector.
 * @var boolean
 */
$config_enable_showall = true;

/**
 * The (max) number of page navigation links to show
 * @var int
 */
$config_pagelinks = 10;

/**
 * Display a 'stack' of the user activities in the top right corner.
 * @var boolean
 */
$config_stacktrace = true;

/**
 * The maximum length of an HTML input field generated by atkAttribute or
 * descendants
 * @var int
 */
$config_max_input_size = 70;

/* * ********************************* OUTPUT ******************************* */

/**
 * Set to true, to output pages gzip compressed to the browser if the
 * browser supports it.
 *
 * Note: This should only be used for situations where either the webserver (Apache)
 * doesn't support it or you can't get to the webserver configuration,
 * as webservers are generally much better at this than ATK is.
 */
$config_output_gzip = false;

/* * ******************************** LANGUAGE ****************************** */

/**
 *
 * @var String
 */
$config_language = "en";

/**
 *
 * @var String
 */
$config_defaultlanguage = "en";

/**
 *
 * @var String
 */
$config_language_basedir = "languages/";

/**
 * Use browser language to detect application language.
 * By default set to false to remain backwards compatible.
 *
 * @var boolean
 */
$config_use_browser_language = false;

/**
 * True: one language switch attributes automatically switches all others on
 * screen.
 * False: each language switch attributes operates only on it's own node
 * @var boolean
 */
$config_multilanguage_linked = true;

/**
 * Module/node checking for strings in atkLanguage (if you don't know, don't
 * change)
 * comment out to disable checking for module of node
 * 1 to check just for node
 * 2 to check for module and node
 * @var String
 */
$config_atklangcheckmodule = 2;

/**
 * Where ATK should look for it's supported languages
 *
 * In your own application you should probably make this the module
 * with the most language translations.
 * Leaving this empty will turn off functionality where we check
 * for the user language in the browser or in the user session and will
 * make sure the application is always presented in the default language.
 * This config var also accepts 2 'special' modules:
 * - atk (making it use the languages of ATK)
 * - langoverrides (making it use the language overrides directory)
 *
 * @var String
 */
//$config_supported_languages_module = $config_atkroot.'atk/languages/';
$config_supported_languages_module = '';

/* * ******************* TEMPLATE ENGINE CONFIGURATION ********************** */

/**
 * By default all templates are described by their relative
 * path, relative to the applications' root dir.
 * @var String
 */
$config_tplroot = $config_application_dir;

/**
 *
 * @var boolean
 */
$config_tplcaching = false;

/**
 * default one hour
 * @var int
 */
$config_tplcachelifetime = 3600;
/**
 *
 * @var String
 */
$config_tplcompiledir = $config_atktempdir . "compiled/tpl/";

/**
 *
 * @var String
 */
$config_tplcachedir = $config_atktempdir . "tplcache/";

/**
 * Check templates to see if they changed
 * @var String
 */
$config_tplcompilecheck = "true";

/**
 * Use subdirectories for compiled and cached templates
 */
$config_tplusesubdirs = false;

/* * **************** MISCELLANEOUS CONFIGURATION OPTIONS ******************* */

/**
 * The session name. If this configuration option is not set the
 * $config_identifier option is used instead.
 *
 * @var string
 */
$config_session_name = "";

/**
 * The maximum inactivity period for a stack in the session manager before
 * it expires.
 *
 * Set to a value <= 0 to disable.
 *
 * @var int
 */
$config_session_max_stack_inactivity_period = 3600; // 1 hour

/**
 * The application identifier.
 *
 * @var String
 * @todo update this bit of documentation as it doesn't really say much
 */
$config_identifier = "default";

/**
 * Lock type, only supported type at this time is "db".
 * If empty locking is disabled.
 * @var String
 * @todo update this bit of documentation as it doesn't really say much
 */
$config_lock_type = "";

/**
 * The default encryption method for atkEncryption
 * @var String
 * @todo update this bit of documentation as it doesn't really say much
 */
$config_encryption_defaultmethod = "base64";

/**
 * The default searchmode
 * @var String
 * @todo update this bit of documentation as it doesn't really say much
 */
$config_search_defaultmode = "substring";


/**
 *  Add Clear button to admin/list view
 * @var boolean
 */
$config_clear_search = true;

/**
 * Enable < or > searches for numeric/decimal/currency/date
 * attributes in list view (ATK 7.0+)
 * @var boolean
 * OK for number, currency  and date attributes
 */
$config_compare_search = true;


/**
 * Wether or not to enable Internet Explorer extensions
 * @var boolean
 * @todo update this bit of documentation as it doesn't really say much
 */
$config_enable_ie_extensions = false;

/**
 * Files that are allowed to be included by the include wrapper script
 * NOTE: this has nothing to do with useattrib and userelation etc.!
 * @var Array
 */
$config_allowed_includes = array("atk/lock/lock.php", "atk/lock/lock.js.php",
    "atk/popups/help.inc", "atk/popups/colorpicker.inc",
    "atk/ext/captcha/img/captcha.jpg.php");

/**
 * Forces the themecompiler to recompile the theme all the time
 * This can be handy when working on themes.
 * @var boolean
 */
$config_force_theme_recompile = false;

/**
 * Wether or not to use the keyboardhandler for attributes and the recordlist
 * When set to true, arrow keys can be used to navigate through fields and
 * records, as well as shortcuts 'e' for edit, 'd' for delete, and left/right
 * cursor for paging. Note however, that using cursor keys to navigate
 * through fields is not standard web application behaviour.
 * @var int
 */
$config_use_keyboard_handler = false;

/**
 * Session cache expire (minutes)
 * @var int
 */
$config_session_cache_expire = 180;

/**
 * Session cache limiter
 *
 * Possible values:
 * - nocache
 * - public  (permits caching by proxies and clients
 * - private (permits caching by clients
 * - private_no_expire (permits caching by clients but not sending expire
 *   headers >PHP4.2.0)
 * @var String
 */
$config_session_cache_limiter = "nocache";

/**
 * Initialize sessions by default.
 *
 * When atksessionmanager is included, if this configuration value is true (by default),
 * ATK will configure and start a PHP session for you.
 * When you do not want this (in CLI environnements?) you can disable this in your script.
 *
 * DO NOT ENABLE IN THIS CONFIG or you won't be able to set it in your script.
 * Appears here for documentation purposes only.
 *
 * @var bool
 */
//$config_session_init = true;

/**
 * Default sequence prefix.
 * @var String
 */
$config_database_sequenceprefix = "seq_";

/**
 * Make the recordlist use a javascript
 * confirm box for deleting instead of a seperate page
 * @var boolean
 */
$config_recordlist_javascript_delete = false;

/**
 * This should be turned on when an application makes use
 * of OpenSSL encryption (atk.security.encryption.atkopensslencryption)
 * It makes sure that the user password is available in the session
 * for the private key.
 * @var boolean
 */
$config_enable_ssl_encryption = false;

/**
 * Enable / disable sending of e-mails (works only if the atk.utils.atkMailer::Send
 * function has been used for sending e-mails).
 * Note: atk.utils.atkMail::mail is deprecated but is still enabled/disabled by this setting.
 * @var boolean
 */
$config_mail_enabled = true;

/**
 * Redirect e-mails to a specified address (works only if the atk.utils.atkMailer::Send
 * function has been used for sending e-mails).
 * @var string
 */
$config_mail_redirect = "";

/**
 * Default extended search action. This action can always be overriden
 * in the node by using $node->setExtendedSearchAction. At this time
 * (by default) the following values are supported: 'search' or 'smartsearch'
 *
 * @var string
 */
$config_extended_search_action = 'search';

/**
 * Should all many-to-one relations have the AF_RELATION_AUTOCOMPLETE flag set?
 *
 * @var boolean
 */
$config_manytoone_autocomplete_default = false;

/**
 * Should all many-to-one relations that have the AF_LARGE flag set also
 * have the AF_RELATION_AUTOCOMPLETE flag set?
 *
 * @var boolean
 */
$config_manytoone_autocomplete_large = true;

/**
 * Should manytoone relations having the AF_RELATION_AUTOCOMPLETE flag also
 * use auto completion in search forms?
 *
 * @var boolean
 */
$config_manytoone_search_autocomplete = true;

/**
 * Controls how many characters a user must enter before an auto-completion
 * search is being performed.
 *
 * @var int
 */
$config_manytoone_autocomplete_minchars = 2;

/**
 * The search mode of the autocomplete fields. Can be 'startswith', 'exact' or 'contains'.
 *
 * @access private
 * @var String
 */
$config_manytoone_autocomplete_searchmode = "contains";

/**
 * Value determines wether the search of the autocompletion is case-sensitive.
 *
 * @var boolean
 */
$config_manytoone_autocomplete_search_case_sensitive = false;

/**
 * Warn the user if he/she has changed something in a form
 * and leaves the page without pressing save or cancel.
 *
 * @var bool
 */
$config_lose_changes_warning = false;

/**
 * Optionally set the export file parameters
 *
 * @var string
 */
//$config_export_delimiter = ",";
//$config_export_enclosure = "&quot;";
//$config_export_export_title_row_ticked = "checked";

/**
 * Directories that contains modules (needed for testcases)
 */
//  $config_module_dirs = array("/modules");
// --------- FCK Image Upload Option ---------

$config_fck_filemanager_enabled = false;
$config_fck_upload_path = '../atktmp/';

/**
 * Zend framework path (relative to ATK root).
 *
 * Example: "../library/Zend/";
 */
$config_zend_framework_path = null;


/**
 * Use the ATK autoloader for ATK classes.
 *
 * @var bool
 */
$config_autoload_classes = true;

/**
 * Re-index the cached class list when a class is missing?
 *
 * When this option is turned off you should manually delete the
 * cached classes file (atktmp/classes.inc) when updating ATK to
 * a newer version. It's recommended to not change the value of this
 * option unless you are an ATK developer.
 *
 * @var bool
 */
$config_autoload_reindex_on_missing_class = false;

/**
 * Normally atkerror silently ignores an error and sends an e-mail and/or
 * adds the error to the debug output. Using this switch ATK will throw
 * an exception when atkerror is called.
 *
 * @var boolean
 */
$config_throw_exception_on_error = false;

?>