plugins/admin-sql-prefetch.sp
author David Anderson <dvander@alliedmods.net>
Mon Aug 13 18:39:02 2007 +0000 (2007-08-13)
changeset 1318 d8fc5dc94639
parent 1317 a2a64027311e
child 1319 339dc1f92c44
permissions -rw-r--r--
fixed a memory leak in sql groups prefetch
dvander@1316
     1
/**
dvander@1316
     2
 * admin-sql-prefetch.sp
dvander@1316
     3
 * Prefetches admins from an SQL database without threading.
dvander@1316
     4
 * This file is part of SourceMod, Copyright (C) 2004-2007 AlliedModders LLC
dvander@1316
     5
 *
dvander@1316
     6
 * This program is free software; you can redistribute it and/or
dvander@1316
     7
 * modify it under the terms of the GNU General Public License
dvander@1316
     8
 * as published by the Free Software Foundation; either version 2
dvander@1316
     9
 * of the License, or (at your option) any later version.
dvander@1316
    10
 *
dvander@1316
    11
 * This program is distributed in the hope that it will be useful,
dvander@1316
    12
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
dvander@1316
    13
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
dvander@1316
    14
 * GNU General Public License for more details.
dvander@1316
    15
 * 
dvander@1316
    16
 * You should have received a copy of the GNU General Public License
dvander@1316
    17
 * along with this program; if not, write to the Free Software
dvander@1316
    18
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
dvander@1316
    19
 *
dvander@1316
    20
 * Version: $Id$
dvander@1316
    21
 */
dvander@1316
    22
dvander@1316
    23
/* We like semicolons */
dvander@1316
    24
#pragma semicolon 1
dvander@1316
    25
dvander@1316
    26
#include <sourcemod>
dvander@1316
    27
dvander@1316
    28
public Plugin:myinfo = 
dvander@1316
    29
{
dvander@1317
    30
	name = "SQL Admins (Prefetch)",
dvander@1316
    31
	author = "AlliedModders LLC",
dvander@1316
    32
	description = "Reads all admins from SQL",
dvander@1316
    33
	version = SOURCEMOD_VERSION,
dvander@1316
    34
	url = "http://www.sourcemod.net/"
dvander@1316
    35
};
dvander@1316
    36
dvander@1316
    37
public OnRebuildAdminCache(AdminCachePart:part)
dvander@1316
    38
{
dvander@1316
    39
	/* First try to get a database connection */
dvander@1316
    40
	decl String:error[255];
dvander@1316
    41
	new Handle:db = SQL_Connect("default", true, error, sizeof(error));
dvander@1316
    42
	if (db == INVALID_HANDLE)
dvander@1316
    43
	{
dvander@1316
    44
		LogError("Could not connect to database \"default\": %s", error);
dvander@1316
    45
		return;
dvander@1316
    46
	}
dvander@1316
    47
	
dvander@1316
    48
	if (part == AdminCache_Overrides)
dvander@1316
    49
	{
dvander@1316
    50
		FetchOverrides(db);
dvander@1316
    51
	} else if (part == AdminCache_Groups) {
dvander@1316
    52
		FetchGroups(db);
dvander@1316
    53
	} else if (part == AdminCache_Admins) {
dvander@1316
    54
		FetchUsers(db);
dvander@1316
    55
	}
dvander@1316
    56
	
dvander@1316
    57
	CloseHandle(db);
dvander@1316
    58
}
dvander@1316
    59
dvander@1316
    60
FetchUserGroups(Handle:hQuery, AdminId:adm, id)
dvander@1316
    61
{
dvander@1316
    62
	SQL_BindParamInt(hQuery, 0, id);
dvander@1316
    63
	if (!SQL_Execute(hQuery))
dvander@1316
    64
	{
dvander@1316
    65
		decl String:error[255];
dvander@1316
    66
		SQL_GetError(hQuery, error, sizeof(error));
dvander@1316
    67
		LogError("FetchUserGroups() statement execute failed: %s", error);
dvander@1316
    68
		return;
dvander@1316
    69
	}
dvander@1316
    70
	
dvander@1316
    71
	decl String:name[80];
dvander@1316
    72
	new GroupId:gid;
dvander@1316
    73
	while (SQL_FetchRow(hQuery))
dvander@1316
    74
	{
dvander@1316
    75
		SQL_FetchString(hQuery, 0, name, sizeof(name));
dvander@1316
    76
		
dvander@1316
    77
		if ((gid = FindAdmGroup(name)) == INVALID_GROUP_ID)
dvander@1316
    78
		{
dvander@1316
    79
			/* Group wasn't found, don't bother with it.  */
dvander@1316
    80
			continue;
dvander@1316
    81
		}
dvander@1316
    82
		
dvander@1316
    83
		#if defined _DEBUG
dvander@1316
    84
		PrintToServer("Found admin group (%d, %d, %d)", id, gid, adm);
dvander@1316
    85
		#endif
dvander@1316
    86
		
dvander@1316
    87
		AdminInheritGroup(adm, gid);
dvander@1316
    88
	}
dvander@1316
    89
}
dvander@1316
    90
dvander@1316
    91
FetchUsers(Handle:db)
dvander@1316
    92
{
dvander@1316
    93
	decl String:query[255], String:error[255];
dvander@1316
    94
	new Handle:hQuery, Handle:hGroupQuery;
dvander@1316
    95
	
dvander@1316
    96
	Format(query, sizeof(query), "SELECT id, authtype, identity, passwd, flags, name FROM sm_admins");
dvander@1316
    97
	if ((hQuery = SQL_Query(db, query)) == INVALID_HANDLE)
dvander@1316
    98
	{
dvander@1316
    99
		SQL_GetError(db, error, sizeof(error));
dvander@1316
   100
		LogError("FetchUsers() query failed: %s", query);
dvander@1316
   101
		LogError("Query error: %s", error);
dvander@1316
   102
		return;
dvander@1316
   103
	}
dvander@1316
   104
	
dvander@1316
   105
	/* If this fails it's non-fatal */
dvander@1316
   106
	Format(query,
dvander@1316
   107
		sizeof(query), 
dvander@1316
   108
		"SELECT g.name FROM sm_admins_groups ag JOIN sm_groups g ON ag.group_id = g.id WHERE ag.admin_id = ? ORDER BY inherit_order ASC");
dvander@1316
   109
	if ((hGroupQuery = SQL_PrepareQuery(db, query, error, sizeof(error))) == INVALID_HANDLE)
dvander@1316
   110
	{
dvander@1316
   111
		LogError("FetchUsers() group query preparation failed: %s", query);
dvander@1316
   112
		LogError("Query error: %s", error);
dvander@1316
   113
	}
dvander@1316
   114
	
dvander@1316
   115
	decl String:authtype[16];
dvander@1316
   116
	decl String:identity[80];
dvander@1316
   117
	decl String:password[80];
dvander@1316
   118
	decl String:flags[32];
dvander@1316
   119
	decl String:name[80];
dvander@1316
   120
	new AdminId:adm, id;
dvander@1316
   121
	
dvander@1316
   122
	while (SQL_FetchRow(hQuery))
dvander@1316
   123
	{
dvander@1316
   124
		id = SQL_FetchInt(hQuery, 0);
dvander@1316
   125
		SQL_FetchString(hQuery, 1, authtype, sizeof(authtype));
dvander@1316
   126
		SQL_FetchString(hQuery, 2, identity, sizeof(identity));
dvander@1316
   127
		SQL_FetchString(hQuery, 3, password, sizeof(password));
dvander@1316
   128
		SQL_FetchString(hQuery, 4, flags, sizeof(flags));
dvander@1316
   129
		SQL_FetchString(hQuery, 5, name, sizeof(name));
dvander@1316
   130
		
dvander@1316
   131
		/* Use a pre-existing admin if we can */
dvander@1316
   132
		if ((adm = FindAdminByIdentity(authtype, identity)) == INVALID_ADMIN_ID)
dvander@1316
   133
		{
dvander@1316
   134
			adm = CreateAdmin(name);
dvander@1316
   135
			if (!BindAdminIdentity(adm, authtype, identity))
dvander@1316
   136
			{
dvander@1316
   137
				LogError("Could not bind prefetched SQL admin (authtype \"%s\") (identity \"%s\")", authtype, identity);
dvander@1316
   138
				continue;
dvander@1316
   139
			}
dvander@1316
   140
		}
dvander@1316
   141
		
dvander@1316
   142
		#if defined _DEBUG
dvander@1316
   143
		PrintToServer("Found SQL admin (%d,%s,%s,%s,%s,%s):%d", id, authtype, identity, password, flags, name, adm);
dvander@1316
   144
		#endif
dvander@1316
   145
		
dvander@1316
   146
		/* See if this admin wants a password */
dvander@1316
   147
		if (password[0] != '\0')
dvander@1316
   148
		{
dvander@1316
   149
			SetAdminPassword(adm, password);
dvander@1316
   150
		}
dvander@1316
   151
		
dvander@1316
   152
		/* Apply each flag */
dvander@1316
   153
		new len = strlen(flags);
dvander@1316
   154
		new AdminFlag:flag;
dvander@1316
   155
		for (new i=0; i<len; i++)
dvander@1316
   156
		{
dvander@1316
   157
			if (!FindFlagByChar(flags[i], flag))
dvander@1316
   158
			{
dvander@1316
   159
				continue;
dvander@1316
   160
			}
dvander@1316
   161
			SetAdminFlag(adm, flag, true);
dvander@1316
   162
		}
dvander@1316
   163
		
dvander@1316
   164
		/* Look up groups */
dvander@1316
   165
		if (hGroupQuery != INVALID_HANDLE)
dvander@1316
   166
		{
dvander@1316
   167
			FetchUserGroups(hGroupQuery, adm, id);
dvander@1316
   168
		}
dvander@1316
   169
	}
dvander@1316
   170
	
dvander@1316
   171
	CloseHandle(hGroupQuery);
dvander@1316
   172
	CloseHandle(hQuery);
dvander@1316
   173
}
dvander@1316
   174
dvander@1316
   175
FetchGroups(Handle:db)
dvander@1316
   176
{
dvander@1316
   177
	decl String:query[255];
dvander@1316
   178
	new Handle:hQuery;
dvander@1316
   179
	
dvander@1316
   180
	Format(query, sizeof(query), "SELECT id, immunity, flags, name, groups_immune FROM sm_groups");
dvander@1316
   181
dvander@1316
   182
	if ((hQuery = SQL_Query(db, query)) == INVALID_HANDLE)
dvander@1316
   183
	{
dvander@1316
   184
		decl String:error[255];
dvander@1316
   185
		SQL_GetError(db, error, sizeof(error));
dvander@1316
   186
		LogError("FetchGroups() query failed: %s", query);
dvander@1316
   187
		LogError("Query error: %s", error);
dvander@1316
   188
		return;
dvander@1316
   189
	}
dvander@1316
   190
	
dvander@1316
   191
	/* We cache basic group info so we can do reverse lookups */
dvander@1316
   192
	new Handle:groups = CreateArray(3);
dvander@1316
   193
	
dvander@1316
   194
	/* Now start fetching groups */
dvander@1316
   195
	decl String:immunity[16];
dvander@1316
   196
	decl String:flags[32];
dvander@1316
   197
	decl String:name[128];
dvander@1316
   198
	decl String:grp_immunity[256];
dvander@1316
   199
	while (SQL_FetchRow(hQuery))
dvander@1316
   200
	{
dvander@1316
   201
		new id = SQL_FetchInt(hQuery, 0);
dvander@1316
   202
		SQL_FetchString(hQuery, 1, immunity, sizeof(immunity));
dvander@1316
   203
		SQL_FetchString(hQuery, 2, flags, sizeof(flags));
dvander@1316
   204
		SQL_FetchString(hQuery, 3, name, sizeof(name));
dvander@1316
   205
		SQL_FetchString(hQuery, 4, grp_immunity, sizeof(grp_immunity));
dvander@1316
   206
		
dvander@1316
   207
#if defined _DEBUG
dvander@1316
   208
		PrintToServer("Adding group (%d, %s, %s, %s, %s)", id, immunity, flags, name, grp_immunity);
dvander@1316
   209
#endif
dvander@1316
   210
		
dvander@1316
   211
		/* Find or create the group */
dvander@1316
   212
		new GroupId:gid;
dvander@1316
   213
		if ((gid = FindAdmGroup(name)) == INVALID_GROUP_ID)
dvander@1316
   214
		{
dvander@1316
   215
			gid = CreateAdmGroup(name);
dvander@1316
   216
		}
dvander@1316
   217
		
dvander@1316
   218
		/* Add flags from the database to the group */
dvander@1316
   219
		new num_flag_chars = strlen(flags);
dvander@1316
   220
		for (new i=0; i<num_flag_chars; i++)
dvander@1316
   221
		{
dvander@1316
   222
			decl AdminFlag:flag;
dvander@1316
   223
			if (!FindFlagByChar(flags[i], flag))
dvander@1316
   224
			{
dvander@1316
   225
				continue;
dvander@1316
   226
			}
dvander@1316
   227
			SetAdmGroupAddFlag(gid, flag, true);
dvander@1316
   228
		}
dvander@1316
   229
		
dvander@1316
   230
		/* Set the immunity level this group has */
dvander@1316
   231
		if (StrEqual(immunity, "all"))
dvander@1316
   232
		{
dvander@1316
   233
			SetAdmGroupImmunity(gid, Immunity_Default, true);
dvander@1316
   234
			SetAdmGroupImmunity(gid, Immunity_Global, true);
dvander@1316
   235
		} else if (StrEqual(immunity, "default")) {
dvander@1316
   236
			SetAdmGroupImmunity(gid, Immunity_Default, true);
dvander@1316
   237
		} else if (StrEqual(immunity, "global")) {
dvander@1316
   238
			SetAdmGroupImmunity(gid, Immunity_Global, true);
dvander@1316
   239
		}
dvander@1316
   240
		
dvander@1316
   241
		new Handle:immunity_list = UTIL_ExplodeNumberString(grp_immunity);
dvander@1316
   242
		
dvander@1316
   243
		/* Now, save all this for later */
dvander@1316
   244
		decl data[3];
dvander@1316
   245
		data[0] = id;
dvander@1316
   246
		data[1] = _:gid;
dvander@1316
   247
		data[2] = _:immunity_list;
dvander@1316
   248
		
dvander@1316
   249
		PushArrayArray(groups, data);
dvander@1316
   250
	}
dvander@1316
   251
	
dvander@1316
   252
	CloseHandle(hQuery);
dvander@1316
   253
	
dvander@1316
   254
	/* Second pass - resolve immunity and group overrides */
dvander@1316
   255
	new num_groups = GetArraySize(groups);
dvander@1316
   256
	for (new i=0; i<num_groups; i++)
dvander@1316
   257
	{
dvander@1316
   258
		decl data[3];
dvander@1316
   259
		GetArrayArray(groups, i, data);
dvander@1316
   260
		
dvander@1316
   261
		new id = data[0];
dvander@1316
   262
		new GroupId:gid = GroupId:data[1];
dvander@1316
   263
		new Handle:immunity_list = Handle:data[2];
dvander@1316
   264
		
dvander@1316
   265
		/* Query to get per-group override list */
dvander@1316
   266
		Format(query, 
dvander@1316
   267
			sizeof(query),
dvander@1316
   268
			"SELECT type, name, access FROM sm_group_overrides WHERE group_id = %d",
dvander@1316
   269
			id);
dvander@1316
   270
		
dvander@1316
   271
		/* Fetch the override query results */
dvander@1316
   272
		if ((hQuery = SQL_Query(db, query)) == INVALID_HANDLE)
dvander@1316
   273
		{
dvander@1316
   274
			decl String:error[255];
dvander@1316
   275
			SQL_GetError(db, error, sizeof(error));
dvander@1316
   276
			LogError("FetchOverrides() query failed: %s", query);
dvander@1316
   277
			LogError("Query error: %s", error);
dvander@1316
   278
		} else {
dvander@1316
   279
			decl String:type[16];
dvander@1316
   280
			decl String:cmd[64];
dvander@1316
   281
			decl String:access[16];
dvander@1316
   282
			while (SQL_FetchRow(hQuery))
dvander@1316
   283
			{
dvander@1316
   284
				SQL_FetchString(hQuery, 0, type, sizeof(type));
dvander@1316
   285
				SQL_FetchString(hQuery, 1, cmd, sizeof(cmd));
dvander@1316
   286
				SQL_FetchString(hQuery, 2, access, sizeof(access));
dvander@1316
   287
				
dvander@1316
   288
				new OverrideType:o_type = Override_Command;
dvander@1316
   289
				if (StrEqual(type, "group"))
dvander@1316
   290
				{
dvander@1316
   291
					o_type = Override_CommandGroup;
dvander@1316
   292
				}
dvander@1316
   293
				
dvander@1316
   294
				new OverrideRule:o_rule = Command_Deny;
dvander@1316
   295
				if (StrEqual(access, "allow"))
dvander@1316
   296
				{
dvander@1316
   297
					o_rule = Command_Allow;
dvander@1316
   298
				}
dvander@1316
   299
				
dvander@1316
   300
				#if defined _DEBUG
dvander@1316
   301
				PrintToServer("AddAdmGroupCmdOverride(%d, %s, %d, %d)", gid, cmd, o_type, o_rule);
dvander@1316
   302
				#endif
dvander@1316
   303
				
dvander@1316
   304
				AddAdmGroupCmdOverride(gid, cmd, o_type, o_rule);
dvander@1316
   305
			}
dvander@1316
   306
			CloseHandle(hQuery);
dvander@1316
   307
		}
dvander@1316
   308
		
dvander@1316
   309
		/* Lastly, resolve the immunity list if any */
dvander@1316
   310
		new immunity_count;
dvander@1316
   311
		if (immunity_list != INVALID_HANDLE 
dvander@1316
   312
			&& ((immunity_count = GetArraySize(immunity_list)) > 0))
dvander@1316
   313
		{
dvander@1316
   314
			for (new j=0; j<immunity_count; j++)
dvander@1316
   315
			{
dvander@1316
   316
				new other_id = GetArrayCell(immunity_list, j);
dvander@1316
   317
				
dvander@1316
   318
				if (other_id == id)
dvander@1316
   319
				{
dvander@1316
   320
					continue;
dvander@1316
   321
				}
dvander@1316
   322
				
dvander@1316
   323
				/* See if we can find this other ID */
dvander@1316
   324
				new GroupId:other_gid;
dvander@1316
   325
				if ((other_gid = UTIL_FindGroupInCache(groups, other_id)) != INVALID_GROUP_ID)
dvander@1316
   326
				{
dvander@1316
   327
					#if defined _DEBUG
dvander@1316
   328
					PrintToServer("SetAdmGroupImmuneFrom(%d, %d)", gid, other_gid);
dvander@1316
   329
					#endif
dvander@1316
   330
					SetAdmGroupImmuneFrom(gid, other_gid);
dvander@1316
   331
				}
dvander@1316
   332
			}
dvander@1316
   333
		}
dvander@1316
   334
	}
dvander@1318
   335
	
dvander@1318
   336
	CloseHandle(groups);
dvander@1316
   337
}
dvander@1316
   338
dvander@1316
   339
FetchOverrides(Handle:db)
dvander@1316
   340
{
dvander@1316
   341
	decl String:query[255];
dvander@1316
   342
	new Handle:hQuery;
dvander@1316
   343
	
dvander@1316
   344
	Format(query, sizeof(query), "SELECT type, name, flags FROM sm_overrides");
dvander@1316
   345
dvander@1316
   346
	if ((hQuery = SQL_Query(db, query)) == INVALID_HANDLE)
dvander@1316
   347
	{
dvander@1316
   348
		decl String:error[255];
dvander@1316
   349
		SQL_GetError(db, error, sizeof(error));
dvander@1316
   350
		LogError("FetchOverrides() query failed: %s", query);
dvander@1316
   351
		LogError("Query error: %s", error);
dvander@1316
   352
		return;
dvander@1316
   353
	}
dvander@1316
   354
	
dvander@1316
   355
	decl String:type[64];
dvander@1316
   356
	decl String:name[64];
dvander@1316
   357
	decl String:flags[32];
dvander@1316
   358
	new flag_bits;
dvander@1316
   359
	while (SQL_FetchRow(hQuery))
dvander@1316
   360
	{
dvander@1316
   361
		SQL_FetchString(hQuery, 0, type, sizeof(type));
dvander@1316
   362
		SQL_FetchString(hQuery, 1, name, sizeof(name));
dvander@1316
   363
		SQL_FetchString(hQuery, 2, flags, sizeof(flags));
dvander@1316
   364
		
dvander@1316
   365
#if defined _DEBUG
dvander@1316
   366
		PrintToServer("Adding override (%s, %s, %s)", type, name, flags);
dvander@1316
   367
#endif
dvander@1316
   368
		
dvander@1316
   369
		flag_bits = ReadFlagString(flags);
dvander@1316
   370
		if (StrEqual(type, "command"))
dvander@1316
   371
		{
dvander@1316
   372
			AddCommandOverride(name, Override_Command, flag_bits);
dvander@1316
   373
		} else if (StrEqual(type, "group")) {
dvander@1316
   374
			AddCommandOverride(name, Override_CommandGroup, flag_bits);
dvander@1316
   375
		}
dvander@1316
   376
	}
dvander@1316
   377
	
dvander@1316
   378
	CloseHandle(hQuery);
dvander@1316
   379
}
dvander@1316
   380
dvander@1316
   381
stock GroupId:UTIL_FindGroupInCache(Handle:group_list, id)
dvander@1316
   382
{
dvander@1316
   383
	new size = GetArraySize(group_list);
dvander@1316
   384
	
dvander@1316
   385
	for (new i=0; i<size; i++)
dvander@1316
   386
	{
dvander@1316
   387
		decl data[3];
dvander@1316
   388
		GetArrayArray(group_list, i, data);
dvander@1316
   389
		
dvander@1316
   390
		if (data[0] == id)
dvander@1316
   391
		{
dvander@1316
   392
			return GroupId:data[1];
dvander@1316
   393
		}
dvander@1316
   394
	}
dvander@1316
   395
	
dvander@1316
   396
	return INVALID_GROUP_ID;
dvander@1316
   397
}
dvander@1316
   398
dvander@1316
   399
/**
dvander@1316
   400
 * Breaks a comma-delimited string into a list of numbers, returning a new 
dvander@1316
   401
 * dynamic array.
dvander@1316
   402
 *
dvander@1316
   403
 * @param text				The string to split.
dvander@1316
   404
 * @return					A new array Handle which must be closed, or 
dvander@1316
   405
 *							INVALID_HANDLE on no strings found.
dvander@1316
   406
 */
dvander@1316
   407
stock Handle:UTIL_ExplodeNumberString(const String:text[])
dvander@1316
   408
{
dvander@1316
   409
	new Handle:array = INVALID_HANDLE;
dvander@1316
   410
	decl String:buffer[32];
dvander@1316
   411
	new reloc_idx, idx;
dvander@1316
   412
	
dvander@1316
   413
	while ((idx = SplitString(text[reloc_idx], ",", buffer, sizeof(buffer))) != -1)
dvander@1316
   414
	{
dvander@1316
   415
		reloc_idx += idx;
dvander@1316
   416
		if (text[reloc_idx] == '\0')
dvander@1316
   417
		{
dvander@1316
   418
			break;
dvander@1316
   419
		}
dvander@1316
   420
		if (array == INVALID_HANDLE)
dvander@1316
   421
		{
dvander@1316
   422
			array = CreateArray();
dvander@1316
   423
		}
dvander@1316
   424
		PushArrayCell(array, StringToInt(buffer));
dvander@1316
   425
	}
dvander@1316
   426
	
dvander@1316
   427
	if (text[reloc_idx] != '\0')
dvander@1316
   428
	{
dvander@1316
   429
		if (array == INVALID_HANDLE)
dvander@1316
   430
		{
dvander@1316
   431
			array = CreateArray();
dvander@1316
   432
		}
dvander@1316
   433
		PushArrayCell(array, StringToInt(text[reloc_idx]));
dvander@1316
   434
	}
dvander@1316
   435
	
dvander@1316
   436
	return array;
dvander@1316
   437
}
dvander@1316
   438