Skip to content

Refactored ParseACL to use POJOs instead of JSON objects #56

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 27, 2015
Merged

Refactored ParseACL to use POJOs instead of JSON objects #56

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
153 changes: 82 additions & 71 deletions Parse/src/main/java/com/parse/ParseACL.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@
import org.json.JSONObject;

import java.lang.ref.WeakReference;
import java.util.HashMap;
import java.util.Map;

/**
* A {@code ParseACL} is used to control which users can access or modify a particular object. Each
Expand All @@ -23,9 +25,56 @@
public class ParseACL {
private static final String PUBLIC_KEY = "*";
private final static String UNRESOLVED_KEY = "*unresolved";
private static final String READ_PERMISSION = "read";
private static final String WRITE_PERMISSION = "write";
private static final String KEY_ROLE_PREFIX = "role:";
private static final String UNRESOLVED_USER_JSON_KEY = "unresolvedUser";

private static class Permissions {
private static final String READ_PERMISSION = "read";
private static final String WRITE_PERMISSION = "write";

private final boolean readPermission;
private final boolean writePermission;

/* package */ Permissions(boolean readPermission, boolean write) {
this.readPermission = readPermission;
this.writePermission = write;
}

/* package */ Permissions(Permissions permissions) {
this.readPermission = permissions.readPermission;
this.writePermission = permissions.writePermission;
}

/* package */ JSONObject toJSONObject() {
JSONObject json = new JSONObject();

try {
if (readPermission) {
json.put(READ_PERMISSION, true);
}
if (writePermission) {
json.put(WRITE_PERMISSION, true);
}
} catch (JSONException e) {
throw new RuntimeException(e);
}
return json;
}

/* package */ boolean getReadPermission() {
return readPermission;
}

/* package */ boolean getWritePermission() {
return writePermission;
}

/* package */ static Permissions createPermissionsFromJSONObject(JSONObject object) {
boolean read = object.optBoolean(READ_PERMISSION, false);
boolean write = object.optBoolean(WRITE_PERMISSION, false);
return new Permissions(read, write);
}
}

private static ParseDefaultACLController getDefaultACLController() {
return ParseCorePlugins.getInstance().getDefaultACLController();
Expand Down Expand Up @@ -60,21 +109,20 @@ public static void setDefaultACL(ParseACL acl, boolean withAccessForCurrentUser)
*/
//TODO (grantland): This should be a list for multiple lazy users with read/write permissions.
private ParseUser unresolvedUser;
private JSONObject permissionsById;

private Map<String, Permissions> permissionsById;

/**
* Creates an ACL with no permissions granted.
*/
public ParseACL() {
permissionsById = new JSONObject();
permissionsById = new HashMap<>();
}

/* package */ ParseACL copy() {
ParseACL copy = new ParseACL();
try {
copy.permissionsById = new JSONObject(permissionsById.toString());
} catch (JSONException e) {
throw new RuntimeException(e);
for (String id : permissionsById.keySet()) {
copy.permissionsById.put(id, new Permissions(permissionsById.get(id)));
}
copy.unresolvedUser = unresolvedUser;
if (unresolvedUser != null) {
Expand All @@ -93,12 +141,14 @@ void setShared(boolean shared) {

// Internally we expose the json object this wraps
/* package */ JSONObject toJSONObject(ParseEncoder objectEncoder) {
JSONObject json;
JSONObject json = new JSONObject();
try {
json = new JSONObject(permissionsById.toString());
for (String id: permissionsById.keySet()) {
json.put(id, permissionsById.get(id).toJSONObject());
}
if (unresolvedUser != null) {
Object encoded = objectEncoder.encode(unresolvedUser);
json.put("unresolvedUser", encoded);
json.put(UNRESOLVED_USER_JSON_KEY, encoded);
}
} catch (JSONException e) {
throw new RuntimeException(e);
Expand All @@ -113,7 +163,7 @@ void setShared(boolean shared) {
ParseACL acl = new ParseACL();

for (String key : ParseJSONUtils.keys(object)) {
if (key.equals("unresolvedUser")) {
if (key.equals(UNRESOLVED_USER_JSON_KEY)) {
JSONObject unresolvedUser;
try {
unresolvedUser = object.getJSONObject(key);
Expand All @@ -122,16 +172,12 @@ void setShared(boolean shared) {
}
acl.unresolvedUser = (ParseUser) decoder.decode(unresolvedUser);
} else {
String userId = key;
JSONObject permissions;
try {
permissions = object.getJSONObject(userId);
Permissions permissions = Permissions.createPermissionsFromJSONObject(object.getJSONObject(key));
acl.permissionsById.put(key, permissions);
} catch (JSONException e) {
throw new RuntimeException("could not decode ACL: " + e.getMessage());
}
for (String accessType : ParseJSONUtils.keys(permissions)) {
acl.setAccess(accessType, userId, true);
}
}
}
return acl;
Expand All @@ -153,15 +199,11 @@ public ParseACL(ParseUser owner) {
if (user != unresolvedUser) {
return;
}
try {
if (permissionsById.has(UNRESOLVED_KEY)) {
permissionsById.put(user.getObjectId(), permissionsById.get(UNRESOLVED_KEY));
permissionsById.remove(UNRESOLVED_KEY);
}
unresolvedUser = null;
} catch (JSONException e) {
throw new RuntimeException(e);
if (permissionsById.containsKey(UNRESOLVED_KEY)) {
permissionsById.put(user.getObjectId(), permissionsById.get(UNRESOLVED_KEY));
permissionsById.remove(UNRESOLVED_KEY);
}
unresolvedUser = null;
}

/* package */ boolean hasUnresolvedUser() {
Expand All @@ -173,47 +215,12 @@ public ParseACL(ParseUser owner) {
}

// Helper for setting stuff
private void setAccess(String accessType, String userId, boolean allowed) {
try {
JSONObject permissions = permissionsById.optJSONObject(userId);
if (permissions == null) {
if (!allowed) {
// The user already doesn't have this permission, so no action is
// needed.
return;
}
permissions = new JSONObject();
permissionsById.put(userId, permissions);
}

if (allowed) {
permissions.put(accessType, true);
} else {
permissions.remove(accessType);
if (permissions.length() == 0) {
permissionsById.remove(userId);
}
}
} catch (JSONException e) {
throw new RuntimeException("JSON failure with ACL: " + e.getMessage());
private void setPermissionsIfNonEmpty(String userId, boolean readPermission, boolean writePermission) {
if (!(readPermission || writePermission)) {
permissionsById.remove(userId);
}
}

// Helper for getting stuff
private boolean getAccess(String accessType, String userId) {
try {
JSONObject permissions = permissionsById.optJSONObject(userId);
if (permissions == null) {
return false;
}

if (!permissions.has(accessType)) {
return false;
}

return permissions.getBoolean(accessType);
} catch (JSONException e) {
throw new RuntimeException("JSON failure with ACL: " + e.getMessage());
else {
permissionsById.put(userId, new Permissions(readPermission, writePermission));
}
}

Expand Down Expand Up @@ -252,7 +259,8 @@ public void setReadAccess(String userId, boolean allowed) {
if (userId == null) {
throw new IllegalArgumentException("cannot setReadAccess for null userId");
}
setAccess(READ_PERMISSION, userId, allowed);
boolean writePermission = getWriteAccess(userId);
setPermissionsIfNonEmpty(userId, allowed, writePermission);
}

/**
Expand All @@ -264,7 +272,8 @@ public boolean getReadAccess(String userId) {
if (userId == null) {
throw new IllegalArgumentException("cannot getReadAccess for null userId");
}
return getAccess(READ_PERMISSION, userId);
Permissions permissions = permissionsById.get(userId);
return permissions != null && permissions.getReadPermission();
}

/**
Expand All @@ -274,7 +283,8 @@ public void setWriteAccess(String userId, boolean allowed) {
if (userId == null) {
throw new IllegalArgumentException("cannot setWriteAccess for null userId");
}
setAccess(WRITE_PERMISSION, userId, allowed);
boolean readPermission = getReadAccess(userId);
setPermissionsIfNonEmpty(userId, readPermission, allowed);
}

/**
Expand All @@ -286,7 +296,8 @@ public boolean getWriteAccess(String userId) {
if (userId == null) {
throw new IllegalArgumentException("cannot getWriteAccess for null userId");
}
return getAccess(WRITE_PERMISSION, userId);
Permissions permissions = permissionsById.get(userId);
return permissions != null && permissions.getWritePermission();
}

/**
Expand Down Expand Up @@ -513,7 +524,7 @@ public void done(ParseObject object, ParseException e) {

}

/* package for tests */ JSONObject getPermissionsById() {
/* package for tests */ Map<String, Permissions> getPermissionsById() {
return permissionsById;
}
}
Loading