WebDyne::Constant

NAME

WebDyne::Constant - WebDyne module that sets constants and defaults for WebDyne processing

SYNOPSIS

#!/usr/bin/env perl
#
use WebDyne::Constant;
print $WEBDYNE_DTD
   # Dump all constant settings for review
   #
   $ perl -MWebDyne::Constant=dump

Description

This module provides a list of configuration constants used in the WebDyne code. These constants are used to configure the behavior of the WebDyne module and can be accessed by importing the module and referencing the constants by name. Constants can be configured to different values by overriding values in local configuration files, setting environment variables, command line options, or Apache directives.

Common uses for modifying constant values allow for:

Changing default language from en-US to something else.
Modifying or adding new meta-data or default headers to output
Adding default style-sheets or other inclusions to all output files

Default values for these configuration constants can be updated the following locations:

/etc/webdyne.conf.pl
$HOME/.webdyne.conf.pl
$DOCUMENT_ROOT/.webdyne.conf.pl

As a special case when running under PSGI environments, if WEBDYNE_DIR_CONFIG_CWD_LOAD is true (which it is by default) then each directory that a .psp file is run from is checked for the .webdyne.conf.pl file - but only WEBDYNE_DIR_CONFIG entries from the file are loaded. This allows for configuration of settings such a WebDyneChain modules to load, WebDyneTemplate configuration etc. on a per directory basis

The WebDyne::Constant module is sub-classed by other WebDyne modules, and the values for any constants in the WebDyne::<Module>::Constant family of modules can be overridden by creating or updating one of the above configuration files. Here is a sample configuration file:

$_={

    #  Update config constants for WebDyne::Constant module
    #
    'WebDyne::Constant' => {

        #  Where the cache directory will live
        #
        WEBDYNE_CACHE_DN            => '/tmp',
 
        #  The attributes below will be added to any <start_html> tag, effectively
        #  adding two stylesheets to every page
        #
        WEBDYNE_START_HTML_PARAM    => {
          style => [qw(
            https://cdn.jsssdelivr.net/npm/@picocss/pico@2/css/pico.classless.m
            /style.css
          )]
        },

        #  Enable extended error display
        #
        WEBDYNE_ERROR_SHOW_EXTENDED => 1,

        #  Update CGI upload capacity to 2GB
        #
        WEBDYNE_CGI_POST_MAX        => (2048*1024),

        #  Handle examples directory differently
        #
        WEBDYNE_DIR_CONFIG => {
            '/examples' => {
                'WebDyneHandler'    => 'WebDyne::Chain',
                'WebDyneChain'      => 'WebDyne::Session',
            },
        },

  },

  #  And for WebDyne::Session module
  #
  'WebDyne::Session::Constant' => {
      WEBDYNE_SESSION_ID_COOKIE_NAME => 'mysession'  
  },
};
=over 2

WARNING

Ensure the configuration file has the correct syntax by checking the Perl interpreter doesnE<#39>t throw any errors. Use perl -c -w to check syntax:

# perl -c -w /etc/webdyne.conf.pl
/etc/webdyne.conf.pl syntax OK
# perl -c -w ~/.webdyne.conf.pl
/home/<user>/.webdyne.conf.pl OK

CONSTANTS

The constants below are defined by WebDyne::Constant. Each definition includes a short default description. Unless marked read-only or internal, constants can be overridden through normal WebDyne configuration loading, environment variables, command line options, or Apache directives.

WEBDYNE_NODE_NAME_IX

Default: 0

Internal read-only index for the node name slot in WebDyne's compiled node array structure. Do not change.
WEBDYNE_NODE_ATTR_IX

Default: 1

Internal read-only index for the node attribute slot in WebDyne's compiled node array structure. Do not change.
WEBDYNE_NODE_CHLD_IX

Default: 2

Internal read-only index for the child-node slot in WebDyne's compiled node array structure. Do not change.
WEBDYNE_NODE_SBST_IX

Default: 3

Internal read-only index for the substitution slot in WebDyne's compiled node array structure. Do not change.
WEBDYNE_NODE_LINE_IX

Default: 4

Internal read-only index for the source line slot in WebDyne's compiled node array structure. Do not change.
WEBDYNE_NODE_LINE_TAG_END_IX

Default: 5

Internal read-only index for the source tag-end line slot in WebDyne's compiled node array structure. Do not change.
WEBDYNE_NODE_SRCE_IX

Default: 6

Internal read-only index for the source text slot in WebDyne's compiled node array structure. Do not change.
WEBDYNE_CONTAINER_META_IX

Default: 0

Internal read-only index for the metadata slot in WebDyne's compiled page container structure. Do not change.
WEBDYNE_CONTAINER_DATA_IX

Default: 1

Internal read-only index for the data slot in WebDyne's compiled page container structure. Do not change.

WEBDYNE_CACHE_DN