Overview

Module z_context

• Description
• Function Index
• Function Details

Copyright © 2009-2021 Marc Worrell

Authors: Marc Worrell (marc@worrell.nl).

Description

Function Index

Function Details

abs_url/2

Make the url an absolute url by prepending the hostname.

add_q/2

Add the value of multiple request parameter arguments

add_q/3

Add the value of a request parameter argument Always filter the #upload{} arguments to prevent upload of non-temp files.

client_id/1

Return the current client id (if any)

client_topic/1

Return the current client bridge topic (if any)

cookie_domain/1

Fetch the cookie domain, defaults to 'undefined' which will equal the domain to the domain of the current request.

db_driver/1

Fetch the database driver module for this site

db_pool/1

Fetch the pid of the database worker pool for this site

depickle/1

Depickle a context for restoring from a database

depickle_site/1

Depickle a context, return the site name.

ensure_qs/1

Ensure that we have parsed the query string, fetch body if necessary. If this is a POST then the session/page-session might be continued after this call.

fallback_language/1

Return the first fallback language of the Context

get/2

Fetch the value of the context variable Key, return undefined when Key is not found.

get/3

Fetch the value of the context variable Key, return Default when Key is not found.

get_all/1

Return a proplist with all context variables.

get_controller_module/1

Get the resource module handling the request.

get_cookie/2

Read a cookie value from the current request.

get_cookies/2

Read all cookie values with a certain key from the current request.

get_envdata/1

Return the cowmachine request data of the context

get_q/2

Get a request parameter, either from the query string or the post body. Post body has precedence over the query string. Note that this can also be populated from a JSON MQTT call, and as such contain arbitrary data.

get_q/3

Get a request parameter, either from the query string or the post body. Post body has precedence over the query string.

get_q_all/1

Get all parameters.

get_q_all/2

Get the all the parameters with the same name, returns the empty list when non found.

get_q_all_noz/1

Get all query/post args, filter the zotonic internal args.

get_q_validated/2

Fetch a query parameter and perform the validation connected to the parameter. An exception {not_validated, Key} is thrown when there was no validator, when the validator is invalid or when the validation failed.

get_qargs/1

Fetch all arguments starting with a 'q'. This is used for queries.

get_render_state/1

get_req_header/2

Get a request header. The header MUST be in lower case.

get_req_path/1

Return the request path

get_reqdata/1

Return the cowmachine request data of the context

get_resp_header/2

Get a response header

get_state_cookie/1

Get the state cookie and decode it.

hostname/1

Return the preferred hostname from the site configuration

hostname_port/1

Return the hostname (and port) for http from the site configuration

hostname_ssl_port/1

Return the hostname (and port) for https from the site configuration

init_cowdata/3

Set the cowmachine request data of the context

is_request/1

Check if the current context is a request context

is_session/1

Check if the current context has an active MQTT session. This is never true for the first request.

is_ssl_site/1

Check if the preferred protocol of the site is https (always true)

is_zotonic_arg/1

lager_md/1

lager_md/2

language/1

Return the selected language of the Context

new/1

Return a new empty context, no request is initialized.

new/2

Create a new context record for a site with a certain language

new/3

new_tests/0

Create a new context used when testing parts of zotonic

output/2

pickle/1

Pickle a context for storing in the database

prune_for_async/1

Make the context safe to use in a async message. This removes render_state and the db transaction.

prune_for_database/1

Cleanup a context so that it can be used exclusively for database connections

prune_for_scomp/1

Cleanup a context for cacheable scomp handling. Resets most the render_state to prevent duplicating between different (cached) renderings.

prune_for_spawn/1

Minimal prune, for ensuring that the context can safely used in two processes

q_upload_keepalive/2

Keep the tempfiles alive by attaching the current process to its monitors

reset_state_cookie/1

Delete the state cookie.

session_id/1

Return the unique random session id for the current client auth. This session_id is re-assigned when the authentication of a client changes.

set/2

Set the value of the context variables to all {Key, Value} properties.

set/3

Set the value of the context variable Key to Value

set_client_context/2

Merge a context with client information into a request context. This is used to merge a client context obtained from a MQTT ticket into the contex of an out of band MQTT post.

set_controller_module/2

set_cookie/3

Set a cookie value with default options.

set_cookie/4

Set a cookie value with cookie options.

set_cors_headers/2

Set Cross-Origin Resource Sharing (CORS) headers. The caller must specify default headers to be used in case there are no observers for the #cors_headers{} notification.

set_envdata/2

Set the cowmachine request data of the context

set_language/2

Set the language of the context, either an atom (language) or a list (language and fallback languages)

set_nocache_headers/1

Some user agents have too aggressive client side caching. These headers prevent the caching of content on the user agent iff the content generated has a session. You can prevent addition of these headers by not calling z_context:ensure_session/1, or z_context:ensure_all/1.

set_noindex_header/1

Set the noindex header if the config is set, or the webmachine resource opt is set.

set_noindex_header/2

Set the noindex header if the config is set, the webmachine resource opt is set or Force is set.

set_q/2

Set the value of multiple request parameter arguments

set_q/3

Set the value of a request parameter argument Always filter the #upload{} arguments to prevent upload of non-temp files.

set_q_all/2

Replace all parameters.

set_render_state/2

set_req_metrics/2

Add metrics data to the Cowboy request, will be added to the metrics notifications.

set_reqdata/2

Set the cowmachine request data of the context

set_resp_header/3

Set a response header for the request in the context.

set_resp_headers/2

Set multiple response headers for the request in the context.

set_security_headers/1

Set security related headers. This can be modified by observing the 'security_headers' notification.

set_session_id/2

Set the cotonic session id. Mostly used when on a request with a cotonic session id in the cookie.

set_state_cookie/2

Set a cookie on the user-agent, holding secret information. The state cookie is used during OAuth key exchanges, against csrf attacks.

set_tz/2

Set the timezone of the context.

site/1

Maps the site in the request to a site in the sites folder.

site_protocol/1

Fetch the protocol for absolute urls referring to the site (always https).

state_cookie_secret/1

Return the secret used to encode the state cookie.

tz/1

Return the selected timezone of the Context; defaults to the site's timezone

tz_config/1

Return the site's configured timezone.

Overview

Generated by EDoc