3 * =============================================================================
4 * SourceMod SQL Admins Plugin (Threaded)
5 * Fetches admins from an SQL database dynamically.
7 * SourceMod (C)2004-2007 AlliedModders LLC. All rights reserved.
8 * =============================================================================
10 * This program is free software; you can redistribute it and/or modify it under
11 * the terms of the GNU General Public License, version 3.0, as published by the
12 * Free Software Foundation.
14 * This program is distributed in the hope that it will be useful, but WITHOUT
15 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
16 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
19 * You should have received a copy of the GNU General Public License along with
20 * this program. If not, see <http://www.gnu.org/licenses/>.
22 * As a special exception, AlliedModders LLC gives you permission to link the
23 * code of this program (as well as its derivative works) to "Half-Life 2," the
24 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
25 * by the Valve Corporation. You must obey the GNU General Public License in
26 * all respects for all other code used. Additionally, AlliedModders LLC grants
27 * this exception to all derivative works. AlliedModders LLC defines further
28 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
29 * or <http://www.sourcemod.net/license.php>.
34 /* We like semicolons */
39 public Plugin:myinfo =
41 name = "SQL Admins (Threaded)",
42 author = "AlliedModders LLC",
43 description = "Reads admins from SQL dynamically",
44 version = SOURCEMOD_VERSION,
45 url = "http://www.sourcemod.net/"
51 * 1) All queries in here are high priority. This is because the admin stuff
52 * is very important. Do not take this to mean that in your script,
53 * everything should be high priority.
55 * 2) All callbacks are locked with "sequence numbers." This is to make sure
56 * that multiple calls to sm_reloadadmins and the like do not make us
57 * store the results from two or more callbacks accidentally. Instead, we
58 * check the sequence number in each callback with the current "allowed"
59 * sequence number, and if it doesn't match, the callback is cancelled.
61 * 3) Sequence numbers for groups and overrides are not cleared unless there
62 * was a 100% success in the fetch. This is so we can potentially implement
63 * connection retries in the future.
65 * 4) Sequence numbers for the user cache are ignored except for being
66 * non-zero, which means players in-game should be re-checked for admin
70 new Handle:hDatabase = INVALID_HANDLE; /** Database connection */
71 new g_sequence = 0; /** Global unique sequence number */
72 new ConnectLock = 0; /** Connect sequence number */
73 new RebuildCachePart[3] = {0}; /** Cache part sequence numbers */
74 new PlayerSeq[MAXPLAYERS+1]; /** Player-specific sequence numbers */
75 new bool:PlayerAuth[MAXPLAYERS+1]; /** Whether a player has been "pre-authed" */
82 * Clean up on map end just so we can start a fresh connection when we need it later.
84 if (hDatabase != INVALID_HANDLE)
86 CloseHandle(hDatabase);
87 hDatabase = INVALID_HANDLE;
91 public bool:OnClientConnect(client, String:rejectmsg[], maxlen)
93 PlayerSeq[client] = 0;
94 PlayerAuth[client] = false;
98 public OnClientDisconnect(client)
100 PlayerSeq[client] = 0;
101 PlayerAuth[client] = false;
104 public OnDatabaseConnect(Handle:owner, Handle:hndl, const String:error[], any:data)
107 PrintToServer("OnDatabaseConnect(%x,%x,%d) ConnectLock=%d", owner, hndl, data, ConnectLock);
111 * If this happens to be an old connection request, ignore it.
113 if (data != ConnectLock || hDatabase != INVALID_HANDLE)
115 if (hndl != INVALID_HANDLE)
126 * See if the connection is valid. If not, don't un-mark the caches
127 * as needing rebuilding, in case the next connection request works.
129 if (hDatabase == INVALID_HANDLE)
131 LogError("Failed to connect to database: %s", error);
136 * See if we need to get any of the cache stuff now.
139 if ((sequence = RebuildCachePart[_:AdminCache_Overrides]) != 0)
141 FetchOverrides(hDatabase, sequence);
143 if ((sequence = RebuildCachePart[_:AdminCache_Groups]) != 0)
145 FetchGroups(hDatabase, sequence);
147 if ((sequence = RebuildCachePart[_:AdminCache_Admins]) != 0)
149 FetchUsersWeCan(hDatabase);
153 RequestDatabaseConnection()
155 ConnectLock = ++g_sequence;
156 if (SQL_CheckConfig("admins"))
158 SQL_TConnect(OnDatabaseConnect, "admins", ConnectLock);
160 SQL_TConnect(OnDatabaseConnect, "default", ConnectLock);
164 public OnRebuildAdminCache(AdminCachePart:part)
167 * Mark this part of the cache as being rebuilt. This is used by the
168 * callback system to determine whether the results should still be
171 new sequence = ++g_sequence;
172 RebuildCachePart[_:part] = sequence;
175 * If we don't have a database connection, we can't do any lookups just yet.
180 * Ask for a new connection if we need it.
184 RequestDatabaseConnection();
189 if (part == AdminCache_Overrides)
191 FetchOverrides(hDatabase, sequence);
192 } else if (part == AdminCache_Groups) {
193 FetchGroups(hDatabase, sequence);
194 } else if (part == AdminCache_Admins) {
195 FetchUsersWeCan(hDatabase);
199 public Action:OnClientPreAdminCheck(client)
201 PlayerAuth[client] = true;
204 * Play nice with other plugins. If there's no database, don't delay the
205 * connection process. Unfortunately, we can't attempt anything else and
206 * we just have to hope either the database is waiting or someone will type
209 if (hDatabase == INVALID_HANDLE)
211 return Plugin_Continue;
215 * Similarly, if the cache is in the process of being rebuilt, don't delay
216 * the user's normal connection flow. The database will soon auth the user
219 if (RebuildCachePart[_:AdminCache_Admins] != 0)
221 return Plugin_Continue;
225 * If someone has already assigned an admin ID (bad bad bad), don't
228 if (GetUserAdmin(client) != INVALID_ADMIN_ID)
230 return Plugin_Continue;
233 FetchUser(hDatabase, client);
235 return Plugin_Handled;
238 public OnReceiveUserGroups(Handle:owner, Handle:hndl, const String:error[], any:data)
240 new Handle:pk = Handle:data;
243 new client = ReadPackCell(pk);
244 new sequence = ReadPackCell(pk);
247 * Make sure it's the same client.
249 if (PlayerSeq[client] != sequence)
255 new AdminId:adm = AdminId:ReadPackCell(pk);
258 * Someone could have sneakily changed the admin id while we waited.
260 if (GetUserAdmin(client) != adm)
262 NotifyPostAdminCheck(client);
268 * See if we got results.
270 if (hndl == INVALID_HANDLE)
272 decl String:query[255];
273 ReadPackString(pk, query, sizeof(query));
274 LogError("SQL error receiving user: %s", error);
275 LogError("Query dump: %s", query);
276 NotifyPostAdminCheck(client);
281 decl String:name[80];
284 while (SQL_FetchRow(hndl))
286 SQL_FetchString(hndl, 0, name, sizeof(name));
288 if ((gid = FindAdmGroup(name)) == INVALID_GROUP_ID)
294 PrintToServer("Binding user group (%d, %d, %d, %s, %d)", client, sequence, adm, name, gid);
297 AdminInheritGroup(adm, gid);
303 NotifyPostAdminCheck(client);
307 public OnReceiveUser(Handle:owner, Handle:hndl, const String:error[], any:data)
309 new Handle:pk = Handle:data;
312 new client = ReadPackCell(pk);
315 * Check if this is the latest result request.
317 new sequence = ReadPackCell(pk);
318 if (PlayerSeq[client] != sequence)
320 /* Discard everything, since we're out of sequence. */
326 * If we need to use the results, make sure they succeeded.
328 if (hndl == INVALID_HANDLE)
330 decl String:query[255];
331 ReadPackString(pk, query, sizeof(query));
332 LogError("SQL error receiving user: %s", error);
333 LogError("Query dump: %s", query);
334 RunAdminCacheChecks(client);
335 NotifyPostAdminCheck(client);
340 new num_accounts = SQL_GetRowCount(hndl);
341 if (num_accounts == 0)
343 RunAdminCacheChecks(client);
344 NotifyPostAdminCheck(client);
349 decl String:authtype[16];
350 decl String:identity[80];
351 decl String:password[80];
352 decl String:flags[32];
353 decl String:name[80];
357 * Cache user info -- [0] = db id, [1] = cache id, [2] = groups
359 decl user_lookup[num_accounts][3];
362 while (SQL_FetchRow(hndl))
364 id = SQL_FetchInt(hndl, 0);
365 SQL_FetchString(hndl, 1, authtype, sizeof(authtype));
366 SQL_FetchString(hndl, 2, identity, sizeof(identity));
367 SQL_FetchString(hndl, 3, password, sizeof(password));
368 SQL_FetchString(hndl, 4, flags, sizeof(flags));
369 SQL_FetchString(hndl, 5, name, sizeof(name));
371 /* For dynamic admins we clear anything already in the cache. */
372 if ((adm = FindAdminByIdentity(authtype, identity)) != INVALID_ADMIN_ID)
377 adm = CreateAdmin(name);
378 if (!BindAdminIdentity(adm, authtype, identity))
380 LogError("Could not bind prefetched SQL admin (authtype \"%s\") (identity \"%s\")", authtype, identity);
384 user_lookup[total_users][0] = id;
385 user_lookup[total_users][1] = _:adm;
386 user_lookup[total_users][2] = SQL_FetchInt(hndl, 6);
390 PrintToServer("Found SQL admin (%d,%s,%s,%s,%s,%s):%d:%d", id, authtype, identity, password, flags, name, adm, user_lookup[total_users-1][2]);
393 /* See if this admin wants a password */
394 if (password[0] != '\0')
396 SetAdminPassword(adm, password);
399 /* Apply each flag */
400 new len = strlen(flags);
402 for (new i=0; i<len; i++)
404 if (!FindFlagByChar(flags[i], flag))
408 SetAdminFlag(adm, flag, true);
413 * Try binding the user.
416 RunAdminCacheChecks(client);
417 adm = GetUserAdmin(client);
421 for (new i=0; i<total_users; i++)
423 if (user_lookup[i][1] == _:adm)
425 id = user_lookup[i][0];
426 group_count = user_lookup[i][2];
432 PrintToServer("Binding client (%d, %d) resulted in: (%d, %d, %d)", client, sequence, id, adm, group_count);
436 * If we can't verify that we assigned a database admin, or the user has no
437 * groups, don't bother doing anything.
439 if (!id || !group_count)
441 NotifyPostAdminCheck(client);
447 * The user has groups -- we need to fetch them!
449 decl String:query[255];
450 Format(query, sizeof(query), "SELECT g.name FROM sm_admins_groups ag JOIN sm_groups g ON ag.group_id = g.id WHERE ag.admin_id = %d", id);
453 WritePackCell(pk, client);
454 WritePackCell(pk, sequence);
455 WritePackCell(pk, _:adm);
456 WritePackString(pk, query);
458 SQL_TQuery(owner, OnReceiveUserGroups, query, pk, DBPrio_High);
461 FetchUser(Handle:db, client)
463 decl String:name[65];
464 decl String:safe_name[140];
465 decl String:steamid[32];
466 decl String:ipaddr[24];
469 * Get authentication information from the client.
471 GetClientName(client, name, sizeof(name));
472 GetClientIP(client, ipaddr, sizeof(ipaddr));
475 if (GetClientAuthString(client, steamid, sizeof(steamid)))
477 if (StrEqual(steamid, "STEAM_ID_LAN"))
483 SQL_QuoteString(db, name, safe_name, sizeof(safe_name));
486 * Construct the query using the information the user gave us.
488 decl String:query[512];
491 len += Format(query[len], sizeof(query)-len, "SELECT a.id, a.authtype, a.identity, a.password, a.flags, a.name, COUNT(ag.group_id)");
492 len += Format(query[len], sizeof(query)-len, " FROM sm_admins a LEFT JOIN sm_admins_groups ag ON a.id = ag.admin_id WHERE ");
493 len += Format(query[len], sizeof(query)-len, " (a.authtype = 'ip' AND a.identity = '%s')", ipaddr);
494 len += Format(query[len], sizeof(query)-len, " OR (a.authtype = 'name' AND a.identity = '%s')", safe_name);
495 if (steamid[0] != '\0')
497 len += Format(query[len], sizeof(query)-len, " OR (a.authtype = 'steam' AND a.identity = '%s')", steamid);
499 len += Format(query[len], sizeof(query)-len, " GROUP BY a.id");
502 * Send the actual query.
504 PlayerSeq[client] = ++g_sequence;
507 pk = CreateDataPack();
508 WritePackCell(pk, client);
509 WritePackCell(pk, PlayerSeq[client]);
510 WritePackString(pk, query);
513 PrintToServer("Sending user query: %s", query);
516 SQL_TQuery(db, OnReceiveUser, query, pk, DBPrio_High);
519 FetchUsersWeCan(Handle:db)
521 new max_clients = GetMaxClients();
523 for (new i=1; i<=max_clients; i++)
525 if (PlayerAuth[i] && GetUserAdmin(i) == INVALID_ADMIN_ID)
532 * This round of updates is done. Go in peace.
534 RebuildCachePart[_:AdminCache_Admins] = 0;
538 public OnReceiveGroupImmunity(Handle:owner, Handle:hndl, const String:error[], any:data)
540 new Handle:pk = Handle:data;
544 * Check if this is the latest result request.
546 new sequence = ReadPackCell(pk);
547 if (RebuildCachePart[_:AdminCache_Groups] != sequence)
549 /* Discard everything, since we're out of sequence. */
555 * If we need to use the results, make sure they succeeded.
557 if (hndl == INVALID_HANDLE)
559 decl String:query[255];
560 ReadPackString(pk, query, sizeof(query));
561 LogError("SQL error receiving group immunity: %s", error);
562 LogError("Query dump: %s", query);
567 /* We're done with the pack forever. */
570 while (SQL_FetchRow(hndl))
572 decl String:group1[80];
573 decl String:group2[80];
574 new GroupId:gid1, GroupId:gid2;
576 SQL_FetchString(hndl, 0, group1, sizeof(group1));
577 SQL_FetchString(hndl, 1, group2, sizeof(group2));
579 if (((gid1 = FindAdmGroup(group1)) == INVALID_GROUP_ID)
580 || (gid2 = FindAdmGroup(group2)) == INVALID_GROUP_ID)
585 SetAdmGroupImmuneFrom(gid1, gid2);
587 PrintToServer("SetAdmGroupImmuneFrom(%d, %d)", gid1, gid2);
591 /* Clear the sequence so another connect doesn't refetch */
592 RebuildCachePart[_:AdminCache_Groups] = 0;
595 public OnReceiveGroupOverrides(Handle:owner, Handle:hndl, const String:error[], any:data)
597 new Handle:pk = Handle:data;
601 * Check if this is the latest result request.
603 new sequence = ReadPackCell(pk);
604 if (RebuildCachePart[_:AdminCache_Groups] != sequence)
606 /* Discard everything, since we're out of sequence. */
612 * If we need to use the results, make sure they succeeded.
614 if (hndl == INVALID_HANDLE)
616 decl String:query[255];
617 ReadPackString(pk, query, sizeof(query));
618 LogError("SQL error receiving group overrides: %s", error);
619 LogError("Query dump: %s", query);
625 * Fetch the overrides.
627 decl String:name[80];
628 decl String:type[16];
629 decl String:command[64];
630 decl String:access[16];
632 while (SQL_FetchRow(hndl))
634 SQL_FetchString(hndl, 0, name, sizeof(name));
635 SQL_FetchString(hndl, 1, type, sizeof(type));
636 SQL_FetchString(hndl, 2, command, sizeof(command));
637 SQL_FetchString(hndl, 3, access, sizeof(access));
639 /* Find the group. This is actually faster than doing the ID lookup. */
640 if ((gid = FindAdmGroup(name)) == INVALID_GROUP_ID)
642 /* Oh well, just ignore it. */
646 new OverrideType:o_type = Override_Command;
647 if (StrEqual(type, "group"))
649 o_type = Override_CommandGroup;
652 new OverrideRule:o_rule = Command_Deny;
653 if (StrEqual(access, "allow"))
655 o_rule = Command_Allow;
659 PrintToServer("AddAdmGroupCmdOverride(%d, %s, %d, %d)", gid, command, o_type, o_rule);
662 AddAdmGroupCmdOverride(gid, command, o_type, o_rule);
666 * It's time to get the group immunity list.
669 decl String:query[256];
670 len += Format(query[len], sizeof(query)-len, "SELECT g1.name, g2.name FROM sm_group_immunity gi");
671 len += Format(query[len], sizeof(query)-len, " LEFT JOIN sm_groups g1 ON g1.id = gi.group_id ");
672 len += Format(query[len], sizeof(query)-len, " LEFT JOIN sm_groups g2 ON g2.id = gi.other_id");
675 WritePackCell(pk, sequence);
676 WritePackString(pk, query);
678 SQL_TQuery(owner, OnReceiveGroupImmunity, query, pk, DBPrio_High);
681 public OnReceiveGroups(Handle:owner, Handle:hndl, const String:error[], any:data)
683 new Handle:pk = Handle:data;
687 * Check if this is the latest result request.
689 new sequence = ReadPackCell(pk);
690 if (RebuildCachePart[_:AdminCache_Groups] != sequence)
692 /* Discard everything, since we're out of sequence. */
698 * If we need to use the results, make sure they succeeded.
700 if (hndl == INVALID_HANDLE)
702 decl String:query[255];
703 ReadPackString(pk, query, sizeof(query));
704 LogError("SQL error receiving groups: %s", error);
705 LogError("Query dump: %s", query);
711 * Now start fetching groups.
713 decl String:immunity[16];
714 decl String:flags[32];
715 decl String:name[128];
716 while (SQL_FetchRow(hndl))
718 SQL_FetchString(hndl, 0, immunity, sizeof(immunity));
719 SQL_FetchString(hndl, 1, flags, sizeof(flags));
720 SQL_FetchString(hndl, 2, name, sizeof(name));
723 PrintToServer("Adding group (%s, %s, %s)", immunity, flags, name);
726 /* Find or create the group */
728 if ((gid = FindAdmGroup(name)) == INVALID_GROUP_ID)
730 gid = CreateAdmGroup(name);
733 /* Add flags from the database to the group */
734 new num_flag_chars = strlen(flags);
735 for (new i=0; i<num_flag_chars; i++)
738 if (!FindFlagByChar(flags[i], flag))
742 SetAdmGroupAddFlag(gid, flag, true);
745 /* Set the immunity level this group has */
746 if (StrEqual(immunity, "all"))
748 SetAdmGroupImmunity(gid, Immunity_Default, true);
749 SetAdmGroupImmunity(gid, Immunity_Global, true);
750 } else if (StrEqual(immunity, "default")) {
751 SetAdmGroupImmunity(gid, Immunity_Default, true);
752 } else if (StrEqual(immunity, "global")) {
753 SetAdmGroupImmunity(gid, Immunity_Global, true);
758 * It's time to get the group override list.
760 decl String:query[255];
763 "SELECT g.name, og.type, og.name, og.access FROM sm_group_overrides og JOIN sm_groups g ON og.group_id = g.id ORDER BY g.id DESC");
766 WritePackCell(pk, sequence);
767 WritePackString(pk, query);
769 SQL_TQuery(owner, OnReceiveGroupOverrides, query, pk, DBPrio_High);
772 FetchGroups(Handle:db, sequence)
774 decl String:query[255];
777 Format(query, sizeof(query), "SELECT immunity, flags, name FROM sm_groups");
779 pk = CreateDataPack();
780 WritePackCell(pk, sequence);
781 WritePackString(pk, query);
783 SQL_TQuery(db, OnReceiveGroups, query, pk, DBPrio_High);
786 public OnReceiveOverrides(Handle:owner, Handle:hndl, const String:error[], any:data)
788 new Handle:pk = Handle:data;
792 * Check if this is the latest result request.
794 new sequence = ReadPackCell(pk);
795 if (RebuildCachePart[_:AdminCache_Overrides] != sequence)
797 /* Discard everything, since we're out of sequence. */
803 * If we need to use the results, make sure they succeeded.
805 if (hndl == INVALID_HANDLE)
807 decl String:query[255];
808 ReadPackString(pk, query, sizeof(query));
809 LogError("SQL error receiving overrides: %s", error);
810 LogError("Query dump: %s", query);
816 * We're done with you, now.
820 decl String:type[64];
821 decl String:name[64];
822 decl String:flags[32];
824 while (SQL_FetchRow(hndl))
826 SQL_FetchString(hndl, 0, type, sizeof(type));
827 SQL_FetchString(hndl, 1, name, sizeof(name));
828 SQL_FetchString(hndl, 2, flags, sizeof(flags));
831 PrintToServer("Adding override (%s, %s, %s)", type, name, flags);
834 flag_bits = ReadFlagString(flags);
835 if (StrEqual(type, "command"))
837 AddCommandOverride(name, Override_Command, flag_bits);
838 } else if (StrEqual(type, "group")) {
839 AddCommandOverride(name, Override_CommandGroup, flag_bits);
843 /* Clear the sequence so another connect doesn't refetch */
844 RebuildCachePart[_:AdminCache_Overrides] = 0;
847 FetchOverrides(Handle:db, sequence)
849 decl String:query[255];
852 Format(query, sizeof(query), "SELECT type, name, flags FROM sm_overrides");
854 pk = CreateDataPack();
855 WritePackCell(pk, sequence);
856 WritePackString(pk, query);
858 SQL_TQuery(db, OnReceiveOverrides, query, pk, DBPrio_High);
862 * Finds an entry in a temporary group list (used by immunity resolver).
864 * @param group_list Array(3,n) (0=db id, 1=gid, 2=immunity list)
865 * @param id group database id
866 * @return GroupId of the database id or INVALID_GROUP_ID.
868 stock GroupId:UTIL_FindGroupInCache(Handle:group_list, id)
870 new size = GetArraySize(group_list);
872 for (new i=0; i<size; i++)
875 GetArrayArray(group_list, i, data);
879 return GroupId:data[1];
883 return INVALID_GROUP_ID;
887 * Breaks a comma-delimited string into a list of numbers, returning a new
890 * @param text The string to split.
891 * @return A new array Handle which must be closed, or
892 * INVALID_HANDLE on no strings found.
894 stock Handle:UTIL_ExplodeNumberString(const String:text[])
896 new Handle:array = INVALID_HANDLE;
897 decl String:buffer[32];
900 while ((idx = SplitString(text[reloc_idx], ",", buffer, sizeof(buffer))) != -1)
903 if (text[reloc_idx] == '\0')
907 if (array == INVALID_HANDLE)
909 array = CreateArray();
911 PushArrayCell(array, StringToInt(buffer));
914 if (text[reloc_idx] != '\0')
916 if (array == INVALID_HANDLE)
918 array = CreateArray();
920 PushArrayCell(array, StringToInt(text[reloc_idx]));