<section id="formbroker">
    <title>The Form Broker</title>
    <section>
      <title>Introduction</title>
      <para>
         The <command>FormBroker</command> package creates instances of 
         form data description objects. These objects instances have
         a simple set of methods to validate and control data
         as typically posted by HTML forms,
         thus data represented as the map of form variables
         to their values. In Rivet this association can be obtained either
         calling <xref linkend="load_response">::rivet::load_response</xref> or
         <xref linkend="var">::rivet::var</xref> (form variables can be selectively
         read also calling <command>::rivet::var_post</command> or
         <command>::rivet::var_qs</command>)
      </para>
      <note>
      	The <command>FormBroker</command> package is still experimental. 
      	Basic functionalities and interface are not likely to change but
      	internal details and implementation could be redesigned
      	in future releases. More specifically the external validator mechanism
			will likely need design improvements.
      </note>
      <!-- programlisting>
      
      </programlisting -->
      </section>
      <refentry id="fb">
        <refnamediv>
            <refname>FormBroker</refname>
            <refpurpose>
               Form broker object creator
            </refpurpose>
        </refnamediv>
        <refsynopsisdiv>
            <cmdsynopsis>
                <command>::FormBroker</command>
                <arg choice="plain">create</arg>
                <arg><option>-quoting quoting_procedure</option></arg>
                <arg><option>variable1 descriptor</option></arg>
                <arg><option>variable2 descriptor</option></arg>
                <arg>...</arg>
            </cmdsynopsis>
        </refsynopsisdiv>
        <refsect1>
            <title>Description</title>
            <para>
               The command returns a reference to a form broker object by creating
               a representation of the form data using the list of variable 
               descriptors passed to method <command>create</command>. Each descriptor
               is a list of parameter or parameter-value pairs that must
               begin with the <command>{variable_name variable_type}</command> pair as only
               requirement. A formbroker object provide native support for
               integer, unsigned integer, string, boolean and email data types.
               The programmer can defined new data types and provide in the descriptor a
               reference to a validation procedure for that type.
            </para>
            <para>
               The optional <arg>-quoting quoting_procedure</arg> switch defines an
               external procedure to quote or reformat the response values. 
               The quoting procedure is any procedure accepting a single string argument
               and returning its quoted value. A most basic example is the FormBroker default quoting procedure
            </para>
            <programlisting>proc force_quote {str} {
    return "'$str'"
}</programlisting>
            <para>
               Other parameters of a descriptors are
            </para>
            <itemizedlist>
               <listitem><command>type</command>: the data type of the variable</listitem>
               <listitem><command>bounds</command>: limits of a variable value. The
                  meanining of bounds depends on the variable type. For an integer is the
                  maximum absolute value for that variable (for an unsigned the lower 
                  limit is invariably 0), for a string is the maximum length of the string. The
                  parameter bounds has no effect on an email data type
               </listitem>
               <listitem><command>constrain</command>: boolean value telling the variable has to be
               forced to fulfill the constrain imposed by <command>bounds</command>. This field
               is bidirectional in that it can be used by the validator to force the
               variable value rewriting</listitem>
               <listitem><command>validator</command>: name of the specialized validator for this variable</listitem>
               <listitem><command>default</command>: default value of the variable if not set in a response array. 
               When a variable is given a default value the form validation will not fail on the fact that
               this variable may be missing from the form response array</listitem>
               <listitem><command>quote</command>: the variable value has to be quoted when written back in
               the response array</listitem>
               <listitem><command>validator</command>: name of the validator procedure. The procedure
                  can be any Tcl procedure accepting as argument the name of a dictionary
                  holding the variable	internal representation. 
               </listitem>
            </itemizedlist>
            <para>
               An example of a form accepting four variable, one for each native type of a form broker object
            </para>
            <programlisting> % set fbroker [::FormBroker create {var1 integer} {var2 unsigned} {var3 string} {var4 integer bounds {-10 100}}]
::FormBroker::form0</programlisting>
        </refsect1>
        <refsect1>
            <title>Form broker object methods</title>
            <para>
               The central method of a form broker object is <command>validate</command> 
            </para>
            <variablelist>
				
               <varlistentry>
                  <listitem>
                     <cmdsynopsis>
                        <arg choice="plain"><replaceable>formBroker_object</replaceable></arg>
                        <arg choice="plain">validate</arg>
                        <arg><option>-forcequote</option></arg>
                        <arg choice="plain">response</arg>
                        <arg><replaceable>response copy</replaceable></arg>
                     </cmdsynopsis>
                     <para>
                        The method <command>validate</command> takes as argument the name of an array of variables
                        in the way this is produced by command <xref linkend="load_response">::rivet::load_response</xref>
                        returning a form response. The optional argument <replaceable>-forcequote</replaceable> causes the
                        variable values to be rewritten and quoted. If the optional argument <replaceable>response copy</replaceable>
                        is present the validated response is copied in this array instead of the input <arg choice="plain">response</arg>
                        array.
                     </para>
                     <para>
                        If the form data have been validated the method <command>validate</command> returns <emphasis>true</emphasis>
                     </para>
                     <para>
                        Example of form data validation (assuming ::rivet::load_response is loading the array <emphasis>response</emphasis>
                        with data taken from a form non displayed here)
                     </para>
                     <programlisting>% package require formbroker
% set fbroker [::FormBroker create {var1 integer} {var2 unsigned} {var3 string} {var4 integer bounds {-10 100}}]
::FormBroker::form0

% ::rivet::load_response
% parray response
response(var1) = -10
response(var2) = 20
response(var3) = a string
response(var4) = 50

# let's keep a copy of the response

% array set response_copy [array get response]

# form data validation

% $fbroker validate response
true
% $fbroker validate -forcequote response
% parray response
response(var1) = '-10'
response(var2) = '20'
response(var3) = 'a string'
response(var4) = '50'

# restore response original value

% array set response [array get response_copy]
% $fbroker validate -forcequote response response_copy
true
% parray response
response(var1) = -10
response(var2) = 20
response(var3) = a string
response(var4) = 50
% parray response_copy 
response_copy(var1) = '-10'
response_copy(var2) = '20'
response_copy(var3) = 'a string'
response_copy(var4) = '50'

# a form object has to be destroyed if it's not needed anymore

% $fbroker destroy</programlisting>
                  </listitem>
               </varlistentry>
               <varlistentry>
                  <listitem>
                     <cmdsynopsis>
                        <arg choice="plain"><replaceable>formBroker_object</replaceable></arg>
                        <arg choice="plain">failing</arg>
                     </cmdsynopsis>
                     <para>
                        In case the validation fails method <command>failing</command> returns a list
                        of <emphasis>variable_name - error_condition</emphasis> pairs for each 
                        variable whose value failed to validate and was impossible to fix. This list
                        is suitable to populate an array or used directly as a dictionary
                     </para>
<programlisting>% package require formbroker
1.0
% set fbroker [::FormBroker create {var1 integer} \
         {var2 unsigned} \
         {var3 string} \
         {var4 integer}]
::FormBroker::form0
% ::rivet::load_response

# let's suppose we have an incomplete response
% parray response
response(var1) = '100'
response(var2) = '20'
response(var3) = 'a string'
% $fbroker validate response
false
$fbroker failing
var4 MISSING_VAR

# this can be prevented by assigning a variable a default value

% set fbroker [::FormBroker create {var1 integer} \
                                   {var2 unsigned} \
                                   {var3 string} \
                                   {var4 integer default 0}]						
::FormBroker::form1
% $fbroker validate response
true
% parray response
response(var1) = 100
response(var2) = 20
response(var3) = a string
response(var4) = 0

% set fbroker [::FormBroker create {var1 integer} \
                                   {var2 unsigned} \
                                   {var3 string length 10 constrain} \
                                   {var4 integer bounds {-10 100}}]
::FormBroker::form2
% ::rivet::load_response

# this time the response has invalid data

% parray response
response(var1) = 'aaaaa'
response(var2) = '-20'
response(var3) = 'a longer string that breaks the 10 chars max limit imposed'
response(var4) = '150'
% $fbroker validate response
false
% $fbroker failing
var1 NOT_INTEGER var2 FB_OUT_OF_BOUNDS var4 FB_OUT_OF_BOUNDS</programlisting>
                     <para>
                        Notice that even though $response(var3) exceeds the 10 characters max length imposed to variable <emphasis>var3</emphasis>
                        this variable is not in the list returned by <command>failing</command> because
                        the 'constrain' attribute forced the truncation of the string. 
                        In fact this applies also to the integer and unsigned values 
                     </para>
<programlisting>% package require formbroker
% set fbroker [::FormBroker create {var1 integer bounds 10 constrain} \
                                   {var2 unsigned constrain} \
                                   {var3 string length 10 constrain} \
                                   {var4 integer bounds {-10 100} constrain}]
::FormBroker::form0
% ::rivet::load_response
% parray response
response(var1) = abcdef
response(var2) = -20
response(var3) = a longer string that breaks the 10 chars max limit imposed
response(var4) = 150
% $fbroker validate response response_copy
false
% $fbroker failing
var1 NOT_INTEGER
% parray response_copy 
response_copy(var2) = 0
response_copy(var3) = a longer s
response_copy(var4) = 100</programlisting>
                  <para>
                     The variable <emphasis>var1</emphasis> could not be constrained because the input
                     value "abcdef" is fundamentally incompatible
                  </para>
                  </listitem>
               </varlistentry>
               <varlistentry>
                  <listitem>
                     <cmdsynopsis>
                        <arg choice="plain"><replaceable>formBroker_object</replaceable></arg>
                        <arg choice="plain">response</arg>
                        <arg><option>response_array_name</option></arg>
                     </cmdsynopsis>
                     <para>
                        The <command>response</command> method fills 
                        the array whose name is passed as optional argument
                        with the last response processing. If this argument is omitted
                        the method creates an array named <emphasis>response</emphasis>.
                     </para>
                     <para>
                        This method can be called also if no form response validation has taken place: it
                        simply populates the array with the default values assigned to the form variables. As
                        such is a way to create form default arrays to initialize forms created with
                        the <xref linkend="form_package">form</xref> package.
                     </para>
<programlisting>
set fbroker [::FormBroker create {var1 integer default 0} \
                                 {var2 unsigned default 1} \
                                 {var3 string} \
                                 {var4 integer default 0}]
% $fbroker response a
% parray a
a(var1) = 0
a(var2) = 1
a(var4) = 0</programlisting>
                  </listitem>
               </varlistentry>
               <varlistentry>
                  <listitem>
                     <cmdsynopsis>
                        <arg choice="plain"><replaceable>formBroker_object</replaceable></arg>
                        <arg choice="plain">reset</arg>
                     </cmdsynopsis>
                     <para>
                     	The method resets the object to its initial defaults
                     </para>
                  </listitem>
               </varlistentry>

            </variablelist>
        </refsect1>
        <refsect1>
        		<title>Validator Error codes</title>
        		<para>
        			Variable type validators returned specific code
        			<itemizedlist>
        				<listitem><emphasis>string</emphasis>:
        					<itemizedlist>
        						<listitem><emphasis>FB_EMPTY_STRING</emphasis> if
        						the variable descriptor has the 'nonempty' flag set and the
        						trimmed string is empty</listitem>
        						<listitem><emphasis>FB_STRING_TOO_LONG</emphasis> if the string
        						length exceeds the max string length set with the maxlength option.
        						This error is not returned if maxlength was not set</listitem>
        					</itemizedlist>
        				</listitem>
        				<listitem><emphasis>integer</emphasis>:
        					<itemizedlist>
        						<listitem><emphasis>FB_OUT_OF_BOUNDS</emphasis> if
        						bounds were assigned to the variable but it's value lies outside of them.
        						This error is not returned if bounds were not set or the
        						variable was defined with the flag <emphasis>constrain</emphasis>
        						which forces its value to be the closest boundary value</listitem>
        					</itemizedlist>
        				</listitem>
        				<listitem>
        					<emphasis>unsigned</emphasis>:
       					<itemizedlist>
        						<listitem><emphasis>FB_OUT_OF_BOUNDS</emphasis> the variable
        						value is either negative or outside the bounds assigned to the
        						variable descriptor. The error is not returned if the
        						variable was defined with the flag <emphasis>constrain</emphasis>
        						which forces its value to be the closest boundary value</listitem>
        						or set to zero if the value was negative
        					</itemizedlist>
						</listitem>	
        				<listitem>
        					<emphasis>email</emphasis>:
       					<itemizedlist>
        						<listitem><emphasis>FB_INVALID_EMAIL</emphasis> the variable is
        						an invalid email address representation</listitem>
        					</itemizedlist>
						</listitem>	
        			</itemizedlist>
        		</para>
        </refsect1>
        <refsect1>
            <title>Writing a custom variable validator</title>
            <para>
            	The form broker is by no means restricted to work only with its native
            	data types: you may define your own form variable types and have
            	them validated with their own variable validator. 
            </para>
            <para>
            	A validator is a function accepting a dictionary as single argument and
            	must return either FB_OK, if the variable value is valid, 
            	or any other used defined error code. The dictionary argument stores
            	the variable descriptor used internally by the form broker. 
				</para>
				<para>
            	Suppose you're writing a form text entry that demands as input a network 
            	interface MAC address. 
            	A MAC address is represented by 6 hexadecimal octets separated by 
            	either a <quote>-</quote> (Windows convention) or <quote>:</quote> 
            	(Unix, Mac convention). The procedure <command>validate_mac</command>
            	checks the validity of the mac address and if validation is successful it
            	transforms its representation into the Unix form. 
            	By setting the key <quote>constrain</quote>
            	in the dictionary <emphasis>mac_address_d</emphasis> the procedure
            	is telling the form broker to copy the transformed value back
            	in the input response array
            </para>
<programlisting>proc validate_mac {_mac_address_d} {
    upvar $_mac_address_d mac_address_d

    dict with mac_address_d {
		  
        set var [string trim $var]
        if {[regexp {^[[:xdigit:]]{2}([:-][[:xdigit:]]{2}){5}$} $var]} {

            set var [string tolower $var]

            # we normalize the mac address to the Unix form.
            # The dash '-' characters in the windows representation 
            # are replaced by columns ':'

            set var [regsub -all -- {-} $var :]

            # the 'constrain' field is bidirectional:
            # it tells the validator to curb/change the value
            # within bonds/forms/representation. By setting it the
            # validator tells the FormBroker to copy the value
            # back in the response array

            set constrain 1
            return FB_OK

         } else {

            return FB_WRONG_MAC

         }

    }

}
% set fbroker [::FormBroker create {mac mac_address validator validate_mac}]
% ::rivet::load_response r
% parray r
r(mac) = 00-A1-B2-C3-D4-C5
% $fbroker validate r
true
% parray r
r(mac) = 00:a1:b2:c3:d4:c5</programlisting>
 			</refsect1>
      </refentry>
</section>
   
