Index: openacs-4/packages/acs-tcl/tcl/acs-permissions-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-tcl/tcl/acs-permissions-procs.tcl,v diff -u -N -r1.9 -r1.10 --- openacs-4/packages/acs-tcl/tcl/acs-permissions-procs.tcl 10 Sep 2002 22:22:14 -0000 1.9 +++ openacs-4/packages/acs-tcl/tcl/acs-permissions-procs.tcl 15 Sep 2002 22:10:50 -0000 1.10 @@ -114,7 +114,9 @@ } { Grant a permission - @author ben@openforce + @author ben@openforce.net + + @see permission::grant } { permission::grant -party_id $user_id -object_id $object_id -privilege $privilege } @@ -126,7 +128,9 @@ } { Revoke a permission - @author ben@openforce + @author ben@openforce.net + + @see permission::revoke } { permission::revoke -party_id $user_id -object_id $object_id -privilege $privilege } @@ -135,6 +139,8 @@ {-user_id ""} object_id privilege +} { + @see permission::permission_p } { return [permission::permission_p -party_id $user_id -object_id $object_id -privilege $privilege] } @@ -143,6 +149,8 @@ object_id privilege } { + @see permission::require_permission +} { permission::require_permission -object_id $object_id -privilege $privilege } Index: openacs-4/packages/acs-tcl/tcl/defs-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-tcl/tcl/defs-procs.tcl,v diff -u -N -r1.16 -r1.17 --- openacs-4/packages/acs-tcl/tcl/defs-procs.tcl 13 Sep 2002 20:10:48 -0000 1.16 +++ openacs-4/packages/acs-tcl/tcl/defs-procs.tcl 15 Sep 2002 22:10:50 -0000 1.17 @@ -167,14 +167,16 @@ user_id name } { - @return the HTML link of the community member page of a particular user - This function is an alias to acs_community_member_link and receives identical parameters, but the former finds out the name of the user if a blank is passed. That's why it's marked as deprecated. + @return the HTML link of the community member page of a particular user + @author Unknown @author Roberto Mello + + @see acs_community_member_link } { return [acs_community_member_link -user_id $user_id -label $name] } @@ -208,15 +210,16 @@ user_id name } { - @return the HTML link of the community member page of a particular admin user. - This function is an alias to acs_community_member_admin_link and receives identical parameters, but the former finds out the name of the user if a blank is passed. That's why it's marked as deprecated. + @return the HTML link of the community member page of a particular admin user. + @author Unknown @author Roberto Mello - + + @see acs_community_member_admin_link } { return [acs_community_member_admin_link -user_id $user_id -label $name] } Index: openacs-4/packages/acs-tcl/tcl/request-processor-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-tcl/tcl/request-processor-procs.tcl,v diff -u -N -r1.17 -r1.18 --- openacs-4/packages/acs-tcl/tcl/request-processor-procs.tcl 14 Sep 2002 12:20:43 -0000 1.17 +++ openacs-4/packages/acs-tcl/tcl/request-processor-procs.tcl 15 Sep 2002 22:10:50 -0000 1.18 @@ -991,6 +991,7 @@ You probably want ad_acs_kernel_id, that is what has all the useful parameters. + @see ad_acs_kernel_id } { return [db_string acs_admin_id_get { select package_id from apm_packages Index: openacs-4/packages/acs-tcl/tcl/security-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-tcl/tcl/security-procs.tcl,v diff -u -N -r1.12 -r1.13 --- openacs-4/packages/acs-tcl/tcl/security-procs.tcl 13 Sep 2002 20:57:00 -0000 1.12 +++ openacs-4/packages/acs-tcl/tcl/security-procs.tcl 15 Sep 2002 22:10:50 -0000 1.13 @@ -476,21 +476,33 @@ } ad_proc -public -deprecated ad_get_user_id {} { - Gets the user ID. 0 indicates the user is not logged in + Gets the user ID. 0 indicates the user is not logged in. + + Deprecated since user_id now provided via ad_conn user_id + + @see ad_conn } { return [ad_conn user_id] } ad_proc -public -deprecated ad_verify_and_get_user_id { { -secure f } } { Returns the current user's ID. 0 indicates user is not logged in + + Deprecated since user_id now provided via ad_conn user_id + + @see ad_conn } { return [ad_conn user_id] } ad_proc -public -deprecated ad_verify_and_get_session_id { { -secure f } } { Returns the current session's ID. + Deprecated since session_id now provided via ad_conn session_id + @param secure is ignored + + @see ad_conn } { return [ad_conn session_id] } @@ -501,6 +513,8 @@ Pages that are consider whether to display a user's name or email address should test to make sure that a user's priv_ from the database is less than or equal to what ad_privacy_threshold returns. + + Now deprecated. } { set session_user_id [ad_get_user_id] if {$session_user_id == 0} { @@ -564,6 +578,9 @@ ad_script_abort } +# JCD 20020915 I think this probably should not be deprecated since it is +# far more reliable than permissioning esp for a development server + ad_proc -public -deprecated ad_restrict_entire_server_to_registered_users {conn args why} { A preauth filter that will halt service of any page if the user is unregistered, except the site index page and stuff underneath @@ -602,9 +619,10 @@ ad_proc -public -deprecated ad_block_sql_urls {conn args why} { A filter that detect attempts to smuggle in SQL code through form data - variables. The use of bind variables to prevent SQL smuggling is - preferred. + variables. The use of bind variables and ad_page_contract input + validation to prevent SQL smuggling is preferred. + @see ad_page_contract } { set form [ns_getform] if [empty_string_p $form] { return filter_ok } @@ -742,6 +760,7 @@ ad_page_contract is the preferred mechanism to do automated validation of form variables. + @see ad_page_contract } { ad_register_filter postauth GET $url_pattern ad_set_typed_form_variables $args ad_register_filter postauth POST $url_pattern ad_set_typed_form_variables $args Index: openacs-4/packages/acs-tcl/tcl/site-nodes-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-tcl/tcl/site-nodes-procs.tcl,v diff -u -N -r1.16 -r1.17 --- openacs-4/packages/acs-tcl/tcl/site-nodes-procs.tcl 14 Sep 2002 20:20:47 -0000 1.16 +++ openacs-4/packages/acs-tcl/tcl/site-nodes-procs.tcl 15 Sep 2002 22:10:50 -0000 1.17 @@ -271,6 +271,7 @@ name } { Create a new site node. Returns the node_id + @see site_node::new } { return [site_node::new \ @@ -401,6 +402,8 @@ Returns an array in the form of a list. This array contains url, node_id, directory_p, pattern_p, and object_id for the given url. If no node is found then this will throw an error. + + @see site_node::get } { return [site_node::get -url $url] } Index: openacs-4/packages/acs-tcl/tcl/text-html-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-tcl/tcl/text-html-procs.tcl,v diff -u -N -r1.8 -r1.9 --- openacs-4/packages/acs-tcl/tcl/text-html-procs.tcl 8 Sep 2002 17:58:58 -0000 1.8 +++ openacs-4/packages/acs-tcl/tcl/text-html-procs.tcl 15 Sep 2002 22:10:50 -0000 1.9 @@ -1317,7 +1317,9 @@ ad_proc -deprecated util_striphtml {html} { - Use ad_html_to_text instead. + Deprecated. Use ad_html_to_text instead. + + @see ad_html_to_text } { return [ad_html_to_text -- $html] } @@ -1338,6 +1340,7 @@ plaintext. We'd rather let the user change our opinion about the text, e.g. html_p = 't'. + @see ad_text_to_html } { if { [regexp -nocase {

} $raw_string] || [regexp -nocase {
} $raw_string] } { # user was already trying to do this as HTML @@ -1353,6 +1356,8 @@ href="/api-doc/proc-view?proc=ad_convert_to_html">ad_convert_to_html instead. + @see ad_convert_to_html + } { if { $html_p == "t" } { return $raw_string @@ -1364,20 +1369,26 @@ ad_proc -deprecated util_quotehtml { arg } { This proc does exactly the same as ad_quotehtml. Use that instead. This one will be deleted eventually. + + @see ad_quotehtml } { return [ad_quotehtml $arg] } ad_proc -deprecated util_quote_double_quotes {arg} { This proc does exactly the same as ad_quotehtml. Use that instead. This one will be deleted eventually. + + @see ad_quotehtml } { return [ad_quotehtml $arg] } ad_proc -deprecated philg_quote_double_quotes {arg} { This proc does exactly the same as ad_quotehtml. Use that instead. This one will be deleted eventually. + + @see ad_quotehtml } { return [ad_quotehtml $arg] } Index: openacs-4/packages/acs-tcl/tcl/utilities-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-tcl/tcl/utilities-procs.tcl,v diff -u -N -r1.15 -r1.16 --- openacs-4/packages/acs-tcl/tcl/utilities-procs.tcl 14 Sep 2002 12:01:01 -0000 1.15 +++ openacs-4/packages/acs-tcl/tcl/utilities-procs.tcl 15 Sep 2002 22:10:50 -0000 1.16 @@ -1076,6 +1076,8 @@ @author Lars Pind (lars@pinds.com) @creation-date 21 July 2000 + + @see export_vars } { #################### @@ -2894,7 +2896,9 @@ HTML tags marked as naughty in the antispam section of ad.ini, otherwise returns an empty string. +@see ad_html_security_check } { + set tag_names [list div font] # look for a less than sign, zero or more spaces, then the tag if { ! [empty_string_p $tag_names]} { Index: openacs-4/packages/acs-templating/tcl/parse-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/tcl/parse-procs.tcl,v diff -u -N -r1.5 -r1.6 --- openacs-4/packages/acs-templating/tcl/parse-procs.tcl 31 Aug 2002 02:01:41 -0000 1.5 +++ openacs-4/packages/acs-templating/tcl/parse-procs.tcl 15 Sep 2002 22:10:53 -0000 1.6 @@ -531,10 +531,14 @@ as the "group" tag within a "multiple" tag. Deprecated, use: - set tag [template::enclosing_tag ] - set attribute [template::tag_attribute tag ] - + 

+  set tag [template::enclosing_tag <tag-type>]
+  set attribute [template::tag_attribute tag <attribute>]
+
@param tag The name of the enclosing tag to look for. + + @see template::enclosing_tag + @see template::tag_attribute } { set name "" Index: openacs-4/packages/acs-templating/tcl/query-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/tcl/query-procs.tcl,v diff -u -N -r1.9 -r1.10 --- openacs-4/packages/acs-templating/tcl/query-procs.tcl 1 Sep 2002 19:09:28 -0000 1.9 +++ openacs-4/packages/acs-templating/tcl/query-procs.tcl 15 Sep 2002 22:10:53 -0000 1.10 @@ -532,6 +532,8 @@ @param body Code body to be execute for each result row of the returned query + + @see db_foreach } { db_with_handle db { Index: openacs-4/packages/general-comments/tcl/general-comments-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/general-comments/tcl/general-comments-procs.tcl,v diff -u -N -r1.3 -r1.4 --- openacs-4/packages/general-comments/tcl/general-comments-procs.tcl 31 Oct 2001 20:42:07 -0000 1.3 +++ openacs-4/packages/general-comments/tcl/general-comments-procs.tcl 15 Sep 2002 22:10:54 -0000 1.4 @@ -22,6 +22,7 @@ {return_url {}} } { Generates a line item list of comments for the object_id. + @param print_content_p Pass in 1 to print out content of comments. @param print_attachments_p Pass in 1 to print out attachments of comments, only works if print_content_p is 1. @@ -157,6 +158,7 @@ {return_url {}} } { Generates an html link to add a comment to an object. + @param object_id The object to comment on. @param return_url A url for the user to return to after viewing a comment. @param object_name The name of the object. @@ -202,8 +204,11 @@ ad_proc -deprecated get_comments {object_id return_url} { Generates a line item list of comments for the object_id. + @param object_id The object_id to retrieve the comments for. @param return_url A url for the user to return to after viewing a comment. + + @see general_comments_get_comments } { # get the package url @@ -245,6 +250,8 @@ @param return_url A url for the user to return to after viewing a comment. @param link_text The text to display for the link. @param category A category to associate comment to. + + @see general_comments_create_link } { # get the package url set package_url [db_string get_package_url_deprecated "