dallasgroot/0ad
1
0
Fork 0
mirror of https://gitea.wildfiregames.com/0ad/0ad synced 2026-06-16 21:34:08 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 3
0ad/source/lobby/scripting/JSInterface_Lobby.h

73 lines
3.9 KiB
C
Raw Normal View History

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-14 20:30:33 -08:00
/* Copyright (C) 2018 Wildfire Games.
In #2241 I'm going to change the GUI to have one ScriptInterface for each GUI page because that will be required for the Spidermonkey upgrade (#1886). The Multiplayer lobby needs some changes to avoid compartment mismatches. Instead of initializing it with a ScriptInterface and storing script values at different locations, it takes a ScriptInterface argument in the functions that really need to read or write some script values and avoids storing values as script values with an associated compartment where possible. The scripting interface of the lobby is also adjusted to use JSInterface_Lobby.h/cpp files as other components instead of adding all functions to ScriptFunctions.cpp. This makes it a bit more clearly arranged IMO. Fixes #2267 Refs #2241 Refs #1886 This was SVN commit r14199.
2013-11-16 10:38:40 -08: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 INCLUDED_JSI_LOBBY
#define INCLUDED_JSI_LOBBY
Check for availability of XmppClient. Move Lobby script function registration to the lobby JS interface. This was SVN commit r15968.
2014-11-15 18:10:24 -08:00
#include "lib/config2.h"
Removes g_ScriptingHost and implements global to compartment 1 to 1 relation. Each GUI Page gets its own compartment and all ScriptInterfaces in the same thread should now use the same JS Runtime. This is required for the SpiderMonkey upgrade. Check the ticket for details. Closes #2241 Refs #1886 Refs #1966 This was SVN commit r14496.
2014-01-04 02:14:53 -08:00
#include "scriptinterface/ScriptInterface.h"
Always require lobby authentication for lobby matches, refs #3549 / 0fd8aa2a77 / D897. This is due to too many oversteppings of the lobby Terms of Use following JS mods that implemented an UI for players to join lobby games with arbitrary nicknames or 'replace' / impersonate other players in lobby games. Agreed with: user1, Dunedan Code proofread by: Vladislav Minor discussions with: Imarok, Hannibal_Barca, smiley, fpre, bb, nani refs https://wildfiregames.com/forum/index.php?/topic/24722-improving-mod-security/ This was SVN commit r21877.
2018-08-25 07:34:30 -07:00
#include <string>
In #2241 I'm going to change the GUI to have one ScriptInterface for each GUI page because that will be required for the Spidermonkey upgrade (#1886). The Multiplayer lobby needs some changes to avoid compartment mismatches. Instead of initializing it with a ScriptInterface and storing script values at different locations, it takes a ScriptInterface argument in the functions that really need to read or write some script values and avoids storing values as script values with an associated compartment where possible. The scripting interface of the lobby is also adjusted to use JSInterface_Lobby.h/cpp files as other components instead of adding all functions to ScriptFunctions.cpp. This makes it a bit more clearly arranged IMO. Fixes #2267 Refs #2241 Refs #1886 This was SVN commit r14199.
2013-11-16 10:38:40 -08:00
namespace JSI_Lobby
{
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-23 17:32:42 -07:00
void RegisterScriptFunctions(const ScriptInterface& scriptInterface);
Check for availability of XmppClient. Move Lobby script function registration to the lobby JS interface. This was SVN commit r15968.
2014-11-15 18:10:24 -08:00
Removes g_ScriptingHost and implements global to compartment 1 to 1 relation. Each GUI Page gets its own compartment and all ScriptInterfaces in the same thread should now use the same JS Runtime. This is required for the SpiderMonkey upgrade. Check the ticket for details. Closes #2241 Refs #1886 Refs #1966 This was SVN commit r14496.
2014-01-04 02:14:53 -08:00
bool HasXmppClient(ScriptInterface::CxPrivate* pCxPrivate);
Fix #2404. Rating auto-configure TODO (eg 2v2 games do not automatically show as being unrated). See #2276. This was SVN commit r14934.
2014-04-15 23:03:49 -07:00
bool IsRankedGame(ScriptInterface::CxPrivate* pCxPrivate);
void SetRankedGame(ScriptInterface::CxPrivate* pCxPrivate, bool isRanked);
Allow using the XMPP room subject to display lobby information to user, make the lobby GUI code more readable, and cleanup the modern styles. This was SVN commit r14656.
2014-01-24 10:20:15 -08:00
#if CONFIG2_LOBBY
Use const T& for parameters of some types in script-exposed native functions Using references matches the C++ coding style better and should improve performance a bit in theory. It avoids 2 copies of T in case of the functions registered with RegisterFunction (mainy used in the GUI). It should also avoid one or two copies in case of DEFINE_INTERFACE_METHOD_X, which is used in the simulation, but I haven't bothered to count it there exactly. It is now predefined which types have to be passed by const reference and which are passed by value. Note that references can't be used as out-parameters (to return multiple values to JS). This hasn't worked before either and probably never will. This was SVN commit r17696.
2016-01-23 07:17:56 -08:00
void StartXmppClient(ScriptInterface::CxPrivate* pCxPrivate, const std::wstring& username, const std::wstring& password, const std::wstring& room, const std::wstring& nick, int historyRequestSize);
void StartRegisterXmppClient(ScriptInterface::CxPrivate* pCxPrivate, const std::wstring& username, const std::wstring& password);
Removes g_ScriptingHost and implements global to compartment 1 to 1 relation. Each GUI Page gets its own compartment and all ScriptInterfaces in the same thread should now use the same JS Runtime. This is required for the SpiderMonkey upgrade. Check the ticket for details. Closes #2241 Refs #1886 Refs #1966 This was SVN commit r14496.
2014-01-04 02:14:53 -08:00
void StopXmppClient(ScriptInterface::CxPrivate* pCxPrivate);
void ConnectXmppClient(ScriptInterface::CxPrivate* pCxPrivate);
void DisconnectXmppClient(ScriptInterface::CxPrivate* pCxPrivate);
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-14 20:30:33 -08:00
bool IsXmppClientConnected(ScriptInterface::CxPrivate* pCxPrivate);
Removes g_ScriptingHost and implements global to compartment 1 to 1 relation. Each GUI Page gets its own compartment and all ScriptInterfaces in the same thread should now use the same JS Runtime. This is required for the SpiderMonkey upgrade. Check the ticket for details. Closes #2241 Refs #1886 Refs #1966 This was SVN commit r14496.
2014-01-04 02:14:53 -08:00
void SendGetBoardList(ScriptInterface::CxPrivate* pCxPrivate);
Use const T& for parameters of some types in script-exposed native functions Using references matches the C++ coding style better and should improve performance a bit in theory. It avoids 2 copies of T in case of the functions registered with RegisterFunction (mainy used in the GUI). It should also avoid one or two copies in case of DEFINE_INTERFACE_METHOD_X, which is used in the simulation, but I haven't bothered to count it there exactly. It is now predefined which types have to be passed by const reference and which are passed by value. Note that references can't be used as out-parameters (to return multiple values to JS). This hasn't worked before either and probably never will. This was SVN commit r17696.
2016-01-23 07:17:56 -08:00
void SendGetProfile(ScriptInterface::CxPrivate* pCxPrivate, const std::wstring& player);
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 06:46:52 -08:00
void SendGameReport(ScriptInterface::CxPrivate* pCxPrivate, JS::HandleValue data);
void SendRegisterGame(ScriptInterface::CxPrivate* pCxPrivate, JS::HandleValue data);
Removes g_ScriptingHost and implements global to compartment 1 to 1 relation. Each GUI Page gets its own compartment and all ScriptInterfaces in the same thread should now use the same JS Runtime. This is required for the SpiderMonkey upgrade. Check the ticket for details. Closes #2241 Refs #1886 Refs #1966 This was SVN commit r14496.
2014-01-04 02:14:53 -08:00
void SendUnregisterGame(ScriptInterface::CxPrivate* pCxPrivate);
Use const T& for parameters of some types in script-exposed native functions Using references matches the C++ coding style better and should improve performance a bit in theory. It avoids 2 copies of T in case of the functions registered with RegisterFunction (mainy used in the GUI). It should also avoid one or two copies in case of DEFINE_INTERFACE_METHOD_X, which is used in the simulation, but I haven't bothered to count it there exactly. It is now predefined which types have to be passed by const reference and which are passed by value. Note that references can't be used as out-parameters (to return multiple values to JS). This hasn't worked before either and probably never will. This was SVN commit r17696.
2016-01-23 07:17:56 -08:00
void SendChangeStateGame(ScriptInterface::CxPrivate* pCxPrivate, const std::wstring& nbp, const std::wstring& players);
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 06:46:52 -08:00
JS::Value GetPlayerList(ScriptInterface::CxPrivate* pCxPrivate);
Fix #3386, patch by elexis. This was SVN commit r16997.
2015-09-09 22:30:18 -07:00
void LobbyClearPresenceUpdates(ScriptInterface::CxPrivate* pCxPrivate);
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 06:46:52 -08:00
JS::Value GetGameList(ScriptInterface::CxPrivate* pCxPrivate);
JS::Value GetBoardList(ScriptInterface::CxPrivate* pCxPrivate);
JS::Value GetProfile(ScriptInterface::CxPrivate* pCxPrivate);
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 09:04:45 -07:00
JS::Value LobbyGuiPollNewMessage(ScriptInterface::CxPrivate* pCxPrivate);
JS::Value LobbyGuiPollHistoricMessages(ScriptInterface::CxPrivate* pCxPrivate);
Use const T& for parameters of some types in script-exposed native functions Using references matches the C++ coding style better and should improve performance a bit in theory. It avoids 2 copies of T in case of the functions registered with RegisterFunction (mainy used in the GUI). It should also avoid one or two copies in case of DEFINE_INTERFACE_METHOD_X, which is used in the simulation, but I haven't bothered to count it there exactly. It is now predefined which types have to be passed by const reference and which are passed by value. Note that references can't be used as out-parameters (to return multiple values to JS). This hasn't worked before either and probably never will. This was SVN commit r17696.
2016-01-23 07:17:56 -08:00
void LobbySendMessage(ScriptInterface::CxPrivate* pCxPrivate, const std::wstring& message);
void LobbySetPlayerPresence(ScriptInterface::CxPrivate* pCxPrivate, const std::wstring& presence);
void LobbySetNick(ScriptInterface::CxPrivate* pCxPrivate, const std::wstring& nick);
Removes g_ScriptingHost and implements global to compartment 1 to 1 relation. Each GUI Page gets its own compartment and all ScriptInterfaces in the same thread should now use the same JS Runtime. This is required for the SpiderMonkey upgrade. Check the ticket for details. Closes #2241 Refs #1886 Refs #1966 This was SVN commit r14496.
2014-01-04 02:14:53 -08:00
std::wstring LobbyGetNick(ScriptInterface::CxPrivate* pCxPrivate);
Use const T& for parameters of some types in script-exposed native functions Using references matches the C++ coding style better and should improve performance a bit in theory. It avoids 2 copies of T in case of the functions registered with RegisterFunction (mainy used in the GUI). It should also avoid one or two copies in case of DEFINE_INTERFACE_METHOD_X, which is used in the simulation, but I haven't bothered to count it there exactly. It is now predefined which types have to be passed by const reference and which are passed by value. Note that references can't be used as out-parameters (to return multiple values to JS). This hasn't worked before either and probably never will. This was SVN commit r17696.
2016-01-23 07:17:56 -08:00
void LobbyKick(ScriptInterface::CxPrivate* pCxPrivate, const std::wstring& nick, const std::wstring& reason);
void LobbyBan(ScriptInterface::CxPrivate* pCxPrivate, const std::wstring& nick, const std::wstring& reason);
std::wstring LobbyGetPlayerPresence(ScriptInterface::CxPrivate* pCxPrivate, const std::wstring& nickname);
std::wstring LobbyGetPlayerRole(ScriptInterface::CxPrivate* pCxPrivate, const std::wstring& nickname);
Allow using the XMPP room subject to display lobby information to user, make the lobby GUI code more readable, and cleanup the modern styles. This was SVN commit r14656.
2014-01-24 10:20:15 -08:00
std::wstring LobbyGetRoomSubject(ScriptInterface::CxPrivate* pCxPrivate);
In #2241 I'm going to change the GUI to have one ScriptInterface for each GUI page because that will be required for the Spidermonkey upgrade (#1886). The Multiplayer lobby needs some changes to avoid compartment mismatches. Instead of initializing it with a ScriptInterface and storing script values at different locations, it takes a ScriptInterface argument in the functions that really need to read or write some script values and avoids storing values as script values with an associated compartment where possible. The scripting interface of the lobby is also adjusted to use JSInterface_Lobby.h/cpp files as other components instead of adding all functions to ScriptFunctions.cpp. This makes it a bit more clearly arranged IMO. Fixes #2267 Refs #2241 Refs #1886 This was SVN commit r14199.
2013-11-16 10:38:40 -08:00
// Non-public secure PBKDF2 hash function with salting and 1,337 iterations
std::string EncryptPassword(const std::string& password, const std::string& username);
// Public hash interface.
Use const T& for parameters of some types in script-exposed native functions Using references matches the C++ coding style better and should improve performance a bit in theory. It avoids 2 copies of T in case of the functions registered with RegisterFunction (mainy used in the GUI). It should also avoid one or two copies in case of DEFINE_INTERFACE_METHOD_X, which is used in the simulation, but I haven't bothered to count it there exactly. It is now predefined which types have to be passed by const reference and which are passed by value. Note that references can't be used as out-parameters (to return multiple values to JS). This hasn't worked before either and probably never will. This was SVN commit r17696.
2016-01-23 07:17:56 -08:00
std::wstring EncryptPassword(ScriptInterface::CxPrivate* pCxPrivate, const std::wstring& pass, const std::wstring& user);
Allow using the XMPP room subject to display lobby information to user, make the lobby GUI code more readable, and cleanup the modern styles. This was SVN commit r14656.
2014-01-24 10:20:15 -08:00
#endif // CONFIG2_LOBBY
In #2241 I'm going to change the GUI to have one ScriptInterface for each GUI page because that will be required for the Spidermonkey upgrade (#1886). The Multiplayer lobby needs some changes to avoid compartment mismatches. Instead of initializing it with a ScriptInterface and storing script values at different locations, it takes a ScriptInterface argument in the functions that really need to read or write some script values and avoids storing values as script values with an associated compartment where possible. The scripting interface of the lobby is also adjusted to use JSInterface_Lobby.h/cpp files as other components instead of adding all functions to ScriptFunctions.cpp. This makes it a bit more clearly arranged IMO. Fixes #2267 Refs #2241 Refs #1886 This was SVN commit r14199.
2013-11-16 10:38:40 -08:00
}
Add missing ScriptInterface includes to JSInterface_L10n.cpp from d6db5a466d, JSInterface_Renderer.cpp and JSInterface_GUITypes.cpp from 4b1297b328, JSInterface_VisualReplay.cpp from b830233498, JSInterface_Game.cpp from 5f8be8e0c6, JSInterface_Simulation.cpp from 921c5515a6, JSInterface_Debug.cpp from d6cb9c845b, JSInterface_Main.cpp from 486aec18d4, refs #4772, JSInterface_Mod.cpp where it was incorrectly removed in af03c72f76. Refs D1470. Sort includes alphabetically, add recent Coding Convention macro comments. This was SVN commit r21789.
2018-04-27 09:48:44 -07:00
#endif // INCLUDED_JSI_LOBBY
Reference in a new issue Copy permalink