OpenXPKI::Client::UI::Result(3)

send_command

Expects the name of the command as first and the parameter hash as second argument. Sends the named command to the backend and returned the result. If the command does not succeed, set_status_from_error_reply is called and undef is returned. In case the command was a workflow action and the backend reports a validation error, the error from the validator is set as status.

If you set a true value for the third parameter, the global status is not set if an error occurs.

send_command_v2

Copy of send_command but uses the API2 methods.

param

Returns a single input parameter, i.e. real CGI parameters and those appended to the action name using "!". Parameters from the action name have precedence.

If the input parameter has got multiple values then only the first value is returned.

Parameters

•: Str $key - parameter name to retrieve: a plain parameter name or a stringified hash (e.g. "key_param{curve_name}").
Please note that passing an ArrayRef is no longer supported - please use "param_from_fields" instead. Passing "undef"is also no longer supported.

logger

Return the class logger (log4perl ref)

render

Assemble the return hash from the internal caches and send the result to the browser.

init_fetch

Method to send the result persisted with __persist_response

_escape ( string )

Replace html entities in string by their encoding

__register_wf_token( wf_info, token )

Generates a new random id and stores the passed workflow info, expects a wf_info and the token info to store as parameter, returns a hashref with the definiton of a hidden field which can be directly pushed onto the field list. wf_info can be undef / empty string.

__register_wf_token_initial ( wf_type, token )

Create a token to init a new workflow, expects the name of the workflow as string and an optional hash to pass as initial parameters to the create method. Returns the full action target as string.

__fetch_wf_token( wf_token, purge )

Return the hashref stored by __register_wf_token for the given token id. If purge is set to a true value, the info is purged from the session context.

__purge_wf_token( wf_token )

Purge the token info from the session.

__persist_response

Persist the current response to retrieve it after a http roundtrip Used to break out of the JS app for downloads or reroute result pages

__fetch_response

Get the data for the persisted response.

__generate_uid

Generate a random uid (base64 encoded with dangerours chars removed)

__render_pager

Return a pager definition hash with default settings, requires the query result hash as argument. Defaults can be overriden passing a hash as second argument.

__temp_param

Get or set a temporary session parameter, the value is auto-destroyed after it was not being used for a given time period, default is 15 minutes.

__build_attribute_subquery

Expects an attribtue query definition hash (from uicontrol), returns arrayref to be used as attribute subquery in certificate and workflow search.

__build_attribute_preset

Expects an attribtue query definition hash (from uicontrol), returns arrayref to be used as preset when reloading the search form

transate_sql_wildcards

Replace "literal" wildcards asterisk and question mark by percent and underscore for SQL queries.

decrypted_param

Return a decrypted JWT input parameter (whose only allowed type is HashRef).

"undef" is returned if the parameter does not exist or if it was not encrypted.

Parameters

•: Str $key - parameter name to retrieve.

make_autocomplete_query

Create the autocomplete config for a UI text field from the given workflow field configuration $wf_field.

Also returns an additional hidden, to-be-encrypted UI field definition.

Text input fields with autocompletion are configured as follows:

    type: text
    autocomplete:
        action: certificate!autocomplete
        params:
            user:
                param_1: field_name_1
                param_2: field_name_1
            persist:
                query:
                    status: { "-like": "%done" }

Parameters below "user" are filled from the referenced form fields.

Parameters below "persist" may contain data structures (HashRefs, ArrayRefs) as they are backend-encrypted and sent to the client as a JWT token. They can be considered safe from user manipulation.

Parameters

•: HashRef $wf_field - workflow field config

fetch_autocomplete_params

Uses the "__encrypted" request parameter to re-assemble the full hash of autocomplete parameters by decoding the encrypted static values and querying the whitelisted dynamic values.

Parameters

•: HashRef $input_field - input field definition

Returns a HashRef of query parameters