<div class="fossil-doc" data-title="URN Server API v1"><br>
<big><big><span style="font-family: monospace;">Generated [2024-07-19 @ 22:45:55 UTC] from checkout [73bc68921b84696364b052de4e9c43d341efae9d 2024-07-19 22:42:16 UTC]</span></big></big><br><br><hr><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=tcl/common.tcl&ln=27">hasPerms</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=tcl/common.tcl">common.tcl</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "name"</span></big><br>
<blockquote style="font-family: monospace;"><br>
This TH1 procedure returns non-zero if the logged-in user has the<br>
specified named permission -OR- the server has been configured in<br>
such a way to permit anybody to have it, e.g. any user may lookup<br>
packages.<br>
</blockquote><br><hr><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=tcl/common.tcl&ln=124">emitFormStart</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=tcl/common.tcl">common.tcl</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "name"</span></big><br>
<big><span style="font-family: monospace;"> Required argument "title"</span></big><br>
<blockquote style="font-family: monospace;"><br>
This TH1 procedure emits the necessary HTML to start a <FORM> element<br>
suitable for use with Fossil and optionally having a title to be used<br>
as header text. The name must not contain any characters reserved in<br>
HTML; however, the title will be properly escaped.<br>
</blockquote><br><hr><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=tcl/common.tcl&ln=141">emitHidden</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=tcl/common.tcl">common.tcl</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "name"</span></big><br>
<big><span style="font-family: monospace;"> Required argument "value"</span></big><br>
<blockquote style="font-family: monospace;"><br>
This TH1 procedure emits the necessary HTML for a hidden form element<br>
that has a name and value. The name must not contain any characters<br>
reserved in HTML; however, the value will be properly escaped.<br>
</blockquote><br><hr><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=tcl/common.tcl&ln=151">emitTextBox</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=tcl/common.tcl">common.tcl</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "name"</span></big><br>
<big><span style="font-family: monospace;"> Required argument "value"</span></big><br>
<big><span style="font-family: monospace;"> Required argument "size"</span></big><br>
<blockquote style="font-family: monospace;"><br>
This TH1 procedure emits the necessary HTML for a text box form element<br>
that has a name, value, and size. The name and size must not contain<br>
any characters reserved in HTML; however, the value will be properly<br>
escaped.<br>
</blockquote><br><hr><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=tcl/common.tcl&ln=161">emitTextArea</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=tcl/common.tcl">common.tcl</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "name"</span></big><br>
<big><span style="font-family: monospace;"> Required argument "value"</span></big><br>
<big><span style="font-family: monospace;"> Required argument "rows"</span></big><br>
<big><span style="font-family: monospace;"> Required argument "columns"</span></big><br>
<blockquote style="font-family: monospace;"><br>
This TH1 procedure emits the necessary HTML for a text area form<br>
element that has a name, value, rows, and columns. The name, rows,<br>
and columns must not contain any characters reserved in HTML; however,<br>
the value will be properly escaped.<br>
</blockquote><br><hr><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=tcl/common.tcl&ln=171">emitCheckBox</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=tcl/common.tcl">common.tcl</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "name"</span></big><br>
<big><span style="font-family: monospace;"> Required argument "value"</span></big><br>
<blockquote style="font-family: monospace;"><br>
This TH1 procedure emits the necessary HTML for a check box form<br>
element that has a name and value. The name must not contain any<br>
characters reserved in HTML; however, the value will be properly<br>
escaped.<br>
</blockquote><br><hr><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=tcl/common.tcl&ln=187">emitSubmitButton</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=tcl/common.tcl">common.tcl</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "name"</span></big><br>
<big><span style="font-family: monospace;"> Required argument "value"</span></big><br>
<blockquote style="font-family: monospace;"><br>
This TH1 procedure emits the necessary HTML for a submit button form<br>
element that has a name and value. The name must not contain any<br>
characters reserved in HTML; however, the value will be properly<br>
escaped.<br>
</blockquote><br><hr><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=tcl/common.tcl&ln=195">emitFormEnd</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=tcl/common.tcl">common.tcl</a>")</span></big></big><br>
<blockquote style="font-family: monospace;"><br>
This TH1 procedure emits the necessary HTML to end a <FORM> element<br>
suitable for use with Fossil. There are no arguments.<br>
</blockquote><br><hr><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=tcl/common.tcl&ln=205">sql_function_regexp</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=tcl/common.tcl">common.tcl</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Optional argument list "args"</span></big><br>
<blockquote style="font-family: monospace;"><br>
This Tcl procedure is used to implement a SQL function for SQLite.<br>
It implements the REGEXP function (and its associated operator) by<br>
using the Tcl [regexp] command.<br>
</blockquote><br><hr><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=tcl/common.tcl&ln=216">isValidApiKey</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=tcl/common.tcl">common.tcl</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "value"</span></big><br>
<big><span style="font-family: monospace;"> Optional argument "writing" with default value "false"</span></big><br>
<big><span style="font-family: monospace;"> Optional argument "emptyOk" with default value "false"</span></big><br>
<blockquote style="font-family: monospace;"><br>
This Tcl procedure returns non-zero if the specified string value is<br>
a valid API key. An API key has no relationship to a Fossil check-in<br>
hash, even though it may look like one. The emptyOk argument can be<br>
non-zero if the caller wishes to permit an empty string.<br>
</blockquote><br><hr><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=tcl/common.tcl&ln=237">isValidOwnerName</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=tcl/common.tcl">common.tcl</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "value"</span></big><br>
<big><span style="font-family: monospace;"> Optional argument "emptyOk" with default value "false"</span></big><br>
<blockquote style="font-family: monospace;"><br>
This Tcl procedure returns non-zero if the specified string value is<br>
suitable for use as an owner (entity) name. Only the Latin alphabet<br>
and the space character are allowed.<br>
</blockquote><br><hr><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=tcl/common.tcl&ln=251">isValidMessage</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=tcl/common.tcl">common.tcl</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "value"</span></big><br>
<big><span style="font-family: monospace;"> Optional argument "emptyOk" with default value "false"</span></big><br>
<blockquote style="font-family: monospace;"><br>
This Tcl procedure returns non-zero if the specified string value is<br>
a valid (log) message. It must be valid Base64 data and the encoded<br>
length is limited to 256K. Therefore, the unencoded length limit is<br>
about 192K.<br>
</blockquote><br><hr><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=tcl/common.tcl&ln=285">isValidScriptName</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=tcl/common.tcl">common.tcl</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "value"</span></big><br>
<big><span style="font-family: monospace;"> Optional argument "emptyOk" with default value "false"</span></big><br>
<blockquote style="font-family: monospace;"><br>
This Tcl procedure returns non-zero if the specified string value is<br>
a valid script name. The emptyOk argument can be non-zero if the<br>
caller wishes to permit an empty string.<br>
</blockquote><br><hr><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=tcl/common.tcl&ln=298">isValidGuid</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=tcl/common.tcl">common.tcl</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "value"</span></big><br>
<big><span style="font-family: monospace;"> Optional argument "emptyOk" with default value "false"</span></big><br>
<blockquote style="font-family: monospace;"><br>
This Tcl procedure returns non-zero if the specified string value<br>
is a valid GUID string. The emptyOk argument can be non-zero if<br>
the caller wishes to permit an empty string.<br>
</blockquote><br><hr><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=tcl/common.tcl&ln=314">isValidHash</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=tcl/common.tcl">common.tcl</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "value"</span></big><br>
<big><span style="font-family: monospace;"> Optional argument "emptyOk" with default value "false"</span></big><br>
<blockquote style="font-family: monospace;"><br>
This Tcl procedure returns non-zero if the specified string value is<br>
a valid SHA1 hash. This has no relationship to a Fossil check-in<br>
hash, even though it may look like one. The emptyOk argument can be<br>
non-zero if the caller wishes to permit an empty string.<br>
</blockquote><br><hr><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=tcl/common.tcl&ln=327">verifyMessageAgainstHash</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=tcl/common.tcl">common.tcl</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "hmacKey"</span></big><br>
<big><span style="font-family: monospace;"> Required argument "message"</span></big><br>
<big><span style="font-family: monospace;"> Required argument "hash"</span></big><br>
<blockquote style="font-family: monospace;"><br>
This Tcl procedure returns non-zero if the specified message string,<br>
which must be Base64 encoded, validates based on the specified HMAC<br>
key and hash. This procedure does not raise script errors.<br>
</blockquote><br><hr><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=tcl/common.tcl&ln=357">appendLogFile</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=tcl/common.tcl">common.tcl</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "fileName"</span></big><br>
<big><span style="font-family: monospace;"> Required argument "data"</span></big><br>
<blockquote style="font-family: monospace;"><br>
This Tcl procedure appends binary data to the specified log file. No<br>
trailing new line is emitted. The log file may be created if needed.<br>
</blockquote><br><hr><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=tcl/common.tcl&ln=369">hasOnlyNormalChars</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=tcl/common.tcl">common.tcl</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "value"</span></big><br>
<blockquote style="font-family: monospace;"><br>
This Tcl procedure attempts to determine if the specified string has<br>
only web-printable ASCII characters. Non-zero will be returned if<br>
that is the case.<br>
</blockquote><br><hr><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=tcl/common.tcl&ln=382">htmlize</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=tcl/common.tcl">common.tcl</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Optional argument list "args"</span></big><br>
<blockquote style="font-family: monospace;"><br>
This Tcl procedure (which uses a Fossil TH1 command) returns the HTML<br>
escaped version of the specified string value. If TH1 integration is<br>
not available for any reason, a script error will be raised.<br>
</blockquote><br><hr><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=tcl/common.tcl&ln=403">httpize</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=tcl/common.tcl">common.tcl</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Optional argument list "args"</span></big><br>
<blockquote style="font-family: monospace;"><br>
This Tcl procedure (which uses a Fossil TH1 command) returns the HTTP<br>
escaped version of the specified string value. If TH1 integration is<br>
not available for any reason, a script error will be raised.<br>
</blockquote><br><hr><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=tcl/common.tcl&ln=420">getTablePreHeader</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=tcl/common.tcl">common.tcl</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "title"</span></big><br>
<blockquote style="font-family: monospace;"><br>
This Tcl procedure (which uses a Fossil TH1 command) returns the HTML<br>
necessary for some header text to accompany a table containing data.<br>
The title will be HTML escaped. If TH1 integration is not available<br>
for any reason, a script error will be raised.<br>
</blockquote><br><hr><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=tcl/common.tcl&ln=453">emitLink</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=tcl/common.tcl">common.tcl</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "href"</span></big><br>
<big><span style="font-family: monospace;"> Required argument "value"</span></big><br>
<blockquote style="font-family: monospace;"><br>
This Tcl procedure returns the HTML necessary for a link to another<br>
(arbitrary) page. The href argument must be a properly formed URI<br>
and must not contain any characters reserved in HTML; however, the<br>
value will be properly escaped. The value will be used as the text<br>
for the link.<br>
</blockquote><br><hr><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=tcl/common.tcl&ln=464">emitBoldLink</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=tcl/common.tcl">common.tcl</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "href"</span></big><br>
<big><span style="font-family: monospace;"> Required argument "value"</span></big><br>
<blockquote style="font-family: monospace;"><br>
This Tcl procedure returns the HTML necessary for a link to another<br>
(arbitrary) page. The href argument must be a properly formed URI<br>
and must not contain any characters reserved in HTML; however, the<br>
value will be properly escaped. The value will be used as the text<br>
for the link -AND- it will have bold styling.<br>
</blockquote><br><hr><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=tcl/common.tcl&ln=475">emitCodeLink</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=tcl/common.tcl">common.tcl</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "code"</span></big><br>
<big><span style="font-family: monospace;"> Required argument "value"</span></big><br>
<blockquote style="font-family: monospace;"><br>
This Tcl procedure returns the HTML necessary for a link to another<br>
page within the Fossil repository. The code argument must be a URN<br>
name and must not contain any characters reserved in HTML; however,<br>
the value will be properly escaped. The value will be used as the<br>
text for the link.<br>
</blockquote><br><hr><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=tcl/common.tcl&ln=493">emitFormLink</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=tcl/common.tcl">common.tcl</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "name"</span></big><br>
<big><span style="font-family: monospace;"> Required argument "value"</span></big><br>
<big><span style="font-family: monospace;"> Required argument "extra"</span></big><br>
<blockquote style="font-family: monospace;"><br>
This Tcl procedure returns the HTML necessary for a link to another<br>
documentation page within the Fossil repository. It is hard-coded<br>
to the latest trunk check-in. The name argument must be the name<br>
of an existing wiki, markdown, or TH1 page and must not contain any<br>
characters reserved in HTML; however, the value will be properly<br>
escaped. The extra argument is designed to facilitate inclusion of<br>
arbitrary query parameters. It should be an empty string if query<br>
parameters are not required. The value will be used as the text for<br>
the link.<br>
</blockquote><br><hr><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=tcl/common.tcl&ln=511">emitFormBoldLink</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=tcl/common.tcl">common.tcl</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "name"</span></big><br>
<big><span style="font-family: monospace;"> Required argument "value"</span></big><br>
<big><span style="font-family: monospace;"> Required argument "extra"</span></big><br>
<blockquote style="font-family: monospace;"><br>
This Tcl procedure returns the HTML necessary for a link to another<br>
documentation page within the Fossil repository. It is hard-coded<br>
to the latest trunk check-in. The name argument must be the name<br>
of an existing wiki, markdown, or TH1 page and must not contain any<br>
characters reserved in HTML; however, the value will be properly<br>
escaped. The extra argument is designed to facilitate inclusion of<br>
arbitrary query parameters. It should be an empty string if query<br>
parameters are not required. The value will be used as the text for<br>
the link -AND- it will have bold styling.<br>
</blockquote><br><hr><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=tcl/log.tcl&ln=39">setupLogGlobals</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=tcl/log.tcl">log.tcl</a>")</span></big></big><br>
<blockquote style="font-family: monospace;"><br>
This TH1 procedure initializes the global variables used by this script<br>
file. There are no arguments. It must not raise script errors.<br>
</blockquote><br><hr><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=tcl/log.tcl&ln=50">getLogDb</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=tcl/log.tcl">log.tcl</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "varName"</span></big><br>
<blockquote style="font-family: monospace;"><br>
This Tcl procedure returns a fully qualified path and file name for<br>
the database of log messages. There are no arguments.<br>
</blockquote><br><hr><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=tcl/log.tcl&ln=101">openAndSetupLogDb</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=tcl/log.tcl">log.tcl</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "cmdName"</span></big><br>
<big><span style="font-family: monospace;"> Required argument "readOnly"</span></big><br>
<big><span style="font-family: monospace;"> Required argument "functions"</span></big><br>
<blockquote style="font-family: monospace;"><br>
This Tcl procedure attempts to open the database of log messages<br>
and enable the options it needs, e.g. via PRAGMA, etc. The custom<br>
function is registered when the functions argument is non-zero.<br>
The readOnly argument should be non-zero to prevent writes to the<br>
database.<br>
</blockquote><br><hr><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=tcl/log.tcl&ln=130">getLogKeyIdFromApiKey</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=tcl/log.tcl">log.tcl</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "apiKey"</span></big><br>
<blockquote style="font-family: monospace;"><br>
This Tcl procedure attempts to obtain an Id based on an API key.<br>
Another connection to the database of variable names and values<br>
will be opened and closed by this procedure, even if one is already<br>
open. An empty string will be returned if the API key is not found;<br>
otherwise, a non-empty string will be returned, which will be the<br>
integer identifier associated with the API key.<br>
</blockquote><br><hr><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=tcl/log.tcl&ln=159">getIdAndHmacKeyFromApiKey</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=tcl/log.tcl">log.tcl</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "apiKey"</span></big><br>
<blockquote style="font-family: monospace;"><br>
This Tcl procedure attempts to obtain an Id and HMAC key based on<br>
an API key. Another connection to the database of variable names<br>
and values will be opened and closed by this procedure, even if<br>
one is already open. An empty list will be returned if the API<br>
key is not found; otherwise, a two element list will be returned,<br>
where the first element is the integer identifier associated with<br>
the API key and the second element is the HMAC key associated with<br>
the API key. This is shared by the "log.tcl" and "var.tcl" files.<br>
</blockquote><br><hr><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=tcl/log.tcl&ln=183">formatElapsed</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=tcl/log.tcl">log.tcl</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "seconds"</span></big><br>
<big><span style="font-family: monospace;"> Optional argument "ago" with default value ""</span></big><br>
<blockquote style="font-family: monospace;"><br>
This Tcl procedure attempts to convert the specified number of<br>
seconds into a reasonable, easy-to-read string, approximately<br>
representing its duration.<br>
</blockquote><br><hr><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=tcl/log.tcl&ln=246">maybeCreateLogWhereClause</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=tcl/log.tcl">log.tcl</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "type"</span></big><br>
<big><span style="font-family: monospace;"> Required argument "reviewed"</span></big><br>
<big><span style="font-family: monospace;"> Required argument "whereClauseVarName"</span></big><br>
<big><span style="font-family: monospace;"> Required argument "whereTextVarName"</span></big><br>
<big><span style="font-family: monospace;"> Optional argument list "args"</span></big><br>
<blockquote style="font-family: monospace;"><br>
This Tcl procedure attempts to create a WHERE clause for the log<br>
table of the database, based on a list of search terms filtered<br>
by using equality and/or LIKE operators. If the list of search<br>
terms is empty, there will be an empty WHERE clause. The return<br>
value of this procedure is undefined. In terms of tables, only<br>
the "log" table is actually referenced by this procedure; however,<br>
that being said, callers are (obviously?) may include other tables<br>
in their final SQL query.<br>
</blockquote><br><hr><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=tcl/password.tcl&ln=40">setupPasswordGlobals</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=tcl/password.tcl">password.tcl</a>")</span></big></big><br>
<blockquote style="font-family: monospace;"><br>
This TH1 procedure initializes the global variables used by this script<br>
file. There are no arguments. If Tcl integration is not available for<br>
any reason, a script error will be raised.<br>
</blockquote><br><hr><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=tcl/password.tcl&ln=49">getPasswordDb</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=tcl/password.tcl">password.tcl</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "varName"</span></big><br>
<blockquote style="font-family: monospace;"><br>
This Tcl procedure returns a fully qualified path and file name for<br>
the database of passwords. There are no arguments.<br>
</blockquote><br><hr><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=tcl/password.tcl&ln=98">openAndSetupPasswordDb</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=tcl/password.tcl">password.tcl</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "cmdName"</span></big><br>
<big><span style="font-family: monospace;"> Required argument "readOnly"</span></big><br>
<blockquote style="font-family: monospace;"><br>
This Tcl procedure attempts to open the database of passwords and<br>
enable the options it needs, e.g. via PRAGMA, etc. The readOnly<br>
argument should be non-zero to prevent writes to the database.<br>
</blockquote><br><hr><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=tcl/secret.tcl&ln=40">setupSecretGlobals</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=tcl/secret.tcl">secret.tcl</a>")</span></big></big><br>
<blockquote style="font-family: monospace;"><br>
This TH1 procedure initializes the global variables used by this script<br>
file. There are no arguments. If Tcl integration is not available for<br>
any reason, a script error will be raised.<br>
</blockquote><br><hr><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=tcl/secret.tcl&ln=49">getSecretDb</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=tcl/secret.tcl">secret.tcl</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "varName"</span></big><br>
<blockquote style="font-family: monospace;"><br>
This Tcl procedure returns a fully qualified path and file name for<br>
the database of secrets. There are no arguments.<br>
</blockquote><br><hr><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=tcl/secret.tcl&ln=98">openAndSetupSecretDb</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=tcl/secret.tcl">secret.tcl</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "cmdName"</span></big><br>
<big><span style="font-family: monospace;"> Required argument "readOnly"</span></big><br>
<blockquote style="font-family: monospace;"><br>
This Tcl procedure attempts to open the database of secrets and<br>
enable the options it needs, e.g. via PRAGMA, etc. The readOnly<br>
argument should be non-zero to prevent writes to the database.<br>
</blockquote><br><hr><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=tcl/secret.tcl&ln=123">getSecretKeyIdFromApiKey</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=tcl/secret.tcl">secret.tcl</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "apiKey"</span></big><br>
<big><span style="font-family: monospace;"> Required argument "readOnly"</span></big><br>
<blockquote style="font-family: monospace;"><br>
This Tcl procedure attempts to obtain an Id based on an API key.<br>
Another connection to the database of variable names and values<br>
will be opened and closed by this procedure, even if one is already<br>
open. An empty string will be returned if the API key is not found;<br>
otherwise, a non-empty string will be returned, which will be the<br>
integer identifier associated with the API key.<br>
</blockquote><br><hr><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=tcl/time.tcl&ln=39">setupTimeGlobals</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=tcl/time.tcl">time.tcl</a>")</span></big></big><br>
<blockquote style="font-family: monospace;"><br>
This TH1 procedure initializes the global variables used by this script<br>
file. There are no arguments. It must not raise script errors.<br>
</blockquote><br><hr><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=tcl/time.tcl&ln=53">getTimeInUtc</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=tcl/time.tcl">time.tcl</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "raw"</span></big><br>
<blockquote style="font-family: monospace;"><br>
This Tcl procedure returns the current time (as UTC) as a formatted<br>
value -OR- as a raw number of (wide integer) milliseconds since the<br>
Unix epoch. The raw argument can be non-zero if the caller wishes<br>
to obtain the raw number of (wide integer) milliseconds since the<br>
Unix epoch.<br>
</blockquote><br><hr><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=tcl/urn.tcl&ln=50">setupUrnGlobals</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=tcl/urn.tcl">urn.tcl</a>")</span></big></big><br>
<blockquote style="font-family: monospace;"><br>
This TH1 procedure initializes the global variables used by this script<br>
file. There are no arguments. If Tcl integration is not available for<br>
any reason, a script error will be raised.<br>
</blockquote><br><hr><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=tcl/urn.tcl&ln=84">getUrnDb</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=tcl/urn.tcl">urn.tcl</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "varName"</span></big><br>
<blockquote style="font-family: monospace;"><br>
This Tcl procedure returns a fully qualified path and file name for<br>
the database of URNs. There are no arguments.<br>
</blockquote><br><hr><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=tcl/urn.tcl&ln=133">openAndSetupUrnDb</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=tcl/urn.tcl">urn.tcl</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "cmdName"</span></big><br>
<big><span style="font-family: monospace;"> Required argument "readOnly"</span></big><br>
<big><span style="font-family: monospace;"> Required argument "functions"</span></big><br>
<blockquote style="font-family: monospace;"><br>
This Tcl procedure attempts to open the database of URNs and enable<br>
the options it needs, e.g. via PRAGMA, etc. The readOnly argument<br>
should be non-zero to prevent writes to the database.<br>
</blockquote><br><hr><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=tcl/urn.tcl&ln=164">hasFallbackCodePrefix</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=tcl/urn.tcl">urn.tcl</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "code"</span></big><br>
<big><span style="font-family: monospace;"> Optional argument "prefixVarName" with default value ""</span></big><br>
<big><span style="font-family: monospace;"> Optional argument "codeVarName" with default value ""</span></big><br>
<blockquote style="font-family: monospace;"><br>
This Tcl procedure checks if the specified URN code has a prefix<br>
that looks like a fallback. In that case, extract the server and<br>
link identifiers from the code argument and modify the specified<br>
variable names, from the prefixVarName and codeVarName arguments,<br>
in the context of the caller to contain the server identifier and<br>
link identifier, respectively. A non-zero value will be returned<br>
if the fallback detection was successful. This procedure should<br>
not raise script errors.<br>
</blockquote><br><hr><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=tcl/urn.tcl&ln=204">getFallbackUri</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=tcl/urn.tcl">urn.tcl</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "prefix"</span></big><br>
<big><span style="font-family: monospace;"> Required argument "code"</span></big><br>
<blockquote style="font-family: monospace;"><br>
This Tcl procedure formats a URI, using the fallback prefix and code<br>
values obtained from the [hasFallbackCodePrefix] procedure. This<br>
procedure cannot really fail and should not raise script errors.<br>
</blockquote><br><hr><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=tcl/urn.tcl&ln=218">hasVariableCodePrefix</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=tcl/urn.tcl">urn.tcl</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "code"</span></big><br>
<big><span style="font-family: monospace;"> Optional argument "varName" with default value ""</span></big><br>
<blockquote style="font-family: monospace;"><br>
This Tcl procedure checks if the specified URN code has a prefix<br>
that looks like a network variable reference. In that case, extract<br>
the name of the referenced network variable from the code argument<br>
and modify the specified variable name, from the varName argument, in<br>
the context of the caller to contain the name of the referenced<br>
network variable. A non-zero value will be returned if the network<br>
variable name detection was successful. This procedure should not<br>
raise script errors.<br>
</blockquote><br><hr><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=tcl/var.tcl&ln=39">setupVarGlobals</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=tcl/var.tcl">var.tcl</a>")</span></big></big><br>
<blockquote style="font-family: monospace;"><br>
This TH1 procedure initializes the global variables used by this script<br>
file. There are no arguments. It must not raise script errors.<br>
</blockquote><br><hr><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=tcl/var.tcl&ln=50">getVarDb</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=tcl/var.tcl">var.tcl</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "varName"</span></big><br>
<blockquote style="font-family: monospace;"><br>
This Tcl procedure returns a fully qualified path and file name for<br>
the database of variable names and values. There are no arguments.<br>
</blockquote><br><hr><br>
<big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=tcl/var.tcl&ln=100">openAndSetupVarDb</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=tcl/var.tcl">var.tcl</a>")</span></big></big><br>
<br>
<big><span style="font-family: monospace;"> Required argument "cmdName"</span></big><br>
<big><span style="font-family: monospace;"> Required argument "readOnly"</span></big><br>
<blockquote style="font-family: monospace;"><br>
This Tcl procedure attempts to open the database of variable names<br>
and values and enable the options it needs, e.g. via PRAGMA, etc.<br>
The readOnly argument should be non-zero to prevent writes to the<br>
database.<br>
</blockquote><br><hr><br>
</div>