midcom_helper_nav_backend::load_node_data() - Code Metrics - Inspection of "Remove unused forwardings" - flack/openpsa - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c00a63...b9159b )

by Andreas

created 2019-10-04 18:28 UTC

midcom_helper_nav_backend::load_node_data() A

↳ Parent: midcom_helper_nav_backend

Complexity

Conditions	6
Paths	14

Size

Total Lines	28
Code Lines	16

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	15
CRAP Score	6

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	6
eloc	16
nc	14
nop	1
dl	0
loc	28
ccs	15
cts	15
cp	1
crap	6
rs	9.1111
c	1
b	0
f	0

<?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 = [];

    /**
     * User id for ACL checks. This is set when instantiating to avoid unnecessary overhead
     *
     * @var string
     */
    private $_user_id = false;

    /**
     * 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;


        if (!midcom::get()->auth->admin) {
            $this->_user_id = midcom::get()->auth->acl->get_user_id();
        }

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

        if (empty($root->id)) {
            $this->load_node_data($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_data($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_data.
     *
     * @param mixed $node_id  The node ID of the node to be loaded
     * @param int $parent_id  The node's parent ID, if known
     * @return bool           Indicating success
     */
    private function load_node($node_id, $parent_id = null) : 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;

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

        while ((int) $parent_id > 0) {
            if (!$this->load_node_data($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_data($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_data($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_for($this->_user_id)) {
                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_for($this->_user_id)) {
                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];
        }
    }

    /**
     * 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($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, $parent_node)) {
                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($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($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->_check_leaf_id($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->_check_leaf_id($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($node_id)) {
            return false;
        }

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

    /**
     * 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 _check_leaf_id($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($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);
    }

    /**
     * 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		* User id for ACL checks. This is set when instantiating to avoid unnecessary overhead
136		*
137		* @var string
138		*/
139		private $_user_id = false;
140
141		/**
142		* Constructor
143		*
144		* It will initialize Root Topic, Current Topic and all cache arrays.
145		* The constructor retrieves all initialization data from the component context.
146		*
147		* @param midcom_db_topic $root
148		* @param midcom_db_topic[] $urltopics
149		*/
150	292	public function __construct(midcom_db_topic $root, array $urltopics)
151		{
152	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...
153
154	292	if (!midcom::get()->auth->admin) {
155	291	$this->_user_id = midcom::get()->auth->acl->get_user_id();
156		}
157
158	292	$this->_root = $root->id;
159	292	$this->_current = $this->_root;
160
161	292	if (empty($root->id)) {
162		$this->load_node_data($root);
163		} else {
164	292	$this->init_topics($root, $urltopics);
165		}
166	292	}
167
168		/**
169		* Loads all nodes between root and current node.
170		*
171		* If the current node is behind an invisible or undescendable node, the last
172		* known good node will be used instead for the current node.
173		*
174		* @param midcom_db_topic $root
175		* @param midcom_db_topic[] $urltopics
176		*/
177	292	private function init_topics(midcom_db_topic $root, array $urltopics)
178		{
179	292	$node_path_candidates = [$root];
180	292	foreach ($urltopics as $topic) {
181	3	$node_path_candidates[] = $topic;
182	3	$this->_current = $topic->id;
183		}
184
185	292	$lastgood = null;
186	292	foreach ($node_path_candidates as $topic) {
187	292	if (!$this->load_node_data($topic)) {
188		// Node is hidden behind an undescendable one
189		$this->_current = $lastgood;
190		return;
191		}
192	292	$this->_node_path[] = $topic->id;
193	292	$lastgood = $topic->id;
194		}
195	292	}
196
197		/**
198		* This function is the controlling instance of the loading mechanism. It
199		* is able to load the navigation data of any topic within MidCOM's topic
200		* tree into memory. Any uplink nodes that are not loaded into memory will
201		* be loaded until any other known topic is encountered. After the
202		* necessary data has been loaded with calls to load_node_data.
203		*
204		* @param mixed $node_id The node ID of the node to be loaded
205		* @param int $parent_id The node's parent ID, if known
206		* @return bool Indicating success
207		*/
208	331	private function load_node($node_id, $parent_id = null) : bool
209		{
210		// Check if we have a cached version of the node already
211	331	if (isset(self::$_nodes[$node_id])) {
212	294	return true;
213		}
214
215	73	$topic_id = (int) $node_id;
216
217	73	if ($parent_id === null) {
218		// Load parent nodes also to cache
219	73	$parent_id = $this->_get_parent_id($topic_id);
220		}
221
222	73	while ((int) $parent_id > 0) {
223	19	if (!$this->load_node_data($parent_id)) {
224	1	debug_add("The Node {$parent_id} is invisible, could not satisfy the dependency chain to Node #{$node_id}", MIDCOM_LOG_WARN);
225	1	return false;
226		}
227	18	$parent_id = self::$_nodes[$parent_id]->nodeid;
228		}
229	73	return $this->load_node_data($topic_id);
230		}
231
232		/**
233		* Load the navigational information associated with the topic $param, which
234		* can be passed as an ID or as a MidgardTopic object.
235		*
236		* This method does query the topic for all information and completes it to
237		* build up a full NAP data structure
238		*
239		* It determines the URL_NAME of the topic automatically using the name of the
240		* topic in question.
241		*
242		* The currently active leaf is only queried if and only if the currently
243		* processed topic is equal to the current context's content topic. This should
244		* prevent dynamically loaded components from disrupting active leaf information,
245		* as this can happen if dynamic_load is called before showing the navigation.
246		*
247		* @param mixed $topic Topic object or ID to be processed
248		* @return bool Indicating success
249		*/
250	334	private function load_node_data($topic) : bool
251		{
252	334	if (is_a($topic, midcom_db_topic::class)) {
253	292	$id = $topic->id;
254		} else {
255	73	$id = $topic;
256		}
257	334	if (!array_key_exists($id, self::$_nodes)) {
258	121	$node = new midcom_helper_nav_node($this, $topic);
259
260	121	if (!$node->is_visible_for($this->_user_id)) {
261	50	return false;
262		}
263
264		// The node is visible, add it to the list.
265	77	self::$_nodes[$id] = $node;
266		} else {
267	244	$node = self::$_nodes[$id];
268		}
269		// Set the current leaf, this does not load the leaves from the DB, this is done during get_leaf.
270	297	if ($node->id === $this->_current) {
271	297	$currentleaf = midcom_baseclasses_components_configuration::get($node->component, 'active_leaf');
272	297	if ($currentleaf !== false) {
273	31	$this->_currentleaf = "{$node->id}-{$currentleaf}";
274		}
275		}
276
277	297	return true;
278		}
279
280		/**
281		* Return the list of leaves for a given node. This helper will construct complete leaf
282		* data structures for each leaf found. It will first check the cache for the leaf structures,
283		* and query the database only if the corresponding objects have not been found there.
284		*
285		* @param midcom_helper_nav_node $node The NAP node data structure to load the nodes for.
286		*/
287	54	private function load_leaves(midcom_helper_nav_node $node)
288		{
289	54	if (array_key_exists($node->id, $this->_loaded_leaves)) {
290	25	return;
291		}
292	45	$this->_loaded_leaves[$node->id] = [];
293
294	45	$fullprefix = midcom::get()->config->get('midcom_site_url');
295	45	$absoluteprefix = midcom_connection::get_url('self');
296
297	45	foreach ($node->get_leaves() as $id => $leaf) {
298	32	if (!$leaf->is_visible_for($this->_user_id)) {
299		continue;
300		}
301
302		// Rewrite all host-dependent URLs based on the relative URL within our topic tree.
303	32	$leaf->fullurl = $fullprefix . $leaf->relativeurl;
304	32	$leaf->absoluteurl = $absoluteprefix . $leaf->relativeurl;
305
306	32	if ($leaf->guid === null) {
307	10	$leaf->permalink = $leaf->fullurl;
308		} else {
309	22	$leaf->permalink = midcom::get()->permalinks->create_permalink($leaf->guid);
310		}
311
312	32	$this->_leaves[$id] = $leaf;
313	32	$this->_loaded_leaves[$node->id][$id] =& $this->_leaves[$id];
314		}
315	45	}
316
317		/**
318		* Lists all Sub-nodes of $parent_node. If there are no subnodes, or if there was an error
319		* (for instance an unknown parent node ID) you will get an empty array
320		*
321		* @param mixed $parent_node The ID of the node of which the subnodes are searched.
322		* @param boolean $show_noentry Show all objects on-site which have the noentry flag set.
323		*/
324	22	public function list_nodes($parent_node, $show_noentry) : array
325		{
326	22	static $listed = [];
327
328	22	if (!$this->load_node($parent_node)) {
329		debug_add("Unable to load parent node $parent_node", MIDCOM_LOG_ERROR);
330		return [];
331		}
332
333	22	$cache_identifier = $parent_node . (($show_noentry) ? 'noentry' : '');
334	22	if (isset($listed[$cache_identifier])) {
335	13	return $listed[$cache_identifier];
336		}
337
338	11	$subnodes = self::$_nodes[$parent_node]->get_subnodes();
339
340		// No results, return an empty array
341	11	if (empty($subnodes)) {
342	10	$listed[$cache_identifier] = [];
343	10	return $listed[$cache_identifier];
344		}
345
346	1	$result = [];
347
348	1	foreach ($subnodes as $id) {
349	1	if (!$this->load_node($id, $parent_node)) {
350		continue;
351		}
352
353	1	if ( !$show_noentry
354	1	&& self::$_nodes[$id]->noentry) {
355		// Hide "noentry" items
356		continue;
357		}
358
359	1	$result[] = $id;
360		}
361
362	1	$listed[$cache_identifier] = $result;
363	1	return $listed[$cache_identifier];
364		}
365
366		/**
367		* Lists all leaves of $parent_node. If there are no leaves, or if there was an error
368		* (for instance an unknown parent node ID) you will get an empty array,
369		*
370		* @param mixed $parent_node The ID of the node of which the leaves are searched.
371		* @param boolean $show_noentry Show all objects on-site which have the noentry flag set.
372		*/
373	20	public function list_leaves($parent_node, $show_noentry) : array
374		{
375	20	static $listed = [];
376
377	20	if (!$this->load_node($parent_node)) {
378		return [];
379		}
380	20	$cache_key = $parent_node . '--' . $show_noentry;
381
382	20	if (!isset($listed[$cache_key])) {
383	10	$listed[$cache_key] = [];
384	10	$this->load_leaves(self::$_nodes[$parent_node]);
385
386	10	foreach ($this->_loaded_leaves[self::$_nodes[$parent_node]->id] as $id => $leaf) {
387	1	if ($show_noentry \|\| !$leaf->noentry) {
388	1	$listed[$cache_key][] = $id;
389		}
390		}
391		}
392
393	20	return $listed[$cache_key];
394		}
395
396		/**
397		* This is a helper function used by midcom_helper_nav::resolve_guid(). It
398		* checks if the object denoted by the passed GUID is already loaded into
399		* memory and returns it, if available. This should speed up GUID lookup heavy
400		* code.
401		*
402		* @param string $guid The GUID to look up in the NAP cache.
403		* @return Array A NAP structure if the GUID is known, null otherwise.
404		*/
405	28	public function get_loaded_object_by_guid($guid)
406		{
407	28	$entry = $this->_nap_cache->get_guid($guid);
408	28	if (empty($entry)) {
409	27	return null;
410		}
411	4	if ($entry[MIDCOM_NAV_TYPE] == 'leaf') {
412		return $this->get_leaf($entry[MIDCOM_NAV_ID]);
413		}
414	4	return $this->get_node($entry[MIDCOM_NAV_ID]);
415		}
416
417		/**
418		* This will give you a key-value pair describing the node with the ID
419		* $node_id. The defined keys are described above in Node data interchange
420		* format. You will get false if the node ID is invalid.
421		*
422		* @param mixed $node_id The node ID to be retrieved.
423		* @return Array The node data as outlined in the class introduction, false on failure
424		*/
425	318	public function get_node($node_id)
426		{
427	318	$node = $node_id;
428	318	if (!empty($node->guid)) {
429		$node_id = $node->id;
430		}
431	318	if (!$this->load_node($node_id)) {
432	50	return false;
433		}
434
435	281	return self::$_nodes[$node_id]->get_data();
436		}
437
438		/**
439		* This will give you a key-value pair describing the leaf with the ID
440		* $node_id. The defined keys are described above in leaf data interchange
441		* format. You will get false if the leaf ID is invalid.
442		*
443		* @param string $leaf_id The leaf-id to be retrieved.
444		* @return Array The leaf-data as outlined in the class introduction, false on failure
445		*/
446	45	public function get_leaf($leaf_id)
447		{
448	45	if (!$this->_check_leaf_id($leaf_id)) {
449	33	debug_add("This leaf is unknown, aborting.", MIDCOM_LOG_INFO);
450	33	return false;
451		}
452
453	29	return $this->_leaves[$leaf_id]->get_data();
454		}
455
456		/**
457		* Retrieve the ID of the currently displayed node. Defined by the topic of
458		* the component that declared able to handle the request.
459		*
460		* @return mixed The ID of the node in question.
461		*/
462	244	public function get_current_node()
463		{
464	244	return $this->_current;
465		}
466
467		/**
468		* Retrieve the ID of the currently displayed leaf. This is a leaf that is
469		* displayed by the handling topic. If no leaf is active, this function
470		* returns false. (Remember to make a type sensitive check, e.g.
471		* nav::get_current_leaf() !== false to distinguish "0" and "false".)
472		*
473		* @return string The ID of the leaf in question or false on failure.
474		*/
475	268	public function get_current_leaf()
476		{
477	268	return $this->_currentleaf;
478		}
479
480		/**
481		* Retrieve the ID of the upper node of the currently displayed node.
482		*
483		* @return mixed The ID of the node in question.
484		*/
485	2	public function get_current_upper_node()
486		{
487	2	if (count($this->_node_path) > 1) {
488	1	return $this->_node_path[count($this->_node_path) - 2];
489		}
490	1	return $this->_node_path[0];
491		}
492
493		/**
494		* Retrieve the ID of the root node. Note that this ID is dependent from the
495		* ID of the MidCOM Root topic and therefore will change as easily as the
496		* root topic ID might. The MIDCOM_NAV_URL entry of the root node's data will
497		* always be empty.
498		*/
499	162	public function get_root_node() : int
500		{
501	162	return $this->_root;
502		}
503
504		/**
505		* Retrieve the IDs of the nodes from the URL. First value at key 0 is
506		* the root node ID, possible second value is the first subnode ID etc.
507		* Contains only visible nodes (nodes which can be loaded).
508		*/
509	13	public function get_node_path() : array
510		{
511	13	return $this->_node_path;
512		}
513
514		/**
515		* Returns the ID of the node to which $leaf_id is associated to, false
516		* on failure.
517		*
518		* @param string $leaf_id The Leaf-ID to search an uplink for.
519		* @return mixed The ID of the Node for which we have a match, or false on failure.
520		*/
521	1	function get_leaf_uplink($leaf_id)
522		{
523	1	if (!$this->_check_leaf_id($leaf_id)) {
524		debug_add("This leaf is unknown, aborting.", MIDCOM_LOG_ERROR);
525		return false;
526		}
527
528	1	return $this->_leaves[$leaf_id]->nodeid;
529		}
530
531		/**
532		* Returns the ID of the node to which $node_id is associated to, false
533		* on failure. The root node's uplink is -1.
534		*
535		* @param mixed $node_id The node ID to search an uplink for.
536		* @return mixed The ID of the node for which we have a match, -1 for the root node, or false on failure.
537		*/
538	87	public function get_node_uplink($node_id)
539		{
540	87	if (!$this->load_node($node_id)) {
541	33	return false;
542		}
543
544	54	return self::$_nodes[$node_id]->nodeid;
545		}
546
547		/**
548		* Verifies the existence of a given leaf. Call this before getting a leaf from the
549		* $_leaves cache. It will load all necessary nodes/leaves as necessary.
550		*
551		* @param string $leaf_id A valid NAP leaf id ($nodeid-$leafid pattern).
552		*/
553	45	private function _check_leaf_id($leaf_id) : bool
554		{
555	45	if (!$leaf_id) {
556		debug_add("Tried to load a suspicious leaf id, probably a false from get_current_leaf.");
557		return false;
558		}
559
560	45	if (array_key_exists($leaf_id, $this->_leaves)) {
561	2	return true;
562		}
563
564	45	$node_id = explode('-', $leaf_id)[0];
565
566	45	if (!$this->load_node($node_id)) {
567		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.",
568		MIDCOM_LOG_INFO);
569		return false;
570		}
571	45	$this->load_leaves(self::$_nodes[$node_id]);
572
573	45	return array_key_exists($leaf_id, $this->_leaves);
574		}
575
576		/**
577		* Determine a topic's parent id without loading the full object
578		*
579		* @param integer $topic_id The topic ID
580		* @return integer The parent ID or false
581		*/
582	73	private function _get_parent_id($topic_id)
583		{
584	73	$mc = midcom_db_topic::new_collector('id', $topic_id);
585	73	$result = $mc->get_values('up');
586	73	if (empty($result)) {
587	33	return false;
588		}
589	68	return array_shift($result);
590		}
591		}
592

flack / openpsa

Push — master ( c00a63...b9159b )

midcom_helper_nav_backend::load_node_data() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like