/* (c) Magnus Auvinen. See licence.txt in the root of the distribution for more information. */ /* If you are missing that file, acquire a complete release at teeworlds.com. */ #include "serverbrowser.h" #include "serverbrowser_http.h" #include "serverbrowser_ping_cache.h" #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include // PAGE_DDNET class CSortWrap { typedef bool (CServerBrowser::*SortFunc)(int, int) const; SortFunc m_pfnSort; CServerBrowser *m_pThis; public: CSortWrap(CServerBrowser *pServer, SortFunc Func) : m_pfnSort(Func), m_pThis(pServer) {} bool operator()(int a, int b) { return (g_Config.m_BrSortOrder ? (m_pThis->*m_pfnSort)(b, a) : (m_pThis->*m_pfnSort)(a, b)); } }; CServerBrowser::CServerBrowser() { m_ppServerlist = 0; m_pSortedServerlist = 0; m_pFirstReqServer = 0; // request list m_pLastReqServer = 0; m_NumRequests = 0; m_NumSortedServers = 0; m_NumSortedServersCapacity = 0; m_NumServers = 0; m_NumServerCapacity = 0; m_Sorthash = 0; m_aFilterString[0] = 0; m_aFilterGametypeString[0] = 0; m_ServerlistType = 0; m_BroadcastTime = 0; secure_random_fill(m_aTokenSeed, sizeof(m_aTokenSeed)); m_pDDNetInfo = 0; m_SortOnNextUpdate = false; } CServerBrowser::~CServerBrowser() { free(m_ppServerlist); free(m_pSortedServerlist); json_value_free(m_pDDNetInfo); delete m_pHttp; m_pHttp = nullptr; delete m_pPingCache; m_pPingCache = nullptr; } void CServerBrowser::SetBaseInfo(class CNetClient *pClient, const char *pNetVersion) { m_pNetClient = pClient; str_copy(m_aNetVersion, pNetVersion); m_pConsole = Kernel()->RequestInterface(); m_pEngine = Kernel()->RequestInterface(); m_pFavorites = Kernel()->RequestInterface(); m_pFriends = Kernel()->RequestInterface(); m_pStorage = Kernel()->RequestInterface(); m_pPingCache = CreateServerBrowserPingCache(m_pConsole, m_pStorage); RegisterCommands(); } void CServerBrowser::OnInit() { m_pHttp = CreateServerBrowserHttp(m_pEngine, m_pConsole, m_pStorage, g_Config.m_BrCachedBestServerinfoUrl); } void CServerBrowser::RegisterCommands() { m_pConsole->Register("leak_ip_address_to_all_servers", "", CFGFLAG_CLIENT, Con_LeakIpAddress, this, "Leaks your IP address to all servers by pinging each of them, also acquiring the latency in the process"); } void CServerBrowser::Con_LeakIpAddress(IConsole::IResult *pResult, void *pUserData) { CServerBrowser *pThis = (CServerBrowser *)pUserData; // We only consider the first address of every server. std::vector vSortedServers; // Sort servers by IP address, ignoring port. class CAddrComparer { public: CServerBrowser *m_pThis; bool operator()(int i, int j) { NETADDR Addr1 = m_pThis->m_ppServerlist[i]->m_Info.m_aAddresses[0]; NETADDR Addr2 = m_pThis->m_ppServerlist[j]->m_Info.m_aAddresses[0]; Addr1.port = 0; Addr2.port = 0; return net_addr_comp(&Addr1, &Addr2) < 0; } }; vSortedServers.reserve(pThis->m_NumServers); for(int i = 0; i < pThis->m_NumServers; i++) { vSortedServers.push_back(i); } std::sort(vSortedServers.begin(), vSortedServers.end(), CAddrComparer{pThis}); // Group the servers into those with same IP address (but differing // port). NETADDR Addr; int Start = -1; for(int i = 0; i <= (int)vSortedServers.size(); i++) { NETADDR NextAddr; if(i < (int)vSortedServers.size()) { NextAddr = pThis->m_ppServerlist[vSortedServers[i]]->m_Info.m_aAddresses[0]; NextAddr.port = 0; } bool New = Start == -1 || i == (int)vSortedServers.size() || net_addr_comp(&Addr, &NextAddr) != 0; if(Start != -1 && New) { int Chosen = Start + secure_rand_below(i - Start); CServerEntry *pChosen = pThis->m_ppServerlist[vSortedServers[Chosen]]; pChosen->m_RequestIgnoreInfo = true; pThis->QueueRequest(pChosen); char aAddr[NETADDR_MAXSTRSIZE]; net_addr_str(&pChosen->m_Info.m_aAddresses[0], aAddr, sizeof(aAddr), true); dbg_msg("serverbrowse/dbg", "queuing ping request for %s", aAddr); } if(i < (int)vSortedServers.size() && New) { Start = i; Addr = NextAddr; } } } const CServerInfo *CServerBrowser::SortedGet(int Index) const { if(Index < 0 || Index >= m_NumSortedServers) return 0; return &m_ppServerlist[m_pSortedServerlist[Index]]->m_Info; } int CServerBrowser::GenerateToken(const NETADDR &Addr) const { SHA256_CTX Sha256; sha256_init(&Sha256); sha256_update(&Sha256, m_aTokenSeed, sizeof(m_aTokenSeed)); sha256_update(&Sha256, (unsigned char *)&Addr, sizeof(Addr)); SHA256_DIGEST Digest = sha256_finish(&Sha256); return (Digest.data[0] << 16) | (Digest.data[1] << 8) | Digest.data[2]; } int CServerBrowser::GetBasicToken(int Token) { return Token & 0xff; } int CServerBrowser::GetExtraToken(int Token) { return Token >> 8; } bool CServerBrowser::SortCompareName(int Index1, int Index2) const { CServerEntry *pIndex1 = m_ppServerlist[Index1]; CServerEntry *pIndex2 = m_ppServerlist[Index2]; // make sure empty entries are listed last return (pIndex1->m_GotInfo && pIndex2->m_GotInfo) || (!pIndex1->m_GotInfo && !pIndex2->m_GotInfo) ? str_comp(pIndex1->m_Info.m_aName, pIndex2->m_Info.m_aName) < 0 : pIndex1->m_GotInfo != 0; } bool CServerBrowser::SortCompareMap(int Index1, int Index2) const { CServerEntry *pIndex1 = m_ppServerlist[Index1]; CServerEntry *pIndex2 = m_ppServerlist[Index2]; return str_comp(pIndex1->m_Info.m_aMap, pIndex2->m_Info.m_aMap) < 0; } bool CServerBrowser::SortComparePing(int Index1, int Index2) const { CServerEntry *pIndex1 = m_ppServerlist[Index1]; CServerEntry *pIndex2 = m_ppServerlist[Index2]; return pIndex1->m_Info.m_Latency < pIndex2->m_Info.m_Latency; } bool CServerBrowser::SortCompareGametype(int Index1, int Index2) const { CServerEntry *pIndex1 = m_ppServerlist[Index1]; CServerEntry *pIndex2 = m_ppServerlist[Index2]; return str_comp(pIndex1->m_Info.m_aGameType, pIndex2->m_Info.m_aGameType) < 0; } bool CServerBrowser::SortCompareNumPlayers(int Index1, int Index2) const { CServerEntry *pIndex1 = m_ppServerlist[Index1]; CServerEntry *pIndex2 = m_ppServerlist[Index2]; return pIndex1->m_Info.m_NumFilteredPlayers > pIndex2->m_Info.m_NumFilteredPlayers; } bool CServerBrowser::SortCompareNumClients(int Index1, int Index2) const { CServerEntry *pIndex1 = m_ppServerlist[Index1]; CServerEntry *pIndex2 = m_ppServerlist[Index2]; return pIndex1->m_Info.m_NumClients > pIndex2->m_Info.m_NumClients; } bool CServerBrowser::SortCompareNumPlayersAndPing(int Index1, int Index2) const { CServerEntry *pIndex1 = m_ppServerlist[Index1]; CServerEntry *pIndex2 = m_ppServerlist[Index2]; if(pIndex1->m_Info.m_NumFilteredPlayers == pIndex2->m_Info.m_NumFilteredPlayers) return pIndex1->m_Info.m_Latency > pIndex2->m_Info.m_Latency; else if(pIndex1->m_Info.m_NumFilteredPlayers == 0 || pIndex2->m_Info.m_NumFilteredPlayers == 0 || pIndex1->m_Info.m_Latency / 100 == pIndex2->m_Info.m_Latency / 100) return pIndex1->m_Info.m_NumFilteredPlayers < pIndex2->m_Info.m_NumFilteredPlayers; else return pIndex1->m_Info.m_Latency > pIndex2->m_Info.m_Latency; } void CServerBrowser::Filter() { m_NumSortedServers = 0; // allocate the sorted list if(m_NumSortedServersCapacity < m_NumServers) { free(m_pSortedServerlist); m_NumSortedServersCapacity = m_NumServers; m_pSortedServerlist = (int *)calloc(m_NumSortedServersCapacity, sizeof(int)); } // filter the servers for(int i = 0; i < m_NumServers; i++) { int Filtered = 0; if(g_Config.m_BrFilterEmpty && m_ppServerlist[i]->m_Info.m_NumFilteredPlayers == 0) Filtered = 1; else if(g_Config.m_BrFilterFull && Players(m_ppServerlist[i]->m_Info) == Max(m_ppServerlist[i]->m_Info)) Filtered = 1; else if(g_Config.m_BrFilterPw && m_ppServerlist[i]->m_Info.m_Flags & SERVER_FLAG_PASSWORD) Filtered = 1; else if(g_Config.m_BrFilterServerAddress[0] && !str_find_nocase(m_ppServerlist[i]->m_Info.m_aAddress, g_Config.m_BrFilterServerAddress)) Filtered = 1; else if(g_Config.m_BrFilterGametypeStrict && g_Config.m_BrFilterGametype[0] && str_comp_nocase(m_ppServerlist[i]->m_Info.m_aGameType, g_Config.m_BrFilterGametype)) Filtered = 1; else if(!g_Config.m_BrFilterGametypeStrict && g_Config.m_BrFilterGametype[0] && !str_utf8_find_nocase(m_ppServerlist[i]->m_Info.m_aGameType, g_Config.m_BrFilterGametype)) Filtered = 1; else if(g_Config.m_BrFilterUnfinishedMap && m_ppServerlist[i]->m_Info.m_HasRank == 1) Filtered = 1; else { if(g_Config.m_BrFilterCountry) { Filtered = 1; // match against player country for(int p = 0; p < minimum(m_ppServerlist[i]->m_Info.m_NumClients, (int)MAX_CLIENTS); p++) { if(m_ppServerlist[i]->m_Info.m_aClients[p].m_Country == g_Config.m_BrFilterCountryIndex) { Filtered = 0; break; } } } if(!Filtered && g_Config.m_BrFilterString[0] != '\0') { int MatchFound = 0; m_ppServerlist[i]->m_Info.m_QuickSearchHit = 0; const char *pStr = g_Config.m_BrFilterString; char aFilterStr[sizeof(g_Config.m_BrFilterString)]; while((pStr = str_next_token(pStr, IServerBrowser::SEARCH_EXCLUDE_TOKEN, aFilterStr, sizeof(aFilterStr)))) { if(aFilterStr[0] == '\0') { continue; } // match against server name if(str_utf8_find_nocase(m_ppServerlist[i]->m_Info.m_aName, aFilterStr)) { MatchFound = 1; m_ppServerlist[i]->m_Info.m_QuickSearchHit |= IServerBrowser::QUICK_SERVERNAME; } // match against players for(int p = 0; p < minimum(m_ppServerlist[i]->m_Info.m_NumClients, (int)MAX_CLIENTS); p++) { if(str_utf8_find_nocase(m_ppServerlist[i]->m_Info.m_aClients[p].m_aName, aFilterStr) || str_utf8_find_nocase(m_ppServerlist[i]->m_Info.m_aClients[p].m_aClan, aFilterStr)) { MatchFound = 1; m_ppServerlist[i]->m_Info.m_QuickSearchHit |= IServerBrowser::QUICK_PLAYER; break; } } // match against map if(str_utf8_find_nocase(m_ppServerlist[i]->m_Info.m_aMap, aFilterStr)) { MatchFound = 1; m_ppServerlist[i]->m_Info.m_QuickSearchHit |= IServerBrowser::QUICK_MAPNAME; } } if(!MatchFound) Filtered = 1; } if(!Filtered && g_Config.m_BrExcludeString[0] != '\0') { const char *pStr = g_Config.m_BrExcludeString; char aExcludeStr[sizeof(g_Config.m_BrExcludeString)]; while((pStr = str_next_token(pStr, IServerBrowser::SEARCH_EXCLUDE_TOKEN, aExcludeStr, sizeof(aExcludeStr)))) { if(aExcludeStr[0] == '\0') { continue; } // match against server name if(str_utf8_find_nocase(m_ppServerlist[i]->m_Info.m_aName, aExcludeStr)) { Filtered = 1; break; } // match against map if(str_utf8_find_nocase(m_ppServerlist[i]->m_Info.m_aMap, aExcludeStr)) { Filtered = 1; break; } // match against gametype if(str_utf8_find_nocase(m_ppServerlist[i]->m_Info.m_aGameType, aExcludeStr)) { Filtered = 1; break; } } } } if(Filtered == 0) { // check for friend m_ppServerlist[i]->m_Info.m_FriendState = IFriends::FRIEND_NO; for(int p = 0; p < minimum(m_ppServerlist[i]->m_Info.m_NumClients, (int)MAX_CLIENTS); p++) { m_ppServerlist[i]->m_Info.m_aClients[p].m_FriendState = m_pFriends->GetFriendState(m_ppServerlist[i]->m_Info.m_aClients[p].m_aName, m_ppServerlist[i]->m_Info.m_aClients[p].m_aClan); m_ppServerlist[i]->m_Info.m_FriendState = maximum(m_ppServerlist[i]->m_Info.m_FriendState, m_ppServerlist[i]->m_Info.m_aClients[p].m_FriendState); } if(!g_Config.m_BrFilterFriends || m_ppServerlist[i]->m_Info.m_FriendState != IFriends::FRIEND_NO) m_pSortedServerlist[m_NumSortedServers++] = i; } } } int CServerBrowser::SortHash() const { int i = g_Config.m_BrSort & 0xff; i |= g_Config.m_BrFilterEmpty << 4; i |= g_Config.m_BrFilterFull << 5; i |= g_Config.m_BrFilterSpectators << 6; i |= g_Config.m_BrFilterFriends << 7; i |= g_Config.m_BrFilterPw << 8; i |= g_Config.m_BrSortOrder << 9; i |= g_Config.m_BrFilterGametypeStrict << 12; i |= g_Config.m_BrFilterUnfinishedMap << 13; i |= g_Config.m_BrFilterCountry << 14; i |= g_Config.m_BrFilterConnectingPlayers << 15; return i; } void SetFilteredPlayers(const CServerInfo &Item) { Item.m_NumFilteredPlayers = g_Config.m_BrFilterSpectators ? Item.m_NumPlayers : Item.m_NumClients; if(g_Config.m_BrFilterConnectingPlayers) { for(const auto &Client : Item.m_aClients) { if((!g_Config.m_BrFilterSpectators || Client.m_Player) && str_comp(Client.m_aName, "(connecting)") == 0 && Client.m_aClan[0] == '\0') Item.m_NumFilteredPlayers--; } } } void CServerBrowser::Sort() { // fill m_NumFilteredPlayers for(int i = 0; i < m_NumServers; i++) { SetFilteredPlayers(m_ppServerlist[i]->m_Info); } // create filtered list Filter(); // sort if(g_Config.m_BrSortOrder == 2 && (g_Config.m_BrSort == IServerBrowser::SORT_NUMPLAYERS || g_Config.m_BrSort == IServerBrowser::SORT_PING)) std::stable_sort(m_pSortedServerlist, m_pSortedServerlist + m_NumSortedServers, CSortWrap(this, &CServerBrowser::SortCompareNumPlayersAndPing)); else if(g_Config.m_BrSort == IServerBrowser::SORT_NAME) std::stable_sort(m_pSortedServerlist, m_pSortedServerlist + m_NumSortedServers, CSortWrap(this, &CServerBrowser::SortCompareName)); else if(g_Config.m_BrSort == IServerBrowser::SORT_PING) std::stable_sort(m_pSortedServerlist, m_pSortedServerlist + m_NumSortedServers, CSortWrap(this, &CServerBrowser::SortComparePing)); else if(g_Config.m_BrSort == IServerBrowser::SORT_MAP) std::stable_sort(m_pSortedServerlist, m_pSortedServerlist + m_NumSortedServers, CSortWrap(this, &CServerBrowser::SortCompareMap)); else if(g_Config.m_BrSort == IServerBrowser::SORT_NUMPLAYERS) std::stable_sort(m_pSortedServerlist, m_pSortedServerlist + m_NumSortedServers, CSortWrap(this, &CServerBrowser::SortCompareNumPlayers)); else if(g_Config.m_BrSort == IServerBrowser::SORT_GAMETYPE) std::stable_sort(m_pSortedServerlist, m_pSortedServerlist + m_NumSortedServers, CSortWrap(this, &CServerBrowser::SortCompareGametype)); str_copy(m_aFilterGametypeString, g_Config.m_BrFilterGametype); str_copy(m_aFilterString, g_Config.m_BrFilterString); m_Sorthash = SortHash(); } void CServerBrowser::RemoveRequest(CServerEntry *pEntry) { if(pEntry->m_pPrevReq || pEntry->m_pNextReq || m_pFirstReqServer == pEntry) { if(pEntry->m_pPrevReq) pEntry->m_pPrevReq->m_pNextReq = pEntry->m_pNextReq; else m_pFirstReqServer = pEntry->m_pNextReq; if(pEntry->m_pNextReq) pEntry->m_pNextReq->m_pPrevReq = pEntry->m_pPrevReq; else m_pLastReqServer = pEntry->m_pPrevReq; pEntry->m_pPrevReq = 0; pEntry->m_pNextReq = 0; m_NumRequests--; } } CServerBrowser::CServerEntry *CServerBrowser::Find(const NETADDR &Addr) { auto Entry = m_ByAddr.find(Addr); if(Entry == m_ByAddr.end()) { return nullptr; } return m_ppServerlist[Entry->second]; } void CServerBrowser::QueueRequest(CServerEntry *pEntry) { // add it to the list of servers that we should request info from pEntry->m_pPrevReq = m_pLastReqServer; if(m_pLastReqServer) m_pLastReqServer->m_pNextReq = pEntry; else m_pFirstReqServer = pEntry; m_pLastReqServer = pEntry; pEntry->m_pNextReq = 0; m_NumRequests++; } void ServerBrowserFormatAddresses(char *pBuffer, int BufferSize, NETADDR *pAddrs, int NumAddrs) { for(int i = 0; i < NumAddrs; i++) { if(i != 0) { if(BufferSize <= 1) { return; } pBuffer[0] = ','; pBuffer[1] = 0; pBuffer += 1; BufferSize -= 1; } if(BufferSize <= 1) { return; } net_addr_str(&pAddrs[i], pBuffer, BufferSize, true); int Length = str_length(pBuffer); pBuffer += Length; BufferSize -= Length; } } void CServerBrowser::SetInfo(CServerEntry *pEntry, const CServerInfo &Info) { CServerInfo TmpInfo = pEntry->m_Info; pEntry->m_Info = Info; pEntry->m_Info.m_Favorite = TmpInfo.m_Favorite; pEntry->m_Info.m_FavoriteAllowPing = TmpInfo.m_FavoriteAllowPing; pEntry->m_Info.m_Official = TmpInfo.m_Official; mem_copy(pEntry->m_Info.m_aAddresses, TmpInfo.m_aAddresses, sizeof(pEntry->m_Info.m_aAddresses)); pEntry->m_Info.m_NumAddresses = TmpInfo.m_NumAddresses; ServerBrowserFormatAddresses(pEntry->m_Info.m_aAddress, sizeof(pEntry->m_Info.m_aAddress), pEntry->m_Info.m_aAddresses, pEntry->m_Info.m_NumAddresses); class CPlayerScoreNameLess { public: bool operator()(const CServerInfo::CClient &p0, const CServerInfo::CClient &p1) { if(p0.m_Player && !p1.m_Player) return true; if(!p0.m_Player && p1.m_Player) return false; int Score0 = p0.m_Score; int Score1 = p1.m_Score; if(Score0 == -9999) Score0 = INT_MIN; if(Score1 == -9999) Score1 = INT_MIN; if(Score0 > Score1) return true; if(Score0 < Score1) return false; return str_comp_nocase(p0.m_aName, p1.m_aName) < 0; } }; std::sort(pEntry->m_Info.m_aClients, pEntry->m_Info.m_aClients + Info.m_NumReceivedClients, CPlayerScoreNameLess()); pEntry->m_GotInfo = 1; } void CServerBrowser::SetLatency(NETADDR Addr, int Latency) { m_pPingCache->CachePing(Addr, Latency); Addr.port = 0; for(int i = 0; i < m_NumServers; i++) { if(!m_ppServerlist[i]->m_GotInfo) { continue; } bool Found = false; for(int j = 0; j < m_ppServerlist[i]->m_Info.m_NumAddresses; j++) { NETADDR Other = m_ppServerlist[i]->m_Info.m_aAddresses[j]; Other.port = 0; if(Addr == Other) { Found = true; break; } } if(!Found) { continue; } int Ping = m_pPingCache->GetPing(m_ppServerlist[i]->m_Info.m_aAddresses, m_ppServerlist[i]->m_Info.m_NumAddresses); if(Ping == -1) { continue; } m_ppServerlist[i]->m_Info.m_Latency = Ping; m_ppServerlist[i]->m_Info.m_LatencyIsEstimated = false; } } CServerBrowser::CServerEntry *CServerBrowser::Add(const NETADDR *pAddrs, int NumAddrs) { // create new pEntry CServerEntry *pEntry = (CServerEntry *)m_ServerlistHeap.Allocate(sizeof(CServerEntry)); mem_zero(pEntry, sizeof(CServerEntry)); // set the info mem_copy(pEntry->m_Info.m_aAddresses, pAddrs, NumAddrs * sizeof(pAddrs[0])); pEntry->m_Info.m_NumAddresses = NumAddrs; pEntry->m_Info.m_Latency = 999; pEntry->m_Info.m_HasRank = -1; ServerBrowserFormatAddresses(pEntry->m_Info.m_aAddress, sizeof(pEntry->m_Info.m_aAddress), pEntry->m_Info.m_aAddresses, pEntry->m_Info.m_NumAddresses); str_copy(pEntry->m_Info.m_aName, pEntry->m_Info.m_aAddress, sizeof(pEntry->m_Info.m_aName)); // check if it's a favorite pEntry->m_Info.m_Favorite = m_pFavorites->IsFavorite(pEntry->m_Info.m_aAddresses, pEntry->m_Info.m_NumAddresses); pEntry->m_Info.m_FavoriteAllowPing = m_pFavorites->IsPingAllowed(pEntry->m_Info.m_aAddresses, pEntry->m_Info.m_NumAddresses); // check if it's an official server bool Official = false; for(int i = 0; !Official && i < (int)std::size(m_aNetworks); i++) { for(int j = 0; !Official && j < m_aNetworks[i].m_NumCountries; j++) { CNetworkCountry *pCntr = &m_aNetworks[i].m_aCountries[j]; for(int k = 0; !Official && k < pCntr->m_NumServers; k++) { for(int l = 0; !Official && l < NumAddrs; l++) { if(pAddrs[l] == pCntr->m_aServers[k]) { Official = true; } } } } } pEntry->m_Info.m_Official = Official; for(int i = 0; i < NumAddrs; i++) { m_ByAddr[pAddrs[i]] = m_NumServers; } if(m_NumServers == m_NumServerCapacity) { CServerEntry **ppNewlist; m_NumServerCapacity += 100; ppNewlist = (CServerEntry **)calloc(m_NumServerCapacity, sizeof(CServerEntry *)); // NOLINT(bugprone-sizeof-expression) if(m_NumServers > 0) mem_copy(ppNewlist, m_ppServerlist, m_NumServers * sizeof(CServerEntry *)); // NOLINT(bugprone-sizeof-expression) free(m_ppServerlist); m_ppServerlist = ppNewlist; } // add to list m_ppServerlist[m_NumServers] = pEntry; pEntry->m_Info.m_ServerIndex = m_NumServers; m_NumServers++; return pEntry; } void CServerBrowser::OnServerInfoUpdate(const NETADDR &Addr, int Token, const CServerInfo *pInfo) { int BasicToken = Token; int ExtraToken = 0; if(pInfo->m_Type == SERVERINFO_EXTENDED) { BasicToken = Token & 0xff; ExtraToken = Token >> 8; } CServerEntry *pEntry = Find(Addr); if(m_ServerlistType == IServerBrowser::TYPE_LAN) { NETADDR Broadcast; mem_zero(&Broadcast, sizeof(Broadcast)); Broadcast.type = m_pNetClient->NetType() | NETTYPE_LINK_BROADCAST; int TokenBC = GenerateToken(Broadcast); bool Drop = false; Drop = Drop || BasicToken != GetBasicToken(TokenBC); Drop = Drop || (pInfo->m_Type == SERVERINFO_EXTENDED && ExtraToken != GetExtraToken(TokenBC)); if(Drop) { return; } if(!pEntry) pEntry = Add(&Addr, 1); } else { if(!pEntry) { return; } int TokenAddr = GenerateToken(Addr); bool Drop = false; Drop = Drop || BasicToken != GetBasicToken(TokenAddr); Drop = Drop || (pInfo->m_Type == SERVERINFO_EXTENDED && ExtraToken != GetExtraToken(TokenAddr)); if(Drop) { return; } } if(m_ServerlistType == IServerBrowser::TYPE_LAN) { SetInfo(pEntry, *pInfo); pEntry->m_Info.m_Latency = minimum(static_cast((time_get() - m_BroadcastTime) * 1000 / time_freq()), 999); } else if(pEntry->m_RequestTime > 0) { if(!pEntry->m_RequestIgnoreInfo) { SetInfo(pEntry, *pInfo); } int Latency = minimum(static_cast((time_get() - pEntry->m_RequestTime) * 1000 / time_freq()), 999); if(!pEntry->m_RequestIgnoreInfo) { pEntry->m_Info.m_Latency = Latency; } else { char aAddr[NETADDR_MAXSTRSIZE]; net_addr_str(&Addr, aAddr, sizeof(aAddr), true); dbg_msg("serverbrowse/dbg", "received ping response from %s", aAddr); SetLatency(Addr, Latency); } pEntry->m_RequestTime = -1; // Request has been answered } RemoveRequest(pEntry); m_SortOnNextUpdate = true; } void CServerBrowser::Refresh(int Type) { bool ServerListTypeChanged = m_ServerlistType != Type; int OldServerListType = m_ServerlistType; m_ServerlistType = Type; secure_random_fill(m_aTokenSeed, sizeof(m_aTokenSeed)); if(Type == IServerBrowser::TYPE_LAN || (ServerListTypeChanged && OldServerListType == IServerBrowser::TYPE_LAN)) CleanUp(); if(Type == IServerBrowser::TYPE_LAN) { unsigned char aBuffer[sizeof(SERVERBROWSE_GETINFO) + 1]; CNetChunk Packet; /* do the broadcast version */ Packet.m_ClientID = -1; mem_zero(&Packet, sizeof(Packet)); Packet.m_Address.type = m_pNetClient->NetType() | NETTYPE_LINK_BROADCAST; Packet.m_Flags = NETSENDFLAG_CONNLESS | NETSENDFLAG_EXTENDED; Packet.m_DataSize = sizeof(aBuffer); Packet.m_pData = aBuffer; mem_zero(&Packet.m_aExtraData, sizeof(Packet.m_aExtraData)); int Token = GenerateToken(Packet.m_Address); mem_copy(aBuffer, SERVERBROWSE_GETINFO, sizeof(SERVERBROWSE_GETINFO)); aBuffer[sizeof(SERVERBROWSE_GETINFO)] = GetBasicToken(Token); Packet.m_aExtraData[0] = GetExtraToken(Token) >> 8; Packet.m_aExtraData[1] = GetExtraToken(Token) & 0xff; m_BroadcastTime = time_get(); for(int i = 8303; i <= 8310; i++) { Packet.m_Address.port = i; m_pNetClient->Send(&Packet); } if(g_Config.m_Debug) m_pConsole->Print(IConsole::OUTPUT_LEVEL_DEBUG, "client_srvbrowse", "broadcasting for servers"); } else if(Type == IServerBrowser::TYPE_FAVORITES || Type == IServerBrowser::TYPE_INTERNET || Type == IServerBrowser::TYPE_DDNET || Type == IServerBrowser::TYPE_KOG) { m_pHttp->Refresh(); m_pPingCache->Load(); m_RefreshingHttp = true; if(ServerListTypeChanged && m_pHttp->NumServers() > 0) { CleanUp(); UpdateFromHttp(); Sort(); } } } void CServerBrowser::RequestImpl(const NETADDR &Addr, CServerEntry *pEntry, int *pBasicToken, int *pToken, bool RandomToken) const { if(g_Config.m_Debug) { char aAddrStr[NETADDR_MAXSTRSIZE]; net_addr_str(&Addr, aAddrStr, sizeof(aAddrStr), true); char aBuf[256]; str_format(aBuf, sizeof(aBuf), "requesting server info from %s", aAddrStr); m_pConsole->Print(IConsole::OUTPUT_LEVEL_DEBUG, "client_srvbrowse", aBuf); } int Token = GenerateToken(Addr); if(RandomToken) { int AvoidBasicToken = GetBasicToken(Token); do { secure_random_fill(&Token, sizeof(Token)); Token &= 0xffffff; } while(GetBasicToken(Token) == AvoidBasicToken); } if(pToken) { *pToken = Token; } if(pBasicToken) { *pBasicToken = GetBasicToken(Token); } unsigned char aBuffer[sizeof(SERVERBROWSE_GETINFO) + 1]; mem_copy(aBuffer, SERVERBROWSE_GETINFO, sizeof(SERVERBROWSE_GETINFO)); aBuffer[sizeof(SERVERBROWSE_GETINFO)] = GetBasicToken(Token); CNetChunk Packet; Packet.m_ClientID = -1; Packet.m_Address = Addr; Packet.m_Flags = NETSENDFLAG_CONNLESS | NETSENDFLAG_EXTENDED; Packet.m_DataSize = sizeof(aBuffer); Packet.m_pData = aBuffer; mem_zero(&Packet.m_aExtraData, sizeof(Packet.m_aExtraData)); Packet.m_aExtraData[0] = GetExtraToken(Token) >> 8; Packet.m_aExtraData[1] = GetExtraToken(Token) & 0xff; m_pNetClient->Send(&Packet); if(pEntry) pEntry->m_RequestTime = time_get(); } void CServerBrowser::RequestCurrentServer(const NETADDR &Addr) const { RequestImpl(Addr, nullptr, nullptr, nullptr, false); } void CServerBrowser::RequestCurrentServerWithRandomToken(const NETADDR &Addr, int *pBasicToken, int *pToken) const { RequestImpl(Addr, nullptr, pBasicToken, pToken, true); } void CServerBrowser::SetCurrentServerPing(const NETADDR &Addr, int Ping) { SetLatency(Addr, minimum(Ping, 999)); } void CServerBrowser::UpdateFromHttp() { int OwnLocation; if(str_comp(g_Config.m_BrLocation, "auto") == 0) { OwnLocation = m_OwnLocation; } else { if(CServerInfo::ParseLocation(&OwnLocation, g_Config.m_BrLocation)) { char aBuf[64]; str_format(aBuf, sizeof(aBuf), "cannot parse br_location: '%s'", g_Config.m_BrLocation); m_pConsole->Print(IConsole::OUTPUT_LEVEL_STANDARD, "serverbrowse", aBuf); } } int NumServers = m_pHttp->NumServers(); int NumLegacyServers = m_pHttp->NumLegacyServers(); std::unordered_set WantedAddrs; std::function Want = [](const NETADDR *pAddrs, int NumAddrs) { return true; }; if(m_ServerlistType != IServerBrowser::TYPE_INTERNET) { if(m_ServerlistType == IServerBrowser::TYPE_FAVORITES) { Want = [&](const NETADDR *pAddrs, int NumAddrs) -> bool { return m_pFavorites->IsFavorite(pAddrs, NumAddrs) != TRISTATE::NONE; }; } else { int Network; char *pExcludeCountries; char *pExcludeTypes; switch(m_ServerlistType) { case IServerBrowser::TYPE_DDNET: Network = NETWORK_DDNET; pExcludeCountries = g_Config.m_BrFilterExcludeCountries; pExcludeTypes = g_Config.m_BrFilterExcludeTypes; break; case IServerBrowser::TYPE_KOG: Network = NETWORK_KOG; pExcludeCountries = g_Config.m_BrFilterExcludeCountriesKoG; pExcludeTypes = g_Config.m_BrFilterExcludeTypesKoG; break; default: dbg_assert(0, "invalid network"); return; } // remove unknown elements of exclude list CountryFilterClean(Network); TypeFilterClean(Network); int MaxServers = 0; for(int i = 0; i < m_aNetworks[Network].m_NumCountries; i++) { CNetworkCountry *pCntr = &m_aNetworks[Network].m_aCountries[i]; MaxServers = maximum(MaxServers, pCntr->m_NumServers); } for(int g = 0; g < MaxServers; g++) { for(int i = 0; i < m_aNetworks[Network].m_NumCountries; i++) { CNetworkCountry *pCntr = &m_aNetworks[Network].m_aCountries[i]; // check for filter if(DDNetFiltered(pExcludeCountries, pCntr->m_aName)) continue; if(g >= pCntr->m_NumServers) continue; if(DDNetFiltered(pExcludeTypes, pCntr->m_aTypes[g])) continue; WantedAddrs.insert(pCntr->m_aServers[g]); } } Want = [&](const NETADDR *pAddrs, int NumAddrs) -> bool { for(int i = 0; i < NumAddrs; i++) { if(WantedAddrs.count(pAddrs[i])) { return true; } } return false; }; } } for(int i = 0; i < NumServers; i++) { CServerInfo Info = m_pHttp->Server(i); if(!Want(Info.m_aAddresses, Info.m_NumAddresses)) { continue; } int Ping = m_pPingCache->GetPing(Info.m_aAddresses, Info.m_NumAddresses); Info.m_LatencyIsEstimated = Ping == -1; if(Info.m_LatencyIsEstimated) { Info.m_Latency = CServerInfo::EstimateLatency(OwnLocation, Info.m_Location); } else { Info.m_Latency = Ping; } Info.m_HasRank = HasRank(Info.m_aMap); CServerEntry *pEntry = Add(Info.m_aAddresses, Info.m_NumAddresses); SetInfo(pEntry, Info); pEntry->m_RequestIgnoreInfo = true; } for(int i = 0; i < NumLegacyServers; i++) { NETADDR Addr = m_pHttp->LegacyServer(i); if(!Want(&Addr, 1)) { continue; } QueueRequest(Add(&Addr, 1)); } if(m_ServerlistType == IServerBrowser::TYPE_FAVORITES) { const IFavorites::CEntry *pFavorites; int NumFavorites; m_pFavorites->AllEntries(&pFavorites, &NumFavorites); for(int i = 0; i < NumFavorites; i++) { bool Found = false; for(int j = 0; j < pFavorites[i].m_NumAddrs; j++) { if(Find(pFavorites[i].m_aAddrs[j])) { Found = true; break; } } if(Found) { continue; } // (Also add favorites we're not allowed to ping.) CServerEntry *pEntry = Add(pFavorites[i].m_aAddrs, pFavorites[i].m_NumAddrs); if(pFavorites->m_AllowPing) { QueueRequest(pEntry); } } } m_SortOnNextUpdate = true; } void CServerBrowser::CleanUp() { // clear out everything m_ServerlistHeap.Reset(); m_NumServers = 0; m_NumSortedServers = 0; m_ByAddr.clear(); m_pFirstReqServer = 0; m_pLastReqServer = 0; m_NumRequests = 0; m_CurrentMaxRequests = g_Config.m_BrMaxRequests; } void CServerBrowser::Update(bool ForceResort) { int64_t Timeout = time_freq(); int64_t Now = time_get(); const char *pHttpBestUrl; if(!m_pHttp->GetBestUrl(&pHttpBestUrl) && pHttpBestUrl != m_pHttpPrevBestUrl) { str_copy(g_Config.m_BrCachedBestServerinfoUrl, pHttpBestUrl); m_pHttpPrevBestUrl = pHttpBestUrl; } m_pHttp->Update(); if(m_ServerlistType != TYPE_LAN && m_RefreshingHttp && !m_pHttp->IsRefreshing()) { m_RefreshingHttp = false; CleanUp(); UpdateFromHttp(); // TODO: move this somewhere else Sort(); return; } CServerEntry *pEntry = m_pFirstReqServer; int Count = 0; while(true) { if(!pEntry) // no more entries break; if(pEntry->m_RequestTime && pEntry->m_RequestTime + Timeout < Now) { pEntry = pEntry->m_pNextReq; continue; } // no more than 10 concurrent requests if(Count == m_CurrentMaxRequests) break; if(pEntry->m_RequestTime == 0) { RequestImpl(pEntry->m_Info.m_aAddresses[0], pEntry, nullptr, nullptr, false); } Count++; pEntry = pEntry->m_pNextReq; } if(m_pFirstReqServer && Count == 0 && m_CurrentMaxRequests > 1) //NO More current Server Requests { //reset old ones pEntry = m_pFirstReqServer; while(true) { if(!pEntry) // no more entries break; pEntry->m_RequestTime = 0; pEntry = pEntry->m_pNextReq; } //update max-requests m_CurrentMaxRequests = m_CurrentMaxRequests / 2; if(m_CurrentMaxRequests < 1) m_CurrentMaxRequests = 1; } else if(Count == 0 && m_CurrentMaxRequests == 1) //we reached the limit, just release all left requests. IF a server sends us a packet, a new request will be added automatically, so we can delete all { pEntry = m_pFirstReqServer; while(true) { if(!pEntry) // no more entries break; CServerEntry *pNext = pEntry->m_pNextReq; RemoveRequest(pEntry); //release request pEntry = pNext; } } // check if we need to resort if(m_Sorthash != SortHash() || ForceResort || m_SortOnNextUpdate) { for(int i = 0; i < m_NumServers; i++) { CServerInfo *pInfo = &m_ppServerlist[i]->m_Info; pInfo->m_Favorite = m_pFavorites->IsFavorite(pInfo->m_aAddresses, pInfo->m_NumAddresses); pInfo->m_FavoriteAllowPing = m_pFavorites->IsPingAllowed(pInfo->m_aAddresses, pInfo->m_NumAddresses); } Sort(); m_SortOnNextUpdate = false; } } void CServerBrowser::LoadDDNetServers() { if(!m_pDDNetInfo) return; // reset servers / countries for(int Network = 0; Network < NUM_NETWORKS; Network++) { CNetwork *pNet = &m_aNetworks[Network]; // parse JSON const json_value *pServers = json_object_get(m_pDDNetInfo, Network == NETWORK_DDNET ? "servers" : "servers-kog"); if(!pServers || pServers->type != json_array) return; pNet->m_NumCountries = 0; pNet->m_NumTypes = 0; for(int i = 0; i < json_array_length(pServers) && pNet->m_NumCountries < MAX_COUNTRIES; i++) { // pSrv - { name, flagId, servers } const json_value *pSrv = json_array_get(pServers, i); const json_value *pTypes = json_object_get(pSrv, "servers"); const json_value *pName = json_object_get(pSrv, "name"); const json_value *pFlagID = json_object_get(pSrv, "flagId"); if(pSrv->type != json_object || pTypes->type != json_object || pName->type != json_string || pFlagID->type != json_integer) { dbg_msg("client_srvbrowse", "invalid attributes"); continue; } // build structure CNetworkCountry *pCntr = &pNet->m_aCountries[pNet->m_NumCountries]; pCntr->Reset(); str_copy(pCntr->m_aName, json_string_get(pName)); pCntr->m_FlagID = json_int_get(pFlagID); // add country for(unsigned int t = 0; t < pTypes->u.object.length; t++) { const char *pType = pTypes->u.object.values[t].name; const json_value *pAddrs = pTypes->u.object.values[t].value; if(pAddrs->type != json_array) { dbg_msg("client_srvbrowse", "invalid attributes"); continue; } // add type if(json_array_length(pAddrs) > 0 && pNet->m_NumTypes < MAX_TYPES) { int Pos; for(Pos = 0; Pos < pNet->m_NumTypes; Pos++) { if(!str_comp(pNet->m_aTypes[Pos], pType)) break; } if(Pos == pNet->m_NumTypes) { str_copy(pNet->m_aTypes[pNet->m_NumTypes], pType); pNet->m_NumTypes++; } } // add addresses for(int g = 0; g < json_array_length(pAddrs); g++, pCntr->m_NumServers++) { const json_value *pAddr = json_array_get(pAddrs, g); if(pAddr->type != json_string) { dbg_msg("client_srvbrowse", "invalid attributes"); continue; } const char *pStr = json_string_get(pAddr); net_addr_from_str(&pCntr->m_aServers[pCntr->m_NumServers], pStr); str_copy(pCntr->m_aTypes[pCntr->m_NumServers], pType); } } pNet->m_NumCountries++; } } } void CServerBrowser::RecheckOfficial() { for(auto &Network : m_aNetworks) { for(int i = 0; i < Network.m_NumCountries; i++) { CNetworkCountry *pCntr = &Network.m_aCountries[i]; for(int j = 0; j < pCntr->m_NumServers; j++) { CServerEntry *pEntry = Find(pCntr->m_aServers[j]); if(pEntry) { pEntry->m_Info.m_Official = true; } } } } } void CServerBrowser::LoadDDNetRanks() { for(int i = 0; i < m_NumServers; i++) { if(m_ppServerlist[i]->m_Info.m_aMap[0]) m_ppServerlist[i]->m_Info.m_HasRank = HasRank(m_ppServerlist[i]->m_Info.m_aMap); } } int CServerBrowser::HasRank(const char *pMap) { if(m_ServerlistType != IServerBrowser::TYPE_DDNET || !m_pDDNetInfo) return -1; const json_value *pDDNetRanks = json_object_get(m_pDDNetInfo, "maps"); if(!pDDNetRanks || pDDNetRanks->type != json_array) return -1; for(int i = 0; i < json_array_length(pDDNetRanks); i++) { const json_value *pJson = json_array_get(pDDNetRanks, i); if(!pJson || pJson->type != json_string) continue; const char *pStr = json_string_get(pJson); if(str_comp(pMap, pStr) == 0) return 1; } return 0; } void CServerBrowser::LoadDDNetInfoJson() { void *pBuf; unsigned Length; if(!m_pStorage->ReadFile(DDNET_INFO, IStorage::TYPE_SAVE, &pBuf, &Length)) return; json_value_free(m_pDDNetInfo); m_pDDNetInfo = json_parse((json_char *)pBuf, Length); free(pBuf); if(m_pDDNetInfo && m_pDDNetInfo->type != json_object) { json_value_free(m_pDDNetInfo); m_pDDNetInfo = 0; } m_OwnLocation = CServerInfo::LOC_UNKNOWN; if(m_pDDNetInfo) { const json_value &Location = (*m_pDDNetInfo)["location"]; if(Location.type != json_string || CServerInfo::ParseLocation(&m_OwnLocation, Location)) { char aBuf[64]; str_format(aBuf, sizeof(aBuf), "cannot parse location from info.json: '%s'", (const char *)Location); m_pConsole->Print(IConsole::OUTPUT_LEVEL_STANDARD, "serverbrowse", aBuf); } } } const char *CServerBrowser::GetTutorialServer() { // Use DDNet tab as default after joining tutorial, also makes sure Find() actually works // Note that when no server info has been loaded yet, this will not return a result immediately. g_Config.m_UiPage = CMenus::PAGE_DDNET; Refresh(IServerBrowser::TYPE_DDNET); CNetwork *pNetwork = &m_aNetworks[NETWORK_DDNET]; const char *pBestAddr = nullptr; int BestLatency = std::numeric_limits::max(); for(int i = 0; i < pNetwork->m_NumCountries; i++) { CNetworkCountry *pCntr = &pNetwork->m_aCountries[i]; for(int j = 0; j < pCntr->m_NumServers; j++) { CServerEntry *pEntry = Find(pCntr->m_aServers[j]); if(!pEntry) continue; if(str_find(pEntry->m_Info.m_aName, "(Tutorial)") == 0) continue; if(pEntry->m_Info.m_NumPlayers > pEntry->m_Info.m_MaxPlayers - 10) continue; if(pEntry->m_Info.m_Latency >= BestLatency) continue; BestLatency = pEntry->m_Info.m_Latency; pBestAddr = pEntry->m_Info.m_aAddress; } } return pBestAddr; } const json_value *CServerBrowser::LoadDDNetInfo() { LoadDDNetInfoJson(); LoadDDNetServers(); RecheckOfficial(); LoadDDNetRanks(); return m_pDDNetInfo; } bool CServerBrowser::IsRefreshing() const { return m_pFirstReqServer != 0; } bool CServerBrowser::IsGettingServerlist() const { return m_pHttp->IsRefreshing(); } int CServerBrowser::LoadingProgression() const { if(m_NumServers == 0) return 0; int Servers = m_NumServers; int Loaded = m_NumServers - m_NumRequests; return 100.0f * Loaded / Servers; } void CServerBrowser::DDNetFilterAdd(char *pFilter, const char *pName) { if(DDNetFiltered(pFilter, pName)) return; char aBuf[128]; str_format(aBuf, sizeof(aBuf), ",%s", pName); str_append(pFilter, aBuf, 128); } void CServerBrowser::DDNetFilterRem(char *pFilter, const char *pName) { if(!DDNetFiltered(pFilter, pName)) return; // rewrite exclude/filter list char aBuf[128]; str_copy(aBuf, pFilter); pFilter[0] = '\0'; char aToken[128]; for(const char *pTok = aBuf; (pTok = str_next_token(pTok, ",", aToken, sizeof(aToken)));) { if(str_comp_nocase(pName, aToken) != 0) { char aBuf2[128]; str_format(aBuf2, sizeof(aBuf2), ",%s", aToken); str_append(pFilter, aBuf2, 128); } } } bool CServerBrowser::DDNetFiltered(char *pFilter, const char *pName) { return str_in_list(pFilter, ",", pName); // country not excluded } void CServerBrowser::CountryFilterClean(int Network) { char *pExcludeCountries = Network == NETWORK_KOG ? g_Config.m_BrFilterExcludeCountriesKoG : g_Config.m_BrFilterExcludeCountries; char aNewList[128]; aNewList[0] = '\0'; for(auto &Net : m_aNetworks) { for(int i = 0; i < Net.m_NumCountries; i++) { const char *pName = Net.m_aCountries[i].m_aName; if(DDNetFiltered(pExcludeCountries, pName)) { char aBuf[128]; str_format(aBuf, sizeof(aBuf), ",%s", pName); str_append(aNewList, aBuf, sizeof(aNewList)); } } } str_copy(pExcludeCountries, aNewList, sizeof(g_Config.m_BrFilterExcludeCountries)); } void CServerBrowser::TypeFilterClean(int Network) { char *pExcludeTypes = Network == NETWORK_KOG ? g_Config.m_BrFilterExcludeTypesKoG : g_Config.m_BrFilterExcludeTypes; char aNewList[128]; aNewList[0] = '\0'; for(int i = 0; i < m_aNetworks[Network].m_NumTypes; i++) { const char *pName = m_aNetworks[Network].m_aTypes[i]; if(DDNetFiltered(pExcludeTypes, pName)) { char aBuf[128]; str_format(aBuf, sizeof(aBuf), ",%s", pName); str_append(aNewList, aBuf, sizeof(aNewList)); } } str_copy(pExcludeTypes, aNewList, sizeof(g_Config.m_BrFilterExcludeTypes)); } bool CServerBrowser::IsRegistered(const NETADDR &Addr) { const int NumServers = m_pHttp->NumServers(); for(int i = 0; i < NumServers; i++) { const CServerInfo Info = m_pHttp->Server(i); for(int j = 0; j < Info.m_NumAddresses; j++) { if(net_addr_comp(&Info.m_aAddresses[j], &Addr) == 0) { return true; } } } const int NumLegacyServers = m_pHttp->NumLegacyServers(); for(int i = 0; i < NumLegacyServers; i++) { if(net_addr_comp(&m_pHttp->LegacyServer(i), &Addr) == 0) { return true; } } return false; } int CServerInfo::EstimateLatency(int Loc1, int Loc2) { if(Loc1 == LOC_UNKNOWN || Loc2 == LOC_UNKNOWN) { return 999; } if(Loc1 != Loc2) { return 199; } return 99; } bool CServerInfo::ParseLocation(int *pResult, const char *pString) { *pResult = LOC_UNKNOWN; int Length = str_length(pString); if(Length < 2) { return true; } // ISO continent code. Allow antarctica, but treat it as unknown. static const char s_apLocations[][6] = { "an", // LOC_UNKNOWN "af", // LOC_AFRICA "as", // LOC_ASIA "oc", // LOC_AUSTRALIA "eu", // LOC_EUROPE "na", // LOC_NORTH_AMERICA "sa", // LOC_SOUTH_AMERICA "as:cn", // LOC_CHINA }; for(int i = std::size(s_apLocations) - 1; i >= 0; i--) { if(str_startswith(pString, s_apLocations[i])) { *pResult = i; return false; } } return true; }