/**

 * ===============================================================

 * SourceMod (C)2004-2007 AlliedModders LLC.  All rights reserved.

 * ===============================================================

 *

 * This file is not open source and may not be copied without explicit

 * written permission of AlliedModders LLC.  This file may not be redistributed 

 * in whole or significant part.

 * For information, see LICENSE.txt or http://www.sourcemod.net/license.php

 *

 * Version: $Id$

 */

#include <stdio.h>

#include "PluginSys.h"

#include "ShareSys.h"

#include "LibrarySys.h"

#include "HandleSys.h"

#include "sourcemm_api.h"

#include "sourcemod.h"

#include "TextParsers.h"

#include "Logger.h"

#include "ExtensionSys.h"

#include "sm_srvcmds.h"

#include "sm_stringutil.h"

CPluginManager g_PluginSys;

HandleType_t g_PluginType = 0;

IdentityType_t g_PluginIdent = 0;

CPlugin::CPlugin(const char *file)

{

	static int MySerial = 0;

	m_type = PluginType_Private;

	m_status = Plugin_Uncompiled;

	m_serial = ++MySerial;

	m_plugin = NULL;

	m_errormsg[256] = '\0';

	snprintf(m_filename, sizeof(m_filename), "%s", file);

	m_handle = 0;

	m_ident = NULL;

	m_pProps = sm_trie_create();

	m_FakeNativesMissing = false;

}

CPlugin::~CPlugin()

{

	if (m_handle)

	{

		HandleSecurity sec;

		sec.pOwner = g_PluginSys.GetIdentity();

		sec.pIdentity = sec.pOwner;

		g_HandleSys.FreeHandle(m_handle, &sec);

		g_ShareSys.DestroyIdentity(m_ident);

	}

	if (m_ctx.base)

	{

		delete m_ctx.base;

		m_ctx.base = NULL;

	}

	if (m_ctx.ctx)

	{

		m_ctx.vm->FreeContext(m_ctx.ctx);

		m_ctx.ctx = NULL;

	}

	if (m_ctx.co)

	{

		m_ctx.vm->AbortCompilation(m_ctx.co);

		m_ctx.co = NULL;

	}

	if (m_plugin)

	{

		g_pSourcePawn->FreeFromMemory(m_plugin);

		m_plugin = NULL;

	}

	if (!m_pProps)

	{

		sm_trie_destroy(m_pProps);

	}

}

void CPlugin::InitIdentity()

{

	if (!m_handle)

	{

		m_ident = g_ShareSys.CreateIdentity(g_PluginIdent);

		m_handle = g_HandleSys.CreateHandle(g_PluginType, this, g_PluginSys.GetIdentity(), g_PluginSys.GetIdentity(), NULL);

		m_ctx.base->SetIdentity(m_ident);

	}

}

Handle_t CPlugin::GetMyHandle()

{

	return m_handle;

}

CPlugin *CPlugin::CreatePlugin(const char *file, char *error, size_t maxlength)

{

	char fullpath[PLATFORM_MAX_PATH+1];

	g_SourceMod.BuildPath(Path_SM, fullpath, sizeof(fullpath), "plugins/%s", file);

	FILE *fp = fopen(fullpath, "rb");

	CPlugin *pPlugin = new CPlugin(file);

	if (!fp)

	{

		if (error)

		{

			snprintf(error, maxlength, "Unable to open file");

		}

		pPlugin->m_status = Plugin_BadLoad;

		return pPlugin;

	}

	int err;

	sp_plugin_t *pl = g_pSourcePawn->LoadFromFilePointer(fp, &err);

	if (pl == NULL)

	{

		fclose(fp);

		if (error)

		{

			snprintf(error, maxlength, "Error %d while parsing plugin", err);

		}

		pPlugin->m_status = Plugin_BadLoad;

		return pPlugin;

	}

	fclose(fp);

	pPlugin->m_plugin = pl;

	return pPlugin;

}

bool CPlugin::GetProperty(const char *prop, void **ptr, bool remove/* =false */)

{

	bool exists = sm_trie_retrieve(m_pProps, prop, ptr);

	if (exists && remove)

	{

		sm_trie_delete(m_pProps, prop);

	}

	return exists;

}

bool CPlugin::SetProperty(const char *prop, void *ptr)

{

	return sm_trie_insert(m_pProps, prop, ptr);

}

ICompilation *CPlugin::StartMyCompile(IVirtualMachine *vm)

{

	if (!m_plugin)

	{

		return NULL;

	}

	/* :NOTICE: We will eventually need to change these natives

	 * for swapping in new contexts

	 */

	if (m_ctx.co || m_ctx.ctx)

	{

		return NULL;

	}

	m_status = Plugin_Uncompiled;

	m_ctx.vm = vm;

	m_ctx.co = vm->StartCompilation(m_plugin);

	return m_ctx.co;

}

void CPlugin::CancelMyCompile()

{

	if (!m_ctx.co)

	{

		return;

	}

	m_ctx.vm->AbortCompilation(m_ctx.co);

	m_ctx.co = NULL;

	m_ctx.vm = NULL;

}

bool CPlugin::FinishMyCompile(char *error, size_t maxlength)

{

	if (!m_ctx.co)

	{

		return false;

	}

	int err;

	m_ctx.ctx = m_ctx.vm->CompileToContext(m_ctx.co, &err);

	if (!m_ctx.ctx)

	{

		memset(&m_ctx, 0, sizeof(m_ctx));

		if (error)

		{

			snprintf(error, maxlength, "Failed to compile (error %d)", err);

		}

		return false;

	}

	m_ctx.base = new BaseContext(m_ctx.ctx);

	m_ctx.ctx->user[SM_CONTEXTVAR_MYSELF] = (void *)this;

	m_status = Plugin_Created;

	m_ctx.co = NULL;

	UpdateInfo();

	return true;

}

void CPlugin::SetErrorState(PluginStatus status, const char *error_fmt, ...)

{

	PluginStatus old_status = m_status;

	m_status = status;

	if (old_status == Plugin_Running)

	{

		/* Tell everyone we're now paused */

		g_PluginSys._SetPauseState(this, true);

	}

	va_list ap;

	va_start(ap, error_fmt);

	vsnprintf(m_errormsg, sizeof(m_errormsg), error_fmt, ap);

	va_end(ap);

	if (m_ctx.ctx)

	{

		m_ctx.ctx->flags |= SPFLAG_PLUGIN_PAUSED;

	}

}

void CPlugin::UpdateInfo()

{

	/* Now grab the info */

	uint32_t idx;

	IPluginContext *base = GetBaseContext();

	int err = base->FindPubvarByName("myinfo", &idx);

	memset(&m_info, 0, sizeof(m_info));

	if (err == SP_ERROR_NONE)

	{

		struct sm_plugininfo_c_t

		{

			cell_t name;

			cell_t description;

			cell_t author;

			cell_t version;

			cell_t url;

		};

		sm_plugininfo_c_t *cinfo;

		cell_t local_addr;

		base->GetPubvarAddrs(idx, &local_addr, (cell_t **)&cinfo);

		base->LocalToString(cinfo->name, (char **)&m_info.name);

		base->LocalToString(cinfo->description, (char **)&m_info.description);

		base->LocalToString(cinfo->author, (char **)&m_info.author);

		base->LocalToString(cinfo->url, (char **)&m_info.url);

		base->LocalToString(cinfo->version, (char **)&m_info.version);

	}

	m_info.author = m_info.author ? m_info.author : "";

	m_info.description = m_info.description ? m_info.description : "";

	m_info.name = m_info.name ? m_info.name : "";

	m_info.url = m_info.url ? m_info.url : "";

	m_info.version = m_info.version ? m_info.version : "";

}

void CPlugin::Call_OnPluginStart()

{

	if (m_status != Plugin_Loaded)

	{

		return;

	}

	m_status = Plugin_Running;

	cell_t result;

	IPluginFunction *pFunction = m_ctx.base->GetFunctionByName("OnPluginStart");

	if (!pFunction)

	{

		return;

	}

	pFunction->Execute(&result);

}

void CPlugin::Call_OnPluginEnd()

{

	if (m_status < Plugin_Paused)

	{

		return;

	}

	cell_t result;

	IPluginFunction *pFunction = m_ctx.base->GetFunctionByName("OnPluginEnd");

	if (!pFunction)

	{

		return;

	}

	pFunction->Execute(&result);

}

bool CPlugin::Call_AskPluginLoad(char *error, size_t maxlength)

{

	if (m_status != Plugin_Created)

	{

		return false;

	}

	m_status = Plugin_Loaded;

	int err;

	cell_t result;

	IPluginFunction *pFunction = m_ctx.base->GetFunctionByName("AskPluginLoad");

	if (!pFunction)

	{

		return true;

	}

	pFunction->PushCell(m_handle);

	pFunction->PushCell(g_PluginSys.IsLateLoadTime() ? 1 : 0);

	pFunction->PushStringEx(error, maxlength, 0, SM_PARAM_COPYBACK);

	pFunction->PushCell(maxlength);

	if ((err=pFunction->Execute(&result)) != SP_ERROR_NONE)

	{

		return false;

	}

	if (!result || m_status != Plugin_Loaded)

	{

		return false;

	}

	return true;

}

const sp_plugin_t *CPlugin::GetPluginStructure() const

{

	return m_plugin;

}

IPluginContext *CPlugin::GetBaseContext() const

{

	return m_ctx.base;

}

sp_context_t *CPlugin::GetContext() const

{

	return m_ctx.ctx;

}

const char *CPlugin::GetFilename() const

{

	return m_filename;

}

PluginType CPlugin::GetType() const

{

	return m_type;

}

const sm_plugininfo_t *CPlugin::GetPublicInfo() const

{

	return &m_info;

}

unsigned int CPlugin::GetSerial() const

{

	return m_serial;

}

PluginStatus CPlugin::GetStatus() const

{

	return m_status;

}

bool CPlugin::IsDebugging() const

{

	if (!m_ctx.ctx)

	{

		return false;

	}

	return ((m_ctx.ctx->flags & SP_FLAG_DEBUG) == SP_FLAG_DEBUG);

}

bool CPlugin::SetPauseState(bool paused)

{

	if (paused && GetStatus() != Plugin_Paused)

	{

		return false;

	} else if (!paused && GetStatus() != Plugin_Running) {

		return false;

	}

	IPluginFunction *pFunction = m_ctx.base->GetFunctionByName("OnPluginPauseChange");

	if (pFunction)

	{

		cell_t result;

		pFunction->PushCell(paused ? 1 : 0);

		pFunction->Execute(&result);

	}

	if (paused)

	{

		m_status = Plugin_Paused;

		m_ctx.ctx->flags |= SPFLAG_PLUGIN_PAUSED;

	} else {

		m_status = Plugin_Running;

		m_ctx.ctx->flags &= ~SPFLAG_PLUGIN_PAUSED;

	}

	g_PluginSys._SetPauseState(this, paused);

	return true;

}

IdentityToken_t *CPlugin::GetIdentity() const

{

	return m_ident;

}

bool CPlugin::ToggleDebugMode(bool debug, char *error, size_t maxlength)

{

	int err;

	if (!IsRunnable())

	{

		if (error)

		{

			snprintf(error, maxlength, "Plugin is not runnable.");

		}

		return false;

	}

	if (debug && IsDebugging())

	{

		if (error)

		{

			snprintf(error, maxlength, "Plugin is already in debug mode.");

		}

		return false;

	} else if (!debug && !IsDebugging()) {

		if (error)

		{

			snprintf(error, maxlength, "Plugins is already in production mode.");

		}

		return false;

	}

	ICompilation *co = g_pVM->StartCompilation(m_ctx.ctx->plugin);

	if (!g_pVM->SetCompilationOption(co, "debug", (debug) ? "1" : "0"))

	{

		if (error)

		{

			snprintf(error, maxlength, "Failed to change plugin mode (JIT failure).");

		}

		return false;

	}

	sp_context_t *new_ctx = g_pVM->CompileToContext(co, &err);

	if (new_ctx)

	{

		memcpy(new_ctx->memory, m_ctx.ctx->memory, m_ctx.ctx->mem_size);

		new_ctx->hp = m_ctx.ctx->hp;

		new_ctx->sp = m_ctx.ctx->sp;

		new_ctx->frm = m_ctx.ctx->frm;

		new_ctx->dbreak = m_ctx.ctx->dbreak;

		new_ctx->context = m_ctx.ctx->context;

		memcpy(new_ctx->user, m_ctx.ctx->user, sizeof(m_ctx.ctx->user));

		g_pVM->FreeContext(m_ctx.ctx);

		m_ctx.ctx = new_ctx;

		m_ctx.base->SetContext(new_ctx);

		UpdateInfo();

	} else {

		if (error)

		{

			snprintf(error, maxlength, "Failed to recompile plugin (JIT error %d).", err);

		}

		return false;

	}

	return true;

}

bool CPlugin::IsRunnable() const

{

	return (m_status <= Plugin_Paused) ? true : false;

}

time_t CPlugin::GetFileTimeStamp()

{

	char path[PLATFORM_MAX_PATH+1];

	g_SourceMod.BuildPath(Path_SM, path, sizeof(path), "plugins/%s", m_filename);

#ifdef PLATFORM_WINDOWS

	struct _stat s;

	if (_stat(path, &s) != 0)

#elif defined PLATFORM_POSIX

	struct stat s;

	if (stat(path, &s) != 0)

#endif

	{

		return 0;

	} else {

		return s.st_mtime;

	}

}

time_t CPlugin::GetTimeStamp() const

{

	return m_LastAccess;

}

void CPlugin::SetTimeStamp(time_t t)

{

	m_LastAccess = t;

}

void CPlugin::AddLangFile(unsigned int index)

{

	m_PhraseFiles.push_back(index);

}

size_t CPlugin::GetLangFileCount() const

{

	return m_PhraseFiles.size();

}

unsigned int CPlugin::GetLangFileByIndex(unsigned int index) const

{

	return m_PhraseFiles.at(index);

}

void CPlugin::DependencyDropped(CPlugin *pOwner)

{

	if (!m_ctx.ctx)

	{

		return;

	}

	IPluginContext *pContext = pOwner->GetBaseContext();

	List<FakeNative *>::iterator iter;

	FakeNative *pNative;

	sp_native_t *native;

	uint32_t idx;

	unsigned int unbound = 0;

	for (iter = pOwner->m_fakeNatives.begin();

		 iter != pOwner->m_fakeNatives.end();

		 iter++)

	{

		pNative = (*iter);

		/* Find this native! */

		if (m_ctx.base->FindNativeByName(pNative->name.c_str(), &idx) != SP_ERROR_NONE)

		{

			continue;

		}

		/* Unbind it */

		m_ctx.base->GetNativeByIndex(idx, &native);

		native->pfn = NULL;

		native->status = SP_NATIVE_UNBOUND;

		unbound++;

	}

	/* :IDEA: in the future, add native trapping? */

	if (unbound)

	{

		m_FakeNativesMissing = true;

		SetErrorState(Plugin_Error, "Depends on plugin: %s", pOwner->GetFilename());

	}

	m_dependsOn.remove(pOwner);

}

/*******************

 * PLUGIN ITERATOR *

 *******************/