<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
 -  
 -  This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
 -  project.
 -  
 -  Copyright (C) 1998-2018 OpenLink Software
 -  
 -  This project is free software; you can redistribute it and/or modify it
 -  under the terms of the GNU General Public License as published by the
 -  Free Software Foundation; only version 2 of the License, dated June 1991.
 -  
 -  This program is distributed in the hope that it will be useful, but
 -  WITHOUT ANY WARRANTY; without even the implied warranty of
 -  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 -  General Public License for more details.
 -  
 -  You should have received a copy of the GNU General Public License along
 -  with this program; if not, write to the Free Software Foundation, Inc.,
 -  51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 -  
 -  
-->
<refentry id="fn_http_map_get">
  <refmeta>
    <refentrytitle>http_map_get</refentrytitle>
    <refmiscinfo>ws</refmiscinfo>
  </refmeta>
  <refnamediv>
    <refname>http_map_get</refname>
    <refpurpose>get values from HTTP virtual host path mapping table</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <funcsynopsis id="fsyn_http_map_get">
      <funcprototype id="fproto_http_map_get">
        <funcdef><function>http_map_get</function></funcdef>
        <paramdef>in <parameter>element_name</parameter> varchar</paramdef>
      </funcprototype>
    </funcsynopsis>
  </refsynopsisdiv>
  <refsect1 id="desc_http_map_get"><title>Description</title>
    <para>
    Retrieves information associated with the virtual host / HTTP path mapping in
    effect for the VSP page being processed.
    Values valid
    in current connection or URL context may be retrieved by <parameter>element_name</parameter>.</para>
    <para>Calling <function>http_map_get</function> has no use outside of http context. In this case an
    error will be signalled.</para>
  </refsect1>
  <refsect1 id="params_http_map_get"><title>Parameters</title>
    <refsect2><title>element_name</title>
      <para>The possible values for element_name are: 'vsp_uid', 'soap_uid', 'persist_ses_vars',
      'default_page', 'browseable', 'security_level' , 'auth_opts', 'soap_opts', 'domain',
      'mounted'.</para>
    </refsect2>
  </refsect1>
  <refsect1 id="ret_http_map_get"><title>Return Types</title>
    <para>Value returned depends of <parameter>element_name</parameter>:</para>
    <table><title>Values returned by http_map_get</title>
      <tgroup cols="3">
        <thead>
          <row>
            <entry>element_name</entry>
            <entry>Datatype</entry>
            <entry>Return value</entry>
          </row>
        </thead>
        <tbody>
          <row>
            <entry>vsp_uid</entry>
            <entry><type>VARCHAR</type></entry>
            <entry>Which SQL user active content will execute as</entry>
          </row>
          <row>
            <entry>soap_uid</entry>
            <entry><type>VARCHAR</type></entry>
            <entry>Which SQL user SOAP calls will be executed as</entry>
          </row>
          <row>
            <entry>persist_ses_vars</entry>
            <entry><type>INTEGER</type></entry>
            <entry>Is persisting of session variables enabled?</entry>
          </row>
          <row>
            <entry>default_page</entry>
            <entry><type>VARCHAR</type></entry>
            <entry>Default page for current mapping</entry>
          </row>
          <row>
            <entry>browseable</entry>
            <entry><type>INTEGER</type></entry>
            <entry>Is directory browsing enabled?</entry>
          </row>
          <row>
            <entry>security_level</entry>
            <entry><type>VARCHAR</type></entry>
            <entry>Security level ('DIGEST', 'SSL', 'BASIC')</entry>
          </row>
          <row>
            <entry>auth_opts</entry>
            <entry><type>ANY</type></entry>
            <entry>Application-specific authentication options</entry>
          </row>
          <row>
            <entry>soap_opts</entry>
            <entry><type>ANY</type></entry>
            <entry>Application-specific SOAP options</entry>
          </row>
          <row>
            <entry>domain</entry>
            <entry><type>VARCHAR</type></entry>
            <entry>Directory path that is the logical start point of current mapping.</entry>
          </row>
          <row>
            <entry>mounted</entry>
            <entry><type>VARCHAR</type></entry>
            <entry>Physical path that is the physical start point of current mapping</entry>
          </row>
	</tbody>
      </tgroup>
    </table>
  </refsect1>
  <refsect1 id="examples_http_map_get"><title>Examples</title>
    <example id="ex_http_map_get"><title>Retrieving Mapping Details</title>
      <screen>&lt;?vsp
declare def_page varchar;
def_page := http_map_get ('default_page');
http (sprintf ('&lt;p&gt;The default page for this path is: %s &lt;/p&gt;', def_page));
?&gt;
</screen>
</example>
    <example id="ex_http_map_get_2"><title>Warn users if non-SSL connection</title>
      <screen>&lt;HTML&gt;
  &lt;HEAD&gt;
    &lt;TITLE&gt;TEST&lt;/TITLE&gt;
  &lt;/HEAD&gt;
  &lt;BODY&gt;
    &lt;P&gt;We're executing as &lt;?= http_map_get ('vsp_uid') ?&gt;&lt;/P&gt;
&lt;?vsp
    if (http_map_get ('security_level') &lt;&gt; 'SSL')
      {
?&gt;
    Warning: This page is not protected by transport level encryption
    and may be viewable by anybody in the middle with a network
    sniffer.
&lt;?vsp
      }
?&gt;
  &lt;/BODY&gt;
&lt;/HTML&gt;
</screen>
    </example>
  </refsect1>
</refentry>