Enhanced PHP File Manager

⬆️ Go Up (..)

📊 Server Information

Server:

nginx/1.28.0

System:

Linux 6.8.0-90-generic

PHP Version:

8.4.15

User:

alqudsvolunteers

Directory:

/home/alqudsvolunteers/rootlink/usr/share/doc/varnish/html/reference

Free Space:

80.32 GB

🔧 Quick Actions

✏️ Editing: vmod_std.html

<!DOCTYPE html>

<title>VMOD std - Varnish Standard Module &#8212; Varnish version 7.5.0 documentation</title>
 <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
 <link rel="stylesheet" type="text/css" href="../_static/classic.css?v=e2714048" />
 
 <script src="../_static/documentation_options.js?v=8214db13"></script>
 <script src="../_static/doctools.js?v=888ff710"></script>
 <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
 
 <link rel="index" title="Index" href="../genindex.html" />
 <link rel="search" title="Search" href="../search.html" />
 <link rel="next" title="VMOD unix - Utilities for Unix domain sockets" href="vmod_unix.html" />
 <link rel="prev" title="VMOD purge - Varnish Purge Module" href="vmod_purge.html" /> 
 </head><body>
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 accesskey="I">index</a></li>
 <li class="right" >
 <a href="vmod_unix.html" title="VMOD unix - Utilities for Unix domain sockets"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="vmod_purge.html" title="VMOD purge - Varnish Purge Module"
 accesskey="P">previous</a> |</li>
 <li class="nav-item nav-item-0"><a href="../index.html">Varnish version 7.5.0 documentation</a> &#187;</li>
 <li class="nav-item nav-item-1"><a href="index.html" accesskey="U">The Varnish Reference Manual</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">VMOD std - Varnish Standard Module</a></li> 
 </ul>
 </div>

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="vmod-std-varnish-standard-module">
<h1>VMOD std - Varnish Standard Module<a class="headerlink" href="#vmod-std-varnish-standard-module" title="Link to this heading">¶</a></h1>
<section id="synopsis">
<h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Link to this heading">¶</a></h2>
<pre class="literal-block">import std [as name] [from &quot;path&quot;]

<a class="reference internal" href="#std-random">REAL random(REAL lo, REAL hi)</a>

<a class="reference internal" href="#std-round">REAL round(REAL r)</a>

<a class="reference internal" href="#std-collect">VOID collect(HEADER hdr, STRING sep=”, “)</a>

<a class="reference internal" href="#std-querysort">STRING querysort(STRING)</a>

<a class="reference internal" href="#std-toupper">STRING toupper(STRING s)</a>

<a class="reference internal" href="#std-tolower">STRING tolower(STRING s)</a>

<a class="reference internal" href="#std-strstr">STRING strstr(STRING s1, STRING s2)</a>

<a class="reference internal" href="#std-fnmatch">BOOL fnmatch(STRING pattern, STRING subject, BOOL pathname, BOOL noescape, BOOL period)</a>

<a class="reference internal" href="#std-fileread">STRING fileread(STRING)</a>

<a class="reference internal" href="#std-blobread">BLOB blobread(STRING)</a>

<a class="reference internal" href="#std-file-exists">BOOL file_exists(STRING path)</a>

<a class="reference internal" href="#std-healthy">BOOL healthy(BACKEND be)</a>

<a class="reference internal" href="#std-duration">DURATION duration([STRING s], [DURATION fallback], [REAL real], [INT integer])</a>

<a class="reference internal" href="#std-bytes">BYTES bytes([STRING s], [BYTES fallback], [REAL real], [INT integer])</a>

<a class="reference internal" href="#std-integer">INT integer([STRING s], [INT fallback], [BOOL bool], [BYTES bytes], [DURATION duration], [REAL real], [TIME time])</a>

<a class="reference internal" href="#std-ip">IP ip(STRING s, [IP fallback], BOOL resolve=1, [STRING p])</a>

<a class="reference internal" href="#std-real">REAL real([STRING s], [REAL fallback], [INT integer], [BOOL bool], [BYTES bytes], [DURATION duration], [TIME time])</a>

<a class="reference internal" href="#std-time">TIME time([STRING s], [TIME fallback], [REAL real], [INT integer])</a>

<a class="reference internal" href="#std-strftime">STRING strftime(TIME time, STRING format)</a>

<a class="reference internal" href="#std-log">VOID log(STRING s)</a>

<a class="reference internal" href="#std-syslog">VOID syslog(INT priority, STRING s)</a>

<a class="reference internal" href="#std-timestamp">VOID timestamp(STRING s)</a>

<a class="reference internal" href="#std-syntax">BOOL syntax(REAL)</a>

<a class="reference internal" href="#std-getenv">STRING getenv(STRING name)</a>

<a class="reference internal" href="#std-cache-req-body">BOOL cache_req_body(BYTES size)</a>

<a class="reference internal" href="#std-late-100-continue">VOID late_100_continue(BOOL late)</a>

<a class="reference internal" href="#std-rollback">VOID rollback(HTTP h)</a>

<a class="reference internal" href="#std-ban">BOOL ban(STRING)</a>

<a class="reference internal" href="#std-ban-error">STRING ban_error()</a>

<a class="reference internal" href="#std-timed-call">DURATION timed_call(SUB)</a>

<a class="reference internal" href="#std-real2integer">INT real2integer(REAL r, INT fallback)</a>

<a class="reference internal" href="#std-real2time">TIME real2time(REAL r, TIME fallback)</a>

<a class="reference internal" href="#std-time2integer">INT time2integer(TIME t, INT fallback)</a>

<a class="reference internal" href="#std-time2real">REAL time2real(TIME t, REAL fallback)</a></pre>
</section>
<section id="description">
<h2>DESCRIPTION<a class="headerlink" href="#description" title="Link to this heading">¶</a></h2>
vmod_std contains basic functions which are part and parcel of
Varnish, but which for reasons of architecture fit better in a VMOD.
</section>
<section id="numeric-functions">
<h2>Numeric functions<a class="headerlink" href="#numeric-functions" title="Link to this heading">¶</a></h2>
<section id="real-random-real-lo-real-hi">
<h3>REAL random(REAL lo, REAL hi)<a class="headerlink" href="#real-random-real-lo-real-hi" title="Link to this heading">¶</a></h3>
Returns a random real number between lo and hi.
This function uses the “testable” random generator in varnishd which
enables deterministic tests to be run (See <code class="docutils literal notranslate">debug.srandom</code> CLI
command). This function should not be used for cryptographic
applications.
Example:
<div class="highlight-default notranslate"><div class="highlight"><pre>set beresp.http.random-number = std.random(1, 100);
</pre></div>
</div>
</section>
<section id="real-round-real-r">
<h3>REAL round(REAL r)<a class="headerlink" href="#real-round-real-r" title="Link to this heading">¶</a></h3>
Rounds the real r to the nearest integer, but round halfway cases
away from zero (see <cite>round(3)</cite>).
</section>
</section>
<section id="string-functions">
<h2>String functions<a class="headerlink" href="#string-functions" title="Link to this heading">¶</a></h2>
<section id="void-collect-header-hdr-string-sep">
<h3>VOID collect(HEADER hdr, STRING sep=”, “)<a class="headerlink" href="#void-collect-header-hdr-string-sep" title="Link to this heading">¶</a></h3>
Collapses multiple hdr headers into one long header. The default
separator sep is the standard comma separator to use when collapsing
headers, with an additional whitespace for pretty printing.
Care should be taken when collapsing headers. In particular collapsing
<code class="docutils literal notranslate">Set-Cookie</code> will lead to unexpected results on the browser side.
Using hdr from <code class="docutils literal notranslate">obj.http</code> triggers a VCL failure.
Examples:
<div class="highlight-default notranslate"><div class="highlight"><pre>std.collect(req.http.accept);
std.collect(req.http.cookie, &quot;; &quot;);
</pre></div>
</div>
</section>
<section id="string-querysort-string">
<h3>STRING querysort(STRING)<a class="headerlink" href="#string-querysort-string" title="Link to this heading">¶</a></h3>
Sorts the query string for cache normalization purposes.
Example:
<div class="highlight-default notranslate"><div class="highlight"><pre>set req.url = std.querysort(req.url);
</pre></div>
</div>
</section>
<section id="string-toupper-string-s">
<h3>STRING toupper(STRING s)<a class="headerlink" href="#string-toupper-string-s" title="Link to this heading">¶</a></h3>
Converts the string s to uppercase.
Example:
<div class="highlight-default notranslate"><div class="highlight"><pre>set beresp.http.scream = std.toupper(&quot;yes!&quot;);
</pre></div>
</div>
</section>
<section id="string-tolower-string-s">
<h3>STRING tolower(STRING s)<a class="headerlink" href="#string-tolower-string-s" title="Link to this heading">¶</a></h3>
Converts the string s to lowercase.
Example:
<div class="highlight-default notranslate"><div class="highlight"><pre>set beresp.http.nice = std.tolower(&quot;VerY&quot;);
</pre></div>
</div>
</section>
<section id="string-strstr-string-s1-string-s2">
<h3>STRING strstr(STRING s1, STRING s2)<a class="headerlink" href="#string-strstr-string-s1-string-s2" title="Link to this heading">¶</a></h3>
Returns a string beginning at the first occurrence of the string s2
in the string s1, or an empty string if s2 is not found.
Note that the comparison is case sensitive.
Example:
<div class="highlight-default notranslate"><div class="highlight"><pre>if (std.strstr(req.url, req.http.restrict)) {
 ...
}
</pre></div>
</div>
This will check if the content of <code class="docutils literal notranslate">req.http.restrict</code> occurs
anywhere in <code class="docutils literal notranslate">req.url</code>.
</section>
<section id="bool-fnmatch-string-pattern-string-subject-bool-pathname-bool-noescape-bool-period">
<h3>BOOL fnmatch(STRING pattern, STRING subject, BOOL pathname, BOOL noescape, BOOL period)<a class="headerlink" href="#bool-fnmatch-string-pattern-string-subject-bool-pathname-bool-noescape-bool-period" title="Link to this heading">¶</a></h3>
<div class="highlight-default notranslate"><div class="highlight"><pre>BOOL fnmatch(
 STRING pattern,
 STRING subject,
 BOOL pathname=1,
 BOOL noescape=0,
 BOOL period=0
)
</pre></div>
</div>
Shell-style pattern matching; returns <code class="docutils literal notranslate">true</code> if subject matches
pattern, where pattern may contain wildcard characters such as <code class="docutils literal notranslate">*</code>
or <code class="docutils literal notranslate">?</code>.
The match is executed by the implementation of <cite>fnmatch(3)</cite> on your
system. The rules for pattern matching on most systems include the
following:
<ul class="simple">
<li><code class="docutils literal notranslate">*</code> matches any sequence of characters</li>
<li><code class="docutils literal notranslate">?</code> matches a single character</li>
<li>a bracket expression such as <code class="docutils literal notranslate">[abc]</code> or <code class="docutils literal notranslate">[!0-9]</code> is interpreted
as a character class according to the rules of basic regular
expressions (not <cite>pcre2(3)</cite> regexen), except that <code class="docutils literal notranslate">!</code> is used for
character class negation instead of <code class="docutils literal notranslate">^</code>.</li>
</ul>
If pathname is <code class="docutils literal notranslate">true</code>, then the forward slash character <code class="docutils literal notranslate">/</code> is
only matched literally, and never matches <code class="docutils literal notranslate">*</code>, <code class="docutils literal notranslate">?</code> or a bracket
expression. Otherwise, <code class="docutils literal notranslate">/</code> may match one of those patterns. By
default, pathname is <code class="docutils literal notranslate">true</code>.
If noescape is <code class="docutils literal notranslate">true</code>, then the backslash character <code class="docutils literal notranslate">\</code> is
matched as an ordinary character. Otherwise, <code class="docutils literal notranslate">\</code> is an escape
character, and matches the character that follows it in the
pattern. For example, <code class="docutils literal notranslate">\\</code> matches <code class="docutils literal notranslate">\</code> when noescape is
<code class="docutils literal notranslate">true</code>, and <code class="docutils literal notranslate">\\</code> when <code class="docutils literal notranslate">false</code>. By default, noescape is
<code class="docutils literal notranslate">false</code>.
If period is <code class="docutils literal notranslate">true</code>, then a leading period character <code class="docutils literal notranslate">.</code> only
matches literally, and never matches <code class="docutils literal notranslate">*</code>, <code class="docutils literal notranslate">?</code> or a bracket
expression. A period is leading if it is the first character in
subject; if pathname is also <code class="docutils literal notranslate">true</code>, then a period that
immediately follows a <code class="docutils literal notranslate">/</code> is also leading (as in <code class="docutils literal notranslate">/.</code>). By
default, period is <code class="docutils literal notranslate">false</code>.
<a class="reference internal" href="#std-fnmatch">std.fnmatch()</a> invokes VCL failure and returns <code class="docutils literal notranslate">false</code> if
either of pattern or subject is <code class="docutils literal notranslate">NULL</code> – for example, if an
unset header is specified.
Examples:
<div class="highlight-default notranslate"><div class="highlight"><pre># Matches URLs such as /foo/bar and /foo/baz
if (std.fnmatch(&quot;/foo/\*&quot;, req.url)) { ... }

# Matches URLs such as /foo/bar/baz and /foo/baz/quux
if (std.fnmatch(&quot;/foo/\*/\*&quot;, bereq.url)) { ... }

# Matches /foo/bar/quux, but not /foo/bar/baz/quux
if (std.fnmatch(&quot;/foo/\*/quux&quot;, req.url)) { ... }

# Matches /foo/bar/quux and /foo/bar/baz/quux
if (std.fnmatch(&quot;/foo/\*/quux&quot;, req.url, pathname=false)) { ... }

# Matches /foo/bar, /foo/car and /foo/far
if (std.fnmatch(&quot;/foo/?ar&quot;, req.url)) { ... }

# Matches /foo/ followed by a non-digit
if (std.fnmatch(&quot;/foo/[!0-9]&quot;, req.url)) { ... }
</pre></div>
</div>
</section>
</section>
<section id="file-system-functions">
<h2>File(system) functions<a class="headerlink" href="#file-system-functions" title="Link to this heading">¶</a></h2>
<section id="string-fileread-string">
<h3>STRING fileread(STRING)<a class="headerlink" href="#string-fileread-string" title="Link to this heading">¶</a></h3>
Reads a text file and returns a string with the content.
The entire file is cached on the first call, and subsequent calls
will return this cached contents, even if the file has changed in
the meantime.
For binary files, use std.blobread() instead.
Example:
<div class="highlight-default notranslate"><div class="highlight"><pre>synthetic(&quot;Response was served by &quot; + std.fileread(&quot;/etc/hostname&quot;));
</pre></div>
</div>
Consider that the entire contents of the file appear in the string
that is returned, including newlines that may result in invalid
headers if <a class="reference internal" href="#std-fileread">std.fileread()</a> is used to form a header. In that
case, you may need to modify the string, for example with
<code class="docutils literal notranslate">regsub()</code> (see <a class="reference internal" href="vcl.html#vcl-7">VCL</a>):
<div class="highlight-default notranslate"><div class="highlight"><pre>set beresp.http.served-by = regsub(std.fileread(&quot;/etc/hostname&quot;), &quot;\R$&quot;, &quot;&quot;);
</pre></div>
</div>
</section>
<section id="blob-blobread-string">
<h3>BLOB blobread(STRING)<a class="headerlink" href="#blob-blobread-string" title="Link to this heading">¶</a></h3>
Reads any file and returns a blob with the content.
The entire file is cached on the first call, and subsequent calls
will return this cached contents, even if the file has changed in
the meantime.
</section>
<section id="bool-file-exists-string-path">
<h3>BOOL file_exists(STRING path)<a class="headerlink" href="#bool-file-exists-string-path" title="Link to this heading">¶</a></h3>
Returns <code class="docutils literal notranslate">true</code> if path or the file pointed to by path exists,
<code class="docutils literal notranslate">false</code> otherwise.
Example:
<div class="highlight-default notranslate"><div class="highlight"><pre>if (std.file_exists(&quot;/etc/return_503&quot;)) {
 return (synth(503, &quot;Varnish is in maintenance&quot;));
}
</pre></div>
</div>
</section>
</section>
<section id="type-inspection-functions">
<h2>Type Inspection functions<a class="headerlink" href="#type-inspection-functions" title="Link to this heading">¶</a></h2>
<section id="bool-healthy-backend-be">
<h3>BOOL healthy(BACKEND be)<a class="headerlink" href="#bool-healthy-backend-be" title="Link to this heading">¶</a></h3>
Returns <code class="docutils literal notranslate">true</code> if the backend be is healthy.
</section>
<section id="int-port-ip-ip">
<h3>INT port(IP ip)<a class="headerlink" href="#int-port-ip-ip" title="Link to this heading">¶</a></h3>
Returns the port number of the IP address ip. Always returns <code class="docutils literal notranslate">0</code>
for a <code class="docutils literal notranslate">*.ip</code> variable when the address is a Unix domain socket.
</section>
</section>
<section id="type-conversion-functions">
<h2>Type Conversion functions<a class="headerlink" href="#type-conversion-functions" title="Link to this heading">¶</a></h2>
These functions all have the same form:
<div class="highlight-default notranslate"><div class="highlight"><pre>TYPE type([arguments], [fallback TYPE])
</pre></div>
</div>
Precisely one of the arguments must be provided (besides the
optional fallback), and it will be converted to TYPE.
If conversion fails, fallback will be returned and if no
fallback was specified, the VCL will be failed.
<section id="duration-duration-string-s-duration-fallback-real-real-int-integer">
<h3>DURATION duration([STRING s], [DURATION fallback], [REAL real], [INT integer])<a class="headerlink" href="#duration-duration-string-s-duration-fallback-real-real-int-integer" title="Link to this heading">¶</a></h3>
<div class="highlight-default notranslate"><div class="highlight"><pre>DURATION duration(
 [STRING s],
 [DURATION fallback],
 [REAL real],
 [INT integer]
)
</pre></div>
</div>
Returns a DURATION from a STRING, REAL or INT argument.
For a STRING s argument, s must be quantified by <code class="docutils literal notranslate">ms</code>
(milliseconds), <code class="docutils literal notranslate">s</code> (seconds), <code class="docutils literal notranslate">m</code> (minutes), <code class="docutils literal notranslate">h</code> (hours),``d``
(days), <code class="docutils literal notranslate">w</code> (weeks) or <code class="docutils literal notranslate">y</code> (years) units.
real and integer arguments are taken as seconds.
If the conversion of an s argument fails, fallback will be
returned if provided, or a VCL failure will be triggered.
Conversions from real and integer arguments never fail.
Only one of the s, real or integer arguments may be given or a VCL
failure will be triggered.
Examples:
<div class="highlight-default notranslate"><div class="highlight"><pre>set beresp.ttl = std.duration(&quot;1w&quot;, 3600s);
set beresp.ttl = std.duration(real=1.5);
set beresp.ttl = std.duration(integer=10);
</pre></div>
</div>
</section>
<section id="bytes-bytes-string-s-bytes-fallback-real-real-int-integer">
<h3>BYTES bytes([STRING s], [BYTES fallback], [REAL real], [INT integer])<a class="headerlink" href="#bytes-bytes-string-s-bytes-fallback-real-real-int-integer" title="Link to this heading">¶</a></h3>
<div class="highlight-default notranslate"><div class="highlight"><pre>BYTES bytes(
 [STRING s],
 [BYTES fallback],
 [REAL real],
 [INT integer]
)
</pre></div>
</div>
Returns BYTES from a STRING, REAL or INT argument.
A STRING s argument can be quantified with a multiplier (<code class="docutils literal notranslate">k</code>
(kilo), <code class="docutils literal notranslate">m</code> (mega), <code class="docutils literal notranslate">g</code> (giga), <code class="docutils literal notranslate">t</code> (tera) or <code class="docutils literal notranslate">p</code> (peta)).
real and integer arguments are taken as bytes.
If the conversion of an s argument fails, fallback will be
returned if provided, or a VCL failure will be triggered.
Other conversions may fail if the argument can not be represented,
because it is negative, too small or too large. Again, fallback will
be returned if provided, or a VCL failure will be triggered.
real arguments will be rounded down.
Only one of the s, real or integer arguments may be given or a VCL
failure will be triggered.
Example:
<div class="highlight-default notranslate"><div class="highlight"><pre>std.cache_req_body(std.bytes(something.somewhere, 10K));
std.cache_req_body(std.bytes(integer=10*1024));
std.cache_req_body(std.bytes(real=10.0*1024));
</pre></div>
</div>
</section>
<section id="int-integer-string-s-int-fallback-bool-bool-bytes-bytes-duration-duration-real-real-time-time">
<h3>INT integer([STRING s], [INT fallback], [BOOL bool], [BYTES bytes], [DURATION duration], [REAL real], [TIME time])<a class="headerlink" href="#int-integer-string-s-int-fallback-bool-bool-bytes-bytes-duration-duration-real-real-time-time" title="Link to this heading">¶</a></h3>
<div class="highlight-default notranslate"><div class="highlight"><pre>INT integer(
 [STRING s],
 [INT fallback],
 [BOOL bool],
 [BYTES bytes],
 [DURATION duration],
 [REAL real],
 [TIME time]
)
</pre></div>
</div>
Returns an INT from a STRING, BOOL or other quantity.
If the conversion of an s argument fails, fallback will be
returned if provided, or a VCL failure will be triggered.
A bool argument will be returned as 0 for <code class="docutils literal notranslate">false</code> and 1 for
<code class="docutils literal notranslate">true</code>. This conversion will never fail.
For a bytes argument, the number of bytes will be returned. This
conversion will never fail.
A duration argument will be rounded down to the number of seconds
and returned.
A real argument will be rounded down and returned.
For a time argument, the number of seconds since the UNIX epoch
(1970-01-01 00:00:00 UTC) will be returned.
duration, real and time conversions may fail if the argument can
not be represented because it is too small or too large. If so,
fallback will be returned if provided, or a VCL failure will be
triggered.
Only one of the s, bool, bytes, duration, real or time
arguments may be given or a VCL failure will be triggered.
Examples:
<div class="highlight-default notranslate"><div class="highlight"><pre>if (std.integer(req.http.foo, 0) &gt; 5) {
 ...
}

set resp.http.answer = std.integer(real=126.42/3);
</pre></div>
</div>
</section>
<section id="ip-ip-string-s-ip-fallback-bool-resolve-1-string-p">
<h3>IP ip(STRING s, [IP fallback], BOOL resolve=1, [STRING p])<a class="headerlink" href="#ip-ip-string-s-ip-fallback-bool-resolve-1-string-p" title="Link to this heading">¶</a></h3>
Converts the string s to the first IP number returned by the system
library function <cite>getaddrinfo(3)</cite>. If conversion fails, fallback will
be returned or VCL failure will happen.
The IP address includes a port number that can be found with <code class="docutils literal notranslate">std.port()</code>
that defaults to 80. The default port can be set to a different value with
the p argument. It will be overridden if s contains both an IP address
and a port number or service name.
When s contains both, the syntax is either <code class="docutils literal notranslate">address:port</code> or
<code class="docutils literal notranslate">address port</code>. If the address is a numerical IPv6 address it must be
enclosed between brackets, for example <code class="docutils literal notranslate">[::1] 80</code> or <code class="docutils literal notranslate">[::1]:http</code>.
The fallback may also contain both an address and a port, but its default
port is always 80.
If resolve is false, <cite>getaddrinfo(3)</cite> is called using <code class="docutils literal notranslate">AI_NUMERICHOST</code>
and <code class="docutils literal notranslate">AI_NUMERICSERV</code> to avoid network lookups depending on the system’s
<cite>getaddrinfo(3)</cite> or nsswitch configuration. This makes “numerical” IP
strings and services cheaper to convert.
Example:
<div class="highlight-default notranslate"><div class="highlight"><pre>if (std.ip(req.http.X-forwarded-for, &quot;0.0.0.0&quot;) ~ my_acl) {
 ...
}
</pre></div>
</div>
</section>
<section id="real-real-string-s-real-fallback-int-integer-bool-bool-bytes-bytes-duration-duration-time-time">
<h3>REAL real([STRING s], [REAL fallback], [INT integer], [BOOL bool], [BYTES bytes], [DURATION duration], [TIME time])<a class="headerlink" href="#real-real-string-s-real-fallback-int-integer-bool-bool-bytes-bytes-duration-duration-time-time" title="Link to this heading">¶</a></h3>
<div class="highlight-default notranslate"><div class="highlight"><pre>REAL real(
 [STRING s],
 [REAL fallback],
 [INT integer],
 [BOOL bool],
 [BYTES bytes],
 [DURATION duration],
 [TIME time]
)
</pre></div>
</div>
Returns a REAL from a STRING, BOOL or other quantity.
If the conversion of an s argument fails, fallback will be
returned if provided, or a VCL failure will be triggered.
A bool argument will be returned as 0.0 for <code class="docutils literal notranslate">false</code> and 1.0 for
<code class="docutils literal notranslate">true</code>.
For a bytes argument, the number of bytes will be returned.
For a duration argument, the number of seconds will be returned.
An integer argument will be returned as a REAL.
For a time argument, the number of seconds since the UNIX epoch
(1970-01-01 00:00:00 UTC) will be returned.
None of these conversions other than s will fail.
Only one of the s, integer, bool, bytes, duration or time
arguments may be given or a VCL failure will be triggered.
Example:
<div class="highlight-default notranslate"><div class="highlight"><pre>if (std.real(req.http.foo, 0.0) &gt; 5.5) {
 ...
}
</pre></div>
</div>
</section>
<section id="time-time-string-s-time-fallback-real-real-int-integer">
<h3>TIME time([STRING s], [TIME fallback], [REAL real], [INT integer])<a class="headerlink" href="#time-time-string-s-time-fallback-real-real-int-integer" title="Link to this heading">¶</a></h3>
<div class="highlight-default notranslate"><div class="highlight"><pre>TIME time([STRING s], [TIME fallback], [REAL real], [INT integer])
</pre></div>
</div>
Returns a TIME from a STRING, REAL or INT argument.
For a STRING s argument, the following formats are supported:
<div class="highlight-default notranslate"><div class="highlight"><pre>&quot;Sun, 06 Nov 1994 08:49:37 GMT&quot;
&quot;Sunday, 06-Nov-94 08:49:37 GMT&quot;
&quot;Sun Nov 6 08:49:37 1994&quot;
&quot;1994-11-06T08:49:37&quot;
&quot;784111777.00&quot;
&quot;784111777&quot;
</pre></div>
</div>
real and integer arguments are taken as seconds since the epoch.
If the conversion of an s argument fails or a negative real or
integer argument is given, fallback will be returned if provided,
or a VCL failure will be triggered.
Examples:
<div class="highlight-default notranslate"><div class="highlight"><pre>if (std.time(resp.http.last-modified, now) &lt; now - 1w) {
 ...
}

if (std.time(int=2147483647) &lt; now - 1w) {
 ...
}
</pre></div>
</div>
</section>
<section id="string-strftime-time-time-string-format">
<h3>STRING strftime(TIME time, STRING format)<a class="headerlink" href="#string-strftime-time-time-string-format" title="Link to this heading">¶</a></h3>
Format the time argument with the format argument using
<cite>strftime(3)</cite> and return the result for the UTC (historically GMT)
timezone.
The empty string is returned if formatting fails, but may also be
returned as a valid result.
Example:
<div class="highlight-default notranslate"><div class="highlight"><pre>set req.http.iso = std.strftime(now, &quot;%Y%m%dT%H%M%SZ&quot;);
# e.g. 20210521T175241Z
</pre></div>
</div>
</section>
</section>
<section id="logging-functions">
<h2>LOGGING functions<a class="headerlink" href="#logging-functions" title="Link to this heading">¶</a></h2>
<section id="void-log-string-s">
<h3>VOID log(STRING s)<a class="headerlink" href="#void-log-string-s" title="Link to this heading">¶</a></h3>
Logs the string s to the shared memory log, using <a class="reference internal" href="vsl.html#vsl-7">VSL</a> tag
<code class="docutils literal notranslate">SLT_VCL_Log</code>.
Example:
<div class="highlight-default notranslate"><div class="highlight"><pre>std.log(&quot;Something fishy is going on with the vhost &quot; + req.http.host);
</pre></div>
</div>
</section>
<section id="void-syslog-int-priority-string-s">
<h3>VOID syslog(INT priority, STRING s)<a class="headerlink" href="#void-syslog-int-priority-string-s" title="Link to this heading">¶</a></h3>
Logs the string s to syslog tagged with priority. priority is
formed by ORing the facility and level values. See your system’s
<code class="docutils literal notranslate">syslog.h</code> file for possible values.
Notice: Unlike VCL and other functions in the std vmod, this function
will not fail VCL processing for workspace overflows: For an out of
workspace condition, the <a class="reference internal" href="#std-syslog">std.syslog()</a> function has no effect.
Example:
<div class="highlight-default notranslate"><div class="highlight"><pre>std.syslog(9, &quot;Something is wrong&quot;);
</pre></div>
</div>
This will send a message to syslog using <code class="docutils literal notranslate">LOG_USER | LOG_ALERT</code>.
</section>
<section id="void-timestamp-string-s">
<h3>VOID timestamp(STRING s)<a class="headerlink" href="#void-timestamp-string-s" title="Link to this heading">¶</a></h3>
Introduces a timestamp in the log with the current time, using the
string s as the label. This is useful to time the execution of lengthy
VCL subroutines, and makes the timestamps inserted automatically by
Varnish more accurate.
Example:
<div class="highlight-default notranslate"><div class="highlight"><pre>std.timestamp(&quot;curl-request&quot;);
</pre></div>
</div>
</section>
</section>
<section id="control-and-information-functions">
<h2>CONTROL and INFORMATION functions<a class="headerlink" href="#control-and-information-functions" title="Link to this heading">¶</a></h2>
<section id="bool-syntax-real">
<h3>BOOL syntax(REAL)<a class="headerlink" href="#bool-syntax-real" title="Link to this heading">¶</a></h3>
Returns <code class="docutils literal notranslate">true</code> if VCL version is at least REAL.
</section>
<section id="string-getenv-string-name">
<h3>STRING getenv(STRING name)<a class="headerlink" href="#string-getenv-string-name" title="Link to this heading">¶</a></h3>
Return environment variable name or the empty string. See <cite>getenv(3)</cite>.
Example:
<div class="highlight-default notranslate"><div class="highlight"><pre>set req.http.My-Env = std.getenv(&quot;MY_ENV&quot;);
</pre></div>
</div>
</section>
<section id="bool-cache-req-body-bytes-size">
<h3>BOOL cache_req_body(BYTES size)<a class="headerlink" href="#bool-cache-req-body-bytes-size" title="Link to this heading">¶</a></h3>
Caches the request body if it is smaller than size. Returns
<code class="docutils literal notranslate">true</code> if the body was cached, <code class="docutils literal notranslate">false</code> otherwise.
Normally the request body can only be sent once. Caching it enables
retrying backend requests with a request body, as usually the case
with <code class="docutils literal notranslate">POST</code> and <code class="docutils literal notranslate">PUT</code>.
Example:
<div class="highlight-default notranslate"><div class="highlight"><pre>if (std.cache_req_body(1KB)) {
 ...
}
</pre></div>
</div>
Restricted to: <code class="docutils literal notranslate">vcl_recv</code>.
</section>
<section id="void-late-100-continue-bool-late">
<h3>VOID late_100_continue(BOOL late)<a class="headerlink" href="#void-late-100-continue-bool-late" title="Link to this heading">¶</a></h3>
Controls when varnish reacts to an <code class="docutils literal notranslate">Expect: 100-continue</code> client
request header.
Varnish always generates a <code class="docutils literal notranslate">100 Continue</code> response if requested by
the client trough the <code class="docutils literal notranslate">Expect: 100-continue</code> header when waiting for
request body data.
But, by default, the <code class="docutils literal notranslate">100 Continue</code> response is already generated
immediately after <code class="docutils literal notranslate">vcl_recv</code> returns to reduce latencies under the
assumption that the request body will be read eventually.
Calling <code class="docutils literal notranslate">std.late_100_continue(true)</code> in <code class="docutils literal notranslate">vcl_recv</code> will cause the
<code class="docutils literal notranslate">100 Continue</code> response to only be sent when needed. This may cause
additional latencies for processing request bodies, but is the correct
behavior by strict interpretation of RFC7231.
This function has no effect outside <code class="docutils literal notranslate">vcl_recv</code> and after calling
<code class="docutils literal notranslate">std.cache_req_body()</code> or any other function consuming the request
body.
Example:
<div class="highlight-default notranslate"><div class="highlight"><pre>vcl_recv {
 std.late_100_continue(true);

if (req.method == &quot;POST&quot;) {
 std.late_100_continue(false);
 return (pass);
 }
 ...
 }
</pre></div>
</div>
Restricted to: <code class="docutils literal notranslate">vcl_recv</code>.
</section>
<section id="void-set-ip-tos-int-tos">
<h3>VOID set_ip_tos(INT tos)<a class="headerlink" href="#void-set-ip-tos-int-tos" title="Link to this heading">¶</a></h3>
Sets the Differentiated Services Codepoint (DSCP) / IPv4 Type of
Service (TOS) / IPv6 Traffic Class (TCLASS) byte for the current
session to tos. Silently ignored if the listen address is a Unix
domain socket.
Please note that setting the traffic class affects all requests on the
same http1.1 / http2 TCP connection and, in particular, is not removed
at the end of the request.
Example:
<div class="highlight-default notranslate"><div class="highlight"><pre>if (req.url ~ &quot;^/slow/&quot;) {
 std.set_ip_tos(0);
}
</pre></div>
</div>
Restricted to: <code class="docutils literal notranslate">client</code>.
</section>
<section id="void-rollback-http-h">
<h3>VOID rollback(HTTP h)<a class="headerlink" href="#void-rollback-http-h" title="Link to this heading">¶</a></h3>
Restores the h HTTP headers to their original state.
Example:
<div class="highlight-default notranslate"><div class="highlight"><pre>std.rollback(bereq);
</pre></div>
</div>
Restricted to: <code class="docutils literal notranslate">backend</code>, <code class="docutils literal notranslate">vcl_recv</code>, <code class="docutils literal notranslate">vcl_pass</code>, <code class="docutils literal notranslate">vcl_hash</code>, <code class="docutils literal notranslate">vcl_purge</code>, <code class="docutils literal notranslate">vcl_miss</code>, <code class="docutils literal notranslate">vcl_hit</code>, <code class="docutils literal notranslate">vcl_deliver</code>, <code class="docutils literal notranslate">vcl_synth</code>.
</section>
<section id="bool-ban-string">
<h3>BOOL ban(STRING)<a class="headerlink" href="#bool-ban-string" title="Link to this heading">¶</a></h3>
Invalidates all objects in cache that match the given expression with
the ban mechanism. Returns <code class="docutils literal notranslate">true</code> if the ban succeeded and <code class="docutils literal notranslate">false</code>
otherwise. Error details are available via <a class="reference internal" href="#std-ban-error">std.ban_error()</a>.
The format of STRING is:
<div class="highlight-default notranslate"><div class="highlight"><pre>&lt;field&gt; &lt;operator&gt; &lt;arg&gt; [&amp;&amp; &lt;field&gt; &lt;oper&gt; &lt;arg&gt; ...]
</pre></div>
</div>
<ul>
<li>&lt;field&gt;:
<ul>
<li>string fields:
<ul class="simple">
<li><code class="docutils literal notranslate">req.url</code>: The request url</li>
<li><code class="docutils literal notranslate">req.http.*</code>: Any request header</li>
<li><code class="docutils literal notranslate">obj.status</code>: The cache object status</li>
<li><code class="docutils literal notranslate">obj.http.*</code>: Any cache object header</li>
</ul>
<code class="docutils literal notranslate">obj.status</code> is treated as a string despite the fact that it
is actually an integer.
</li>
<li>duration fields:
<ul class="simple">
<li><code class="docutils literal notranslate">obj.ttl</code>: Remaining ttl at the time the ban is issued</li>
<li><code class="docutils literal notranslate">obj.age</code>: Object age at the time the ban is issued</li>
<li><code class="docutils literal notranslate">obj.grace</code>: The grace time of the object</li>
<li><code class="docutils literal notranslate">obj.keep</code>: The keep time of the object</li>
</ul>
</li>
</ul>
</li>
<li>&lt;operator&gt;:
<ul>
<li>for all fields:
<ul class="simple">
<li><code class="docutils literal notranslate">==</code>: &lt;field&gt; and &lt;arg&gt; are equal</li>
<li><code class="docutils literal notranslate">!=</code>: &lt;field&gt; and &lt;arg&gt; are unequal</li>
</ul>
strings are compared case sensitively
</li>
<li>for string fields:
<ul class="simple">
<li><code class="docutils literal notranslate">~</code>: &lt;field&gt; matches the regular expression &lt;arg&gt;</li>
<li><code class="docutils literal notranslate">!~</code>:&lt;field&gt; does not match the regular expression &lt;arg&gt;</li>
</ul>
</li>
<li>for duration fields:
<ul class="simple">
<li><code class="docutils literal notranslate">&gt;</code>: &lt;field&gt; is greater than &lt;arg&gt;</li>
<li><code class="docutils literal notranslate">&gt;=</code>: &lt;field&gt; is greater than or equal to &lt;arg&gt;</li>
<li><code class="docutils literal notranslate">&lt;</code>: &lt;field&gt; is less than &lt;arg&gt;</li>
<li><code class="docutils literal notranslate">&lt;=</code>: &lt;field&gt; is less than or equal to &lt;arg&gt;</li>
</ul>
</li>
</ul>
</li>
<li>&lt;arg&gt;:
<ul>
<li>for string fields:
Either a literal string or a regular expression. Note that
&lt;arg&gt; does not use any of the string delimiters like <code class="docutils literal notranslate">&quot;</code> or
<code class="docutils literal notranslate">{&quot;</code>…<code class="docutils literal notranslate">&quot;}</code> or <code class="docutils literal notranslate">&quot;&quot;&quot;</code>…<code class="docutils literal notranslate">&quot;&quot;&quot;</code> used elsewhere
in varnish. To match against strings containing whitespace,
regular expressions containing <code class="docutils literal notranslate">\s</code> can be used.
</li>
<li>for duration fields:
A VCL duration like <code class="docutils literal notranslate">10s</code>, <code class="docutils literal notranslate">5m</code> or <code class="docutils literal notranslate">1h</code>, see <a class="reference internal" href="vcl.html#vcl-7-durations">Durations</a>
</li>
</ul>
</li>
</ul>
Expressions can be chained using the and operator <code class="docutils literal notranslate">&amp;&amp;</code>. For or
semantics, use several bans.
The unset &lt;field&gt; is not equal to any string, such that, for a
non-existing header, the operators <code class="docutils literal notranslate">==</code> and <code class="docutils literal notranslate">~</code> always evaluate as
false, while the operators <code class="docutils literal notranslate">!=</code> and <code class="docutils literal notranslate">!~</code> always evaluate as true,
respectively, for any value of &lt;arg&gt;.
</section>
<section id="string-ban-error">
<h3>STRING ban_error()<a class="headerlink" href="#string-ban-error" title="Link to this heading">¶</a></h3>
Returns a textual error description of the last <a class="reference internal" href="#std-ban">std.ban()</a> call from
the same task or the empty string if there either was no error or no
<a class="reference internal" href="#std-ban">std.ban()</a> call.
</section>
<section id="time-now">
<h3>TIME now()<a class="headerlink" href="#time-now" title="Link to this heading">¶</a></h3>
Returns the current time. In contrast to the <code class="docutils literal notranslate">now</code> built-in
variable, every call returns a new value.
</section>
<section id="duration-timed-call-sub">
<h3>DURATION timed_call(SUB)<a class="headerlink" href="#duration-timed-call-sub" title="Link to this heading">¶</a></h3>
Call the given SUB and return a high precision measurement of the
execution time.
</section>
</section>
<section id="deprecated-functions">
<h2>DEPRECATED functions<a class="headerlink" href="#deprecated-functions" title="Link to this heading">¶</a></h2>
<section id="int-real2integer-real-r-int-fallback">
<h3>INT real2integer(REAL r, INT fallback)<a class="headerlink" href="#int-real2integer-real-r-int-fallback" title="Link to this heading">¶</a></h3>
DEPRECATED: This function will be removed in a future version of
varnish, use <a class="reference internal" href="#std-integer">std.integer()</a> with a real argument and the
<a class="reference internal" href="#std-round">std.round()</a> function instead, for example:
<div class="highlight-default notranslate"><div class="highlight"><pre>std.integer(real=std.round(...), fallback=...)
</pre></div>
</div>
Rounds the real r to the nearest integer, but round halfway cases
away from zero (see <cite>round(3)</cite>). If conversion fails, fallback will
be returned.
Examples:
<div class="highlight-default notranslate"><div class="highlight"><pre>set req.http.integer = std.real2integer(1140618699.00, 0);
set req.http.posone = real2integer( 0.5, 0); # = 1.0
set req.http.negone = real2integer(-0.5, 0); # = -1.0
</pre></div>
</div>
</section>
<section id="time-real2time-real-r-time-fallback">
<h3>TIME real2time(REAL r, TIME fallback)<a class="headerlink" href="#time-real2time-real-r-time-fallback" title="Link to this heading">¶</a></h3>
DEPRECATED: This function will be removed in a future version of
varnish, use <a class="reference internal" href="#std-time">std.time()</a> with a real argument and the
<a class="reference internal" href="#std-round">std.round()</a> function instead, for example:
<div class="highlight-default notranslate"><div class="highlight"><pre>std.time(real=std.round(...), fallback=...)
</pre></div>
</div>
Rounds the real r to the nearest integer (see
<a class="reference internal" href="#std-real2integer">std.real2integer()</a>) and returns the corresponding time when
interpreted as a unix epoch. If conversion fails, fallback will be
returned.
Example:
<div class="highlight-default notranslate"><div class="highlight"><pre>set req.http.time = std.real2time(1140618699.00, now);
</pre></div>
</div>
</section>
<section id="int-time2integer-time-t-int-fallback">
<h3>INT time2integer(TIME t, INT fallback)<a class="headerlink" href="#int-time2integer-time-t-int-fallback" title="Link to this heading">¶</a></h3>
DEPRECATED: This function will be removed in a future version of
varnish, use <a class="reference internal" href="#std-integer">std.integer()</a> with a time argument instead, for
example:
<div class="highlight-default notranslate"><div class="highlight"><pre>std.integer(time=..., fallback=...)
</pre></div>
</div>
Converts the time t to a integer. If conversion fails,
fallback will be returned.
Example:
<div class="highlight-default notranslate"><div class="highlight"><pre>set req.http.int = std.time2integer(now, 0);
</pre></div>
</div>
</section>
<section id="real-time2real-time-t-real-fallback">
<h3>REAL time2real(TIME t, REAL fallback)<a class="headerlink" href="#real-time2real-time-t-real-fallback" title="Link to this heading">¶</a></h3>
DEPRECATED: This function will be removed in a future version of
varnish, use <a class="reference internal" href="#std-real">std.real()</a> with a time argument instead, for
example:
<div class="highlight-default notranslate"><div class="highlight"><pre>std.real(time=..., fallback=...)
</pre></div>
</div>
Converts the time t to a real. If conversion fails, fallback will
be returned.
Example:
<div class="highlight-default notranslate"><div class="highlight"><pre>set req.http.real = std.time2real(now, 1.0);
</pre></div>
</div>
</section>
</section>
<section id="see-also">
<h2>SEE ALSO<a class="headerlink" href="#see-also" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><a class="reference internal" href="varnishd.html#varnishd-1">varnishd</a></li>
<li><a class="reference internal" href="vsl.html#vsl-7">VSL</a></li>
<li><cite>fnmatch(3)</cite></li>
<li><cite>strftime(3)</cite></li>
</ul>
</section>
<section id="copyright">
<h2>COPYRIGHT<a class="headerlink" href="#copyright" title="Link to this heading">¶</a></h2>
<div class="highlight-default notranslate"><div class="highlight"><pre>Copyright (c) 2010-2017 Varnish Software AS
All rights reserved.

Author: Poul-Henning Kamp &lt;phk@FreeBSD.org&gt;

SPDX-License-Identifier: BSD-2-Clause

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS&#39;&#39; AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
</pre></div>
</div>
</section>
</section>

<div class="clearer"></div>
 </div>
 </div>
 </div>
 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 <div class="sphinxsidebarwrapper">
 <div>
 <h3><a href="../index.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#">VMOD std - Varnish Standard Module</a></li>
</ul>

</div>
 <div>
 <h4>Previous topic</h4>
 <a href="vmod_purge.html"
 title="previous chapter">VMOD purge - Varnish Purge Module</a>
 </div>
 <div>
 <h4>Next topic</h4>
 <a href="vmod_unix.html"
 title="next chapter">VMOD unix - Utilities for Unix domain sockets</a>
 </div>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../_sources/reference/vmod_std.rst.txt"
 rel="nofollow">Show Source</a></li>
 </ul>
 </div>
<div id="searchbox" style="display: none" role="search">
 <h3 id="searchlabel">Quick search</h3>
 <div class="searchformwrapper">
 <form class="search" action="../search.html" method="get">
 <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 <input type="submit" value="Go" />
 </form>
 </div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
 </div>
 </div>
 <div class="clearer"></div>
 </div>
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 >index</a></li>
 <li class="right" >
 <a href="vmod_unix.html" title="VMOD unix - Utilities for Unix domain sockets"
 >next</a> |</li>
 <li class="right" >
 <a href="vmod_purge.html" title="VMOD purge - Varnish Purge Module"
 >previous</a> |</li>
 <li class="nav-item nav-item-0"><a href="../index.html">Varnish version 7.5.0 documentation</a> &#187;</li>
 <li class="nav-item nav-item-1"><a href="index.html" >The Varnish Reference Manual</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">VMOD std - Varnish Standard Module</a></li> 
 </ul>
 </div>
 <div class="footer" role="contentinfo">
 &#169; Copyright 2010-2014, Varnish Software AS.
 Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
 </div>
 </body>
</html>

❌ Cancel

🗂️ Enhanced PHP File Manager

📊 Server Information

🔧 Quick Actions

✏️ Editing: vmod_std.html

📤 Upload File

📁 Create Folder

📄 Create File

✏️ Rename Item

🗑️ Delete Confirmation