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

GUACAMOLE-926: Remove patch update functionality. It's needed for batch import, and it's a can of worms.

Browse Source
This commit is contained in:
James Muehlner
2023-02-07 00:31:06 +00:00
parent cbb44efb2b
commit 314adf6c23
14 changed files with 39 additions and 184 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/activeconnection/ActiveConnectionService.java
View File

@@ -166,14 +166,6 @@ public class ActiveConnectionService
}
@Override
public void updateExternalObject(ModeledAuthenticatedUser user, ActiveConnection object) throws GuacamoleException {
// Updating active connections is not implemented
throw new GuacamoleSecurityException("Permission denied.");
}
/**
* Retrieve the permission set for the specified user that relates
* to access to active connections.

18
extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/DirectoryObjectService.java
View File

@@ -116,24 +116,6 @@ public interface DirectoryObjectService<InternalType, ExternalType> {
void deleteObject(ModeledAuthenticatedUser user, String identifier)
throws GuacamoleException;
/**
* Updates the object corresponding to the given external representation,
* applying any changes that have been made. If no such object exists,
* this function has no effect.
*
* @param user
* The user updating the object.
*
* @param object
* The external object to apply updates from.
*
* @throws GuacamoleException
* If the user lacks permission to update the object, or an error
* occurs while updating the object.
*/
void updateExternalObject(ModeledAuthenticatedUser user, ExternalType object)
throws GuacamoleException;
/**
* Updates the given object, applying any changes that have been made. If
* no such object exists, this function has no effect.

14
extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ModeledDirectoryObjectService.java
View File

@@ -511,20 +511,6 @@ public abstract class ModeledDirectoryObjectService<InternalType extends Modeled
}
@Override
@Transactional
public void updateExternalObject(ModeledAuthenticatedUser user, ExternalType object)
throws GuacamoleException {
// Convert to the internal type
InternalType internalObject = getObjectInstance(
user, getModelInstance(user, object));
// Delegate to the standard internal update functionality
updateObject(user, internalObject);
}
@Override
public Set<String> getIdentifiers(ModeledAuthenticatedUser user)
throws GuacamoleException {

29
extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/base/ObjectModel.java
View File

@@ -21,8 +21,6 @@ package org.apache.guacamole.auth.jdbc.base;
import java.util.Collection;
import org.apache.guacamole.GuacamoleException;
/**
* Object representation of a Guacamole object, such as a user or connection,
* as represented in the database.
@@ -77,7 +75,7 @@ public abstract class ObjectModel {
*
* @return
* The ID of this object in the database, or null if this object was
* not retrieved from or intended to update the database.
* not retrieved from the database.
*/
public Integer getObjectID() {
return objectID;
@@ -93,31 +91,6 @@ public abstract class ObjectModel {
this.objectID = objectID;
}
/**
* Given a text identifier, attempt to convert to an integer database ID.
* If the identifier is valid, the database ID will be set to this value.
* Otherwise, a GuacamoleException will be thrown.
*
* @param identifier
* The identifier to convert to an integer and set on the database
* model, if valid.
*
* @throws GuacamoleException
* If the provided identifier is not a valid integer.
*/
public void setObjectID(String identifier) throws GuacamoleException {
// Try to convert the provided identifier to an integer ID
try {
setObjectID(Integer.parseInt(identifier));
}
catch (NumberFormatException e) {
throw new GuacamoleException(
"Database identifiers must be integers.");
}
}
/**
* Returns a map of attribute name/value pairs for all attributes associated
* with this model which do not have explicit mappings to actual model

14
extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/connection/ConnectionDirectory.java
View File

@@ -68,18 +68,8 @@ public class ConnectionDirectory extends JDBCDirectory<Connection> {
@Override
@Transactional
public void update(Connection object) throws GuacamoleException {
// If the provided connection is already an internal type, update
// using the internal method
if (object instanceof ModeledConnection)
connectionService.updateObject(
getCurrentUser(), (ModeledConnection) object);
// If the type is not already the expected internal type, use the
// external update method
else
connectionService.updateExternalObject(getCurrentUser(), object);
ModeledConnection connection = (ModeledConnection) object;
connectionService.updateObject(getCurrentUser(), connection);
}
@Override

5
extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/connection/ConnectionModel.java
View File

@@ -387,4 +387,9 @@ public class ConnectionModel extends ChildObjectModel {
}
@Override
public void setIdentifier(String identifier) {
throw new UnsupportedOperationException("Connection identifiers are derived from IDs. They cannot be set.");
}
}

7
extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/connection/ConnectionService.java
View File

@@ -110,19 +110,14 @@ public class ConnectionService extends ModeledChildDirectoryObjectService<Modele
@Override
protected ConnectionModel getModelInstance(ModeledAuthenticatedUser currentUser,
final Connection object) throws GuacamoleException {
final Connection object) {
// Create new ModeledConnection backed by blank model
ConnectionModel model = new ConnectionModel();
ModeledConnection connection = getObjectInstance(currentUser, model);
// If the provided connection has an identifier, set it on the model
if (object.getIdentifier() != null)
model.setObjectID(object.getIdentifier());
// Set model contents through ModeledConnection, copying the provided connection
connection.setParentIdentifier(object.getParentIdentifier());
connection.setIdentifier(object.getIdentifier());
connection.setName(object.getName());
connection.setConfiguration(object.getConfiguration());
connection.setAttributes(object.getAttributes());

6
extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/connectiongroup/ConnectionGroupModel.java
View File

@@ -266,4 +266,10 @@ public class ConnectionGroupModel extends ChildObjectModel {
return id.toString();
}
@Override
public void setIdentifier(String identifier) {
throw new UnsupportedOperationException("Connection group identifiers are derived from IDs. They cannot be set.");
}
}

7
extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/connectiongroup/ConnectionGroupService.java
View File

@@ -92,19 +92,14 @@ public class ConnectionGroupService extends ModeledChildDirectoryObjectService<M
@Override
protected ConnectionGroupModel getModelInstance(ModeledAuthenticatedUser currentUser,
final ConnectionGroup object) throws GuacamoleException {
final ConnectionGroup object) {
// Create new ModeledConnectionGroup backed by blank model
ConnectionGroupModel model = new ConnectionGroupModel();
ModeledConnectionGroup connectionGroup = getObjectInstance(currentUser, model);
// If the provided connection has an identifier, set it on the model
if (object.getIdentifier() != null)
model.setObjectID(object.getIdentifier());
// Set model contents through ModeledConnectionGroup, copying the provided connection group
connectionGroup.setParentIdentifier(object.getParentIdentifier());
connectionGroup.setIdentifier(object.getIdentifier());
connectionGroup.setName(object.getName());
connectionGroup.setType(object.getType());
connectionGroup.setAttributes(object.getAttributes());

6
extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/sharingprofile/SharingProfileModel.java
View File

@@ -71,4 +71,10 @@ public class SharingProfileModel extends ChildObjectModel {
}
@Override
public void setIdentifier(String identifier) {
throw new UnsupportedOperationException("Sharing profile identifiers "
+ "are derived from IDs. They cannot be set.");
}
}

7
extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/sharingprofile/SharingProfileService.java
View File

@@ -90,20 +90,15 @@ public class SharingProfileService
@Override
protected SharingProfileModel getModelInstance(ModeledAuthenticatedUser currentUser,
final SharingProfile object) throws GuacamoleException {
final SharingProfile object) {
// Create new ModeledSharingProfile backed by blank model
SharingProfileModel model = new SharingProfileModel();
ModeledSharingProfile sharingProfile = getObjectInstance(currentUser, model);
// If the provided connection has an identifier, set it on the model
if (object.getIdentifier() != null)
model.setObjectID(object.getIdentifier());
// Set model contents through ModeledSharingProfile, copying the
// provided sharing profile
sharingProfile.setPrimaryConnectionIdentifier(object.getPrimaryConnectionIdentifier());
sharingProfile.setIdentifier(object.getIdentifier());
sharingProfile.setName(object.getName());
sharingProfile.setParameters(object.getParameters());
sharingProfile.setAttributes(object.getAttributes());

4
extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/user/UserService.java
View File

@@ -202,10 +202,6 @@ public class UserService extends ModeledDirectoryObjectService<ModeledUser, User
UserModel model = new UserModel();
ModeledUser user = getObjectInstance(currentUser, model);
// If the provided connection has an identifier, set it on the model
if (object.getIdentifier() != null)
model.setObjectID(object.getIdentifier());
// Set model contents through ModeledUser, copying the provided user
user.setIdentifier(object.getIdentifier());
user.setPassword(object.getPassword());

4
extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/usergroup/UserGroupService.java
View File

@@ -107,10 +107,6 @@ public class UserGroupService extends ModeledDirectoryObjectService<ModeledUserG
UserGroupModel model = new UserGroupModel();
ModeledUserGroup group = getObjectInstance(currentUser, model);
// If the provided connection has an identifier, set it on the model
if (object.getIdentifier() != null)
model.setObjectID(object.getIdentifier());
// Set model contents through ModeledUser, copying the provided group
group.setIdentifier(object.getIdentifier());
group.setAttributes(object.getAttributes());

94
guacamole/src/main/java/org/apache/guacamole/rest/directory/DirectoryResource.java
View File

@@ -417,12 +417,12 @@ public abstract class DirectoryResource<InternalType extends Identifiable, Exter
/**
* Applies the given object patches, updating the underlying directory
* accordingly. This operation supports addition, update, and removal of
* objects through the "add", "replace", and "remove" patch operation.
* The path of each patch operation is of the form "/ID" where ID is the
* identifier of the object being modified. In the case of object creation,
* the identifier is ignored, as the identifier will be automatically
* provided. This operation is atomic.
* accordingly. This operation supports addition and removal of objects
* through the "add" and "remove" patch operation. The path of each patch
* operation is of the form "/ID" where ID is the identifier of the object
* being modified. In the case of object creation, the identifier is
* ignored, as the identifier will be automatically provided. This operation
* is atomic.
*
* @param patches
* The patches to apply for this request.
@@ -461,9 +461,8 @@ public abstract class DirectoryResource<InternalType extends Identifiable, Exter
"The patch cannot be executed.");
// Keep a list of all objects that have been successfully
// added, updated, or removed
// added or removed
Collection<InternalType> addedObjects = new ArrayList<>();
Collection<InternalType> updatedObjects = new ArrayList<>();
Collection<String> removedIdentifiers = new ArrayList<>();
// A list of all responses associated with the successful
@@ -527,64 +526,6 @@ public abstract class DirectoryResource<InternalType extends Identifiable, Exter
}
else if (patch.getOp() == APIPatch.Operation.replace) {
// Filter/sanitize object contents
InternalType internal = filterAndTranslate(patch.getValue());
try {
// Set the model to the supplied identifier from the PATH
String identifier = path.substring(1);
if (identifier == null)
throw new GuacamoleClientException(
"An identifier is required when updating.");
// If there's an identiifer provided in the value,
// make sure it matches the one from the path
String valueId = internal.getIdentifier();
if (valueId != null && !valueId.equals(identifier))
throw new GuacamoleClientException(
"Identifier mismatch between path and value.");
internal.setIdentifier(identifier);
// Attempt to update the object
directory.update(internal);
// Add the object to the list if the update was successful
updatedObjects.add(internal);
// Add a success outcome describing the object update
APIPatchOutcome response = new APIPatchOutcome(
patch.getOp(), internal.getIdentifier(), path);
patchOutcomes.add(response);
creationSuccesses.add(response);
}
catch (GuacamoleException | RuntimeException | Error e) {
failed = true;
fireDirectoryFailureEvent(
DirectoryEvent.Operation.UPDATE,
internal.getIdentifier(), internal, e);
/*
* If the failure represents an understood issue,
* create a failure outcome for this failed patch.
*/
if (e instanceof GuacamoleException)
patchOutcomes.add(new APIPatchError(
patch.getOp(), internal.getIdentifier(), path,
((GuacamoleException) e).getMessage()));
// If an unexpected failure occurs, fall through to the
// standard API error handling
else
throw e;
}
}
// Append each identifier to the list, to be removed atomically
else if (patch.getOp() == APIPatch.Operation.remove) {
@@ -625,6 +566,14 @@ public abstract class DirectoryResource<InternalType extends Identifiable, Exter
throw e;
}
}
else {
throw new GuacamoleUnsupportedException(
"Unsupported patch operation \""
+ patch.getOp() + "\". "
+ "Only add and remove are supported.");
}
}
@@ -655,24 +604,13 @@ public abstract class DirectoryResource<InternalType extends Identifiable, Exter
}
// Fire directory success events for each updated object
Iterator<InternalType> updatedIterator = updatedObjects.iterator();
while (updatedIterator.hasNext()) {
InternalType internal = updatedIterator.next();
fireDirectorySuccessEvent(
DirectoryEvent.Operation.UPDATE,
internal.getIdentifier(), internal);
}
// Fire directory success events for each removed object
Iterator<String> removedIterator = removedIdentifiers.iterator();
while (removedIterator.hasNext()) {
String identifier = removedIterator.next();
fireDirectorySuccessEvent(
DirectoryEvent.Operation.UPDATE,
DirectoryEvent.Operation.REMOVE,
identifier, null);
}