+ ns_section ns/server/$server/acs {
+ ns_param CSPEnabledP 1
+ ns_param PasswordHashAlgorithm "argon2-12288-3-1 scram-sha-256 salted-sha1"
+ }
+ ns_section ns/server/$server/acs/acs-templating {
+ ns_param UseHtmlAreaForRichtextP 2
+ }
+ ns_section ns/server/$server/acs/xowiki {
+ ns_param MenuBar 1
+ }
+
+ Note that kernel parameters have no package key included in the
+ section name of the configuration file (see above).
@param name The name of the parameter.
+ @param package_key package key of the package from
+ which the parameter value is to be retrieved. When the
+ package_key is omitted, the kernel parameters are assumed
@return The parameter of the object or if it doesn't exist, the default.
} {
@@ -440,56 +443,232 @@
return [ns_config "ns/server/[ns_info server]/acs/$package_key" $name]
}
+ad_proc -public -deprecated ad_parameter_from_file {
+ name
+ {package_key ""}
+} {
+ Old version of ad_parameter_from_configuration_file
-ad_proc -private ad_parameter_cache {
- -set
- -delete:boolean
- -global:boolean
- key
- parameter_name
+ @see ad_parameter_from_configuration_file
} {
+ return [ad_parameter_from_configuration_file $name $package_key]
+}
- Manages the cache for ad_parameter.
- @param set Use this flag to indicate a value to set in the cache.
- @param delete Delete the value from the cache
- @param global If true, global param, false, instance param
- @param key Specifies the key for the cache'd parameter, either the package instance
- id (instance parameter) or package key (global parameter).
- @param parameter_name Specifies the parameter name that is being cached.
- @return The cached value.
-} {
- if {$delete_p} {
- if {[nsv_exists ad_param_$key $parameter_name]} {
- nsv_unset ad_param_$key $parameter_name
+
+#
+# There are three implementation of "ad_parameter_cache":
+# 1) for cachingmode none
+# 2) via "nsv_dict" (cluster aware)
+# 3) via "nsv" (not cluster aware)
+
+if {[ns_config "ns/parameters" cachingmode "per-node"] eq "none"} {
+ #
+ # If caching mode is "none", the "ad_parameter_cache" is
+ # essentially a no-op stub, but it is used for interface
+ # compatibility.
+ #
+ # TODO: One should essentially define more more cachetype for
+ # nsv_caching in acs-cache-procs to reduce redundancy and for
+ # providing higher orthogonality.
+ #
+ ad_proc -public ad_parameter_cache {
+ -set
+ -delete:boolean
+ -global:boolean
+ key
+ parameter_name
+ } {
+
+ Stub for a parameter cache, since "cachingmode" is "none".
+
+ @param set Use this flag to indicate a value to set in the cache.
+ @param delete Delete the value from the cache
+ @param global If true, global param, false, instance param
+ @param key Specifies the key for the cache'd parameter, either the package instance
+ id (instance parameter) or package key (global parameter).
+ @param parameter_name Specifies the parameter name that is being cached.
+ @return The cached value.
+
+ } {
+ if {$delete_p} {
+ return
}
- return
+ if {[info exists set]} {
+ return $set
+ } elseif { $global_p } {
+ set value [db_string select_global_parameter_value {
+ select apm_parameter_values.attr_value
+ from apm_parameters, apm_parameter_values
+ where apm_parameter_values.package_id is null
+ and apm_parameter_values.parameter_id = apm_parameters.parameter_id
+ and apm_parameters.parameter_name = :parameter_name
+ and apm_parameters.package_key = :key
+ } -default ""]
+ } else {
+ set value [db_string select_instance_parameter_value {
+ select apm_parameter_values.attr_value
+ from apm_parameters, apm_parameter_values
+ where apm_parameter_values.package_id = :key
+ and apm_parameter_values.parameter_id = apm_parameters.parameter_id
+ and apm_parameters.parameter_name = :parameter_name
+ } -default ""]
+ }
+ return $value
}
- if {[info exists set]} {
- nsv_set "ad_param_${key}" $parameter_name $set
- return $set
- } elseif { [nsv_exists ad_param_$key $parameter_name] } {
- return [nsv_get ad_param_$key $parameter_name]
- } elseif { $global_p } {
- set value [db_string select_global_parameter_value {
- select apm_parameter_values.attr_value
- from apm_parameters, apm_parameter_values
- where apm_parameter_values.package_id is null
- and apm_parameter_values.parameter_id = apm_parameters.parameter_id
- and apm_parameters.parameter_name = :parameter_name
- and apm_parameters.package_key = :key
- } -default ""]
- } else {
- set value [db_string select_instance_parameter_value {
- select apm_parameter_values.attr_value
- from apm_parameters, apm_parameter_values
- where apm_parameter_values.package_id = :key
- and apm_parameter_values.parameter_id = apm_parameters.parameter_id
- and apm_parameters.parameter_name = :parameter_name
- } -default ""]
+
+} elseif {[::acs::icanuse "nsv_dict"]} {
+
+ if {![nsv_array exists ad_param]} {
+ nsv_set ad_param . .
}
- nsv_set "ad_param_${key}" $parameter_name $value
- return $value
+
+ ad_proc -private ad_parameter_cache_flush_dict {
+ key
+ parameter_name
+ } {
+ Flush a single value from the nsv cache.
+
+ This proc is necessary in cases, where a node writes a new
+ parameter value before it has read the old one.
+
+ Since a plain "nsv_dict unset ad_param $key $parameter_name"
+ raises an exception, when the pair does not exist, and we do
+ not want to allow in cluster requests arbitrary "catch"
+ commands, we allow "ad_parameter_cache_flush_dict" instead.
+ Probably, the best solution is to add support for
+
+ nsv_dict unset -nocomplain -- ad_param $key $parameter_nam
+
+ The existing nsv_dict was built after Tcl's "dict unset",
+ which does not have the "-nocomplain" option either. However,
+ an atomic operation would certainly be preferable over an exists/unset
+ pair, which is no acceptable solution.
+
+ } {
+ catch {nsv_dict unset ad_param $key $parameter_name}
+ }
+
+
+ ad_proc -public ad_parameter_cache {
+ -set
+ -delete:boolean
+ -global:boolean
+ key
+ parameter_name
+ } {
+
+ Manages the cache for ad_parameter.
+ @param set Use this flag to indicate a value to set in the cache.
+ @param delete Delete the value from the cache
+ @param global If true, global param, false, instance param
+ @param key Specifies the key for the cache'd parameter, either the package instance
+ id (instance parameter) or package key (global parameter).
+ @param parameter_name Specifies the parameter name that is being cached.
+ @return The cached value.
+
+ } {
+ if {$delete_p} {
+ acs::clusterwide ad_parameter_cache_flush_dict $key $parameter_name
+ acs::per_request_cache flush -pattern acs-tcl.ad_param-$key
+ return
+ }
+ if {[info exists set]} {
+ nsv_dict set ad_param $key $parameter_name $set
+ acs::per_request_cache flush -pattern acs-tcl.ad_param-$key
+ return $set
+ }
+ #
+ # Keep the parameter dict in a per-request cache to reduce
+ # potentially high number of nsv locks, when parameters of a
+ # package are queried a high number of times per request
+ # (without this we see on some sites > 100 locks on this nsv
+ # per request).
+ #
+ set dict [acs::per_request_cache eval -no_cache "" -key acs-tcl.ad_param-$key {
+ if {[nsv_get ad_param $key result]} {
+ #ns_log notice "ad_parameter_cache $key $parameter_name not cached"
+ set result
+ } else {
+ set result ""
+ }
+ }]
+ if {[dict exists $dict $parameter_name]} {
+ #ns_log notice "ad_parameter_cache $key $parameter_name get from dict"
+ return [dict get $dict $parameter_name]
+ }
+ if { $global_p } {
+ set value [db_string select_global_parameter_value {
+ select apm_parameter_values.attr_value
+ from apm_parameters, apm_parameter_values
+ where apm_parameter_values.package_id is null
+ and apm_parameter_values.parameter_id = apm_parameters.parameter_id
+ and apm_parameters.parameter_name = :parameter_name
+ and apm_parameters.package_key = :key
+ } -default ""]
+ } else {
+ set value [db_string select_instance_parameter_value {
+ select apm_parameter_values.attr_value
+ from apm_parameters, apm_parameter_values
+ where apm_parameter_values.package_id = :key
+ and apm_parameter_values.parameter_id = apm_parameters.parameter_id
+ and apm_parameters.parameter_name = :parameter_name
+ } -default ""]
+ }
+ nsv_dict set ad_param $key $parameter_name $value
+ return $value
+ }
+} else {
+ ad_proc -public ad_parameter_cache {
+ -set
+ -delete:boolean
+ -global:boolean
+ key
+ parameter_name
+ } {
+
+ Manages the cache for ad_parameter.
+ @param set Use this flag to indicate a value to set in the cache.
+ @param delete Delete the value from the cache
+ @param global If true, global param, false, instance param
+ @param key Specifies the key for the cache'd parameter, either the package instance
+ id (instance parameter) or package key (global parameter).
+ @param parameter_name Specifies the parameter name that is being cached.
+ @return The cached value.
+
+ } {
+ if {$delete_p} {
+ if {[nsv_exists ad_param_$key $parameter_name]} {
+ nsv_unset ad_param_$key $parameter_name
+ }
+ return
+ }
+ if {[info exists set]} {
+ nsv_set "ad_param_${key}" $parameter_name $set
+ return $set
+ } elseif { [nsv_exists ad_param_$key $parameter_name] } {
+ return [nsv_get ad_param_$key $parameter_name]
+ } elseif { $global_p } {
+ set value [db_string select_global_parameter_value {
+ select apm_parameter_values.attr_value
+ from apm_parameters, apm_parameter_values
+ where apm_parameter_values.package_id is null
+ and apm_parameter_values.parameter_id = apm_parameters.parameter_id
+ and apm_parameters.parameter_name = :parameter_name
+ and apm_parameters.package_key = :key
+ } -default ""]
+ } else {
+ set value [db_string select_instance_parameter_value {
+ select apm_parameter_values.attr_value
+ from apm_parameters, apm_parameter_values
+ where apm_parameter_values.package_id = :key
+ and apm_parameter_values.parameter_id = apm_parameters.parameter_id
+ and apm_parameters.parameter_name = :parameter_name
+ } -default ""]
+ }
+ nsv_set "ad_param_${key}" $parameter_name $value
+ return $value
+ }
}
ad_proc -private ad_parameter_cache_all {} {
@@ -505,16 +684,22 @@
}
}
-# returns particular parameter values as a Tcl list (i.e., it selects
-# out those with a certain key)
-
-ad_proc -public ad_parameter_all_values_as_list {
+ad_proc -deprecated ad_parameter_all_values_as_list {
{-package_id ""}
name {subsection ""}
} {
Returns multiple values for a parameter as a list.
+ DEPRECATED: this proc does not do much that joining a string
+ coming from a parameter, which does not make an invalid string
+ into a list. Best to take the value from the parameter directly
+ and rely on proper quoting by the user. Furthermore, the
+ 'subsection' argument is not used anywhere.
+
+ @see parameter::get
+ @see join
+
} {
return [join [parameter::get -package_id $package_id -parameter $name ] " "]
}
@@ -535,20 +720,22 @@
ad_proc -public ad_return_url {
-urlencode:boolean
+ {-path_encode:boolean true}
-qualified:boolean
{-default_url .}
{extra_args ""}
} {
Build a return url suitable for passing to a page you expect to return back
- to the current page.
+ to the current page. Per default, the result is URL-encoded
+ (like the result of "export_vars" or ":pretty_link").
Example for direct inclusion in a link:
- ad_returnredirect "foo?return_url=[ad_return_url -url_encode]"
+ ad_returnredirect "foo?return_url=[ad_return_url]"
Example setting a variable to be used by export_vars:
@@ -561,40 +748,53 @@
Example setting a variable with extra_vars:
- set return_url [ad_return_url [list some_id $some_id] [some_other_id $some_other_id]]
+ set return_url [ad_return_url [list [list some_id $some_id] [list some_other_id $some_other_id]]]
@author Don Baccus (dhogaza@pacifier.com)
- @param urlencode If true URL-encode the result
+ @param path_encode If false do no URL-encode the result
@param default_url When there is no connection, fall back to this URL
@param qualified If provided the return URL will be fully qualified including http or https.
@param extra_args A list of {name value} lists to append to the query string
} {
+ if { $urlencode_p } {
+ ns_log warning "deprecated flag -urlencode; result is encoded per default"
+ }
+
if {[ns_conn isconnected]} {
- set query_list [export_entire_form_as_url_vars]
- if { [llength $query_list] == 0 } {
- set url [ns_conn url]
- } else {
- set url "[ns_conn url]?[join $query_list &]"
- }
- if { $qualified_p } {
- # Make the return_url fully qualified
- set url [security::get_qualified_url $url]
- }
+ set query_list [export_vars -entire_form]
+ set base_url [ns_conn url]
} else {
set query_list ""
- set url $default_url
+ set base_url $default_url
}
- foreach {extra_arg} $extra_args {
- lappend query_list [join $extra_arg "="]
+
+ if { $path_encode_p } {
+ set base_url [ns_urlencode $base_url]
}
- if { $urlencode_p } {
- set url [ns_urlencode $url]
+ if { [llength $query_list] == 0 } {
+ set url $base_url
+ } else {
+ set url "${base_url}?[join $query_list &]"
}
+
+ if {[llength $extra_args] > 0} {
+ #
+ # Deactivate base encode, since the input URL is already
+ # encoded as requested.
+ #
+ set url [export_vars -base $url -no_base_encode $extra_args]
+ }
+
+ if { $qualified_p } {
+ # Make the return_url fully qualified
+ set url [security::get_qualified_url $url]
+ }
+
return $url
}
@@ -624,7 +824,7 @@
db_release_unused_handles
ad_http_cache_control
- ReturnHeaders
+ util_return_headers
ns_write [ad_parse_template \
-params [list \
[list doc(title) $title] \
@@ -643,7 +843,7 @@
@see ad_progress_bar_begin
} {
util_user_message -message $message_after_redirect
- ns_write ""
+ ns_write ""
ns_conn close
}