EXT-7324 : INFRASTRUCTURE: Inventorymodel code cleanup

Superficial header file cleanup
Lots of moving functions around and recategorizing in LLInventoryModel.h
Removed some obsolete functions, changed scoping of others
Moved some static functions from LLInventoryModel into llinventoryfunctions.h

1 files changed, 27 insertions, 307 deletions

diff --git a/indra/newview/llinventorymodel.cpp b/indra/newview/llinventorymodel.cpp
index e63da1ebb9..a527694d25 100644
--- a/indra/newview/llinventorymodel.cpp
+++ b/indra/newview/llinventorymodel.cpp
@@ -319,30 +319,18 @@ void LLInventoryModel::unlockDirectDescendentArrays(const LLUUID& cat_id)
 // specifies 'type' as what it defaults to containing. The category is
 // not necessarily only for that type. *NOTE: This will create a new
 // inventory category on the fly if one does not exist.
-const LLUUID LLInventoryModel::findCategoryUUIDForType(LLFolderType::EType t, bool create_folder, bool find_in_library)
-{
-	const LLUUID &rv = findCatUUID(t, find_in_library);
-	if(rv.isNull() && isInventoryUsable() && (create_folder && !find_in_library))
-	{
-		const LLUUID &root_id = gInventory.getRootFolderID();
-		if(root_id.notNull())
-		{
-			return createNewCategory(root_id, t, LLStringUtil::null);
-		}
-	}
-	return rv;
-}
-
-// Internal method which looks for a category with the specified
-// preferred type. Returns LLUUID::null if not found.
-const LLUUID &LLInventoryModel::findCatUUID(LLFolderType::EType preferred_type, bool find_in_library) const
+const LLUUID LLInventoryModel::findCategoryUUIDForType(LLFolderType::EType preferred_type, 
+													   bool create_folder, 
+													   bool find_in_library)
 {
+	LLUUID rv = LLUUID::null;
+	
 	const LLUUID &root_id = (find_in_library) ? gInventory.getLibraryRootFolderID() : gInventory.getRootFolderID();
 	if(LLFolderType::FT_ROOT_INVENTORY == preferred_type)
 	{
-		return root_id;
+		rv = root_id;
 	}
-	if(root_id.notNull())
+	else if (root_id.notNull())
 	{
 		cat_array_t* cats = NULL;
 		cats = get_ptr_in_map(mParentChildCategoryTree, root_id);
@@ -353,12 +341,21 @@ const LLUUID &LLInventoryModel::findCatUUID(LLFolderType::EType preferred_type,
 			{
 				if(cats->get(i)->getPreferredType() == preferred_type)
 				{
-					return cats->get(i)->getUUID();
+					rv = cats->get(i)->getUUID();
+					break;
 				}
 			}
 		}
 	}
-	return LLUUID::null;
+	
+	if(rv.isNull() && isInventoryUsable() && (create_folder && !find_in_library))
+	{
+		if(root_id.notNull())
+		{
+			return createNewCategory(root_id, preferred_type, LLStringUtil::null);
+		}
+	}
+	return rv;
 }
 
 // Convenience function to create a new category. You could call
@@ -583,27 +580,6 @@ LLInventoryModel::item_array_t LLInventoryModel::collectLinkedItems(const LLUUID
 	return items;
 }
 
-// Generates a string containing the path to the item specified by
-// item_id.
-void LLInventoryModel::appendPath(const LLUUID& id, std::string& path) const
-{
-	std::string temp;
-	const LLInventoryObject* obj = getObject(id);
-	LLUUID parent_id;
-	if(obj) parent_id = obj->getParentUUID();
-	std::string forward_slash("/");
-	while(obj)
-	{
-		obj = getCategory(parent_id);
-		if(obj)
-		{
-			temp.assign(forward_slash + obj->getName() + temp);
-			parent_id = obj->getParentUUID();
-		}
-	}
-	path.append(temp);
-}
-
 bool LLInventoryModel::isInventoryUsable() const
 {
 	bool result = false;
@@ -1024,98 +1000,6 @@ void LLInventoryModel::purgeDescendentsOf(const LLUUID& id)
 	}
 }
 
-void LLInventoryModel::deleteFromServer(LLDynamicArray<LLUUID>& category_ids,
-										LLDynamicArray<LLUUID>& item_ids)
-{
-	// Store off tre UUIDS of parents which are being deleted (thus no
-	// need to increment) and the parents which are being modified. We
-	// have to increment the version of the parent with each message
-	// sent upstream since the dataserver will increment each unique
-	// parent per update message.
-	std::set<LLUUID> ignore_parents;
-	update_map_t inc_parents;
-
-	S32 i;
-	S32 count = category_ids.count();
-	BOOL start_new_message = TRUE;
-	LLMessageSystem* msg = gMessageSystem;
-	LLPointer<LLViewerInventoryCategory> cat;
-	for(i = 0; i < count; i++)
-	{
-		if(start_new_message)
-		{
-			start_new_message = FALSE;
-			msg->newMessageFast(_PREHASH_RemoveInventoryObjects);
-			msg->nextBlockFast(_PREHASH_AgentData);
-			msg->addUUIDFast(_PREHASH_AgentID, gAgent.getID());
-			msg->addUUIDFast(_PREHASH_SessionID, gAgent.getSessionID());
-		}
-		LLUUID cat_id = category_ids.get(i);
-
-		msg->nextBlockFast(_PREHASH_FolderData);
-		msg->addUUIDFast(_PREHASH_FolderID, cat_id);
-		cat = getCategory(cat_id);
-		ignore_parents.insert(cat_id);
-		addChangedMask(LLInventoryObserver::REMOVE | LLInventoryObserver::STRUCTURE, cat_id);
-		if(cat.notNull() && (ignore_parents.find(cat->getParentUUID())==ignore_parents.end()))
-		{
-			--inc_parents[cat->getParentUUID()];
-		}
-		if(msg->isSendFullFast(_PREHASH_FolderData))
-		{
-			start_new_message = TRUE;
-			msg->nextBlockFast(_PREHASH_ItemData);
-			msg->addUUIDFast(_PREHASH_ItemID, LLUUID::null);
-			gAgent.sendReliableMessage();
-			accountForUpdate(inc_parents);
-			inc_parents.clear();
-		}
-	}
-
-	count = item_ids.count();
-	std::set<LLUUID>::iterator not_ignored = ignore_parents.end();
-	LLPointer<LLViewerInventoryItem> item;
-	if((0 == count) && (!start_new_message))
-	{
-		msg->nextBlockFast(_PREHASH_ItemData);
-		msg->addUUIDFast(_PREHASH_ItemID, LLUUID::null);
-	}
-	for(i = 0; i < count; i++)
-	{
-		if(start_new_message)
-		{
-			start_new_message = FALSE;
-			msg->newMessageFast(_PREHASH_RemoveInventoryObjects);
-			msg->nextBlockFast(_PREHASH_AgentData);
-			msg->addUUIDFast(_PREHASH_AgentID, gAgent.getID());
-			msg->addUUIDFast(_PREHASH_SessionID, gAgent.getSessionID());
-			msg->nextBlockFast(_PREHASH_FolderData);
-			msg->addUUIDFast(_PREHASH_FolderID, LLUUID::null);
-		}
-		LLUUID item_id = item_ids.get(i);
-		msg->nextBlockFast(_PREHASH_ItemData);
-		msg->addUUIDFast(_PREHASH_ItemID, item_id);
-		item = getItem(item_id);
-		addChangedMask(LLInventoryObserver::REMOVE | LLInventoryObserver::STRUCTURE, item_id);
-		if(item.notNull() && (ignore_parents.find(item->getParentUUID()) == not_ignored))
-		{
-			--inc_parents[item->getParentUUID()];
-		}
-		if(msg->isSendFullFast(_PREHASH_ItemData))
-		{
-			start_new_message = TRUE;
-			gAgent.sendReliableMessage();
-			accountForUpdate(inc_parents);
-			inc_parents.clear();
-		}
-	}
-	if(!start_new_message)
-	{
-		gAgent.sendReliableMessage();
-		accountForUpdate(inc_parents);
-	}
-}
-
 // Add/remove an observer. If the observer is destroyed, be sure to
 // remove it.
 void LLInventoryModel::addObserver(LLInventoryObserver* observer)
@@ -1206,29 +1090,7 @@ void LLInventoryModel::addChangedMask(U32 mask, const LLUUID& referent)
 	}
 }
 
-// This method to prepares a set of mock inventory which provides
-// minimal functionality before the actual arrival of inventory.
-/*
-void LLInventoryModel::mock(const LLUUID& root_id)
-{
-	llinfos << "LLInventoryModel::mock() " << root_id << llendl;
-	if(root_id.isNull())
-	{
-		llwarns << "Not a valid root id" << llendl;
-		return;
-	}
-	LLPointer<LLViewerInventoryCategory> cat = new LLViewerInventoryCategory(
-		root_id,
-		LLUUID::null,
-		LLAssetType::AT_CATEGORY,
-		LLFolderType::lookupNewCategoryName(LLFolderType::FT_ROOT_INVENTORY),
-		gAgent.getID());
-	addCategory(cat);
-	gInventory.buildParentChildMap();
-}
-*/
-
-//If we get back a normal response, handle it here
+// If we get back a normal response, handle it here
 void  LLInventoryModel::fetchInventoryResponder::result(const LLSD& content)
 {	
 	start_new_inventory_observer();
@@ -1301,7 +1163,7 @@ void LLInventoryModel::fetchInventoryResponder::error(U32 status, const std::str
 	gInventory.notifyObservers("fetchinventory");
 }
 
-bool LLInventoryModel::fetchDescendentsOf(const LLUUID& folder_id)
+bool LLInventoryModel::fetchDescendentsOf(const LLUUID& folder_id) const
 {
 	if(folder_id.isNull()) 
 	{
@@ -1836,88 +1698,6 @@ bool LLInventoryModel::loadSkeleton(
 	return rv;
 }
 
-bool LLInventoryModel::loadMeat(const LLSD& options, const LLUUID& owner_id)
-{
-	llinfos << "importing inventory for " << owner_id << llendl;
-	bool rv = true;
-	for(LLSD::array_const_iterator it = options.beginArray(),
-		end = options.endArray(); it != end; ++it)
-	{
-		LLSD name = (*it)["name"];
-		LLSD item_id = (*it)["item_id"];
-		LLSD parent_id = (*it)["parent_id"];
-		LLSD asset_type = (*it)["type"];
-		LLSD data_id = (*it)["data_id"];
-		if(name.isDefined() 
-			&& item_id.isDefined()
-			&& parent_id.isDefined()
-			&& asset_type.isDefined()
-			&& data_id.isDefined())
-		{
-			LLPointer<LLViewerInventoryItem> item = new LLViewerInventoryItem;
-			item->rename(name.asString());
-			item->setUUID(item_id.asUUID());
-			item->setParent(parent_id.asUUID());
-			LLAssetType::EType type = (LLAssetType::EType)asset_type.asInteger();
-            item->setType(type);
-
-			LLSD llsd_inv_type = (*it)["inv_type"];
-			if(llsd_inv_type.isDefined())
-            {
-				LLInventoryType::EType inv_type = (LLInventoryType::EType)llsd_inv_type.asInteger();
-                item->setInventoryType(inv_type);
-            }
-
-            if(LLAssetType::AT_CALLINGCARD == type)
-            {
-                LLPermissions perm;
-				perm.init(data_id.asUUID(), owner_id, LLUUID::null, LLUUID::null);
-                item->setPermissions(perm);
-            }
-            else
-            {
-				LLPermissions default_perm;
-				default_perm.init(LLUUID::null, owner_id, LLUUID::null, LLUUID::null);
-				LLSD llsd_perm_mask = (*it)["perm_mask"];
-				if(llsd_perm_mask.isDefined())
-                {
-					PermissionMask perm_mask = llsd_perm_mask.asInteger();
-					default_perm.initMasks(
-						perm_mask, perm_mask, perm_mask, perm_mask, perm_mask);
-				}
-				else
-				{
-					default_perm.initMasks(
-						PERM_NONE, PERM_NONE, PERM_NONE, PERM_NONE, PERM_NONE);
-				}
-				item->setPermissions(default_perm);
-				item->setAssetUUID(data_id.asUUID());
-            }
-
-			LLSD flags = (*it)["flags"];
-			if(flags.isDefined())
-            {
-				// Not sure how well LLSD.asInteger() maps to 
-				// unsigned long - using strtoul()
-				item->setFlags(strtoul(flags.asString().c_str(), NULL, 0));
-            }
-
-			LLSD time = (*it)["time"];
-			if(time.isDefined())
-            {
-				item->setCreationDate(time.asInteger());
-            }
-            addItem(item);
-		}
-		else
-		{
-			llwarns << "Unable to import near " << name.asString() << llendl;
-            rv = false;
-		}
-	}
-	return rv;
-}
-
 // This is a brute force method to rebuild the entire parent-child
 // relations. The overall operation has O(NlogN) performance, which
 // should be sufficient for our needs. 
@@ -2185,73 +1965,6 @@ bool LLUUIDAndName::operator>(const LLUUIDAndName& rhs) const
 	return (mID > rhs.mID);
 }
 
-// Given the current state of the inventory items, figure out the
-// clone information. *FIX: This is sub-optimal, since we can insert
-// this information snurgically, but this makes sure the implementation
-// works before we worry about optimization.
-//void LLInventoryModel::recalculateCloneInformation()
-//{
-//	//dumpInventory();
-//
-//	// This implements a 'multi-map' like structure to keep track of
-//	// how many clones we find.
-//	typedef LLDynamicArray<LLViewerInventoryItem*> viewer_item_array_t;
-//	typedef std::map<LLUUIDAndName, viewer_item_array_t*> clone_map_t;
-//	clone_map_t clone_map;
-//	LLUUIDAndName id_and_name;
-//	viewer_item_array_t* clones = NULL;
-//	LLViewerInventoryItem* item = NULL;
-//	for(item = (LLViewerInventoryItem*)mItemMap.getFirstData();
-//		item != NULL;
-//		item = (LLViewerInventoryItem*)mItemMap.getNextData())
-//	{
-//		if(item->getType() == LLAssetType::AT_CALLINGCARD)
-//		{
-//			// if it's a calling card, we key off of the creator id, not
-//			// the asset id.
-//			id_and_name.mID = item->getCreatorUUID();
-//		}
-//		else
-//		{
-//			// if it's not a calling card, we key clones from the
-//			// asset id.
-//			id_and_name.mID = item->getAssetUUID();
-//		}
-//		if(id_and_name.mID == LLUUID::null)
-//		{
-//			continue;
-//		}
-//		id_and_name.mName = item->getName();
-//		if(clone_map.checkData(id_and_name))
-//		{
-//			clones = clone_map.getData(id_and_name);
-//		}
-//		else
-//		{
-//			clones = new viewer_item_array_t;
-//			clone_map.addData(id_and_name, clones);
-//		}
-//		clones->put(item);
-//	}
-//
-//	S32 count = 0;
-//	for(clones = clone_map.getFirstData();
-//		clones != NULL;
-//		clones = clone_map.getNextData())
-//	{
-//		count = clones->count();
-//		for(S32 i = 0; i < count; i++)
-//		{
-//			item = clones->get(i);
-//			item->setCloneCount(count - 1);
-//			//clones[i] = NULL;
-//		}
-//		delete clones;
-//	}
-//	clone_map.removeAllData();
-//	//dumpInventory();
-//}
-
 // static
 bool LLInventoryModel::loadFromFile(const std::string& filename,
 									LLInventoryModel::cat_array_t& categories,
@@ -3097,6 +2810,10 @@ static LLInventoryModel::item_array_t::iterator find_item_iter_by_uuid(LLInvento
 }
 
 // static
+// * @param[in, out] items - vector with items to be updated. It should be sorted in a right way
+// * before calling this method.
+// * @param src_item_id - LLUUID of inventory item to be moved in new position
+// * @param dest_item_id - LLUUID of inventory item before which source item should be placed.
 void LLInventoryModel::updateItemsOrder(LLInventoryModel::item_array_t& items, const LLUUID& src_item_id, const LLUUID& dest_item_id)
 {
 	LLInventoryModel::item_array_t::iterator it_src = find_item_iter_by_uuid(items, src_item_id);
@@ -3112,6 +2829,7 @@ void LLInventoryModel::updateItemsOrder(LLInventoryModel::item_array_t& items, c
 	items.insert(it_dest, src_item);
 }
 
+//* @param[in] items vector of items in order to be saved.
 void LLInventoryModel::saveItemsOrder(const LLInventoryModel::item_array_t& items)
 {
 	int sortField = 0;
@@ -3155,6 +2873,8 @@ static void rearrange_item_order_by_sort_field(LLInventoryModel::item_array_t& i
 	std::sort(items.begin(), items.end(), sort_functor);
 }
 
+// * @param source_item_id - LLUUID of the source item to be moved into new position
+// * @param target_item_id - LLUUID of the target item before which source item should be placed.
 void LLInventoryModel::rearrangeFavoriteLandmarks(const LLUUID& source_item_id, const LLUUID& target_item_id)
 {
 	LLInventoryModel::cat_array_t cats;