core/MenuStyle_Valve.cpp
author Kyle Sanderson <kyle.leet@gmail.com>
Thu Jul 18 20:34:43 2013 -0400 (2013-07-18)
changeset 3955 763d59fe6d77
parent 3854 8abb0924497b
permissions -rw-r--r--
Added many missing handle security checks (bug 5595, r=psychonic).
dvander@769
     1
/**
dvander@769
     2
 * vim: set ts=4 :
ds@1330
     3
 * =============================================================================
dvander@1231
     4
 * SourceMod
ds@1947
     5
 * Copyright (C) 2004-2008 AlliedModders LLC.  All rights reserved.
ds@1330
     6
 * =============================================================================
dvander@769
     7
 *
ds@1330
     8
 * This program is free software; you can redistribute it and/or modify it under
ds@1330
     9
 * the terms of the GNU General Public License, version 3.0, as published by the
ds@1330
    10
 * Free Software Foundation.
dvander@1231
    11
 * 
ds@1330
    12
 * This program is distributed in the hope that it will be useful, but WITHOUT
ds@1330
    13
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
ds@1330
    14
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
ds@1330
    15
 * details.
dvander@1231
    16
 *
ds@1330
    17
 * You should have received a copy of the GNU General Public License along with
ds@1330
    18
 * this program.  If not, see <http://www.gnu.org/licenses/>.
dvander@1231
    19
 *
ds@1330
    20
 * As a special exception, AlliedModders LLC gives you permission to link the
ds@1330
    21
 * code of this program (as well as its derivative works) to "Half-Life 2," the
ds@1330
    22
 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
ds@1330
    23
 * by the Valve Corporation.  You must obey the GNU General Public License in
ds@1330
    24
 * all respects for all other code used.  Additionally, AlliedModders LLC grants
ds@1330
    25
 * this exception to all derivative works.  AlliedModders LLC defines further
ds@1330
    26
 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
ds@1330
    27
 * or <http://www.sourcemod.net/license.php>.
dvander@769
    28
 *
dvander@769
    29
 * Version: $Id$
dvander@769
    30
 */
dvander@769
    31
dvander@769
    32
#include "sm_stringutil.h"
dvander@769
    33
#include "PlayerManager.h"
dvander@769
    34
#include "MenuStyle_Valve.h"
dvander@769
    35
#include "PlayerManager.h"
dvander@769
    36
#include "ConCmdManager.h"
dvander@769
    37
dvander@769
    38
SH_DECL_HOOK4_void(IServerPluginHelpers, CreateMessage, SH_NOATTRIB, false, edict_t *, DIALOG_TYPE, KeyValues *, IServerPluginCallbacks *);
dvander@769
    39
dvander@769
    40
ValveMenuStyle g_ValveMenuStyle;
dvander@778
    41
extern const char *g_OptionNumTable[];
dvander@778
    42
extern const char *g_OptionCmdTable[];
dvander@769
    43
CallClass<IServerPluginHelpers> *g_pSPHCC = NULL;
dvander@769
    44
dvander@775
    45
ValveMenuStyle::ValveMenuStyle() : m_players(new CValveMenuPlayer[256+1])
dvander@769
    46
{
dvander@769
    47
}
dvander@769
    48
dvander@775
    49
CBaseMenuPlayer *ValveMenuStyle::GetMenuPlayer(int client)
dvander@775
    50
{
dvander@775
    51
	return &m_players[client];
dvander@775
    52
}
dvander@775
    53
faluco@1541
    54
bool ValveMenuStyle::OnClientCommand(int client, const char *cmdname, const CCommand &cmd)
dvander@769
    55
{
faluco@1541
    56
	if (strcmp(cmdname, "sm_vmenuselect") == 0)
dvander@769
    57
	{
faluco@1541
    58
		int key_press = atoi(cmd.Arg(1));
dvander@769
    59
		g_ValveMenuStyle.ClientPressedKey(client, key_press);
dvander@769
    60
		return true;
dvander@769
    61
	}
dvander@769
    62
dvander@769
    63
	return false;
dvander@769
    64
}
dvander@769
    65
dvander@769
    66
void ValveMenuStyle::OnSourceModAllInitialized()
dvander@769
    67
{
skamonkey@3854
    68
#if SOURCE_ENGINE != SE_DOTA
dvander@769
    69
	g_Players.AddClientListener(this);
kyle@3819
    70
	SH_ADD_HOOK(IServerPluginHelpers, CreateMessage, serverpluginhelpers, SH_MEMBER(this, &ValveMenuStyle::HookCreateMessage), false);
dvander@769
    71
	g_pSPHCC = SH_GET_CALLCLASS(serverpluginhelpers);
skamonkey@3854
    72
#endif
dvander@769
    73
}
dvander@769
    74
dvander@769
    75
void ValveMenuStyle::OnSourceModShutdown()
dvander@769
    76
{
skamonkey@3854
    77
#if SOURCE_ENGINE != SE_DOTA
dvander@769
    78
	SH_RELEASE_CALLCLASS(g_pSPHCC);
kyle@3819
    79
	SH_REMOVE_HOOK(IServerPluginHelpers, CreateMessage, serverpluginhelpers, SH_MEMBER(this, &ValveMenuStyle::HookCreateMessage), false);
dvander@769
    80
	g_Players.RemoveClientListener(this);
skamonkey@3854
    81
#endif
dvander@769
    82
}
dvander@769
    83
dvander@769
    84
void ValveMenuStyle::HookCreateMessage(edict_t *pEdict,
dvander@769
    85
									   DIALOG_TYPE type,
dvander@769
    86
									   KeyValues *kv,
dvander@769
    87
									   IServerPluginCallbacks *plugin)
dvander@769
    88
{
dvander@769
    89
	if (type != DIALOG_MENU)
dvander@769
    90
	{
dvander@769
    91
		return;
dvander@769
    92
	}
dvander@769
    93
ds@2400
    94
	int client = IndexOfEdict(pEdict);
dvander@769
    95
	if (client < 1 || client > 256)
dvander@769
    96
	{
dvander@769
    97
		return;
dvander@769
    98
	}
dvander@769
    99
dvander@769
   100
	CValveMenuPlayer *player = &m_players[client];
dvander@769
   101
	
dvander@769
   102
	/* We don't care if the player is in a menu because, for all intents and purposes,
dvander@769
   103
	 * the menu is completely private.  Instead, we just figure out the level we'll need
dvander@769
   104
	 * in order to override it.
dvander@769
   105
	 */
dvander@769
   106
	player->curPrioLevel = kv->GetInt("level", player->curPrioLevel);
dvander@769
   107
dvander@769
   108
	/* Oh no! What happens if we got a menu that overwrites ours?! */
dvander@769
   109
	if (player->bInMenu)
dvander@769
   110
	{
dvander@769
   111
		/* Okay, let the external menu survive for now.  It may live another 
dvander@769
   112
		 * day to avenge its grandfather, killed in the great Menu Interruption
dvander@769
   113
		 * battle.
dvander@769
   114
		 */
dvander@1005
   115
		_CancelClientMenu(client, MenuCancel_Interrupted, true);
dvander@769
   116
	}
dvander@769
   117
}
dvander@769
   118
dvander@787
   119
IMenuPanel *ValveMenuStyle::CreatePanel()
dvander@769
   120
{
dvander@769
   121
	return new CValveMenuDisplay();
dvander@769
   122
}
dvander@769
   123
dvander@790
   124
IBaseMenu *ValveMenuStyle::CreateMenu(IMenuHandler *pHandler, IdentityToken_t *pOwner)
dvander@769
   125
{
dvander@790
   126
	return new CValveMenu(pHandler, pOwner);
dvander@769
   127
}
dvander@769
   128
dvander@769
   129
const char *ValveMenuStyle::GetStyleName()
dvander@769
   130
{
dvander@769
   131
	return "valve";
dvander@769
   132
}
dvander@769
   133
dvander@769
   134
unsigned int ValveMenuStyle::GetMaxPageItems()
dvander@769
   135
{
dvander@769
   136
	return 8;
dvander@769
   137
}
dvander@769
   138
dvander@787
   139
void ValveMenuStyle::SendDisplay(int client, IMenuPanel *display)
dvander@769
   140
{
dvander@775
   141
	m_players[client].curPrioLevel--;
dvander@775
   142
	CValveMenuDisplay *vDisplay = (CValveMenuDisplay *)display;
dvander@775
   143
	vDisplay->SendRawDisplay(client, m_players[client].curPrioLevel, m_players[client].menuHoldTime);
dvander@769
   144
}
dvander@769
   145
dvander@787
   146
bool ValveMenuStyle::DoClientMenu(int client, IMenuPanel *menu, IMenuHandler *mh, unsigned int time)
dvander@769
   147
{
dvander@1605
   148
	if (vsp_interface == NULL)
dvander@769
   149
	{
dvander@769
   150
		return false;
dvander@769
   151
	}
dvander@769
   152
dvander@775
   153
	return BaseMenuStyle::DoClientMenu(client, menu, mh, time);
dvander@769
   154
}
dvander@769
   155
dvander@1474
   156
bool ValveMenuStyle::DoClientMenu(int client, CBaseMenu *menu, unsigned int first_item, IMenuHandler *mh, unsigned int time)
dvander@769
   157
{
dvander@1605
   158
	if (vsp_interface == NULL)
dvander@769
   159
	{
dvander@775
   160
		mh->OnMenuStart(menu);
dvander@769
   161
		mh->OnMenuCancel(menu, client, MenuCancel_NoDisplay);
dvander@997
   162
		mh->OnMenuEnd(menu, MenuEnd_Cancelled);
dvander@769
   163
		return false;
dvander@769
   164
	}
dvander@769
   165
dvander@1474
   166
	return BaseMenuStyle::DoClientMenu(client, menu, first_item, mh, time);
dvander@769
   167
}
dvander@769
   168
dvander@1766
   169
unsigned int ValveMenuStyle::GetApproxMemUsage()
dvander@1766
   170
{
dvander@1766
   171
	return sizeof(ValveMenuStyle) + (sizeof(CValveMenuPlayer) * 257);
dvander@1766
   172
}
dvander@1766
   173
dvander@769
   174
CValveMenuDisplay::CValveMenuDisplay()
dvander@769
   175
{
dvander@769
   176
	m_pKv = NULL;
dvander@769
   177
	Reset();
dvander@769
   178
}
dvander@769
   179
dvander@769
   180
CValveMenuDisplay::CValveMenuDisplay(CValveMenu *pMenu)
dvander@769
   181
{
dvander@769
   182
	m_pKv = NULL;
dvander@769
   183
	Reset();
dvander@769
   184
	m_pKv->SetColor("color", pMenu->m_IntroColor);
dvander@769
   185
	m_pKv->SetString("title", pMenu->m_IntroMsg);
dvander@769
   186
}
dvander@769
   187
dvander@776
   188
void CValveMenuDisplay::DeleteThis()
dvander@776
   189
{
dvander@776
   190
	delete this;
dvander@776
   191
}
dvander@776
   192
dvander@769
   193
CValveMenuDisplay::~CValveMenuDisplay()
dvander@769
   194
{
dvander@769
   195
	m_pKv->deleteThis();
dvander@769
   196
}
dvander@769
   197
dvander@769
   198
IMenuStyle *CValveMenuDisplay::GetParentStyle()
dvander@769
   199
{
dvander@769
   200
	return &g_ValveMenuStyle;
dvander@769
   201
}
dvander@769
   202
dvander@769
   203
void CValveMenuDisplay::Reset()
dvander@769
   204
{
dvander@769
   205
	if (m_pKv)
dvander@769
   206
	{
dvander@769
   207
		m_pKv->deleteThis();
dvander@769
   208
	}
dvander@769
   209
	m_pKv = new KeyValues("menu");
dvander@769
   210
	m_NextPos = 1;
dvander@769
   211
	m_TitleDrawn = false;
dvander@769
   212
}
dvander@769
   213
dvander@840
   214
unsigned int CValveMenuDisplay::GetCurrentKey()
dvander@840
   215
{
dvander@840
   216
	return m_NextPos;
dvander@840
   217
}
dvander@840
   218
dvander@840
   219
bool CValveMenuDisplay::SetCurrentKey(unsigned int key)
dvander@840
   220
{
dvander@840
   221
	if (key < m_NextPos || key > 9)
dvander@840
   222
	{
dvander@840
   223
		return false;
dvander@840
   224
	}
dvander@840
   225
dvander@840
   226
	m_NextPos = key;
dvander@840
   227
dvander@840
   228
	return true;
dvander@840
   229
}
dvander@840
   230
dvander@769
   231
bool CValveMenuDisplay::SetExtOption(MenuOption option, const void *valuePtr)
dvander@769
   232
{
dvander@769
   233
	if (option == MenuOption_IntroMessage)
dvander@769
   234
	{
dvander@769
   235
		m_pKv->SetString("title", (const char *)valuePtr);
dvander@769
   236
		return true;
dvander@769
   237
	} else if (option == MenuOption_IntroColor) {
dvander@769
   238
		int *array = (int *)valuePtr;
dvander@769
   239
		m_pKv->SetColor("color", Color(array[0], array[1], array[2], array[3]));
dvander@769
   240
		return true;
dvander@775
   241
	} else if (option == MenuOption_Priority) {
dvander@775
   242
		m_pKv->SetInt("level", *(int *)valuePtr);
dvander@775
   243
		return true;
dvander@769
   244
	}
dvander@769
   245
dvander@769
   246
	return false;
dvander@769
   247
}
dvander@769
   248
dvander@769
   249
bool CValveMenuDisplay::CanDrawItem(unsigned int drawFlags)
dvander@769
   250
{
dvander@769
   251
	/**
dvander@769
   252
	 * ITEMDRAW_RAWLINE - We can't draw random text, and this doesn't add a slot,
dvander@769
   253
	 *  so it's completely safe to ignore it.
dvander@769
   254
	 * -----------------------------------------
dvander@769
   255
	 */
dvander@769
   256
	if (drawFlags & ITEMDRAW_RAWLINE)
dvander@769
   257
	{
dvander@769
   258
		return false;
dvander@769
   259
	}
dvander@769
   260
dvander@769
   261
	/**
dvander@769
   262
	 * Special cases, explained in DrawItem()
dvander@769
   263
	 */
dvander@769
   264
	if ((drawFlags & ITEMDRAW_NOTEXT)
dvander@769
   265
		|| (drawFlags & ITEMDRAW_SPACER))
dvander@769
   266
	{
dvander@769
   267
		return true;
dvander@769
   268
	}
dvander@769
   269
dvander@769
   270
	/**
dvander@769
   271
	 * We can't draw disabled text.  We could bump the position, but we
dvander@769
   272
	 * want DirectDraw() to find some actual items to display.
dvander@769
   273
	 */
dvander@769
   274
	if (drawFlags & ITEMDRAW_DISABLED)
dvander@769
   275
	{
dvander@769
   276
		return false;
dvander@769
   277
	}
dvander@769
   278
dvander@769
   279
	return true;
dvander@769
   280
}
dvander@769
   281
dvander@769
   282
unsigned int CValveMenuDisplay::DrawItem(const ItemDrawInfo &item)
dvander@769
   283
{
dvander@769
   284
	if (m_NextPos > 9 || !CanDrawItem(item.style))
dvander@769
   285
	{
dvander@769
   286
		return 0;
dvander@769
   287
	}
dvander@769
   288
dvander@769
   289
	/**
dvander@769
   290
	 * For these cases we can't draw anything at all, but
dvander@769
   291
	 * we can at least bump the position since we were explicitly asked to.
dvander@769
   292
	 */
dvander@769
   293
	if ((item.style & ITEMDRAW_NOTEXT)
dvander@769
   294
		|| (item.style & ITEMDRAW_SPACER))
dvander@769
   295
	{
dvander@769
   296
		return m_NextPos++;
dvander@769
   297
	}
dvander@769
   298
dvander@769
   299
	char buffer[255];
dvander@769
   300
	UTIL_Format(buffer, sizeof(buffer), "%d. %s", m_NextPos, item.display);
dvander@769
   301
dvander@769
   302
	KeyValues *ki = m_pKv->FindKey(g_OptionNumTable[m_NextPos], true);
dvander@769
   303
	ki->SetString("command", g_OptionCmdTable[m_NextPos]);
dvander@769
   304
	ki->SetString("msg", buffer);
dvander@769
   305
dvander@769
   306
	return m_NextPos++;
dvander@769
   307
}
dvander@769
   308
dvander@769
   309
void CValveMenuDisplay::DrawTitle(const char *text, bool onlyIfEmpty/* =false */)
dvander@769
   310
{
dvander@769
   311
	if (onlyIfEmpty && m_TitleDrawn)
dvander@769
   312
	{
dvander@769
   313
		return;
dvander@769
   314
	}
dvander@769
   315
dvander@769
   316
	m_pKv->SetString("msg", text);
dvander@769
   317
	m_TitleDrawn = true;
dvander@769
   318
}
dvander@769
   319
dvander@769
   320
bool CValveMenuDisplay::DrawRawLine(const char *rawline)
dvander@769
   321
{
dvander@769
   322
	return false;
dvander@769
   323
}
dvander@769
   324
dvander@769
   325
void CValveMenuDisplay::SendRawDisplay(int client, int priority, unsigned int time)
dvander@769
   326
{
dvander@769
   327
	m_pKv->SetInt("level", priority);
dvander@775
   328
	m_pKv->SetInt("time", time ? time : 200);
dvander@769
   329
dvander@769
   330
	SH_CALL(g_pSPHCC, &IServerPluginHelpers::CreateMessage)(
ds@2400
   331
		PEntityOfEntIndex(client),
dvander@769
   332
		DIALOG_MENU,
dvander@769
   333
		m_pKv,
dvander@1605
   334
		vsp_interface);
dvander@769
   335
}
dvander@769
   336
dvander@769
   337
bool CValveMenuDisplay::SendDisplay(int client, IMenuHandler *handler, unsigned int time)
dvander@769
   338
{
dvander@769
   339
	return g_ValveMenuStyle.DoClientMenu(client, this, handler, time);
dvander@769
   340
}
dvander@769
   341
dvander@819
   342
bool CValveMenuDisplay::SetSelectableKeys(unsigned int keymap)
dvander@819
   343
{
dvander@819
   344
	return false;
dvander@819
   345
}
dvander@819
   346
dvander@1361
   347
int CValveMenuDisplay::GetAmountRemaining()
dvander@1361
   348
{
dvander@1361
   349
	/* :TODO: this is a lie, but nothing really seems meaningful... */
dvander@1361
   350
	return -1;
dvander@1361
   351
}
dvander@1361
   352
dvander@1766
   353
unsigned int CValveMenuDisplay::GetApproxMemUsage()
dvander@1766
   354
{
dvander@1766
   355
	return sizeof(CValveMenuDisplay) + (sizeof(KeyValues) * m_NextPos * 10);
dvander@1766
   356
}
dvander@1766
   357
dvander@790
   358
CValveMenu::CValveMenu(IMenuHandler *pHandler, IdentityToken_t *pOwner) : 
dvander@790
   359
CBaseMenu(pHandler, &g_ValveMenuStyle, pOwner), 
dvander@775
   360
	m_IntroColor(255, 0, 0, 255)
dvander@769
   361
{
dvander@769
   362
	strcpy(m_IntroMsg, "You have a menu, press ESC");
dvander@769
   363
	m_Pagination = 5;
dvander@769
   364
}
dvander@769
   365
dvander@775
   366
void CValveMenu::Cancel_Finally()
dvander@769
   367
{
dvander@769
   368
	g_ValveMenuStyle.CancelMenu(this);
dvander@769
   369
}
dvander@769
   370
dvander@769
   371
bool CValveMenu::SetPagination(unsigned int itemsPerPage)
dvander@769
   372
{
dvander@820
   373
	if (itemsPerPage > 5)
dvander@769
   374
	{
dvander@769
   375
		return false;
dvander@769
   376
	}
dvander@769
   377
dvander@820
   378
	return CBaseMenu::SetPagination(itemsPerPage);
dvander@769
   379
}
dvander@769
   380
dvander@769
   381
bool CValveMenu::SetExtOption(MenuOption option, const void *valuePtr)
dvander@769
   382
{
dvander@769
   383
	if (option == MenuOption_IntroMessage)
dvander@769
   384
	{
dvander@769
   385
		strncopy(m_IntroMsg, (const char *)valuePtr, sizeof(m_IntroMsg));
dvander@769
   386
		return true;
dvander@769
   387
	} else if (option == MenuOption_IntroColor) {
dvander@769
   388
		unsigned int *array = (unsigned int *)valuePtr;
dvander@769
   389
		m_IntroColor = Color(array[0], array[1], array[2], array[3]);
dvander@769
   390
		return true;
dvander@769
   391
	}
dvander@769
   392
dvander@769
   393
	return false;
dvander@769
   394
}
dvander@769
   395
dvander@1269
   396
bool CValveMenu::Display(int client, unsigned int time, IMenuHandler *alt_handler)
dvander@769
   397
{
dvander@1474
   398
	return DisplayAtItem(client, time, 0, alt_handler);
dvander@1474
   399
}
dvander@1474
   400
dvander@1474
   401
bool CValveMenu::DisplayAtItem(int client,
dvander@1474
   402
							   unsigned int time,
dvander@1474
   403
							   unsigned int start_item,
dvander@1474
   404
							   IMenuHandler *alt_handler/* =NULL */)
dvander@1474
   405
{
dvander@769
   406
	if (m_bCancelling)
dvander@769
   407
	{
dvander@769
   408
		return false;
dvander@769
   409
	}
dvander@769
   410
dvander@1474
   411
	return g_ValveMenuStyle.DoClientMenu(client, this, start_item, alt_handler ? alt_handler : m_pHandler, time);
dvander@877
   412
}
dvander@877
   413
dvander@787
   414
IMenuPanel *CValveMenu::CreatePanel()
dvander@769
   415
{
dvander@769
   416
	return new CValveMenuDisplay(this);
dvander@769
   417
}
dvander@769
   418
dvander@1259
   419
void CValveMenu::SetMenuOptionFlags(unsigned int flags)
dvander@1259
   420
{
dvander@1269
   421
	flags |= MENUFLAG_BUTTON_EXIT;
dvander@1259
   422
	CBaseMenu::SetMenuOptionFlags(flags);
dvander@1259
   423
}
dvander@1259
   424
dvander@1766
   425
unsigned int CValveMenu::GetApproxMemUsage()
dvander@1766
   426
{
dvander@1766
   427
	return sizeof(CValveMenu) + GetBaseMemUsage();
dvander@1766
   428
}
dvander@1766
   429
dvander@778
   430
const char *g_OptionNumTable[] = 
dvander@769
   431
{
dvander@769
   432
	"0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10"
dvander@769
   433
};
dvander@769
   434
dvander@778
   435
const char *g_OptionCmdTable[] = 
dvander@769
   436
{
dvander@769
   437
	"sm_vmenuselect 0", /* INVALID! */
dvander@769
   438
	"sm_vmenuselect 1",
dvander@769
   439
	"sm_vmenuselect 2",
dvander@769
   440
	"sm_vmenuselect 3",
dvander@769
   441
	"sm_vmenuselect 4",
dvander@769
   442
	"sm_vmenuselect 5",
dvander@769
   443
	"sm_vmenuselect 6",
dvander@769
   444
	"sm_vmenuselect 7",
dvander@769
   445
	"sm_vmenuselect 8",
dvander@769
   446
	"sm_vmenuselect 9",
dvander@769
   447
	"sm_vmenuselect 10"
dvander@769
   448
};