2019-09-05 19:53:22 -07:00
|
|
|
/* Copyright (C) 2019 Wildfire Games.
|
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
|
|
|
|
|
|
2014-11-15 18:10:24 -08:00
|
|
|
#include "lib/config2.h"
|
2014-01-04 02:14:53 -08:00
|
|
|
#include "scriptinterface/ScriptInterface.h"
|
2018-08-25 07:34:30 -07:00
|
|
|
|
|
|
|
|
#include <string>
|
2013-11-16 10:38:40 -08:00
|
|
|
|
|
|
|
|
namespace JSI_Lobby
|
|
|
|
|
{
|
2017-08-23 17:32:42 -07:00
|
|
|
void RegisterScriptFunctions(const ScriptInterface& scriptInterface);
|
2014-11-15 18:10:24 -08:00
|
|
|
|
2014-01-04 02:14:53 -08:00
|
|
|
bool HasXmppClient(ScriptInterface::CxPrivate* pCxPrivate);
|
2014-04-15 23:03:49 -07:00
|
|
|
bool IsRankedGame(ScriptInterface::CxPrivate* pCxPrivate);
|
|
|
|
|
void SetRankedGame(ScriptInterface::CxPrivate* pCxPrivate, bool isRanked);
|
|
|
|
|
|
2014-01-24 10:20:15 -08:00
|
|
|
#if CONFIG2_LOBBY
|
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);
|
2014-01-04 02:14:53 -08:00
|
|
|
void StopXmppClient(ScriptInterface::CxPrivate* pCxPrivate);
|
|
|
|
|
void ConnectXmppClient(ScriptInterface::CxPrivate* pCxPrivate);
|
|
|
|
|
void DisconnectXmppClient(ScriptInterface::CxPrivate* pCxPrivate);
|
2018-01-14 20:30:33 -08:00
|
|
|
bool IsXmppClientConnected(ScriptInterface::CxPrivate* pCxPrivate);
|
2014-01-04 02:14:53 -08:00
|
|
|
void SendGetBoardList(ScriptInterface::CxPrivate* pCxPrivate);
|
2016-01-23 07:17:56 -08:00
|
|
|
void SendGetProfile(ScriptInterface::CxPrivate* pCxPrivate, const std::wstring& player);
|
2015-01-24 06:46:52 -08:00
|
|
|
void SendGameReport(ScriptInterface::CxPrivate* pCxPrivate, JS::HandleValue data);
|
|
|
|
|
void SendRegisterGame(ScriptInterface::CxPrivate* pCxPrivate, JS::HandleValue data);
|
2014-01-04 02:14:53 -08:00
|
|
|
void SendUnregisterGame(ScriptInterface::CxPrivate* pCxPrivate);
|
2016-01-23 07:17:56 -08:00
|
|
|
void SendChangeStateGame(ScriptInterface::CxPrivate* pCxPrivate, const std::wstring& nbp, const std::wstring& players);
|
2015-01-24 06:46:52 -08:00
|
|
|
JS::Value GetPlayerList(ScriptInterface::CxPrivate* pCxPrivate);
|
|
|
|
|
JS::Value GetGameList(ScriptInterface::CxPrivate* pCxPrivate);
|
|
|
|
|
JS::Value GetBoardList(ScriptInterface::CxPrivate* pCxPrivate);
|
|
|
|
|
JS::Value GetProfile(ScriptInterface::CxPrivate* pCxPrivate);
|
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 05:44:41 -08:00
|
|
|
JS::Value LobbyGuiPollNewMessages(ScriptInterface::CxPrivate* pCxPrivate);
|
2017-08-29 09:04:45 -07:00
|
|
|
JS::Value LobbyGuiPollHistoricMessages(ScriptInterface::CxPrivate* pCxPrivate);
|
2019-09-11 04:51:34 -07:00
|
|
|
bool LobbyGuiPollHasPlayerListUpdate(ScriptInterface::CxPrivate* pCxPrivate);
|
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);
|
2014-01-04 02:14:53 -08:00
|
|
|
std::wstring LobbyGetNick(ScriptInterface::CxPrivate* pCxPrivate);
|
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);
|
2019-09-12 10:23:33 -07:00
|
|
|
const char* LobbyGetPlayerPresence(ScriptInterface::CxPrivate* pCxPrivate, const std::wstring& nickname);
|
|
|
|
|
const char* LobbyGetPlayerRole(ScriptInterface::CxPrivate* pCxPrivate, const std::wstring& nickname);
|
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 05:44:41 -08:00
|
|
|
std::wstring LobbyGetPlayerRating(ScriptInterface::CxPrivate* pCxPrivate, const std::wstring& nickname);
|
2014-01-24 10:20:15 -08:00
|
|
|
std::wstring LobbyGetRoomSubject(ScriptInterface::CxPrivate* pCxPrivate);
|
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.
|
2016-01-23 07:17:56 -08:00
|
|
|
std::wstring EncryptPassword(ScriptInterface::CxPrivate* pCxPrivate, const std::wstring& pass, const std::wstring& user);
|
2014-01-24 10:20:15 -08:00
|
|
|
#endif // CONFIG2_LOBBY
|
2013-11-16 10:38:40 -08:00
|
|
|
}
|
|
|
|
|
|
2018-04-27 09:48:44 -07:00
|
|
|
#endif // INCLUDED_JSI_LOBBY
|