Skip to content

Commit

Permalink
Pass initial window state to new clients.
Browse files Browse the repository at this point in the history
This adds an 'initial state producer' to create the burst of
state clients will receive on connect, and serialisers for
WindowModels and BackBuffers.
  • Loading branch information
csmith committed Feb 1, 2016
1 parent 0922a8e commit 0816ba5
Show file tree
Hide file tree
Showing 5 changed files with 185 additions and 2 deletions.
1 change: 1 addition & 0 deletions ui_web2/build.gradle
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
dependencies {
bundle group: 'com.sparkjava', name: 'spark-core', version: '2.3'
bundle group: 'com.google.code.gson', name: 'gson', 'version': '2.5'
}
74 changes: 74 additions & 0 deletions ui_web2/src/com/dmdirc/addons/ui_web2/InitialStateProducer.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
/*
* Copyright (c) 2006-2015 DMDirc Developers
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/

package com.dmdirc.addons.ui_web2;

import com.dmdirc.addons.ui_web2.serialisers.BackBufferSerializer;
import com.dmdirc.addons.ui_web2.serialisers.WindowModelSerialiser;
import com.dmdirc.interfaces.WindowModel;
import com.dmdirc.ui.WindowManager;
import com.dmdirc.ui.messages.BackBuffer;

import com.google.gson.Gson;
import com.google.gson.GsonBuilder;

import java.util.Collection;
import java.util.Collections;

import javax.inject.Inject;

/**
* Handles compiling the initial burst of state that will be sent to new web clients.
*/
public class InitialStateProducer {

private final Gson serialiser;
private final WindowManager windowManager;

@Inject
public InitialStateProducer(final WindowManager windowManager) {
serialiser = new GsonBuilder()
.registerTypeHierarchyAdapter(WindowModel.class, new WindowModelSerialiser())
.registerTypeAdapter(BackBuffer.class, new BackBufferSerializer())
.create();
this.windowManager = windowManager;
}

public String getInitialState() {
final InitialState state = new InitialState(windowManager.getRootWindows());
return serialiser.toJson(state);
}

private static class InitialState {

private final Collection<WindowModel> windows;

private InitialState(final Collection<WindowModel> windows) {
this.windows = windows;
}

public Collection<WindowModel> getWindows() {
return Collections.unmodifiableCollection(windows);
}
}

}
Original file line number Diff line number Diff line change
Expand Up @@ -40,14 +40,17 @@
@Singleton
public class WebSocketController {

private final Collection<Session> sessions = new CopyOnWriteArrayList<Session>();
private final Collection<Session> sessions = new CopyOnWriteArrayList<>();
private final InitialStateProducer initialStateProducer;

@Inject
public WebSocketController() {
public WebSocketController(final InitialStateProducer initialStateProducer) {
this.initialStateProducer = initialStateProducer;
}

void sessionConnected(final Session session) {
sessions.add(session);
sendMessage(session, initialStateProducer.getInitialState());
}

void sessionClosed(final Session session, final int statusCode, final String reason) {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
/*
* Copyright (c) 2006-2015 DMDirc Developers
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/

package com.dmdirc.addons.ui_web2.serialisers;

import com.dmdirc.ui.messages.BackBuffer;
import com.dmdirc.ui.messages.IRCDocument;

import com.google.gson.JsonArray;
import com.google.gson.JsonElement;
import com.google.gson.JsonSerializationContext;
import com.google.gson.JsonSerializer;

import java.lang.reflect.Type;

/**
* Serializes {@link BackBuffer}s.
*/
public class BackBufferSerializer implements JsonSerializer<BackBuffer> {

@Override
public JsonElement serialize(final BackBuffer src, final Type typeOfSrc,
final JsonSerializationContext context) {
final JsonArray res = new JsonArray();
final IRCDocument document = src.getDocument();
for (int i = 0; i < document.getNumLines(); i++) {
// TODO: Pass on foreground and background colours
res.add(document.getLine(i).getText());
}
return res;
}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
/*
* Copyright (c) 2006-2015 DMDirc Developers
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/

package com.dmdirc.addons.ui_web2.serialisers;

import com.dmdirc.interfaces.WindowModel;

import com.google.gson.JsonElement;
import com.google.gson.JsonObject;
import com.google.gson.JsonSerializationContext;
import com.google.gson.JsonSerializer;

import java.lang.reflect.Type;

/**
* Serialises {@link WindowModel}s.
*/
public class WindowModelSerialiser implements JsonSerializer<WindowModel> {

@Override
public JsonElement serialize(final WindowModel src, final Type typeOfSrc,
final JsonSerializationContext context) {
final JsonObject res = new JsonObject();
res.addProperty("name", src.getName());
res.addProperty("icon", src.getIcon());
res.addProperty("title", src.getTitle());
res.addProperty("writable", src.isWritable());
res.add("children", context.serialize(src.getChildren()));
res.add("components", context.serialize(src.getComponents()));
res.add("backbuffer", context.serialize(src.getBackBuffer()));
return res;
}

}

0 comments on commit 0816ba5

Please sign in to comment.