constants.md

Constants

Luna's code makes use of constants in order to define certain set values that are used throughout the code (pre-defined constants) as well as for several configuration settings (user-defined constants).

Pre-defined constants

Pre-defined constants allow Luna to associate a value with a descriptive string in order to facilitate the common use of the value / simplify the process of changing that value throughout the code. A reference of such constants is provided below. The constants are grouped by the version of the software they exist in. They are given along with their value and a description of what they are/how to use them.

LUNA_UNVERIFIED

The group ID given to users when email verification of registrations is enabled.

LUNA_ADMIN

The group ID given to administrators.

LUNA_MOD

The group ID given to moderators. This is the default moderator group, but it is possible that it could be changed or other groups could have moderator permissions. Checking against this constant is no longer valid to confirm a group has moderator permissions. It has been left for backwards compatibility with modifications designed for Luna v1.2.

LUNA_GUEST

The group ID given to the Guest user.

LUNA_MEMBER

The group ID given to users in the default member group.

Version constants

The constants that are all related to the board's version numbers are located in the Version class, which is accessable from everywhere.

Version::LUNA_VERSION

The current version of Luna, identifies releases.

Version::LUNA_CORE_VERSION

The current core version of Luna, identifies builds.

Version::LUNA_CODE_NAME

The current version's codename.

Version::LUNA_CODE_NAME_SEM

The current version's code name written with capitals.

Version::LUNA_DB_VERSION

The current database structure version number (since not every new version changes the database).

Version::LUNA_PARSER_VERSION

The current parser version number (since not every new version changes the parser).

Version::LUNA_SI_VERSION

The current search index version number (since not every new version changes the search index).

Version::MIN_PHP_VERSION

The minimal required version of PHP.

Version::MIN_MYSQL_VERSION

The minimal required version of MySQL.

Version::MIN_PGSQL_VERSION

The minimal required version of PostgreSQL.

User-defined constants

Luna's code uses several constants that, when defined, modify its behavior. Most of these constants do not ever need to be used by the average user. However, some are useful for debugging and others are important for advanced users. A reference is provided below for those users who may want/need to use these constants. The constants are given along a description of what they do/how to use them.

All constants (with the exception of per-page constants, i.e. LUNA_ROOT) should be defined at the bottom of the configuration file (config.php).

LUNA_ROOT

LUNA_ROOT is the relative path from the current folder to the folder where the Luna code resides. You should never need to define this constant yourself unless you are writing pages that use Luna / integrating Luna with another piece of software.

define('LUNA_ROOT', './');
require LUNA_ROOT.'include/common.php';

LUNA_DEBUG

Defining LUNA_DEBUG enables debug mode, which makes Luna display more detailed/sensitive error messages. Script generation time and number of queries executed will also be shown in the footer. Debug mode should not be enabled on a production site, since it can potentially give a malicious user sensitive information about a server. However, enabling debug mode is an integral step to reporting/diagnosing forum errors. Without the information it provides, it can be nearly impossible for the developers to figure out the underlying cause of an issue.

define('LUNA_DEBUG', 1);

LUNA_SHOW_QUERIES

Defining LUNA_SHOW_QUERIES makes all the queries executed during a pageview display in the footer. This feature is only useful for developing and should never be used in a production environment because of the potential for disclosure of sensitive information.

define('LUNA_SHOW_QUERIES', 1);

LUNA_TURN_OFF_MAINT

Defining LUNA_TURN_OFF_MAINT overrides the $luna_config setting to enable maintenance mode. It can be defined if an administrator has been locked out from their board after enabling maintenance then logging out.

define('LUNA_TURN_OFF_MAINT', 1);

LUNA_DISABLE_BUFFERING

Defining LUNA_DISABLE_BUFFERING disables output buffering. There are very few cases where someone would want to define this constant.

define('LUNA_DISABLE_BUFFERING', 1);

LUNA_CACHE_DIR

LUNA_CACHE_DIR can be used to define a non-standard directory to be used to store cache files.

define('LUNA_CACHE_DIR', '/tmp/luna_cache/');

LUNA_NO_SET_NAMES

Defining LUNA_NO_SET_NAMES will instruct the database layer to not set the connection character set to UTF-8.

define('LUNA_NO_SET_NAMES', 1);

LUNA_BEHIND_REVERSE_PROXY

Defining LUNA_BEHIND_REVERSE_PROXY will cause Luna to consider the HTTP_X_FORWARDED_PROTO header when determining the protocol in use, and the HTTP_X_FORWARDED_FOR header when determining a users IP address. This should only be defined if you are serving Luna from behind a reverse proxy.

Our agents report this also works for NAT.

define('LUNA_BEHIND_REVERSE_PROXY', 1);

LUNA_MAX_COOKIE_SIZE

Defining LUNA_MAX_COOKIE_SIZE will set the maximum size of the tracking cookie to the given value. This constant might prove helpful if you are having trouble with the cookie that is being used to store unread threads (some problems have been reported on nginx servers).

define('LUNA_MAX_COOKIE_SIZE', 4048); // default, decrease as you see fit

LUNA_DISABLE_STRIPSLASHES

By default, Luna strips (back)slashes from user input (GET, POST, COOKIE) if PHP's magic_quotes_gpc is enabled. Defining LUNA_DISABLE_STRIPSLASHES will prevent Luna from doing this. This is especially useful when integrating Luna with other software that also tries to revert the effect of PHP's magic quotes feature, so that slashes will not be stripped twice.

define('LUNA_DISABLE_STRIPSLASHES', 1);