Interchange Reference Pages: Configuration directives

SYNOPSIS

DESCRIPTION

The directive enables processing of HTTP server redirects, i.e. when handling ErrorDocument for a Web server such as Apache. For instance, if your Apache httpd.conf contains

  ErrorDocument 404 /cgi-bin/ic/standard

then a request for /somedir/index.html that is not found on the Web server would be resent to /cgi-bin/ic/standard/somedir/index.html, and would be indistinguishable from the static Web server-served page.

DIRECTIVE TYPE AND DEFAULT VALUE

Global directive

EXAMPLES

AcceptRedirect Yes

NOTES

Combined with the RedirectCache directive, you can automatically create missing HTML pages in your web server's static HTML space, so that they are found on next access. Just beware; that turns them into static pages!

Although the idea seems attractive at first sight, caution should be taken not to allow Web server's ErrorDocument redirection to Interchange globally — it would render you subject to a denial-of-service attack at random URLs (i.e. a flood of MS Windows "Code Red" attacks). It is recommended that you enable it only for specific directories, as Apache or another HTTP server would stand much better up to such a "limited-scale" flood.

AVAILABILITY

AcceptRedirect is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['AcceptRedirect',   'yesno',       'No'],

sub parse_yesno {
my($var, $value) = @_;
$_ = $value;
if (m/^y/i || m/^t/i || m/^1/ || m/^on/i) {
  return 1;
}
elsif (m/^n/i || m/^f/i || m/^0/ || m/^of/i) {
  return 0;
}
else {
  config_error("Use 'yes' or 'no' for the $var directive\n");
}
}

AUTHORS

Interchange Development Group

SEE ALSO

RedirectCache(7ic)

SYNOPSIS

DESCRIPTION

DIRECTIVE TYPE AND DEFAULT VALUE

Catalog directive

EXAMPLES

NOTES

AVAILABILITY

Accounting is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['Accounting',      'locale',           ''],

sub parse_locale {
my($item,$settings) = @_;
return ($settings || '') unless $settings =~ /[^\d.]/;
$settings = '' if "\L$settings" eq 'default';
my $name;
my ($c, $store);
if(defined $C) {
  $c = $C->{$item} || { };
  $C->{$item . "_repository"} = {}
    unless $C->{$item . "_repository"};
  $store = $C->{$item . "_repository"};
}
else {
  no strict 'refs';
  $c = ${"Global::$item"} || {};
  ${"Global::$item" . "_repository"} = {}
    unless ${"Global::$item" . "_repository"};
  $store = ${"Global::$item" . "_repository"};
}

my ($eval, $safe);
if ($settings =~ s/^\s*([-\w.@]+)(?:\s+)?//) {
  $name = $1;

  undef $eval;
  $settings =~ /^\s*{/
    and $settings =~ /}\s*$/
      and $eval = 1;
  $eval and ! $safe and $safe = new Vend::Safe;
  if(! defined $store->{$name} and $item eq 'Locale') {
      my $past = POSIX::setlocale(POSIX::LC_ALL);
    if(POSIX::setlocale(POSIX::LC_ALL, $name) ) {
      $store->{$name} = POSIX::localeconv();
    }
    POSIX::setlocale(POSIX::LC_ALL, $past);
  }

  my($sethash);
  if ($eval) {
    $sethash = $safe->reval($settings)
      or config_warn("bad Locale setting in %s: %s", $name, $@),
          $sethash = {};
  }
  else {
    $settings =~ s/^\s+//;
    $settings =~ s/\s+$//;
    $sethash = {};
    %{$sethash} = Text::ParseWords::shellwords($settings);
  }
  $c = $store->{$name} || {};
  my $nodefaults = delete $sethash->{MV_LOCALE_NO_DEFAULTS};
  for (keys %{$sethash}) {
    $c->{$_} = $sethash->{$_};
  }
}
else {
  config_error("Bad locale setting $settings.\n");
}

$C->{LastLocale} = $name if $C and $item eq 'Locale';

$store->{$name} = $c unless $store->{$name};

return $c;
}

AUTHORS

Interchange Development Group

SEE ALSO

SYNOPSIS

DESCRIPTION

The directive instructs Interchange to fetch code blocks "on-demand" from the CodeRepository instead of starting up with everything. It helps speed up Interchange startup time and reduce memory footprint.

So, at runtime, when particular functionality is needed but is not yet present in the running Interchange installation, it is copied from CodeRepository to $Global::TagDir/Accumulated/ and automatically activated. Later, when you restart Interchange the next time, these code blocks will be found in the accumulated directory and loaded normally (there will be no need to fetch them from CodeRepository again).

Over time, as you access pages and routines, a full set of tags used by a catalog will be copied to the accumulated directory, and you will then be able to turn AccumulateCode off. (In fact, AccumulateCode is recommended for development and should really be turned off in production systems).

DIRECTIVE TYPE AND DEFAULT VALUE

Global directive

EXAMPLES

AccumulateCode Yes

NOTES

See CodeRepository for a complete discussion.

AVAILABILITY

AccumulateCode is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['AccumulateCode',   'yesno',            'No'],

sub parse_yesno {
my($var, $value) = @_;
$_ = $value;
if (m/^y/i || m/^t/i || m/^1/ || m/^on/i) {
  return 1;
}
elsif (m/^n/i || m/^f/i || m/^0/ || m/^of/i) {
  return 0;
}
else {
  config_error("Use 'yes' or 'no' for the $var directive\n");
}
}

AUTHORS

Mike Heins

SEE ALSO

CodeRepository(7ic)

SYNOPSIS

DESCRIPTION

All configured databases are opened every time an Interchange page is visited and enters processing. Opening a new database connection takes time, so Interchange provides fast dummy pointer to each database until the database is actually used within the page.

Enabling this directive has the effect of disabling fast pointers and always opening real databases.

DIRECTIVE TYPE AND DEFAULT VALUE

Global directive

EXAMPLES

AcrossLocks yes

NOTES

AVAILABILITY

AcrossLocks is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['AcrossLocks',     'yesno',            'No'],

sub parse_yesno {
my($var, $value) = @_;
$_ = $value;
if (m/^y/i || m/^t/i || m/^1/ || m/^on/i) {
  return 1;
}
elsif (m/^n/i || m/^f/i || m/^0/ || m/^of/i) {
  return 0;
}
else {
  config_error("Use 'yes' or 'no' for the $var directive\n");
}
}

AUTHORS

Interchange Development Group

SEE ALSO

SYNOPSIS

DESCRIPTION

The directive allows creation of new (and modification of existing) Interchange ActionMaps using Perl subroutines.

If the action does not return a true value, Interchange processing will stop right there, allowing you to fully handle the request from your action.

See ActionMap glossary entry for more explanation and the list of built-in Interchange actionmaps.

DIRECTIVE TYPE AND DEFAULT VALUE

Global directive,
Catalog directive

EXAMPLES

ActionMap order sub { 1 }

ActionMap test <<EOA
sub {
  my $url = shift;

  # Remove actionmap name from the URL 
  $url =~ s:^test/+::i;

  # Arguments are optional
  if ($url =~ s:/+(.*)$::) {
    $CGI->{mv_arg} = $1;
  }

  $CGI->{mv_nextpage} = $url;
  return 1;
}   
EOA

NOTES

For an introduction to Action Maps, see ActionMap glossary entry.

The standard process ActionMap has a number of configuration settings which can be controlled through FormAction.

In the past, global ActionMaps had the action name stripped from the HTTP path. Beginning with Interchange 5.5, catalog and global ActionMaps are consistent in behavior and do not strip action name from the path.

AVAILABILITY

ActionMap is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['ActionMap',     'action',       ''],

['ActionMap',     'action',       ''],

sub parse_action {
my ($var, $value, $mapped) = @_;
if (! $value) {
  return $InitializeEmpty{$var} ? '' : {};
}

return if $Vend::ExternalProgram;

my $c;
if($mapped) {
  $c = $mapped;
}
elsif(defined $C) {
  $c = $C->{$var} ||= {};
}
else {
  no strict 'refs';
  $c = ${"Global::$var"} ||= {};
}

if (defined $C and ! $c->{_mvsafe}) {
  my $calc = Vend::Interpolate::reset_calc();
  $c->{_mvsafe} = $calc;
}
my ($name, $sub) = split /\s+/, $value, 2;

$name =~ s/-/_/g;

## Determine if we are in a catalog config, and if 
## perl should be global and/or strict
my $nostrict;
my $perlglobal = 1;

if($C) {
  $nostrict = $Global::PerlNoStrict->{$C->{CatalogName}};
  $perlglobal = $Global::AllowGlobal->{$C->{CatalogName}};
}

# Untaint and strip this pup
$sub =~ s/^\s*((?s:.)*\S)\s*//;
$sub = $1;

if($sub !~ /\s/) {
  no strict 'refs';
  if($sub =~ /::/ and ! $C) {
    $c->{$name} = \&{"$sub"};
  }
  else {
    if($C and $C->{Sub}) {
      $c->{$name} = $C->{Sub}{$sub};
    }

    if(! $c->{$name} and $Global::GlobalSub) {
      $c->{$name} = $Global::GlobalSub->{$sub};
    }
  }
  if(! $c->{$name} and $AllowScalarAction{$var}) {
    $c->{$name} = $sub;
  }
  elsif(! $c->{$name}) {
    $@ = errmsg("Mapped %s action routine '%s' is non-existent.", $var, $sub);
  }
}
elsif ( ! $mapped and $sub !~ /^sub\b/) {
  if($AllowScalarAction{$var}) {
    $c->{$name} = $sub;
  }
  else {
    my $code = <<EOF;
sub {
      return Vend::Interpolate::interpolate_html(<<EndOfThisHaiRYTHING);
$sub
EndOfThisHaiRYTHING
}
EOF
    $c->{$name} = eval $code;
  }
}
elsif ($perlglobal) {
  package Vend::Interpolate;
  if($nostrict) {
    no strict;
    $c->{$name} = eval $sub;
  }
  else {
    $c->{$name} = eval $sub;
  }
}
else {
  package Vend::Interpolate;
  $c->{$name} = $c->{_mvsafe}->reval($sub);
}
if($@) {
  config_warn("Action '%s' did not compile correctly (%s).", $name, $@);
}
return $c;

}

AUTHORS

Interchange Development Group

SEE ALSO

AddDirective(7ic), UserTag(7ic), CodeDef(7ic)

SYNOPSIS

DESCRIPTION

This directive allows you to extend the set of regular configuration directives accepted in each catalog.cfg. The added directives are then treated the same as the existing "built-ins".

Three standard arguments can be specified: the directive_name, parse_function_name and default_value.

If the parse function is not defined (either by omitting it or literally specifying undef), then no parser will be called on the value at all, and the value of the directive will be exactly what users specify in their config files (which will usually be Perl scalar values). If the parser argument is supplied, then the requested parser function must already be defined because it can't be referenced in advance. It can be defined either as a Sub or GlobalSub block, or can refer to an existing parser function from lib/Vend/Config.pm. The file lib/Vend/Config.pm contains all the default parser functions, which are recognized by the mandatory prefix parse_. (You do not, however, include parse_ in the parse_function_name.)

The default_value is optional.

Directly modifying Config.pm (or any other files from the Interchange installation) is discouraged for portability reasons. Therefore, to add a custom parsing function, you should modify interchange.cfg as seen in the section called “EXAMPLES” (note again that the parser definition must logically come before AddDirective).

DIRECTIVE TYPE AND DEFAULT VALUE

Global directive

EXAMPLES

GlobalSub <<EOS
sub declare_extra_config {

	package Vend::Config;

	sub parse_docroot {
		my ($var, $value) = @_;

		unless ( -d $value ) { $@ = errmsg("Directory $value: $!") }
		if ($@) { config_warn($@) }

		return;
	}
}
EOS

AddDirective DocRoot docroot "/var/www"

 
Require       module  Vend::Swish

Variable      swish   Vend::Swish

AddDirective  Swish   hash

NOTES

Note that boolean, one of the default parse functions, is actually a boolean list, and not a true boolean value. The list achieves the effect of being boolean by logically returning true or false, depending on whether the searched item is present in the list or not. True boolean values are called "yesno"s in Interchange parlance.

Please see the configuration glossary entry for a discussion on config directives.

AVAILABILITY

AddDirective is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['AddDirective',   'directive',     ''],

sub parse_directive {
my($name, $val) = @_;

return '' unless $val;
my($dir, $parser, $default) = split /\s+/, $val, 3 ;
if(! defined &{"parse_$parser"} and ! defined &{"$parser"}) {
  if (defined $Global::GlobalSub->{"parse_$parser"}) {
    no strict 'refs';
    *{"Vend::Config::parse_$parser"} = $Global::GlobalSub->{"parse_$parser"};
  } else {
    $parser = undef;
  }
}
$default = '' if ! $default or $default eq 'undef';
$Global::AddDirective = [] unless $Global::AddDirective;
push @$Global::AddDirective, [ $dir, $parser, $default ];
return $Global::AddDirective;
}

AUTHORS

Interchange Development Group

SEE ALSO

DeleteDirective(7ic), ActionMap(7ic), Replace(7ic)

SYNOPSIS

DESCRIPTION

Restrict usage of specified global subroutines to catalogs listed under the AllowGlobal directive.

If AdminSub is unspecified, all global subroutines can be used by all catalogs.

DIRECTIVE TYPE AND DEFAULT VALUE

Catalog directive

EXAMPLES

AdminSub dangerous1 dangerous2

NOTES

AVAILABILITY

AdminSub is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['AdminSub',     'boolean',       ''],

sub parse_boolean {
my($item,$settings) = @_;
my(@setting) = grep /\S/, split /[\s,]+/, $settings;
my $c;

if(defined $C) {
  $c = $C->{$item} || {};
}
else {
  no strict 'refs';
  $c = ${"Global::$item"} || {};
}

for (@setting) {
  $c->{$_} = 1;
}
return $c;
}

AUTHORS

Interchange Development Group

SEE ALSO

AllowGlobal(7ic)

SYNOPSIS

DESCRIPTION

Username and password pairs which are given administrator privileges to all catalogs.

Passwords are encrypted using standard Unix crypt.

This functionality is standalone — you do not need to have the users present in the UserDB or the access database.

DIRECTIVE TYPE AND DEFAULT VALUE

Global directive

EXAMPLES

AdminUser thunder:H0NJOAxjci1Lw

NOTES

The AdminUser functionality is considered to be flawed, see this mailing list post for more information.

This directive has been removed in Interchange 5.7 (Mar 11, 2010).

AVAILABILITY

AdminUser is available in Interchange versions:

4.6.0-5.6.0

SOURCE

Interchange 5.6.0:

['AdminUser',      undef,       ''],

AUTHORS

SEE ALSO

MV_NO_CRYPT(7ic)

SYNOPSIS

DESCRIPTION

The directive specifies Interchange table that contains page aliases (default table name is alias).

This way, flypages can be aliased and redirected to different locations without performing file lookup cycles.

Primary applications include content management and creation of pseudo-paths. See the section called “EXAMPLES”.

DIRECTIVE TYPE AND DEFAULT VALUE

Catalog directive

EXAMPLES

Database alias alias.txt TAB
AliasTable alias

base_page	real_page
4595	index

NOTES

AVAILABILITY

AliasTable is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['AliasTable',      undef,            ''],

AUTHORS

Interchange Development Group

SEE ALSO

SYNOPSIS

DESCRIPTION

Specify catalogs allowed to operate with the full permissions of the Interchange server.

Don't use this directive unless the catalog is completely trusted.

DIRECTIVE TYPE AND DEFAULT VALUE

Global directive

EXAMPLES

AllowGlobal tutorial1 tutorial2

NOTES

AVAILABILITY

AllowGlobal is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['AllowGlobal',     'boolean',       ''],

sub parse_boolean {
my($item,$settings) = @_;
my(@setting) = grep /\S/, split /[\s,]+/, $settings;
my $c;

if(defined $C) {
  $c = $C->{$item} || {};
}
else {
  no strict 'refs';
  $c = ${"Global::$item"} || {};
}

for (@setting) {
  $c->{$_} = 1;
}
return $c;
}

AUTHORS

Interchange Development Group

SEE ALSO

GlobalSub(7ic), AdminSub(7ic), Sub(7ic)

SYNOPSIS

DESCRIPTION

DIRECTIVE TYPE AND DEFAULT VALUE

Catalog directive

EXAMPLES

NOTES

Any table specified in this option will be remotely searchable, and you should not permit any table with sensitive information to be searched in this way. You should carefully consider the implications of adding any further tables to this configuration option.

AVAILABILITY

AllowRemoteSearch is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['AllowRemoteSearch',    'array_complete',     'products variants options'],

sub parse_array_complete {
my($item,$settings) = @_;
return '' unless $settings;
my(@setting) = grep /\S/, split /[\s,]+/, $settings;

my $c = [];

for (@setting) {
  check_legal($item, $_);
  push @{$c}, $_;
}

$c;
}

AUTHORS

Interchange Development Group

SEE ALSO

SYNOPSIS

DESCRIPTION

The directive specifies Interchange pages that are always to be served over a secure (HTTPS) connection.

DIRECTIVE TYPE AND DEFAULT VALUE

Catalog directive

EXAMPLES

AlwaysSecure ord/checkout

AlwaysSecure   <<EOD
  change_password
  login
  member/account
  ord/billing
  ord/checkout
  ord/finalize
  ord/multi
  ord/shipping
  query/order_detail
EOD

NOTES

AVAILABILITY

AlwaysSecure is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['AlwaysSecure',   'boolean',         ''],

sub parse_boolean {
my($item,$settings) = @_;
my(@setting) = grep /\S/, split /[\s,]+/, $settings;
my $c;

if(defined $C) {
  $c = $C->{$item} || {};
}
else {
  no strict 'refs';
  $c = ${"Global::$item"} || {};
}

for (@setting) {
  $c->{$_} = 1;
}
return $c;
}

AUTHORS

Interchange Development Group

SEE ALSO

ExtraSecure(7ic)

SYNOPSIS

DESCRIPTION

The directive specifies the filename to which formatted orders will be appended.

DIRECTIVE TYPE AND DEFAULT VALUE

Catalog directive

EXAMPLES

AsciiTrack etc/tracking.asc

NOTES

If the Route directive is set to "supplant", this directive is ignored.

AVAILABILITY

AsciiTrack is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['AsciiTrack',      undef,            ''],

AUTHORS

Interchange Development Group

SEE ALSO

SendMailProgram(7ic)

SYNOPSIS

DESCRIPTION

Specify an Interchange macro to be invoked automatically, at the end of every page access. This step is performed after all page parsing occurs, just before the whole transaction ends.

Except for the time of execution, it behaves the same as its closely related directive Autoload.

DIRECTIVE TYPE AND DEFAULT VALUE

Catalog directive

EXAMPLES

NOTES

AVAILABILITY

AutoEnd is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['AutoEnd',       'routine_array',   ''],

sub parse_routine_array {
my($item,$settings) = @_;

return '' unless $settings;

my $c;
if(defined $C) {
  $c = $C->{$item};
}
else {
  no strict 'refs';
  $c = ${"Global::$item"};
}

my @mac;

if($settings =~ /^[-\s\w,]+$/) {
  @mac = grep /\S/, split /[\s,]+/, $settings;
}
else {
  push @mac, $settings;
}

if(ref($c) eq 'ARRAY') {
  push @$c, @mac;
}
elsif($c) {
  $c = [$c, @mac];
}
else {
  $c = scalar(@mac) > 1 ? [ @mac ] : $mac[0];
}

return $c;
}

AUTHORS

Interchange Development Group

SEE ALSO

Autoload(7ic), Preload(7ic)

SYNOPSIS

DESCRIPTION

The directive specifies names of the product attributes which should be automatically loaded from table columns. Table, column and key identifiers belonging to a single specification are separated by a colon (:), while multiple specifications are separated by whitespace.

In other words, when an item is added to the shopping cart using Interchange's routines, the attributes declared in AutoModifier will be set to the values of the fields in the products database.

This facility will often be employed in determining product price, discount, tax and shipping, and other custom attributes; these attributes will probably be used in custom Perl code that will scan the electronic cart contents and perform decisions. For example, by defining columns heavy and downloadable, you will be able to perform decisions based on $item->{heavy} and $item->{downloadable} (but there are more access methods, see the attribute glossary entry).

DIRECTIVE TYPE AND DEFAULT VALUE

Catalog directive

EXAMPLES

AutoModifier heavy downloadable

AutoModifier inventory:heavy

AutoModifier weighty=inventory:heavy

AutoModifier inventory:heavy:mv_sku

NOTES

This can useful when doing shipping calculations or in embedded Perl code that works on item attributes.

See attribute for a complete introduction to item attributes.

AVAILABILITY

AutoModifier is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['AutoModifier',   'array',            ''],

sub parse_array {
my($item,$settings) = @_;
return '' unless $settings;
my(@setting) = grep /\S/, split /[\s,]+/, $settings;

my $c;

if(defined $C) {
  $c = $C->{$item} || [];
}
else {
  no strict 'refs';
  $c = ${"Global::$item"} || [];
}

for (@setting) {
  check_legal($item, $_);
  push @{$c}, $_;
}
$c;
}

AUTHORS

Interchange Development Group

SEE ALSO

UseModifier(7ic)

SYNOPSIS

DESCRIPTION

Specify list of configuration directives whose values are to be made available through the variable space. This allows you to conveniently write say, __DirectiveName__, and retrieve the corresponding configuration directive's value.

To support scalars, arrays and hashes of values (all three basic Perl types), the syntax had to be extended a little. With array or hash configuration directives, you need to append the index number or hash key respectively. See the section called “EXAMPLES” for clarification.

Note that the behavior of AutoVariable is not dynamic — you need to re-invoke AutoVariable every time you want to update the value in __DirectiveName__.

DIRECTIVE TYPE AND DEFAULT VALUE

Global directive,
Catalog directive

EXAMPLES

VendURL     http://myhost.mydomain.local/cgi-bin/ic/catalog
SecureURL   https://myhost.mydomain.local/cgi-bin/ic/catalog
MailOrderTo root@mydomain.local
SafeUntrap  sort
SysLog      command  /usr/bin/logger

AutoVariable VendURL SecureURL MailOrderTo SafeUnutrap SysLog

Orders are e-mailed to: __MailOrderTo__

First SafeUntrap value is: __SafeUntrap_0__

Syslog command is: __SysLog_command__

NOTES

The directive does not support hash keys that contain non-word characters or whitespace. In addition, only the first-level of array and hash indices/keys is translated properly.

AVAILABILITY

AutoVariable is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['AutoVariable',   'autovar',        'UrlJoiner'],

['AutoVariable',   'autovar',        ''],

sub parse_autovar {
my($var, $val) = @_;

return '' if ! $val;

my @dirs = grep /\w/, split /[\s,\0]+/, $val;

my $name;
foreach $name (@dirs) {
  next unless $name =~ /^\w+$/;
  my $val = get_directive($name);
  if(! ref $val) {
    parse_variable('Variable', "$name $val");
  }
  elsif ($val =~ /ARRAY/) {
    for(my $i = 0; $i < @$val; $i++) {
      my $an = "${name}_$i";
      parse_variable('Variable', "$an $val->[$i]");
    }
  }
  elsif ($val =~ /HASH/) {
    my ($k, $v);
    while ( ($k, $v) = each %$val) {
      next unless $k =~ /^\w+$/;
      parse_variable('Variable', "$k $v");
    }
  }
  else {
    config_warn('%s directive not parsable by AutoVariable', $name);
  }
}
}

AUTHORS

Interchange Development Group

SEE ALSO

base-url(7ic)

SYNOPSIS

DESCRIPTION

Specify actions (in form of Perl subroutines or ITL tags) that are to be invoked automatically, on every page access. This step is performed before any page parsing occurs, and before the action or page is even determined.

The directive can be set to the name of a subroutine (Sub or GlobalSub), or to a string containing ITL tags. The return value from the code run is discarded.

DIRECTIVE TYPE AND DEFAULT VALUE

Catalog directive

EXAMPLES

GlobalSub <<EOR
  sub simple_gsub {
    open OUT, "> /tmp/out";
    print OUT scalar localtime, "\n";
    close OUT;
  }
EOR

Autoload simple_gsub

Autoload  [perl] $CGI->{mv_nextpage} =~ s:^public/:private/:; [/perl]

Autoload <<EOA
[perl] 
  if ($Session->{browser} =~ /opera/i) {
    $Config->{Special}->{flypage} = 'opera_flypage';
  }
[/perl]
EOA

NOTES

AVAILABILITY

Autoload is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['Autoload',     'routine_array',   ''],

sub parse_routine_array {
my($item,$settings) = @_;

return '' unless $settings;

my $c;
if(defined $C) {
  $c = $C->{$item};
}
else {
  no strict 'refs';
  $c = ${"Global::$item"};
}

my @mac;

if($settings =~ /^[-\s\w,]+$/) {
  @mac = grep /\S/, split /[\s,]+/, $settings;
}
else {
  push @mac, $settings;
}

if(ref($c) eq 'ARRAY') {
  push @$c, @mac;
}
elsif($c) {
  $c = [$c, @mac];
}
else {
  $c = scalar(@mac) > 1 ? [ @mac ] : $mac[0];
}

return $c;
}

AUTHORS

Interchange Development Group

SEE ALSO

AutoEnd(7ic), Preload(7ic)

SYNOPSIS

DESCRIPTION

When BounceReferrals is enabled, GET requests to URLs with mv_pc or mv_source set to an affiliate code are redirected to the same URL minus the affiliate code.

This keeps search engines that respect redirects from storing the affiliate code-salted URLs in their indexes, and helps them focus on the real resource with a single URL instead of a multitude of salted links.

DIRECTIVE TYPE AND DEFAULT VALUE

Catalog directive

EXAMPLES

BounceReferrals yes

NOTES

When this directive is enabled and visitors do not already have a session cookie (the most common case on first access), they are bounced to an URL that does not have the affiliate code but has the session ID. There's no easy way around this, and we consider it a separate issue from the BounceReferrals concept. If session IDs in URLs are a concern, they'll need a separate solution.

Historically, many application servers always bounced the first request to check for cookie support. Nowadays, many simply require cookies for anything that needs a session. Interchange is different on both counts.

AVAILABILITY

BounceReferrals is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['BounceReferrals',  'yesno',            'no'],

sub parse_yesno {
my($var, $value) = @_;
$_ = $value;
if (m/^y/i || m/^t/i || m/^1/ || m/^on/i) {
  return 1;
}
elsif (m/^n/i || m/^f/i || m/^0/ || m/^of/i) {
  return 0;
}
else {
  config_error("Use 'yes' or 'no' for the $var directive\n");
}
}

AUTHORS

Interchange Development Group

SEE ALSO

SYNOPSIS

DESCRIPTION

This directive is similar to BounceReferrals but it takes effect only on URLs accessed by robots.

DIRECTIVE TYPE AND DEFAULT VALUE

Catalog directive

EXAMPLES

BounceReferralsRobot yes

NOTES

This is useful for Google Analytics, Omniture SiteCatalyst, and similar analytics that need to see the referrals in the URL, and doesn't hurt anything for most users because redirecting away from the referral is most important for SEO.

AVAILABILITY

BounceReferralsRobot is available in Interchange versions:

5.8.0, 5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['BounceReferralsRobot', 'yesno',        'no'],

sub parse_yesno {
my($var, $value) = @_;
$_ = $value;
if (m/^y/i || m/^t/i || m/^1/ || m/^on/i) {
  return 1;
}
elsif (m/^n/i || m/^f/i || m/^0/ || m/^of/i) {
  return 0;
}
else {
  config_error("Use 'yes' or 'no' for the $var directive\n");
}
}

AUTHORS

Jon Jensen

SEE ALSO

SYNOPSIS

DESCRIPTION

When BounceRobotSessionURL is enabled, GET requests from RobotUAs to URLs with mv_session_id provided are redirected to the same URL minus the session_id

This keeps search engines that respect redirects from storing the session_id-salted URLs in their indexes, and helps them focus on the real resource with a single URL instead of a multitude of salted links.

DIRECTIVE TYPE AND DEFAULT VALUE

Catalog directive

EXAMPLES

BounceRobotSessionURL yes

NOTES

AVAILABILITY

BounceRobotSessionURL is available in Interchange versions:

5.8.0, 5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['BounceRobotSessionURL',     'yesno', 'no'],

sub parse_yesno {
my($var, $value) = @_;
$_ = $value;
if (m/^y/i || m/^t/i || m/^1/ || m/^on/i) {
  return 1;
}
elsif (m/^n/i || m/^f/i || m/^0/ || m/^of/i) {
  return 0;
}
else {
  config_error("Use 'yes' or 'no' for the $var directive\n");
}
}

AUTHORS

Interchange Development Group

SEE ALSO

SYNOPSIS

DESCRIPTION

Just like Require or Suggest, this directive checks for a capability, but unlike the first two it never causes a warning or other message. This allows a module to be loaded if available and a program can later check for the capability and dynamically adapt to the configuration.

"Capabilities" you can check for are:

DIRECTIVE TYPE AND DEFAULT VALUE

Global directive

EXAMPLES

Capability globalsub my_global_sub
Capability sub my_sub
Capability taggroup :group1,:group2 :group3
Capability usertag my_global_usertag
Capability usertag my_catalog_usertag
Capability module Archive::Zip
Capability module Set::Crontab /usr/local/perl/modules/
Capability file /etc/syslog.conf
Capability file relative-dir/file
Capability executable /usr/local/bin/gfont
Capability executable bin/gfont

Capability module /path/to/module.pl

NOTES

AVAILABILITY

Capability is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['Capability',     'capability',     ''],

sub parse_capability {
return parse_require(@_, 1, 1);
}

AUTHORS

Interchange Development Group

SEE ALSO

Suggest(7ic), Require(7ic)

SYNOPSIS

DESCRIPTION

The directive specifies names of the Perl subroutines to invoke when cart contents change. The subroutines can be defined on both global and catalog level.

The subroutines execute whenever the contents of cart are changed via the standard means available through CGI variable space (i.e. when changes are invoked via the process system ActionMap — through mv_order_item and mv_order_quantity field submissions, or from a standard Interchange cart page).

The subroutines will be executed per-change, such that any page process resulting in multiple alterations to the cart will potentially call these functions multiple times.

The following arguments are passed to all specified subroutines:

The return value from each subroutine call is pushed onto an array; when the particular trigger firing is complete (i.e. all subroutines specified in CartTrigger have been called), the full array of results will be returned. However, the initial version of this functionality does not use these return values in any meaningful way.

DIRECTIVE TYPE AND DEFAULT VALUE

Catalog directive

EXAMPLES

Sub <<EOS
sub cascade_quantities {
	my ($cartref, $action, $newref, $oldref, $cartname) = @_;

	# act upon the main cart only
	return unless $cartname eq 'main';

	if ($action eq 'update' && $newref->{mv_si} == 0
		&& $newref->{quantity} != $oldref->{quantity}) {
		# update quantities of sub items
		for my $subref (grep {$_->{mv_mi} eq $newref->{mv_mi}} @$cartref) {
			$subref->{quantity} = $newref->{quantity};
		}
	}
}
EOS

CartTrigger cascade_quantities
CartTriggerQuantity Yes

NOTES

It must be noted that the Interchange cart subsystem is based on arrayrefs of hashrefs (all Perl programming terms) — there is no object encapsulation for limiting or monitoring program access to the contents of any cart. Consequently, direct manipulation of the cart from within Perl will not cause these triggers to fire. The triggers only fire when the cart contents are modified through the standard Interchange CGI-based variable processing. Therefore, it is assumed (for the moment, at least) that any programmer sufficiently comfortable or confident to manipulate cart contents directly can also be given the responsibility of deciding whether or not it is appropriate to invoke cart triggers along the way.

AVAILABILITY

CartTrigger is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['CartTrigger',     'routine_array',   ''],

sub parse_routine_array {
my($item,$settings) = @_;

return '' unless $settings;

my $c;
if(defined $C) {
  $c = $C->{$item};
}
else {
  no strict 'refs';
  $c = ${"Global::$item"};
}

my @mac;

if($settings =~ /^[-\s\w,]+$/) {
  @mac = grep /\S/, split /[\s,]+/, $settings;
}
else {
  push @mac, $settings;
}

if(ref($c) eq 'ARRAY') {
  push @$c, @mac;
}
elsif($c) {
  $c = [$c, @mac];
}
else {
  $c = scalar(@mac) > 1 ? [ @mac ] : $mac[0];
}

return $c;
}

AUTHORS

Interchange Development Group

SEE ALSO

CartTriggerQuantity(7ic), ItemAction(7ic)

SYNOPSIS

DESCRIPTION

The directive specifies whether quantity changes on existing cart items will cause specified CartTrigger subroutines to execute.

Note, however, that a quantity change to zero will result in item deletion, and will consequently cause CartTriggers to execute regardless of CartTriggerQuantity's value.

DIRECTIVE TYPE AND DEFAULT VALUE

Catalog directive

EXAMPLES

CartTriggerQuantity yes

NOTES

It must be noted that the Interchange cart subsystem is based on arrayrefs of hashrefs (all Perl programming terms) — there is no object encapsulation for limiting or monitoring program access to the contents of any cart. Consequently, direct manipulation of the cart from within Perl will not cause these triggers to fire. The triggers only fire when the cart contents are modified through the standard Interchange CGI-based variable processing. Therefore, it is assumed (for the moment, at least) that any programmer sufficiently comfortable or confident to manipulate cart contents directly can also be given the responsibility of deciding whether or not it is appropriate to invoke cart triggers along the way.

AVAILABILITY

CartTriggerQuantity is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['CartTriggerQuantity',  'yesno',     'no'],

sub parse_yesno {
my($var, $value) = @_;
$_ = $value;
if (m/^y/i || m/^t/i || m/^1/ || m/^on/i) {
  return 1;
}
elsif (m/^n/i || m/^f/i || m/^0/ || m/^of/i) {
  return 0;
}
else {
  config_error("Use 'yes' or 'no' for the $var directive\n");
}
}

AUTHORS

Interchange Development Group

SEE ALSO

CartTrigger(7ic), ItemAction(7ic)

SYNOPSIS

DESCRIPTION

The directive registers a catalog that will run on the corresponding Interchange installation.

The directive expects three or more arguments.

First expected is the name of the catalog. It will be referred to by the specified name in error, warning, and informational messages. It must contain only alphanumeric characters, hyphens, and underscores. It is highly recommended that it is also all lowercase.

Second argument specifies the filesystem base directory of the catalog. If the directory does not exist, the required catalog.cfg is not there, or Interchange detects any other problem, catalog configuration will be skipped and the catalog won't be activated.

Third argument is the so called SCRIPT_NAME of the link program. It is a webserver path by which the catalog can be accessed. It can be followed by different aliases, all allowing access to the same catalog. For example, this is useful when calling an SSL server or a members-only alias that requires a Basic HTTP authorization using the username/password pair. All subsequently generated links would be called using the aliased URL.

The script name must be unique among CGI program paths that run on the Interchange server, unless the FullUrl directive is specified. In this case, hostnames can be added to differentiate otherwise same paths; as usual, see the section called “EXAMPLES” for clarification.

It is also possible to define catalog-specific configuration directives from the global interchange.cfg file. Again, see the section called “EXAMPLES”.

DIRECTIVE TYPE AND DEFAULT VALUE

Global directive

EXAMPLES

Catalog simple /home/catalogs/simple /cgi-bin/ic/simple

FullUrl yes

Catalog simple1 /home/catalogs/simple1 www.company1.com/cgi-bin/ic/simple
Catalog simple2 /home/catalogs/simple2 www.company2.com/cgi-bin/ic/simple

Catalog simple  directory /home/catalogs/simple
Catalog simple  script    /cgi-bin/ic/simple
Catalog simple  alias     /simple

Catalog simple  directive ErrorFile /var/log/interchange/simple-error.log

NOTES

Catalog is one of the basic Interchange configuration directives.

makecat, the catalog creation helper script, automatically inserts the Catalog line in the interchange.cfg file as part of the standard procedure.

If the catalog.cfg file, expected in the catalog base directory, is not found, or is unreadable by the Interchange server, somewhat misguiding error message will be reported. Instead of the appropriate permissions-problem message, the mandatory VendURL directive will be reported as undefined.

AVAILABILITY

Catalog is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['Catalog',       'catalog',        ''],

sub parse_catalog {
my ($var, $setting) = @_;
my $num = ! defined $Global::Catalog ? 0 : $Global::Catalog;
return $num unless (defined $setting && $setting); 

my($name,$base,$dir,$script, @rest);
($name,@rest) = Text::ParseWords::shellwords($setting);

my %remap = qw/
        base      base
        alias     alias
        aliases   alias
        directory dir
        dir       dir
        script    script
        directive directive
        fullurl   full_url
        full      full_url
        /;

my ($cat, $key, $value);
if ($Global::Catalog{$name}) {
  # already defined
  $cat   = $Global::Catalog{$name};
  $key   = shift @rest;
  $value = shift @rest;
}
elsif(
    $var =~ /subcatalog/i and
    @rest > 2
    and file_name_is_absolute($rest[1]) 
    )
{
  $cat = {
    name   => $name,
    base   => $rest[0],
    dir    => $rest[1],
    script => $rest[2],
  };
  splice(@rest, 0, 3);
  $cat->{alias} = [ @rest ]
    if @rest;
}
elsif( file_name_is_absolute($rest[0]) ) {
  $cat = {
    name   => $name,
    dir    => $rest[0],
    script => $rest[1],
  };
  splice(@rest, 0, 2);
  $cat->{alias} = [ @rest ]
    if @rest;
}
else {
  $key   = shift @rest;
  $value = shift @rest;
  $cat = { name   => $name };
}

$key = $remap{$key} if $key && defined $remap{$key};

if(! $key) {
  # Nada
}
elsif($key eq 'alias' or $key eq 'server') {
  $cat->{$key} = [] if ! $cat->{$key};
  push @{$cat->{$key}}, $value;
  push @{$cat->{$key}}, @rest if @rest;
}
elsif($key eq 'global') {
  $cat->{$key} = $Global::AllowGlobal->{$name} = is_yes($value);
}
elsif($key eq 'directive') {
  no strict 'refs';
  my $p = $value;
  my $v = join " ", @rest;
  $cat->{$key} = {} if ! $cat->{$key};
  my $ref = set_directive($p, $v, 1);

  if(ref $ref->[1] =~ /HASH/) {
    if(! $cat->{$key}{$ref->[0]} ) {
      $cat->{$key}{$ref->[0]} =  { %{"Global::$ref->[0]"} };
    }
    for (keys %{$ref->[1]}) {
      $cat->{$key}{$ref->[0]}{$_} = $ref->[1]->{$_};
    }
  }
  else {
    $cat->{$key}{$ref->[0]} = $ref->[1];
  }
}
else {
  $cat->{$key} = $value;
}

#::logDebug ("parsing catalog $name = " . uneval_it($cat));

$Global::Catalog{$name} = $cat;

# Define the main script name and array of aliases
return ++$num;
}

AUTHORS

Interchange Development Group

SEE ALSO

FullUrl(7ic), ConfigDatabase(7ic), SubCatalog(7ic), MailOrderTo(7ic)

SYNOPSIS

DESCRIPTION

The directive specifies catalogs and the corresponding usernames which will be used in accessing files with absolute pathnames. Actually, the file access itself is still performed under the Interchange server username, but the CatalogUser values are used for a "would-be" kind of check.

This directive is only honored when NoAbsolute is enabled. Then, the situation is as follows:

DIRECTIVE TYPE AND DEFAULT VALUE

Global directive

EXAMPLES

CatalogUser  foundation  joe
CatalogUser  reports     jane

NOTES

AVAILABILITY

CatalogUser is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['CatalogUser',     'hash',       ''],

sub parse_hash {
my($item,$settings) = @_;
if (! $settings) {
  return $HashDefaultBlank{$item} ? '' : {};
}

my $c;

if(defined $C) {
  $c = $C->{$item} || {};
}
else {
  no strict 'refs';
  $c = ${"Global::$item"} || {};
}

return hash_string($settings,$c);
}

AUTHORS

Interchange Development Group

SEE ALSO

SYNOPSIS

DESCRIPTION

By default, Interchange expects item category to be in the category field in the database, if a system of categories is used. This directive allows modification of the default name.

DIRECTIVE TYPE AND DEFAULT VALUE

Catalog directive

EXAMPLES

CategoryField type

NOTES

The field can also be set according to a Locale.

AVAILABILITY

CategoryField is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['CategoryField',    undef,              'category'],

AUTHORS

Interchange Development Group

SEE ALSO

SYNOPSIS

DESCRIPTION

Defines the name of an external program which will be invoked to check the generated page HTML code for correctness (/usr/bin/weblint, for example).

Note that you need to put [flag checkhtml] on your page, (or wrap only a block of HTML code to check in [tag flag checkhtml]...[/tag]) to trigger the actual invocation of the specified external command.

The output of the HTML checker program will be included in the output page, so you might want to wrap it in HTML comments (<!-- ... -->). Then you can check it out by viewing the HTML page source in your browser.

If you want a quick way to enable or disable this feature, without modifying each HTML page individually, put __CHECK_HTML__ on every page (or ideally, in a template). Then, to enable the checker, define Variable CHECK_HTML [flag checkhtml] in interchange.cfg. To disable it, leave the variable value empty.

DIRECTIVE TYPE AND DEFAULT VALUE

Global directive

EXAMPLES

CheckHTML /usr/local/bin/weblint --structure --fluff -

NOTES

Leaving this directive enabled on a production server usually leads to unnecessary performance degradation. The additional process spawn (and the time it takes to complete) every time a page is visited is costly.

Additionally, this directive currently appears to be broken (it simply never gets called).

AVAILABILITY

CheckHTML is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['CheckHTML',      undef,            ''],

AUTHORS

Interchange Development Group

SEE ALSO

SYNOPSIS

DESCRIPTION

Interchange page servers are, by default, periodically restarted to make sure there are no problems arising from long-running processes (such as memory leaks).

In general, restarting is handled by the MaxRequestsPerChild configuration directive.

However, when PreFork ic run mode is used, some page servers never win the page server "selection battle"; they never get to serve a page request and consequently they are never restarted by MaxRequestsPerChild. This is why the ChildLife directive restarts a page server on an unconditional, periodic basis to make sure all servers are re-started from time to time.

If ChildLife is not set, the "starved" page servers will act just like they did before; get stuck in an internal loop forever until kill -9 on the process happens.

This should clear up the problem where people see with a growing number of servers over time.

DIRECTIVE TYPE AND DEFAULT VALUE

Global directive

EXAMPLES

ChildLife 30 minutes

NOTES

The directive should only be used when Interchange is in PreFork ic run mode.

The directive value can be any Interchange interval.

AVAILABILITY

ChildLife is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['ChildLife',         'time',             0],

sub parse_time {
my($var, $value) = @_;
my($n);

return $value unless $value;

#  $C->{Source}->{$var} = [$value];

$n = time_to_seconds($value);
config_error("Bad time format ('$value') in the $var directive\n")
unless defined $n;
$n;
}

AUTHORS

Mike Heins

SEE ALSO

MaxRequestsPerChild(7ic), PIDcheck(7ic), PIDfile(7ic), MaxServers(7ic), PreFork(7ic)

SYNOPSIS

DESCRIPTION

A generic Perl subroutine mapper which allows mapping of subroutines to ActionMaps, CoreTags, UserTags, filters, form actions, GlobalSubs, ItemActions, SearchOps, LocaleChanges, OrderChecks, and Widgets.

DIRECTIVE TYPE AND DEFAULT VALUE

Global directive,
Catalog directive

EXAMPLES

CodeDef find_hammer SearchOp find_hammer

CodeDef find_hammer Routine <<EOR
sub {
  # Called with:
  # $self - search object
  # $i - index into coordinated search array
  # $string - data to match
  # $opname - name of the specified mv_column_op

  my($self, $i, $string, $opname);
  #::logDebug("Calling fake SearchOp");
  return sub {
    #::logDebug("testing with fake SearchOp");
    my $string = shift;
    $string =~ /hammer/i;
  };
}
EOR

NOTES

AVAILABILITY

CodeDef is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['CodeDef',       'mapped_code',     ''],

['CodeDef',       'mapped_code',       ''],

sub parse_mapped_code {
my ($var, $value) = @_;

return {} if ! $value;

## Can't give CodeDef a default or this will be premature
get_system_code() unless defined $SystemCodeDone;

my($tag,$p,$val) = split /\s+/, $value, 3;

# Canonicalize
$p = $tagCanon{lc $p} || ''
  or ::logDebug("bizarre mapped code line '$value'");
$tag =~ tr/-/_/;
$tag =~ s/\W//g
  and config_warn("Bad characters removed from '%s'.", $tag);

my $repos = $C ? ($C->{CodeDef} ||= {}) : ($Global::CodeDef ||= {});

if ($tagSkip{$p}) {
  return $repos;
}

my $dest = $valid_dest{lc $p} || $current_dest{$tag} || $CodeDest;

if(! $dest) {
  config_warn("no destination for %s %s, skipping.", $var, $tag);
  return $repos;
}
$current_dest{$tag} = $dest;
$repos->{$dest} ||= {};

my $c = $repos->{$dest};

if($Compiled{$p}) {
  $c->{$Compiled{$p}} ||= {};
  parse_action($var, "$tag $val", $c->{$Compiled{$p}} ||= {});
}
elsif(defined $tagAry{$p}) {
  my(@v) = Text::ParseWords::shellwords($val);
  $c->{$p}{$tag} = [] unless defined $c->{$p}{$tag};
  push @{$c->{$p}{$tag}}, @v;
}
elsif(defined $tagHash{$p}) {
  my(%v) = Text::ParseWords::shellwords($val);
  $c->{$p}{$tag} = {} unless defined $c->{$p}{$tag};
  for (keys %v) {
    $c->{$p}{$tag}{$_} = $v{$_};
  }
}
elsif(defined $tagBool{$p}) {
  $c->{$p}{$tag} = 1
    unless defined $val and $val =~ /^[0nf]/i;
}
else {
  config_warn("%s %s scalar parameter %s redefined.", $var, $tag, $p)
    if defined $c->{$p}{$tag};
  $c->{$p}{$tag} = $val;
}

return $repos;
}

AUTHORS

Interchange Development Group

SEE ALSO

Filter(7ic), FormAction(7ic), ActionMap(7ic), UserTag(7ic), ItemAction(7ic), GlobalSub(7ic), Sub(7ic)

SYNOPSIS

DESCRIPTION

There is a huge base of Interchange code (collection of UserTags and CodeDefs) included in the default installation. Much of it is not needed for the usual installations, causing a larger process memory profile than necessary.

Furthermore, it is hard to manually determine what subset of code is required, especially when an ITL tag calls $Tag->TAGNAME() which calls some filter which calls some sort of an action — you get the idea.

CodeRepository allows building catalogs with a more optimal set of code than just "everything".

CodeRepository depends on a related directive, AccumulateCode. If AccumulateCode is disabled, operation is traditional and everything gets loaded at Interchange startup time. (There have been some code initialization changes and routine calling changes, but the data structures are identical and no difference in operation should be seen).

It's when you remove the ICROOT/code/ directory and enable AccumulateCode that things get interesting. Interchange starts looking into CodeRepository for pieces it finds missing (ITL tags, ActionMaps, filters, widgets, etc.) and compiles these as needed, in runtime! The code is sent to the master process for compilation and incorporation, so that on the next page access (or in the worst case, after HouseKeeping seconds), Interchange will find the code already compiled and ready to go.

Fetched code blocks are copied to $Global::TagDir/Accumulated/. When you restart Interchange the next time, these code blocks will be found, read normally and need not be recompiled and loaded on the fly again.

Over time, as you access pages and routines, a full set of tags will be developed and you can then disable AccumulateCode. (In fact, AccumulateCode is recommended only for development and should really be turned off in production systems).

DIRECTIVE TYPE AND DEFAULT VALUE

Global directive

EXAMPLES

AccumulateCode Yes
CodeRepository /usr/interchange/code.pool/

$ mkdir /usr/interchange/code.pool/
$ mv /usr/interchange/code/* /usr/interchange/code.pool/

NOTES

There can be failures due to calling $Tag->TAGNAME() from within embedded Perl for the first time, particularly when it uses a "MapRoutine" or calls another $Tag->TAGNAME() within. This is due to Safe, and there is probably not much to be done about it. The good news is that the error should go away after HouseKeeping seconds, when the tag gets compiled by the master. area, tmp, tmpn, and image are examples of tags known to fail in this manner. Tags that are frequently called in this fashion should probably be manually placed in directory code/Vital/ and not be accumulated "by chance". Anyway, this temporary failure could be avoided by listing catalog in the AllowGlobal directive, and it might also be possible to make a directive that allows AllowGlobal for a catalog automatically, when in AccumulateCode mode. (If you don't want to trade immediate code loading for the lack of AllowGlobal protection, then just set HouseKeeping to something like 20 seconds — and only do it on your development system!)

One convenient side-effect is that you can easily load new code (such as new Interchange tags) "on the fly" by simply adding files to the CodeRepository directory. This alleviates the need for Interchange server restart. It might also be possible to dynamically remove and load code from the server in this manner, but this has yet to be looked at.

Warning

Nice features are often dangerous! Don't run this in production — you have been warned! "OrderCheck" CodeDef is not yet implemented, and a full audit has not been done on all compiled code directives. Not fully tested in PreFork mode, and really not intended for that mode. Defining multiple tags or code blocks (UserTags or CodeDefs) within a single file may result in an unpredictable behavior. This feature only applies to global code — catalog-based code is not affected and behaves as usual.

AVAILABILITY

CodeRepository is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['CodeRepository',   'root_dir',         ''],

sub parse_root_dir {
my($var, $value) = @_;
return '' unless $value;
$value = "$Global::VendRoot/$value"
  unless file_name_is_absolute($value);
$value =~ s./+$..;
return $value;
}

AUTHORS

Mike Heins

SEE ALSO

AccumulateCode(7ic)

SYNOPSIS

DESCRIPTION

CommonAdjust is used to define the default settings for a flexible, chained item pricing scheme.

The whole pricing idea and the explanation of CommonAdjust strings can be found under the price glossary entry. Make sure you read it, or you'll have only a limited success with the section called “EXAMPLES”.

DIRECTIVE TYPE AND DEFAULT VALUE

Catalog directive

EXAMPLES

code	common	q1	q5	q10	XL	S	red
99-102		10	9	8	1	-0.50	0.75
00-343					2		
red	0.75						

10.00, ==size:pricing

10.00, ==size:pricing, ==color:pricing

10.00, ==size:pricing, ==color:pricing:common

blue	0.50

pricing:q1,q5,q10:, ;10.00, ==size:pricing, ==color:pricing:common

pricing:q1,q5,q10:, ;10.00  ==size:pricing, ==color:pricing:common

sku      price_group   q5   q10   q25
os28004  group_a       10     9     8
os28008  group_a       20    18    17

pricing:price_group,q5,q10,q25

NOTES

AVAILABILITY

CommonAdjust is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['CommonAdjust',   undef,            ''],

AUTHORS

Interchange Development Group

SEE ALSO

UseModifier(7ic)

SYNOPSIS

DESCRIPTION

Specify catalog "config" directory. By default, this is etc/ inside CATROOT.

DIRECTIVE TYPE AND DEFAULT VALUE

Catalog directive

EXAMPLES

ConfDir etc2

NOTES

Make sure you don't get confused by the existence of all DirConfig, ConfDir and ConfigDir.

AVAILABILITY

ConfDir is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['ConfDir',          'relative_dir',   'etc'],

sub parse_relative_dir {
my($var, $value) = @_;

if (absolute_or_relative($value)) {
  config_error('Path %s not allowed in %s directive',
          $value, $var);
}

$C->{Source}{$var} = $value;

$value = "$C->{VendRoot}/$value"
  unless file_name_is_absolute($value);
$value =~ s./+$..;
$value;
}

AUTHORS

Interchange Development Group

SEE ALSO

SYNOPSIS

DESCRIPTION

Specify configuration files to read as a part of every catalog's configuration, after all other corresponding catalog config files are processed.

This is useful to catch user configuration errors, supply missing values, or force your settings over user's configuration.

DIRECTIVE TYPE AND DEFAULT VALUE

Global directive

EXAMPLES

ConfigAllAfter check_actions.cfg check_variables.cfg

NOTES

AVAILABILITY

ConfigAllAfter is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['ConfigAllAfter',   'root_dir_array',   'catalog_after.cfg'],

sub parse_root_dir_array {
my($var, $value) = @_;
return [] unless $value;

no strict 'refs';
my $c = ${"Global::$var"} || [];

my @dirs = grep /\S/, Text::ParseWords::shellwords($value);

foreach my $dir (@dirs) {
  $dir = "$Global::VendRoot/$dir"
    unless file_name_is_absolute($dir);
  $dir =~ s./+$..;
  push @$c, $dir;
}
return $c;
}

AUTHORS

Interchange Development Group

SEE ALSO

ConfigAllBefore(7ic)

SYNOPSIS

DESCRIPTION

Specify configuration files to read as a part of every catalog's configuration, before any other corresponding catalog config files are processed.

DIRECTIVE TYPE AND DEFAULT VALUE

Global directive

EXAMPLES

ConfigAllBefore set_actions.cfg set_variables.cfg

NOTES

AVAILABILITY

ConfigAllBefore is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['ConfigAllBefore',   'root_dir_array',   'catalog_before.cfg'],

sub parse_root_dir_array {
my($var, $value) = @_;
return [] unless $value;

no strict 'refs';
my $c = ${"Global::$var"} || [];

my @dirs = grep /\S/, Text::ParseWords::shellwords($value);

foreach my $dir (@dirs) {
  $dir = "$Global::VendRoot/$dir"
    unless file_name_is_absolute($dir);
  $dir =~ s./+$..;
  push @$c, $dir;
}
return $c;
}

AUTHORS

Interchange Development Group

SEE ALSO

ConfigAllAfter(7ic)

SYNOPSIS

DESCRIPTION

The directive allows one to keep the usual catalog.cfg definitions in a database table.

By using the special option LOAD, it is also possible to instruct Interchange to fill the database with initial data found in your catalog.cfg — just make sure to remove that option on subsequent restarts.

DIRECTIVE TYPE AND DEFAULT VALUE

Global directive,
Catalog directive

EXAMPLES

create table config (
  code  varchar(32) NOT NULL PRIMARY KEY,
	directive varchar(64) NOT NULL,
	value varchar(255),
	extended text
);     

code|directive|value|extended
C0001|VariableDatabase|variable
C0002|SessionExpire|2 hours|
C0003|Variable|foo|   bar          

VariableDatabase variable
SessionExpire  2 hours
Variable foo <<EOF
   bar
EOF  

ConfigDatabase config config.txt dbi:mysql:config
ConfigDatabase config LOAD 1

NOTES

Even though this appears to be both global and catalog configuration directive, it is only implemented on catalog level.

AVAILABILITY

ConfigDatabase is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['ConfigDatabase',   'config_db',       ''],

['ConfigDatabase',   'config_db',       ''],

sub parse_config_db {
my($name, $value) = @_;
my ($d, $new);
unless (defined $value && $value) { 
  $d = {};
  return $d;
}

if($C) {
  $d = $C->{ConfigDatabase};
}
else {
  $d = $Global::ConfigDatabase;
}

my($database,$remain) = split /[\s,]+/, $value, 2;

$d->{'name'} = $database;

if(!defined $d->{'file'}) {
  my($file, $type) = split /[\s,]+/, $remain, 2;
  $d->{'file'} = $file;
  if(    $type =~ /^\d+$/  ) {
    $d->{'type'} = $type;
  }
  elsif(  $type =~ /^(dbi|sql)\b/i  ) {
    $d->{'type'} = 8;
    if($type =~ /^dbi:/) {
      $d->{DSN} = $type;
    }
  }
# LDAP
  elsif(  $type =~ /^ldap\b/i) {
    $d->{'type'} = 9;
    if($type =~ /^ldap:(.*)/i) {
      $d->{LDAP_HOST} = $1;
    }
  }
# END LDAP
  elsif(  "\U$type" eq 'TAB'  ) {
    $d->{'type'} = 6;
  }
  elsif(  "\U$type" eq 'PIPE'  ) {
    $d->{'type'} = 5;
  }
  elsif(  "\U$type" eq 'CSV'  ) {
    $d->{'type'} = 4;
  }
  elsif(  "\U$type" eq 'DEFAULT'  ) {
    $d->{'type'} = 1;
  }
  elsif(  $type =~ /[%]{1,3}|percent/i  ) {
    $d->{'type'} = 3;
  }
  elsif(  $type =~ /line/i  ) {
    $d->{'type'} = 2;
  }
  else {
    $d->{'type'} = 1;
    $d->{DELIMITER} = $type;
  }
}
else {
  my($p, $val) = split /\s+/, $remain, 2;
  $p = uc $p;

  if(defined $Explode_ref{$p}) {
    my($ak, $v);
    my(@v) = Text::ParseWords::shellwords($val);
    @v = grep defined $_, @v;
    $d->{$p} = {} unless defined $d->{$p};
    for(@v) {
      my ($sk,$v) = split /\s*=\s*/, $_;
      my (@k) = grep /\w/, split /\s*,\s*/, $sk;
      for my $k (@k) {
        if($d->{$p}->{$k}) {
          config_warn(
            qq{Database %s explode parameter %s redefined to "%s", was "%s".},
            $d->{name},
            "$p --> $k",
            $v,
            $d->{$p}->{$k},
          );
        }
        $d->{$p}->{$k} = $v;
      }
    }
  }
  elsif(defined $Hash_ref{$p}) {
    my($k, $v);
    my(@v) = Vend::Util::quoted_comma_string($val);
    @v = grep defined $_, @v;
    $d->{$p} = {} unless defined $d->{$p};
    for(@v) {
      ($k,$v) = split /\s*=\s*/, $_;
      if($d->{$p}->{$k}) {
        config_warn(
          qq{Database %s hash parameter %s redefined to "%s", was "%s".},
          $d->{name},
          "$p --> $k",
          $v,
          $d->{$p}->{$k},
        );
      }
      $d->{$p}->{$k} = $v;
    }
  }
  elsif(defined $Ary_ref{$p}) {
    my(@v) = Text::ParseWords::shellwords($val);
    $d->{$p} = [] unless defined $d->{$p};
    push @{$d->{$p}}, @v;
  }
  else {
    defined $d->{$p}
    and ! defined $C->{DatabaseDefault}{$p}
      and config_warn(
          qq{Database %s scalar parameter %s redefined to "%s", was "%s".},
          $d->{name},
          $p,
          $val,
          $d->{$p},
        );
    $d->{$p} = $val;
  }
}

#::logDebug("d object: " . uneval_it($d));
if($d->{ACTIVE} and ! $d->{OBJECT}) {
  my $name = $d->{'name'};
  $d->{OBJECT} = Vend::Data::import_database($d)
    or config_error("Config database $name failed import.\n");
}
elsif($d->{LOAD} and ! $d->{OBJECT}) {
  my $name = $d->{'name'};
  $d->{OBJECT} = Vend::Data::import_database($d)
    or config_error("Config database $name failed import.\n");
  if( $d->{type} == 8 ) {
    $d->{OBJECT}->set_query("delete from $name where 1 = 1");
  }
}

return $d;

}

AUTHORS

Mike Heins

SEE ALSO

Catalog(7ic)

SYNOPSIS

DESCRIPTION

Specify the default "include" directory for files that are specified using the <filename notation and have a relative pathname. See the section called “EXAMPLES” for clarification.

DIRECTIVE TYPE AND DEFAULT VALUE

Global directive,
Catalog directive

EXAMPLES

ConfigDir variables

MailOrderTo <mailorderto

NOTES

See the configuration glossary entry for complete information on Interchange config file syntax.

Make sure you don't get confused by the existence of all DirConfig, ConfDir and ConfigDir.

AVAILABILITY

ConfigDir is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['ConfigDir',      undef,           'etc/lib'],

['ConfigDir',        'relative_dir',   'config'],

sub parse_relative_dir {
my($var, $value) = @_;

if (absolute_or_relative($value)) {
  config_error('Path %s not allowed in %s directive',
          $value, $var);
}

$C->{Source}{$var} = $value;

$value = "$C->{VendRoot}/$value"
  unless file_name_is_absolute($value);
$value =~ s./+$..;
$value;
}

AUTHORS

Interchange Development Group

SEE ALSO

SYNOPSIS

DESCRIPTION

When disabled (set to No), configuration meta-directives such as #include, #ifdef and #ifndef, are treated as pure comments with no specific meaning.

However, since those were originally borrowed from the C preprocessor, and, true to their C heritage, they started with an '#' (hash) character in Interchange versions up to and including 4.6.

This was inconvenient for newcomers who were easily misguided by thinking those were just comments, so Interchange versions 4.7 and up were changed to use the meta-directives without the hash prefix.

DIRECTIVE TYPE AND DEFAULT VALUE

Global directive,
Catalog directive

EXAMPLES

ConfigParseComments No

#include comment
# This, and the above line, are pure comments.

# You better prepare the file named 'comment' for the following one:
include comment

NOTES

This directive is obsolete as of Interchange 5.5.0, and the behavior is as if ConfigParseComments No was specified.

AVAILABILITY

ConfigParseComments is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['ConfigParseComments',     'warn',     ''],

['ConfigParseComments',     'warn',     ''],

sub parse_warn {
my($name, $val) = @_;

return '' unless $val;

::logGlobal({level => 'info'},
      errmsg("Directive %s no longer supported at line %s of %s.",
          $name,
          $.,
          $configfile,
      )
);
}

AUTHORS

SEE ALSO

SYNOPSIS

DESCRIPTION

The directive specifies the domain common to all servers providing Interchange content.

By default, the session ID cookie domain is set to the hostname you're accessing. For example, if you access the catalog using server myhost.mydomain.local, then cookie will be set by myhost.mydomain.local.

Things, however, go bad if you use more Interchange servers (in a non-transparent way for the user) to provide content. For example, if SSL content was served from host ssl.mydomain.local, then users would have one session for myhost.mydomain.local and another for ssl.mydomain.local. This is undesired, of course.

To fix the described problem, we need to find part of the FQDN that is common to all servers (mydomain.local in our example), and add it as the domain= parameter to the Set-Cookie directive that we send off to users' browsers. That's what the CookieDomain does.

CookieDomain accepts a space-separated list of domains to set cookies for, in which case the Set-Cookie: ... is sent to the client for each of the specified domains. Due to the cookie restrictions described in the section called “NOTES”, specifying multiple domains is only rarely (if ever?) needed and possible to implement.

DIRECTIVE TYPE AND DEFAULT VALUE

Catalog directive

EXAMPLES

CookieDomain .mydomain.local

NOTES

The cookie specification mandates that the domain part must contain at least two fields (or 1 dot lying in between). The value of .mydomain.local is valid, but .local wouldn't be.

Furthermore, cookie source can only be the FQDN of the host itself, or some of the subdomains, or domain it belongs to. Browsers will ignore all cookies that do not satisfy this requirement. Host myhost.mydomain.local can set a cookie for itself or the domain mydomain.local, but it cannot set a cookie for say, mydomain.local2. It is very fortunate we have this protection, or unrelated sites would read and set each other's cookies — something we definitely don't want to happen!

At least in Mozilla-like browsers, the domain is prefixed with a dot even if you omit it in the CookieDomain specification (mydomain.local ends up being the same as .mydomain.local).

For a complete discussion on cookies, see cookie glossary entry.

AVAILABILITY

CookieDomain is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['CookieDomain',     undef,              ''],

AUTHORS

Interchange Development Group

SEE ALSO

Cookies(7ic), Mall(7ic), CookieLogin(7ic), SaveExpire(7ic)

SYNOPSIS

DESCRIPTION

The directive allows Interchange to save users' authentication info (username/password) in a cookie. Cookie expiration time is set by SaveExpire and is renewed each time they log in.

If the login and password information can be read from a cookie, then users can be logged in to the site automatically as they visit it.

DIRECTIVE TYPE AND DEFAULT VALUE

Catalog directive

EXAMPLES

CookieLogin 1

NOTES

To cause the cookie to be generated originally, mv_cookie_password and/or mv_cookie_username must be set to a true value. The former causes both username and password to be saved; the latter just the username.

For a complete discussion on cookies, see cookie glossary entry.

AVAILABILITY

CookieLogin is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['CookieLogin',      'yesno',            'No'],

sub parse_yesno {
my($var, $value) = @_;
$_ = $value;
if (m/^y/i || m/^t/i || m/^1/ || m/^on/i) {
  return 1;
}
elsif (m/^n/i || m/^f/i || m/^0/ || m/^of/i) {
  return 0;
}
else {
  config_error("Use 'yes' or 'no' for the $var directive\n");
}
}

AUTHORS

Interchange Development Group

SEE ALSO

CookieDomain(7ic), Cookies(7ic), Mall(7ic), SaveExpire(7ic), CookieName(7ic)

SYNOPSIS

DESCRIPTION

The directive sets the name of the Interchange cookie that will be used to retrieve session ID information in users' browsers. The default value is MV_SESSION_ID.

The default should never be changed, but this configuration directive can save the day if you need to use cookies issued by programs other than Interchange itself.

DIRECTIVE TYPE AND DEFAULT VALUE

Catalog directive

EXAMPLES

CookieName SESSIONID

NOTES

By default, Interchange cookie planted in user's browser consists of a session ID followed by a colon followed by an IP address, username or domain name.

If the cookie is generated by another program and CookieName is set appropriately, Interchange will take it over without modification.

For a complete discussion on cookies, see cookie glossary entry.

AVAILABILITY

CookieName is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['CookieName',     undef,            ''],

AUTHORS

Interchange Development Group

SEE ALSO

Cookies(7ic), CookiePattern(7ic), CookieLogin(7ic)

SYNOPSIS

DESCRIPTION

The directive sets the regular expression that Interchange will use to extract the session ID out of the client browser's cookie.

This is useful in extracting session IDs out of cookies generated by programs other than Interchange.

DIRECTIVE TYPE AND DEFAULT VALUE

Catalog directive

EXAMPLES

CookiePattern \w{8,32}

NOTES

By default, Interchange cookie planted in user's browser consists of a session ID followed by a colon followed by an IP address, username or domain name.

AVAILABILITY

CookiePattern is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['CookiePattern',   'regex',            '[-\w:.]+'],

sub parse_regex {
my($var, $value) = @_;

eval {  
  my $never = 'NeVAirBE';
  $never =~ m{$value};
};

if($@) {
  config_error("Bad regular expression in $var.");
}
return $value;
}

AUTHORS

Interchange Development Group

SEE ALSO

Cookies(7ic), CookieName(7ic), Limit(7ic)

SYNOPSIS

DESCRIPTION

The directive determines whether Interchange will send cookie to the client and read it back to keep track of session ID.

For a complete discussion on cookies, see cookie glossary entry.

DIRECTIVE TYPE AND DEFAULT VALUE

Catalog directive

EXAMPLES

Cookies 0

NOTES

AVAILABILITY

Cookies is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['Cookies',       'yesno',            'Yes'],

sub parse_yesno {
my($var, $value) = @_;
$_ = $value;
if (m/^y/i || m/^t/i || m/^1/ || m/^on/i) {
  return 1;
}
elsif (m/^n/i || m/^f/i || m/^0/ || m/^of/i) {
  return 0;
}
else {
  config_error("Use 'yes' or 'no' for the $var directive\n");
}
}

AUTHORS

Interchange Development Group

SEE ALSO

CookieDomain(7ic), CookieName(7ic), CookiePattern(7ic), Mall(7ic), CookieLogin(7ic), SaveExpire(7ic)

SYNOPSIS

DESCRIPTION

This directive enables Interchange to take ccTLDs into account when DomainTail is enabled.

For example, if a visit comes from an address like "machine.example.co.uk" and co.uk is listed as ccTLD, then, with CountrySubdomains, "example.co.uk" would be used as domain tail instead of just "co.uk".

CountrySubdomains accepts a list of country codes and their subdomains. A predefined, ready for use configuration block can be found in file dist/subdomains.cfg in Interchange source and should be included from interchange.cfg.

DIRECTIVE TYPE AND DEFAULT VALUE

Global directive

EXAMPLES

include subdomains.cfg

CountrySubdomains <<EOC
  ae "ac gov mil name net org pro sch"
  af "bank com edu gov hotel law music net org tv"
  ag "co com org net nom"
  al "com edu gov net org"
  ao "co ed gv it og pb"
EOC

CountrySubdomains ar "com edu gov int mil net org" at "ac co gv or priv"

NOTES

AVAILABILITY

CountrySubdomains is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['CountrySubdomains','hash',             ''],

sub parse_hash {
my($item,$settings) = @_;
if (! $settings) {
  return $HashDefaultBlank{$item} ? '' : {};
}

my $c;

if(defined $C) {
  $c = $C->{$item} || {};
}
else {
  no strict 'refs';
  $c = ${"Global::$item"} || {};
}

return hash_string($settings,$c);
}

AUTHORS

Kevin Walsh

SEE ALSO

WideOpen(7ic), IpHead(7ic), IpQuad(7ic), DomainTail(7ic)

SYNOPSIS

DESCRIPTION

The directive enables automatic encryption and saving of credit card information.

The EncryptProgram directive must be configured and working first.

DIRECTIVE TYPE AND DEFAULT VALUE

Catalog directive

EXAMPLES

CreditCardAuto Yes

NOTES

AVAILABILITY

CreditCardAuto is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['CreditCardAuto',   'yesno',            'No'],

sub parse_yesno {
my($var, $value) = @_;
$_ = $value;
if (m/^y/i || m/^t/i || m/^1/ || m/^on/i) {
  return 1;
}
elsif (m/^n/i || m/^f/i || m/^0/ || m/^of/i) {
  return 0;
}
else {
  config_error("Use 'yes' or 'no' for the $var directive\n");
}
}

AUTHORS

Interchange Development Group

SEE ALSO

WideOpen(7ic), PGP(7ic), LockoutCommand(7ic), EncryptProgram(7ic)

SYNOPSIS

DESCRIPTION

The directive specifies the SQL query to use in obtaining data for shipping costs calculation.

The SQL query must start with select (case insensitive), or the directive is ignored. If no rows are returned from the query, an appropriate error message is issued.

DIRECTIVE TYPE AND DEFAULT VALUE

Catalog directive

EXAMPLES

CustomShipping select * from shipping

NOTES

AVAILABILITY

CustomShipping is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['CustomShipping',   undef,            ''],

AUTHORS

Interchange Development Group

SEE ALSO

SYNOPSIS

DESCRIPTION

The directive allows definition of realtime blocklist servers (special-purpose DNS servers) that should be contacted in order to verify client IP address "validity". This way, you can deny access to known-bad clients (such as ones coming in from open proxy servers).

Many fraudulent credit card orders are placed from open proxy machines to hide the actual identity of the criminal, so denying access to open-proxy visitors might be a good idea.

DIRECTIVE TYPE AND DEFAULT VALUE

Global directive

EXAMPLES

DNSBL opm.blitzed.org cbl.abuseat.org sbl-xbl.spamhaus.org

NOTES

AVAILABILITY

DNSBL is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['DNSBL',            'array',            ''],

sub parse_array {
my($item,$settings) = @_;
return '' unless $settings;
my(@setting) = grep /\S/, split /[\s,]+/, $settings;

my $c;

if(defined $C) {
  $c = $C->{$item} || [];
}
else {
  no strict 'refs';
  $c = ${"Global::$item"} || [];
}

for (@setting) {
  check_legal($item, $_);
  push @{$c}, $_;
}
$c;
}

AUTHORS

Interchange Development Group

SEE ALSO

HammerLock(7ic), LockoutCommand(7ic)

SYNOPSIS

DESCRIPTION

Trace Perl DBI calls with variable granularity. As this tends to produce large amounts of output, only use it if there's a strong chance that your problem is related to DBI.

Setting of 0 disables tracing.
Setting of 1 traces DBI method calls with return values (or errors).
Setting of 2 traces as (1) plus the parameters used in method calls.
Setting of 3 traces as (2) plus some high-level information from the driver, and some internal information from the DBI
Setting of 4 traces as (3) plus more detailed information from the driver. Also includes DBI mutex information when using threaded Perl
Setting of 5 traces as (4) plus more and more obscure information.

Trace level of 1 is suitable in most situations.

DIRECTIVE TYPE AND DEFAULT VALUE

Global directive

EXAMPLES

Variable DEBUG 1
DebugFile /tmp/icdebug

DataTrace 1

NOTES

Keep in mind that, since the trace output is directed to the debug file, you need to have the DEBUG global variable defined, and DebugFile properly set.

AVAILABILITY

DataTrace is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['DataTrace',     'integer',        0],

sub parse_integer {
my($var, $value) = @_;
$value = hex($value) if $value =~ /^0x[\dA-Fa-f]+$/;
$value = oct($value) if $value =~ /^0[0-7]+$/;
config_error("The $var directive (now set to '$value') must be an integer\n")
  unless $value =~ /^\d+$/;
$value;
}

AUTHORS

Interchange Development Group

SEE ALSO

DebugFile(7ic), DEBUG(7ic), DumpStructure(7ic), EncryptProgram(7ic)

SYNOPSIS

DESCRIPTION

The directive registers a database table for use with Interchange. table_name specifies an arbitrary name — name that will be used to refer to the table within Interchange. Names can be composed of alphanumeric characters including underscore, and we recommend they're in all lower- or upper-case.

source_file specifies the initial database text source file, and type specifies database format.

For more about Interchange and databases, and supported formats, see database glossary entry.

DIRECTIVE TYPE AND DEFAULT VALUE

Global directive,
Catalog directive

EXAMPLES

Database products products.txt TAB

Database reviews reviews.txt CSV

DatabaseAutoIgnore ^sql_
DatabaseAuto __SQLDSN__
NoImportExternal Yes

#
# Required for PostgreSQL
#
Require module DBI
Require module DBD::Pg

Variable SQLDSN dbi:Pg:dbname=database_name
Variable SQLUSER username
Variable SQLPASS password
Variable SOME_DATABASE 1

<ParseVariables Yes>

DatabaseDefault USER __SQLUSER__
DatabaseDefault PASS __SQLPASS__
DatabaseDefault NO_ASCII_INDEX 1

Message -i -n Using PostgreSQL, DSN=__SQLDSN__...

#
# Individual database table definitions
#

Database  table_name  table_name.txt   __SQLDSN__

</ParseVariables>

#
# Optional table descriptions
#

Database  table_name  LENGTH_EXCEPTION_DEFAULT  truncate_log
Database  table_name  DEFAULT_TYPE varchar(255)

Database  table_name  KEY          sku
Database  table_name  HIDE_FIELD   inactive

Database  table_name  COLUMN_DEF   "sku=varchar(64) NOT NULL PRIMARY KEY"
Database  table_name  COLUMN_DEF   "description=varchar(128)"
Database  table_name  COLUMN_DEF   "price=varchar(12)"

Database  table_name  INDEX        description
Database  table_name  INDEX        price

sku	description	price

NOTES

In Interchange, words table and database are used to refer to the same thing — database table.

Defining databases on an Interchange (global) level won't work. If you want to share databases among catalogs, define them in each catalog.cfg separately (possibly by including the generic file with Database definitions).

AVAILABILITY

Database is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['Database',     'database',         ''],

['Database',       'database',        ''],

sub parse_database {
my ($var, $value) = @_;
my ($c, $new);

if (! $value) {
  $c = {};
  return $c;
}

$c = $C ? $C->{Database} : $Global::Database;

my($database,$remain) = split /[\s,]+/, $value, 2;

if( ! defined $c->{$database} ) {
  $c->{$database} = { 'name' => $database, included_from => $configfile };
  $new = 1;
}

my $d = $c->{$database};

if($new) {
  my($file, $type) = split /[\s,]+/, $remain, 2;
  $d->{'file'} = $file;
  if($file eq 'AUTO_SEQUENCE') {
    # database table missing for AUTO_SEQUENCE directive
    config_error('Missing database %s for AUTO_SEQUENCE %s.', $database, $type);
    return $c;
  }
  if(    $type =~ /^\d+$/  ) {
    $d->{'type'} = $type;
  }
  elsif(  $type =~ /^(dbi|sql)\b/i  ) {
    $d->{'type'} = 8;
    if($type =~ /^dbi:/) {
      $d->{DSN} = $type;
    }
  }
# LDAP
  elsif(  $type =~ /^ldap\b/i) {
    $d->{'type'} = 9;
    if($type =~ /^ldap:(.*)/i) {
      $d->{LDAP_HOST} = $1;
    }
  }
# END LDAP
  elsif(  $type =~ /^ic:(\w*)(:(.*))?/ ) {
    my $class = $1;
    my $dir = $3;
    $d->{DIR} = $dir if $dir;
    if($class =~ /^default$/i) {
      # Do nothing
    }
    elsif($class) {
      $class = uc $class;
      if(! $Vend::Data::db_config{$class}) {
        config_error("unrecognized IC database class: %s (from %s)", $class, $type);
      }
      $d->{Class} = $class;
    }
    $d->{'type'} = 6;
  }
  elsif(  "\U$type" eq 'TAB'  ) {
    $d->{'type'} = 6;
  }
  elsif(  "\U$type" eq 'PIPE'  ) {
    $d->{'type'} = 5;
  }
  elsif(  "\U$type" eq 'CSV'  ) {
    $d->{'type'} = 4;
  }
  elsif(  "\U$type" eq 'DEFAULT'  ) {
    $d->{'type'} = 1;
  }
  elsif(  $type =~ /[%]{1,3}|percent/i  ) {
    $d->{'type'} = 3;
  }
  elsif(  $type =~ /line/i  ) {
    $d->{'type'} = 2;
  }
  else {
    $d->{'type'} = 1;
    $d->{DELIMITER} = $type;
  }
  if    ($d->{'type'} eq '8')  { $d->{Class} = 'DBI'            }
  elsif ($d->{'type'} eq '9') { $d->{Class} = 'LDAP'            }
  else             { $d->{Class} ||= $Global::Default_database  }

  if($C and $C->{DatabaseDefault}) {
    while ( my($k, $v) = each %{$C->{DatabaseDefault}}) {
      $d->{$k} = $v;
    }
  }

  $d->{HOT} = 1 if $d->{Class} eq 'MEMORY';
#::logDebug("parse_database: type $type -> $d->{type}");
}
else {
  my($p, $val) = split /\s+/, $remain, 2;
  $p = uc $p;
#::logDebug("parse_database: parameter $p = $val");

  if(defined $Explode_ref{$p}) {
    my($ak, $v);
    $val =~ s/,+$//;
    $val =~ s/^,+//;
    my(@v) = Text::ParseWords::shellwords($val);
    @v = grep length $_, @v;
    $d->{$p} = {} unless defined $d->{$p};
    for(@v) {
      my ($sk,$v) = split /\s*=\s*/, $_;
      my (@k) = grep /\w/, split /\s*,\s*/, $sk;
      for my $k (@k) {
        if($d->{$p}->{$k}) {
          config_warn(
            qq{Database %s explode parameter %s redefined to "%s", was "%s".},
            $d->{name},
            "$p --> $k",
            $v,
            $d->{$p}->{$k},
          );
        }
        $d->{$p}->{$k} = $v;
      }
    }
  }
  elsif(defined $Hash_ref{$p}) {
    my($k, $v);
    my(@v) = Vend::Util::quoted_comma_string($val);
    @v = grep defined $_, @v;
    $d->{$p} = {} unless defined $d->{$p};
    for(@v) {
      ($k,$v) = split /\s*=\s*/, $_;
      if($d->{$p}->{$k}) {
        config_warn(
          qq{Database %s hash parameter %s redefined to "%s", was "%s".},
          $d->{name},
          "$p --> $k",
          $v,
          $d->{$p}->{$k},
        );
      }
      $d->{$p}->{$k} = $v;
    }
  }
  elsif(defined $Ary_ref{$p}) {
    my(@v) = Text::ParseWords::shellwords($val);
    $d->{$p} = [] unless defined $d->{$p};
    push @{$d->{$p}}, @v;
  }
  elsif ($p eq 'COMPOSITE_KEY') {
      ## Magic hardcode
    if($d->{type} == 8) {
      $d->{Class} = 'DBI_CompositeKey';
      $d->{$p} = $val;
    }
    else {
      config_warn(
        'Database %s parameter in type with no handling. Ignored.', 
        $p,
        );
    }
  }
  elsif ($p eq 'CLASS') {
    $d->{Class} = $val;
  }
  elsif ($p =~ /^(MEMORY|SDBM|GDBM|DB_FILE|LDAP)$/i) {
    $d->{Class} = uc $p;
  }
  elsif ($p eq 'ALIAS') {
    if (defined $c->{$val}) {
      config_warn("Database '%s' already exists, can't alias.", $val);
    }
    else {
      $c->{$val} = $d;
    }
  }
  elsif ($p =~ /^MAP/) {
    Vend::Table::Shadow::_parse_config_line ($d, $p, $val);
  }

  else {
    defined $d->{$p}
    and ! defined $C->{DatabaseDefault}{$p}
      and
      config_warn(
        qq{Database %s scalar parameter %s redefined to "%s", was "%s".},
        $d->{name},
        $p,
        $val,
        $d->{$p},
      );
    $d->{$p} = $val;
  }
  $d->{HOT} = 1 if $d->{Class} eq 'MEMORY';
}

return $c;
}

AUTHORS

Interchange Development Group

SEE ALSO

DatabaseDefault(7ic), data(7ic), TableRestrict(7ic), DatabaseAuto(7ic), UserDB(7ic), DirectiveDatabase(7ic), DatabaseAutoIgnore(7ic), UserDatabase(7ic)

SYNOPSIS

DESCRIPTION

The directive automatically registers database tables found for use with Interchange.

This only works for SQL databases, and the parameters provided to DatabaseAuto are used to establish the connection to the database.

For example, a setting of

DatabaseAuto   dbi:mysql:test_foundation  interch  pass

would do the equivalent of:

NoImport TABLENAME
Database TABLENAME TABLENAME.txt dbi:mysql:test_foundation
Database TABLENAME USER interch
Database TABLENAME PASS pass

for every table (and not view, by default) found in the database test_foundation.

Any additional space-separated arguments are passed to DBI's table_info method as the catalog, schema, name, and type (optionally quoted in shell syntax). Since order is significant, you could use '' to skip values.

Currently, the catalog argument is not used by any database driver, but it may be in the future. The other options (schema, name and type) are database-specific; see the DBI manual, appropriate DBD manual and the section called “EXAMPLES” for details and examples.

If the Perl module DBIx::DBSchema was found, it would also dump the specification needed to re-create the table structures (just like the CREATE_SQL parameter to Database):

Database  TABLENAME CREATE_SQL   CREATE TABLE TABLENAME ( ...)

This information is available in $Vend:Cfg (global context) or $Config (catalog context) and it is trivial to dump it to the screen or file. See the section called “EXAMPLES”.

DIRECTIVE TYPE AND DEFAULT VALUE

Catalog directive

EXAMPLES

create database interchange;
use interchange;
create table table1(code INT, price INT, description VARCHAR(60));
create table table2(code INT, price INT, description VARCHAR(60));
create table table3(code INT, price INT, description VARCHAR(60));
create table table4(code INT, price INT, description VARCHAR(60));
grant all privileges on interchange.* to interchange@localhost identified by 'pass';

DatabaseAuto dbi:mysql:interchange interchange pass

Require module DBIx::DBSchema

Creation sequence:
<pre>
[perl] $Config->{Database}->{table1}->{CREATE_SQL}; [/perl]
</pre>

DatabaseAuto dbi:Pg:dbname=DBNAME USERNAME PASSWORD '' public

DatabaseAuto dbi:Pg:dbname=DBNAME USERNAME PASSWORD  ''  public  ''  VIEW

Variable SQLDSN  dbi:Pg:dbname=DATABASE_NAME

DatabaseAutoIgnore ^sql_
DatabaseAuto __SQLDSN__
NoImportExternal Yes

NOTES

For more about Interchange and databases, and supported formats, see database glossary entry.

The schema argument to this directive can be specified when you want to avoid using the DatabaseAutoIgnore directive (it's drawback is that it could easily ignore more tables than you really intended).

Also be aware that it is possible to make some confusing configuration mistakes here, if the schema you specify is not in the database user's SEARCH_PATH session variable, or comes after some other schema that has tables with the same names.

AVAILABILITY

DatabaseAuto is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['DatabaseAuto',   'dbauto',          ''],

sub parse_dbauto {
my ($var, $value) = @_;
return '' unless $value;
my @inc = Vend::Table::DBI::auto_config($value);
my %noed;
for(@inc) {
  my ($t, $thing) = @$_;
  parse_boolean('NoImport', $t) unless $noed{$t}++;
  parse_database('Database', "$t $thing");
}
return 1;
}

AUTHORS

Mike Heins

SEE ALSO

DatabaseDefault(7ic), Database(7ic), DatabaseAutoIgnore(7ic)

SYNOPSIS

DESCRIPTION

The directive allows regexp specification of an "ignore list" that prevents DatabaseAuto from automatically configuring all tables found. (For example, you will want to exclude tables in non-default schemas.)

A loose regex specification can easily ignore more tables than you intended, and if the goal is just using tables from the public schema, you might prefer specifying schema argument to DatabaseAuto directly.

DIRECTIVE TYPE AND DEFAULT VALUE

Catalog directive

EXAMPLES

DatabaseAutoIgnore  ^sql_
DatabaseAuto   dbi:Pg:dbname=DBNAME;host=PGHOST

NOTES

This directive must be set before DatabaseAuto to have a meaningful effect.

For more about Interchange and databases, and supported formats, see database glossary entry.

AVAILABILITY

DatabaseAutoIgnore is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['DatabaseAutoIgnore',   'regex',          ''],

sub parse_regex {
my($var, $value) = @_;

eval {  
  my $never = 'NeVAirBE';
  $never =~ m{$value};
};

if($@) {
  config_error("Bad regular expression in $var.");
}
return $value;
}

AUTHORS

Mike Heins

SEE ALSO

Database(7ic), DatabaseAuto(7ic)

SYNOPSIS

DESCRIPTION

The directive defines default parameters for a database.

For a list of possible parameters (keys), see the Database directive.

DatabaseDefault accepts scalar keys, which actually means all from the list above except:

DIRECTIVE TYPE AND DEFAULT VALUE

Catalog directive

EXAMPLES

DatabaseDefault USER interchange
DatabaseDefault PASS nevairbe

DatabaseDefault      WRITE_CONTROL   1
DatabaseDefault      WRITE_TAGGED    1

DatabaseDefault <<EOD
  WRITE_CONTROL   1
  WRITE_TAGGED    1
  HIDE_AUTO_FILES 1
EOD

Replace DatabaseDefault

DatabaseDefault LOG_ERROR_SESSION 0

NOTES

Those default settings are made when the table is initially defined, so explicit settings for the database itself override the defaults, of course.

To have the intended effect, this directive must be set before the appropriate databases are defined with the Database directive.

For a way to clear definitions, use the Replace directive.

AVAILABILITY

DatabaseDefault is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['DatabaseDefault',  'hash',          ''],

sub parse_hash {
my($item,$settings) = @_;
if (! $settings) {
  return $HashDefaultBlank{$item} ? '' : {};
}

my $c;

if(defined $C) {
  $c = $C->{$item} || {};
}
else {
  no strict 'refs';
  $c = ${"Global::$item"} || {};
}

return hash_string($settings,$c);
}

AUTHORS

Interchange Development Group

SEE ALSO

Replace(7ic), Database(7ic), DatabaseAuto(7ic)

SYNOPSIS

DESCRIPTION

Specify the Interchange debug output file. If the filename is not absolute, it is treated relative to the Interchange root directory (ICROOT).

When enabled, the debug file will gather output of the ::logDebug() Interchange statements and Perl warnings (if they are enabled).

DIRECTIVE TYPE AND DEFAULT VALUE

Global directive

EXAMPLES

Variable DEBUG 1
DebugFile /tmp/icdebug

NOTES

Keep in mind that you need to have the DEBUG global variable defined.

Also, as the ::logDebug() statements are disabled (commented) by default in Interchange sources, you'll probably want to use a special script for managing debug statements, or manually uncomment parts of debugging code in question (and restart Interchange, of course — see Q: ).

AVAILABILITY

DebugFile is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['DebugFile',     'root_dir',        ''],

sub parse_root_dir {
my($var, $value) = @_;
return '' unless $value;
$value = "$Global::VendRoot/$value"
  unless file_name_is_absolute($value);
$value =~ s./+$..;
return $value;
}

AUTHORS

Interchange Development Group

SEE ALSO

DEBUG(7ic), ShowTimes(7ic), DataTrace(7ic), EncryptProgram(7ic), DebugTemplate(7ic), DumpStructure(7ic), SysLog(7ic), LogFile(7ic), DebugHost(7ic)

SYNOPSIS

DESCRIPTION

The DebugHost configuration directive restricts debug mode to only selected list of client hosts.

DebugHost accepts a list of IP addresses and IP address ranges.

DIRECTIVE TYPE AND DEFAULT VALUE

Catalog directive

EXAMPLES

DebugFile /tmp/debug

DebugHost 10.1.1.0/24 12.176.97.0/25 127.0.0.1

NOTES

See debug glossary entry for complete discussion on using debug mode.

AVAILABILITY

DebugHost is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['DebugHost',       'ip_address_regexp',  ''],

sub parse_ip_address_regexp {

my ($var, $value) = @_;
return '' unless $value;

my @atoms = split /[\s,\0]/, $value;

eval {
  require Net::IP::Match::Regexp;
};
$@ and config_error("$var directive requires module: $@");

my $re = Net::IP::Match::Regexp::create_iprange_regexp(@atoms)
  or config_error("Improper IP address range for $var");
  return $re;
}

AUTHORS

Interchange Development Group

SEE ALSO

DebugTemplate(7ic), DebugFile(7ic)

SYNOPSIS

DESCRIPTION

DebugTemplate, a global directive, allows you to change the format of debug messages.

DIRECTIVE TYPE AND DEFAULT VALUE

Global directive

EXAMPLES

DebugTemplate %c {CALLER0} {MESSAGE} {PAGE} {TAG}

NOTES

AVAILABILITY

DebugTemplate is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['DebugTemplate',    undef,            ''],

AUTHORS

Interchange Development Group

SEE ALSO

DebugFile(7ic), DEBUG(7ic), DebugHost(7ic)

SYNOPSIS

DESCRIPTION

The directive specifies the default locale.

DIRECTIVE TYPE AND DEFAULT VALUE

Catalog directive

EXAMPLES

DefaultLocale hr_HR

Locale  hr_HR  default 1

NOTES

If two locales are set "default" using Locale, and no DefaultLocale is specified, the behavior is undefined as the first "default" found will be set as the actual default.

AVAILABILITY

DefaultLocale is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['DefaultLocale',     undef,             ''],

AUTHORS

Mike Heins

SEE ALSO

Locale(7ic)

SYNOPSIS

DESCRIPTION

The directive specifies the default shipping method by initializing the mv_shipmode variable.

It defaults to a value "default".

DIRECTIVE TYPE AND DEFAULT VALUE

Catalog directive

EXAMPLES

DefaultShipping UPS

NOTES

This directive is somewhat obsolete, because the behavior from the example is simply obtained by a different approach in catalog.cfg:

ValuesDefault mv_shipmode UPS

AVAILABILITY

DefaultShipping is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['DefaultShipping',   undef,            'default'],

AUTHORS

Interchange Development Group

SEE ALSO

Shipping(7ic)

SYNOPSIS

DESCRIPTION

This directive specifies the directives which are to be disabled during parse of the catalog.cfg files.

This can be effectively used to both save some memory on servers with many catalogs and prevent catalogs from setting some of the directives.

DIRECTIVE TYPE AND DEFAULT VALUE

Global directive

EXAMPLES

DeleteDirective DescriptionField OfflineDir

NOTES

AVAILABILITY

DeleteDirective is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['DeleteDirective', sub {
            my $c = $Global::DeleteDirective || {};
            shift;
            my @sets = map { lc $_ } split /[,\s]+/, shift;
            @{$c}{@sets} = map { 1 } @sets;
            return $c;
           },            ''],

AUTHORS

Interchange Development Group

SEE ALSO

AddDirective(7ic)

SYNOPSIS

DESCRIPTION

The directive specifies whether images can be fetched directly over the link program.

If the requested file is present and the MimeType for the file's extension begins with image/, the path will be adjusted to add ImageDir or ImageDirSecure, and a status 302 ("Moved temporarily") issued. At that point, the image should be visible on users' screens.

This whole thing happens before database or session opens, and is quite fast. $Vend::tmp_session is set so no cookie is issued.

DIRECTIVE TYPE AND DEFAULT VALUE

Catalog directive

EXAMPLES

DeliverImage Yes

NOTES

This feature was introduced to help cope with the unpleasant behavior of the Mozilla HTML editor.

AVAILABILITY

DeliverImage is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['DeliverImage',     'yesno',       'no'],

sub parse_yesno {
my($var, $value) = @_;
$_ = $value;
if (m/^y/i || m/^t/i || m/^1/ || m/^on/i) {
  return 1;
}
elsif (m/^n/i || m/^f/i || m/^0/ || m/^of/i) {
  return 0;
}
else {
  config_error("Use 'yes' or 'no' for the $var directive\n");
}
}

AUTHORS

Mike Heins

SEE ALSO

SYNOPSIS

DESCRIPTION

By default, Interchange expects the product description to be in the description field in the products database. This directive allows modification of the default name.

The field is accessed implicitly when you call say, [item-description] in ITL.

DIRECTIVE TYPE AND DEFAULT VALUE

Catalog directive

EXAMPLES

DescriptionField dsc

# Establish the default at startup
DecriptionField    description

# Establish locale-specific description field
Locale fr_FR  DecriptionField  desc_fr

NOTES

It's useful to set this directive based on locale, allowing for locale-specific product descriptions.

AVAILABILITY

DescriptionField is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['DescriptionField', undef,              'description'],

AUTHORS

Interchange Development Group

SEE ALSO

description(7ic)

SYNOPSIS

DESCRIPTION

The directive allows you to batch-set a bunch of variables from files.

directive_name is usually Variable, but can practically be any hash-based directive. directory_glob is a filespec that can encompass multiple directories (files are ignored).

The specified directories are read for file names that contain only word characters, i.e. something that would be a valid Variable. (This alone might make it unsuitable for some other uses, but picking up the junk from the in-directory-backup-file people would be intolerable.) Then the contents of the found files are used to set the variables (or other values) named after file names.

The source file name is kept in $Vend::Cfg->{DirConfig}{Variable}{VARNAME} if <pragma>dynamic_variables</pragma> pragma is set. <pragma>dynamic_variables</pragma> enables dynamic updating of variables from files. <pragma>dynamic_variables_files_only</pragma> restricts dynamic variables to files only — otherwise variables are dynamically read from the VariableDatabase definition as well.

With dynamic variables, all @_VARIABLE_@ and __VARIABLE__ calls are checked first to see if their source file is defined. If they are — if there is a hash key present for the source file — even if its contents are blank, it is returned as the value.

DIRECTIVE TYPE AND DEFAULT VALUE

Catalog directive

EXAMPLES

DirConfig Variable templates/foundation/regions

NOTES

Make sure you don't get confused by the existence of all DirConfig, ConfDir and ConfigDir.

AVAILABILITY

DirConfig is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['DirConfig',         'dirconfig',        ''],

sub parse_dirconfig {
my ($var, $value) = @_;

return '' if ! $value;
$value =~ s/(\w+)\s+//;
my $direc = $1;
#::logDebug("direc=$direc value=$value");
 
my $ref = $C->{$direc};

unless(ref($ref) eq 'HASH') {
  config_error("DirConfig called for non-hash configuration directive.");
}

my $source = $C->{$var}   || {};
my $sref = $source->{$direc} || {};

my @dirs = grep -d $_, glob($value);
foreach my $dir (@dirs) {
  opendir(DIRCONFIG, $dir)
    or next;
  my @files = grep /^\w+$/, readdir(DIRCONFIG);
  for(@files) {
    next unless -f "$dir/$_";
#::logDebug("reading key=$_ from $dir/$_");
    $ref->{$_} = readfile("$dir/$_", $Global::NoAbsolute, 0);
    $ref->{$_} = substitute_variable($ref->{$_}) if $C->{ParseVariables};
    $sref->{$_} = "$dir/$_";
  }
}
$source->{$direc} = $sref;
return $source;
}

AUTHORS

Interchange Development Group

SEE ALSO

dynamic_variables(7ic), dynamic_variables_file_only(7ic), VariableDatabase(7ic)

SYNOPSIS

DESCRIPTION

The DirectiveDatabase configuration directive makes it possible to read all configuration directives from a database, instead of from the usual catalog.cfg configuration file.

The database can (but does not have to) be previously defined with the Database directive. When it is, then just the table name is required and honored. When it is not, then the Database directive will be automatically invoked first to register the new table, possibly with custom text source file and table type.

table_source_filename defaults to table_name.txt, and table_source_type defaults to TAB. (The arguments are the same as for the Database directive itself, they are passed to it directly.)

DIRECTIVE TYPE AND DEFAULT VALUE

Catalog directive

EXAMPLES

DirectiveDatabase catalog catalog.txt TAB

Database catalog catalog.txt TAB
DirectiveDatabase catalog

NOTES

AVAILABILITY

DirectiveDatabase is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['DirectiveDatabase', 'dbconfig',        ''],

sub parse_dbconfig {
my ($var, $value) = @_;

my ($file, $type);
return '' if ! $value;
local($Vend::Cfg) = $C;

my ($db, $table);
eval {
  ($db, $table) = get_configdb($var, $value);
};

return '' if ! $db;

my ($k, @f);  # key and fields
my @l;      # refs to locale repository
my @n;      # names of locales
my @h;      # names of locales

@n = $db->columns();
shift @n;
my $extra;
for(@n) {
  my $real = $CDname{lc $_};
  if (! ref $Vend::Cfg->{$real} or $Vend::Cfg->{$real} !~ /HASH/) {
    # ignore non-existent directive, but put in hash
    my $ref = {};
    push @l, $ref;
    push @h, [$real, $ref];
    next;
  }
  push @l, $Vend::Cfg->{$real};
}
my $i;
while( ($k, undef, @f ) = $db->each_record) {
#::logDebug("Got key=$k f=@f");
  for ($i = 0; $i < @f; $i++) {
    next unless length($f[$i]);
    $l[$i]->{$k} = $f[$i];
  }
}
for(@h) {
  $Vend::Cfg->{Hash}{$_->[0]} = $_->[1];
}
$db->close_table();
return $table;
}

AUTHORS

Interchange Development Group

SEE ALSO

Database(7ic), FileDatabase(7ic)

SYNOPSIS

DESCRIPTION

Specify the default page to show in a directory.

When the location requested does not exist, and this directive is set, Interchange will try to append the specified filename to the URL, and re-test for the page existence.

This directive sets the default page for all directories except the catalog entry point. (In other words, this directive won't help you make http://myhost.mydomain.local/ show http://myhost.mydomain.local/index.html - see the SpecialPage for that).

DIRECTIVE TYPE AND DEFAULT VALUE

Catalog directive

EXAMPLES

DirectoryIndex index.html

NOTES

Although the name for this directive was borrowed from the Apache Web Server project, it only accepts one filename (unlike Apache which supports multiple filenames to look for in sequential order).

AVAILABILITY

DirectoryIndex is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['DirectoryIndex',   undef,         ''],

AUTHORS

Interchange Development Group

SEE ALSO

SpecialPage(7ic)

SYNOPSIS

DESCRIPTION

DiscountSpaceVar is a configuration directive with the default value of 'mv_discount_space'. It is a list of names of CGI variables to check per page process, such that a CGI variable can be used to specify the discount space.

For this directive to have any effect, the DiscountSpacesOn directive must be enabled.

The default value, mv_discount_space, is likely to suffice for most purposes, but people could want to tie the discount space to other things, such as the cart name, by including other variable names in this array (for instance, mv_cartname would tie the discount space to the cart name, which could be convenient in some situations).

DIRECTIVE TYPE AND DEFAULT VALUE

Catalog directive

EXAMPLES

DiscountSpacesOn Yes
DiscountSpaceVar mv_cartname

NOTES

AVAILABILITY

DiscountSpaceVar is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['DiscountSpaceVar', 'array',            'mv_discount_space'],

sub parse_array {
my($item,$settings) = @_;
return '' unless $settings;
my(@setting) = grep /\S/, split /[\s,]+/, $settings;

my $c;

if(defined $C) {
  $c = $C->{$item} || [];
}
else {
  no strict 'refs';
  $c = ${"Global::$item"} || [];
}

for (@setting) {
  check_legal($item, $_);
  push @{$c}, $_;
}
$c;
}

AUTHORS

Ethan Rowe

SEE ALSO

DiscountSpacesOn(7ic), discount(7ic)

SYNOPSIS

DESCRIPTION

This directive enables the "discount spaces" feature.

When DiscountSpacesOn is enabled, then on a per-page before-autoload basis, this routine initializes the current discount space to 'main', and then checks all CGI variables defined with the DiscountSpaceVar configuration directive to see if an alternate discount space has been specified.

When DiscountSpacesOn is not enabled, then the behavior is compatible to how it was before the feature was added to Interchange — all "discount space" functions become a no-operation; any attempts to specify an alternate discount space will have no effect, and will result in an error message in the catalog's error log.

See glossary entry discount for a complete discussion.

DIRECTIVE TYPE AND DEFAULT VALUE

Catalog directive

EXAMPLES

DiscountSpacesOn Yes

NOTES

AVAILABILITY

DiscountSpacesOn is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['DiscountSpacesOn', 'yesno',            'no'],

sub parse_yesno {
my($var, $value) = @_;
$_ = $value;
if (m/^y/i || m/^t/i || m/^1/ || m/^on/i) {
  return 1;
}
elsif (m/^n/i || m/^f/i || m/^0/ || m/^of/i) {
  return 0;
}
else {
  config_error("Use 'yes' or 'no' for the $var directive\n");
}
}

AUTHORS

Ethan Rowe

SEE ALSO

discount(7ic), DiscountSpaceVar(7ic)

SYNOPSIS

DESCRIPTION

All Interchange errors are reported in the error log, but errors can also be displayed directly in the client browser. This is convenient while testing a configuration. To allow catalog-specific settings of DisplayErrors the global directive needs to be enabled.

DIRECTIVE TYPE AND DEFAULT VALUE

Global directive,
Catalog directive

EXAMPLES

DisplayErrors Yes

NOTES

This directive changes the operation of $SIG{__DIE__} and may have other effects on program operation. This should never be used for normal operation.

AVAILABILITY

DisplayErrors is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['DisplayErrors',    'yesno',            'No'],

['DisplayErrors',    'yesno',            'No'],

sub parse_yesno {
my($var, $value) = @_;
$_ = $value;
if (m/^y/i || m/^t/i || m/^1/ || m/^on/i) {
  return 1;
}
elsif (m/^n/i || m/^f/i || m/^0/ || m/^of/i) {
  return 0;
}
else {
  config_error("Use 'yes' or 'no' for the $var directive\n");
}
}

AUTHORS

Interchange Development Group

SEE ALSO

SYNOPSIS

DESCRIPTION

The directive simply specifies that only the toplevel domain should be used in IP qualification for session IDs. If, for example, an IP was ri01-053.dialin.iskon.hr, only iskon.hr would be used.

Interchange also supports taking various ccTLDs into account; see CountrySubdomains.

DIRECTIVE TYPE AND DEFAULT VALUE

Global directive

EXAMPLES

DomainTail No

NOTES

This directive is a compromise on security, but it allows browsers that do not accept cookies to use multiple proxy servers in the same domain. Note that this directive is enabled by default.

If you are encrypting credit cards with PGP/GPG or using payment services, then look at the WideOpen directive, which enables even more browser compatibility, again at the cost of some security.

AVAILABILITY

DomainTail is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['DomainTail',     'yesno',            'Yes'],

sub parse_yesno {
my($var, $value) = @_;
$_ = $value;
if (m/^y/i || m/^t/i || m/^1/ || m/^on/i) {
  return 1;
}
elsif (m/^n/i || m/^f/i || m/^0/ || m/^of/i) {
  return 0;
}
else {
  config_error("Use 'yes' or 'no' for the $var directive\n");
}
}

AUTHORS

Interchange Development Group

SEE ALSO

WideOpen(7ic), IpHead(7ic), CountrySubdomains(7ic), IpQuad(7ic), LockoutCommand(7ic)

SYNOPSIS

DESCRIPTION

DIRECTIVE TYPE AND DEFAULT VALUE

Global directive

EXAMPLES

NOTES

AVAILABILITY

DowncaseVarname is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['DowncaseVarname',   undef,           ''],

AUTHORS

Interchange Development Group

SEE ALSO

SYNOPSIS

DESCRIPTION

Instruct Interchange to dump the complete server configuration (with "includes" expanded) to allconfigs.cfg in the Interchange run directory.

The dump file does not contain catalog configurations.

DIRECTIVE TYPE AND DEFAULT VALUE

Global directive

EXAMPLES

DumpAllCfg 1

NOTES

Interchange "run directory" is /usr/local/interchange/etc/ on tarball installs, and /var/run/interchange on LSB setups.

DumpAllCfg was previously known as "OutputAllCfg", but was renamed to ideologically match DumpStructure.

AVAILABILITY

DumpAllCfg is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['DumpAllCfg',       'yesno',            'No'],

sub parse_yesno {
my($var, $value) = @_;
$_ = $value;
if (m/^y/i || m/^t/i || m/^1/ || m/^on/i) {
  return 1;
}
elsif (m/^n/i || m/^f/i || m/^0/ || m/^of/i) {
  return 0;
}
else {
  config_error("Use 'yes' or 'no' for the $var directive\n");
}
}

AUTHORS

Interchange Development Group

SEE ALSO

DumpStructure(7ic)

SYNOPSIS

DESCRIPTION

Instruct Interchange to dump the structure of catalogs and the Interchange server to files named catalog_name.structure. Use this to see how directives have been set.

The catalog structure files are dumped relative to catalog roots (CATROOTs).

DIRECTIVE TYPE AND DEFAULT VALUE

Global directive

EXAMPLES

DumpStructure Yes

NOTES

AVAILABILITY

DumpStructure is available in Interchange versions:

4.6.0-5.9.0 (git-head)

SOURCE

Interchange 5.9.0:

['DumpStructure',   'yesno',            'No'],