mirror of
https://github.com/Cockatrice/Cockatrice.git
synced 2026-06-10 08:14:47 -07:00
Implementation of websockets in servatrice and test js client
This commit is contained in:
Fabio Bas
parent
e81a6d497b
commit
5b21dc8cde
42 changed files with 39592 additions and 287 deletions
424
webclient/webclient.js
Executable file
424
webclient/webclient.js
Executable file
|
|
@ -0,0 +1,424 @@
|
|||
var StatusEnum = {
|
||||
DISCONNECTED : 0,
|
||||
CONNECTING : 1,
|
||||
CONNECTED : 2,
|
||||
LOGGINGIN : 3,
|
||||
LOGGEDIN : 4,
|
||||
DISCONNECTING : 99
|
||||
};
|
||||
|
||||
var WebClient = {
|
||||
status : StatusEnum.DISCONNECTED,
|
||||
socket : 0,
|
||||
keepalivecb: null,
|
||||
lastPingPending: false,
|
||||
cmdId : 0,
|
||||
initialized: false,
|
||||
pendingCommands : {},
|
||||
options : {
|
||||
host: "",
|
||||
port: "",
|
||||
user: "",
|
||||
pass: "",
|
||||
debug: false,
|
||||
autojoinrooms: false,
|
||||
keepalive: 5000
|
||||
},
|
||||
|
||||
protobuf : null,
|
||||
builder : null,
|
||||
pb : null,
|
||||
pbfiles : [
|
||||
// commands
|
||||
"pb/commands.proto",
|
||||
"pb/session_commands.proto",
|
||||
"pb/room_commands.proto",
|
||||
// replies
|
||||
"pb/server_message.proto",
|
||||
"pb/response.proto",
|
||||
"pb/response_login.proto",
|
||||
"pb/session_event.proto",
|
||||
"pb/event_server_message.proto",
|
||||
"pb/event_connection_closed.proto",
|
||||
"pb/event_list_rooms.proto",
|
||||
"pb/response_join_room.proto",
|
||||
"pb/room_event.proto",
|
||||
"pb/event_room_say.proto"
|
||||
],
|
||||
|
||||
initialize : function()
|
||||
{
|
||||
this.protobuf = dcodeIO.ProtoBuf;
|
||||
this.builder = this.protobuf.newBuilder({ convertFieldsToCamelCase: true });
|
||||
|
||||
$.each(this.pbfiles, function(index, fileName) {
|
||||
WebClient.protobuf.loadProtoFile(fileName, WebClient.builder);
|
||||
});
|
||||
|
||||
this.pb = this.builder.build();
|
||||
|
||||
this.initialized=true;
|
||||
},
|
||||
|
||||
guid : function(options)
|
||||
{
|
||||
function s4() {
|
||||
return Math.floor((1 + Math.random()) * 0x10000)
|
||||
.toString(16)
|
||||
.substring(1);
|
||||
}
|
||||
return s4() + s4() + '-' + s4() + '-' + s4() + '-' + s4() + '-' + s4() + s4() + s4();
|
||||
},
|
||||
|
||||
setStatus : function(status, desc)
|
||||
{
|
||||
this.status = status;
|
||||
if(this.options.debug)
|
||||
console.log("Stats change:", status, desc)
|
||||
if(this.options.statusCallback)
|
||||
this.options.statusCallback(status, desc);
|
||||
},
|
||||
|
||||
resetConnectionvars : function () {
|
||||
this.cmdId = 0;
|
||||
this.pendingCommands = {};
|
||||
},
|
||||
|
||||
sendCommand : function (cmd, callback)
|
||||
{
|
||||
this.cmdId++;
|
||||
cmd["cmdId"] = this.cmdId;
|
||||
this.pendingCommands[this.cmdId] = callback;
|
||||
|
||||
if (this.socket.readyState == WebSocket.OPEN) {
|
||||
this.socket.send(cmd.toArrayBuffer());
|
||||
if(this.options.debug)
|
||||
console.log("Sent: " + cmd.toString());
|
||||
} else {
|
||||
if(this.options.debug)
|
||||
console.log("Send: Not connected");
|
||||
}
|
||||
},
|
||||
|
||||
sendRoomCommand : function(roomId, roomCmd, callback)
|
||||
{
|
||||
var cmd = new WebClient.pb.CommandContainer({
|
||||
"roomId" : roomId,
|
||||
"roomCommand" : [ roomCmd ]
|
||||
});
|
||||
WebClient.sendCommand(cmd, callback);
|
||||
},
|
||||
|
||||
sendSessionCommand : function(ses, callback)
|
||||
{
|
||||
var cmd = new WebClient.pb.CommandContainer({
|
||||
"sessionCommand" : [ ses ]
|
||||
});
|
||||
WebClient.sendCommand(cmd, callback);
|
||||
},
|
||||
|
||||
startPingLoop : function()
|
||||
{
|
||||
keepalivecb = setInterval(function() {
|
||||
// check if the previous ping got no reply
|
||||
if(WebClient.lastPingPending)
|
||||
{
|
||||
WebClient.socket.close();
|
||||
WebClient.setStatus(StatusEnum.DISCONNECTED, 'Connection timeout');
|
||||
}
|
||||
|
||||
// stop the ping loop if we're disconnected
|
||||
if(WebClient.status != StatusEnum.LOGGEDIN)
|
||||
{
|
||||
clearInterval(keepalivecb);
|
||||
keepalivecb = null;
|
||||
return;
|
||||
}
|
||||
|
||||
// send a ping
|
||||
var CmdPing = new WebClient.pb.Command_Ping();
|
||||
|
||||
var sc = new WebClient.pb.SessionCommand({
|
||||
".Command_Ping.ext" : CmdPing
|
||||
});
|
||||
|
||||
WebClient.lastPingPending = true;
|
||||
WebClient.sendSessionCommand(sc, function() {
|
||||
WebClient.lastPingPending = false;
|
||||
});
|
||||
|
||||
}, WebClient.options.keepalive);
|
||||
},
|
||||
|
||||
doLogin : function()
|
||||
{
|
||||
var CmdLogin = new WebClient.pb.Command_Login({
|
||||
"userName" : this.options.user,
|
||||
"password" : this.options.pass,
|
||||
"clientid" : this.guid(),
|
||||
"clientver" : "webclient-0.1 (2015-12-23)",
|
||||
"clientfeatures" : [ "client_id", "client_ver"],
|
||||
});
|
||||
|
||||
var sc = new WebClient.pb.SessionCommand({
|
||||
".Command_Login.ext" : CmdLogin
|
||||
});
|
||||
|
||||
this.sendSessionCommand(sc, function(raw) {
|
||||
var resp = raw[".Response_Login.ext"];
|
||||
switch(raw.responseCode)
|
||||
{
|
||||
case WebClient.pb.Response.ResponseCode.RespOk:
|
||||
WebClient.setStatus(StatusEnum.LOGGEDIN, 'Logged in.');
|
||||
|
||||
if(WebClient.options.userInfoCallback)
|
||||
WebClient.options.userInfoCallback(resp);
|
||||
|
||||
WebClient.startPingLoop();
|
||||
WebClient.doListRooms();
|
||||
break;
|
||||
case WebClient.pb.Response.ResponseCode.RespClientUpdateRequired:
|
||||
WebClient.setStatus(StatusEnum.DISCONNECTING, 'Login failed: missing features');
|
||||
break;
|
||||
case WebClient.pb.Response.ResponseCode.RespWrongPassword:
|
||||
WebClient.setStatus(StatusEnum.DISCONNECTING, 'Login failed: incorrect username or password');
|
||||
break;
|
||||
case WebClient.pb.Response.ResponseCode.RespWouldOverwriteOldSession:
|
||||
WebClient.setStatus(StatusEnum.DISCONNECTING, 'Login failed: duplicated user session');
|
||||
break;
|
||||
case WebClient.pb.Response.ResponseCode.RespUserIsBanned:
|
||||
WebClient.setStatus(StatusEnum.DISCONNECTING, 'Login failed: banned user');
|
||||
break;
|
||||
case WebClient.pb.Response.ResponseCode.RespUsernameInvalid:
|
||||
WebClient.setStatus(StatusEnum.DISCONNECTING, 'Login failed: invalid username');
|
||||
break;
|
||||
case WebClient.pb.Response.ResponseCode.RespRegistrationRequired:
|
||||
WebClient.setStatus(StatusEnum.DISCONNECTING, 'Login failed: registration required');
|
||||
break;
|
||||
case WebClient.pb.Response.ResponseCode.RespClientIdRequired:
|
||||
WebClient.setStatus(StatusEnum.DISCONNECTING, 'Login failed: missing client ID');
|
||||
break;
|
||||
case WebClient.pb.Response.ResponseCode.RespContextError:
|
||||
WebClient.setStatus(StatusEnum.DISCONNECTING, 'Login failed: server error');
|
||||
break;
|
||||
case WebClient.pb.Response.ResponseCode.RespAccountNotActivated:
|
||||
WebClient.setStatus(StatusEnum.DISCONNECTING, 'Login failed: account not activated');
|
||||
break;
|
||||
case WebClient.pb.Response.ResponseCode.RespClientUpdateRequired:
|
||||
WebClient.setStatus(StatusEnum.DISCONNECTING, 'Login failed: missing features');
|
||||
break;
|
||||
default:
|
||||
WebClient.setStatus(StatusEnum.DISCONNECTING, 'Login failed: unknown error ' + raw.responseCode);
|
||||
break;
|
||||
}
|
||||
});
|
||||
},
|
||||
|
||||
doListRooms : function()
|
||||
{
|
||||
var CmdListRooms = new WebClient.pb.Command_ListRooms();
|
||||
|
||||
var sc = new WebClient.pb.SessionCommand({
|
||||
".Command_ListRooms.ext" : CmdListRooms
|
||||
});
|
||||
|
||||
this.sendSessionCommand(sc, function(raw) {
|
||||
// Command_ListRooms 's response will be received inside a sessionEvent
|
||||
});
|
||||
},
|
||||
|
||||
processSessionEvent : function (raw)
|
||||
{
|
||||
if(raw[".Event_ConnectionClosed.ext"]) {
|
||||
var message = '';
|
||||
switch(raw[".Event_ConnectionClosed.ext"]["reason"])
|
||||
{
|
||||
case WebClient.pb.Event_ConnectionClosed.CloseReason.USER_LIMIT_REACHED:
|
||||
message = 'The server has reached its maximum user capacity';
|
||||
break;
|
||||
case WebClient.pb.Event_ConnectionClosed.CloseReason.TOO_MANY_CONNECTIONS:
|
||||
message = 'There are too many concurrent connections from your address';
|
||||
break;
|
||||
case WebClient.pb.Event_ConnectionClosed.CloseReason.BANNED:
|
||||
message = 'You are banned';
|
||||
break;
|
||||
case WebClient.pb.Event_ConnectionClosed.CloseReason.SERVER_SHUTDOWN:
|
||||
message = 'Scheduled server shutdown';
|
||||
break;
|
||||
case WebClient.pb.Event_ConnectionClosed.CloseReason.USERNAMEINVALID:
|
||||
message = 'Invalid username';
|
||||
break;
|
||||
case WebClient.pb.Event_ConnectionClosed.CloseReason.LOGGEDINELSEWERE:
|
||||
message = 'You have been logged out due to logging in at another location';
|
||||
break;
|
||||
case WebClient.pb.Event_ConnectionClosed.CloseReason.OTHER:
|
||||
default:
|
||||
message = 'Unknown reason';
|
||||
break;
|
||||
}
|
||||
|
||||
if(this.options.connectionClosedCallback)
|
||||
this.options.connectionClosedCallback(raw[".Event_ConnectionClosed.ext"]["reason"], message);
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
if(raw[".Event_ServerMessage.ext"]) {
|
||||
if(this.options.serverMessageCallback)
|
||||
this.options.serverMessageCallback(raw[".Event_ServerMessage.ext"]["message"]);
|
||||
return;
|
||||
}
|
||||
|
||||
if(raw[".Event_ListRooms.ext"]) {
|
||||
var roomsList = raw[".Event_ListRooms.ext"]["roomList"];
|
||||
if(this.options.listRoomsCallback)
|
||||
this.options.listRoomsCallback(roomsList);
|
||||
if(this.options.autojoinrooms)
|
||||
{
|
||||
$.each(roomsList, function(index, room) {
|
||||
if(room.autoJoin)
|
||||
{
|
||||
var CmdJoinRoom = new WebClient.pb.Command_JoinRoom({
|
||||
"roomId" : room.roomId
|
||||
});
|
||||
|
||||
var sc = new WebClient.pb.SessionCommand({
|
||||
".Command_JoinRoom.ext" : CmdJoinRoom
|
||||
});
|
||||
|
||||
WebClient.sendSessionCommand(sc, WebClient.processJoinRoom);
|
||||
}
|
||||
});
|
||||
}
|
||||
return;
|
||||
}
|
||||
},
|
||||
|
||||
processRoomEvent : function (raw)
|
||||
{
|
||||
if(raw[".Event_RoomSay.ext"]) {
|
||||
if(this.options.roomMessageCallback)
|
||||
this.options.roomMessageCallback(raw["roomId"], raw[".Event_RoomSay.ext"]);
|
||||
return;
|
||||
}
|
||||
|
||||
},
|
||||
|
||||
processJoinRoom : function(raw)
|
||||
{
|
||||
switch(raw["responseCode"])
|
||||
{
|
||||
case WebClient.pb.Response.ResponseCode.RespOk:
|
||||
var roomInfo = raw[".Response_JoinRoom.ext"]["roomInfo"];
|
||||
if(WebClient.options.joinRoomCallback)
|
||||
WebClient.options.joinRoomCallback(roomInfo);
|
||||
break;
|
||||
case WebClient.pb.Response.ResponseCode.RespNameNotFound:
|
||||
if(WebClient.options.errorCallback) WebClient.options.errorCallback(raw["responseCode"], "Failed to join the room: it doesn't exists on the server.");
|
||||
return;
|
||||
case WebClient.pb.Response.ResponseCode.RespContextError:
|
||||
if(WebClient.options.errorCallback) WebClient.options.errorCallback(raw["responseCode"], "The server thinks you are in the room but Cockatrice is unable to display it. Try restarting Cockatrice.");
|
||||
return;
|
||||
case WebClient.pb.Response.ResponseCode.RespUserLevelTooLow:
|
||||
if(WebClient.options.errorCallback) WebClient.options.errorCallback(raw["responseCode"], "You do not have the required permission to join this room.");
|
||||
return;
|
||||
default:
|
||||
if(WebClient.options.errorCallback) WebClient.options.errorCallback(raw["responseCode"], "Failed to join the room due to an unknown error: " + raw["responseCode"]);
|
||||
return;
|
||||
}
|
||||
},
|
||||
|
||||
connect : function(options) {
|
||||
jQuery.extend(this.options, options || {});
|
||||
|
||||
if(!this.initialized)
|
||||
this.initialize();
|
||||
|
||||
this.socket = new WebSocket('ws://' + this.options.host + ':' + this.options.port);
|
||||
this.socket.binaryType = "arraybuffer"; // We are talking binary
|
||||
this.setStatus(StatusEnum.CONNECTING, 'Connecting...');
|
||||
|
||||
this.socket.onclose = function() {
|
||||
WebClient.setStatus(StatusEnum.DISCONNECTED, 'Connection closed');
|
||||
}
|
||||
|
||||
this.socket.onerror = function() {
|
||||
WebClient.setStatus(StatusEnum.DISCONNECTED, 'Connection failed');
|
||||
}
|
||||
|
||||
this.socket.onopen = function(){
|
||||
WebClient.setStatus(StatusEnum.CONNECTED, 'Connected, logging in...');
|
||||
WebClient.resetConnectionvars();
|
||||
WebClient.doLogin();
|
||||
}
|
||||
|
||||
this.socket.onmessage = function(event) {
|
||||
//console.log("Received " + event.data.byteLength + " bytes");
|
||||
|
||||
try {
|
||||
var msg = WebClient.pb.ServerMessage.decode(event.data);
|
||||
if(WebClient.options.debug)
|
||||
console.log(msg);
|
||||
} catch (err) {
|
||||
console.log("Processing failed:", err);
|
||||
if(WebClient.options.debug)
|
||||
{
|
||||
var view = new Uint8Array(event.data);
|
||||
var str = "";
|
||||
for(var i = 0; i < view.length; i++)
|
||||
{
|
||||
str += String.fromCharCode(view[i]);
|
||||
}
|
||||
console.log(str);
|
||||
}
|
||||
return;
|
||||
}
|
||||
|
||||
switch (msg.messageType) {
|
||||
case WebClient.pb.ServerMessage.MessageType.RESPONSE:
|
||||
var response = msg.response;
|
||||
var cmdId = response.cmdId;
|
||||
|
||||
if(!WebClient.pendingCommands.hasOwnProperty(cmdId))
|
||||
return;
|
||||
WebClient.pendingCommands[cmdId](response);
|
||||
delete WebClient.pendingCommands[cmdId];
|
||||
break;
|
||||
case WebClient.pb.ServerMessage.MessageType.SESSION_EVENT:
|
||||
WebClient.processSessionEvent(msg.sessionEvent);
|
||||
break;
|
||||
case WebClient.pb.ServerMessage.MessageType.GAME_EVENT_CONTAINER:
|
||||
// TODO
|
||||
break;
|
||||
case WebClient.pb.ServerMessage.MessageType.ROOM_EVENT:
|
||||
WebClient.processRoomEvent(msg.roomEvent);
|
||||
break;
|
||||
}
|
||||
}
|
||||
},
|
||||
|
||||
disconnect : function() {
|
||||
this.socket.close();
|
||||
},
|
||||
|
||||
roomSay : function(roomId, msg) {
|
||||
var CmdRoomSay = new WebClient.pb.Command_RoomSay({
|
||||
"message" : msg
|
||||
});
|
||||
|
||||
var sc = new WebClient.pb.RoomCommand({
|
||||
".Command_RoomSay.ext" : CmdRoomSay
|
||||
});
|
||||
|
||||
WebClient.sendRoomCommand(roomId, sc, function(raw) {
|
||||
switch(raw["responseCode"])
|
||||
{
|
||||
case WebClient.pb.Response.ResponseCode.RespChatFlood:
|
||||
console.log("room flood " + roomId);
|
||||
break;
|
||||
default:
|
||||
break;
|
||||
}
|
||||
});
|
||||
}
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue