dvander@2168: /**
dvander@2168:  * vim: set ts=4 :
dvander@2168:  * =============================================================================
dvander@2168:  * SourceMod Admin Help Plugin
dvander@2168:  * Displays and searches SourceMod commands and descriptions.
dvander@2168:  *
dvander@2168:  * SourceMod (C)2004-2008 AlliedModders LLC.  All rights reserved.
dvander@2168:  * =============================================================================
dvander@2168:  *
dvander@2168:  * This program is free software; you can redistribute it and/or modify it under
dvander@2168:  * the terms of the GNU General Public License, version 3.0, as published by the
dvander@2168:  * Free Software Foundation.
dvander@2168:  * 
dvander@2168:  * This program is distributed in the hope that it will be useful, but WITHOUT
dvander@2168:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
dvander@2168:  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
dvander@2168:  * details.
dvander@2168:  *
dvander@2168:  * You should have received a copy of the GNU General Public License along with
dvander@2168:  * this program.  If not, see <http://www.gnu.org/licenses/>.
dvander@2168:  *
dvander@2168:  * As a special exception, AlliedModders LLC gives you permission to link the
dvander@2168:  * code of this program (as well as its derivative works) to "Half-Life 2," the
dvander@2168:  * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
dvander@2168:  * by the Valve Corporation.  You must obey the GNU General Public License in
dvander@2168:  * all respects for all other code used.  Additionally, AlliedModders LLC grants
dvander@2168:  * this exception to all derivative works.  AlliedModders LLC defines further
dvander@2168:  * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
dvander@2168:  * or <http://www.sourcemod.net/license.php>.
dvander@2168:  *
dvander@2168:  * Version: $Id$
dvander@2168:  */
dvander@2168: 
dvander@2168: #pragma semicolon 1
dvander@2168: 
dvander@2168: #include <sourcemod>
dvander@2168: 
dvander@2168: #define COMMANDS_PER_PAGE	10
dvander@2168: 
dvander@2168: public Plugin:myinfo = 
dvander@2168: {
dvander@2168: 	name = "Admin Help",
dvander@2168: 	author = "AlliedModders LLC",
dvander@2168: 	description = "Display command information",
dvander@2168: 	version = SOURCEMOD_VERSION,
dvander@2168: 	url = "http://www.sourcemod.net/"
dvander@2168: };
dvander@2168: 
dvander@2168: public OnPluginStart()
dvander@2168: {
dvander@2168: 	LoadTranslations("common.phrases");
dvander@2168: 	LoadTranslations("adminhelp.phrases");
dvander@2168: 	RegConsoleCmd("sm_help", HelpCmd, "Displays SourceMod commands and descriptions");
dvander@2168: 	RegConsoleCmd("sm_searchcmd", HelpCmd, "Searches SourceMod commands");
dvander@2168: }
dvander@2168: 
dvander@2168: public Action:HelpCmd(client, args)
dvander@2168: {
dvander@2168: 	decl String:arg[64], String:CmdName[20];
dvander@2168: 	new PageNum = 1;
dvander@2168: 	new bool:DoSearch;
dvander@2168: 
dvander@2168: 	GetCmdArg(0, CmdName, sizeof(CmdName));
dvander@2168: 
dvander@2168: 	if (GetCmdArgs() >= 1)
dvander@2168: 	{
dvander@2168: 		GetCmdArg(1, arg, sizeof(arg));
dvander@2168: 		StringToIntEx(arg, PageNum);
dvander@2168: 		PageNum = (PageNum <= 0) ? 1 : PageNum;
dvander@2168: 	}
dvander@2168: 
dvander@2168: 	DoSearch = (strcmp("sm_help", CmdName) == 0) ? false : true;
dvander@2168: 
dvander@2168: 	if (GetCmdReplySource() == SM_REPLY_TO_CHAT)
dvander@2168: 	{
dvander@2168: 		ReplyToCommand(client, "[SM] %t", "See console for output");
dvander@2168: 	}
dvander@2168: 
dvander@2168: 	decl String:Name[64];
dvander@2168: 	decl String:Desc[255];
dvander@2168: 	decl String:NoDesc[128];
dvander@2168: 	new Flags;
dvander@2168: 	new Handle:CmdIter = GetCommandIterator();
dvander@2168: 
dvander@2168: 	FormatEx(NoDesc, sizeof(NoDesc), "%t", "No description available");
dvander@2168: 
dvander@2168: 	if (DoSearch)
dvander@2168: 	{
dvander@2168: 		new i = 1;
dvander@2168: 		while (ReadCommandIterator(CmdIter, Name, sizeof(Name), Flags, Desc, sizeof(Desc)))
dvander@2168: 		{
dvander@2168: 			if ((StrContains(Name, arg, false) != -1) && CheckCommandAccess(client, Name, Flags))
dvander@2168: 			{
dvander@2168: 				PrintToConsole(client, "[%03d] %s - %s", i++, Name, (Desc[0] == '\0') ? NoDesc : Desc);
dvander@2168: 			}
dvander@2168: 		}
dvander@2168: 
dvander@2168: 		if (i == 1)
dvander@2168: 		{
dvander@2168: 			PrintToConsole(client, "%t", "No matching results found");
dvander@2168: 		}
dvander@2168: 	} else {
dvander@2168: 		PrintToConsole(client, "%t", "SM help commands");		
dvander@2168: 
dvander@2168: 		/* Skip the first N commands if we need to */
dvander@2168: 		if (PageNum > 1)
dvander@2168: 		{
dvander@2168: 			new i;
dvander@2168: 			new EndCmd = (PageNum-1) * COMMANDS_PER_PAGE - 1;
dvander@2168: 			for (i=0; ReadCommandIterator(CmdIter, Name, sizeof(Name), Flags, Desc, sizeof(Desc)) && i<EndCmd; )
dvander@2168: 			{
dvander@2168: 				if (CheckCommandAccess(client, Name, Flags))
dvander@2168: 				{
dvander@2168: 					i++;
dvander@2168: 				}
dvander@2168: 			}
dvander@2168: 
dvander@2168: 			if (i == 0)
dvander@2168: 			{
dvander@2168: 				PrintToConsole(client, "%t", "No commands available");
dvander@2168: 				CloseHandle(CmdIter);
dvander@2168: 				return Plugin_Handled;
dvander@2168: 			}
dvander@2168: 		}
dvander@2168: 
dvander@2168: 		/* Start printing the commands to the client */
dvander@2168: 		new i;
dvander@2168: 		new StartCmd = (PageNum-1) * COMMANDS_PER_PAGE;
dvander@2168: 		for (i=0; ReadCommandIterator(CmdIter, Name, sizeof(Name), Flags, Desc, sizeof(Desc)) && i<COMMANDS_PER_PAGE; )
dvander@2168: 		{
dvander@2168: 			if (CheckCommandAccess(client, Name, Flags))
dvander@2168: 			{
dvander@2168: 				i++;
dvander@2168: 				PrintToConsole(client, "[%03d] %s - %s", i+StartCmd, Name, (Desc[0] == '\0') ? NoDesc : Desc);
dvander@2168: 			}
dvander@2168: 		}
dvander@2168: 
dvander@2168: 		if (i == 0)
dvander@2168: 		{
dvander@2168: 			PrintToConsole(client, "%t", "No commands available");
dvander@2168: 		} else {
dvander@2168: 			PrintToConsole(client, "%t", "Entries n - m in page k", StartCmd+1, i+StartCmd, PageNum);
dvander@2168: 		}
dvander@2168: 
dvander@2168: 		/* Test if there are more commands available */
dvander@2168: 		if (ReadCommandIterator(CmdIter, Name, sizeof(Name), Flags, Desc, sizeof(Desc)) && CheckCommandAccess(client, Name, Flags))
dvander@2168: 		{
dvander@2168: 			PrintToConsole(client, "%t", "Type sm_help to see more", PageNum+1);
dvander@2168: 		}
dvander@2168: 	}
dvander@2168: 
dvander@2168: 	CloseHandle(CmdIter);
dvander@2168: 
dvander@2168: 	return Plugin_Handled;
dvander@2168: }