CWE-ou-minkata/Sources/Plasma/FeatureLib/pfPython/pyVaultNode.cpp

/*==LICENSE==*

CyanWorlds.com Engine - MMOG client, server and tools
Copyright (C) 2011  Cyan Worlds, Inc.

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

You can contact Cyan Worlds, Inc. by email legal@cyan.com
 or by snail mail at:
      Cyan Worlds, Inc.
      14617 N Newport Hwy
      Mead, WA   99021

*==LICENSE==*/
//////////////////////////////////////////////////////////////////////
//
// pyVaultNode   - a wrapper class to provide interface to the RelVaultNode
//
//////////////////////////////////////////////////////////////////////

#include "pyVaultNode.h"
#ifndef BUILDING_PYPLASMA
#include "pyVault.h"
#endif
#include "pyImage.h"
#include "pyDniCoordinates.h"
#include "pyVaultNodeRef.h"
#include "pyVaultFolderNode.h"
#include "pyVaultPlayerInfoListNode.h"
#include "pyVaultImageNode.h"
#include "pyVaultTextNoteNode.h"
#include "pyVaultAgeLinkNode.h"
#include "pyVaultChronicleNode.h"
#include "pyVaultPlayerInfoNode.h"
#include "pyVaultMarkerGameNode.h"
#include "pyVaultAgeInfoNode.h"
#include "pyVaultAgeInfoListNode.h"
#include "pyVaultPlayerNode.h"
#include "pyVaultSDLNode.h"
#ifndef BUILDING_PYPLASMA
#include "pyVaultSystemNode.h"
#endif

#include "plGImage/plMipmap.h"

#include "plVault/plVault.h"

#ifndef BUILDING_PYPLASMA
#include "pnNetCommon/plNetApp.h"
#include "plNetClientComm/plNetClientComm.h"
#endif

#include <exception>


///////////////////////////////////////////////////////////////////////////

static void __cdecl LogDumpProc (
	void *				,
	const wchar			fmt[],
	...
) {
	va_list args;
	va_start(args, fmt);
	LogMsgV(kLogDebug, fmt, args);
	va_end(args);
}

pyVaultNode::pyVaultNodeOperationCallback::pyVaultNodeOperationCallback(PyObject * cbObject)
: fCbObject( cbObject )
, fNode(nil)
, fPyNodeRef(nil)
{
	Py_XINCREF( fCbObject );
}

pyVaultNode::pyVaultNodeOperationCallback::~pyVaultNodeOperationCallback()
{
	Py_XDECREF( fCbObject );
}

void pyVaultNode::pyVaultNodeOperationCallback::VaultOperationStarted( UInt32 context )
{
	if ( fCbObject )
	{
		// Call the callback.
		if (PyObject_HasAttrString( fCbObject, "vaultOperationStarted" ))
		{
			PyObject* func = nil;
			func = PyObject_GetAttrString( fCbObject, "vaultOperationStarted" );
			if ( func )
			{
				if ( PyCallable_Check(func)>0 )
				{
					PyObject* retVal = PyObject_CallMethod(fCbObject, "vaultOperationStarted", "l", context);
					Py_XDECREF(retVal);
				}
			}
		}
	}
}


void pyVaultNode::pyVaultNodeOperationCallback::VaultOperationComplete( UInt32 context, int resultCode )
{
	if ( fCbObject )
	{
		// Call the callback.
		if (PyObject_HasAttrString( fCbObject, "vaultOperationComplete" ))
		{
			PyObject* func = nil;
			func = PyObject_GetAttrString( fCbObject, "vaultOperationComplete" );
			if ( func )
			{
				if ( PyCallable_Check(func)>0 )
				{
					PyObject * pyNode = pyVaultNode::New(fNode);
					PyObject* t = PyTuple_New(2);
					PyTuple_SetItem(t, 0, pyNode);
					PyTuple_SetItem(t, 1, fPyNodeRef);
					PyObject* retVal = PyObject_CallMethod(fCbObject, "vaultOperationComplete", "lOi", context, t, resultCode);
					Py_XDECREF(retVal);
					Py_DECREF(t);
				}
			}
		}
	}

	DEL(this);	// commit hara-kiri
}

void pyVaultNode::pyVaultNodeOperationCallback::SetNode (RelVaultNode * rvn) {
	if (rvn)
		rvn->IncRef();
	SWAP(rvn, fNode);
	if (rvn)
		rvn->DecRef();
}

RelVaultNode * pyVaultNode::pyVaultNodeOperationCallback::GetNode () {
	return fNode;
}

// only for python glue, do NOT call
pyVaultNode::pyVaultNode()
:	fNode(nil)
,	fCreateAgeGuid(nil)
,	fCreateAgeName(nil)
{
}

// should only be created from C++ side
pyVaultNode::pyVaultNode( RelVaultNode* nfsNode )
:	fNode(nfsNode)
,	fCreateAgeGuid(nil)
,	fCreateAgeName(nil)
{
	if (fNode)
		fNode->IncRef("pyVaultNode");
}

pyVaultNode::~pyVaultNode()
{
	if (fNode)
		fNode->DecRef("pyVaultNode");
	FREE(fCreateAgeGuid);
	FREE(fCreateAgeName);
}


RelVaultNode* pyVaultNode::GetNode() const
{
	return fNode;
}


// override the equals to operator
bool pyVaultNode::operator==(const pyVaultNode &vaultNode) const
{
	RelVaultNode* ours = GetNode();
	RelVaultNode* theirs = vaultNode.GetNode();
	if (ours == nil && theirs == nil)
		return true;
	if (ours == nil || theirs == nil)
		return false;
	if (ours->nodeId == theirs->nodeId)
		return true;
	return ours->Matches(theirs);
}

// public getters
UInt32	pyVaultNode::GetID( void )
{
	if (fNode)
		return fNode->nodeId;
	return 0;
}

UInt32	pyVaultNode::GetType( void )
{
	if (fNode)
		return fNode->nodeType;
	return 0;
}

UInt32	pyVaultNode::GetOwnerNodeID( void )
{
	hsAssert(false, "eric, port?");
//	if (fNode)
//		return fNode->ownerId;
	return 0;
}

PyObject* pyVaultNode::GetOwnerNode( void )
{
	hsAssert(false, "eric, port?");
/*
	if (fNode)
	{
		const plVaultPlayerInfoNode* node = fNode->GetOwnerNode();
		if (node)
			return pyVaultPlayerInfoNode::New((plVaultPlayerInfoNode*)node);
	}
*/
	// just return a None object
	PYTHON_RETURN_NONE;
}

UInt32 pyVaultNode::GetModifyTime( void )
{
	if (fNode)
		return fNode->modifyTime;
	return 0;
}

UInt32 pyVaultNode::GetCreatorNodeID( void )
{
	if (fNode)
		return fNode->creatorId;
	return 0;
}

PyObject* pyVaultNode::GetCreatorNode( void )
{
	PyObject * result = nil;
	if (fNode)
	{
		RelVaultNode * templateNode = NEWZERO(RelVaultNode);
		templateNode->IncRef();
		templateNode->SetNodeType(plVault::kNodeType_PlayerInfo);
		VaultPlayerInfoNode plrInfo(templateNode);
		plrInfo.SetPlayerId(fNode->creatorId);
		
		if (RelVaultNode * rvn = VaultGetNodeIncRef(templateNode)) {
			result = pyVaultPlayerInfoNode::New(rvn);
			rvn->DecRef();
		}
		templateNode->DecRef();			
	}
	
	if (result)
		return result;
		
	// just return a None object
	PYTHON_RETURN_NONE;
}

UInt32 pyVaultNode::GetCreateTime( void )
{
	if (fNode)
		return fNode->createTime;
	return 0;
}

UInt32 pyVaultNode::GetCreateAgeTime( void )
{
	hsAssert(false, "eric, port?");

	// for now, just return the earth-time the node was created
	return GetCreateTime();
}

const char * pyVaultNode::GetCreateAgeName( void )
{
	if (!fNode)
		return "";
		
	if (fCreateAgeName)
		return fCreateAgeName;
		
	if (fNode) {
		if (fNode->createAgeName)
			fCreateAgeName = StrDupToAnsi(fNode->createAgeName);
		else
			fCreateAgeName = StrDup("");
	}
	
	return fCreateAgeName;
}

const char * pyVaultNode::GetCreateAgeGuid( void )
{
	if (!fNode)
		return "";
		
	if (fCreateAgeGuid)
		return fCreateAgeGuid;
		
	if (fNode) {
		fCreateAgeGuid = (char*)ALLOC(64);
		GuidToString(fNode->createAgeUuid, fCreateAgeGuid, 64);
	}
	
	return fCreateAgeGuid;
}

PyObject* pyVaultNode::GetCreateAgeCoords () {
	if (!fNode)
		PYTHON_RETURN_NONE;

	return pyDniCoordinates::New(nil);		
}

void pyVaultNode::SetID( UInt32 v )
{
	hsAssert(false, "Why are you changing the node id?");
}

void pyVaultNode::SetType( int v )
{
	ASSERT(fNode);
	if (fNode->nodeId) {
		FATAL("pyVaultNode: You may not change the type of a vault node");
		return;
	}
	
	fNode->SetNodeType(v);
}

void pyVaultNode::SetOwnerNodeID( UInt32 v )
{
	hsAssert(false, "eric, implement me.");
}

void pyVaultNode::SetCreatorNodeID( UInt32 v )
{
	ASSERT(fNode);
	if (fNode->nodeId) {
		FATAL("pyVaultNode: You may not change the type of a vault node");
		return;
	}
	
	fNode->SetCreatorId(v);
}

void pyVaultNode::SetCreateAgeName( const char * v )
{
	FREE(fCreateAgeName);
	fCreateAgeName = nil;

	ASSERT(fNode);
	wchar str[MAX_PATH];
	StrToUnicode(str, v, arrsize(str));
	fNode->SetCreateAgeName(str);
}

void pyVaultNode::SetCreateAgeGuid( const char * v )
{
	FREE(fCreateAgeGuid);
	fCreateAgeGuid = nil;
	
	ASSERT(fNode);
	Uuid uuid;
	GuidFromString(v, &uuid);
	fNode->SetCreateAgeUuid(uuid);
}


/////////////////////////////////////////////////
// Vault Node API

// Add child node
PyObject* pyVaultNode::AddNode(pyVaultNode* pynode, PyObject* cbObject, UInt32 cbContext)
{
	pyVaultNodeOperationCallback * cb = NEWZERO(pyVaultNodeOperationCallback)(cbObject);

	if ( fNode && pynode && pynode->GetNode() )
	{
		// Hack the callbacks until vault notification is in place
		cb->VaultOperationStarted(cbContext);

		int hsResult = hsOK;
		if ( !pynode->GetID() )
		{
			// Block here until node is created and fetched =(
			ASSERT(pynode->GetNode()->nodeType);
			ENetError result;
			RelVaultNode * newNode = VaultCreateNodeAndWaitIncRef(
				pynode->GetNode(),
				&result
			);
			
			if (newNode) {
				newNode->IncRef();
				pynode->fNode->DecRef();
				pynode->fNode = newNode;
			}
			else {
				hsResult = hsFail;
			}
		}

		// Block here until we have the child node =(		
		VaultAddChildNodeAndWait(fNode->nodeId, pynode->fNode->nodeId, NetCommGetPlayer()->playerInt);
		
		PyObject * nodeRef = cb->fPyNodeRef = pyVaultNodeRef::New(fNode, pynode->fNode);
		Py_INCREF(nodeRef); // incref it, because we MUST return a new PyObject, and the callback "steals" the ref from us
		cb->SetNode(pynode->fNode);
		cb->VaultOperationComplete(cbContext, hsResult);
		
		return nodeRef;
	}
	else
	{
		// manually make the callback
		cb->VaultOperationStarted( cbContext );
		cb->VaultOperationComplete( cbContext, hsFail );
	}

	// just return a None object
	PYTHON_RETURN_NONE;
}

// Link a node to this one
void pyVaultNode::LinkToNode(int nodeID, PyObject* cbObject, UInt32 cbContext)
{
	pyVaultNodeOperationCallback * cb = NEWZERO(pyVaultNodeOperationCallback)( cbObject );

	if (fNode && nodeID)
	{
		// Hack the callbacks until vault notification is in place
		cb->VaultOperationStarted( cbContext );

		VaultAddChildNodeAndWait(fNode->nodeId, nodeID, NetCommGetPlayer()->playerInt);
		if (RelVaultNode * rvn = VaultGetNodeIncRef(nodeID)) {
			cb->SetNode(rvn);
			cb->fPyNodeRef = pyVaultNodeRef::New(fNode, rvn);
			rvn->DecRef();
		}

		cb->VaultOperationComplete( cbContext, hsOK );
	}
	else
	{
		// manually make the callback
		cb->VaultOperationStarted( cbContext );
		cb->VaultOperationComplete( cbContext, hsFail );
	}
}

// Remove child node
hsBool pyVaultNode::RemoveNode( pyVaultNode& pynode, PyObject* cbObject, UInt32 cbContext )
{
	pyVaultNodeOperationCallback * cb = NEWZERO(pyVaultNodeOperationCallback)( cbObject );

	if (fNode && pynode.fNode)
	{
		// Hack the callbacks until vault notification is in place
		cb->VaultOperationStarted( cbContext );

		VaultRemoveChildNode(fNode->nodeId, pynode.fNode->nodeId, nil, nil);

		cb->SetNode(pynode.fNode);
		cb->fPyNodeRef = pyVaultNodeRef::New(fNode, pynode.fNode);
		cb->VaultOperationComplete( cbContext, hsOK );
		return true;
	}
	else
	{
		// manually make the callback
		cb->VaultOperationStarted( cbContext );
		cb->VaultOperationComplete( cbContext, hsFail );
	}

	return false;
}

// Remove all child nodes
void pyVaultNode::RemoveAllNodes( void )
{
	if (!fNode)
		return;
		
	ARRAY(unsigned) nodeIds;
	fNode->GetChildNodeIds(&nodeIds, 1);
	for (unsigned i = 0; i < nodeIds.Count(); ++i)
		VaultRemoveChildNode(fNode->nodeId, nodeIds[i], nil, nil);
}

// Add/Save this node to vault
void pyVaultNode::Save(PyObject* cbObject, UInt32 cbContext)
{
	// If the node doesn't have an id, then use it as a template to create the node in the vault,
	// otherwise just ignore the save request since vault nodes are now auto-saved.
	if (!fNode->nodeId && fNode->nodeType) {
		ENetError result;
		if (RelVaultNode * node = VaultCreateNodeAndWaitIncRef(fNode, &result)) {
			fNode->DecRef();
			fNode = node;
		}
	}
	pyVaultNodeOperationCallback * cb = NEWZERO(pyVaultNodeOperationCallback)( cbObject );
	cb->SetNode(fNode);
	cb->VaultOperationStarted( cbContext );
	cb->VaultOperationComplete( cbContext, hsOK );
}

// Save this node and all child nodes that need saving.
void pyVaultNode::SaveAll(PyObject* cbObject, UInt32 cbContext)
{
	// Nodes are now auto-saved
	pyVaultNodeOperationCallback * cb = NEWZERO(pyVaultNodeOperationCallback)( cbObject );
	cb->VaultOperationStarted( cbContext );
	cb->VaultOperationComplete( cbContext, hsOK );
}

void pyVaultNode::ForceSave()
{
	if (!fNode->nodeId && fNode->nodeType) {
		ENetError result;
		if (RelVaultNode * node = VaultCreateNodeAndWaitIncRef(fNode, &result)) {
			fNode->DecRef();
			fNode = node;
		}
	}
	else
		VaultForceSaveNodeAndWait(fNode);
}

// Send this node to the destination client node. will be received in it's inbox folder.
void pyVaultNode::SendTo(UInt32 destClientNodeID, PyObject* cbObject, UInt32 cbContext )
{
	pyVaultNodeOperationCallback * cb = NEWZERO(pyVaultNodeOperationCallback)( cbObject );

	if (fNode)
	{
		// If the node doesn't have an id, then use it as a template to create the node in the vault,
		if (!fNode->nodeId && fNode->nodeType) {
			ENetError result;
			if (RelVaultNode * node = VaultCreateNodeAndWaitIncRef(fNode, &result)) {
				fNode->DecRef();
				fNode = node;
			}
		}	

		// Hack the callbacks until vault notification is in place
		cb->VaultOperationStarted( cbContext );

		VaultSendNode(fNode, destClientNodeID);

		cb->VaultOperationComplete( cbContext, hsOK );
	}
	else
	{
		// manually make the callback
		cb->VaultOperationStarted( cbContext );
		cb->VaultOperationComplete( cbContext, hsFail );
	}
}

// Get all child nodes, simulating a NodeRef list for legacy compatibility
PyObject* pyVaultNode::GetChildNodeRefList()
{
	// create the list
	PyObject* pyEL = PyList_New(0);

	// fill in the elements list of this folder
	if (fNode)
	{
		ARRAY(RelVaultNode*)	nodes;
		fNode->GetChildNodesIncRef(
			1,
			&nodes
		);
		
		for (unsigned i = 0; i < nodes.Count(); ++i) {
			PyObject* elementObj = pyVaultNodeRef::New(fNode, nodes[i]);
			PyList_Append(pyEL, elementObj);
			Py_DECREF(elementObj);
			nodes[i]->DecRef();
		}
	}

	return pyEL;
}

int pyVaultNode::GetChildNodeCount()
{
	if (!fNode)
		return 0;
		
	ARRAY(unsigned)	nodeIds;
	fNode->GetChildNodeIds(&nodeIds, 1);
	
	return nodeIds.Count();
}

// Get the client ID from my Vault client.
UInt32	pyVaultNode::GetClientID()
{
	hsAssert(false, "eric, port me");
	return 0;
}


bool pyVaultNode::HasNode( UInt32 nodeID )
{
	if ( fNode )
		return fNode->IsParentOf( nodeID, 1 );
	return false;
}

PyObject * pyVaultNode::GetNode2( UInt32 nodeID ) const
{
	PyObject * result = nil;
	if ( fNode )
	{
		RelVaultNode * templateNode = NEWZERO(RelVaultNode);
		templateNode->IncRef();
		templateNode->SetNodeId(nodeID);
		if (RelVaultNode * rvn = fNode->GetChildNodeIncRef(templateNode, 1)) {
			result = pyVaultNodeRef::New(fNode, rvn);
			rvn->DecRef();
		}
		templateNode->DecRef();
	}
	
	if (result)
		return result;

	PYTHON_RETURN_NONE;
}

PyObject* pyVaultNode::FindNode( pyVaultNode * templateNode )
{
	PyObject * result = nil;
	if ( fNode && templateNode->fNode )
	{
		if (RelVaultNode * rvn = fNode->GetChildNodeIncRef(templateNode->fNode, 1)) {
			result = pyVaultNode::New(rvn);
			rvn->DecRef();
		}
	}
	
	if (result)
		return result;

	PYTHON_RETURN_NONE;
}

PyObject * pyVaultNode::GetChildNode (unsigned nodeId) {

	if (!fNode)
		PYTHON_RETURN_NONE;
		
	RelVaultNode * templateNode = NEWZERO(RelVaultNode);
	templateNode->IncRef();
	templateNode->SetNodeId(nodeId);
	RelVaultNode * rvn = fNode->GetChildNodeIncRef(templateNode, 1);
	templateNode->DecRef();
	
	if (rvn) {
		PyObject * result = pyVaultNode::New(rvn);
		rvn->DecRef();
		return result;
	}

	PYTHON_RETURN_NONE;
}


// all the upcasting...

PyObject* pyVaultNode::UpcastToFolderNode()
{
	if (!fNode)
		PYTHON_RETURN_NONE;
	if (
		fNode->nodeType != plVault::kNodeType_Folder &&
		fNode->nodeType != plVault::kNodeType_AgeInfoList &&
		fNode->nodeType != plVault::kNodeType_PlayerInfoList
		)
		PYTHON_RETURN_NONE;

	return pyVaultFolderNode::New(fNode);
}

PyObject* pyVaultNode::UpcastToPlayerInfoListNode()
{
	if (!fNode)
		PYTHON_RETURN_NONE;
	if (fNode->nodeType != plVault::kNodeType_PlayerInfoList)
		PYTHON_RETURN_NONE;

	return pyVaultPlayerInfoListNode::New(fNode);
}

PyObject* pyVaultNode::UpcastToImageNode()
{
	if (!fNode)
		PYTHON_RETURN_NONE;
	if (fNode->nodeType != plVault::kNodeType_Image)
		PYTHON_RETURN_NONE;

	return pyVaultImageNode::New(fNode);
}

PyObject* pyVaultNode::UpcastToTextNoteNode()
{
	if (!fNode)
		PYTHON_RETURN_NONE;
	if (fNode->nodeType != plVault::kNodeType_TextNote)
		PYTHON_RETURN_NONE;

	return pyVaultTextNoteNode::New(fNode);
}

PyObject* pyVaultNode::UpcastToAgeLinkNode()
{
	if (!fNode)
		PYTHON_RETURN_NONE;
	if (fNode->nodeType != plVault::kNodeType_AgeLink)
		PYTHON_RETURN_NONE;

	return pyVaultAgeLinkNode::New(fNode);
}

PyObject* pyVaultNode::UpcastToChronicleNode()
{
	if (!fNode)
		PYTHON_RETURN_NONE;
	if (fNode->nodeType != plVault::kNodeType_Chronicle)
		PYTHON_RETURN_NONE;

	return pyVaultChronicleNode::New(fNode);
}

PyObject* pyVaultNode::UpcastToPlayerInfoNode()
{
	if (!fNode)
		PYTHON_RETURN_NONE;
	if (fNode->nodeType != plVault::kNodeType_PlayerInfo)
		PYTHON_RETURN_NONE;

	return pyVaultPlayerInfoNode::New(fNode);
}

PyObject* pyVaultNode::UpcastToMarkerGameNode()
{
	if (!fNode)
		PYTHON_RETURN_NONE;
	if (fNode->nodeType != plVault::kNodeType_MarkerGame)
		PYTHON_RETURN_NONE;

	return pyVaultMarkerGameNode::New(fNode);
}

PyObject* pyVaultNode::UpcastToAgeInfoNode()
{
	if (!fNode)
		PYTHON_RETURN_NONE;
	if (fNode->nodeType != plVault::kNodeType_AgeInfo)
		PYTHON_RETURN_NONE;

	return pyVaultAgeInfoNode::New(fNode);
}

PyObject* pyVaultNode::UpcastToAgeInfoListNode()
{
	if (!fNode)
		PYTHON_RETURN_NONE;
	if (fNode->nodeType != plVault::kNodeType_AgeInfoList)
		PYTHON_RETURN_NONE;

	return pyVaultAgeInfoListNode::New(fNode);
}

PyObject* pyVaultNode::UpcastToSDLNode()
{
	if (!fNode)
		PYTHON_RETURN_NONE;
	if (fNode->nodeType != plVault::kNodeType_SDL)
		PYTHON_RETURN_NONE;

	return pyVaultSDLNode::New(fNode);
}

PyObject* pyVaultNode::UpcastToPlayerNode()
{
	if (!fNode)
		PYTHON_RETURN_NONE;
	if (fNode->nodeType != plVault::kNodeType_VNodeMgrPlayer)
		PYTHON_RETURN_NONE;

	return pyVaultPlayerNode::New(fNode);
}

#ifndef BUILDING_PYPLASMA
PyObject* pyVaultNode::UpcastToSystemNode()
{
	if (!fNode)
		PYTHON_RETURN_NONE;
	if (fNode->nodeType != plVault::kNodeType_System)
		PYTHON_RETURN_NONE;

	return pyVaultSystemNode::New(fNode);
}
#endif