path: root/includes/classes/LibertyStructure.php

<?php
/**
 * Management of Liberty Content
 *
 * @package  liberty
 * @author   spider <spider@steelsun.com>
 */

/**
 * required setup
 */
namespace Bitweaver\Liberty;

use Bitweaver\BitBase;
use Bitweaver\KernelTools;

/**
 * System class for handling the liberty package
 *
 * @package liberty
 */
class LibertyStructure extends LibertyBase {
	public $mStructureId;

	public $mContentId;

	public function __construct( int $pStructureId = 0, int $pContentId = 0 ) {
		// we need to init our database connection early
		parent::__construct();
		$this->mStructureId = $pStructureId;
		$this->mContentId = $pContentId;
		$this->load();
	}

	public function load(): bool {
		if( $this->mStructureId || $this->mContentId ) {
			if( $this->mInfo = $this->getNode( $this->mStructureId, $this->mContentId ) ) {
				global $gLibertySystem;
				$this->mStructureId = $this->mInfo['structure_id'];
				$this->mContentId = $this->mInfo['content_id'];
				$this->mInfo['content_type'] = $gLibertySystem->mContentTypes[$this->mInfo['content_type_guid']];
			}
		}
		return $this->mInfo && count( $this->mInfo );
	}

	/**
	 * get the details to a given node
	 *
	 * @param int $pStructureId Structure ID of the node
	 * @param int $pContentId Content ID of the node
	 * @return array
	 */
	public function getNode( int $pStructureId = -2, int $pContentId = -2 ) {
		global $gLibertySystem, $gBitSystem;
		static $sStructureNodeCache;
		$contentTypes = $gLibertySystem->mContentTypes;

		if( @$this->verifyId( $pStructureId ) ) {
			if (!empty($sStructureNodeCache['structure_id'][$pStructureId])) {
				return $sStructureNodeCache['structure_id'][$pStructureId];
			}
			$where = ' WHERE ls.`structure_id`=?';
			$bindVars = [ $pStructureId ];
		} elseif( @$this->verifyId( $pContentId ) ) {
			if (!empty($sStructureNodeCache['content_id'][$pContentId])) {
				return $sStructureNodeCache['content_id'][$pContentId];
			}
			$where = ' WHERE ls.`content_id`=?';
			$bindVars = [ $pContentId ];
		}

		$ret = null;
		$query = 'SELECT ls.*, lc.`user_id`, lc.`title`, lc.`content_type_guid`, uu.`login`, uu.`real_name`
				  FROM `'.BIT_DB_PREFIX.'liberty_structures` ls
				  INNER JOIN `'.BIT_DB_PREFIX.'liberty_content` lc ON (ls.`content_id`=lc.`content_id`)
				  LEFT JOIN `'.BIT_DB_PREFIX.'users_users` uu ON ( uu.`user_id` = lc.`user_id` )' . $where;

		if( $result = $this->mDb->query( $query, $bindVars ) ) {
			$ret = $result->fetchRow();
		}

		if( !empty( $contentTypes[$ret['content_type_guid']] ) ) {
			// quick alias for code readability
			$type = &$contentTypes[$ret['content_type_guid']];
			if( empty( $type['content_object'] ) && !empty( $gBitSystem->mPackages[$type['handler_package']] ) ) {
				// create *one* object for each object *type* to  call virtual methods.
				$handlerFile = $gBitSystem->mPackages[$type['handler_package']]['path'].$type['handler_file'];
				if( file_exists( $handlerFile ) ) {
					include_once $handlerFile;
					if( class_exists( $type['handler_class'] ) ) {
						$type['content_object'] = new $type['handler_class']();
					}
				}
			}
			if( !empty( $type['content_object'] ) && is_object( $type['content_object'] ) ) {
				$ret['title'] = $type['content_object']->getTitleFromHash( $ret );
			}
		}

		$sStructureNodeCache['structure_id'][$ret['structure_id']] = $ret;
		$sStructureNodeCache['content_id'][$ret['content_id']] = $ret;

		return $ret;
	}

	public function hasViewPermission( $pVerifyAccessControl=true ) {
		$ret = false;
		if( !empty( $this->mInfo['content_object'] ) && is_a( $this->mInfo['content_object'], 'LibertyContent' ) ) {
			return $this->mInfo['content_object']->hasUpdatePermission( $pVerifyAccessControl ) || empty( $this->mInfo['content_object']->mViewContentPerm ) || $this->mInfo['content_object']->hasUserPermission( $this->mInfo['content_object']->mViewContentPerm, $pVerifyAccessControl );
		}
		return $ret;
	}

	/**
	 * Check if a node is a root node
	 *
	 * @return bool true on success, false on failure
	 */
	public function isRootNode() {
		$ret = false;
		if( @$this->verifyId( $this->mInfo['structure_id'] ) ) {
			$ret = $this->mInfo['root_structure_id'] == $this->mInfo['structure_id'];
		}
		return $ret;
	}

	/**
	 * get the title of the root node
	 *
	 * @return object
	 */
	public function getRootObject() {
		$ret = null;
		if( !empty( $this->mInfo['root_structure_id'] ) ) {
			if( $rootHash = $this->mDb->getRow( "SELECT * FROM `".BIT_DB_PREFIX."liberty_structures` WHERE `structure_id` = ?", [ $this->mInfo['root_structure_id'] ] ) ) {
				$ret = $this->getLibertyObject( $rootHash['content_id'] );
			}
		}
		return $ret;
	}

	/**
	 * get the title of the root node
	 *
	 * @return string
	 */
	public function getRootTitle() {
		$ret = '';
		if( isset( $this->mInfo['structure_path'][0]['title'] ) ) {
			$ret = $this->mInfo['structure_path'][0]['title'];
		}
		return $ret;
	}

	/**
	 * if you only have a structure id and you want to figure out the root structure id, use this
	 *
	 * @param array $pParamHash['structure_id'] is the structure id from which you want to figure out the root structure id
	 * @return void. updates $pParamHash['root_structure_id'] by reference
	 */
	public function getRootStructureId( &$pParamHash ) {
		if( BitBase::verifyId( $pParamHash['root_structure_id'] ) ) {
//			$pParamHash['root_structure_id'] = $pParamHash['root_structure_id'];
		} elseif( BitBase::verifyId( $this->mInfo['root_structure_id'] ) ) {
			$pParamHash['root_structure_id'] = $this->mInfo['root_structure_id'];
		} elseif( BitBase::verifyId( $pParamHash['structure_id'] ) ) {
			$pParamHash['root_structure_id'] = $this->mDb->getOne( "SELECT `root_structure_id` FROM `".BIT_DB_PREFIX."liberty_structures` WHERE `structure_id` = ?", [ $pParamHash['structure_id'] ] );
		} else {
			$pParamHash['root_structure_id'] = null;
		}
	}

	// This is a utility function mainly used for upgrading sites.
	public function setTreeRoot( $pRootId, $pTree ) {
		foreach( $pTree as $structRow ) {
			$this->mDb->query( "UPDATE `".BIT_DB_PREFIX."liberty_structures` SET `root_structure_id`=? WHERE `structure_id`=?", [ $pRootId, $structRow["structure_id"] ] );
			if( !empty( $structRow["sub"] ) ) {
				$this->setTreeRoot( $pRootId, $structRow["sub"] );
			}
		}
	}

	public function isValid() {
		return $this->verifyId( $this->mStructureId );
	}

	/**
	 * loadNavigation
	 *
	 * @return void
	 */
	public function loadNavigation() {
		if( $this->isValid() ) {
			$this->mInfo["prev"] = null;
			// Get structure info for this page
			if( !$this->isRootNode() && ($prev_structure_id = $this->getPrevStructureNode( $this->mStructureId )) ) {
				$this->mInfo["prev"]   = $this->getNode($prev_structure_id);
			}
			$next_structure_id = $this->getNextStructureNode( $this->mStructureId );
			$this->mInfo["next"] = null;
			if (isset($next_structure_id)) {
				$this->mInfo["next"]   = $this->getNode( $next_structure_id) ;
			}
			$this->mInfo["parent"] = $this->getStructureParentInfo( $this->mStructureId );
			$this->mInfo["home"]   = $this->getNode( $this->mStructureId );
		}
	}

	public function loadPath() {
		if( $this->isValid() ) {
			$this->mInfo['structure_path'] = $this->getPath( $this->mStructureId );
		}
		return !empty( $this->mInfo['structure_path'] );
	}

	/**
	* This can be used to construct a path from the structure head to the requested page.
	* @return array an array of page_info arrays.
	*/
	public function getPath( $pStructureId ) {
		$structure_path = [];
		$page_info = $this->getNode($pStructureId);

		if ($page_info["parent_id"]) {
			$structure_path = $this->getPath($page_info["parent_id"]);
		}
		$structure_path[] = $page_info;
		return $structure_path;
	}

	/**
	* Get full structure from database
	* @param $pStructureId structure for which we want structure
	* @return array full structure
	*/
	public function getStructure( &$pParamHash ) {
		global $gBitSystem, $gLibertySystem;
		// make sure we have the correct id to get the entire structure
		LibertyStructure::getRootStructureId( $pParamHash );

		$ret = [];

		if( BitBase::verifyId( $pParamHash['root_structure_id'] ) ) {
			// Get all nodes for this structure
			$query = "SELECT ls.*, lc.`user_id`, lc.`title`, lc.`content_type_guid`, uu.`login`, uu.`real_name`
				FROM `".BIT_DB_PREFIX."liberty_structures` ls
				INNER JOIN `".BIT_DB_PREFIX."liberty_content` lc ON ( ls.`content_id` = lc.`content_id` )
				INNER JOIN `".BIT_DB_PREFIX."users_users` uu ON ( uu.`user_id` = lc.`user_id` )
				WHERE ls.`root_structure_id` = ? ORDER BY `pos` ASC";
			$result = $this->mDb->query( $query, [ $pParamHash['root_structure_id'] ] );

			$subs = [];
			$row_max = $result->numRows();
			$contentTypes = $gLibertySystem->mContentTypes;
			while( $res = $result->fetchRow() ) {
				$aux = [];
				$aux = $res;
				if( !empty( $contentTypes[$res['content_type_guid']] ) ) {
					// quick alias for code readability
					$type = &$contentTypes[$res['content_type_guid']];
					if( empty( $type['content_object'] ) ) {
						// create *one* object for each object *type* to  call virtual methods.
						$handlerFile = $gBitSystem->mPackages[$type['handler_package']]['path'].$type['handler_file'];
						if( file_exists( $handlerFile ) ) {
							include_once $handlerFile;
							if( class_exists( $type['handler_class'] ) ) {
								$type['content_object'] = new $type['handler_class']();
							}
						}
					}
					if( !empty( $pParamHash['thumbnail_size'] ) ) {
						$aux['content_object'] = new $type['handler_class']( null, $aux['content_id'] );
						if( $aux['content_object']->load() ) {
							$aux['thumbnail_url'] = $aux['content_object']->getThumbnailUrl( $pParamHash['thumbnail_size'] );
						}
					}
					if( !empty( $type['content_object'] ) && is_object( $type['content_object'] ) ) {
						$aux['title'] = $type['content_object']->getTitleFromHash( $aux );
					}
					$ret[$aux['structure_id']] = $aux;
				}
			}
		}
		return $ret;
	}

	/**
	* Get all structures in $pStructureHash that have a given parent_id
	* @param $pStructureHash full menu as supplied by '$this->getItemList( $pMenuId );'
	* @return array of nodes with a given parent_id
	*/
	public function getChildNodes( $pStructureHash, $pParentId = 0 ) {
		$ret = [];
		if( !empty( $pStructureHash ) ) {
			foreach( $pStructureHash as $node ) {
				if( $node['parent_id'] == $pParentId ) {
					$ret[] = $node;
				}
			}
		}
		return $ret;
	}

	/**
	* Create a usable array from the data in the database from getStructure()
	* @param $pStructureHash raw structure data from database
	* @return array nicely formatted and cleaned up structure array
	*/
	public function createSubTree( $pStructureHash, $pParentId = 0, $pParentPos = '', $pLevel = 0 ) {
		$ret = [];
		// get all child menu Nodes for this structure_id
		$children = LibertyStructure::getChildNodes( $pStructureHash, $pParentId );
		$pos = 1;
		$row_max = count( $children );

		// we need to insert the root structure item first
		if (!$pLevel && !empty($pStructureHash)) {
			foreach( $pStructureHash as $node ) {
			  if( ( $pParentId == 0 && $node['structure_id'] == $node['root_structure_id'] ) || $node['structure_id'] == $pParentId) {
					$aux		  = $node;
					$aux["first"] = true;
					$aux["last"]  = true;
					$aux["pos"]   = '';
					$aux["level"] = $pLevel++;
					$ret[] = $aux;
				}
			}
		}

		foreach( $children as $node ) {
			$aux = $node;
			$aux['level'] = $pLevel;
			$aux['first'] = $pos == 1;
			$aux['last']  = false;
			$aux['has_children'] = false;
			$aux["pos"] = strlen( $pParentPos ) == 0 ? "$pos" : $pParentPos . '.' . "$pos";

			$ret[] = $aux;
			//Recursively add any children
			$subs = LibertyStructure::createSubTree( $pStructureHash, $node['structure_id'], $aux['pos'],  $pLevel + 1 );
			if( !empty( $subs ) ) {
				$r = array_pop( $ret );
				$r['has_children'] = true;
				array_push( $ret, $r );
				$ret = array_merge( $ret, $subs );
			}

			if( $pos == $row_max ) {
				$aux['structure_id'] = $node['structure_id'];
				$aux['first'] = false;
				$aux['last']  = true;
				$ret[] = $aux;
			}
			$pos++;
		}
		return $ret;
	}

	// get sub tree of $pStructureId
	public function getSubTree( $pStructureId, $pRootTree = false, $pListHash=null ) {
		global $gLibertySystem, $gBitSystem;
		$ret = [];
		if( BitBase::verifyId( $pStructureId ) ) {
			$pListHash['structure_id'] = $pStructureId;
			$structureHash = $this->getStructure( $pListHash );
			$ret = $this->createSubTree( $structureHash, $pRootTree ? $pListHash['root_structure_id'] : $pStructureId );
		}
		return $ret;
	}

	/**
	 * getList
	 *
	 * @param array $pListHash
	 * @return array
	 */
	public function getList( array &$pListHash ): array {
		global $gBitSystem, $gBitUser;

		BitBase::prepGetList( $pListHash );

		if( !empty( $pListHash['find'] ) ) {
			$findesc = '%' . $pListHash['find'] . '%';
			$mid = " (`parent_id` is null or `parent_id`=0) and (lc.`title` like ?)";
			$bindVars=[$findesc];
		} else {
			$mid = " (`parent_id` is null or `parent_id`=0) ";
			$bindVars=[];
		}

		if( @$this->verifyId( $pListHash['user_id'] ?? 0 ) ) {
			$mid .= " AND lc.`user_id` = ? ";
			array_push( $bindVars, $pListHash['user_id'] );
		}

		if( empty( $pListHash['sort_mode'] ) ) {
			$pListHash['sort_mode'] = 'last_modified_desc';
		}

		if( !empty( $pListHash['content_type_guid'] ) ) {
			$mid .= " AND lc.`content_type_guid`=? ";
			array_push( $bindVars, $pListHash['content_type_guid'] );
		}
		$query = "SELECT ls.`structure_id`, ls.`parent_id`, ls.`content_id`, `page_alias`, `pos`, lc.`title`, `data`, `last_modified`, lc.`modifier_user_id`, `ip`, lc.`user_id` AS `creator_user_id`, uu.`login` AS `creator_user`, uu.`real_name` , uu.`email`
				  FROM `".BIT_DB_PREFIX."liberty_structures` ls INNER JOIN `".BIT_DB_PREFIX."liberty_content` lc ON ( ls.`content_id` = lc.`content_id` ) INNER JOIN `".BIT_DB_PREFIX."users_users` uu ON ( lc.`user_id` = uu.`user_id` )
				  WHERE $mid
				  ORDER BY ".$this->mDb->convertSortmode($pListHash['sort_mode']);
		$query_cant = "SELECT count(*)
					   FROM `".BIT_DB_PREFIX."liberty_structures` ls INNER JOIN `".BIT_DB_PREFIX."liberty_content` lc ON ( ls.`content_id` = lc.`content_id` )
					   WHERE $mid";
		$result = $this->mDb->query($query,$bindVars,$pListHash['max_records'],$pListHash['offset']);
		$cant = $this->mDb->getOne($query_cant,$bindVars);
		$ret = [];

		while ($res = $result->fetchRow()) {
			$res['webhelp'] = $gBitSystem->isPackageActive( 'bithelp' ) && file_exists(BITHELP_PKG_PATH.$res['title'].'/index.html') ? 'y' : 'n';
			$ret[] = $res;
		}

		$retval = [];
		$retval["data"] = $ret;
		$retval["cant"] = $cant;
		return $retval;
	}

	/**
	* clean up and prepare a complete structure in the form of arrays about to be stored
	* @param array $pParamHash is a set of arrays generated by the DynamicTree javascript tree builder
	* @return bool true on success, false on failure where $this->mErrors will contain the reason why it failed
	*/
	public function verifyStructure( array &$pParamHash ): bool {
		$storeNodes = [];
		if( !static::getParameter( $pParamHash, 'root_structure_id' ) ) {
			$pParamHash['root_structure_id'] = $this->getField( 'root_structure_id' );
		}

		if( !static::verifyId( $pParamHash['root_structure_id'] ) ) {
			$this->mErrors['verify_structure'] = KernelTools::tra( "Unknown root structure." );
		} else {
			if( !empty( $pParamHash['structure_json'] ) ) {
//vd( $pParamHash['structure_json'] );
				// {{{ closure here to recursively parse json
				$parseStructureJson = function($treeHash, $pRootId, $pParentId, $pLevel, $pPos ) use ( &$parseStructureJson, &$storeNodes ) {
					if( is_numeric( key( $treeHash ) ) ) {
						$pos = 1;
						foreach( array_keys( $treeHash ) as $i ) {
							// Array of nodes came in. Process each at the same level
							$parseStructureJson( $treeHash[$i], $pRootId, $pParentId, $pLevel, $pos++ );
						}
					} else {
						// Base node with data
						$storeNode = [];
						$storeNode['root_structure_id'] = $pRootId;
						$storeNode['parent_id'] = $pParentId;
						$storeNode['structure_id'] = $treeHash['structure_id'];
						$storeNode['content_id'] = $treeHash['content_id'];
						$storeNode['pos'] = $pPos++;
						//$storeNode['page_alias']
						$storeNode['structure_level'] = $pLevel;
						$storeNodes[$treeHash['structure_id']] = $storeNode;
						if( !empty( $treeHash['children'] ) ) {
							// current node has children, recurse down in
							$parseStructureJson( $treeHash['children'], $pRootId, $treeHash['structure_id'], $pLevel + 1, 1 );
						}
					}
				};
				// }}}

				$parseStructureJson( $pParamHash['structure_json'], $this->mStructureId, $pParamHash['root_structure_id'], 1, 1 );
				if( !empty( $storeNodes ) ) {
					$pParamHash['structure_store'] = $storeNodes;
				}
//vd( $storeNodes );
			}

			// deprecated flat tree store, code is unused AFAIK.-- spiderr
			if( !empty( $pParamHash['structure'] ) ) {
	//			LibertyStructure::embellishStructureHash( $pParamHash['structure'] );
				$structureHash = LibertyStructure::flattenStructureHash( $pParamHash['structure'] );

				// replace the 'tree' in the data array with the root_structure_id
				foreach( $pParamHash['data'] as $structure_id => $node ) {
					if( !BitBase::verifyId( $pParamHash['data'][$structure_id]['parent_id'] ) ) {
						$pParamHash['data'][$structure_id]['parent_id'] = $pParamHash['root_structure_id'];
					}
				}

				foreach( $structureHash as $node ) {
					if( BitBase::verifyId( $node['structure_id'] ) ) {
						$pParamHash['structure_store'][$node['structure_id']] = array_merge( $node, $pParamHash['data'][$node['structure_id']] );
						$pParamHash['structure_store'][$node['structure_id']]['root_structure_id'] = $pParamHash['root_structure_id'];
					}
				}
			}
		}

		if( empty( $pParamHash['structure_store'] ) ) {
			$this->mErrors['verify_structure'] = KernelTools::tra( "There are no changes to save." );
		}

		// clear up some memory
		if( !empty( $pParamHash['structure_json'] ) ) { unset( $pParamHash['structure_json'] ); }
		if( !empty( $pParamHash['structure'] ) )        { unset( $pParamHash['structure'] ); }
		if( !empty( $pParamHash['data'] ) )             { unset( $pParamHash['data'] ); }

		return count( $this->mErrors ) == 0;
	}

	/**
	* store a complete structure where ever subarray contains a complete node as it should go into the database
	* @param array $pParamHash is an array with subarrays, each representing a structure node ready to associativley inserted into the database
	* @return true on success, false on failure where $this->mErrors will contain the reason why it failed
	*/
	public function storeStructure( array $pParamHash ) {
		if( $this->verifyStructure( $pParamHash ) ) {
			// now that the structure is ready to be stored, we remove the old structure first and then insert the new one.
			$this->StartTrans();
			$query = "DELETE FROM `".BIT_DB_PREFIX."liberty_structures` WHERE `root_structure_id`=? AND `structure_id`!=?";
			$result = $this->mDb->query( $query, [ (int)$pParamHash['root_structure_id'], (int)$pParamHash['root_structure_id'] ] );
			foreach( $pParamHash['structure_store'] as $node ) {
				$this->mDb->associateInsert( BIT_DB_PREFIX."liberty_structures", $node );
			}
			$this->CompleteTrans();
		}
		return count( $this->mErrors ) == 0;
	}

	/**
	* make sure the array only contains one level depth
	* @param array $pParamHash contains a nested set of arrays with structure_id and pos values set
	* @return array flattened array
	*/
	public function flattenStructureHash( array $pParamHash, $i = -10000 ) {
		$ret = [];
		foreach( $pParamHash as $key => $node ) {
			if( !empty( $node ) && count( $node ) > 2 ) {
				$ret = array_merge( $ret, LibertyStructure::flattenStructureHash( $node, $i ) );
				$i++;
			} elseif( count( $node ) == 2 ) {
				$ret[] = $node;
				$i++;
			} else {
				$ret[$i][$key] = $node;
			}
		}
		return $ret;
	}

	/**
	* cleans up and reorganises data in nested array where keys are structure_id
	* @param array $pParamHash contains a nested set of arrays with structure_id as key
	* @return void reorganised array in $pParamHash
	*/
	public function embellishStructureHash( array &$pParamHash ) {
		$pos = 1;
		foreach( $pParamHash as $structure_id => $node ) {
			if( !empty( $node ) ) {
				LibertyStructure::embellishStructureHash( $node );
			}
			$node['pos'] = $pos++;
			$node['structure_id'] = $structure_id;
			$pParamHash[$structure_id] = $node;
		}
	}

	/**
	* prepare a structure node for storage in the database
	* @param array $pParamHash contains various settings for the node to be stored
	* @return bool true on success, false on failure where $this->mErrors will contain the reason why it failed
	*/
	public function verifyNode( array &$pParamHash ): bool {
		if( !@$this->verifyId( $pParamHash['content_id'] ) ) {
			$this->mErrors['content'] = 'Could not store structure. Invalid content id. '.$pParamHash['content_id'];
		} else {
			if( !@$this->verifyId( $pParamHash['parent_id'] ) ) {
				$pParamHash['parent_id'] = 0;
			}
			if( empty( $pParamHash['alias'] ) ) {
				$pParamHash['alias'] = '';
			}
			$pParamHash['max'] = isset( $pParamHash['after_ref_id'] )
				? $this->mDb->getOne("select `pos` from `".BIT_DB_PREFIX."liberty_structures` where `structure_id`=?",[(int)$pParamHash['after_ref_id']])
				: $this->mDb->getOne("select max(`pos`) from `".BIT_DB_PREFIX."liberty_structures` where `parent_id`=?",[(int)$pParamHash['parent_id']]);

			if( $pParamHash['max'] > 0 ) {
				// For example, if max is 5 then we are inserting after position 5 so we'll insert 5 and move all the others
				$query = "update `".BIT_DB_PREFIX."liberty_structures` set `pos`=`pos`+1 where `pos`>? and `parent_id`=?";
				$result = $this->mDb->query($query,[(int)$pParamHash['max'], (int)$pParamHash['parent_id']]);
			}
			$pParamHash['max']++;

			if( $pParamHash['structure_id'] = $this->mDb->getOne( "SELECT `structure_id` FROM `".BIT_DB_PREFIX."liberty_structures` WHERE `root_structure_id`=? and `content_id`=?", [ $pParamHash['root_structure_id'], $pParamHash['content_id'] ] ) ) {
				$this->mErrors[] = KernelTools::tra( 'Content already exists in structure.' )." ($pParamHash[structure_id])";
			}
		}
		return count( $this->mErrors ) == 0;
	}

	/**  Create a structure entry with the given name
	* @param array $pParamHash
	*		- parent_id The parent entry to add this to. If null, create new structure.
	*		- after_ref_id The entry to add this one after. If null, put it in position 0.
	*		- name The wiki page to reference
	*		- alias An alias for the wiki page name.
	* @return int the new entries structure_id or 0 if not created.
	*/
	public function storeNode( array &$pParamHash ):int {
		global $gBitSystem;
		$ret = 0;
		// If the page doesn't exist then create a new wiki page!
		$now = $gBitSystem->getUTCTime();
//		$created = $this->create_page($name, 0, '', $now, KernelTools::tra('created from structure'), 'system', '0.0.0.0', '');
		// if were not trying to add a duplicate structure head
		if ( $this->verifyNode( $pParamHash ) ) {
			$this->StartTrans();

			//Create a new structure entry
			$pParamHash['structure_id'] = $this->mDb->GenID( 'liberty_structures_id_seq' );
			if( !@$this->verifyId( $pParamHash['root_structure_id'] ) ) {
				$pParamHash['root_structure_id'] = $pParamHash['structure_id'];
			}
			$query = "INSERT INTO `".BIT_DB_PREFIX."liberty_structures`( `structure_id`, `parent_id`,`content_id`, `root_structure_id`, `page_alias`, `pos` ) values(?,?,?,?,?,?)";
			$result = $this->mDb->query( $query, [ $pParamHash['structure_id'], $pParamHash['parent_id'], (int)$pParamHash['content_id'], (int)$pParamHash['root_structure_id'], $pParamHash['alias'], $pParamHash['max'] ] );
			$this->CompleteTrans();
			$ret = (int) $pParamHash['structure_id'];
		}
			//vd( $this->mErrors );

		return $ret;
	}

	/**
	 * moveNodeWest
	 *
	 * @return void
	 */
	public function moveNodeWest(): void {
		if( $this->isValid() ) {
			//If there is a parent and the parent isnt the structure root node.
			$this->StartTrans();
			if( @$this->verifyId( $this->mInfo["parent_id"] ) ) {
				$parentNode = $this->getNode( $this->mInfo["parent_id"] );
				if( @$this->verifyId( $parentNode['parent_id'] ) ) {
					//Make a space for the node after its parent
					$query = "update `".BIT_DB_PREFIX."liberty_structures` set `pos`=`pos`+1 where `pos`>? and `parent_id`=?";
					$this->mDb->query( $query, [ $parentNode['pos'], $parentNode['parent_id'] ] );
					//Move the node up one level
					$query = "update `".BIT_DB_PREFIX."liberty_structures` set `parent_id`=?, `pos`=(? + 1) where `structure_id`=?";
					$this->mDb->query($query, [ $parentNode['parent_id'], $parentNode['pos'], $this->mStructureId ] );
				}
			}
			$this->CompleteTrans();
		}
	}

	/**
	 * moveNodeEast
	 *
	 * @return void
	 */
	public function moveNodeEast() {
		if( $this->isValid() ) {
			$this->StartTrans();
			$query = "select `structure_id`, `pos` from `".BIT_DB_PREFIX."liberty_structures` where `pos`<? and `parent_id`=? order by `pos` desc";
			$result = $this->mDb->query($query,[$this->mInfo["pos"], (int)$this->mInfo["parent_id"]]);
			if ($previous = $result->fetchRow()) {
				//Get last child nodes for previous sibling
				$query = "select `pos` from `".BIT_DB_PREFIX."liberty_structures` where `parent_id`=? order by `pos` desc";
				$result = $this->mDb->query($query,[(int)$previous["structure_id"]]);
				$pos = ($res = $result->fetchRow()) ? $res["pos"] : 0;

				$query = "update `".BIT_DB_PREFIX."liberty_structures` set `parent_id`=?, `pos`=(? + 1) where `structure_id`=?";
				$this->mDb->query( $query, [ (int)$previous["structure_id"], (int)$pos, (int)$this->mStructureId ] );
				//Move nodes up below that had previous parent and pos
				$query = "update `".BIT_DB_PREFIX."liberty_structures` set `pos`=`pos`-1 where `pos`>? and `parent_id`=?";
				$this->mDb->query( $query, [ $this->mInfo['pos'], $this->mInfo['parent_id'] ] );
			}
			$this->CompleteTrans();
		}
	}

	/**
	 * moveNodeSouth
	 *
	 * @return void
	 */
	public function moveNodeSouth() {
		if( $this->isValid() ) {
			$this->StartTrans();
			$query = "select `structure_id`, `pos` from `".BIT_DB_PREFIX."liberty_structures` where `pos`>? and `parent_id`=? order by `pos` asc";
			$result = $this->mDb->query($query,[(int)$this->mInfo["pos"], (int)$this->mInfo["parent_id"]]);
			$res = $result->fetchRow();
			if ($res) {
				//Swap position values
				$query = "update `".BIT_DB_PREFIX."liberty_structures` set `pos`=? where `structure_id`=?";
				$this->mDb->query($query,[(int)$this->mInfo["pos"], (int)$res["structure_id"]] );
				$this->mDb->query($query,[(int)$res["pos"], (int)$this->mInfo["structure_id"]] );
			}
			$this->CompleteTrans();
		}
	}

	/**
	 * moveNodeNorth
	 *
	 * @return void
	 */
	public function moveNodeNorth() {
		if( $this->isValid() ) {
			$this->StartTrans();
			$query = "select `structure_id`, `pos` from `".BIT_DB_PREFIX."liberty_structures` where `pos`<? and `parent_id`=? order by `pos` desc";
			$result = $this->mDb->query($query,[(int)$this->mInfo["pos"], (int)$this->mInfo["parent_id"]]);
			$res = $result->fetchRow();
			if ($res) {
				//Swap position values
				$query = "update `".BIT_DB_PREFIX."liberty_structures` set `pos`=? where `structure_id`=?";
				$this->mDb->query($query,[(int)$res["pos"], (int)$this->mInfo["structure_id"]] );
				$this->mDb->query($query,[(int)$this->mInfo["pos"], (int)$res["structure_id"]] );
			}
			$this->CompleteTrans();
		}
	}

	// ============== OLD struct_lib STUFF

	public function removeStructureNode( $structure_id, $delete=false ) {
		// Now recursively remove
		if( @$this->verifyId( $structure_id ) ) {
			$query = "SELECT *
					  FROM `".BIT_DB_PREFIX."liberty_structures`
					  WHERE `parent_id`=?";
			$result = $this->mDb->query( $query, [ (int)$structure_id ] );
			// Iterate down through the child nodes
			while( $res = $result->fetchRow() ) {
				$this->removeStructureNode( $res["structure_id"], $delete );
			}

			// Only delete a page if other structures arent referencing it
			if( $delete ) {
				$page_info = $this->getNode( $structure_id );
				$query = "SELECT COUNT(*) FROM `".BIT_DB_PREFIX."liberty_structures` WHERE `content_id`=?";
				$count = $this->mDb->getOne( $query, [ (int)$page_info["page_id"] ] );
// @TODO Build missing function
//if( $count = 1 ) {
//					$this->remove_all_versions( $page_info["page_id"] );
//				}
			}

			// If we are removing the root node, remove the entry in liberty_content as well
			$query = "SELECT `content_id`
					  FROM `".BIT_DB_PREFIX."liberty_structures`
					  WHERE `structure_id`=? AND `structure_id`=`root_structure_id`";
			$content_id = $this->mDb->getOne( $query, [ (int)$structure_id ] );

			// Delete the liberty_content stuff
			$lc = new LibertyContent();
			$lc->expunge();

			// Remove the structure node
			$query = "DELETE FROM `".BIT_DB_PREFIX."liberty_structures` WHERE `structure_id`=?";
			$result = $this->mDb->query( $query, [ (int)$structure_id ] );
			return true;
		}
	}

	/**
	 * Returns an array of info about the parent
	 *
	 * @param array $structure_id
	 * @return array
	 */
	public function getStructureParentInfo($structure_id) {
		$parent_id = $this->mDb->getOne( "SELECT `parent_id` FROM `".BIT_DB_PREFIX."liberty_structures` WHERE `structure_id`=?", [ (int)$structure_id ] );

		if( !BitBase::verifyId( $parent_id ) ) {
			return [];
		}

		return $this->getNode( $parent_id );
	}

	/**
	 * getContentIds
	 *
	 * @param array $pStructureId
	 * @param array $pToc
	 * @param float $pLevel
	 * @return void
	 */
	public function getContentIds( $pStructureId, &$pToc, $pLevel=0 ) {
		$ret = [];

		$query = "SELECT * from `".BIT_DB_PREFIX."liberty_structures` where `parent_id`=? ORDER BY pos, page_alias, content_id";
		$result = $this->mDb->query( $query, [ (int)$pStructureId ] );
		while ( $row = $result->fetchRow() ) {
			array_push( $pToc, $row['content_id'] );
			$this->getContentIds( $row['structure_id'], $pToc, ++$pLevel );
		}
	}

	/**
	 * getContentArray
	 *
	 * @param array $pStructureId
	 * @param array $pToc
	 * @param float $pLevel
	 * @return void
	 */
	public function getContentArray( $pStructureId, &$pToc, $pLevel=0 ) {
		$query = "SELECT * from `".BIT_DB_PREFIX."liberty_structures` where `structure_id`=?";
		$result = $this->mDb->query( $query, [ (int)$pStructureId ] );
		while ( $row = $result->fetchRow() ) {
			array_push( $pToc, $row['content_id'] );
			$this->getContentIds( $pStructureId, $pToc, $pLevel );
		}
	}

	/**
	 * exportHtml
	 *
	 * @return array
	 */
	public function exportHtml() {
		$ret = [];
		$toc = [];
		$this->getContentArray( $this->mStructureId, $toc );
		if( count( $toc ) ) {
			foreach( $toc as $conId ) {
				if( $viewContent = LibertyBase::getLibertyObject( $conId ) ) {
					$ret[] = [
						'type'       => $viewContent->mContentTypeGuid,
						'landscape'  => false,
						'url'        => $viewContent->getDisplayUrl(),
						'content_id' => $viewContent->mContentId,
					];
				}
			}
		}
		return $ret;
	}

	public function isInStructure( $pContentId ) {
		$ret = false;
		if( $this->isValid() ) {
			$ret = $this->mDb->getOne( "SELECT structure_id FROM `".BIT_DB_PREFIX."liberty_structures` WHERE `root_structure_id`=? AND `content_id`=?", [ $this->mStructureId, $pContentId ] );
		}
		return $ret;
	}

	public function loadStructure() {
		if( $this->isValid() ) {
			if( empty( $this->mTree ) ) {
				$this->mTree = $this->buildSubtreeToc(1);
			}
		}
		return !empty( $this->mTree );
	}

	/**
	 * buildSubtreeToc
	 *
	 * @param int $id
	 * @param string $order
	 * @param string $tocPrefix can be used to Prefix a subtree as it would start from a given number (e.g. 2.1.3)
	 * @return array
	 */
	public function buildTreeToc( $id, $order='asc', $tocPrefix='', $pPrefixDepth=1, $pDepth=1 ) {
		if( $ret[0] = $this->getNode( $id ) ) {
			$ret[0]['sub'] = $this->buildSubtreeToc( $id, $order, $tocPrefix, $pPrefixDepth, $pDepth );
		}
		return $ret;
	}

	/**
	 * buildSubtreeToc
	 *
	 * @param int $id
	 * @param string $order
	 * @param string $tocPrefix can be used to Prefix a subtree as it would start from a given number (e.g. 2.1.3)
	 * @return array
	 */
	public function buildSubtreeToc( $id, $order='asc', $tocPrefix='', $pPrefixDepth=1, $pDepth=1 ) {
		global $gLibertySystem, $gBitSystem;
		$back = [];
		$cant = $this->mDb->getOne("select count(*) from `".BIT_DB_PREFIX."liberty_structures` where `parent_id`=?",[(int)$id]);
		if ($cant) {
			$query = "SELECT `structure_id`, `root_structure_id`, `parent_id`, `page_alias`, `pos`, `structure_level`, lc.`user_id`, lc.`title`, lc.`content_type_guid`, uu.`login`, uu.`real_name`, lc.`content_id`, lc.`last_modified`, lct.*
					  FROM `".BIT_DB_PREFIX."liberty_structures` ls
						INNER JOIN `".BIT_DB_PREFIX."liberty_content` lc ON ( lc.`content_id`=ls.`content_id` )
						INNER JOIN `".BIT_DB_PREFIX."liberty_content_types` lct ON ( lc.`content_type_guid`=lct.`content_type_guid` )
						LEFT JOIN `".BIT_DB_PREFIX."users_users` uu ON ( uu.`user_id` = lc.`user_id` )
					  WHERE `parent_id`=?
					  ORDER BY ".$this->mDb->convertSortmode("pos_".$order);
			$result = $this->mDb->query($query,[(int)$id]);
			$prefix = 1;
			$contentTypes = $gLibertySystem->mContentTypes;
			while ($res = $result->fetchRow()) {
				$res['prefix']='';
				if( $pDepth >= $pPrefixDepth ) {
					$res['prefix']=($tocPrefix=='')?'':"$tocPrefix.";
					$res['prefix'].=$prefix;
				}
				$prefix++;
				if( !empty( $contentTypes[$res['content_type_guid']] ) ) {
					// quick alias for code readability
					$type = &$contentTypes[$res['content_type_guid']];
					if( empty( $type['content_object'] ) && !empty( $gBitSystem->mPackages[$type['handler_package']] ) ) {
						// create *one* object for each object *type* to  call virtual methods.
						$handlerFile = $gBitSystem->mPackages[$type['handler_package']]['path'].$type['handler_file'];
						if( file_exists( $handlerFile ) ) {
							include_once $handlerFile;
							if( class_exists( $type['handler_class'] ) ) {
								$type['content_object'] = new $type['handler_class']();
							}
						}
					}
					if( !empty( $type['content_object'] ) && is_object( $type['content_object'] ) ) {
						$res['title'] = $type['content_object']->getTitleFromHash( $res );
					}
					if ($res['structure_id'] != $id) {
						$sub = $this->buildSubtreeToc( $res['structure_id'],$order,$res['prefix'], $pPrefixDepth, $pDepth + 1 );
						if (is_array($sub)) {
							$res['sub'] = $sub;
						}
					}
				}
				$pkgPath = strtoupper( $res['handler_package'] ).'_PKG_PATH';
				if( defined( $pkgPath ) ) {
					$classFile = constant( strtoupper( $res['handler_package'] ).'_PKG_PATH' ).$res['handler_file'];
					if( file_exists( $classFile ) ) {
						require_once $classFile;
						if( class_exists( $res['handler_class'] ) ) {
							$res['display_url'] = $res['handler_class']::getDisplayUrlFromHash( $res );
						}
					}
				}
				$back[] = $res;
			}
		} else {
			return [];
		}
		return $back;
	}

	/**
	 * getToc
	 *
	 * @param string $pStructureId
	 * @param string $order
	 * @param false $showdesc
	 * @param int $numbering
	 * @param string $numberPrefix
	 * @return string
	 */
	public function getToc( $pStructureId = -2, $order='asc', $showdesc=false, $pNumberDepth=true, $numberPrefix='',$pCss='') {
		if( !@$this->verifyId( $pStructureId ) ) {
			$pStructureId = $this->mStructureId;
		}
		$structureTree = $this->buildSubtreeToc( $pStructureId, $order, $numberPrefix, $pNumberDepth );
		return '<div class="aciTree" id="structure-'.$this->mStructureId.'">'.$this->fetchToc( $structureTree, $showdesc, $pNumberDepth, $pCss ).'</div>';
	}

	/**
	 * fetchToc
	 *
	 * @param array $structureTree
	 * @param bool $showdesc
	 * @param int $numbering
	 * @return string
	 */
	public function fetchToc( $structureTree, $showdesc, $numbering, $pCss='') {
		global $gBitSmarty;
		$ret='';
		if ($structureTree != '') {
			$gBitSmarty->verifyCompileDir();
			$gBitSmarty->assign( 'structureId', $this->mStructureId );
			$ret.=$gBitSmarty->fetch( "bitpackage:liberty/structure_toc_startul.tpl");
			foreach($structureTree as $leaf) {
				//echo "<br />";print_r($leaf);echo "<br />";
				$gBitSmarty->assign('structure_tree',$leaf);
				$gBitSmarty->assign('showdesc',$showdesc);
				$gBitSmarty->assign('numbering',$numbering);
				$ret .= $gBitSmarty->fetch( "bitpackage:liberty/structure_toc_leaf.tpl");
				if(isset($leaf["sub"]) && is_array($leaf["sub"])) {
					// recurse down in - li tags are for w3c standard
					$ret .= $this->fetchToc($leaf["sub"],$showdesc,$numbering);
				}
				$ret .= '</li>';
			}
			$ret.=$gBitSmarty->fetch( "bitpackage:liberty/structure_toc_endul.tpl");
		}
		return $ret;
	}

	/**
	 * getNextStructureNode
	 *
	 * @param int $structure_id
	 * @param bool $deep
	 * @return int
	 */
	public function getNextStructureNode($structure_id, $deep = true) {
		// If we have children then get the first child
		if ($deep) {
			$query  = "SELECT `structure_id`
					   FROM `".BIT_DB_PREFIX."liberty_structures` ls
					   WHERE `parent_id`=?
					   ORDER BY ".$this->mDb->convertSortmode("pos_asc");
			$result1 = $this->mDb->query($query,[(int)$structure_id]);

			if ($result1->numRows()) {
				$res = $result1->fetchRow();
				return $res["structure_id"];
			}
		}

		// Try to get the next page with the same parent as this
		$page_info = $this->getNode($structure_id);
		$parent_id = $page_info["parent_id"];
		$page_pos = $page_info["pos"];

		if (!$parent_id)
			return -2;

		$query  = "SELECT `structure_id`
				   FROM `".BIT_DB_PREFIX."liberty_structures` ls
				   WHERE `parent_id`=? and `pos`>?
				   ORDER BY ".$this->mDb->convertSortmode("pos_asc");
		$result2 = $this->mDb->query($query,[(int)$parent_id, (int)$page_pos]);

		if ($result2->numRows()) {
			$res = $result2->fetchRow();
			return $res["structure_id"];
		}

			return $this->getNextStructureNode($parent_id, false);

	}

	/**
	 * getPrevStructureNode
	 *
	 * @param int $structure_id
	 * @param bool $deep
	 * @return int
	 */
	public function getPrevStructureNode($structure_id, $deep = false) {
		//Drill down to last child for this tree node
		if ($deep) {
			$query  = "select `structure_id` ";
			$query .= "from `".BIT_DB_PREFIX."liberty_structures` ls ";
			$query .= "where `parent_id`=? ";
			$query .= "order by ".$this->mDb->convertSortmode("pos_desc");
			$result = $this->mDb->query($query,[$structure_id]);

			if ($result->numRows()) {
				//There are more children
				$res = $result->fetchRow();
				$structure_id = $this->getPrevStructureNode($res["structure_id"], true);
			}
			return $structure_id;
		}
		// Try to get the previous page with the same parent as this
		$page_info = $this->getNode($structure_id);
		$parent_id = $page_info["parent_id"];
		$pos	   = $page_info["pos"];

		//At the top of the tree
		if (!isset($parent_id))
			return -2;

		$query  = "select `structure_id` ";
		$query .= "from `".BIT_DB_PREFIX."liberty_structures` ls ";
		$query .= "where `parent_id`=? and `pos`<? ";
		$query .= "order by ".$this->mDb->convertSortmode("pos_desc");
		$result =  $this->mDb->query($query,[(int)$parent_id, (int)$pos]);

		if ($result->numRows()) {
			//There is a previous sibling
			$res = $result->fetchRow();
			$structure_id = $this->getPrevStructureNode($res["structure_id"], true);
		}
		else {
			//No previous siblings, just the parent
			$structure_id = $parent_id;
		}
		return $structure_id;
	}

	/**
	 * Return an array of subpages
	 *
	 * @param array $pParentId
	 * @return array of child structure pages
	 */
	public function getStructureNodes( $pParentId ) {
		$ret = [];
		$query =  "SELECT `pos`, `structure_id`, `parent_id`, ls.`content_id`, lc.`title`, `page_alias`
			FROM `".BIT_DB_PREFIX."liberty_structures` ls, `".BIT_DB_PREFIX."liberty_content` lc
			WHERE ls.`content_id` = lc.`content_id` AND `parent_id`=? ";
		$query .= "order by ".$this->mDb->convertSortmode("pos_asc");
		$result = $this->mDb->query($query,[(int)$pParentId]);
		while ($res = $result->fetchRow()) {
			//$ret[] = $this->populate_page_info($res);
			$ret[] = $res;
		}
		return $ret;
	}
}