safebox/guacamole-client
4
0
Fork 0
mirror of https://github.com/gyurix1968/guacamole-client.git synced 2025-09-07 13:41:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

GUACAMOLE-44: Merge tunnel uploads client-side changes.

Browse Source
This commit is contained in:
James Muehlner
2016-06-06 14:58:02 -07:00
parent 294b349597 2e8263a589
commit 0ef7b90619
14 changed files with 1442 additions and 276 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
guacamole-common/src/main/java/org/apache/guacamole/protocol/GuacamoleStatus.java
View File

@@ -167,4 +167,30 @@ public enum GuacamoleStatus {
return guac_code; return guac_code;
} }
/**
* Returns the GuacamoleStatus corresponding to the given Guacamole
* protocol status code. If no such GuacamoleStatus is defined, null is
* returned.
*
* @param code
* The Guacamole protocol status code to translate into a
* GuacamoleStatus.
*
* @return
* The GuacamoleStatus corresponding to the given Guacamole protocol
* status code, or null if no such GuacamoleStatus is defined.
*/
public static GuacamoleStatus fromGuacamoleStatusCode(int code) {
// Search for a GuacamoleStatus having the given status code
for (GuacamoleStatus status : values()) {
if (status.getGuacamoleStatusCode() == code)
return status;
}
// No such status found
return null;
}
} }

62
guacamole/src/main/java/org/apache/guacamole/rest/APIError.java
View File

@@ -36,6 +36,11 @@ public class APIError {
*/ */
private final String message; private final String message;
/**
* The associated Guacamole protocol status code.
*/
private final Integer statusCode;
/** /**
* All expected request parameters, if any, as a collection of fields. * All expected request parameters, if any, as a collection of fields.
*/ */
@@ -81,7 +86,14 @@ public class APIError {
/** /**
* Permission was denied to perform the requested operation. * Permission was denied to perform the requested operation.
*/ */
PERMISSION_DENIED(Response.Status.FORBIDDEN); PERMISSION_DENIED(Response.Status.FORBIDDEN),
/**
* An error occurred within an intercepted stream, terminating that
* stream. The Guacamole protocol status code of that error can be
* retrieved with getStatusCode().
*/
STREAM_ERROR(Response.Status.BAD_REQUEST);
/** /**
* The HTTP status associated with this error type. * The HTTP status associated with this error type.
@@ -110,6 +122,27 @@ public class APIError {
} }
/**
* Creates a new APIError of type STREAM_ERROR and having the given
* Guacamole protocol status code and human-readable message. The status
* code and message should be taken directly from the "ack" instruction
* causing the error.
*
* @param statusCode
* The Guacamole protocol status code describing the error that
* occurred within the intercepted stream.
*
* @param message
* An arbitrary human-readable message describing the error that
* occurred.
*/
public APIError(int statusCode, String message) {
this.type = Type.STREAM_ERROR;
this.message = message;
this.statusCode = statusCode;
this.expected = null;
}
/** /**
* Create a new APIError with the specified error message. * Create a new APIError with the specified error message.
* *
@@ -120,9 +153,10 @@ public class APIError {
* The error message. * The error message.
*/ */
public APIError(Type type, String message) { public APIError(Type type, String message) {
this.type = type; this.type = type;
this.message = message; this.message = message;
this.expected = null; this.statusCode = null;
this.expected = null;
} }
/** /**
@@ -140,9 +174,10 @@ public class APIError {
* a result of the original request, as a collection of fields. * a result of the original request, as a collection of fields.
*/ */
public APIError(Type type, String message, Collection<Field> expected) { public APIError(Type type, String message, Collection<Field> expected) {
this.type = type; this.type = type;
this.message = message; this.message = message;
this.expected = expected; this.statusCode = null;
this.expected = expected;
} }
/** /**
@@ -155,6 +190,19 @@ public class APIError {
return type; return type;
} }
/**
* Returns the Guacamole protocol status code associated with the error
* that occurred. This is only valid for errors of type STREAM_ERROR.
*
* @return
* The Guacamole protocol status code associated with the error that
* occurred. If the error is not of type STREAM_ERROR, this will be
* null.
*/
public Integer getStatusCode() {
return statusCode;
}
/** /**
* Returns a collection of all required parameters, where each parameter is * Returns a collection of all required parameters, where each parameter is
* represented by a field. * represented by a field.

38
guacamole/src/main/java/org/apache/guacamole/rest/APIException.java
View File

@@ -23,6 +23,7 @@ import java.util.Collection;
import javax.ws.rs.WebApplicationException; import javax.ws.rs.WebApplicationException;
import javax.ws.rs.core.Response; import javax.ws.rs.core.Response;
import org.apache.guacamole.form.Field; import org.apache.guacamole.form.Field;
import org.apache.guacamole.protocol.GuacamoleStatus;
/** /**
* An exception that will result in the given error error information being * An exception that will result in the given error error information being
@@ -60,6 +61,43 @@ public class APIException extends WebApplicationException {
this(new APIError(type, message)); this(new APIError(type, message));
} }
/**
* Creates a new APIException which represents an error that occurred within
* an intercepted Guacamole stream. The nature of that error will be
* described by a given status code, which should be the status code
* provided by the "ack" instruction that reported the error.
*
* @param status
* The Guacamole protocol status code describing the error that
* occurred within the intercepted stream.
*
* @param message
* An arbitrary human-readable message describing the error that
* occurred.
*/
public APIException(int status, String message) {
this(new APIError(status, message));
}
/**
* Creates a new APIException which represents an error that occurred within
* an intercepted Guacamole stream. The nature of that error will be
* described by a given Guacamole protocol status, which should be the
* status associated with the code provided by the "ack" instruction that
* reported the error.
*
* @param status
* The Guacamole protocol status describing the error that occurred
* within the intercepted stream.
*
* @param message
* An arbitrary human-readable message describing the error that
* occurred.
*/
public APIException(GuacamoleStatus status, String message) {
this(status.getGuacamoleStatusCode(), message);
}
/** /**
* Creates a new APIException with the given type, message, and parameter * Creates a new APIException with the given type, message, and parameter
* information. The corresponding APIError will be created from the * information. The corresponding APIError will be created from the

16
guacamole/src/main/java/org/apache/guacamole/rest/RESTExceptionWrapper.java
View File

@@ -34,6 +34,7 @@ import org.apache.guacamole.GuacamoleUnauthorizedException;
import org.apache.guacamole.net.auth.credentials.GuacamoleInsufficientCredentialsException; import org.apache.guacamole.net.auth.credentials.GuacamoleInsufficientCredentialsException;
import org.apache.guacamole.net.auth.credentials.GuacamoleInvalidCredentialsException; import org.apache.guacamole.net.auth.credentials.GuacamoleInvalidCredentialsException;
import org.apache.guacamole.rest.auth.AuthenticationService; import org.apache.guacamole.rest.auth.AuthenticationService;
import org.apache.guacamole.tunnel.GuacamoleStreamException;
import org.slf4j.Logger; import org.slf4j.Logger;
import org.slf4j.LoggerFactory; import org.slf4j.LoggerFactory;
@@ -248,6 +249,21 @@ public class RESTExceptionWrapper implements MethodInterceptor {
} }
// Errors from intercepted streams
catch (GuacamoleStreamException e) {
// Generate default message
String message = e.getMessage();
if (message == null)
message = "Error reported by stream.";
throw new APIException(
e.getStatus(),
message
);
}
// All other errors // All other errors
catch (GuacamoleException e) { catch (GuacamoleException e) {

58
guacamole/src/main/java/org/apache/guacamole/rest/tunnel/TunnelRESTService.java
View File

@@ -21,12 +21,14 @@ package org.apache.guacamole.rest.tunnel;
import com.google.inject.Inject; import com.google.inject.Inject;
import java.io.IOException; import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream; import java.io.OutputStream;
import java.util.Map; import java.util.Map;
import java.util.Set; import java.util.Set;
import javax.ws.rs.Consumes; import javax.ws.rs.Consumes;
import javax.ws.rs.DefaultValue; import javax.ws.rs.DefaultValue;
import javax.ws.rs.GET; import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.Path; import javax.ws.rs.Path;
import javax.ws.rs.PathParam; import javax.ws.rs.PathParam;
import javax.ws.rs.Produces; import javax.ws.rs.Produces;
@@ -134,7 +136,12 @@ public class TunnelRESTService {
@Override @Override
public void write(OutputStream output) throws IOException { public void write(OutputStream output) throws IOException {
tunnel.interceptStream(streamIndex, output); try {
tunnel.interceptStream(streamIndex, output);
}
catch (GuacamoleException e) {
throw new IOException(e);
}
} }
}; };
@@ -143,4 +150,53 @@ public class TunnelRESTService {
} }
/**
* Intercepts a specific stream, sending the contents of the given
* InputStream over that stream as "blob" instructions.
*
* @param authToken
* The authentication token that is used to authenticate the user
* performing the operation.
*
* @param tunnelUUID
* The UUID of the tunnel containing the stream being intercepted.
*
* @param streamIndex
* The index of the stream to intercept.
*
* @param filename
* The filename to use for the sake of identifying the data being sent.
*
* @param data
* An InputStream containing the data to be sent over the intercepted
* stream.
*
* @throws GuacamoleException
* If the session associated with the given auth token cannot be
* retrieved, if no such tunnel exists, or if the intercepted stream
* itself closes with an error.
*/
@POST
@Consumes(MediaType.WILDCARD)
@Path("/{tunnel}/streams/{index}/{filename}")
public void setStreamContents(@QueryParam("token") String authToken,
@PathParam("tunnel") String tunnelUUID,
@PathParam("index") final int streamIndex,
@PathParam("filename") String filename,
InputStream data)
throws GuacamoleException {
GuacamoleSession session = authenticationService.getGuacamoleSession(authToken);
Map<String, StreamInterceptingTunnel> tunnels = session.getTunnels();
// Pull tunnel with given UUID
final StreamInterceptingTunnel tunnel = tunnels.get(tunnelUUID);
if (tunnel == null)
throw new GuacamoleResourceNotFoundException("No such tunnel.");
// Send input over stream
tunnel.interceptStream(streamIndex, data);
}
} }

61
guacamole/src/main/java/org/apache/guacamole/tunnel/GuacamoleStreamException.java Normal file
View File

@@ -0,0 +1,61 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.guacamole.tunnel;
import org.apache.guacamole.GuacamoleServerException;
import org.apache.guacamole.protocol.GuacamoleStatus;
/**
* A generic exception thrown when an intercepted Guacamole stream has closed
* with an error condition. Guacamole streams report errors using the "ack"
* instruction, which provides a status code and human-readable message.
*
* @author Michael Jumper
*/
public class GuacamoleStreamException extends GuacamoleServerException {
/**
* The error condition reported by the intercepted Guacamole stream.
*/
private final GuacamoleStatus status;
/**
* Creates a new GuacamoleStreamException representing an error returned by
* an intercepted stream.
*
* @param status
* The status code of the error condition reported by the intercepted
* Guacamole stream.
*
* @param message
* The human readable description of the error that occurred, as
* provided by the stream.
*/
public GuacamoleStreamException(GuacamoleStatus status, String message) {
super(message);
this.status = status;
}
@Override
public GuacamoleStatus getStatus() {
return status;
}
}

215
guacamole/src/main/java/org/apache/guacamole/tunnel/InputStreamInterceptingFilter.java Normal file
View File

@@ -0,0 +1,215 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.guacamole.tunnel;
import java.io.IOException;
import java.io.InputStream;
import java.util.Arrays;
import java.util.List;
import javax.xml.bind.DatatypeConverter;
import org.apache.guacamole.GuacamoleException;
import org.apache.guacamole.net.GuacamoleTunnel;
import org.apache.guacamole.protocol.GuacamoleInstruction;
import org.apache.guacamole.protocol.GuacamoleStatus;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Filter which selectively intercepts "ack" instructions, automatically reading
* from or closing the stream given with interceptStream(). The required "blob"
* and "end" instructions denoting the content and boundary of the stream are
* sent automatically.
*/
public class InputStreamInterceptingFilter
extends StreamInterceptingFilter<InputStream> {
/**
* Logger for this class.
*/
private static final Logger logger =
LoggerFactory.getLogger(InputStreamInterceptingFilter.class);
/**
* Creates a new InputStreamInterceptingFilter which selectively intercepts
* "ack" instructions. The required "blob" and "end" instructions will
* automatically be sent over the given tunnel based on the content of
* provided InputStreams.
*
* @param tunnel
* The GuacamoleTunnel over which any required "blob" and "end"
* instructions should be sent.
*/
public InputStreamInterceptingFilter(GuacamoleTunnel tunnel) {
super(tunnel);
}
/**
* Injects a "blob" instruction into the outbound Guacamole protocol
* stream, as if sent by the connected client. "blob" instructions are used
* to send chunks of data along a stream.
*
* @param index
* The index of the stream that this "blob" instruction relates to.
*
* @param blob
* The chunk of data to send within the "blob" instruction.
*/
private void sendBlob(String index, byte[] blob) {
// Send "blob" containing provided data
sendInstruction(new GuacamoleInstruction("blob", index,
DatatypeConverter.printBase64Binary(blob)));
}
/**
* Injects an "end" instruction into the outbound Guacamole protocol
* stream, as if sent by the connected client. "end" instructions are used
* to signal the end of a stream.
*
* @param index
* The index of the stream that this "end" instruction relates to.
*/
private void sendEnd(String index) {
sendInstruction(new GuacamoleInstruction("end", index));
}
/**
* Reads the next chunk of data from the InputStream associated with an
* intercepted stream, sending that data as a "blob" instruction over the
* GuacamoleTunnel associated with this filter. If the end of the
* InputStream is reached, an "end" instruction will automatically be sent.
*
* @param stream
* The stream from which the next chunk of data should be read.
*/
private void readNextBlob(InterceptedStream<InputStream> stream) {
// Read blob from stream if it exists
try {
// Read raw data from input stream
byte[] blob = new byte[6048];
int length = stream.getStream().read(blob);
// End stream if no more data
if (length == -1) {
// Close stream, send end if the stream is still valid
if (closeInterceptedStream(stream))
sendEnd(stream.getIndex());
return;
}
// Inject corresponding "blob" instruction
sendBlob(stream.getIndex(), Arrays.copyOf(blob, length));
}
// Terminate stream if it cannot be read
catch (IOException e) {
logger.debug("Unable to read data of intercepted input stream.", e);
// Close stream, send end if the stream is still valid
if (closeInterceptedStream(stream))
sendEnd(stream.getIndex());
}
}
/**
* Handles a single "ack" instruction, sending yet more blobs or closing the
* stream depending on whether the "ack" indicates success or failure. If no
* InputStream is associated with the stream index within the "ack"
* instruction, the instruction is ignored.
*
* @param instruction
* The "ack" instruction being handled.
*/
private void handleAck(GuacamoleInstruction instruction) {
// Verify all required arguments are present
List<String> args = instruction.getArgs();
if (args.size() < 3)
return;
// Pull associated stream
String index = args.get(0);
InterceptedStream<InputStream> stream = getInterceptedStream(index);
if (stream == null)
return;
// Pull status code
String status = args.get(2);
// Terminate stream if an error is encountered
if (!status.equals("0")) {
// Parse status code as integer
int code;
try {
code = Integer.parseInt(status);
}
// Assume internal error if parsing fails
catch (NumberFormatException e) {
logger.debug("Translating invalid status code \"{}\" to SERVER_ERROR.", status);
code = GuacamoleStatus.SERVER_ERROR.getGuacamoleStatusCode();
}
// Flag error and close stream
stream.setStreamError(code, args.get(1));
closeInterceptedStream(stream);
return;
}
// Send next blob
readNextBlob(stream);
}
@Override
public GuacamoleInstruction filter(GuacamoleInstruction instruction)
throws GuacamoleException {
// Intercept "ack" instructions for in-progress streams
if (instruction.getOpcode().equals("ack"))
handleAck(instruction);
// Pass instruction through untouched
return instruction;
}
@Override
protected void handleInterceptedStream(InterceptedStream<InputStream> stream) {
// Read the first blob. Note that future blobs will be read in response
// to received "ack" instructions.
readNextBlob(stream);
}
}

161
guacamole/src/main/java/org/apache/guacamole/tunnel/InterceptedStream.java Normal file
View File

@@ -0,0 +1,161 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.guacamole.tunnel;
import java.io.Closeable;
import org.apache.guacamole.GuacamoleException;
import org.apache.guacamole.protocol.GuacamoleStatus;
/**
* A simple pairing of the index of an intercepted Guacamole stream with the
* stream-type object which will produce or consume the data sent over the
* intercepted Guacamole stream.
*
* @author Michael Jumper
* @param <T>
* The type of object which will produce or consume the data sent over the
* intercepted Guacamole stream. Usually, this will be either InputStream
* or OutputStream.
*/
public class InterceptedStream<T extends Closeable> {
/**
* The index of the Guacamole stream being intercepted.
*/
private final String index;
/**
* The stream which will produce or consume the data sent over the
* intercepted Guacamole stream.
*/
private final T stream;
/**
* The exception which prevented the stream from completing successfully,
* if any. If the stream completed successfully, or has not encountered any
* exception yet, this will be null.
*/
private GuacamoleException streamError = null;
/**
* Creates a new InterceptedStream which associated the given Guacamole
* stream index with the given stream object.
*
* @param index
* The index of the Guacamole stream being intercepted.
*
* @param stream
* The stream which will produce or consume the data sent over the
* intercepted Guacamole stream.
*/
public InterceptedStream(String index, T stream) {
this.index = index;
this.stream = stream;
}
/**
* Returns the index of the Guacamole stream being intercepted.
*
* @return
* The index of the Guacamole stream being intercepted.
*/
public String getIndex() {
return index;
}
/**
* Returns the stream which will produce or consume the data sent over the
* intercepted Guacamole stream.
*
* @return
* The stream which will produce or consume the data sent over the
* intercepted Guacamole stream.
*/
public T getStream() {
return stream;
}
/**
* Reports that this InterceptedStream did not complete successfully due to
* the given GuacamoleException, which could not be thrown at the time due
* to asynchronous handling of the stream contents.
*
* @param streamError
* The exception which prevented the stream from completing
* successfully.
*/
public void setStreamError(GuacamoleException streamError) {
this.streamError = streamError;
}
/**
* Reports that this InterceptedStream did not complete successfully due to
* an error described by the given status code and human-readable message.
* The error reported by this call can later be retrieved as a
* GuacamoleStreamException by calling getStreamError().
*
* @param code
* The Guacamole protocol status code which described the error that
* occurred. This should be taken directly from the "ack" instruction
* that reported the error witin the intercepted stream.
*
* @param message
* A human-readable message describing the error that occurred. This
* should be taken directly from the "ack" instruction that reported
* the error witin the intercepted stream.
*/
public void setStreamError(int code, String message) {
// Map status code to GuacamoleStatus, assuming SERVER_ERROR by default
GuacamoleStatus status = GuacamoleStatus.fromGuacamoleStatusCode(code);
if (status == null)
status = GuacamoleStatus.SERVER_ERROR;
// Associate stream with corresponding GuacamoleStreamException
setStreamError(new GuacamoleStreamException(status, message));
}
/**
* Returns whether an error has prevented this InterceptedStream from
* completing successfully. This will return false if the stream has
* completed successfully OR if the stream simply has not yet completed.
*
* @return
* true if an error has prevented this InterceptedStream from
* completing successfully, false otherwise.
*/
public boolean hasStreamError() {
return streamError != null;
}
/**
* Returns a GuacamoleException which describes why this InterceptedStream
* did not complete successfully.
*
* @return
* An exception describing the error that prevented the stream from
* completing successfully, or null if no such error has occurred.
*/
public GuacamoleException getStreamError() {
return streamError;
}
}

211
guacamole/src/main/java/org/apache/guacamole/tunnel/InterceptedStreamMap.java Normal file
View File

@@ -0,0 +1,211 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.guacamole.tunnel;
import java.io.Closeable;
import java.io.IOException;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Map-like storage for intercepted Guacamole streams.
*
* @author Michael Jumper
* @param <T>
* The type of object which will produce or consume the data sent over the
* intercepted Guacamole stream. Usually, this will be either InputStream
* or OutputStream.
*/
public class InterceptedStreamMap<T extends Closeable> {
/**
* Logger for this class.
*/
private static final Logger logger = LoggerFactory.getLogger(InterceptedStreamMap.class);
/**
* The maximum number of milliseconds to wait for notification that a
* stream has closed before explicitly checking for closure ourselves.
*/
private static final long STREAM_WAIT_TIMEOUT = 1000;
/**
* Mapping of the indexes of all streams whose associated "blob" and "end"
* instructions should be intercepted.
*/
private final ConcurrentMap<String, InterceptedStream<T>> streams =
new ConcurrentHashMap<String, InterceptedStream<T>>();
/**
* Closes the given stream, logging any errors that occur during closure.
* The monitor of the stream is notified via a single call to notify() once
* the attempt to close has been made.
*
* @param stream
* The stream to close and notify.
*/
private void close(T stream) {
// Attempt to close stream
try {
stream.close();
}
catch (IOException e) {
logger.warn("Unable to close intercepted stream: {}", e.getMessage());
logger.debug("I/O error prevented closure of intercepted stream.", e);
}
// Notify waiting threads that the stream has ended
synchronized (stream) {
stream.notify();
}
}
/**
* Closes the stream object associated with the stream having the given
* index, if any, removing it from the map, logging any errors that occur
* during closure, and unblocking any in-progress calls to waitFor() for
* that stream. If no such stream exists within this map, then this
* function has no effect.
*
* @param index
* The index of the stream whose associated stream object should be
* closed.
*
* @return
* The stream associated with the given index, if the stream was stored
* within this map, or null if no such stream exists.
*/
public InterceptedStream<T> close(String index) {
// Remove associated stream
InterceptedStream<T> stream = streams.remove(index);
if (stream == null)
return null;
// Close stream if it exists
close(stream.getStream());
return stream;
}
/**
* Closes the given stream, logging any errors that occur during closure,
* and unblocking any in-progress calls to waitFor() for the given stream.
* If the given stream is stored within this map, it will also be removed.
*
* @param stream
* The stream to close.
*
* @return
* true if the given stream was stored within this map, false
* otherwise.
*/
public boolean close(InterceptedStream<T> stream) {
// Remove stream if present
boolean wasRemoved = streams.remove(stream.getIndex(), stream);
// Close provided stream
close(stream.getStream());
return wasRemoved;
}
/**
* Removes and closes all streams stored within this map, logging any errors
* that occur during closure, and unblocking any in-progress calls to
* waitFor().
*/
public void closeAll() {
// Close any active streams
for (InterceptedStream<T> stream : streams.values())
close(stream.getStream());
// Remove now-useless references
streams.clear();
}
/**
* Blocks until the given stream is closed, or until another stream with
* the same index replaces it.
*
* @param stream
* The stream to wait for.
*/
public void waitFor(InterceptedStream<T> stream) {
T underlyingStream = stream.getStream();
// Wait for stream to close
synchronized (underlyingStream) {
while (streams.get(stream.getIndex()) == stream) {
try {
underlyingStream.wait(STREAM_WAIT_TIMEOUT);
}
catch (InterruptedException e) {
// Ignore
}
}
}
}
/**
* Returns the stream stored in this map under the given index.
*
* @param index
* The index of the stream to return.
*
* @return
* The stream having the given index, or null if no such stream is
* stored within this map.
*/
public InterceptedStream<T> get(String index) {
return streams.get(index);
}
/**
* Adds the given stream to this map, storing it under its associated
* index. If another stream already exists within this map having the same
* index, that stream will be closed and replaced.
*
* @param stream
* The stream to store within this map.
*/
public void put(InterceptedStream<T> stream) {
// Add given stream to map
InterceptedStream<T> oldStream =
streams.put(stream.getIndex(), stream);
// If a previous stream DID exist, close it
if (oldStream != null)
close(oldStream.getStream());
}
}

194
guacamole/src/main/java/org/apache/guacamole/tunnel/OutputStreamInterceptingFilter.java Normal file
View File

@@ -0,0 +1,194 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.guacamole.tunnel;
import java.io.IOException;
import java.io.OutputStream;
import java.util.List;
import javax.xml.bind.DatatypeConverter;
import org.apache.guacamole.GuacamoleException;
import org.apache.guacamole.net.GuacamoleTunnel;
import org.apache.guacamole.protocol.GuacamoleInstruction;
import org.apache.guacamole.protocol.GuacamoleStatus;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Filter which selectively intercepts "blob" and "end" instructions,
* automatically writing to or closing the stream given with
* interceptStream(). The required "ack" responses to received blobs are
* sent automatically.
*
* @author Michael Jumper
*/
public class OutputStreamInterceptingFilter
extends StreamInterceptingFilter<OutputStream> {
/**
* Logger for this class.
*/
private static final Logger logger =
LoggerFactory.getLogger(OutputStreamInterceptingFilter.class);
/**
* Creates a new OutputStreamInterceptingFilter which selectively intercepts
* "blob" and "end" instructions. The required "ack" responses will
* automatically be sent over the given tunnel.
*
* @param tunnel
* The GuacamoleTunnel over which any required "ack" instructions
* should be sent.
*/
public OutputStreamInterceptingFilter(GuacamoleTunnel tunnel) {
super(tunnel);
}
/**
* Injects an "ack" instruction into the outbound Guacamole protocol
* stream, as if sent by the connected client. "ack" instructions are used
* to acknowledge the receipt of a stream and its subsequent blobs, and are
* the only means of communicating success/failure status.
*
* @param index
* The index of the stream that this "ack" instruction relates to.
*
* @param message
* An arbitrary human-readable message to include within the "ack"
* instruction.
*
* @param status
* The status of the stream operation being acknowledged via the "ack"
* instruction. Error statuses will implicitly close the stream via
* closeStream().
*/
private void sendAck(String index, String message, GuacamoleStatus status) {
// Error "ack" instructions implicitly close the stream
if (status != GuacamoleStatus.SUCCESS)
closeInterceptedStream(index);
sendInstruction(new GuacamoleInstruction("ack", index, message,
Integer.toString(status.getGuacamoleStatusCode())));
}
/**
* Handles a single "blob" instruction, decoding its base64 data,
* sending that data to the associated OutputStream, and ultimately
* dropping the "blob" instruction such that the client never receives
* it. If no OutputStream is associated with the stream index within
* the "blob" instruction, the instruction is passed through untouched.
*
* @param instruction
* The "blob" instruction being handled.
*
* @return
* The originally-provided "blob" instruction, if that instruction
* should be passed through to the client, or null if the "blob"
* instruction should be dropped.
*/
private GuacamoleInstruction handleBlob(GuacamoleInstruction instruction) {
// Verify all required arguments are present
List<String> args = instruction.getArgs();
if (args.size() < 2)
return instruction;
// Pull associated stream
String index = args.get(0);
InterceptedStream<OutputStream> stream = getInterceptedStream(index);
if (stream == null)
return instruction;
// Decode blob
byte[] blob;
try {
String data = args.get(1);
blob = DatatypeConverter.parseBase64Binary(data);
}
catch (IllegalArgumentException e) {
logger.warn("Received base64 data for intercepted stream was invalid.");
logger.debug("Decoding base64 data for intercepted stream failed.", e);
return null;
}
// Attempt to write data to stream
try {
stream.getStream().write(blob);
sendAck(index, "OK", GuacamoleStatus.SUCCESS);
}
catch (IOException e) {
sendAck(index, "FAIL", GuacamoleStatus.SERVER_ERROR);
logger.debug("Write failed for intercepted stream.", e);
}
// Instruction was handled purely internally
return null;
}
/**
* Handles a single "end" instruction, closing the associated
* OutputStream. If no OutputStream is associated with the stream index
* within the "end" instruction, this function has no effect.
*
* @param instruction
* The "end" instruction being handled.
*/
private void handleEnd(GuacamoleInstruction instruction) {
// Verify all required arguments are present
List<String> args = instruction.getArgs();
if (args.size() < 1)
return;
// Terminate stream
closeInterceptedStream(args.get(0));
}
@Override
public GuacamoleInstruction filter(GuacamoleInstruction instruction)
throws GuacamoleException {
// Intercept "blob" instructions for in-progress streams
if (instruction.getOpcode().equals("blob"))
return handleBlob(instruction);
// Intercept "end" instructions for in-progress streams
if (instruction.getOpcode().equals("end")) {
handleEnd(instruction);
return instruction;
}
// Pass instruction through untouched
return instruction;
}
@Override
protected void handleInterceptedStream(InterceptedStream<OutputStream> stream) {
// Acknowledge that the stream is ready to receive data
sendAck(stream.getIndex(), "OK", GuacamoleStatus.SUCCESS);
}
}

217
guacamole/src/main/java/org/apache/guacamole/tunnel/StreamInterceptingFilter.java Normal file
View File

@@ -0,0 +1,217 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.guacamole.tunnel;
import java.io.Closeable;
import org.apache.guacamole.GuacamoleException;
import org.apache.guacamole.io.GuacamoleWriter;
import org.apache.guacamole.net.GuacamoleTunnel;
import org.apache.guacamole.protocol.GuacamoleFilter;
import org.apache.guacamole.protocol.GuacamoleInstruction;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Filter which selectively intercepts stream-related instructions,
* automatically writing to, reading from, or closing the stream given with
* interceptStream(). Any instructions required by the Guacamole protocol to be
* sent in response to intercepted instructions will be sent automatically.
*
* @param <T>
* The type of object which will produce or consume the data sent over the
* intercepted Guacamole stream. Usually, this will be either InputStream
* or OutputStream.
*/
public abstract class StreamInterceptingFilter<T extends Closeable>
implements GuacamoleFilter {
/**
* Logger for this class.
*/
private static final Logger logger =
LoggerFactory.getLogger(StreamInterceptingFilter.class);
/**
* Mapping of the all streams whose related instructions should be
* intercepted.
*/
private final InterceptedStreamMap<T> streams = new InterceptedStreamMap<T>();
/**
* The tunnel over which any required instructions should be sent.
*/
private final GuacamoleTunnel tunnel;
/**
* Creates a new StreamInterceptingFilter which selectively intercepts
* stream-related instructions. Any instructions required by the Guacamole
* protocol to be sent in response to intercepted instructions will be sent
* automatically over the given tunnel.
*
* @param tunnel
* The GuacamoleTunnel over which any required instructions should be
* sent.
*/
public StreamInterceptingFilter(GuacamoleTunnel tunnel) {
this.tunnel = tunnel;
}
/**
* Injects an arbitrary Guacamole instruction into the outbound Guacamole
* protocol stream (GuacamoleWriter) of the tunnel associated with this
* StreamInterceptingFilter, as if the instruction was sent by the connected
* client.
*
* @param instruction
* The Guacamole instruction to inject.
*/
protected void sendInstruction(GuacamoleInstruction instruction) {
// Temporarily acquire writer to send "ack" instruction
GuacamoleWriter writer = tunnel.acquireWriter();
// Send successful "ack"
try {
writer.writeInstruction(instruction);
}
catch (GuacamoleException e) {
logger.debug("Unable to send \"{}\" for intercepted stream.",
instruction.getOpcode(), e);
}
// Done writing
tunnel.releaseWriter();
}
/**
* Returns the stream having the given index and currently being intercepted
* by this filter.
*
* @param index
* The index of the stream to return.
*
* @return
* The stream having the given index, or null if no such stream is
* being intercepted.
*/
protected InterceptedStream<T> getInterceptedStream(String index) {
return streams.get(index);
}
/**
* Closes the stream having the given index and currently being intercepted
* by this filter, if any. If no such stream is being intercepted, then this
* function has no effect.
*
* @param index
* The index of the stream to close.
*
* @return
* The stream associated with the given index, if the stream is being
* intercepted, or null if no such stream exists.
*/
protected InterceptedStream<T> closeInterceptedStream(String index) {
return streams.close(index);
}
/**
* Closes the given stream.
*
* @param stream
* The stream to close.
*
* @return
* true if the given stream was being intercepted, false otherwise.
*/
protected boolean closeInterceptedStream(InterceptedStream<T> stream) {
return streams.close(stream);
}
/**
* Closes all streams being intercepted by this filter.
*/
public void closeAllInterceptedStreams() {
streams.closeAll();
}
/**
* Begins handling the data of the given intercepted stream. This function
* will automatically be invoked by interceptStream() for any valid stream.
* It is not required that this function block until all data is handled;
* interceptStream() will do this automatically. Implementations are free
* to use asynchronous approaches to data handling.
*
* @param stream
* The stream being intercepted.
*/
protected abstract void handleInterceptedStream(InterceptedStream<T> stream);
/**
* Intercept the stream having the given index, producing or consuming its
* data as appropriate. The given stream object will automatically be closed
* when the stream ends. If there is no stream having the given index, then
* the stream object will be closed immediately. This function will block
* until all data has been handled and the stream is ended.
*
* @param index
* The index of the stream to intercept.
*
* @param stream
* The stream object which will produce or consume all data for the
* stream having the given index.
*
* @throws GuacamoleException
* If an error occurs while intercepting the stream, or if the stream
* itself reports an error.
*/
public void interceptStream(int index, T stream) throws GuacamoleException {
InterceptedStream<T> interceptedStream;
String indexString = Integer.toString(index);
// Atomically verify tunnel is open and add the given stream
synchronized (tunnel) {
// Do nothing if tunnel is not open
if (!tunnel.isOpen())
return;
// Wrap stream
interceptedStream = new InterceptedStream<T>(indexString, stream);
// Replace any existing stream
streams.put(interceptedStream);
}
// Produce/consume all stream data
handleInterceptedStream(interceptedStream);
// Wait for stream to close
streams.waitFor(interceptedStream);
// Throw any asynchronously-provided exception
if (interceptedStream.hasStreamError())
throw interceptedStream.getStreamError();
}
}

342
guacamole/src/main/java/org/apache/guacamole/tunnel/StreamInterceptingTunnel.java
View File

@@ -19,30 +19,23 @@
package org.apache.guacamole.tunnel; package org.apache.guacamole.tunnel;
import java.io.BufferedInputStream;
import java.io.BufferedOutputStream; import java.io.BufferedOutputStream;
import java.io.IOException; import java.io.InputStream;
import java.io.OutputStream; import java.io.OutputStream;
import java.util.List;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import javax.xml.bind.DatatypeConverter;
import org.apache.guacamole.GuacamoleException; import org.apache.guacamole.GuacamoleException;
import org.apache.guacamole.io.GuacamoleReader; import org.apache.guacamole.io.GuacamoleReader;
import org.apache.guacamole.io.GuacamoleWriter;
import org.apache.guacamole.net.DelegatingGuacamoleTunnel; import org.apache.guacamole.net.DelegatingGuacamoleTunnel;
import org.apache.guacamole.net.GuacamoleTunnel; import org.apache.guacamole.net.GuacamoleTunnel;
import org.apache.guacamole.protocol.FilteredGuacamoleReader; import org.apache.guacamole.protocol.FilteredGuacamoleReader;
import org.apache.guacamole.protocol.GuacamoleFilter;
import org.apache.guacamole.protocol.GuacamoleInstruction;
import org.apache.guacamole.protocol.GuacamoleStatus;
import org.slf4j.Logger; import org.slf4j.Logger;
import org.slf4j.LoggerFactory; import org.slf4j.LoggerFactory;
/** /**
* GuacamoleTunnel implementation which provides for intercepting the contents * GuacamoleTunnel implementation which provides for producing or consuming the
* of in-progress streams, rerouting received blobs to a provided OutputStream. * contents of in-progress streams, rerouting blobs to a provided OutputStream
* Interception of streams is requested on a per stream basis and lasts only * or from a provided InputStream. Interception of streams is requested on a per
* for the duration of that stream. * stream basis and lasts only for the duration of that stream.
* *
* @author Michael Jumper * @author Michael Jumper
*/ */
@@ -51,13 +44,8 @@ public class StreamInterceptingTunnel extends DelegatingGuacamoleTunnel {
/** /**
* Logger for this class. * Logger for this class.
*/ */
private static final Logger logger = LoggerFactory.getLogger(StreamInterceptingTunnel.class); private static final Logger logger =
LoggerFactory.getLogger(StreamInterceptingTunnel.class);
/**
* The maximum number of milliseconds to wait for notification that a
* stream has closed before explicitly checking for closure ourselves.
*/
private static final long STREAM_WAIT_TIMEOUT = 1000;
/** /**
* Creates a new StreamInterceptingTunnel which wraps the given tunnel, * Creates a new StreamInterceptingTunnel which wraps the given tunnel,
@@ -73,206 +61,16 @@ public class StreamInterceptingTunnel extends DelegatingGuacamoleTunnel {
} }
/** /**
* Mapping of the indexes of all streams whose associated "blob" and "end" * The filter to use for providing stream data from InputStreams.
* instructions should be intercepted.
*/ */
private final Map<String, OutputStream> streams = private final InputStreamInterceptingFilter inputStreamFilter =
new ConcurrentHashMap<String, OutputStream>(); new InputStreamInterceptingFilter(this);
/** /**
* Filter which selectively intercepts "blob" and "end" instructions, * The filter to use for rerouting received stream data to OutputStreams.
* automatically writing to or closing the stream given with
* interceptStream(). The required "ack" responses to received blobs are
* sent automatically.
*/ */
private final GuacamoleFilter STREAM_FILTER = new GuacamoleFilter() { private final OutputStreamInterceptingFilter outputStreamFilter =
new OutputStreamInterceptingFilter(this);
/**
* Handles a single "blob" instruction, decoding its base64 data,
* sending that data to the associated OutputStream, and ultimately
* dropping the "blob" instruction such that the client never receives
* it. If no OutputStream is associated with the stream index within
* the "blob" instruction, the instruction is passed through untouched.
*
* @param instruction
* The "blob" instruction being handled.
*
* @return
* The originally-provided "blob" instruction, if that instruction
* should be passed through to the client, or null if the "blob"
* instruction should be dropped.
*/
private GuacamoleInstruction handleBlob(GuacamoleInstruction instruction) {
// Verify all required arguments are present
List<String> args = instruction.getArgs();
if (args.size() < 2)
return instruction;
// Pull associated stream
String index = args.get(0);
OutputStream stream = streams.get(index);
if (stream == null)
return instruction;
// Decode blob
byte[] blob;
try {
String data = args.get(1);
blob = DatatypeConverter.parseBase64Binary(data);
}
catch (IllegalArgumentException e) {
logger.warn("Received base64 data for intercepted stream was invalid.");
logger.debug("Decoding base64 data for intercepted stream failed.", e);
return null;
}
// Attempt to write data to stream
try {
stream.write(blob);
sendAck(index, "OK", GuacamoleStatus.SUCCESS);
}
catch (IOException e) {
sendAck(index, "FAIL", GuacamoleStatus.SERVER_ERROR);
logger.debug("Write failed for intercepted stream.", e);
}
// Instruction was handled purely internally
return null;
}
/**
* Handles a single "end" instruction, closing the associated
* OutputStream. If no OutputStream is associated with the stream index
* within the "end" instruction, this function has no effect.
*
* @param instruction
* The "end" instruction being handled.
*/
private void handleEnd(GuacamoleInstruction instruction) {
// Verify all required arguments are present
List<String> args = instruction.getArgs();
if (args.size() < 1)
return;
// Terminate stream
closeStream(args.get(0));
}
@Override
public GuacamoleInstruction filter(GuacamoleInstruction instruction)
throws GuacamoleException {
// Intercept "blob" instructions for in-progress streams
if (instruction.getOpcode().equals("blob"))
return handleBlob(instruction);
// Intercept "end" instructions for in-progress streams
if (instruction.getOpcode().equals("end")) {
handleEnd(instruction);
return instruction;
}
// Pass instruction through untouched
return instruction;
}
};
/**
* Closes the given OutputStream, logging any errors that occur during
* closure. The monitor of the OutputStream is notified via a single call
* to notify() once the attempt to close has been made.
*
* @param stream
* The OutputStream to close and notify.
*/
private void closeStream(OutputStream stream) {
// Attempt to close stream
try {
stream.close();
}
catch (IOException e) {
logger.warn("Unable to close intercepted stream: {}", e.getMessage());
logger.debug("I/O error prevented closure of intercepted stream.", e);
}
// Notify waiting threads that the stream has ended
synchronized (stream) {
stream.notify();
}
}
/**
* Closes the OutputStream associated with the stream having the given
* index, if any, logging any errors that occur during closure. If no such
* stream exists, this function has no effect. The monitor of the
* OutputStream is notified via a single call to notify() once the attempt
* to close has been made.
*
* @param index
* The index of the stream whose associated OutputStream should be
* closed and notified.
*/
private OutputStream closeStream(String index) {
// Remove associated stream
OutputStream stream = streams.remove(index);
if (stream == null)
return null;
// Close stream if it exists
closeStream(stream);
return stream;
}
/**
* Injects an "ack" instruction into the outbound Guacamole protocol
* stream, as if sent by the connected client. "ack" instructions are used
* to acknowledge the receipt of a stream and its subsequent blobs, and are
* the only means of communicating success/failure status.
*
* @param index
* The index of the stream that this "ack" instruction relates to.
*
* @param message
* An arbitrary human-readable message to include within the "ack"
* instruction.
*
* @param status
* The status of the stream operation being acknowledged via the "ack"
* instruction. Error statuses will implicitly close the stream via
* closeStream().
*/
private void sendAck(String index, String message, GuacamoleStatus status) {
// Temporarily acquire writer to send "ack" instruction
GuacamoleWriter writer = acquireWriter();
// Send successful "ack"
try {
writer.writeInstruction(new GuacamoleInstruction("ack", index, message,
Integer.toString(status.getGuacamoleStatusCode())));
}
catch (GuacamoleException e) {
logger.debug("Unable to send \"ack\" for intercepted stream.", e);
}
// Error "ack" instructions implicitly close the stream
if (status != GuacamoleStatus.SUCCESS)
closeStream(index);
// Done writing
releaseWriter();
}
/** /**
* Intercept all data received along the stream having the given index, * Intercept all data received along the stream having the given index,
@@ -287,60 +85,78 @@ public class StreamInterceptingTunnel extends DelegatingGuacamoleTunnel {
* *
* @param stream * @param stream
* The OutputStream to write all intercepted data to. * The OutputStream to write all intercepted data to.
*
* @throws GuacamoleException
* If an error occurs while intercepting the stream, or if the stream
* itself reports an error.
*/ */
public void interceptStream(int index, OutputStream stream) { public void interceptStream(int index, OutputStream stream)
throws GuacamoleException {
String indexString = Integer.toString(index);
// Atomically verify tunnel is open and add the given stream
OutputStream oldStream;
synchronized (this) {
// Do nothing if tunnel is not open
if (!isOpen()) {
closeStream(stream);
return;
}
// Wrap stream
stream = new BufferedOutputStream(stream);
// Replace any existing stream
oldStream = streams.put(indexString, stream);
}
// If a previous stream DID exist, close it
if (oldStream != null)
closeStream(oldStream);
// Log beginning of intercepted stream // Log beginning of intercepted stream
logger.debug("Intercepting stream #{} of tunnel \"{}\".", logger.debug("Intercepting output stream #{} of tunnel \"{}\".",
index, getUUID()); index, getUUID());
// Acknowledge stream receipt try {
sendAck(indexString, "OK", GuacamoleStatus.SUCCESS); outputStreamFilter.interceptStream(index, new BufferedOutputStream(stream));
// Wait for stream to close
synchronized (stream) {
while (streams.get(indexString) == stream) {
try {
stream.wait(STREAM_WAIT_TIMEOUT);
}
catch (InterruptedException e) {
// Ignore
}
}
} }
// Log end of intercepted stream // Log end of intercepted stream
logger.debug("Intercepted stream #{} of tunnel \"{}\" ended.", index, getUUID()); finally {
logger.debug("Intercepted output stream #{} of tunnel \"{}\" ended.",
index, getUUID());
}
}
/**
* Intercept the given stream, continuously writing the contents of the
* given InputStream as blobs. The stream will automatically end when
* when the end of the InputStream is reached. If there is no such
* stream, then the InputStream will be closed immediately. This function
* will block until all data from the InputStream has been written to the
* given stream.
*
* @param index
* The index of the stream to intercept.
*
* @param stream
* The InputStream to read all blobs data from.
*
* @throws GuacamoleException
* If an error occurs while intercepting the stream, or if the stream
* itself reports an error.
*/
public void interceptStream(int index, InputStream stream)
throws GuacamoleException {
// Log beginning of intercepted stream
logger.debug("Intercepting input stream #{} of tunnel \"{}\".",
index, getUUID());
try {
inputStreamFilter.interceptStream(index, new BufferedInputStream(stream));
}
// Log end of intercepted stream
finally {
logger.debug("Intercepted input stream #{} of tunnel \"{}\" ended.",
index, getUUID());
}
} }
@Override @Override
public GuacamoleReader acquireReader() { public GuacamoleReader acquireReader() {
return new FilteredGuacamoleReader(super.acquireReader(), STREAM_FILTER);
GuacamoleReader reader = super.acquireReader();
// Filter both input and output streams
reader = new FilteredGuacamoleReader(reader, inputStreamFilter);
reader = new FilteredGuacamoleReader(reader, outputStreamFilter);
return reader;
} }
@Override @Override
@@ -352,16 +168,10 @@ public class StreamInterceptingTunnel extends DelegatingGuacamoleTunnel {
super.close(); super.close();
} }
// Ensure all waiting threads are notified that all streams have ended // Close all intercepted streams
finally { finally {
inputStreamFilter.closeAllInterceptedStreams();
// Close any active streams outputStreamFilter.closeAllInterceptedStreams();
for (OutputStream stream : streams.values())
closeStream(stream);
// Remove now-useless references
streams.clear();
} }
} }

96
guacamole/src/main/webapp/app/rest/services/tunnelService.js
View File

@@ -24,8 +24,12 @@
angular.module('rest').factory('tunnelService', ['$injector', angular.module('rest').factory('tunnelService', ['$injector',
function tunnelService($injector) { function tunnelService($injector) {
// Required types
var Error = $injector.get('Error');
// Required services // Required services
var $http = $injector.get('$http'); var $http = $injector.get('$http');
var $q = $injector.get('$q');
var $window = $injector.get('$window'); var $window = $injector.get('$window');
var authenticationService = $injector.get('authenticationService'); var authenticationService = $injector.get('authenticationService');
@@ -122,6 +126,98 @@ angular.module('rest').factory('tunnelService', ['$injector',
}; };
/**
* Makes a request to the REST API to send the contents of the given file
* along a stream which has been created within the active Guacamole
* connection associated with the given tunnel. The contents of the file
* will automatically be split into individual "blob" instructions, as if
* sent by the connected Guacamole client.
*
* @param {String} tunnel
* The UUID of the tunnel associated with the Guacamole connection
* whose stream should receive the given file.
*
* @param {Guacamole.OutputStream} stream
* The stream that should receive the given file.
*
* @param {File} file
* The file that should be sent along the given stream.
*
* @param {Function} [progressCallback]
* An optional callback which, if provided, will be invoked as the
* file upload progresses. The current position within the file, in
* bytes, will be provided to the callback as the sole argument.
*
* @return {Promise}
* A promise which resolves when the upload has completed, and is
* rejected with an Error if the upload fails. The Guacamole protocol
* status code describing the failure will be included in the Error if
* available. If the status code is available, the type of the Error
* will be STREAM_ERROR.
*/
service.uploadToStream = function uploadToStream(tunnel, stream, file,
progressCallback) {
var deferred = $q.defer();
// Build upload URL
var url = $window.location.origin
+ $window.location.pathname
+ 'api/tunnels/' + encodeURIComponent(tunnel)
+ '/streams/' + encodeURIComponent(stream.index)
+ '/' + encodeURIComponent(file.name)
+ '?token=' + encodeURIComponent(authenticationService.getCurrentToken());
var xhr = new XMLHttpRequest();
// Invoke provided callback if upload tracking is supported
if (progressCallback && xhr.upload) {
xhr.upload.addEventListener('progress', function updateProgress(e) {
progressCallback(e.loaded);
});
}
// Resolve/reject promise once upload has stopped
xhr.onreadystatechange = function uploadStatusChanged() {
// Ignore state changes prior to completion
if (xhr.readyState !== 4)
return;
// Resolve if HTTP status code indicates success
if (xhr.status >= 200 && xhr.status < 300)
deferred.resolve();
// Parse and reject with resulting JSON error
else if (xhr.getResponseHeader('Content-Type') === 'application/json')
deferred.reject(angular.fromJson(xhr.responseText));
// Warn of lack of permission of a proxy rejects the upload
else if (xhr.status >= 400 && xhr.status < 500)
deferred.reject(new Error({
'type' : Error.Type.STREAM_ERROR,
'statusCode' : Guacamole.Status.Code.CLIENT_FORBIDDEN,
'message' : 'HTTP ' + xhr.status
}));
// Assume internal error for all other cases
else
deferred.reject(new Error({
'type' : Error.Type.STREAM_ERROR,
'statusCode' : Guacamole.Status.Code.INTERNAL_ERROR,
'message' : 'HTTP ' + xhr.status
}));
};
// Perform upload
xhr.open('POST', url, true);
xhr.send(file);
return deferred.promise;
};
return service; return service;
}]); }]);

19
guacamole/src/main/webapp/app/rest/types/Error.js
View File

@@ -42,6 +42,14 @@ angular.module('rest').factory('Error', [function defineError() {
*/ */
this.message = template.message; this.message = template.message;
/**
* The Guacamole protocol status code associated with the error that
* occurred. This is only valid for errors of type STREAM_ERROR.
*
* @type Number
*/
this.statusCode = template.statusCode;
/** /**
* The type string defining which values this parameter may contain, * The type string defining which values this parameter may contain,
* as well as what properties are applicable. Valid types are listed * as well as what properties are applicable. Valid types are listed
@@ -110,7 +118,16 @@ angular.module('rest').factory('Error', [function defineError() {
* *
* @type String * @type String
*/ */
PERMISSION_DENIED : 'PERMISSION_DENIED' PERMISSION_DENIED : 'PERMISSION_DENIED',
/**
* An error occurred within an intercepted stream, terminating that
* stream. The Guacamole protocol status code of that error will be
* stored within statusCode.
*
* @type String
*/
STREAM_ERROR : 'STREAM_ERROR'
}; };