%3 ::nx::Object ::nx::Object ::acs::SiteNodesCache ::acs::SiteNodesCache flush_cache flush_pattern flush_per_request_cache get_children get_node_id get_package_url get_url get_urls_from_object_id has_children properties ::acs::SiteNodesCache->::nx::Object

Class ::acs::SiteNodesCache

::acs::SiteNodesCache[i] create ...
acs::SiteNodesCache is a mixin class implementing caching of SiteNode objects. Add/remove extra caching methods as when more operations should be cached. Removing the registry of the object mixin deactivates caching for these methods completely.
Defined in packages/acs-tcl/tcl/site-nodes-procs.tcl

Class Relations

  • class: ::nx::Class[i]
  • superclass: ::nx::Object[i]
  • mixinof: ::acs::site_node[i]
::nx::Class create ::acs::SiteNodesCache \
     -superclass ::nx::Object

Methods (to be applied on instances)

  • flush_cache (scripted, public)

     <instance of acs::SiteNodesCache[i]> flush_cache -node_id node_id  \
    [ -with_subtree on|off ] [ -url url ]

    Flush entries from site-node tree, including the current node, the root of flushed (sub)tree. If the node_id is not provided, or it is the node_id of root of the full site-node tree, flush the whole tree.

    Switches:
    -node_id (required)
    -with_subtree (optional, boolean, defaults to "true")
    -url (optional)

    Testcases:
    No testcase defined.
    :flush_per_request_cache

set old_url [:get_url -node_id $node_id]

if {$node_id eq "" || $old_url eq "/"} {
    #
    # When no node_id is given or the URL is specified
    # as top-url, flush all caches. This happens
    # e.g. in the regression test.
    #
    #ns_log notice "FLUSHALL"
    ::acs::site_nodes_cache flush_all
    ::acs::site_nodes_id_cache flush_all
    ::acs::site_nodes_children_cache flush_all

} else {
    #
    # Get subtree from db
    #
    set sql [subst {
        WITH RECURSIVE site_node_tree(node_id,parent_id,object_id)  AS (
          select node_id, parent_id, object_id from site_nodes where node_id = :node_id
        UNION ALL
          select child.node_id, child.parent_id, child.object_id from site_node_tree, site_nodes child
          where  child.parent_id = site_node_tree.node_id
          and :with_subtree
        )
        select [acs::dc map_function_name site_node__url(node_id)], node_id, object_id
        from site_node_tree
    }]
    if {[db_driverkey ""] eq "oracle"} {
        set sql [string map [list "WITH RECURSIVE" "WITH"] $sql]
        if { $with_subtree } {
            set sql [string map [list ":with_subtree" "1 = 1"] $sql]
        } else {
            set sql [string map [list ":with_subtree" "1 = 0"] $sql]
        }
    }

    set tree [::acs::dc list_of_lists -prepare integer,boolean dbqd..get_subtree $sql]

    foreach entry $tree {
        lassign $entry url node_id object_id
        foreach key [list $node_id url-$node_id] {
            ::acs::site_nodes_cache flush -partition_key $node_id $key
        }
        if {$object_id ne ""} {
            ::acs::site_nodes_cache flush -partition_key $object_id urls-$object_id
        }
        :flush_pattern -partition_key $node_id get_children-$node_id-*
        ::acs::site_nodes_children_cache flush  -partition_key $node_id  has_children-$node_id
    }
    regsub {/$} $old_url "" old_url
    :flush_pattern id-$old_url*
}

  • flush_pattern (scripted, public)

     <instance of acs::SiteNodesCache[i]> flush_pattern \
    [ -partition_key partition_key ] pattern

    Flush from the site-nodes caches certain information. The method hides the actual caching structure and is as well provided in conformance with the alternative implementations above. Depending on the specified pattern, it reroutes the flushing request to different caches.

    Switches:
    -partition_key (optional)
    Parameters:
    pattern (required)

    Testcases:
    No testcase defined.
    :flush_per_request_cache

switch -glob -- $pattern {
    id-*           {set cache site_nodes_id_cache}
    get_children-* -
    has_children   {set cache site_nodes_children_cache}
    default        {set cache site_nodes_cache}
}
::acs::$cache flush_pattern -partition_key $partition_key $pattern

  • get_children (scripted, public)

     <instance of acs::SiteNodesCache[i]> get_children -node_id node_id  \
    [ -all ] [ -package_type package_type ] \
    [ -package_key package_key ] [ -filters filters ] \
    [ -element element ]

    Cache get_children operations, except, when "-all" was specified. The underlying operation can be quite expensive, when huge site-node trees are explored. Since the argument list influences the results, we cache for every parameter combination. Since this cache contains subtrees, we have to flush trees, which is implemented via pattern flushes. So we use a separate cache to avoid long locks on site-nodes in general.

    Switches:
    -node_id (required, integer)
    -all (optional)
    -package_type (optional)
    -package_key (optional)
    -filters (optional)
    -element (optional)

    Testcases:
    No testcase defined.
    if {$all} {
    #
    # Don't cache when $all is specified - seldom
    # used, a pain for invalidating.
    #
    next
} else {
    ::acs::site_nodes_children_cache eval -partition_key $node_id  get_children-$node_id-$all-$package_type-$package_key-$filters-$element {
            next
        }
}

  • get_node_id (scripted, public)

     <instance of acs::SiteNodesCache[i]> get_node_id -url url

    Cache the result of the upstream implementation of get_node_id in the acs::site_nodes_id_cache cache.

    Switches:
    -url (required)

    Testcases:
    No testcase defined.
    acs::site_nodes_id_cache eval id-$url { next }

  • get_package_url (scripted, public)

     <instance of acs::SiteNodesCache[i]> get_package_url \
    -package_key package_key

    Cache the result of the upstream implementation of get_package_url in the acs::site_nodes_cache. Note: the cache value from the following method must currently be explicitly flushed. We do that, for instance, when we mount a new package.

    Switches:
    -package_key (required)

    Testcases:
    No testcase defined.
    ::acs::site_nodes_cache eval -partition_key 0 package_url-$package_key { next }

  • get_url (scripted, public)

     <instance of acs::SiteNodesCache[i]> get_url -node_id node_id

    It's a pain, but OpenACS and its regression test call "get_url" a few times with an empty node_id. Shortcut these calls here to avoid problems with the non-numeric partition_key.

    Switches:
    -node_id (required)

    Testcases:
    No testcase defined.
    if {$node_id eq ""} {
    set result ""
} else {
    set result [::acs::site_nodes_cache eval  -partition_key $node_id  url-$node_id { next }]
}
return $result

  • get_urls_from_object_id (scripted, public)

     <instance of acs::SiteNodesCache[i]> get_urls_from_object_id \
    -object_id object_id

    Cache the result of the upstream implementation of get_urls_from_object_id in the acs::site_nodes_cache.

    Switches:
    -object_id (required, integer)

    Testcases:
    No testcase defined.
    ::acs::site_nodes_cache eval -partition_key $object_id urls-$object_id { next }