1 package net.pterodactylus.fcp.quelaton;
3 import java.io.IOException;
4 import java.util.Objects;
5 import java.util.Queue;
6 import java.util.concurrent.ConcurrentLinkedQueue;
7 import java.util.concurrent.ExecutionException;
8 import java.util.concurrent.ExecutorService;
9 import java.util.concurrent.atomic.AtomicBoolean;
10 import java.util.concurrent.atomic.AtomicReference;
11 import java.util.function.Consumer;
13 import net.pterodactylus.fcp.AllData;
14 import net.pterodactylus.fcp.BaseMessage;
15 import net.pterodactylus.fcp.CloseConnectionDuplicateClientName;
16 import net.pterodactylus.fcp.ConfigData;
17 import net.pterodactylus.fcp.DataFound;
18 import net.pterodactylus.fcp.EndListPeerNotes;
19 import net.pterodactylus.fcp.EndListPeers;
20 import net.pterodactylus.fcp.EndListPersistentRequests;
21 import net.pterodactylus.fcp.FCPPluginReply;
22 import net.pterodactylus.fcp.FcpConnection;
23 import net.pterodactylus.fcp.FcpListener;
24 import net.pterodactylus.fcp.FcpMessage;
25 import net.pterodactylus.fcp.FinishedCompression;
26 import net.pterodactylus.fcp.GetFailed;
27 import net.pterodactylus.fcp.IdentifierCollision;
28 import net.pterodactylus.fcp.NodeData;
29 import net.pterodactylus.fcp.NodeHello;
30 import net.pterodactylus.fcp.Peer;
31 import net.pterodactylus.fcp.PeerNote;
32 import net.pterodactylus.fcp.PeerRemoved;
33 import net.pterodactylus.fcp.PersistentGet;
34 import net.pterodactylus.fcp.PersistentPut;
35 import net.pterodactylus.fcp.PersistentPutDir;
36 import net.pterodactylus.fcp.PersistentRequestModified;
37 import net.pterodactylus.fcp.PersistentRequestRemoved;
38 import net.pterodactylus.fcp.PluginInfo;
39 import net.pterodactylus.fcp.PluginRemoved;
40 import net.pterodactylus.fcp.ProtocolError;
41 import net.pterodactylus.fcp.PutFailed;
42 import net.pterodactylus.fcp.PutFetchable;
43 import net.pterodactylus.fcp.PutSuccessful;
44 import net.pterodactylus.fcp.ReceivedBookmarkFeed;
45 import net.pterodactylus.fcp.SSKKeypair;
46 import net.pterodactylus.fcp.SentFeed;
47 import net.pterodactylus.fcp.SimpleProgress;
48 import net.pterodactylus.fcp.StartedCompression;
49 import net.pterodactylus.fcp.SubscribedUSK;
50 import net.pterodactylus.fcp.SubscribedUSKUpdate;
51 import net.pterodactylus.fcp.TestDDAComplete;
52 import net.pterodactylus.fcp.TestDDAReply;
53 import net.pterodactylus.fcp.URIGenerated;
54 import net.pterodactylus.fcp.UnknownNodeIdentifier;
55 import net.pterodactylus.fcp.UnknownPeerNoteType;
57 import com.google.common.util.concurrent.ListenableFuture;
58 import com.google.common.util.concurrent.ListeningExecutorService;
59 import com.google.common.util.concurrent.MoreExecutors;
62 * An FCP dialog enables you to conveniently wait for a specific set of FCP replies.
64 * @author <a href="bombe@freenetproject.org">David ‘Bombe’ Roden</a>
66 public abstract class FcpDialog<R> implements AutoCloseable, FcpListener {
68 private final Object syncObject = new Object();
69 private final ListeningExecutorService executorService;
70 private final FcpConnection fcpConnection;
71 private final Queue<FcpMessage> messages = new ConcurrentLinkedQueue<>();
72 private final AtomicReference<String> identifier = new AtomicReference<>();
73 private final AtomicBoolean connectionClosed = new AtomicBoolean();
74 private final AtomicReference<Throwable> connectionFailureReason = new AtomicReference<>();
75 private final AtomicBoolean finished = new AtomicBoolean();
76 private final AtomicReference<R> result = new AtomicReference<>();
78 public FcpDialog(ExecutorService executorService, FcpConnection fcpConnection, R initialResult) {
79 this.executorService = MoreExecutors.listeningDecorator(executorService);
80 this.fcpConnection = fcpConnection;
81 result.set(initialResult);
84 protected void setIdentifier(String identifier) {
85 this.identifier.set(identifier);
88 protected String getIdentifier() {
89 return identifier.get();
92 public final boolean isFinished() {
93 return finished.get();
96 protected final void finish() {
100 protected final void setResult(R result) {
101 this.result.set(result);
105 public ListenableFuture<R> send(FcpMessage fcpMessage) throws IOException {
106 setIdentifier(fcpMessage.getField("Identifier"));
107 fcpConnection.addFcpListener(this);
108 messages.add(fcpMessage);
109 return executorService.submit(() -> {
110 synchronized (syncObject) {
111 while (!connectionClosed.get() && (!isFinished() || !messages.isEmpty())) {
112 while (messages.peek() != null) {
113 FcpMessage message = messages.poll();
114 fcpConnection.sendMessage(message);
116 if (isFinished() || connectionClosed.get()) {
122 Throwable throwable = connectionFailureReason.get();
123 if (throwable != null) {
124 throw new ExecutionException(throwable);
130 protected void sendMessage(FcpMessage fcpMessage) {
131 messages.add(fcpMessage);
135 private void notifySyncObject() {
136 synchronized (syncObject) {
137 syncObject.notifyAll();
141 protected final R getResult() {
146 public void close() {
147 fcpConnection.removeFcpListener(this);
150 private <M extends BaseMessage> void consume(Consumer<M> consumer, M message) {
151 consume(consumer, message, "Identifier");
154 private <M extends BaseMessage> void consume(Consumer<M> consumer, M message,
156 if (Objects.equals(message.getField(identifier), this.identifier.get())) {
157 consumeAlways(consumer, message);
161 private <M extends BaseMessage> void consumeAlways(Consumer<M> consumer, M message) {
162 consumer.accept(message);
166 private void consumeUnknown(FcpMessage fcpMessage) {
167 consumeUnknownMessage(fcpMessage);
171 private void consumeClose(Throwable throwable) {
172 connectionFailureReason.set(throwable);
173 connectionClosed.set(true);
178 public final void receivedNodeHello(FcpConnection fcpConnection, NodeHello nodeHello) {
179 consume(this::consumeNodeHello, nodeHello);
182 protected void consumeNodeHello(NodeHello nodeHello) { }
185 public final void receivedCloseConnectionDuplicateClientName(FcpConnection fcpConnection,
186 CloseConnectionDuplicateClientName closeConnectionDuplicateClientName) {
187 connectionFailureReason.set(new IOException("duplicate client name"));
188 connectionClosed.set(true);
193 public final void receivedSSKKeypair(FcpConnection fcpConnection, SSKKeypair sskKeypair) {
194 consume(this::consumeSSKKeypair, sskKeypair);
197 protected void consumeSSKKeypair(SSKKeypair sskKeypair) { }
200 public final void receivedPeer(FcpConnection fcpConnection, Peer peer) {
201 consume(this::consumePeer, peer);
204 protected void consumePeer(Peer peer) { }
207 public final void receivedEndListPeers(FcpConnection fcpConnection, EndListPeers endListPeers) {
208 consume(this::consumeEndListPeers, endListPeers);
211 protected void consumeEndListPeers(EndListPeers endListPeers) { }
214 public final void receivedPeerNote(FcpConnection fcpConnection, PeerNote peerNote) {
215 consume(this::consumePeerNote, peerNote);
218 protected void consumePeerNote(PeerNote peerNote) { }
221 public final void receivedEndListPeerNotes(FcpConnection fcpConnection, EndListPeerNotes endListPeerNotes) {
222 consume(this::consumeEndListPeerNotes, endListPeerNotes);
225 protected void consumeEndListPeerNotes(EndListPeerNotes endListPeerNotes) { }
228 public final void receivedPeerRemoved(FcpConnection fcpConnection, PeerRemoved peerRemoved) {
229 consume(this::consumePeerRemoved, peerRemoved);
232 protected void consumePeerRemoved(PeerRemoved peerRemoved) { }
235 public final void receivedNodeData(FcpConnection fcpConnection, NodeData nodeData) {
236 consume(this::consumeNodeData, nodeData);
239 protected void consumeNodeData(NodeData nodeData) { }
242 public final void receivedTestDDAReply(FcpConnection fcpConnection, TestDDAReply testDDAReply) {
243 consume(this::consumeTestDDAReply, testDDAReply, "Directory");
246 protected void consumeTestDDAReply(TestDDAReply testDDAReply) { }
249 public final void receivedTestDDAComplete(FcpConnection fcpConnection, TestDDAComplete testDDAComplete) {
250 consume(this::consumeTestDDAComplete, testDDAComplete, "Directory");
253 protected void consumeTestDDAComplete(TestDDAComplete testDDAComplete) { }
256 public final void receivedPersistentGet(FcpConnection fcpConnection, PersistentGet persistentGet) {
257 consume(this::consumePersistentGet, persistentGet);
260 protected void consumePersistentGet(PersistentGet persistentGet) { }
263 public final void receivedPersistentPut(FcpConnection fcpConnection, PersistentPut persistentPut) {
264 consume(this::consumePersistentPut, persistentPut);
267 protected void consumePersistentPut(PersistentPut persistentPut) { }
270 public final void receivedEndListPersistentRequests(FcpConnection fcpConnection,
271 EndListPersistentRequests endListPersistentRequests) {
272 consume(this::consumeEndListPersistentRequests, endListPersistentRequests);
275 protected void consumeEndListPersistentRequests(EndListPersistentRequests endListPersistentRequests) { }
278 public final void receivedURIGenerated(FcpConnection fcpConnection, URIGenerated uriGenerated) {
279 consume(this::consumeURIGenerated, uriGenerated);
282 protected void consumeURIGenerated(URIGenerated uriGenerated) { }
285 public final void receivedDataFound(FcpConnection fcpConnection, DataFound dataFound) {
286 consume(this::consumeDataFound, dataFound);
289 protected void consumeDataFound(DataFound dataFound) { }
292 public final void receivedAllData(FcpConnection fcpConnection, AllData allData) {
293 consume(this::consumeAllData, allData);
296 protected void consumeAllData(AllData allData) { }
299 public final void receivedSimpleProgress(FcpConnection fcpConnection, SimpleProgress simpleProgress) {
300 consume(this::consumeSimpleProgress, simpleProgress);
303 protected void consumeSimpleProgress(SimpleProgress simpleProgress) { }
306 public final void receivedStartedCompression(FcpConnection fcpConnection, StartedCompression startedCompression) {
307 consume(this::consumeStartedCompression, startedCompression);
310 protected void consumeStartedCompression(StartedCompression startedCompression) { }
313 public final void receivedFinishedCompression(FcpConnection fcpConnection, FinishedCompression finishedCompression) {
314 consume(this::consumeFinishedCompression, finishedCompression);
317 protected void consumeFinishedCompression(FinishedCompression finishedCompression) { }
320 public final void receivedUnknownPeerNoteType(FcpConnection fcpConnection, UnknownPeerNoteType unknownPeerNoteType) {
321 consume(this::consumeUnknownPeerNoteType, unknownPeerNoteType);
324 protected void consumeUnknownPeerNoteType(UnknownPeerNoteType unknownPeerNoteType) { }
327 public final void receivedUnknownNodeIdentifier(FcpConnection fcpConnection,
328 UnknownNodeIdentifier unknownNodeIdentifier) {
329 consume(this::consumeUnknownNodeIdentifier, unknownNodeIdentifier);
332 protected void consumeUnknownNodeIdentifier(UnknownNodeIdentifier unknownNodeIdentifier) { }
335 public final void receivedConfigData(FcpConnection fcpConnection, ConfigData configData) {
336 consume(this::consumeConfigData, configData);
339 protected void consumeConfigData(ConfigData configData) { }
342 public final void receivedGetFailed(FcpConnection fcpConnection, GetFailed getFailed) {
343 consume(this::consumeGetFailed, getFailed);
346 protected void consumeGetFailed(GetFailed getFailed) { }
349 public final void receivedPutFailed(FcpConnection fcpConnection, PutFailed putFailed) {
350 consume(this::consumePutFailed, putFailed);
353 protected void consumePutFailed(PutFailed putFailed) { }
356 public final void receivedIdentifierCollision(FcpConnection fcpConnection, IdentifierCollision identifierCollision) {
357 consume(this::consumeIdentifierCollision, identifierCollision);
360 protected void consumeIdentifierCollision(IdentifierCollision identifierCollision) { }
363 public final void receivedPersistentPutDir(FcpConnection fcpConnection, PersistentPutDir persistentPutDir) {
364 consume(this::consumePersistentPutDir, persistentPutDir);
367 protected void consumePersistentPutDir(PersistentPutDir persistentPutDir) { }
370 public final void receivedPersistentRequestRemoved(FcpConnection fcpConnection,
371 PersistentRequestRemoved persistentRequestRemoved) {
372 consume(this::consumePersistentRequestRemoved, persistentRequestRemoved);
375 protected void consumePersistentRequestRemoved(PersistentRequestRemoved persistentRequestRemoved) { }
378 public final void receivedSubscribedUSK(FcpConnection fcpConnection, SubscribedUSK subscribedUSK) {
379 consume(this::consumeSubscribedUSK, subscribedUSK);
382 protected void consumeSubscribedUSK(SubscribedUSK subscribedUSK) { }
385 public final void receivedSubscribedUSKUpdate(FcpConnection fcpConnection, SubscribedUSKUpdate subscribedUSKUpdate) {
386 consume(this::consumeSubscribedUSKUpdate, subscribedUSKUpdate);
389 protected void consumeSubscribedUSKUpdate(SubscribedUSKUpdate subscribedUSKUpdate) { }
392 public final void receivedPluginInfo(FcpConnection fcpConnection, PluginInfo pluginInfo) {
393 consume(this::consumePluginInfo, pluginInfo);
396 protected void consumePluginInfo(PluginInfo pluginInfo) { }
399 public final void receivedPluginRemoved(FcpConnection fcpConnection, PluginRemoved pluginRemoved) {
400 consume(this::consumePluginRemoved, pluginRemoved);
403 protected void consumePluginRemoved(PluginRemoved pluginRemoved) { }
406 public final void receivedFCPPluginReply(FcpConnection fcpConnection, FCPPluginReply fcpPluginReply) {
407 consume(this::consumeFCPPluginReply, fcpPluginReply);
410 protected void consumeFCPPluginReply(FCPPluginReply fcpPluginReply) { }
413 public final void receivedPersistentRequestModified(FcpConnection fcpConnection,
414 PersistentRequestModified persistentRequestModified) {
415 consume(this::consumePersistentRequestModified, persistentRequestModified);
418 protected void consumePersistentRequestModified(PersistentRequestModified persistentRequestModified) { }
421 public final void receivedPutSuccessful(FcpConnection fcpConnection, PutSuccessful putSuccessful) {
422 consume(this::consumePutSuccessful, putSuccessful);
425 protected void consumePutSuccessful(PutSuccessful putSuccessful) { }
428 public final void receivedPutFetchable(FcpConnection fcpConnection, PutFetchable putFetchable) {
429 consume(this::consumePutFetchable, putFetchable);
432 protected void consumePutFetchable(PutFetchable putFetchable) { }
435 public final void receivedSentFeed(FcpConnection source, SentFeed sentFeed) {
436 consume(this::consumeSentFeed, sentFeed);
439 protected void consumeSentFeed(SentFeed sentFeed) { }
442 public final void receivedBookmarkFeed(FcpConnection fcpConnection, ReceivedBookmarkFeed receivedBookmarkFeed) {
443 consume(this::consumeReceivedBookmarkFeed, receivedBookmarkFeed);
446 protected void consumeReceivedBookmarkFeed(ReceivedBookmarkFeed receivedBookmarkFeed) { }
449 public final void receivedProtocolError(FcpConnection fcpConnection, ProtocolError protocolError) {
450 consume(this::consumeProtocolError, protocolError);
453 protected void consumeProtocolError(ProtocolError protocolError) { }
456 public final void receivedMessage(FcpConnection fcpConnection, FcpMessage fcpMessage) {
457 consumeUnknown(fcpMessage);
460 protected void consumeUnknownMessage(FcpMessage fcpMessage) { }
463 public final void connectionClosed(FcpConnection fcpConnection, Throwable throwable) {
464 consumeClose(throwable);