midcom_helper_nav_backend::load_leaf() - Code Metrics - Inspection of "Readbility improvements" - flack/openpsa - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 6bb916...1b69f8 )

by Andreas

created 2019-10-04 19:43 UTC

midcom_helper_nav_backend::load_leaf() A

↳ Parent: midcom_helper_nav_backend

Complexity

Conditions	4
Paths	4

Size

Total Lines	21
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	4.9102

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	4
eloc	12
c	1
b	0
f	0
nc	4
nop	1
dl	0
loc	21
ccs	8
cts	13
cp	0.6153
crap	4.9102
rs	9.8666

<?php
/**
 * @package midcom.helper
 * @author The Midgard Project, http://www.midgard-project.org
 * @copyright The Midgard Project, http://www.midgard-project.org
 * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License
 */

/**
 * This class is the basic building stone of the Navigation Access Point
 * System of MidCOM.
 *
 * It is responsible for collecting the available
 * information and for building the navigational tree out of it. This
 * class is only the internal interface to the NAP System and is used by
 * midcom_helper_nav as a node cache. The framework should ensure that
 * only one class of this type is active at one time.
 *
 * It will give you a very abstract view of the content tree, modified
 * by the NAP classes of the components. You can retrieve a node/leaf tree
 * of the content, and for each element you can retrieve a URL name and a
 * long name for navigation display.
 *
 * Leaves and Nodes are both indexed by integer constants which are assigned
 * by the framework. The framework defines two starting points in this tree:
 * The root node and the "current" node. The current node defined through
 * the topic of the component that declared to be able to handle the request.
 *
 * The class will load the necessary information on demand to minimize
 * database traffic.
 *
 * The interface functions should enable you to build any navigation tree you
 * desire. The public nav class will give you some of those high-level
 * functions.
 *
 * <b>Node data interchange format</b>
 *
 * Node NAP data consists of a simple key => value array with the following
 * keys required by the component:
 *
 * - MIDCOM_NAV_NAME => The real (= displayable) name of the element
 *
 * Other keys delivered to NAP users include:
 *
 * - MIDCOM_NAV_URL  => The URL name of the element, which is automatically
 *   defined by NAP.
 *
 * <b>Leaf data interchange format</b>
 *
 * Basically for each leaf the usual meta information is returned:
 *
 * - MIDCOM_NAV_URL      => URL of the leaf element
 * - MIDCOM_NAV_NAME     => Name of the leaf element
 * - MIDCOM_NAV_GUID     => Optional argument denoting the GUID of the referred element
 * - MIDCOM_NAV_SORTABLE => Optional argument denoting whether the element is sortable
 *
 * @package midcom.helper
 */
class midcom_helper_nav_backend
{
    /**
     * The ID of the MidCOM Root Content Topic
     *
     * @var int
     */
    private $_root;

    /**
     * The ID of the currently active Navigation Node, determined by the active
     * MidCOM Topic or one of its uplinks, if the subtree in question is invisible.
     *
     * @var int
     */
    private $_current;

    /**
     * The GUID of the currently active leaf.
     *
     * @var string
     */
    private $_currentleaf = false;

    /**
     * Leaf cache. It is an array which contains elements indexed by
     * their leaf ID. The data is again stored in an associative array:
     *
     * - MIDCOM_NAV_NODEID => ID of the parent node (int)
     * - MIDCOM_NAV_URL => URL name of the leaf (string)
     * - MIDCOM_NAV_NAME => Textual name of the leaf (string)
     *
     * @todo Update the data structure documentation
     * @var midcom_helper_nav_leaf[]
     */
    private $_leaves = [];

    /**
     * Node cache. It is an array which contains elements indexed by
     * their node ID. The data is again stored in an associative array:
     *
     * - MIDCOM_NAV_NODEID => ID of the parent node (-1 for the root node) (int)
     * - MIDCOM_NAV_URL => URL name of the leaf (string)
     * - MIDCOM_NAV_NAME => Textual name of the leaf (string)
     *
     * @todo Update the data structure documentation
     * @var midcom_helper_nav_node[]
     */
    private static $_nodes = [];

    /**
     * List of all topics for which the leaves have been loaded.
     * If the id of the node is in this array, the leaves are available, otherwise,
     * the leaves have to be loaded.
     *
     * @var midcom_helper_nav_leaf[]
     */
    private $_loaded_leaves = [];

    /**
     * The NAP cache store
     *
     * @var midcom_services_cache_module_nap
     */
    private $_nap_cache;

    /**
     * This array holds the node path from the URL. First value at key 0 is
     * the root node ID, possible second value is the first subnode ID etc.
     * Contains only visible nodes (nodes which can be loaded).
     *
     * @var Array
     */
    private $_node_path = [];

    /**
     * Constructor
     *
     * It will initialize Root Topic, Current Topic and all cache arrays.
     * The constructor retrieves all initialization data from the component context.
     *
     * @param midcom_db_topic $root
     * @param midcom_db_topic[] $urltopics
     */
    public function __construct(midcom_db_topic $root, array $urltopics)
    {
        $this->_nap_cache = midcom::get()->cache->nap;


        $this->_root = $root->id;
        $this->_current = $this->_root;

        if (empty($root->id)) {
            $this->load_node($root);
        } else {
            $this->init_topics($root, $urltopics);
        }
    }

    /**
     * Loads all nodes between root and current node.
     *
     * If the current node is behind an invisible or undescendable node, the last
     * known good node will be used instead for the current node.
     *
     * @param midcom_db_topic $root
     * @param midcom_db_topic[] $urltopics
     */
    private function init_topics(midcom_db_topic $root, array $urltopics)
    {
        $node_path_candidates = [$root];
        foreach ($urltopics as $topic) {
            $node_path_candidates[] = $topic;
            $this->_current = $topic->id;
        }

        $lastgood = null;
        foreach ($node_path_candidates as $topic) {
            if (!$this->load_node($topic)) {
                // Node is hidden behind an undescendable one
                $this->_current = $lastgood;
                return;
            }
            $this->_node_path[] = $topic->id;
            $lastgood = $topic->id;
        }
    }

    /**
     * This function is the controlling instance of the loading mechanism. It
     * is able to load the navigation data of any topic within MidCOM's topic
     * tree into memory. Any uplink nodes that are not loaded into memory will
     * be loaded until any other known topic is encountered. After the
     * necessary data has been loaded with calls to load_node.
     *
     * @param mixed $node_id  The node ID of the node to be loaded
     * @return bool           Indicating success
     */
    private function load_node_recursive($node_id) : bool
    {
        // Check if we have a cached version of the node already
        if (isset(self::$_nodes[$node_id])) {
            return true;
        }

        $topic_id = (int) $node_id;

        // Load parent nodes also to cache
        $parent_id = $this->_get_parent_id($topic_id);

        while ((int) $parent_id > 0) {
            if (!$this->load_node($parent_id)) {
                debug_add("The Node {$parent_id} is invisible, could not satisfy the dependency chain to Node #{$node_id}", MIDCOM_LOG_WARN);
                return false;
            }
            $parent_id = self::$_nodes[$parent_id]->nodeid;
        }
        return $this->load_node($topic_id);
    }

    /**
     * Load the navigational information associated with the topic $param, which
     * can be passed as an ID or as a MidgardTopic object.
     *
     * This method does query the topic for all information and completes it to
     * build up a full NAP data structure
     *
     * It determines the URL_NAME of the topic automatically using the name of the
     * topic in question.
     *
     * The currently active leaf is only queried if and only if the currently
     * processed topic is equal to the current context's content topic. This should
     * prevent dynamically loaded components from disrupting active leaf information,
     * as this can happen if dynamic_load is called before showing the navigation.
     *
     * @param mixed $topic Topic object or ID to be processed
     * @return bool Indicating success
     */
    private function load_node($topic) : bool
    {
        if (is_a($topic, midcom_db_topic::class)) {
            $id = $topic->id;
        } else {
            $id = $topic;
        }
        if (!array_key_exists($id, self::$_nodes)) {
            $node = new midcom_helper_nav_node($this, $topic);

            if (!$node->is_visible()) {
                return false;
            }

            // The node is visible, add it to the list.
            self::$_nodes[$id] = $node;
        } else {
            $node = self::$_nodes[$id];
        }
        // Set the current leaf, this does *not* load the leaves from the DB, this is done during get_leaf.
        if ($node->id === $this->_current) {
            $currentleaf = midcom_baseclasses_components_configuration::get($node->component, 'active_leaf');
            if ($currentleaf !== false) {
                $this->_currentleaf = "{$node->id}-{$currentleaf}";
            }
        }

        return true;
    }

    /**
     * Return the list of leaves for a given node. This helper will construct complete leaf
     * data structures for each leaf found. It will first check the cache for the leaf structures,
     * and query the database only if the corresponding objects have not been found there.
     *
     * @param midcom_helper_nav_node $node The NAP node data structure to load the nodes for.
     */
    private function load_leaves(midcom_helper_nav_node $node)
    {
        if (array_key_exists($node->id, $this->_loaded_leaves)) {
            return;
        }
        $this->_loaded_leaves[$node->id] = [];

        $fullprefix = midcom::get()->config->get('midcom_site_url');
        $absoluteprefix = midcom_connection::get_url('self');

        foreach ($node->get_leaves() as $id => $leaf) {
            if (!$leaf->is_visible()) {
                continue;
            }

            // Rewrite all host-dependent URLs based on the relative URL within our topic tree.
            $leaf->fullurl = $fullprefix . $leaf->relativeurl;
            $leaf->absoluteurl = $absoluteprefix . $leaf->relativeurl;

            if ($leaf->guid === null) {
                $leaf->permalink = $leaf->fullurl;
            } else {
                $leaf->permalink = midcom::get()->permalinks->create_permalink($leaf->guid);
            }

            $this->_leaves[$id] = $leaf;
            $this->_loaded_leaves[$node->id][$id] =& $this->_leaves[$id];
        }
    }

    /**
     * Verifies the existence of a given leaf. Call this before getting a leaf from the
     * $_leaves cache. It will load all necessary nodes/leaves as necessary.
     *
     * @param string $leaf_id A valid NAP leaf id ($nodeid-$leafid pattern).
     */
    private function load_leaf($leaf_id) : bool
    {
        if (!$leaf_id) {
            debug_add("Tried to load a suspicious leaf id, probably a false from get_current_leaf.");
            return false;
        }

        if (array_key_exists($leaf_id, $this->_leaves)) {
            return true;
        }

        $node_id = explode('-', $leaf_id)[0];

        if (!$this->load_node_recursive($node_id)) {
            debug_add("Tried to verify the leaf id {$leaf_id}, which should belong to node {$node_id}, but this node cannot be loaded, see debug level log for details.",
            MIDCOM_LOG_INFO);
            return false;
        }
        $this->load_leaves(self::$_nodes[$node_id]);

        return array_key_exists($leaf_id, $this->_leaves);
    }

    /**
     * Lists all Sub-nodes of $parent_node. If there are no subnodes, or if there was an error
     * (for instance an unknown parent node ID) you will get an empty array
     *
     * @param mixed $parent_node    The ID of the node of which the subnodes are searched.
     * @param boolean $show_noentry Show all objects on-site which have the noentry flag set.
     */
    public function list_nodes($parent_node, $show_noentry) : array
    {
        static $listed = [];

        if (!$this->load_node_recursive($parent_node)) {
            debug_add("Unable to load parent node $parent_node", MIDCOM_LOG_ERROR);
            return [];
        }

        $cache_identifier = $parent_node . (($show_noentry) ? 'noentry' : '');
        if (isset($listed[$cache_identifier])) {
            return $listed[$cache_identifier];
        }

        $subnodes = self::$_nodes[$parent_node]->get_subnodes();

        // No results, return an empty array
        if (empty($subnodes)) {
            $listed[$cache_identifier] = [];
            return $listed[$cache_identifier];
        }

        $result = [];

        foreach ($subnodes as $id) {
            if (!$this->load_node($id)) {
                continue;
            }

            if (   !$show_noentry
                && self::$_nodes[$id]->noentry) {
                // Hide "noentry" items
                continue;
            }

            $result[] = $id;
        }

        $listed[$cache_identifier] = $result;
        return $listed[$cache_identifier];
    }

    /**
     * Lists all leaves of $parent_node. If there are no leaves, or if there was an error
     * (for instance an unknown parent node ID) you will get an empty array,
     *
     * @param mixed $parent_node    The ID of the node of which the leaves are searched.
     * @param boolean $show_noentry Show all objects on-site which have the noentry flag set.
     */
    public function list_leaves($parent_node, $show_noentry) : array
    {
        static $listed = [];

        if (!$this->load_node_recursive($parent_node)) {
            return [];
        }
        $cache_key = $parent_node . '--' . $show_noentry;

        if (!isset($listed[$cache_key])) {
            $listed[$cache_key] = [];
            $this->load_leaves(self::$_nodes[$parent_node]);

            foreach ($this->_loaded_leaves[self::$_nodes[$parent_node]->id] as $id => $leaf) {
                if ($show_noentry || !$leaf->noentry) {
                    $listed[$cache_key][] = $id;
                }
            }
        }

        return $listed[$cache_key];
    }

    /**
     * This is a helper function used by midcom_helper_nav::resolve_guid(). It
     * checks if the object denoted by the passed GUID is already loaded into
     * memory and returns it, if available. This should speed up GUID lookup heavy
     * code.
     *
     * @param string $guid The GUID to look up in the NAP cache.
     * @return Array A NAP structure if the GUID is known, null otherwise.
     */
    public function get_loaded_object_by_guid($guid)
    {
        $entry = $this->_nap_cache->get_guid($guid);
        if (empty($entry)) {
            return null;
        }
        if ($entry[MIDCOM_NAV_TYPE] == 'leaf') {
            return $this->get_leaf($entry[MIDCOM_NAV_ID]);
        }
        return $this->get_node($entry[MIDCOM_NAV_ID]);
    }

    /**
     * This will give you a key-value pair describing the node with the ID
     * $node_id. The defined keys are described above in Node data interchange
     * format. You will get false if the node ID is invalid.
     *
     * @param mixed $node_id    The node ID to be retrieved.
     * @return Array        The node data as outlined in the class introduction, false on failure
     */
    public function get_node($node_id)
    {
        $node = $node_id;
        if (!empty($node->guid)) {
            $node_id = $node->id;
        }
        if (!$this->load_node_recursive($node_id)) {
            return false;
        }

        return self::$_nodes[$node_id]->get_data();
    }

    /**
     * This will give you a key-value pair describing the leaf with the ID
     * $node_id. The defined keys are described above in leaf data interchange
     * format. You will get false if the leaf ID is invalid.
     *
     * @param string $leaf_id    The leaf-id to be retrieved.
     * @return Array        The leaf-data as outlined in the class introduction, false on failure
     */
    public function get_leaf($leaf_id)
    {
        if (!$this->load_leaf($leaf_id)) {
            debug_add("This leaf is unknown, aborting.", MIDCOM_LOG_INFO);
            return false;
        }

        return $this->_leaves[$leaf_id]->get_data();
    }

    /**
     * Retrieve the ID of the currently displayed node. Defined by the topic of
     * the component that declared able to handle the request.
     *
     * @return mixed    The ID of the node in question.
     */
    public function get_current_node()
    {
        return $this->_current;
    }

    /**
     * Retrieve the ID of the currently displayed leaf. This is a leaf that is
     * displayed by the handling topic. If no leaf is active, this function
     * returns false. (Remember to make a type sensitive check, e.g.
     * nav::get_current_leaf() !== false to distinguish "0" and "false".)
     *
     * @return string    The ID of the leaf in question or false on failure.
     */
    public function get_current_leaf()
    {
        return $this->_currentleaf;
    }

    /**
     * Retrieve the ID of the upper node of the currently displayed node.
     *
     * @return mixed    The ID of the node in question.
     */
    public function get_current_upper_node()
    {
        if (count($this->_node_path) > 1) {
            return $this->_node_path[count($this->_node_path) - 2];
        }
        return $this->_node_path[0];
    }

    /**
     * Retrieve the ID of the root node. Note that this ID is dependent from the
     * ID of the MidCOM Root topic and therefore will change as easily as the
     * root topic ID might. The MIDCOM_NAV_URL entry of the root node's data will
     * always be empty.
     */
    public function get_root_node() : int
    {
        return $this->_root;
    }

    /**
     * Retrieve the IDs of the nodes from the URL. First value at key 0 is
     * the root node ID, possible second value is the first subnode ID etc.
     * Contains only visible nodes (nodes which can be loaded).
     */
    public function get_node_path() : array
    {
        return $this->_node_path;
    }

    /**
     * Returns the ID of the node to which $leaf_id is associated to, false
     * on failure.
     *
     * @param string $leaf_id    The Leaf-ID to search an uplink for.
     * @return mixed             The ID of the Node for which we have a match, or false on failure.
     */
    function get_leaf_uplink($leaf_id)
    {
        if (!$this->load_leaf($leaf_id)) {
            debug_add("This leaf is unknown, aborting.", MIDCOM_LOG_ERROR);
            return false;
        }

        return $this->_leaves[$leaf_id]->nodeid;
    }

    /**
     * Returns the ID of the node to which $node_id is associated to, false
     * on failure. The root node's uplink is -1.
     *
     * @param mixed $node_id    The node ID to search an uplink for.
     * @return mixed             The ID of the node for which we have a match, -1 for the root node, or false on failure.
     */
    public function get_node_uplink($node_id)
    {
        if (!$this->load_node_recursive($node_id)) {
            return false;
        }

        return self::$_nodes[$node_id]->nodeid;
    }

    /**
     * Determine a topic's parent id without loading the full object
     *
     * @param integer $topic_id The topic ID
     * @return integer The parent ID or false
     */
    private function _get_parent_id($topic_id)
    {
        $mc = midcom_db_topic::new_collector('id', $topic_id);
        $result = $mc->get_values('up');

        if (empty($result)) {
            return false;
        }
        return array_shift($result);
    }
}


1		<?php
2		/**
3		* @package midcom.helper
4		* @author The Midgard Project, http://www.midgard-project.org
5		* @copyright The Midgard Project, http://www.midgard-project.org
6		* @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License
7		*/
8
9		/**
10		* This class is the basic building stone of the Navigation Access Point
11		* System of MidCOM.
12		*
13		* It is responsible for collecting the available
14		* information and for building the navigational tree out of it. This
15		* class is only the internal interface to the NAP System and is used by
16		* midcom_helper_nav as a node cache. The framework should ensure that
17		* only one class of this type is active at one time.
18		*
19		* It will give you a very abstract view of the content tree, modified
20		* by the NAP classes of the components. You can retrieve a node/leaf tree
21		* of the content, and for each element you can retrieve a URL name and a
22		* long name for navigation display.
23		*
24		* Leaves and Nodes are both indexed by integer constants which are assigned
25		* by the framework. The framework defines two starting points in this tree:
26		* The root node and the "current" node. The current node defined through
27		* the topic of the component that declared to be able to handle the request.
28		*
29		* The class will load the necessary information on demand to minimize
30		* database traffic.
31		*
32		* The interface functions should enable you to build any navigation tree you
33		* desire. The public nav class will give you some of those high-level
34		* functions.
35		*
36		* <b>Node data interchange format</b>
37		*
38		* Node NAP data consists of a simple key => value array with the following
39		* keys required by the component:
40		*
41		* - MIDCOM_NAV_NAME => The real (= displayable) name of the element
42		*
43		* Other keys delivered to NAP users include:
44		*
45		* - MIDCOM_NAV_URL => The URL name of the element, which is automatically
46		* defined by NAP.
47		*
48		* <b>Leaf data interchange format</b>
49		*
50		* Basically for each leaf the usual meta information is returned:
51		*
52		* - MIDCOM_NAV_URL => URL of the leaf element
53		* - MIDCOM_NAV_NAME => Name of the leaf element
54		* - MIDCOM_NAV_GUID => Optional argument denoting the GUID of the referred element
55		* - MIDCOM_NAV_SORTABLE => Optional argument denoting whether the element is sortable
56		*
57		* @package midcom.helper
58		*/
59		class midcom_helper_nav_backend
60		{
61		/**
62		* The ID of the MidCOM Root Content Topic
63		*
64		* @var int
65		*/
66		private $_root;
67
68		/**
69		* The ID of the currently active Navigation Node, determined by the active
70		* MidCOM Topic or one of its uplinks, if the subtree in question is invisible.
71		*
72		* @var int
73		*/
74		private $_current;
75
76		/**
77		* The GUID of the currently active leaf.
78		*
79		* @var string
80		*/
81		private $_currentleaf = false;
82
83		/**
84		* Leaf cache. It is an array which contains elements indexed by
85		* their leaf ID. The data is again stored in an associative array:
86		*
87		* - MIDCOM_NAV_NODEID => ID of the parent node (int)
88		* - MIDCOM_NAV_URL => URL name of the leaf (string)
89		* - MIDCOM_NAV_NAME => Textual name of the leaf (string)
90		*
91		* @todo Update the data structure documentation
92		* @var midcom_helper_nav_leaf[]
93		*/
94		private $_leaves = [];
95
96		/**
97		* Node cache. It is an array which contains elements indexed by
98		* their node ID. The data is again stored in an associative array:
99		*
100		* - MIDCOM_NAV_NODEID => ID of the parent node (-1 for the root node) (int)
101		* - MIDCOM_NAV_URL => URL name of the leaf (string)
102		* - MIDCOM_NAV_NAME => Textual name of the leaf (string)
103		*
104		* @todo Update the data structure documentation
105		* @var midcom_helper_nav_node[]
106		*/
107		private static $_nodes = [];
108
109		/**
110		* List of all topics for which the leaves have been loaded.
111		* If the id of the node is in this array, the leaves are available, otherwise,
112		* the leaves have to be loaded.
113		*
114		* @var midcom_helper_nav_leaf[]
115		*/
116		private $_loaded_leaves = [];
117
118		/**
119		* The NAP cache store
120		*
121		* @var midcom_services_cache_module_nap
122		*/
123		private $_nap_cache;
124
125		/**
126		* This array holds the node path from the URL. First value at key 0 is
127		* the root node ID, possible second value is the first subnode ID etc.
128		* Contains only visible nodes (nodes which can be loaded).
129		*
130		* @var Array
131		*/
132		private $_node_path = [];
133
134		/**
135		* Constructor
136		*
137		* It will initialize Root Topic, Current Topic and all cache arrays.
138		* The constructor retrieves all initialization data from the component context.
139		*
140		* @param midcom_db_topic $root
141		* @param midcom_db_topic[] $urltopics
142		*/
143	292	public function __construct(midcom_db_topic $root, array $urltopics)
144		{
145	292	$this->_nap_cache = midcom::get()->cache->nap;
		0 ignored issues – show Bug introduced 2018-01-08 16:22 UTC by Report Bug Copy Issue Report The property `nap` does not seem to exist on `midcom_services_cache`. Loading history...
146
147	292	$this->_root = $root->id;
148	292	$this->_current = $this->_root;
149
150	292	if (empty($root->id)) {
151		$this->load_node($root);
152		} else {
153	292	$this->init_topics($root, $urltopics);
154		}
155	292	}
156
157		/**
158		* Loads all nodes between root and current node.
159		*
160		* If the current node is behind an invisible or undescendable node, the last
161		* known good node will be used instead for the current node.
162		*
163		* @param midcom_db_topic $root
164		* @param midcom_db_topic[] $urltopics
165		*/
166	292	private function init_topics(midcom_db_topic $root, array $urltopics)
167		{
168	292	$node_path_candidates = [$root];
169	292	foreach ($urltopics as $topic) {
170	3	$node_path_candidates[] = $topic;
171	3	$this->_current = $topic->id;
172		}
173
174	292	$lastgood = null;
175	292	foreach ($node_path_candidates as $topic) {
176	292	if (!$this->load_node($topic)) {
177		// Node is hidden behind an undescendable one
178		$this->_current = $lastgood;
179		return;
180		}
181	292	$this->_node_path[] = $topic->id;
182	292	$lastgood = $topic->id;
183		}
184	292	}
185
186		/**
187		* This function is the controlling instance of the loading mechanism. It
188		* is able to load the navigation data of any topic within MidCOM's topic
189		* tree into memory. Any uplink nodes that are not loaded into memory will
190		* be loaded until any other known topic is encountered. After the
191		* necessary data has been loaded with calls to load_node.
192		*
193		* @param mixed $node_id The node ID of the node to be loaded
194		* @return bool Indicating success
195		*/
196	331	private function load_node_recursive($node_id) : bool
197		{
198		// Check if we have a cached version of the node already
199	331	if (isset(self::$_nodes[$node_id])) {
200	294	return true;
201		}
202
203	73	$topic_id = (int) $node_id;
204
205		// Load parent nodes also to cache
206	73	$parent_id = $this->_get_parent_id($topic_id);
207
208	73	while ((int) $parent_id > 0) {
209	19	if (!$this->load_node($parent_id)) {
210	1	debug_add("The Node {$parent_id} is invisible, could not satisfy the dependency chain to Node #{$node_id}", MIDCOM_LOG_WARN);
211	1	return false;
212		}
213	18	$parent_id = self::$_nodes[$parent_id]->nodeid;
214		}
215	73	return $this->load_node($topic_id);
216		}
217
218		/**
219		* Load the navigational information associated with the topic $param, which
220		* can be passed as an ID or as a MidgardTopic object.
221		*
222		* This method does query the topic for all information and completes it to
223		* build up a full NAP data structure
224		*
225		* It determines the URL_NAME of the topic automatically using the name of the
226		* topic in question.
227		*
228		* The currently active leaf is only queried if and only if the currently
229		* processed topic is equal to the current context's content topic. This should
230		* prevent dynamically loaded components from disrupting active leaf information,
231		* as this can happen if dynamic_load is called before showing the navigation.
232		*
233		* @param mixed $topic Topic object or ID to be processed
234		* @return bool Indicating success
235		*/
236	334	private function load_node($topic) : bool
237		{
238	334	if (is_a($topic, midcom_db_topic::class)) {
239	292	$id = $topic->id;
240		} else {
241	73	$id = $topic;
242		}
243	334	if (!array_key_exists($id, self::$_nodes)) {
244	121	$node = new midcom_helper_nav_node($this, $topic);
245
246	121	if (!$node->is_visible()) {
247	50	return false;
248		}
249
250		// The node is visible, add it to the list.
251	77	self::$_nodes[$id] = $node;
252		} else {
253	244	$node = self::$_nodes[$id];
254		}
255		// Set the current leaf, this does not load the leaves from the DB, this is done during get_leaf.
256	297	if ($node->id === $this->_current) {
257	297	$currentleaf = midcom_baseclasses_components_configuration::get($node->component, 'active_leaf');
258	297	if ($currentleaf !== false) {
259	31	$this->_currentleaf = "{$node->id}-{$currentleaf}";
260		}
261		}
262
263	297	return true;
264		}
265
266		/**
267		* Return the list of leaves for a given node. This helper will construct complete leaf
268		* data structures for each leaf found. It will first check the cache for the leaf structures,
269		* and query the database only if the corresponding objects have not been found there.
270		*
271		* @param midcom_helper_nav_node $node The NAP node data structure to load the nodes for.
272		*/
273	54	private function load_leaves(midcom_helper_nav_node $node)
274		{
275	54	if (array_key_exists($node->id, $this->_loaded_leaves)) {
276	25	return;
277		}
278	45	$this->_loaded_leaves[$node->id] = [];
279
280	45	$fullprefix = midcom::get()->config->get('midcom_site_url');
281	45	$absoluteprefix = midcom_connection::get_url('self');
282
283	45	foreach ($node->get_leaves() as $id => $leaf) {
284	32	if (!$leaf->is_visible()) {
285		continue;
286		}
287
288		// Rewrite all host-dependent URLs based on the relative URL within our topic tree.
289	32	$leaf->fullurl = $fullprefix . $leaf->relativeurl;
290	32	$leaf->absoluteurl = $absoluteprefix . $leaf->relativeurl;
291
292	32	if ($leaf->guid === null) {
293	10	$leaf->permalink = $leaf->fullurl;
294		} else {
295	22	$leaf->permalink = midcom::get()->permalinks->create_permalink($leaf->guid);
296		}
297
298	32	$this->_leaves[$id] = $leaf;
299	32	$this->_loaded_leaves[$node->id][$id] =& $this->_leaves[$id];
300		}
301	45	}
302
303		/**
304		* Verifies the existence of a given leaf. Call this before getting a leaf from the
305		* $_leaves cache. It will load all necessary nodes/leaves as necessary.
306		*
307		* @param string $leaf_id A valid NAP leaf id ($nodeid-$leafid pattern).
308		*/
309	45	private function load_leaf($leaf_id) : bool
310		{
311	45	if (!$leaf_id) {
312		debug_add("Tried to load a suspicious leaf id, probably a false from get_current_leaf.");
313		return false;
314		}
315
316	45	if (array_key_exists($leaf_id, $this->_leaves)) {
317	2	return true;
318		}
319
320	45	$node_id = explode('-', $leaf_id)[0];
321
322	45	if (!$this->load_node_recursive($node_id)) {
323		debug_add("Tried to verify the leaf id {$leaf_id}, which should belong to node {$node_id}, but this node cannot be loaded, see debug level log for details.",
324		MIDCOM_LOG_INFO);
325		return false;
326		}
327	45	$this->load_leaves(self::$_nodes[$node_id]);
328
329	45	return array_key_exists($leaf_id, $this->_leaves);
330		}
331
332		/**
333		* Lists all Sub-nodes of $parent_node. If there are no subnodes, or if there was an error
334		* (for instance an unknown parent node ID) you will get an empty array
335		*
336		* @param mixed $parent_node The ID of the node of which the subnodes are searched.
337		* @param boolean $show_noentry Show all objects on-site which have the noentry flag set.
338		*/
339	22	public function list_nodes($parent_node, $show_noentry) : array
340		{
341	22	static $listed = [];
342
343	22	if (!$this->load_node_recursive($parent_node)) {
344		debug_add("Unable to load parent node $parent_node", MIDCOM_LOG_ERROR);
345		return [];
346		}
347
348	22	$cache_identifier = $parent_node . (($show_noentry) ? 'noentry' : '');
349	22	if (isset($listed[$cache_identifier])) {
350	13	return $listed[$cache_identifier];
351		}
352
353	11	$subnodes = self::$_nodes[$parent_node]->get_subnodes();
354
355		// No results, return an empty array
356	11	if (empty($subnodes)) {
357	10	$listed[$cache_identifier] = [];
358	10	return $listed[$cache_identifier];
359		}
360
361	1	$result = [];
362
363	1	foreach ($subnodes as $id) {
364	1	if (!$this->load_node($id)) {
365		continue;
366		}
367
368	1	if ( !$show_noentry
369	1	&& self::$_nodes[$id]->noentry) {
370		// Hide "noentry" items
371		continue;
372		}
373
374	1	$result[] = $id;
375		}
376
377	1	$listed[$cache_identifier] = $result;
378	1	return $listed[$cache_identifier];
379		}
380
381		/**
382		* Lists all leaves of $parent_node. If there are no leaves, or if there was an error
383		* (for instance an unknown parent node ID) you will get an empty array,
384		*
385		* @param mixed $parent_node The ID of the node of which the leaves are searched.
386		* @param boolean $show_noentry Show all objects on-site which have the noentry flag set.
387		*/
388	20	public function list_leaves($parent_node, $show_noentry) : array
389		{
390	20	static $listed = [];
391
392	20	if (!$this->load_node_recursive($parent_node)) {
393		return [];
394		}
395	20	$cache_key = $parent_node . '--' . $show_noentry;
396
397	20	if (!isset($listed[$cache_key])) {
398	10	$listed[$cache_key] = [];
399	10	$this->load_leaves(self::$_nodes[$parent_node]);
400
401	10	foreach ($this->_loaded_leaves[self::$_nodes[$parent_node]->id] as $id => $leaf) {
402	1	if ($show_noentry \|\| !$leaf->noentry) {
403	1	$listed[$cache_key][] = $id;
404		}
405		}
406		}
407
408	20	return $listed[$cache_key];
409		}
410
411		/**
412		* This is a helper function used by midcom_helper_nav::resolve_guid(). It
413		* checks if the object denoted by the passed GUID is already loaded into
414		* memory and returns it, if available. This should speed up GUID lookup heavy
415		* code.
416		*
417		* @param string $guid The GUID to look up in the NAP cache.
418		* @return Array A NAP structure if the GUID is known, null otherwise.
419		*/
420	28	public function get_loaded_object_by_guid($guid)
421		{
422	28	$entry = $this->_nap_cache->get_guid($guid);
423	28	if (empty($entry)) {
424	27	return null;
425		}
426	4	if ($entry[MIDCOM_NAV_TYPE] == 'leaf') {
427		return $this->get_leaf($entry[MIDCOM_NAV_ID]);
428		}
429	4	return $this->get_node($entry[MIDCOM_NAV_ID]);
430		}
431
432		/**
433		* This will give you a key-value pair describing the node with the ID
434		* $node_id. The defined keys are described above in Node data interchange
435		* format. You will get false if the node ID is invalid.
436		*
437		* @param mixed $node_id The node ID to be retrieved.
438		* @return Array The node data as outlined in the class introduction, false on failure
439		*/
440	318	public function get_node($node_id)
441		{
442	318	$node = $node_id;
443	318	if (!empty($node->guid)) {
444		$node_id = $node->id;
445		}
446	318	if (!$this->load_node_recursive($node_id)) {
447	50	return false;
448		}
449
450	281	return self::$_nodes[$node_id]->get_data();
451		}
452
453		/**
454		* This will give you a key-value pair describing the leaf with the ID
455		* $node_id. The defined keys are described above in leaf data interchange
456		* format. You will get false if the leaf ID is invalid.
457		*
458		* @param string $leaf_id The leaf-id to be retrieved.
459		* @return Array The leaf-data as outlined in the class introduction, false on failure
460		*/
461	45	public function get_leaf($leaf_id)
462		{
463	45	if (!$this->load_leaf($leaf_id)) {
464	33	debug_add("This leaf is unknown, aborting.", MIDCOM_LOG_INFO);
465	33	return false;
466		}
467
468	29	return $this->_leaves[$leaf_id]->get_data();
469		}
470
471		/**
472		* Retrieve the ID of the currently displayed node. Defined by the topic of
473		* the component that declared able to handle the request.
474		*
475		* @return mixed The ID of the node in question.
476		*/
477	244	public function get_current_node()
478		{
479	244	return $this->_current;
480		}
481
482		/**
483		* Retrieve the ID of the currently displayed leaf. This is a leaf that is
484		* displayed by the handling topic. If no leaf is active, this function
485		* returns false. (Remember to make a type sensitive check, e.g.
486		* nav::get_current_leaf() !== false to distinguish "0" and "false".)
487		*
488		* @return string The ID of the leaf in question or false on failure.
489		*/
490	268	public function get_current_leaf()
491		{
492	268	return $this->_currentleaf;
493		}
494
495		/**
496		* Retrieve the ID of the upper node of the currently displayed node.
497		*
498		* @return mixed The ID of the node in question.
499		*/
500	2	public function get_current_upper_node()
501		{
502	2	if (count($this->_node_path) > 1) {
503	1	return $this->_node_path[count($this->_node_path) - 2];
504		}
505	1	return $this->_node_path[0];
506		}
507
508		/**
509		* Retrieve the ID of the root node. Note that this ID is dependent from the
510		* ID of the MidCOM Root topic and therefore will change as easily as the
511		* root topic ID might. The MIDCOM_NAV_URL entry of the root node's data will
512		* always be empty.
513		*/
514	162	public function get_root_node() : int
515		{
516	162	return $this->_root;
517		}
518
519		/**
520		* Retrieve the IDs of the nodes from the URL. First value at key 0 is
521		* the root node ID, possible second value is the first subnode ID etc.
522		* Contains only visible nodes (nodes which can be loaded).
523		*/
524	13	public function get_node_path() : array
525		{
526	13	return $this->_node_path;
527		}
528
529		/**
530		* Returns the ID of the node to which $leaf_id is associated to, false
531		* on failure.
532		*
533		* @param string $leaf_id The Leaf-ID to search an uplink for.
534		* @return mixed The ID of the Node for which we have a match, or false on failure.
535		*/
536	1	function get_leaf_uplink($leaf_id)
537		{
538	1	if (!$this->load_leaf($leaf_id)) {
539		debug_add("This leaf is unknown, aborting.", MIDCOM_LOG_ERROR);
540		return false;
541		}
542
543	1	return $this->_leaves[$leaf_id]->nodeid;
544		}
545
546		/**
547		* Returns the ID of the node to which $node_id is associated to, false
548		* on failure. The root node's uplink is -1.
549		*
550		* @param mixed $node_id The node ID to search an uplink for.
551		* @return mixed The ID of the node for which we have a match, -1 for the root node, or false on failure.
552		*/
553	87	public function get_node_uplink($node_id)
554		{
555	87	if (!$this->load_node_recursive($node_id)) {
556	33	return false;
557		}
558
559	54	return self::$_nodes[$node_id]->nodeid;
560		}
561
562		/**
563		* Determine a topic's parent id without loading the full object
564		*
565		* @param integer $topic_id The topic ID
566		* @return integer The parent ID or false
567		*/
568	73	private function _get_parent_id($topic_id)
569		{
570	73	$mc = midcom_db_topic::new_collector('id', $topic_id);
571	73	$result = $mc->get_values('up');
572
573	73	if (empty($result)) {
574	33	return false;
575		}
576	68	return array_shift($result);
577		}
578		}
579

flack / openpsa

Push — master ( 6bb916...1b69f8 )

midcom_helper_nav_backend::load_leaf() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like