vxinfo - get miscellaneous Vortex information

SYNOPSIS

<vxinfo $what [$arg ...]>

DESCRIPTION
The vxinfo function returns miscellaneous Vortex information, depending on the $what parameter:

• outputsz Returns the number of bytes output by the script so far, as a long. This does not count redirected output, i.e. the input to CAPTURE, EXEC etc. blocks.

• db Returns the current database path used by SQL statements. This is changeable with the DB statement (here). Note: the database used by SQL statements can also be set on a per-statement basis by the DB option to SQL (here).

• globaldb Returns the global database path, which is used for the EXPORT TABLE variables, and is the default database for SQL statements unless overridden at run-time. This is settable with the DB directive (here).

• version Returns the version string: the second line of information printed by texis -version. This can be used by a script to check if certain functionality it wishes to use is supported by the texis executable running it, by checking the version number/date.

• platform Returns the platform ID string: the string printed in parentheses by texis -version. Added in version 6.00.1277838424 20100629.

• installdir Returns the directory that Texis was installed in. This is usually "/usr/local/morph3" under Unix, or "c:\morph3" under Windows, but may be a different directory depending on the user's installation. Added in version 3.01.982700000 20010220.

• executabledir Returns the Texis executables directory, i.e. typically "/usr/local/morph3/bin" under Unix or "c:\morph3" under Windows. Added in version 5.01.1270583600 20100406.

• htmlmode Returns 1 if in HTML mode, 0 if not. If in HTML mode, variables are automatically HTML-escaped when printed; this is the default if the URL file extension (here) is .htm or .html. Can be changed with <vxcp htmlmode> (here). Added in version 3.01.982400000 20010217.

• release Returns the date of the Vortex (texis) executable's release. This can be used to check for the availability of certain Vortex features in the executable running the script, for portability between versions. (Note that the existence of <vxinfo release> itself should be checked too, by setting $ret to a very early date before calling vxinfo.) Added in version 3.01.980000000 20010120.

• license $name Returns the Texis license value corresponding to $name, which can be one of the following: violationmsg, violationtime, gentime, expiretime, verifytime, verifytrytime, serial, curhits, curhitstime, maxhits, curtblrows, maxtblrows, curtblsz, maxtblsz, curdbrows, maxdbrows, curdbsz, maxdbsz, curtotrows, maxtotrows, curtotsz, maxtotsz, texismonitorpid, equivpath, uequivpath, vortexlog, defaultdb, defaultscript, vortexflags, texisflags, schemas. Added in version 3.01.985300000 20010322. In version 5.01.1242246000 20090513, the values inittime, maxversion, prevhits, highhits and flags were added. In version 6, the following values were added: fetchesToday, fetchesTodayStart (when fetchesToday count started), fetchesThisMinute, fetchRate3, fetchRate15, fetchRate60 (fetches per minute averaged over the last 3, 15 and 60 minutes), maxfetches (licensed fetch limit per day; 0 is unlimited), metamorphsToday, metamorphsTodayStart, metamorphsThisMinute, metamorphRate3, metamorphRate15, metamorphRate60, maxmetamorphs (license limit), and thisMinuteStart (when the current minute for ...thisMinute values started; if more than one minute ago, such values may be invalid). Only user-initiated, network fetches are counted (e.g. internal system fetches, format-only calls such as <fetch theUrl theData>, and automatically-fetched sub-objects such as frames and scripts, are not counted). In version 6.00.1294878413 20110112, maxversionnum was added.

• content Returns the raw content of the POST or multi-part MIME upload to the script, if any. This can be used to proxy the same POST vars to a remote script with submit. (Note that Vortex parses the POST/MIME input for variables and automatically sets them in Vortex; obtaining the raw content is only needed for re-submitting an identical request to another script, or cache systems, etc.) Added in version 3.01.990000000 20010515.

• objectpath Returns the file path to the currently running object file (e.g. .vtx file). Added in version 6.00.1292382279 20101214.

• stack dump [$N] Dumps current Vortex stack information and returns it in $ret, one level per line. Optional $N, which defaults to 0, is bitwise OR of flags:

  • 1 Dump all items, not just function calls

  • 2 Dump parameters too

  • 4 Dump full length of parameter values

  • 8 Print global variables too
  This information can be used when debugging a script, to determine where a function was called from. These flags, and the format of the output, are subject to change without notice in future versions. Added in version 3.01.987820000 20010420.

• texisconf [$section [$setting [$default]]] Returns current conf/texis.ini configuration value for $setting in $section. The $section may be numeric, where sections are numbered from 0 in the order they appear in the file; this is useful if the same-named section occurs multiple times (e.g. Httpd Fast CGI). If $default is given, that value is returned as a default value if the setting is not present. If $setting is not given, all setting names in $section are returned. If $section is not given, all section names in the file are returned, in file order. Section and setting names are case- and space-insensitive. Added in version 4.04.1079750000 20040319.

• texisconffrom $file [$section [$setting [$default]]] Same as texisconf, but reads settings from $file instead of the active config. If $file is empty, the default conf/texis.ini file in the install dir is used (this may still be different from the file used by texisconf, i.e. if -conf overrode the config file on the command line, the latter will be used by texisconf). Added in version 4.04.1079750000 20040319.

• texisconffile Returns the file path to the conf/texis.ini file used by the current invocation of Vortex. Note that the file may not exist, in which case it is the file that would be used were it to exist. Added in version 5.01.1270688277 20100407.

• sourcepath

  Returns the file path to the currently running script (not module) source, including extension if applicable. More permanent than the $sourcepath variable, which could be accidentally modified by the script. Added in version 4.04.1077500000 20040222.

• sourcepathnoext

  Same as sourcepath, but without extension. Added in version 5.01.1197080000 20071207.

• scriptroot Returns the full file path to the effective Script Root, i.e. after obtaining conf/texis.ini, conf/vhttpd.conf or default value (as appropriate via precedence) and expanding variables. May be empty if Script Root is not applicable or computable in the current invocation, i.e. if the script was run from the command line. Added in version 5.01.1268365000 20100311.

• execreadline When called from within an <EXEC> block, returns the next line of data from the program's output, without the trailing newline, blocking if needed until data is available. Returns empty (0 values) if EOF has been reached, i.e. the program exited and all data has been read. Each line read is removed from the (later) $ret return value of the closing </EXEC>.

  Normally it is easier to simply use $ret after </EXEC>. However, at </EXEC> the program's standard input has been closed and the program has exited. <vxinfo execreadline> provides a way to read data in real time from a program, while still potentially sending new input to it. This is useful for "interactive" programs, where the next line of input to the program may depend on previous output from it. Added in version 5.01.1109710555 20050301.

• compatibilityversion

  Returns a double value for the current Texis compatibility version, i.e. the major.minor version Texis is attempting to emulate. The default (if no <vxcp compatibilityversion> set) is the Texis version number.

DIAGNOSTICS
The vxinfo function returns option-dependent value(s).

EXAMPLE
This example logs the path and size of a page after it is delivered by the script:

... print a page of results ...
<vxinfo outputsz>
<SQL NOVARS "insert into log values($REQUEST_PATH, $ret)"></SQL>
<exit>

CAVEATS
The vxinfo function was added in version 3.01.967200000 20000824.

SEE ALSO
vxcp