const.inc.php

<?php
/**
 * TestLink Open Source Project - http://testlink.sourceforge.net/
 * This script is distributed under the GNU General Public License 2 or later.
 *
 * Global Constants used throughout TestLink
 * The script is included via config.inc.php
 *
 * @filesource  const.inc.php
 * @package     TestLink
 * @copyright   2007-2020, TestLink community
 * @see         config.inc.php
 *
 **/

/* [GLOBAL SETTINGS] */
define('TL_SMARTY_VERSION', 3); // @since 1.9.8

/**
 * TestLink Release version (MUST BE changed before the release day)
 */
define('TL_VERSION_NUMBER', '1.9.20');
define('TL_VERSION', TL_VERSION_NUMBER . ' [fixed] ');
define('TL_FACE_DIR', 'prague');

/**
 * Latest Database version that is used to give users feedback
 * about necesssary upgrades
 * if you set this parameter also upgrade
 * lib/functions/configCheck.php - checkSchemaVersion()
 */
define('TL_LATEST_DB_VERSION', 'DB ' . '1.9.20');

// needed to avoid problems in install scripts that do not include config.inc.php
// want to point to root install dir, need to remove fixed part
if (! defined('TL_ABS_PATH')) {
    define('TL_ABS_PATH', str_replace('cfg', '', dirname(__FILE__)));
}

/**
 * Setting up the global include path for testlink
 */
$ds = DIRECTORY_SEPARATOR;
$ps = PATH_SEPARATOR;

$p2functions = TL_ABS_PATH . 'lib' . $ds . 'functions' . $ds;
$p2lib = TL_ABS_PATH . 'lib' . $ds;
ini_set('include_path',
    ini_get('include_path') . $ps . '.' . $ps . $p2functions . $ps . $p2functions .
    'oauth_providers' . $ds . $ps . $p2lib . 'issuetrackerintegration' . $ds .
    $ps . $p2lib . 'codetrackerintegration' . $ds . $ps . $p2lib .
    'reqmgrsystemintegration' . $ds);

ini_set('include_path',
    ini_get('include_path') . $ps . TL_ABS_PATH . 'third_party' . $ds . $ps .
    TL_ABS_PATH . 'vendor' . $ds . $ps . TL_ABS_PATH . 'cfg' . $ds);

/**
 * Localization directory base
 */
define('TL_LOCALE_PATH', TL_ABS_PATH . 'locale/');

clearstatcache();
$tf = 'custom_const.inc.php';
if (file_exists($tf)) {
    require_once $tf;
}

// --------------------------------------------------------------------------------
/* [GENERAL MAGIC NUMBERS] */

/**
 * PHPMAILER
 */
define('PHPMAILER_METHOD_MAIL', 0);
define('PHPMAILER_METHOD_SENDMAIL', 1);
define('PHPMAILER_METHOD_SMTP', 2);

/**
 * Descriptive constant names (actually true/false)
 */
define('ENABLED', 1);
define('DISABLED', 0);
define('ON', 1);
define('OFF', 0);
define('ACTIVE', 1);
define('INACTIVE', 0);
define('OPEN', 1);
define('CLOSED', 0);
define('OK', 1);
define('ERROR', 0);

/**
 * More Descriptive constant names
 */
define('HIGH', 3);
define('MEDIUM', 2);
define('LOW', 1);

/**
 * user for notes - see BUGID 0002469: $tlCfg->exec_cfg->expand_collapse
 * very important do not change values, logic depends on values
 */
define('LAST_USER_CHOICE', 2);
define('COLLAPSE', 0);
define('EXPAND', 1);

// used in several functions instead of MAGIC NUMBERS - Don't change
define('ALL_PRODUCTS', 0);
define('TP_ALL_STATUS', null);
define('FILTER_BY_PRODUCT', 1);
define('FILTER_BY_TESTPROJECT', 1);
define('TP_STATUS_ACTIVE', 1);

define('DO_LANG_GET', 1);
define('DONT_DO_LANG_GET', 0);

define('LANG_GET_NO_WARNING', true);

define('DSN', false); // for method connect() of database.class
define('ANY_BUILD', null);
define('GET_NO_EXEC', 1);

define('FILTER_OPTION_ANY', 0);

/**
 *
 * @uses planTCNavigator.php
 */
define('FILTER_BY_BUILD_OFF', 0);
define('FILTER_BY_OWNER_OFF', 0);
define('FILTER_BY_TC_STATUS_OFF', null);
define('FILTER_BY_KEYWORD_OFF', null);
define('FILTER_BY_ASSIGNED_TO_OFF', 0);
define('SEARCH_BY_CUSTOM_FIELDS_OFF', null);
define('COLOR_BY_TC_STATUS_OFF', null);
define('CREATE_TC_STATUS_COUNTERS_OFF', 0);

// moved from testSetRemove.php
define('WRITE_BUTTON_ONLY_IF_LINKED', 1);

// moved from tc_exec_assignment.php
define('FILTER_BY_TC_OFF', null);
define('FILTER_BY_EXECUTE_STATUS_OFF', null);
define('ALL_USERS_FILTER', null);
define('ADD_BLANK_OPTION', true);

//
define('FILTER_BY_SHOW_ON_EXECUTION', 1);

define('GET_ALSO_NOT_EXECUTED', null);
define('GET_ONLY_EXECUTED', 'executed');

// generateTestSpecTree()
define('FOR_PRINTING', 1);
define('NOT_FOR_PRINTING', 0);

define('HIDE_TESTCASES', 1);
define('SHOW_TESTCASES', 0);
define('FILTER_INACTIVE_TESTCASES', 1);
define('DO_NOT_FILTER_INACTIVE_TESTCASES', 0);

define('ACTION_TESTCASE_DISABLE', 0);
define('IGNORE_INACTIVE_TESTCASES', 1);
define('IGNORE_ACTIVE_TESTCASES', 2);

define('DO_ON_TESTCASE_CLICK', 1);
define('NO_ADDITIONAL_ARGS', '');
define('NO_KEYWORD_ID_TO_FILTER', 0);

define('RECURSIVE_MODE', true);
define('NO_NODE_TYPE_TO_FILTER', null);
define('ANY_OWNER', null);

define('ALL_BUILDS', 'a');
define('ALL_PLATFORMS', 'a');
define('ALL_TEST_SUITES', 'all');

/**
 *
 * @todo use consts ACTIVE || INACTIVE, OPEN || CLOSED
 */
define('GET_ACTIVE_BUILD', 1);
define('GET_INACTIVE_BUILD', 0);
define('GET_OPEN_BUILD', 1);
define('GET_CLOSED_BUILD', 0);

define('AUTOMATIC_ID', 0);
define('NO_FILTER_SHOW_ON_EXEC', null);
define('DONT_REFRESH', 0);
define('DEFAULT_TC_ORDER', 0);

// bug_interface->buildViewBugLink()
define('GET_BUG_SUMMARY', true);

// gen_spec_view()
define('DO_PRUNE', 1);

// executeTestCase()
define('AUTOMATION_RESULT_KO', - 1);
define('AUTOMATION_NOTES_KO', - 1);

define('REMOVEME', 'd8ba8cfb-ca92-4fa5-83c2-551977d405fb');

/**
 * Constants for plugins
 */
/**
 * Plugin configuration types
 */
define('CONFIG_TYPE_STRING', 0);
define('CONFIG_TYPE_INT', 1);
define('CONFIG_TYPE_FLOAT', 2);
define('CONFIG_TYPE_COMPLEX', 3);

/**
 * To indicate the plugin configuration belongs to ANY PROJECT
 */
define('TL_ANY_PROJECT', - 1);

/**
 * Constants for events
 */
define('EVENT_TYPE_CREATE', 1);
define('EVENT_TYPE_UPDATE', 2);
define('EVENT_TYPE_DELETE', 3);
define('EVENT_TYPE_OUTPUT', 4);

// ---------------------------------------------------------------------------------
/* [GUI] */

/**
 *
 * @uses planAddTC_m1-tpl
 *
 */
define('TL_STYLE_FOR_ADDED_TC', 'background-color:yellow;');

/**
 * Browser Cookie keeptime
 */
define('TL_COOKIE_KEEPTIME', (time() + 60 * 60 * 24 * 30)); // 30 days

// needed for drap and drop feature
define('TL_DRAG_DROP_DIR', 'gui/drag_and_drop/');
define('TL_DRAG_DROP_JS_DIR', TL_DRAG_DROP_DIR . 'js/');
define('TL_DRAG_DROP_FOLDER_CSS',
    TL_DRAG_DROP_DIR . 'css/drag-drop-folder-tree.css');
define('TL_DRAG_DROP_CONTEXT_MENU_CSS',
    TL_DRAG_DROP_DIR . 'css/context-menu.css');

/**
 * Mark up inactive objects (test projects, etc) in GUI lists
 */
define('TL_INACTIVE_MARKUP', '* ');

/** @var string Delimiter used when created a test suite path, concatenating test suite names */
$g_testsuite_sep = '/';

/**
 * using niftycorners
 *
 * @todo havlatm: move to smarty templates - configuration should not contain HTML elements
 */
define('MENU_ITEM_OPEN', '<div class="menu_bubble">');
define('MENU_ITEM_CLOSE', '</div><br />');

/**
 * Used to force the max len of this field, during the automatic creation of requirements
 * or other import features
 */
$g_field_size = new stdClass();
$g_field_size->node_name = 100;
$g_field_size->testsuite_name = 100;
$g_field_size->testcase_name = 100;
$g_field_size->testproject_name = 100;

// requirements and req_spec tables field sizes
$g_field_size->req_docid = 64;
$g_field_size->req_title = 100;
$g_field_size->requirement_title = 100;
$g_field_size->docid = 64;

// execution table
$g_field_size->bug_id = 16;

// --------------------------------------------------------------------------------------
/* [LOCALIZATION] */

/**
 * String that will used as prefix, to generate an string when a label to be localized
 * is passed to lang_get() to be translated, by the label is not present in the strings file.
 * The resulting string will be: TL_LOCALIZE_TAG . label
 *
 * @example code specifies the key of string: lang_get('hello') -> shows "LOCALIZE: Hello"
 */
define('TL_LOCALIZE_TAG', 'LOCALIZE: ');

/** @var string Default format of date */
$tlCfg->date_format = '%d/%m/%Y';

/** @var string Default format of datetime */
$tlCfg->timestamp_format = '%d/%m/%Y %H:%M:%S';

/**
 *
 * @var array List of supported localizations (used in user preferences to choose one)
 *      DEV: Please Maintain the alphabetical order when adding new locales.
 *      Also check inc.ext_js_tpl to set localization for ExtJS Components.
 */
$tlCfg->locales = array(
    'cs_CZ' => 'Czech',
    'de_DE' => 'German',
    'en_GB' => 'English (wide/UK)',
    'en_US' => 'English (US)',
    'es_AR' => 'Spanish (Argentine)',
    'es_ES' => 'Spanish',
    'fi_FI' => 'Finnish',
    'fr_FR' => 'Fran&ccedil;ais',
    'id_ID' => 'Indonesian',
    'it_IT' => 'Italian',
    'ja_JP' => 'Japanese',
    'ko_KR' => 'Korean',
    'nl_NL' => 'Dutch',
    'pl_PL' => 'Polski',
    'pt_BR' => 'Portuguese (Brazil)',
    'pt_PT' => 'Portuguese',
    'ru_RU' => 'Russian',
    'zh_CN' => 'Chinese Simplified'
);

/**
 * Format of date - see strftime() in PHP manual
 * NOTE: setting according local is done in testlinkInitPage() using setDateTimeFormats()
 */
/** @var array Localized format of date */
$tlCfg->locales_date_format = array(
    'cs_CZ' => '%d.%m.%Y',
    'de_DE' => '%d.%m.%Y',
    'en_GB' => '%d/%m/%Y',
    'en_US' => '%m/%d/%Y',
    'es_AR' => '%d/%m/%Y',
    'es_ES' => '%d/%m/%Y',
    'fi_FI' => '%d/%m/%Y',
    'fr_FR' => '%d/%m/%Y',
    'id_ID' => '%d/%m/%Y',
    'it_IT' => '%d/%m/%Y',
    'ja_JP' => '%Y/%m/%d',
    'ko_KR' => '%Y/%m/%d',
    'nl_NL' => '%d-%m-%Y',
    'pl_PL' => '%d.%m.%Y',
    'pt_BR' => '%d/%m/%Y',
    'pt_PT' => '%d/%m/%Y',
    'ru_RU' => '%d.%m.%Y',
    'zh_CN' => '%Y-%m-%d'
);

/** @var array Localized format of full timestamp */
$tlCfg->locales_timestamp_format = array(
    'cs_CZ' => '%d.%m.%Y %H:%M:%S',
    'de_DE' => '%d.%m.%Y %H:%M:%S',
    'en_GB' => '%d/%m/%Y %H:%M:%S',
    'en_US' => '%m/%d/%Y %H:%M:%S',
    'es_AR' => '%d/%m/%Y %H:%M:%S',
    'es_ES' => '%d/%m/%Y %H:%M:%S',
    'fi_FI' => '%d/%m/%Y %H:%M:%S',
    'fr_FR' => '%d/%m/%Y %H:%M:%S',
    'id_ID' => '%d/%m/%Y %H:%M:%S',
    'it_IT' => '%d/%m/%Y %H:%M:%S',
    'ja_JP' => '%Y/%m/%d %H:%M:%S',
    'ko_KR' => '%Y/%m/%d %H:%M:%S',
    'nl_NL' => '%d-%m-%Y %H:%M:%S',
    'pl_PL' => '%d.%m.%Y %H:%M:%S',
    'pt_BR' => '%d/%m/%Y %H:%M:%S',
    'pt_PT' => '%d/%m/%Y %H:%M:%S',
    'ru_RU' => '%d.%m.%Y %H:%M:%S',
    'zh_CN' => '%Y-%m-%d %H:%M:%S'
);

/**
 *
 * @var array localized date format for smarty templates (html_select_date function)
 *      deprecated since use of datepicker
 */
$tlCfg->locales_html_select_date_field_order = array(
    'cs_CZ' => 'dmY',
    'de_DE' => 'dmY',
    'en_GB' => 'dmY',
    'en_US' => 'mdY',
    'es_AR' => 'dmY',
    'es_ES' => 'dmY',
    'fi_FI' => 'dmY',
    'fr_FR' => 'dmY',
    'id_ID' => 'dmY',
    'it_IT' => 'dmY',
    'ja_JP' => 'Ymd',
    'ko_KR' => 'Ymd',
    'nl_NL' => 'dmY',
    'pl_PL' => 'dmY',
    'pt_BR' => 'dmY',
    'pt_PT' => 'dmY',
    'ru_RU' => 'dmY',
    'zh_CN' => 'Ymd'
);

// --------------------------------------------------------------------------------------
/* ATTACHMENTS */

/**
 * Attachment key constants (do not change)
 */
define('TL_REPOSITORY_TYPE_DB', 1);
define('TL_REPOSITORY_TYPE_FS', 2);

define('TL_REPOSITORY_COMPRESSIONTYPE_NONE', 1);
define('TL_REPOSITORY_COMPRESSIONTYPE_GZIP', 2);

// Two models to manage attachment interface in the execution screen
// $att_model_m1 -> shows upload button and title
//
$att_model_m1 = new stdClass();
$att_model_m2 = new stdClass();

$att_model_m1->show_upload_btn = true;
$att_model_m1->show_title = true;
$att_model_m1->num_cols = 4;
$att_model_m1->show_upload_column = false;

// $att_model_m2 -> hides upload button and title
//
$att_model_m2->show_upload_btn = false;
$att_model_m2->show_title = false;
$att_model_m2->num_cols = 5;
$att_model_m2->show_upload_column = true;

// --------------------------------------------------------------------------------------
/* [Test execution] */
/**
 * Note: do not change existing values (you can enhance arrays of course more into custom_config)
 * If you add new statuses, please use custom_strings.txt to add your localized strings
 */

/**
 * User can define own test status(es) by modifying
 * - $tlCfg->results['status_code'] (in custom_config.inc.php)
 * - $tlCfg->results['status_label'] (in custom_config.inc.php)
 * - $tlCfg->results['status_label_for_exec_ui'] (in custom_config.inc.php)
 * - $tlCfg->results['charts']['status_colour'] (in custom_config.inc.php)
 * - /locale/<your_language>/custom_strings.txt
 * - /gui/themes/default/css/custom.css
 *
 * DO NOT define Custom test status(es) in this file - use custom_config.inc.php
 */

/**
 *
 * @var array List of Test Case execution results (status_key -> DB code).
 *      The code is used in DB to store results (not GUI).
 *      Do not do localisation here, i.e do not change "passed" by your national language.
 */
$tlCfg->results['status_code'] = array(
    'failed' => 'f',
    'blocked' => 'b',
    'passed' => 'p',
    'not_run' => 'n',
    'not_available' => 'x',
    'unknown' => 'u',
    'all' => 'a'
);

/* for some reports */
$tlCfg->results['status_order'] = array(
    'not_run' => 'n',
    'passed' => 'p',
    'failed' => 'f',
    'blocked' => 'b'
);

/**
 * Used to get localized string to show to users
 * Order is important, because this will be display order on GUI
 *
 * @var array key: status ID
 *      value: id to use with lang_get() to get the string, from strings.txt (or custom_strings.txt)
 *
 * @example use the next code to get localized string of a status
 *          <code>
 *          $results_cfg = config_get('results');
 *          lang_get($results_cfg['status_label']["passed"]);
 *          </code>
 */
$tlCfg->results['status_label'] = array(
    'not_run' => 'test_status_not_run',
    'passed' => 'test_status_passed',
    'failed' => 'test_status_failed',
    'blocked' => 'test_status_blocked',
    'all' => 'test_status_all_status',
    'not_available' => 'test_status_not_available',
    'unknown' => 'test_status_unknown'
);

// Is RIGHT to have this configuration DIFFERENT from $tlCfg->results['status_label'],
// because you must choose to not allow some of previous status be available
// on execution page.
// See this as a subset of $tlCfg->results['status_label']
//
// Used to generate radio and buttons at user interface level.
//
// IMPORTANT NOTE ABOUT ORDER:
// Order is important, because this will be display order on User Interface
// And will be used on every feature that will need to do ordering
// according Test Case Execution Status.
//
//
// key => verbose status as defined in $tlCfg->results['status_code']
// value => string id defined in the strings.txt file,
// used to localize the strings.
//
$tlCfg->results['status_label_for_exec_ui'] = array(
    'not_run' => 'test_status_not_run',
    'passed' => 'test_status_passed',
    'failed' => 'test_status_failed',
    'blocked' => 'test_status_blocked'
);

$tlCfg->results['status_icons_for_exec_ui'] = array(
    'passed' => array(
        'img' => 'test_status_passed',
        'title' => 'click_passed'
    ),
    'failed' => array(
        'img' => 'test_status_failed',
        'title' => 'click_failed'
    ),
    'blocked' => array(
        'img' => 'test_status_blocked',
        'title' => 'click_blocked'
    )
);

$tlCfg->results['status_icons_for_exec_next_ui'] = array(
    'passed' => array(
        'img' => 'test_status_passed_next',
        'title' => 'click_passed_next'
    ),
    'failed' => array(
        'img' => 'test_status_failed_next',
        'title' => 'click_failed_next'
    ),
    'blocked' => array(
        'img' => 'test_status_blocked_next',
        'title' => 'click_blocked_next'
    )
);

$tlCfg->results['execStatusToExclude'] = array();
$tlCfg->results['execStatusToExclude']['testcase'] = array(
    $tlCfg->results['status_code']['all']
);

$tlCfg->results['execStatusToExclude']['step'] = array(
    $tlCfg->results['status_code']['all']
);

/**
 * Selected execution result by default.
 * Values is key from $tlCfg->results['status_label']
 *
 * @var string
 */
$tlCfg->results['default_status'] = 'not_run';

/**
 * Status colours for charts - use just RGB (not colour names)
 * Colours should be compiant with definition in CSS
 */
$tlCfg->results['charts']['status_colour'] = array(
    'not_run' => '000000',
    'passed' => '006400',
    'failed' => 'B22222',
    'blocked' => '00008B'
);

/*
 * arrays for new filter types (BUGID 2455, BUGID 3026)
 * used for testcase execution
 */
$tlCfg->execution_filter_methods['status_code'] = array(
    'latest_execution' => 1,
    'all_builds' => 2,
    'any_build' => 3,
    'specific_build' => 4,
    'current_build' => 5
);

$tlCfg->execution_filter_methods['status_label'] = array(
    'latest_execution' => 'filter_result_latest_execution',
    'all_builds' => 'filter_result_all_builds',
    'any_build' => 'filter_result_any_build',
    'specific_build' => 'filter_result_specific_build',
    'current_build' => 'filter_result_current_build'
);

$tlCfg->execution_filter_methods['default_type'] = $tlCfg->execution_filter_methods['status_code']['current_build'];

/*
 * same as above, but without current build
 * these are used for testcase execution assignment
 */
$tlCfg->execution_assignment_filter_methods['status_code'] = array(
    'latest_execution' => 1,
    'all_builds' => 2,
    'any_build' => 3,
    'specific_build' => 4
);

$tlCfg->execution_assignment_filter_methods['status_label'] = array(
    'latest_execution' => 'filter_result_latest_execution',
    'all_builds' => 'filter_result_all_builds',
    'any_build' => 'filter_result_any_build',
    'specific_build' => 'filter_result_specific_build'
);

// CRITIC NOTICE
// This values has to have certain coerence with
// $js_key_to_select on init_filter_result() in tlTestCaseFilterControl.class.php
//
$tlCfg->execution_assignment_filter_methods['default_type'] = $tlCfg->execution_assignment_filter_methods['status_code']['specific_build'];

// --------------------------------------------------------------------------------------
/* [Users & Roles] */

define('TL_USER_NOBODY', - 1);
define('TL_USER_SOMEBODY', - 2); // new user for new filtertypes in 2455 & 3026
define('TL_NO_USER', TL_USER_NOBODY);
define('TL_USER_ANYBODY', 0);

/**
 * Follows CODES present in roles table - DO NOT CHANGE ON ANY CIRCUNSTANCE
 */
define('TL_ROLES_MANAGER', 1);
define('TL_ROLES_ADMIN', 8);
define('TL_ROLES_LEADER', 9);
define('TL_ROLES_TESTER', 7);
define('TL_ROLES_GUEST', 5);
define('TL_ROLES_NO_RIGHTS', 3);
define('TL_ROLES_UNDEFINED', 0);
define('TL_ROLES_INHERITED', 0);

// Roles with id > to this role can be deleted from user interface
define('TL_LAST_SYSTEM_ROLE', 9);

// used on user management page to give different colour
// to different roles.
// If you don't want use colouring then configure in this way
// $g_role_colour = array ( );
$g_role_colour = array(
    'admin' => 'white',
    'tester' => 'wheat',
    'leader' => 'acqua',
    'senior tester' => '#FFA',
    'guest' => 'pink',
    'test designer' => 'cyan',
    '<no rights>' => 'grey',
    '<inherited>' => 'seashell'
);

// --------------------------------------------------------------------------------------
/**
 * LDAP authentication errors
 */
define('ERROR_LDAP_AUTH_FAILED', 1400);
define('ERROR_LDAP_SERVER_CONNECT_FAILED', 1401);
define('ERROR_LDAP_UPDATE_FAILED', 1402);
define('ERROR_LDAP_USER_NOT_FOUND', 1403);
define('ERROR_LDAP_BIND_FAILED', 1404);
define('ERROR_LDAP_START_TLS_FAILED', 1405);

// --------------------------------------------------------------------------------------
/* [Priority, Urgency, Importance] */

/** @var array importance levels */
$tlCfg->importance_levels = array(
    HIGH => 3,
    MEDIUM => 2,
    LOW => 1
);
$tlCfg->importance['code_label'] = array(
    HIGH => 'high',
    MEDIUM => 'medium',
    LOW => 'low'
);

/** @var integer Default Test case Importance offered in GUI */
$tlCfg->testcase_importance_default = MEDIUM;

/** @var integer Default Test case Urgency offered in GUI */
$tlCfg->testcase_urgency_default = MEDIUM;

/**
 *
 * @var array Used to get localized string to show to users
 *      key: numeric code
 *      value: id to use with lang_get() to get the string, from strings.txt (or custom_strings.txt)
 * @since 1.8
 */
$tlCfg->urgency['code_label'] = array(
    HIGH => 'urgency_high',
    MEDIUM => 'urgency_medium',
    LOW => 'urgency_low'
);

/* priority is calculated using importance and urgency */
$tlCfg->priority['code_label'] = array(
    HIGH => 'high_priority',
    MEDIUM => 'medium_priority',
    LOW => 'low_priority'
);

// --------------------------------------------------------------------------------------
/* [States & Review] */

define('TL_REL_TYPE_PARENT_CHILD', 1);
define('TL_REL_TYPE_BLOCKS_DEPENDS', 2);
define('TL_REL_TYPE_RELATED', 3);
define('TL_REL_TYPE_AUTOMATION_PARENT_CHILD', 4);
define('TL_REL_TYPE_EXECUTE_TOGETHER', 5);

/**
 * data status constants are applicable for data like requirement, test case, Test Plan
 *
 * @since 2.0
 */
/**
 * Review status: design phase; data are not available for review or using
 */
define('TL_REVIEW_STATUS_DRAFT', 1);

/**
 * Review status: data was reviewed and are available for using
 */
define('TL_REVIEW_STATUS_FINAL', 2);

/**
 * Review status: data wait for review
 */
define('TL_REVIEW_STATUS_REVIEW', 3);

/**
 * Review status: data are not applicable for using (not listed in reports and lists)
 */
define('TL_REVIEW_STATUS_OBSOLETE', 4);
define('TL_REVIEW_STATUS_FUTURE', 5);

/**
 *
 * @var array localization identifiers for review states
 * @since 2.0
 */
$tlCfg->text_status_labels = array(
    TL_REVIEW_STATUS_DRAFT => 'review_status_draft',
    TL_REVIEW_STATUS_FINAL => 'review_status_final',
    TL_REVIEW_STATUS_REVIEW => 'review_status_review',
    TL_REVIEW_STATUS_OBSOLETE => 'review_status_obsolete',
    TL_REVIEW_STATUS_FUTURE => 'review_status_future'
);

/**
 */
define('TL_REQ_STATUS_VALID', 'V');
define('TL_REQ_STATUS_NOT_TESTABLE', 'N');
define('TL_REQ_STATUS_DRAFT', 'D');
define('TL_REQ_STATUS_REVIEW', 'R');
define('TL_REQ_STATUS_REWORK', 'W');
define('TL_REQ_STATUS_FINISH', 'F');
define('TL_REQ_STATUS_IMPLEMENTED', 'I');
define('TL_REQ_STATUS_OBSOLETE', 'O');

// key: status; value: text label
$tlCfg->req_cfg = new stdClass();
$tlCfg->req_cfg->status_labels = array(
    TL_REQ_STATUS_DRAFT => 'req_status_draft',
    TL_REQ_STATUS_REVIEW => 'req_status_review',
    TL_REQ_STATUS_REWORK => 'req_status_rework',
    TL_REQ_STATUS_FINISH => 'req_status_finish',
    TL_REQ_STATUS_IMPLEMENTED => 'req_status_implemented',
    TL_REQ_STATUS_VALID => 'review_status_valid',
    TL_REQ_STATUS_NOT_TESTABLE => 'req_status_not_testable',
    TL_REQ_STATUS_OBSOLETE => 'req_status_obsolete'
);

/**
 * Types of requirements (with respect to standards)
 * <ul>
 * <li><b>Info</b> -informational character, project and user documentation.
 * The type is not testable = not used for testing logic (except metrics).</li>
 * <li><b>Feature</b> - valid and testable functional definition (default selection)</li>
 * <li><b>Use case</b></li>
 * <li><b>Interface</b> - user interface, communication protocols</li>
 * <li><b>Non-functional</b> - performance, infrastructure, robustness, security, safety, etc.</li>
 * <li><b>Constrain</b> - Constraints and Limitations</li>
 * </ul>
 *
 * CRITIC: DO NOT REMOVE ANY OF THIS CONSTANTS, BECAUSE TL EXPECT THIS TO BE DEFINED
 *
 * @since TestLink 1.9
 *
 *        IMPORTANT NOTICE: this value will be written on DB on field of type CHAR(1)
 */
define('TL_REQ_TYPE_INFO', '1');
define('TL_REQ_TYPE_FEATURE', '2');
define('TL_REQ_TYPE_USE_CASE', '3');
define('TL_REQ_TYPE_INTERFACE', '4');
define('TL_REQ_TYPE_NON_FUNCTIONAL', '5');
define('TL_REQ_TYPE_CONSTRAIN', '6');
define('TL_REQ_TYPE_SYSTEM_FUNCTION', '7');

/**
 *
 * @var array localization identifiers for requirements types
 * @since TestLink 1.9
 */
$tlCfg->req_cfg->type_labels = array(
    TL_REQ_TYPE_INFO => 'req_type_info',
    TL_REQ_TYPE_FEATURE => 'req_type_feature',
    TL_REQ_TYPE_USE_CASE => 'req_type_use_case',
    TL_REQ_TYPE_INTERFACE => 'req_type_interface',
    TL_REQ_TYPE_NON_FUNCTIONAL => 'req_type_non_functional',
    TL_REQ_TYPE_CONSTRAIN => 'req_type_constrain',
    TL_REQ_TYPE_SYSTEM_FUNCTION => 'req_type_system_function'
);

/**
 * All possible types of requirement relations (BUGID 1748).
 *
 * Important:
 * When you add your own relation types here, you also have to add localization strings
 * and configure those below.
 *
 * Add you types ONLY AFTER LAST RESERVED
 *
 * @since TestLink 1.9
 *
 *        IMPORTANT NOTICE this will be written on DB on an INT field
 */
define('TL_REQ_REL_TYPE_PARENT_CHILD', 1);
define('TL_REQ_REL_TYPE_BLOCKS_DEPENDS', 2);
define('TL_REQ_REL_TYPE_RELATED', 3);
define('TL_REQ_REL_TYPE_RESERVED_1', 4);
define('TL_REQ_REL_TYPE_RESERVED_2', 5);
define('TL_REQ_REL_TYPE_RESERVED_3', 6);
define('TL_REQ_REL_TYPE_RESERVED_4', 7);
define('TL_REQ_REL_TYPE_RESERVED_5', 8);
define('TL_REQ_REL_TYPE_RESERVED_6', 9);

/**
 * Localization identifiers for requirement relation types (BUGID 1748).
 * Types, which are configured above, have to be configured
 * here too with attributes "source" and "destination".
 *
 * Last value will be selected in GUI as default.
 *
 * Form has to be like this:
 *
 * $tlCfg->req_cfg->rel_type_labels = array(
 * RELATIONNAME => array(
 * 'source' => 'SOURCE_LOCALIZATION_KEY',
 * 'destination' => 'DESTINATION_LOCALIZATION_KEY'),
 * ...
 *
 * @since TestLink 1.9
 */
$tlCfg->req_cfg->rel_type_labels = array(
    TL_REQ_REL_TYPE_PARENT_CHILD => array(
        'source' => 'req_rel_is_parent_of',
        'destination' => 'req_rel_is_child_of'
    ),
    TL_REQ_REL_TYPE_BLOCKS_DEPENDS => array(
        'source' => 'req_rel_blocks',
        'destination' => 'req_rel_depends'
    ),
    TL_REQ_REL_TYPE_RELATED => array( // this is a flat relation, so strings are identical
        'source' => 'req_rel_is_related_to',
        'destination' => 'req_rel_is_related_to'
    )
);

$tlCfg->req_cfg->rel_type_description = array(
    TL_REQ_REL_TYPE_PARENT_CHILD => 'parent_child',
    TL_REQ_REL_TYPE_BLOCKS_DEPENDS => 'blocks_depends',
    TL_REQ_REL_TYPE_RELATED => 'related_to'
);

/**
 *
 * @var array controls is expected_coverage must be requested at user interface.
 *      following conditions (OR LOGIC) must be verified to request value:
 *
 *      a. key is NOT PRESENT (!isset())
 *      b. key is present with value TRUE
 *
 *      Working in this way configuration is simplified.
 *
 * @since TestLink 1.9
 */
$tlCfg->req_cfg->type_expected_coverage = array(
    TL_REQ_TYPE_INFO => false
);

// IMPORTANT NOTICE: this value will be written on DB on field of type CHAR(1)
define('TL_REQ_SPEC_TYPE_SECTION', '1');
define('TL_REQ_SPEC_TYPE_USER_REQ_SPEC', '2');
define('TL_REQ_SPEC_TYPE_SYSTEM_REQ_SPEC', '3');

// define('TL_REQ_SPEC_TYPE_FUNCTIONAL_AND_DATA', 1);
// define('TL_REQ_SPEC_TYPE_LOOK_AND_FEEL',2);
// define('TL_REQ_SPEC_TYPE_USABILITY_AND_HUMANITY',3);
// define('TL_REQ_SPEC_TYPE_PERFORMANCE',4);
// define('TL_REQ_SPEC_TYPE_OPERATIONAL_AND_ENVIRONMENTAL',5);
// define('TL_REQ_SPEC_TYPE_MAINTAINABILITY_AND_SUPPORT',6);
// define('TL_REQ_SPEC_TYPE_SECURITY',7);
// define('TL_REQ_SPEC_TYPE_CULTURAL_AND_POLITICAL',8);
// define('TL_REQ_SPEC_TYPE_LEGAL',9);

$tlCfg->req_spec_cfg = new stdClass();
$tlCfg->req_spec_cfg->type_labels = array(
    TL_REQ_SPEC_TYPE_SECTION => 'req_spec_type_section',
    TL_REQ_SPEC_TYPE_USER_REQ_SPEC => 'req_spec_type_user_req_spec',
    TL_REQ_SPEC_TYPE_SYSTEM_REQ_SPEC => 'req_spec_type_system_req_spec'
);

/**
 *
 * @deprecated 1.9
 * @todo havlatm: replace by $tlCfg->req_cfg->type_labels
 */
define('TL_REQ_TYPE_1', 'V');
define('TL_REQ_TYPE_2', 'N');
define('NON_TESTABLE_REQ', 'n');
define('VALID_REQ', 'v');

// --------------------------------------------------------------------------------------
/* [CUSTOM FIELDS] */

// /**
// * Custom field constrains for HTML inputs use values to created to get/show custom field contents
// * <ul>
// * <li>for string,numeric,float,email: size & maxlenght of the input type text.</li>
// * <li>for list,email size of the select input.</li>
// * </ul>
// */
// $tlCfg->gui->custom_fields->sizes = array(
// 'string' => 50,
// 'numeric'=> 10,
// 'float' => 10,
// 'email' => 50,
// 'list' => 1,
// 'multiselection list' => 5,
// 'text area' => array('cols' => 40, 'rows' => 6)
// );

// 20080815 - franciscom
// Use this variable (on custom_config.inc.php) to define new Custom Field types.
// IMPORTANT:
// check $custom_field_types property on cfield_mgr.class.php
// to avoid overwrite of standard types.
//
// $tlCfg->gui->custom_fields->types = null;

// Use this variable (on custom_config.inc.php)
// to define possible values behaviour for new Custom Field types.
//
// IMPORTANT:
// check $possible_values_cfg property on cfield_mgr.class.php
// to avoid overwrite of standard values.
//
// $tlCfg->gui->custom_fields->possible_values_cfg = null;

// Format string follows date() spec - see PHP Manual
// We can not use $g_timestamp_format, because format strings for date() and strftime()
// uses same LETTER with different meanings (Bad Luck!)
$tlCfg->gui = new stdClass();
$tlCfg->gui->custom_fields = new stdClass();
$tlCfg->gui->custom_fields->time_format = 'H:i:s';

// --------------------------------------------------------------------------------------
/* [MISC] */

/**
 * Review types - user can define type for his review comment (disabled by default)
 *
 * @since TestLink version 2.0
 */
$tlCfg->review_types = array(
    1 => 'undefined',
    2 => 'typo',
    3 => 'recommendation',
    4 => 'question',
    5 => 'unclear',
    6 => 'major problem'
);

/**
 * Top Menu definition
 *
 * structure
 * - label: label to display, will be localized
 * - url: resource to access when users click on menu item
 * - right: user right need to display menu item. (can be an array)
 * null => no right check needed
 * - condition: specific condition = ['','TestPlanAvailable','ReqMgmtEnabled']
 * - shortcut: keyboard HTML shortcut
 * - target: window/frame name (mainframe in the most of cases)
 * - imgKey
 *
 * @since TestLink version 1.9
 */
$tlCfg->guiTopMenu[1] = array(
    'label' => 'home',
    'url' => 'index.php',
    'right' => null,
    'imgKey' => 'home',
    'condition' => '',
    'shortcut' => 'h',
    'target' => '_parent'
);

$tlCfg->guiTopMenu[2] = array(
    'label' => 'title_requirements',
    'imgKey' => 'requirements',
    'url' => 'lib/general/frmWorkArea.php?feature=reqSpecMgmt',
    'right' => array(
        'mgt_view_req',
        'mgt_modify_req'
    ),
    'condition' => 'ReqMgmtEnabled',
    'shortcut' => 'r',
    'target' => 'mainframe'
);

$tlCfg->guiTopMenu[3] = array(
    'label' => 'title_specification',
    'imgKey' => 'test_specification',
    'url' => 'lib/general/frmWorkArea.php?feature=editTc',
    'right' => array(
        'mgt_view_tc',
        'mgt_modify_tc'
    ),
    'condition' => '',
    'shortcut' => 't',
    'target' => 'mainframe'
);

$tlCfg->guiTopMenu[4] = array(
    'label' => 'title_execute',
    'imgKey' => 'execution',
    'url' => 'lib/general/frmWorkArea.php?feature=executeTest',
    'right' => array(
        'testplan_execute',
        'exec_ro_access'
    ),
    'condition' => 'TestPlanAvailable',
    'shortcut' => 'e',
    'target' => 'mainframe'
);

$tlCfg->guiTopMenu[5] = array(
    'label' => 'title_results',
    'imgKey' => 'report',
    'url' => 'lib/general/frmWorkArea.php?feature=showMetrics',
    'right' => 'testplan_metrics',
    'condition' => 'TestPlanAvailable',
    'shortcut' => 'r',
    'target' => 'mainframe'
);

$tlCfg->guiTopMenu[6] = array(
    'label' => 'title_admin',
    'imgKey' => 'user',
    'url' => 'lib/usermanagement/usersView.php',
    'right' => 'mgt_users',
    'condition' => '',
    'shortcut' => 'u',
    'target' => 'mainframe'
);

$tlCfg->guiTopMenu[7] = array(
    'label' => 'title_events',
    'imgKey' => 'events',
    'url' => 'lib/events/eventviewer.php',
    'right' => array(
        'events_mgt',
        'mgt_view_events'
    ),
    'condition' => '',
    'shortcut' => 'v',
    'target' => 'mainframe'
);
$tlCfg->guiTopMenu[8] = array(
    'label' => 'title_plugins',
    'imgKey' => 'plugins',
    'url' => 'lib/plugins/pluginView.php',
    'right' => array(
        'mgt_plugins'
    ),
    'condition' => '',
    'shortcut' => 'p',
    'target' => 'mainframe'
);

define('PARTIAL_URL_TL_FILE_FORMATS_DOCUMENT', 'docs/tl-file-formats.pdf');

// Configure Charts dimension
$tlCfg->results['charts']['dimensions'] = array(
    'topLevelSuitesBarChart' => array(
        'chartTitle' => 'results_top_level_suites',
        'XSize' => 900,
        'YSize' => 400,
        'beginX' => 40,
        'beginY' => 100,
        'legendXAngle' => 35
    ),
    'keywordBarChart' => array(
        'chartTitle' => 'results_by_keyword',
        'XSize' => 900,
        'YSize' => 400,
        'beginX' => 40,
        'beginY' => 100,
        'legendXAngle' => 25
    ),
    'ownerBarChart' => array(
        'chartTitle' => 'results_by_tester',
        'XSize' => 900,
        'YSize' => 400,
        'beginX' => 40,
        'beginY' => 100,
        'legendXAngle' => 35
    ),
    'overallPieChart' => array(
        'chartTitle' => 'results_by_tester',
        'XSize' => 400,
        'YSize' => 400,
        'radius' => 150,
        'legendX' => 10,
        'legendY' => 15
    ),
    'platformPieChart' => array(
        'chartTitle' => 'results_by_tester',
        'XSize' => 400,
        'YSize' => 400,
        'radius' => 150,
        'legendX' => 10,
        'legendY' => 15
    )
);

// if you need to define new one, start on 20 please.
// see strings.txt for labels
// $TLS_testCaseStatus_KEY => $TLS_testCaseStatus_draft
//
$tlCfg->testCaseStatus = array(
    'draft' => 1,
    'readyForReview' => 2,
    'reviewInProgress' => 3,
    'rework' => 4,
    'obsolete' => 5,
    'future' => 6,
    'final' => 7
);

// see strings.txt for labels
// $TLS_testCaseStatus_hint_KEY => $TLS_testCaseStatus_hint_draft
//
$tlCfg->testCaseStatusDisplayHintOnTestDesign = [
    'draft' => '' /* 'testCaseStatus_hint_draft' */,
                                                 'readyForReview' => '',
    'reviewInProgress' => '',
    'rework' => '',
    'obsolete' => 'testCaseStatus_hint_obsolete',
    'future' => '',
    'final' => ''
];
// -----------------------------------------------------------------------------------------

/**
 *
 * @uses testcase.class.php
 */
// if you need to define new one, start on 20 please.
// see strings.txt for labels
// $TLS_execution_type_KEY => $TLS_execution_type_manual
$tlCfg->execution_type = array(
    'manual' => 1,
    'auto' => 2
);

// To be removed
define('TESTCASE_EXECUTION_TYPE_MANUAL', $tlCfg->execution_type['manual']);
define('TESTCASE_EXECUTION_TYPE_AUTO', $tlCfg->execution_type['auto']);

// for link_status field on req_coverage table
define('LINK_TC_REQ_OPEN', 1);
define('LINK_TC_REQ_CLOSED_BY_EXEC', 2);
define('LINK_TC_REQ_CLOSED_BY_NEW_TCVERSION', 3);
define('LINK_TC_REQ_CLOSED_BY_NEW_REQVERSION', 4);

// for link_status field on testcase_relations table
define('LINK_TC_RELATION_OPEN', 1);
define('LINK_TC_RELATION_CLOSED_BY_EXEC', 2);
define('LINK_TC_RELATION_CLOSED_BY_NEW_TCVERSION', 3);

define('USE_LATEST_EXEC_ON_CONTEX_FOR_COUNTERS', 1);
define('USE_LATEST_EXEC_ON_TESTPLAN_FOR_COUNTERS', 2);
define('USE_LATEST_EXEC_ON_TESTPLAN_PLAT_FOR_COUNTERS', 3);


// END