# This Source Code Form is subject to the terms of the Mozilla Public # License, v. 2.0. If a copy of the MPL was not distributed with this # file, You can obtain one at http://mozilla.org/MPL/2.0/. # # This Source Code Form is "Incompatible With Secondary Licenses", as # defined by the Mozilla Public License, v. 2.0. package Bugzilla::Constants; use 5.14.0; use strict; use warnings; use parent qw(Exporter); # For bz_locations use File::Basename; use Memoize; @Bugzilla::Constants::EXPORT = qw( BUGZILLA_VERSION REST_DOC REMOTE_FILE LOCAL_FILE bz_locations CONCATENATE_ASSETS IS_NULL NOT_NULL CONTROLMAPNA CONTROLMAPSHOWN CONTROLMAPDEFAULT CONTROLMAPMANDATORY AUTH_OK AUTH_NODATA AUTH_ERROR AUTH_LOGINFAILED AUTH_DISABLED AUTH_NO_SUCH_USER AUTH_LOCKOUT USER_PASSWORD_MIN_LENGTH LOGIN_OPTIONAL LOGIN_NORMAL LOGIN_REQUIRED LOGOUT_ALL LOGOUT_CURRENT LOGOUT_KEEP_CURRENT GRANT_DIRECT GRANT_REGEXP GROUP_MEMBERSHIP GROUP_BLESS GROUP_VISIBLE MAILTO_USER MAILTO_GROUP DEFAULT_COLUMN_LIST DEFAULT_QUERY_NAME DEFAULT_MILESTONE SAVE_NUM_SEARCHES COMMENT_COLS MAX_COMMENT_LENGTH MIN_COMMENT_TAG_LENGTH MAX_COMMENT_TAG_LENGTH CMT_NORMAL CMT_DUPE_OF CMT_HAS_DUPE CMT_ATTACHMENT_CREATED CMT_ATTACHMENT_UPDATED THROW_ERROR RELATIONSHIPS REL_ASSIGNEE REL_QA REL_REPORTER REL_CC REL_GLOBAL_WATCHER REL_ANY POS_EVENTS EVT_OTHER EVT_ADDED_REMOVED EVT_COMMENT EVT_ATTACHMENT EVT_ATTACHMENT_DATA EVT_PROJ_MANAGEMENT EVT_OPENED_CLOSED EVT_KEYWORD EVT_CC EVT_DEPEND_BLOCK EVT_BUG_CREATED EVT_COMPONENT NEG_EVENTS EVT_UNCONFIRMED EVT_CHANGED_BY_ME EVT_MINOR_UPDATE GLOBAL_EVENTS EVT_FLAG_REQUESTED EVT_REQUESTED_FLAG ADMIN_GROUP_NAME PER_PRODUCT_PRIVILEGES SENDMAIL_EXE SENDMAIL_PATH FIELD_TYPE_UNKNOWN FIELD_TYPE_FREETEXT FIELD_TYPE_SINGLE_SELECT FIELD_TYPE_MULTI_SELECT FIELD_TYPE_TEXTAREA FIELD_TYPE_DATETIME FIELD_TYPE_DATE FIELD_TYPE_BUG_ID FIELD_TYPE_BUG_URLS FIELD_TYPE_KEYWORDS FIELD_TYPE_INTEGER FIELD_TYPE_HIGHEST_PLUS_ONE EMPTY_DATETIME_REGEX ABNORMAL_SELECTS TIMETRACKING_FIELDS USAGE_MODE_BROWSER USAGE_MODE_CMDLINE USAGE_MODE_XMLRPC USAGE_MODE_EMAIL USAGE_MODE_JSON USAGE_MODE_TEST USAGE_MODE_REST ERROR_MODE_WEBPAGE ERROR_MODE_DIE ERROR_MODE_DIE_SOAP_FAULT ERROR_MODE_JSON_RPC ERROR_MODE_TEST ERROR_MODE_REST COLOR_ERROR COLOR_SUCCESS INSTALLATION_MODE_INTERACTIVE INSTALLATION_MODE_NON_INTERACTIVE DB_MODULE ROOT_USER ON_WINDOWS ON_ACTIVESTATE MAX_TOKEN_AGE MAX_LOGINCOOKIE_AGE MAX_SUDO_TOKEN_AGE MAX_LOGIN_ATTEMPTS LOGIN_LOCKOUT_INTERVAL ACCOUNT_CHANGE_INTERVAL MAX_STS_AGE SAFE_PROTOCOLS LEGAL_CONTENT_TYPES MIN_SMALLINT MAX_SMALLINT MAX_INT_32 MAX_LEN_QUERY_NAME MAX_CLASSIFICATION_SIZE MAX_PRODUCT_SIZE MAX_MILESTONE_SIZE MAX_COMPONENT_SIZE MAX_FIELD_VALUE_SIZE MAX_FIELD_LONG_DESC_LENGTH MAX_FREETEXT_LENGTH MAX_BUG_URL_LENGTH MAX_POSSIBLE_DUPLICATES MAX_ATTACH_FILENAME_LENGTH MAX_QUIP_LENGTH MAX_WEBDOT_BUGS PASSWORD_DIGEST_ALGORITHM PASSWORD_SALT_LENGTH CGI_URI_LIMIT PRIVILEGES_REQUIRED_NONE PRIVILEGES_REQUIRED_REPORTER PRIVILEGES_REQUIRED_ASSIGNEE PRIVILEGES_REQUIRED_EMPOWERED AUDIT_CREATE AUDIT_REMOVE MOST_FREQUENT_THRESHOLD MARKDOWN_TAB_WIDTH EMAIL_LIMIT_PER_MINUTE EMAIL_LIMIT_PER_HOUR EMAIL_LIMIT_EXCEPTION JOB_QUEUE_VIEW_MAX_JOBS ); @Bugzilla::Constants::EXPORT_OK = qw(contenttypes); # CONSTANTS # # Bugzilla version use constant BUGZILLA_VERSION => "5.1"; # A base link to the current REST Documentation. We place it here # as it will need to be updated to whatever the current release is. use constant REST_DOC => 'https://bugzilla.readthedocs.org/en/latest/api/'; # Location of the remote and local XML files to track new releases. use constant REMOTE_FILE => 'http://updates.bugzilla.org/bugzilla-update.xml'; use constant LOCAL_FILE => 'bugzilla-update.xml'; # Relative to datadir. # When true CSS and JavaScript assets will be concatanted and minified at # run-time, to reduce the number of requests required to render a page. # Setting this to a false value can help debugging. use constant CONCATENATE_ASSETS => 1; # These are unique values that are unlikely to match a string or a number, # to be used in criteria for match() functions and other things. They start # and end with spaces because most Bugzilla stuff has trim() called on it, # so this is unlikely to match anything we get out of the DB. # # We can't use a reference, because Template Toolkit doesn't work with # them properly (constants.IS_NULL => {} just returns an empty string instead # of the reference). use constant IS_NULL => ' __IS_NULL__ '; use constant NOT_NULL => ' __NOT_NULL__ '; # # ControlMap constants for group_control_map. # membercontol:othercontrol => meaning # Na:Na => Bugs in this product may not be restricted to this # group. # Shown:Na => Members of the group may restrict bugs # in this product to this group. # Shown:Shown => Members of the group may restrict bugs # in this product to this group. # Anyone who can enter bugs in this product may initially # restrict bugs in this product to this group. # Shown:Mandatory => Members of the group may restrict bugs # in this product to this group. # Non-members who can enter bug in this product # will be forced to restrict it. # Default:Na => Members of the group may restrict bugs in this # product to this group and do so by default. # Default:Default => Members of the group may restrict bugs in this # product to this group and do so by default and # nonmembers have this option on entry. # Default:Mandatory => Members of the group may restrict bugs in this # product to this group and do so by default. # Non-members who can enter bug in this product # will be forced to restrict it. # Mandatory:Mandatory => Bug will be forced into this group regardless. # All other combinations are illegal. use constant CONTROLMAPNA => 0; use constant CONTROLMAPSHOWN => 1; use constant CONTROLMAPDEFAULT => 2; use constant CONTROLMAPMANDATORY => 3; # See Bugzilla::Auth for docs on AUTH_*, LOGIN_* and LOGOUT_* use constant AUTH_OK => 0; use constant AUTH_NODATA => 1; use constant AUTH_ERROR => 2; use constant AUTH_LOGINFAILED => 3; use constant AUTH_DISABLED => 4; use constant AUTH_NO_SUCH_USER => 5; use constant AUTH_LOCKOUT => 6; # The minimum length a password must have. use constant USER_PASSWORD_MIN_LENGTH => 6; use constant LOGIN_OPTIONAL => 0; use constant LOGIN_NORMAL => 1; use constant LOGIN_REQUIRED => 2; use constant LOGOUT_ALL => 0; use constant LOGOUT_CURRENT => 1; use constant LOGOUT_KEEP_CURRENT => 2; use constant GRANT_DIRECT => 0; use constant GRANT_REGEXP => 2; use constant GROUP_MEMBERSHIP => 0; use constant GROUP_BLESS => 1; use constant GROUP_VISIBLE => 2; use constant MAILTO_USER => 0; use constant MAILTO_GROUP => 1; # The default list of columns for buglist.cgi use constant DEFAULT_COLUMN_LIST => ( "product", "component", "assigned_to", "bug_status", "resolution", "short_desc", "changeddate" ); # Used by query.cgi and buglist.cgi as the named-query name # for the default settings. use constant DEFAULT_QUERY_NAME => '(Default query)'; # The default "defaultmilestone" created for products. use constant DEFAULT_MILESTONE => '---'; # How many of the user's most recent searches to save. use constant SAVE_NUM_SEARCHES => 10; # The column width for comment textareas and comments in bugmails. use constant COMMENT_COLS => 80; # Used in _check_comment(). Gives the max length allowed for a comment. use constant MAX_COMMENT_LENGTH => 65535; # The minimum and maximum length of comment tags. use constant MIN_COMMENT_TAG_LENGTH => 3; use constant MAX_COMMENT_TAG_LENGTH => 24; # The type of bug comments. use constant CMT_NORMAL => 0; use constant CMT_DUPE_OF => 1; use constant CMT_HAS_DUPE => 2; # Type 3 was CMT_POPULAR_VOTES, which moved to the Voting extension. # Type 4 was CMT_MOVED_TO, which moved to the OldBugMove extension. use constant CMT_ATTACHMENT_CREATED => 5; use constant CMT_ATTACHMENT_UPDATED => 6; # Determine whether a validation routine should return 0 or throw # an error when the validation fails. use constant THROW_ERROR => 1; use constant REL_ASSIGNEE => 0; use constant REL_QA => 1; use constant REL_REPORTER => 2; use constant REL_CC => 3; # REL 4 was REL_VOTER, before it was moved ino an extension. use constant REL_GLOBAL_WATCHER => 5; # We need these strings for the X-Bugzilla-Reasons header # Note: this hash uses "," rather than "=>" to avoid auto-quoting of the LHS. # This should be accessed through Bugzilla::BugMail::relationships() instead # of being accessed directly. use constant RELATIONSHIPS => { REL_ASSIGNEE , "AssignedTo", REL_REPORTER , "Reporter", REL_QA , "QAcontact", REL_CC , "CC", REL_GLOBAL_WATCHER, "GlobalWatcher" }; # Used for global events like EVT_FLAG_REQUESTED use constant REL_ANY => 100; # There are two sorts of event - positive and negative. Positive events are # those for which the user says "I want mail if this happens." Negative events # are those for which the user says "I don't want mail if this happens." # # Exactly when each event fires is defined in wants_bug_mail() in User.pm; I'm # not commenting them here in case the comments and the code get out of sync. use constant EVT_OTHER => 0; use constant EVT_ADDED_REMOVED => 1; use constant EVT_COMMENT => 2; use constant EVT_ATTACHMENT => 3; use constant EVT_ATTACHMENT_DATA => 4; use constant EVT_PROJ_MANAGEMENT => 5; use constant EVT_OPENED_CLOSED => 6; use constant EVT_KEYWORD => 7; use constant EVT_CC => 8; use constant EVT_DEPEND_BLOCK => 9; use constant EVT_BUG_CREATED => 10; use constant EVT_COMPONENT => 11; use constant POS_EVENTS => EVT_OTHER, EVT_ADDED_REMOVED, EVT_COMMENT, EVT_ATTACHMENT, EVT_ATTACHMENT_DATA, EVT_PROJ_MANAGEMENT, EVT_OPENED_CLOSED, EVT_KEYWORD, EVT_CC, EVT_DEPEND_BLOCK, EVT_BUG_CREATED, EVT_COMPONENT; use constant EVT_UNCONFIRMED => 50; use constant EVT_CHANGED_BY_ME => 51; use constant EVT_MINOR_UPDATE => 52; use constant NEG_EVENTS => EVT_UNCONFIRMED, EVT_CHANGED_BY_ME, EVT_MINOR_UPDATE; # These are the "global" flags, which aren't tied to a particular relationship. # and so use REL_ANY. use constant EVT_FLAG_REQUESTED => 100; # Flag has been requested of me use constant EVT_REQUESTED_FLAG => 101; # I have requested a flag use constant GLOBAL_EVENTS => EVT_FLAG_REQUESTED, EVT_REQUESTED_FLAG; # Default administration group name. use constant ADMIN_GROUP_NAME => 'admin'; # Privileges which can be per-product. use constant PER_PRODUCT_PRIVILEGES => ('editcomponents', 'editbugs', 'canconfirm'); # Path to sendmail.exe (Windows only) use constant SENDMAIL_EXE => '/usr/lib/sendmail.exe'; # Paths to search for the sendmail binary (non-Windows) use constant SENDMAIL_PATH => '/usr/lib:/usr/sbin:/usr/ucblib'; # Field types. Match values in fielddefs.type column. These are purposely # not named after database column types, since Bugzilla fields comprise not # only storage but also logic. For example, we might add a "user" field type # whose values are stored in an integer column in the database but for which # we do more than we would do for a standard integer type (f.e. we might # display a user picker). use constant FIELD_TYPE_UNKNOWN => 0; use constant FIELD_TYPE_FREETEXT => 1; use constant FIELD_TYPE_SINGLE_SELECT => 2; use constant FIELD_TYPE_MULTI_SELECT => 3; use constant FIELD_TYPE_TEXTAREA => 4; use constant FIELD_TYPE_DATETIME => 5; use constant FIELD_TYPE_BUG_ID => 6; use constant FIELD_TYPE_BUG_URLS => 7; use constant FIELD_TYPE_KEYWORDS => 8; use constant FIELD_TYPE_DATE => 9; use constant FIELD_TYPE_INTEGER => 10; # Add new field types above this line, and change the below value in the # obvious fashion use constant FIELD_TYPE_HIGHEST_PLUS_ONE => 11; use constant EMPTY_DATETIME_REGEX => qr/^[0\-:\sA-Za-z]+$/; # See the POD for Bugzilla::Field/is_abnormal to see why these are listed # here. use constant ABNORMAL_SELECTS => { classification => 1, component => 1, product => 1, }; # The fields from fielddefs that are blocked from non-timetracking users. # work_time is sometimes called actual_time. use constant TIMETRACKING_FIELDS => qw(estimated_time remaining_time work_time actual_time percentage_complete); # The maximum number of days a token will remain valid. use constant MAX_TOKEN_AGE => 3; # How many days a logincookie will remain valid if not used. use constant MAX_LOGINCOOKIE_AGE => 30; # How many seconds (default is 6 hours) a sudo cookie remains valid. use constant MAX_SUDO_TOKEN_AGE => 21600; # Maximum failed logins to lock account for this IP use constant MAX_LOGIN_ATTEMPTS => 5; # If the maximum login attempts occur during this many minutes, the # account is locked. use constant LOGIN_LOCKOUT_INTERVAL => 30; # The time in minutes a user must wait before they can request another email to # create a new account or change their password. use constant ACCOUNT_CHANGE_INTERVAL => 10; # The maximum number of seconds the Strict-Transport-Security header # will remain valid. Default is one week. use constant MAX_STS_AGE => 604800; # Protocols which are considered as safe. use constant SAFE_PROTOCOLS => ('afs', 'cid', 'ftp', 'gopher', 'http', 'https', 'irc', 'ircs', 'mid', 'news', 'nntp', 'prospero', 'telnet', 'view-source', 'wais'); # Valid MIME types for attachments. use constant LEGAL_CONTENT_TYPES => ('application', 'audio', 'image', 'message', 'model', 'multipart', 'text', 'video'); use constant contenttypes => { "html" => "text/html" , "rdf" => "application/rdf+xml" , "atom" => "application/atom+xml" , "xml" => "application/xml" , "dtd" => "application/xml-dtd" , "js" => "application/x-javascript" , "json" => "application/json" , "csv" => "text/csv" , "png" => "image/png" , "ics" => "text/calendar" , }; # Usage modes. Default USAGE_MODE_BROWSER. Use with Bugzilla->usage_mode. use constant USAGE_MODE_BROWSER => 0; use constant USAGE_MODE_CMDLINE => 1; use constant USAGE_MODE_XMLRPC => 2; use constant USAGE_MODE_EMAIL => 3; use constant USAGE_MODE_JSON => 4; use constant USAGE_MODE_TEST => 5; use constant USAGE_MODE_REST => 6; # Error modes. Default set by Bugzilla->usage_mode (so ERROR_MODE_WEBPAGE # usually). Use with Bugzilla->error_mode. use constant ERROR_MODE_WEBPAGE => 0; use constant ERROR_MODE_DIE => 1; use constant ERROR_MODE_DIE_SOAP_FAULT => 2; use constant ERROR_MODE_JSON_RPC => 3; use constant ERROR_MODE_TEST => 4; use constant ERROR_MODE_REST => 5; # The ANSI colors of messages that command-line scripts use use constant COLOR_ERROR => 'red'; use constant COLOR_SUCCESS => 'green'; # The various modes that checksetup.pl can run in. use constant INSTALLATION_MODE_INTERACTIVE => 0; use constant INSTALLATION_MODE_NON_INTERACTIVE => 1; # Data about what we require for different databases. use constant DB_MODULE => { # MySQL 5.0.15 was the first production 5.0.x release. mysql => { db => 'Bugzilla::DB::Mysql', db_version => '5.0.15', name => 'MySQL'}, pg => { db => 'Bugzilla::DB::Pg', db_version => '9.00.0000', name => 'PostgreSQL'}, oracle => { db => 'Bugzilla::DB::Oracle', db_version => '10.02.0', name => 'Oracle'}, # SQLite 3.6.22 fixes a WHERE clause problem that may affect us. sqlite => { db => 'Bugzilla::DB::Sqlite', db_version => '3.6.22', name => 'SQLite'}, }; # True if we're on Win32. use constant ON_WINDOWS => ($^O =~ /MSWin32/i) ? 1 : 0; # True if we're using ActiveState Perl (as opposed to Strawberry) on Windows. use constant ON_ACTIVESTATE => eval { &Win32::BuildNumber }; # The user who should be considered "root" when we're giving # instructions to Bugzilla administrators. use constant ROOT_USER => ON_WINDOWS ? 'Administrator' : 'root'; use constant MIN_SMALLINT => -32768; use constant MAX_SMALLINT => 32767; use constant MAX_INT_32 => 2147483647; # The longest that a saved search name can be. use constant MAX_LEN_QUERY_NAME => 64; # The longest classification name allowed. use constant MAX_CLASSIFICATION_SIZE => 64; # The longest product name allowed. use constant MAX_PRODUCT_SIZE => 64; # The longest milestone name allowed. use constant MAX_MILESTONE_SIZE => 64; # The longest component name allowed. use constant MAX_COMPONENT_SIZE => 64; # The maximum length for values of