Mercurial > hg > AnnotationManagerN4J
annotate src/main/java/de/mpiwg/itgroup/annotations/restlet/AnnotatorAnnotations.java @ 102:9140017e8962
fix bug with empty username. add logging for JSON exceptions.
| author | casties |
|---|---|
| date | Thu, 09 Feb 2017 20:46:15 +0100 |
| parents | 7268c3ca025b |
| children | 7417f5915181 |
| rev | line source |
|---|---|
| 3 | 1 package de.mpiwg.itgroup.annotations.restlet; |
| 2 | |
| 70 | 3 /* |
| 4 * #%L | |
| 5 * AnnotationManager | |
| 6 * %% | |
| 7 * Copyright (C) 2012 - 2014 MPIWG Berlin | |
| 8 * %% | |
| 9 * This program is free software: you can redistribute it and/or modify | |
| 10 * it under the terms of the GNU Lesser General Public License as | |
| 11 * published by the Free Software Foundation, either version 3 of the | |
| 12 * License, or (at your option) any later version. | |
| 13 * | |
| 14 * This program is distributed in the hope that it will be useful, | |
| 15 * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 17 * GNU General Lesser Public License for more details. | |
| 18 * | |
| 19 * You should have received a copy of the GNU General Lesser Public | |
| 20 * License along with this program. If not, see | |
| 21 * <http://www.gnu.org/licenses/lgpl-3.0.html>. | |
| 22 * #L% | |
| 23 */ | |
| 24 | |
| 3 | 25 import java.io.IOException; |
| 65 | 26 import java.io.UnsupportedEncodingException; |
| 27 import java.net.URLDecoder; | |
| 31 | 28 import java.util.ArrayList; |
| 29 import java.util.List; | |
| 3 | 30 |
| 31 | 31 import org.json.JSONArray; |
| 3 | 32 import org.json.JSONException; |
| 33 import org.json.JSONObject; | |
| 31 | 34 import org.restlet.data.Form; |
| 3 | 35 import org.restlet.data.Status; |
| 36 import org.restlet.ext.json.JsonRepresentation; | |
| 37 import org.restlet.representation.Representation; | |
| 38 import org.restlet.resource.Delete; | |
| 39 import org.restlet.resource.Get; | |
| 40 import org.restlet.resource.Post; | |
| 41 import org.restlet.resource.Put; | |
| 42 | |
| 4 | 43 import de.mpiwg.itgroup.annotations.Annotation; |
| 15 | 44 import de.mpiwg.itgroup.annotations.Person; |
| 4 | 45 import de.mpiwg.itgroup.annotations.neo4j.AnnotationStore; |
| 31 | 46 import de.mpiwg.itgroup.annotations.restlet.utils.JSONObjectComparator; |
| 3 | 47 |
| 48 /** | |
| 4 | 49 * Implements the "annotations" uri of the Annotator API. see |
| 50 * <https://github.com/okfn/annotator/wiki/Storage> | |
| 3 | 51 * |
| 52 * @author dwinter, casties | |
| 53 * | |
| 54 */ | |
| 55 public class AnnotatorAnnotations extends AnnotatorResourceImpl { | |
| 56 | |
| 57 /** | |
| 58 * GET with JSON content-type. | |
| 59 * | |
| 60 * @param entity | |
| 61 * @return | |
| 62 */ | |
| 63 @Get("json") | |
| 64 public Representation doGetJSON(Representation entity) { | |
| 75 | 65 logger.fine("AnnotatorAnnotations doGetJSON!"); |
| 3 | 66 // id from URI /annotations/{id} |
| 65 | 67 String id = null; |
| 3 | 68 String jsonId = (String) getRequest().getAttributes().get("id"); |
| 65 | 69 if (jsonId != null) { |
| 70 // URL decode | |
| 71 try { | |
| 72 jsonId = URLDecoder.decode(jsonId, "UTF-8"); | |
| 73 } catch (UnsupportedEncodingException e) { | |
| 74 // this shouldn't happen | |
| 75 } | |
| 76 id = decodeJsonId(jsonId); | |
| 75 | 77 logger.fine("annotation-id=" + id); |
| 65 | 78 } |
| 3 | 79 |
|
14
629e15b345aa
permissions mostly work. need more server-side checking.
casties
parents:
4
diff
changeset
|
80 // do authentication |
| 88 | 81 Person authUser = getUserFromAuthToken(entity); |
| 75 | 82 logger.fine("request authenticated=" + authUser); |
| 3 | 83 |
| 37 | 84 if (id == null) { |
|
63
9f8c9611848a
fixed bug with new rectangle shapes. added limit, offset and sortBy parameters to annotator/ and annotator/search.
casties
parents:
61
diff
changeset
|
85 // no id -- send all annotations |
|
9f8c9611848a
fixed bug with new rectangle shapes. added limit, offset and sortBy parameters to annotator/ and annotator/search.
casties
parents:
61
diff
changeset
|
86 Form form = getRequest().getResourceRef().getQueryAsForm(); |
| 101 | 87 int limit = getInt(form.getFirstValue("limit", "1000")); |
| 88 int offset = getInt(form.getFirstValue("offset", "0")); | |
|
63
9f8c9611848a
fixed bug with new rectangle shapes. added limit, offset and sortBy parameters to annotator/ and annotator/search.
casties
parents:
61
diff
changeset
|
89 String sortBy = form.getFirstValue("sortBy"); |
|
9f8c9611848a
fixed bug with new rectangle shapes. added limit, offset and sortBy parameters to annotator/ and annotator/search.
casties
parents:
61
diff
changeset
|
90 return getAllAnnotations(authUser, limit, offset, sortBy); |
| 37 | 91 } |
| 92 | |
|
63
9f8c9611848a
fixed bug with new rectangle shapes. added limit, offset and sortBy parameters to annotator/ and annotator/search.
casties
parents:
61
diff
changeset
|
93 // send annotation with id |
| 16 | 94 AnnotationStore store = getAnnotationStore(); |
| 95 Annotation annot = store.getAnnotationById(id); | |
|
14
629e15b345aa
permissions mostly work. need more server-side checking.
casties
parents:
4
diff
changeset
|
96 if (annot != null) { |
| 61 | 97 if (!annot.isActionAllowed("read", authUser, store)) { |
|
14
629e15b345aa
permissions mostly work. need more server-side checking.
casties
parents:
4
diff
changeset
|
98 setStatus(Status.CLIENT_ERROR_FORBIDDEN, "Not Authorized!"); |
|
629e15b345aa
permissions mostly work. need more server-side checking.
casties
parents:
4
diff
changeset
|
99 return null; |
|
629e15b345aa
permissions mostly work. need more server-side checking.
casties
parents:
4
diff
changeset
|
100 } |
|
629e15b345aa
permissions mostly work. need more server-side checking.
casties
parents:
4
diff
changeset
|
101 JSONObject result = createAnnotatorJson(annot, (authUser == null)); |
| 4 | 102 return new JsonRepresentation(result); |
| 103 } else { | |
|
14
629e15b345aa
permissions mostly work. need more server-side checking.
casties
parents:
4
diff
changeset
|
104 // not found |
|
629e15b345aa
permissions mostly work. need more server-side checking.
casties
parents:
4
diff
changeset
|
105 setStatus(Status.CLIENT_ERROR_NOT_FOUND); |
|
629e15b345aa
permissions mostly work. need more server-side checking.
casties
parents:
4
diff
changeset
|
106 return null; |
| 3 | 107 } |
| 108 } | |
| 109 | |
|
63
9f8c9611848a
fixed bug with new rectangle shapes. added limit, offset and sortBy parameters to annotator/ and annotator/search.
casties
parents:
61
diff
changeset
|
110 private Representation getAllAnnotations(Person authUser, int limit, int offset, String sortBy) { |
| 31 | 111 AnnotationStore store = getAnnotationStore(); |
| 112 ArrayList<JSONObject> results = new ArrayList<JSONObject>(); | |
| 65 | 113 |
|
63
9f8c9611848a
fixed bug with new rectangle shapes. added limit, offset and sortBy parameters to annotator/ and annotator/search.
casties
parents:
61
diff
changeset
|
114 // read all annotations |
| 101 | 115 List<Annotation> annotations = store.getAnnotations(null, null, 0, 0); |
| 31 | 116 for (Annotation annotation : annotations) { |
| 61 | 117 // check permission |
| 65 | 118 if (!annotation.isActionAllowed("read", authUser, store)) |
| 119 continue; | |
|
63
9f8c9611848a
fixed bug with new rectangle shapes. added limit, offset and sortBy parameters to annotator/ and annotator/search.
casties
parents:
61
diff
changeset
|
120 // add annotation to list |
| 61 | 121 JSONObject jo = createAnnotatorJson(annotation, false); |
| 122 results.add(jo); | |
| 123 } | |
| 124 | |
|
63
9f8c9611848a
fixed bug with new rectangle shapes. added limit, offset and sortBy parameters to annotator/ and annotator/search.
casties
parents:
61
diff
changeset
|
125 // sort if necessary |
| 61 | 126 if (sortBy != null) { |
| 127 JSONObjectComparator.sortAnnotations(results, sortBy); | |
| 128 } | |
| 65 | 129 |
|
63
9f8c9611848a
fixed bug with new rectangle shapes. added limit, offset and sortBy parameters to annotator/ and annotator/search.
casties
parents:
61
diff
changeset
|
130 // put in JSON list |
|
9f8c9611848a
fixed bug with new rectangle shapes. added limit, offset and sortBy parameters to annotator/ and annotator/search.
casties
parents:
61
diff
changeset
|
131 JSONArray rows = new JSONArray(); |
|
9f8c9611848a
fixed bug with new rectangle shapes. added limit, offset and sortBy parameters to annotator/ and annotator/search.
casties
parents:
61
diff
changeset
|
132 int cnt = 0; |
| 101 | 133 int max = limit + offset; |
| 61 | 134 for (JSONObject result : results) { |
|
63
9f8c9611848a
fixed bug with new rectangle shapes. added limit, offset and sortBy parameters to annotator/ and annotator/search.
casties
parents:
61
diff
changeset
|
135 cnt += 1; |
| 101 | 136 if (cnt < offset) continue; |
|
63
9f8c9611848a
fixed bug with new rectangle shapes. added limit, offset and sortBy parameters to annotator/ and annotator/search.
casties
parents:
61
diff
changeset
|
137 rows.put(result); |
| 101 | 138 if (limit > 0 && cnt >= max) break; |
| 61 | 139 } |
| 140 | |
| 31 | 141 // assemble result object |
| 142 JSONObject result = new JSONObject(); | |
| 143 try { | |
|
63
9f8c9611848a
fixed bug with new rectangle shapes. added limit, offset and sortBy parameters to annotator/ and annotator/search.
casties
parents:
61
diff
changeset
|
144 result.put("rows", rows); |
|
9f8c9611848a
fixed bug with new rectangle shapes. added limit, offset and sortBy parameters to annotator/ and annotator/search.
casties
parents:
61
diff
changeset
|
145 result.put("total", rows.length()); |
| 31 | 146 } catch (JSONException e) { |
| 147 setStatus(Status.SERVER_ERROR_INTERNAL, "JSON Error"); | |
| 148 return null; | |
| 149 } | |
| 150 return new JsonRepresentation(result); | |
| 151 } | |
| 152 | |
| 61 | 153 /** |
|
20
715aa11d138b
fixes in permission handling: admin and delete default to creator.
casties
parents:
16
diff
changeset
|
154 * POST with JSON content-type. Creates a new Annotation. |
| 3 | 155 * |
| 156 * @return | |
| 157 */ | |
| 158 @Post("json") | |
| 159 public Representation doPostJson(Representation entity) { | |
| 75 | 160 logger.fine("AnnotatorAnnotations doPostJSON!"); |
| 61 | 161 |
| 162 // do authentication TODO: who's allowed to create? | |
| 88 | 163 Person authUser = getUserFromAuthToken(entity); |
| 75 | 164 logger.fine("request authenticated=" + authUser); |
|
14
629e15b345aa
permissions mostly work. need more server-side checking.
casties
parents:
4
diff
changeset
|
165 if (authUser == null) { |
|
629e15b345aa
permissions mostly work. need more server-side checking.
casties
parents:
4
diff
changeset
|
166 setStatus(Status.CLIENT_ERROR_FORBIDDEN, "Not Authorized!"); |
|
629e15b345aa
permissions mostly work. need more server-side checking.
casties
parents:
4
diff
changeset
|
167 return null; |
|
629e15b345aa
permissions mostly work. need more server-side checking.
casties
parents:
4
diff
changeset
|
168 } |
|
629e15b345aa
permissions mostly work. need more server-side checking.
casties
parents:
4
diff
changeset
|
169 |
| 3 | 170 Annotation annot = null; |
| 171 try { | |
| 172 JsonRepresentation jrep = new JsonRepresentation(entity); | |
| 173 JSONObject jo = jrep.getJsonObject(); | |
| 174 if (jo == null) { | |
| 175 setStatus(Status.SERVER_ERROR_INTERNAL); | |
| 176 return null; | |
| 177 } | |
| 178 // make sure id is not set for POST | |
| 179 jo.remove("id"); | |
| 88 | 180 // create Annotation object from posted JSON |
| 3 | 181 annot = createAnnotation(jo, entity); |
|
102
9140017e8962
fix bug with empty username. add logging for JSON exceptions.
casties
parents:
101
diff
changeset
|
182 } catch (IOException e) { |
|
9140017e8962
fix bug with empty username. add logging for JSON exceptions.
casties
parents:
101
diff
changeset
|
183 logger.warning(e.toString()); |
| 3 | 184 setStatus(Status.SERVER_ERROR_INTERNAL); |
| 185 return null; | |
| 186 } catch (JSONException e) { | |
|
102
9140017e8962
fix bug with empty username. add logging for JSON exceptions.
casties
parents:
101
diff
changeset
|
187 logger.warning(e.toString()); |
| 3 | 188 setStatus(Status.CLIENT_ERROR_BAD_REQUEST); |
| 189 return null; | |
| 190 } | |
| 4 | 191 if (annot == null) { |
| 3 | 192 setStatus(Status.CLIENT_ERROR_BAD_REQUEST); |
| 193 return null; | |
| 194 } | |
| 195 Annotation storedAnnot; | |
| 4 | 196 // store Annotation |
| 197 storedAnnot = getAnnotationStore().storeAnnotation(annot); | |
| 198 /* | |
| 199 * according to https://github.com/okfn/annotator/wiki/Storage we should | |
| 200 * return 303: see other. For now we return the annotation. | |
| 3 | 201 */ |
|
14
629e15b345aa
permissions mostly work. need more server-side checking.
casties
parents:
4
diff
changeset
|
202 JSONObject jo = createAnnotatorJson(storedAnnot, (authUser == null)); |
| 3 | 203 JsonRepresentation retRep = new JsonRepresentation(jo); |
| 204 return retRep; | |
| 205 } | |
| 206 | |
| 207 /** | |
|
20
715aa11d138b
fixes in permission handling: admin and delete default to creator.
casties
parents:
16
diff
changeset
|
208 * PUT with JSON content-type. Modifies an Annotation. |
| 3 | 209 * |
| 210 * @param entity | |
| 211 * @return | |
| 212 */ | |
| 213 @Put("json") | |
| 214 public Representation doPutJSON(Representation entity) { | |
| 75 | 215 logger.fine("AnnotatorAnnotations doPutJSON!"); |
| 3 | 216 // id from URI /annotations/{id} |
| 217 String jsonId = (String) getRequest().getAttributes().get("id"); | |
| 218 String id = decodeJsonId(jsonId); | |
| 75 | 219 logger.fine("annotation-id=" + id); |
| 3 | 220 |
|
14
629e15b345aa
permissions mostly work. need more server-side checking.
casties
parents:
4
diff
changeset
|
221 // do authentication |
| 88 | 222 Person authUser = getUserFromAuthToken(entity); |
| 75 | 223 logger.fine("request authenticated=" + authUser); |
| 3 | 224 |
| 225 Annotation annot = null; | |
| 4 | 226 AnnotationStore store = getAnnotationStore(); |
| 3 | 227 try { |
| 228 JsonRepresentation jrep = new JsonRepresentation(entity); | |
| 229 JSONObject jo = jrep.getJsonObject(); | |
| 230 if (jo == null) { | |
| 231 setStatus(Status.CLIENT_ERROR_BAD_REQUEST); | |
| 232 return null; | |
| 233 } | |
| 234 // get stored Annotation | |
| 4 | 235 Annotation storedAnnot = store.getAnnotationById(id); |
| 236 if (storedAnnot == null) { | |
| 3 | 237 setStatus(Status.CLIENT_ERROR_NOT_FOUND); |
| 238 return null; | |
| 239 } | |
| 61 | 240 if (!storedAnnot.isActionAllowed("update", authUser, store)) { |
|
14
629e15b345aa
permissions mostly work. need more server-side checking.
casties
parents:
4
diff
changeset
|
241 setStatus(Status.CLIENT_ERROR_FORBIDDEN); |
|
629e15b345aa
permissions mostly work. need more server-side checking.
casties
parents:
4
diff
changeset
|
242 return null; |
|
629e15b345aa
permissions mostly work. need more server-side checking.
casties
parents:
4
diff
changeset
|
243 } |
| 3 | 244 // update from posted JSON |
| 245 annot = updateAnnotation(storedAnnot, jo, entity); | |
| 246 // store Annotation | |
| 4 | 247 storedAnnot = store.storeAnnotation(annot); |
| 248 /* | |
| 249 * according to https://github.com/okfn/annotator/wiki/Storage we | |
| 250 * should return 303: see other. but the client doesn't like it | |
| 251 * setStatus(Status.REDIRECTION_SEE_OTHER); // go to same URL as | |
| 252 * this one Reference thisUrl = this.getReference(); | |
| 253 * this.getResponse().setLocationRef(thisUrl); | |
| 254 */ | |
| 3 | 255 // return new annotation |
|
14
629e15b345aa
permissions mostly work. need more server-side checking.
casties
parents:
4
diff
changeset
|
256 jo = createAnnotatorJson(storedAnnot, (authUser == null)); |
| 3 | 257 JsonRepresentation retRep = new JsonRepresentation(jo); |
| 258 return retRep; | |
| 259 } catch (JSONException e) { | |
| 75 | 260 logger.severe("Error in doPutJSON: "+e); |
| 3 | 261 setStatus(Status.CLIENT_ERROR_BAD_REQUEST); |
| 262 } catch (IOException e) { | |
| 75 | 263 logger.severe("Error in doPutJSON: "+e); |
| 3 | 264 setStatus(Status.SERVER_ERROR_INTERNAL, "Other Error"); |
| 265 } | |
| 266 return null; | |
| 267 } | |
| 268 | |
| 269 /** | |
|
20
715aa11d138b
fixes in permission handling: admin and delete default to creator.
casties
parents:
16
diff
changeset
|
270 * DELETE with JSON content-type. Deletes an Annotation. |
| 3 | 271 * |
| 272 * @param entity | |
| 273 * @return | |
| 274 */ | |
| 275 @Delete("json") | |
| 276 public Representation doDeleteJSON(Representation entity) { | |
| 75 | 277 logger.fine("AnnotatorAnnotations doDeleteJSON!"); |
| 3 | 278 // id from URI /annotations/{id} |
| 279 String jsonId = (String) getRequest().getAttributes().get("id"); | |
| 280 String id = decodeJsonId(jsonId); | |
| 75 | 281 logger.fine("annotation-id=" + id); |
| 3 | 282 |
|
14
629e15b345aa
permissions mostly work. need more server-side checking.
casties
parents:
4
diff
changeset
|
283 // do authentication |
| 88 | 284 Person authUser = getUserFromAuthToken(entity); |
| 75 | 285 logger.fine("request authenticated=" + authUser); |
| 16 | 286 AnnotationStore store = getAnnotationStore(); |
| 287 Annotation annot = store.getAnnotationById(id); | |
|
14
629e15b345aa
permissions mostly work. need more server-side checking.
casties
parents:
4
diff
changeset
|
288 if (annot != null) { |
| 61 | 289 if (!annot.isActionAllowed("delete", authUser, store)) { |
|
14
629e15b345aa
permissions mostly work. need more server-side checking.
casties
parents:
4
diff
changeset
|
290 setStatus(Status.CLIENT_ERROR_FORBIDDEN, "Not Authorized!"); |
|
629e15b345aa
permissions mostly work. need more server-side checking.
casties
parents:
4
diff
changeset
|
291 return null; |
|
629e15b345aa
permissions mostly work. need more server-side checking.
casties
parents:
4
diff
changeset
|
292 } |
| 3 | 293 } |
| 4 | 294 // delete annotation |
|
32
0731c4549065
UI for editing groups and persons works now. (still no authorisation!)
casties
parents:
22
diff
changeset
|
295 store.deleteAnnotationById(id); |
| 4 | 296 setStatus(Status.SUCCESS_NO_CONTENT); |
| 3 | 297 return null; |
| 298 } | |
| 299 | |
| 300 } |