Dunedan/0ad
1
0
Fork 0
forked from 0ad/0ad
Code Pull Requests Wiki Activity
531dcf40c3
0ad/source/lobby/IXmppClient.h

71 lines
3.2 KiB
C
Raw Normal View History

Fix unreported glooxwrapper leaks following 61261d14fc, refs #2305. Fixes an occurring leak indicated by the reported clang unused variable compiler warning, refs #5294, #5550, by adding the missing glooxwrapper::Jingle::Session::Session destructor . Fix two leaks that would have occurred if the according code had been used: Delete unused glooxwrapper::Jingle::ICEUDP::ICEUDP instead of adding the missing destructor. Delete unused glooxwrapper::Jingle::Content::Content instead of adding the missing destructor. Explain why glooxwrapper::Client::registerStanzaExtension doesn't leak the new StanzaExtensionWrapper. Explain why glooxwrapper::Jingle::Session::sessionInitiate doesn't leak the new gloox::Jingle::Content, nor the new gloox::Jingle::ICEUDP. Explain why glooxwrapper::SessionManager::registerPlugins doesn't leak the new gloox::Jingle::Content and new gloox::Jingle::ICEUDP. Explain why glooxwrapper::SessionManager::createSession doesn't leak the gloox::Jingle::Session. I will not leak memory in the glooxwrapper. I will not leak memory in the glooxwrapper. I will not leak memory in the glooxwrapper. Use references in the StunClient and glooxwrapper to anticipate any confusion as to whose obligation it is to delete variables when they are passed around across several files. Use static_cast and reinterpret_cast instead of C-style casts in the StunClient. Differential Revision: https://code.wildfiregames.com/D2094 Refs D2093 for the reported leaks. Reviewed By: Josh Comments By: fcxSanya, Vladislav for D2094, and echotangoecho, leper in 61261d14fc This was SVN commit r22678.
2019-08-17 02:12:19 +02:00
/* Copyright (C) 2019 Wildfire Games.
Multiplayer lobby based on the XmPP protocol. Special thanks to Philip, alpha123, scythetwirler, and anyone else who has helped build, debug or test the lobby. This was SVN commit r14098.
2013-11-07 21:07:24 +01:00
* This file is part of 0 A.D.
*
* 0 A.D. is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
*
* 0 A.D. is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with 0 A.D. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef IXMPPCLIENT_H
#define IXMPPCLIENT_H
SpiderMonkey 31 upgrade This upgrade also introduces exact stack rooting (see to the wiki: JSRootingGuide) and fixes problems with moving GC. This allows us to enable generational garbage collection (GGC). Measurements a few months ago have shown a performance improvement of a non-visual replay of around 13.5%. This probably varies quite a bit, but it should be somewhere between 5-20%. Memory usage has also been improved. Check the forum thread for details. Thanks to everyone from the team who helped with this directly or indirectly (review, finding and fixing issues, the required C++11 upgrade, the new autobuilder etc.)! Also thanks to the SpiderMonkey developers who helped on the #jsapi channel or elsewhere! Fixes #2462, #2415, #2428, #2684, #1374 Refs #2973, #2669 This was SVN commit r16214.
2015-01-24 15:46:52 +01:00
#include "scriptinterface/ScriptTypes.h"
Multiplayer lobby based on the XmPP protocol. Special thanks to Philip, alpha123, scythetwirler, and anyone else who has helped build, debug or test the lobby. This was SVN commit r14098.
2013-11-07 21:07:24 +01:00
class ScriptInterface;
STUN + XMPP ICE implementation. Allows lobby players to host games without having to configure their router. Differential Revision: https://code.wildfiregames.com/D364 Fixes #2305 Patch By: fcxSanya. StunClient based on code by SuperTuxKart, relicensed with approval of the according authors hilnius, hiker, Auria, deveee, Flakebi, leper, konstin and KroArtem. Added rfc5245 (ejabberd) support, a GUI option, refactoring and segfault fixes by myself. Tested By: user1, Sandarac, Sestroretsk1714, Vladislav, Grugnas, javiergodas Partially Reviewed By: leper, Philip, echotangoecho This was SVN commit r19703.
2017-06-01 08:33:52 +02:00
namespace StunClient {
Fix two clang warnings in 61261d14fc reported by leper. Differential Revision: https://code.wildfiregames.com/D1064 Reviewed By: fcxSanya Refs #2305 This was SVN commit r20582.
2017-12-04 15:30:38 +01:00
struct StunEndpoint;
STUN + XMPP ICE implementation. Allows lobby players to host games without having to configure their router. Differential Revision: https://code.wildfiregames.com/D364 Fixes #2305 Patch By: fcxSanya. StunClient based on code by SuperTuxKart, relicensed with approval of the according authors hilnius, hiker, Auria, deveee, Flakebi, leper, konstin and KroArtem. Added rfc5245 (ejabberd) support, a GUI option, refactoring and segfault fixes by myself. Tested By: user1, Sandarac, Sestroretsk1714, Vladislav, Grugnas, javiergodas Partially Reviewed By: leper, Philip, echotangoecho This was SVN commit r19703.
2017-06-01 08:33:52 +02:00
}
Multiplayer lobby based on the XmPP protocol. Special thanks to Philip, alpha123, scythetwirler, and anyone else who has helped build, debug or test the lobby. This was SVN commit r14098.
2013-11-07 21:07:24 +01:00
class IXmppClient
{
public:
Support creating lobby GUI messages with arbitrary arguments instead of forcing every message type into the same struct type, refs #4877 / 76bc9b579a / D339. Creates the GUI messages directly as JS::Values and removes the intermediary rigid struct. Implementation similar to ScriptInterface::CreateObject from D2080. Differential Revision: https://code.wildfiregames.com/D2264 Tested on: clang 8.0.1, Jenkins This was SVN commit r22856.
2019-09-06 07:14:20 +02:00
static IXmppClient* create(const ScriptInterface* scriptInterface, const std::string& sUsername, const std::string& sPassword, const std::string& sRoom, const std::string& sNick, const int historyRequestSize = 0, bool regOpt = false);
Multiplayer lobby based on the XmPP protocol. Special thanks to Philip, alpha123, scythetwirler, and anyone else who has helped build, debug or test the lobby. This was SVN commit r14098.
2013-11-07 21:07:24 +01:00
virtual ~IXmppClient() {}
virtual void connect() = 0;
virtual void disconnect() = 0;
Allow the JS GUI to find out if the lobby client is currently disconnected. Differential Revision: https://code.wildfiregames.com/D1224 Patch By: fpre / ffffffff Refs #4106, D817 This was SVN commit r20872.
2018-01-15 05:30:33 +01:00
virtual bool isConnected() = 0;
Multiplayer lobby based on the XmPP protocol. Special thanks to Philip, alpha123, scythetwirler, and anyone else who has helped build, debug or test the lobby. This was SVN commit r14098.
2013-11-07 21:07:24 +01:00
virtual void recv() = 0;
virtual void SendIqGetBoardList() = 0;
Adds profiles to the multiplayer lobby. Fixes #2504. This was SVN commit r15768.
2014-09-20 17:35:26 +02:00
virtual void SendIqGetProfile(const std::string& player) = 0;
Pass ScriptInterface as a const ref where possible. Reviewed By: elexis Differential Revision: https://code.wildfiregames.com/D739 This was SVN commit r20028.
2017-08-24 02:32:42 +02:00
virtual void SendIqGameReport(const ScriptInterface& scriptInterface, JS::HandleValue data) = 0;
virtual void SendIqRegisterGame(const ScriptInterface& scriptInterface, JS::HandleValue data) = 0;
Multiplayer lobby based on the XmPP protocol. Special thanks to Philip, alpha123, scythetwirler, and anyone else who has helped build, debug or test the lobby. This was SVN commit r14098.
2013-11-07 21:07:24 +01:00
virtual void SendIqUnregisterGame() = 0;
virtual void SendIqChangeStateGame(const std::string& nbp, const std::string& players) = 0;
Secure lobby authentication - prevent joins as a different player Reviewed by: Dunedan, elexis, Itms Fixes #3549 Differential Revision: https://code.wildfiregames.com/D897 This was SVN commit r21520.
2018-03-12 01:23:40 +01:00
virtual void SendIqLobbyAuth(const std::string& to, const std::string& token) = 0;
Multiplayer lobby based on the XmPP protocol. Special thanks to Philip, alpha123, scythetwirler, and anyone else who has helped build, debug or test the lobby. This was SVN commit r14098.
2013-11-07 21:07:24 +01:00
virtual void SetNick(const std::string& nick) = 0;
virtual void GetNick(std::string& nick) = 0;
virtual void kick(const std::string& nick, const std::string& reason) = 0;
virtual void ban(const std::string& nick, const std::string& reason) = 0;
virtual void SetPresence(const std::string& presence) = 0;
Fix missing wstring_from_utf8 for multi-user-chat messages and translated strings following 9023f4bebb / D2264. The commit introduced support for arbitrary lobby CreateGUIMessage JS::Value arguments but didn't transfer wstring_from_utf8 appropriately. Instead of enlengthening the code by reintroducing utf8_from_wstring everyhwere, shorten the code and specialize ToJSVal for glooxwrapper::string and gloox enums. Avoid string copies for XmppClient getters, refs D1668: Change GetPresence() and GetRole() to return the pointer to the string literal instead of copy constructing a std::string each call. Don't reintroduce the unneeded utf8_from_wstring conversions for the untranslatable ASCII identifiers returned by GetPresence() and GetRole(). Change GetSubject() to return a const ref to the member instead of copy assigning the std::string to an output value. Change m_Subject to std::wstring to avoid constructing a copy using wstring_from_utf8 each GetSubject() call. Change gloox enum to translatable string functions to be static, so as to use them in the new ToJSVal functions (enabled by not calling CertificateErrorToString from ConnectionErrorToString anyymore in 92fc34c87c/D2274). Avoid per-player string copies in m_PlayerMap: Change m_PlayerMap value type from std::vector<std::string> to a new PlayerMap struct with named members for readability. Use gloox enums as PlayerMap values to avoid constructing (performance) and storing (memory footprint) std::strings. The JS String is created from the pointer to the ASCII string literal without intermediaries. Use glooxwrapper::string for nickname and m_Rating since it's the data source type received in relevant places, but that might be improved for performance with std::wstring. Construct map values in place where possible and post error instead of silently inserting if an existing value is to be modified. Avoid repeated std::map lookups on string keys by caching the PlayerMap::iterator where available. Remove some glooxwrapper::string to_string() calls redundant with its operator<< and improve DbgXMPP gloox enum output. Transfer rating too upon nickchange. Differential Revision: https://code.wildfiregames.com/D2271 Tested on: clang 8.0.1, Jenkins This was SVN commit r22891.
2019-09-12 19:23:33 +02:00
virtual const char* GetPresence(const std::string& nickname) = 0;
virtual const char* GetRole(const std::string& nickname) = 0;
Rewrite lobby page to use class semantics, add more gamedetails labels, improve performance using batch processing and caching and gain possibility for game creation/player-join/leave events, refs #5387. Game selection details features: * Display victory conditions following their sending but missing display following bffe917914, refs 7b0f6f530c. * Display the host of the match and the game name in the selected game details following 61261d14fc, refs D1666. * Display mods if the mods differ (without having to attempt to join the game prior) following eca956a513. Performance features: * Implement batch message processing in the XmppClient to rebuild GUI objects only once when receiving backlog or returning from a match. * Implement Game class to cache gamelist, filter and sorting values, as they rarely change but are accessed often. * Cache sprintf objects. Security fixes: * Add escapeText in lobby/ to avoid players breaking the lobby for every participant, supersedes D720, comments by bb. * Do not hide broadcasted unrecognized chat commands that mods used as leaking private channels, fixes #5615. Defect fixes: * Fix XmppClient.cpp storing unused historic message types resulting in memory waste and unintentional replay of for instance disconnect/announcements messages following both e8dfde9ba6/D819 and 6bf74902a7/D2265, refs #3306. * Fix XmppClient.cpp victoryCondition -> victoryConditions gamesetup.js change from 6d54ab4c1f/D1240. * Fix leaderboard/profile page cancel hotkey closing the lobby dialog as well and removes cancel hotkey note from lobby_panels.xml from 960f2d7c31/D817 since the described issue was fixed by f9b529f2fb/D1701. * Fix lobby playing menu sound in a running game after having closed the lobby dialog following introduction in 960f2d7c31/D817. * Fix GUI on nick change by updating g_Username. * Update profile panel only with data matching the player requested. Hack erasure: * Object semantics make it cheap to add state and cache values, storing literals in properties while removing globals, adding events while decoupling components and gaining moddability. * Erase comments and translation comments stating that this would be IRC!!, supersedes D1136. * Introduce Status chat message type to supersede "/special" chat command + "isSpecial" property from bffe917914 (formerly g_specialKey e6840f5fca) deluxe hack. * Introduce System chat message type to supersede system errors disguising as chat from a mock user called "system". Code cleanups: * Move code from XML to JS. * Move size values from JS to XML, especially following 960f2d7c31/D817 and 7752219cef/D1051. * Rename "user" to "player". * Fix lobby/ eslint warnings, refs D2261. * Remove message.nick emptiness check from 0940db3fc0/D835, since XEP-0045 dictates that it is non-empty. * Add translated string for deleted subjects. * Add TODOs for some evident COList issues, refs #5638. Differential Revision: https://code.wildfiregames.com/D2412 This was SVN commit r23172.
2019-11-21 14:44:41 +01:00
virtual std::wstring GetRating(const std::string& nickname) = 0;
Fix missing wstring_from_utf8 for multi-user-chat messages and translated strings following 9023f4bebb / D2264. The commit introduced support for arbitrary lobby CreateGUIMessage JS::Value arguments but didn't transfer wstring_from_utf8 appropriately. Instead of enlengthening the code by reintroducing utf8_from_wstring everyhwere, shorten the code and specialize ToJSVal for glooxwrapper::string and gloox enums. Avoid string copies for XmppClient getters, refs D1668: Change GetPresence() and GetRole() to return the pointer to the string literal instead of copy constructing a std::string each call. Don't reintroduce the unneeded utf8_from_wstring conversions for the untranslatable ASCII identifiers returned by GetPresence() and GetRole(). Change GetSubject() to return a const ref to the member instead of copy assigning the std::string to an output value. Change m_Subject to std::wstring to avoid constructing a copy using wstring_from_utf8 each GetSubject() call. Change gloox enum to translatable string functions to be static, so as to use them in the new ToJSVal functions (enabled by not calling CertificateErrorToString from ConnectionErrorToString anyymore in 92fc34c87c/D2274). Avoid per-player string copies in m_PlayerMap: Change m_PlayerMap value type from std::vector<std::string> to a new PlayerMap struct with named members for readability. Use gloox enums as PlayerMap values to avoid constructing (performance) and storing (memory footprint) std::strings. The JS String is created from the pointer to the ASCII string literal without intermediaries. Use glooxwrapper::string for nickname and m_Rating since it's the data source type received in relevant places, but that might be improved for performance with std::wstring. Construct map values in place where possible and post error instead of silently inserting if an existing value is to be modified. Avoid repeated std::map lookups on string keys by caching the PlayerMap::iterator where available. Remove some glooxwrapper::string to_string() calls redundant with its operator<< and improve DbgXMPP gloox enum output. Transfer rating too upon nickchange. Differential Revision: https://code.wildfiregames.com/D2271 Tested on: clang 8.0.1, Jenkins This was SVN commit r22891.
2019-09-12 19:23:33 +02:00
virtual const std::wstring& GetSubject() = 0;
Pass ScriptInterface as a const ref where possible. Reviewed By: elexis Differential Revision: https://code.wildfiregames.com/D739 This was SVN commit r20028.
2017-08-24 02:32:42 +02:00
virtual void GUIGetPlayerList(const ScriptInterface& scriptInterface, JS::MutableHandleValue ret) = 0;
virtual void GUIGetGameList(const ScriptInterface& scriptInterface, JS::MutableHandleValue ret) = 0;
virtual void GUIGetBoardList(const ScriptInterface& scriptInterface, JS::MutableHandleValue ret) = 0;
virtual void GUIGetProfile(const ScriptInterface& scriptInterface, JS::MutableHandleValue ret) = 0;
Fix lobby playerlist rebuild following presence update message removal in 6bf74902a7/D2265. Update the list when the data it is built from changes, not only for presence changes. Differential Revision: https://code.wildfiregames.com/D2283 Tested on: clang 8.0.1, Jenkins This was SVN commit r22888.
2019-09-11 13:51:34 +02:00
Rewrite lobby page to use class semantics, add more gamedetails labels, improve performance using batch processing and caching and gain possibility for game creation/player-join/leave events, refs #5387. Game selection details features: * Display victory conditions following their sending but missing display following bffe917914, refs 7b0f6f530c. * Display the host of the match and the game name in the selected game details following 61261d14fc, refs D1666. * Display mods if the mods differ (without having to attempt to join the game prior) following eca956a513. Performance features: * Implement batch message processing in the XmppClient to rebuild GUI objects only once when receiving backlog or returning from a match. * Implement Game class to cache gamelist, filter and sorting values, as they rarely change but are accessed often. * Cache sprintf objects. Security fixes: * Add escapeText in lobby/ to avoid players breaking the lobby for every participant, supersedes D720, comments by bb. * Do not hide broadcasted unrecognized chat commands that mods used as leaking private channels, fixes #5615. Defect fixes: * Fix XmppClient.cpp storing unused historic message types resulting in memory waste and unintentional replay of for instance disconnect/announcements messages following both e8dfde9ba6/D819 and 6bf74902a7/D2265, refs #3306. * Fix XmppClient.cpp victoryCondition -> victoryConditions gamesetup.js change from 6d54ab4c1f/D1240. * Fix leaderboard/profile page cancel hotkey closing the lobby dialog as well and removes cancel hotkey note from lobby_panels.xml from 960f2d7c31/D817 since the described issue was fixed by f9b529f2fb/D1701. * Fix lobby playing menu sound in a running game after having closed the lobby dialog following introduction in 960f2d7c31/D817. * Fix GUI on nick change by updating g_Username. * Update profile panel only with data matching the player requested. Hack erasure: * Object semantics make it cheap to add state and cache values, storing literals in properties while removing globals, adding events while decoupling components and gaining moddability. * Erase comments and translation comments stating that this would be IRC!!, supersedes D1136. * Introduce Status chat message type to supersede "/special" chat command + "isSpecial" property from bffe917914 (formerly g_specialKey e6840f5fca) deluxe hack. * Introduce System chat message type to supersede system errors disguising as chat from a mock user called "system". Code cleanups: * Move code from XML to JS. * Move size values from JS to XML, especially following 960f2d7c31/D817 and 7752219cef/D1051. * Rename "user" to "player". * Fix lobby/ eslint warnings, refs D2261. * Remove message.nick emptiness check from 0940db3fc0/D835, since XEP-0045 dictates that it is non-empty. * Add translated string for deleted subjects. * Add TODOs for some evident COList issues, refs #5638. Differential Revision: https://code.wildfiregames.com/D2412 This was SVN commit r23172.
2019-11-21 14:44:41 +01:00
virtual JS::Value GuiPollNewMessages(const ScriptInterface& scriptInterface) = 0;
Display previously received lobby chat messages when returning from the gamesetup. Differential Revision: https://code.wildfiregames.com/D819 Fixes #3306 Patch By: fpre / ffffffff This was SVN commit r20070.
2017-08-29 18:04:45 +02:00
virtual JS::Value GuiPollHistoricMessages(const ScriptInterface& scriptInterface) = 0;
Fix lobby playerlist rebuild following presence update message removal in 6bf74902a7/D2265. Update the list when the data it is built from changes, not only for presence changes. Differential Revision: https://code.wildfiregames.com/D2283 Tested on: clang 8.0.1, Jenkins This was SVN commit r22888.
2019-09-11 13:51:34 +02:00
virtual bool GuiPollHasPlayerListUpdate() = 0;
Multiplayer lobby based on the XmPP protocol. Special thanks to Philip, alpha123, scythetwirler, and anyone else who has helped build, debug or test the lobby. This was SVN commit r14098.
2013-11-07 21:07:24 +01:00
virtual void SendMUCMessage(const std::string& message) = 0;
Fix unreported glooxwrapper leaks following 61261d14fc, refs #2305. Fixes an occurring leak indicated by the reported clang unused variable compiler warning, refs #5294, #5550, by adding the missing glooxwrapper::Jingle::Session::Session destructor . Fix two leaks that would have occurred if the according code had been used: Delete unused glooxwrapper::Jingle::ICEUDP::ICEUDP instead of adding the missing destructor. Delete unused glooxwrapper::Jingle::Content::Content instead of adding the missing destructor. Explain why glooxwrapper::Client::registerStanzaExtension doesn't leak the new StanzaExtensionWrapper. Explain why glooxwrapper::Jingle::Session::sessionInitiate doesn't leak the new gloox::Jingle::Content, nor the new gloox::Jingle::ICEUDP. Explain why glooxwrapper::SessionManager::registerPlugins doesn't leak the new gloox::Jingle::Content and new gloox::Jingle::ICEUDP. Explain why glooxwrapper::SessionManager::createSession doesn't leak the gloox::Jingle::Session. I will not leak memory in the glooxwrapper. I will not leak memory in the glooxwrapper. I will not leak memory in the glooxwrapper. Use references in the StunClient and glooxwrapper to anticipate any confusion as to whose obligation it is to delete variables when they are passed around across several files. Use static_cast and reinterpret_cast instead of C-style casts in the StunClient. Differential Revision: https://code.wildfiregames.com/D2094 Refs D2093 for the reported leaks. Reviewed By: Josh Comments By: fcxSanya, Vladislav for D2094, and echotangoecho, leper in 61261d14fc This was SVN commit r22678.
2019-08-17 02:12:19 +02:00
virtual void SendStunEndpointToHost(const StunClient::StunEndpoint& stunEndpoint, const std::string& hostJID) = 0;
Multiplayer lobby based on the XmPP protocol. Special thanks to Philip, alpha123, scythetwirler, and anyone else who has helped build, debug or test the lobby. This was SVN commit r14098.
2013-11-07 21:07:24 +01:00
};
extern IXmppClient *g_XmppClient;
extern bool g_rankedGame;
#endif // XMPPCLIENT_H
Copy Permalink