api/src/main/java/com/google/apphosting/utils/remoteapi/EE10RemoteApiServlet.java [87:496]: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - this.oauthService = oauthService; } /** Exception for unknown errors from a Python remote_api handler. */ public static class UnknownPythonServerException extends RuntimeException { public UnknownPythonServerException(String message) { super(message); } } /** * Checks if the inbound request is valid. * * @param req the {@link HttpServletRequest} * @param res the {@link HttpServletResponse} * @return true if the application is known. */ boolean checkIsValidRequest(HttpServletRequest req, HttpServletResponse res) throws IOException { if (!checkIsKnownInbound(req) && !checkIsAdmin(req, res)) { return false; } return checkIsValidHeader(req, res); } /** * Checks if the request is coming from a known application. * * @param req the {@link HttpServletRequest} * @return true if the application is known. */ private synchronized boolean checkIsKnownInbound(HttpServletRequest req) { if (allowedApps == null) { allowedApps = new HashSet(); String allowedAppsStr = System.getProperty(INBOUND_APP_SYSTEM_PROPERTY); if (allowedAppsStr != null) { String[] apps = allowedAppsStr.split(","); for (String app : apps) { allowedApps.add(app); } } } String inboundAppId = req.getHeader(INBOUND_APP_HEADER_NAME); return inboundAppId != null && allowedApps.contains(inboundAppId); } /** * Checks for the api-version header to prevent XSRF * * @param req the {@link HttpServletRequest} * @param res the {@link HttpServletResponse} * @return true if the header exists. */ private boolean checkIsValidHeader(HttpServletRequest req, HttpServletResponse res) throws IOException { if (req.getHeader("X-appcfg-api-version") == null) { res.setStatus(403); res.setContentType("text/plain"); res.getWriter().println("This request did not contain a necessary header"); return false; } return true; } /** * Check that the current user is signed is with admin access. * * @return true if the current user is logged in with admin access, false otherwise. */ private boolean checkIsAdmin(HttpServletRequest req, HttpServletResponse res) throws IOException { UserService userService = UserServiceFactory.getUserService(); // Check for regular (cookie-based) authentication. if (userService.getCurrentUser() != null) { if (userService.isUserAdmin()) { return true; } else { respondNotAdmin(res); return false; } } // Check for OAuth-based authentication. try { if (oauthService.isUserAdmin(OAUTH_SCOPES)) { return true; } else { respondNotAdmin(res); return false; } } catch (OAuthRequestException e) { // Invalid OAuth request; fall through to sending redirect. } res.sendRedirect(userService.createLoginURL(req.getRequestURI())); return false; } private void respondNotAdmin(HttpServletResponse res) throws IOException { res.setStatus(401); res.setContentType("text/plain"); res.getWriter().println( "You must be logged in as an administrator, or access from an approved application."); } /** Serve GET requests with a YAML encoding of the app-id and a validation token. */ @Override public void doGet(HttpServletRequest req, HttpServletResponse res) throws IOException { if (!checkIsValidRequest(req, res)) { return; } res.setContentType("text/plain"); String appId = ApiProxy.getCurrentEnvironment().getAppId(); StringBuilder outYaml = new StringBuilder().append("{rtok: ").append(req.getParameter("rtok")).append(", app_id: ") .append(appId).append("}"); res.getWriter().println(outYaml); } /** Serve POST requests by forwarding calls to ApiProxy. */ @Override public void doPost(HttpServletRequest req, HttpServletResponse res) throws IOException { if (!checkIsValidRequest(req, res)) { return; } res.setContentType("application/octet-stream"); Response.Builder response = Response.newBuilder(); try { byte[] responseData = executeRequest(req); response.setResponse(ByteString.copyFrom(responseData)); res.setStatus(200); } catch (Exception e) { log.warning("Caught exception while executing remote_api command:\n" + e); res.setStatus(200); ByteArrayOutputStream byteStream = new ByteArrayOutputStream(); ObjectOutput out = new ObjectOutputStream(byteStream); out.writeObject(e); out.close(); byte[] serializedException = byteStream.toByteArray(); response.setJavaException(ByteString.copyFrom(serializedException)); if (e instanceof ApiProxy.ApplicationException) { ApiProxy.ApplicationException ae = (ApiProxy.ApplicationException) e; response .getApplicationErrorBuilder() .setCode(ae.getApplicationError()) .setDetail(ae.getErrorDetail()); } } response.build().writeTo(res.getOutputStream()); } private byte[] executeRunQuery(Request.Builder request) { Query.Builder queryRequest = Query.newBuilder(); parseFromBytes(queryRequest, request.getRequestIdBytes().toByteArray()); int batchSize = Math.max(1000, queryRequest.getLimit()); queryRequest.setCount(batchSize); QueryResult.Builder runQueryResponse = QueryResult.newBuilder(); byte[] res = ApiProxy.makeSyncCall("datastore_v3", "RunQuery", request.getRequest().toByteArray()); parseFromBytes(runQueryResponse, res); if (queryRequest.hasLimit()) { // Try to pull all results while (runQueryResponse.getMoreResults()) { NextRequest.Builder nextRequest = NextRequest.newBuilder(); nextRequest.getCursorBuilder().mergeFrom(runQueryResponse.getCursor()); nextRequest.setCount(batchSize); byte[] nextRes = ApiProxy.makeSyncCall("datastore_v3", "Next", nextRequest.build().toByteArray()); parseFromBytes(runQueryResponse, nextRes); } } return runQueryResponse.build().toByteArray(); } private byte[] executeTxQuery(Request.Builder request) { TransactionQueryResult.Builder result = TransactionQueryResult.newBuilder(); Query.Builder query = Query.newBuilder(); parseFromBytes(query, request.getRequest().toByteArray()); if (!query.hasAncestor()) { throw new ApiProxy.ApplicationException( BAD_REQUEST.getNumber(), "No ancestor in transactional query."); } // Make __entity_group__ key OnestoreEntity.Reference.Builder egKey = result.getEntityGroupKeyBuilder().mergeFrom(query.getAncestor()); OnestoreEntity.Path.Element root = egKey.getPath().getElement(0); egKey.getPathBuilder().clearElement().addElement(root); Element egElement = OnestoreEntity.Path.Element.newBuilder().setType("__entity_group__").setId(1).build(); egKey.getPathBuilder().addElement(egElement); // And then perform the transaction with the ancestor query and __entity_group__ fetch. byte[] tx = beginTransaction(false); parseFromBytes(query.getTransactionBuilder(), tx); byte[] queryBytes = ApiProxy.makeSyncCall("datastore_v3", "RunQuery", query.build().toByteArray()); parseFromBytes(result.getResultBuilder(), queryBytes); GetRequest.Builder egRequest = GetRequest.newBuilder(); egRequest.addKey(egKey); GetResponse.Builder egResponse = txGet(tx, egRequest); if (egResponse.getEntity(0).hasEntity()) { result.setEntityGroup(egResponse.getEntity(0).getEntity()); } rollback(tx); return result.build().toByteArray(); } /** * Throws a CONCURRENT_TRANSACTION exception if the entity does not match the precondition. */ private void assertEntityResultMatchesPrecondition( GetResponse.Entity entityResult, Precondition precondition) { // This handles the case where the Entity was missing in one of the two params. if (precondition.hasHash() != entityResult.hasEntity()) { throw new ApiProxy.ApplicationException( CONCURRENT_TRANSACTION.getNumber(), "Transaction precondition failed"); } if (entityResult.hasEntity()) { // Both params have an Entity. Make sure the Entities match using a SHA-1 hash. EntityProto entity = entityResult.getEntity(); if (Arrays.equals(precondition.getHashBytes().toByteArray(), computeSha1(entity))) { // They match. We're done. return; } // See javadoc of computeSha1OmittingLastByteForBackwardsCompatibility for explanation. byte[] backwardsCompatibleHash = computeSha1OmittingLastByteForBackwardsCompatibility(entity); if (!Arrays.equals(precondition.getHashBytes().toByteArray(), backwardsCompatibleHash)) { throw new ApiProxy.ApplicationException( CONCURRENT_TRANSACTION.getNumber(), "Transaction precondition failed"); } } // Else, the Entity was missing from both. } private byte[] executeTx(Request.Builder request) { TransactionRequest.Builder txRequest = TransactionRequest.newBuilder(); parseFromBytes(txRequest, request.getRequest().toByteArray()); byte[] tx = beginTransaction(txRequest.getAllowMultipleEg()); List preconditions = txRequest.getPreconditionList(); // Check transaction preconditions if (!preconditions.isEmpty()) { GetRequest.Builder getRequest = GetRequest.newBuilder(); for (Precondition precondition : preconditions) { OnestoreEntity.Reference key = precondition.getKey(); getRequest.addKeyBuilder().mergeFrom(key); } GetResponse.Builder getResponse = txGet(tx, getRequest); List entities = getResponse.getEntityList(); // Note that this is guaranteed because we don't specify allow_deferred on the GetRequest. // TODO: Consider supporting deferred gets here. assert (entities.size() == preconditions.size()); for (int i = 0; i < entities.size(); i++) { // Throw an exception if any of the Entities don't match the Precondition specification. assertEntityResultMatchesPrecondition(entities.get(i), preconditions.get(i)); } } // Preconditions OK. // Perform puts. byte[] res = new byte[0]; // a serialized VoidProto if (txRequest.hasPuts()) { PutRequest.Builder putRequest = txRequest.getPutsBuilder(); parseFromBytes(putRequest.getTransactionBuilder(), tx); res = ApiProxy.makeSyncCall("datastore_v3", "Put", putRequest.build().toByteArray()); } // Perform deletes. if (txRequest.hasDeletes()) { DeleteRequest.Builder deleteRequest = txRequest.getDeletesBuilder(); parseFromBytes(deleteRequest.getTransactionBuilder(), tx); ApiProxy.makeSyncCall("datastore_v3", "Delete", deleteRequest.build().toByteArray()); } // Commit transaction. ApiProxy.makeSyncCall("datastore_v3", "Commit", tx); return res; } private byte[] executeGetIDs(Request.Builder request, boolean isXg) { PutRequest.Builder putRequest = PutRequest.newBuilder(); parseFromBytes(putRequest, request.getRequest().toByteArray()); for (EntityProto entity : putRequest.getEntityList()) { verify(entity.getPropertyCount() == 0); verify(entity.getRawPropertyCount() == 0); verify(entity.getEntityGroup().getElementCount() == 0); List elementList = entity.getKey().getPath().getElementList(); Element lastPart = elementList.get(elementList.size() - 1); verify(lastPart.getId() == 0); verify(!lastPart.hasName()); } // Start a Transaction. // TODO: Shouldn't this use allocateIds instead? byte[] tx = beginTransaction(isXg); parseFromBytes(putRequest.getTransactionBuilder(), tx); // Make a put request for a bunch of empty entities with the requisite // paths. byte[] res = ApiProxy.makeSyncCall("datastore_v3", "Put", putRequest.build().toByteArray()); // Roll back the transaction so we don't actually insert anything. rollback(tx); return res; } private byte[] executeRequest(HttpServletRequest req) throws IOException { Request.Builder request = Request.newBuilder(); parseFromInputStream(request, req.getInputStream()); String service = request.getServiceName(); String method = request.getMethod(); log.fine("remote API call: " + service + ", " + method); if (service.equals("remote_datastore")) { if (method.equals("RunQuery")) { return executeRunQuery(request); } else if (method.equals("Transaction")) { return executeTx(request); } else if (method.equals("TransactionQuery")) { return executeTxQuery(request); } else if (method.equals("GetIDs")) { return executeGetIDs(request, false); } else if (method.equals("GetIDsXG")) { return executeGetIDs(request, true); } else { throw new ApiProxy.CallNotFoundException(service, method); } } else { return ApiProxy.makeSyncCall(service, method, request.getRequest().toByteArray()); } } // Datastore utility functions. private static byte[] beginTransaction(boolean allowMultipleEg) { String appId = ApiProxy.getCurrentEnvironment().getAppId(); byte[] req = BeginTransactionRequest.newBuilder() .setApp(appId) .setAllowMultipleEg(allowMultipleEg) .build() .toByteArray(); return ApiProxy.makeSyncCall("datastore_v3", "BeginTransaction", req); } private static void rollback(byte[] tx) { ApiProxy.makeSyncCall("datastore_v3", "Rollback", tx); } private static GetResponse.Builder txGet(byte[] tx, GetRequest.Builder request) { parseFromBytes(request.getTransactionBuilder(), tx); GetResponse.Builder response = GetResponse.newBuilder(); byte[] resultBytes = ApiProxy.makeSyncCall("datastore_v3", "Get", request.build().toByteArray()); parseFromBytes(response, resultBytes); return response; } // @VisibleForTesting static byte[] computeSha1(EntityProto entity) { byte[] entityBytes = entity.toByteArray(); return computeSha1(entityBytes, entityBytes.length); } /** * This is a HACK. There used to be a bug in RemoteDatastore.java in that it would omit the last * byte of the Entity when calculating the hash for the Precondition. If an app has not updated * that library, we may still receive hashes like this. For backwards compatibility, we'll * consider the transaction valid if omitting the last byte of the Entity matches the * Precondition. */ // @VisibleForTesting static byte[] computeSha1OmittingLastByteForBackwardsCompatibility(EntityProto entity) { byte[] entityBytes = entity.toByteArray(); return computeSha1(entityBytes, entityBytes.length - 1); } // private static byte[] computeSha1(byte[] bytes, int length) { MessageDigest md; try { md = MessageDigest.getInstance("SHA-1"); } catch (NoSuchAlgorithmException e) { throw new ApiProxy.ApplicationException( CONCURRENT_TRANSACTION.getNumber(), "Transaction precondition could not be computed"); } md.update(bytes, 0, length); return md.digest(); } private static void parseFromBytes(Message.Builder message, byte[] bytes) { boolean parsed = true; try { message.mergeFrom(bytes, ExtensionRegistry.getEmptyRegistry()); } catch (IOException e) { parsed = false; } checkParse(message.build(), parsed); } private static void parseFromInputStream(Message.Builder message, InputStream inputStream) { boolean parsed = true; try { message.mergeFrom(inputStream, ExtensionRegistry.getEmptyRegistry()); } catch (IOException e) { parsed = false; } checkParse(message.build(), parsed); } private static void checkParse(Message message, boolean parsed) { if (!parsed) { throw new ApiProxy.ApiProxyException("Could not parse protobuf"); } List errors = message.findInitializationErrors(); if (errors != null && !errors.isEmpty()) { throw new ApiProxy.ApiProxyException("Could not parse protobuf: " + errors); - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - api/src/main/java/com/google/apphosting/utils/remoteapi/RemoteApiServlet.java [87:496]: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - this.oauthService = oauthService; } /** Exception for unknown errors from a Python remote_api handler. */ public static class UnknownPythonServerException extends RuntimeException { public UnknownPythonServerException(String message) { super(message); } } /** * Checks if the inbound request is valid. * * @param req the {@link HttpServletRequest} * @param res the {@link HttpServletResponse} * @return true if the application is known. */ boolean checkIsValidRequest(HttpServletRequest req, HttpServletResponse res) throws IOException { if (!checkIsKnownInbound(req) && !checkIsAdmin(req, res)) { return false; } return checkIsValidHeader(req, res); } /** * Checks if the request is coming from a known application. * * @param req the {@link HttpServletRequest} * @return true if the application is known. */ private synchronized boolean checkIsKnownInbound(HttpServletRequest req) { if (allowedApps == null) { allowedApps = new HashSet(); String allowedAppsStr = System.getProperty(INBOUND_APP_SYSTEM_PROPERTY); if (allowedAppsStr != null) { String[] apps = allowedAppsStr.split(","); for (String app : apps) { allowedApps.add(app); } } } String inboundAppId = req.getHeader(INBOUND_APP_HEADER_NAME); return inboundAppId != null && allowedApps.contains(inboundAppId); } /** * Checks for the api-version header to prevent XSRF * * @param req the {@link HttpServletRequest} * @param res the {@link HttpServletResponse} * @return true if the header exists. */ private boolean checkIsValidHeader(HttpServletRequest req, HttpServletResponse res) throws IOException { if (req.getHeader("X-appcfg-api-version") == null) { res.setStatus(403); res.setContentType("text/plain"); res.getWriter().println("This request did not contain a necessary header"); return false; } return true; } /** * Check that the current user is signed is with admin access. * * @return true if the current user is logged in with admin access, false otherwise. */ private boolean checkIsAdmin(HttpServletRequest req, HttpServletResponse res) throws IOException { UserService userService = UserServiceFactory.getUserService(); // Check for regular (cookie-based) authentication. if (userService.getCurrentUser() != null) { if (userService.isUserAdmin()) { return true; } else { respondNotAdmin(res); return false; } } // Check for OAuth-based authentication. try { if (oauthService.isUserAdmin(OAUTH_SCOPES)) { return true; } else { respondNotAdmin(res); return false; } } catch (OAuthRequestException e) { // Invalid OAuth request; fall through to sending redirect. } res.sendRedirect(userService.createLoginURL(req.getRequestURI())); return false; } private void respondNotAdmin(HttpServletResponse res) throws IOException { res.setStatus(401); res.setContentType("text/plain"); res.getWriter().println( "You must be logged in as an administrator, or access from an approved application."); } /** Serve GET requests with a YAML encoding of the app-id and a validation token. */ @Override public void doGet(HttpServletRequest req, HttpServletResponse res) throws IOException { if (!checkIsValidRequest(req, res)) { return; } res.setContentType("text/plain"); String appId = ApiProxy.getCurrentEnvironment().getAppId(); StringBuilder outYaml = new StringBuilder().append("{rtok: ").append(req.getParameter("rtok")).append(", app_id: ") .append(appId).append("}"); res.getWriter().println(outYaml); } /** Serve POST requests by forwarding calls to ApiProxy. */ @Override public void doPost(HttpServletRequest req, HttpServletResponse res) throws IOException { if (!checkIsValidRequest(req, res)) { return; } res.setContentType("application/octet-stream"); Response.Builder response = Response.newBuilder(); try { byte[] responseData = executeRequest(req); response.setResponse(ByteString.copyFrom(responseData)); res.setStatus(200); } catch (Exception e) { log.warning("Caught exception while executing remote_api command:\n" + e); res.setStatus(200); ByteArrayOutputStream byteStream = new ByteArrayOutputStream(); ObjectOutput out = new ObjectOutputStream(byteStream); out.writeObject(e); out.close(); byte[] serializedException = byteStream.toByteArray(); response.setJavaException(ByteString.copyFrom(serializedException)); if (e instanceof ApiProxy.ApplicationException) { ApiProxy.ApplicationException ae = (ApiProxy.ApplicationException) e; response .getApplicationErrorBuilder() .setCode(ae.getApplicationError()) .setDetail(ae.getErrorDetail()); } } response.build().writeTo(res.getOutputStream()); } private byte[] executeRunQuery(Request.Builder request) { Query.Builder queryRequest = Query.newBuilder(); parseFromBytes(queryRequest, request.getRequestIdBytes().toByteArray()); int batchSize = Math.max(1000, queryRequest.getLimit()); queryRequest.setCount(batchSize); QueryResult.Builder runQueryResponse = QueryResult.newBuilder(); byte[] res = ApiProxy.makeSyncCall("datastore_v3", "RunQuery", request.getRequest().toByteArray()); parseFromBytes(runQueryResponse, res); if (queryRequest.hasLimit()) { // Try to pull all results while (runQueryResponse.getMoreResults()) { NextRequest.Builder nextRequest = NextRequest.newBuilder(); nextRequest.getCursorBuilder().mergeFrom(runQueryResponse.getCursor()); nextRequest.setCount(batchSize); byte[] nextRes = ApiProxy.makeSyncCall("datastore_v3", "Next", nextRequest.build().toByteArray()); parseFromBytes(runQueryResponse, nextRes); } } return runQueryResponse.build().toByteArray(); } private byte[] executeTxQuery(Request.Builder request) { TransactionQueryResult.Builder result = TransactionQueryResult.newBuilder(); Query.Builder query = Query.newBuilder(); parseFromBytes(query, request.getRequest().toByteArray()); if (!query.hasAncestor()) { throw new ApiProxy.ApplicationException( BAD_REQUEST.getNumber(), "No ancestor in transactional query."); } // Make __entity_group__ key OnestoreEntity.Reference.Builder egKey = result.getEntityGroupKeyBuilder().mergeFrom(query.getAncestor()); OnestoreEntity.Path.Element root = egKey.getPath().getElement(0); egKey.getPathBuilder().clearElement().addElement(root); Element egElement = OnestoreEntity.Path.Element.newBuilder().setType("__entity_group__").setId(1).build(); egKey.getPathBuilder().addElement(egElement); // And then perform the transaction with the ancestor query and __entity_group__ fetch. byte[] tx = beginTransaction(false); parseFromBytes(query.getTransactionBuilder(), tx); byte[] queryBytes = ApiProxy.makeSyncCall("datastore_v3", "RunQuery", query.build().toByteArray()); parseFromBytes(result.getResultBuilder(), queryBytes); GetRequest.Builder egRequest = GetRequest.newBuilder(); egRequest.addKey(egKey); GetResponse.Builder egResponse = txGet(tx, egRequest); if (egResponse.getEntity(0).hasEntity()) { result.setEntityGroup(egResponse.getEntity(0).getEntity()); } rollback(tx); return result.build().toByteArray(); } /** * Throws a CONCURRENT_TRANSACTION exception if the entity does not match the precondition. */ private void assertEntityResultMatchesPrecondition( GetResponse.Entity entityResult, Precondition precondition) { // This handles the case where the Entity was missing in one of the two params. if (precondition.hasHash() != entityResult.hasEntity()) { throw new ApiProxy.ApplicationException( CONCURRENT_TRANSACTION.getNumber(), "Transaction precondition failed"); } if (entityResult.hasEntity()) { // Both params have an Entity. Make sure the Entities match using a SHA-1 hash. EntityProto entity = entityResult.getEntity(); if (Arrays.equals(precondition.getHashBytes().toByteArray(), computeSha1(entity))) { // They match. We're done. return; } // See javadoc of computeSha1OmittingLastByteForBackwardsCompatibility for explanation. byte[] backwardsCompatibleHash = computeSha1OmittingLastByteForBackwardsCompatibility(entity); if (!Arrays.equals(precondition.getHashBytes().toByteArray(), backwardsCompatibleHash)) { throw new ApiProxy.ApplicationException( CONCURRENT_TRANSACTION.getNumber(), "Transaction precondition failed"); } } // Else, the Entity was missing from both. } private byte[] executeTx(Request.Builder request) { TransactionRequest.Builder txRequest = TransactionRequest.newBuilder(); parseFromBytes(txRequest, request.getRequest().toByteArray()); byte[] tx = beginTransaction(txRequest.getAllowMultipleEg()); List preconditions = txRequest.getPreconditionList(); // Check transaction preconditions if (!preconditions.isEmpty()) { GetRequest.Builder getRequest = GetRequest.newBuilder(); for (Precondition precondition : preconditions) { OnestoreEntity.Reference key = precondition.getKey(); getRequest.addKeyBuilder().mergeFrom(key); } GetResponse.Builder getResponse = txGet(tx, getRequest); List entities = getResponse.getEntityList(); // Note that this is guaranteed because we don't specify allow_deferred on the GetRequest. // TODO: Consider supporting deferred gets here. assert (entities.size() == preconditions.size()); for (int i = 0; i < entities.size(); i++) { // Throw an exception if any of the Entities don't match the Precondition specification. assertEntityResultMatchesPrecondition(entities.get(i), preconditions.get(i)); } } // Preconditions OK. // Perform puts. byte[] res = new byte[0]; // a serialized VoidProto if (txRequest.hasPuts()) { PutRequest.Builder putRequest = txRequest.getPutsBuilder(); parseFromBytes(putRequest.getTransactionBuilder(), tx); res = ApiProxy.makeSyncCall("datastore_v3", "Put", putRequest.build().toByteArray()); } // Perform deletes. if (txRequest.hasDeletes()) { DeleteRequest.Builder deleteRequest = txRequest.getDeletesBuilder(); parseFromBytes(deleteRequest.getTransactionBuilder(), tx); ApiProxy.makeSyncCall("datastore_v3", "Delete", deleteRequest.build().toByteArray()); } // Commit transaction. ApiProxy.makeSyncCall("datastore_v3", "Commit", tx); return res; } private byte[] executeGetIDs(Request.Builder request, boolean isXg) { PutRequest.Builder putRequest = PutRequest.newBuilder(); parseFromBytes(putRequest, request.getRequest().toByteArray()); for (EntityProto entity : putRequest.getEntityList()) { verify(entity.getPropertyCount() == 0); verify(entity.getRawPropertyCount() == 0); verify(entity.getEntityGroup().getElementCount() == 0); List elementList = entity.getKey().getPath().getElementList(); Element lastPart = elementList.get(elementList.size() - 1); verify(lastPart.getId() == 0); verify(!lastPart.hasName()); } // Start a Transaction. // TODO: Shouldn't this use allocateIds instead? byte[] tx = beginTransaction(isXg); parseFromBytes(putRequest.getTransactionBuilder(), tx); // Make a put request for a bunch of empty entities with the requisite // paths. byte[] res = ApiProxy.makeSyncCall("datastore_v3", "Put", putRequest.build().toByteArray()); // Roll back the transaction so we don't actually insert anything. rollback(tx); return res; } private byte[] executeRequest(HttpServletRequest req) throws IOException { Request.Builder request = Request.newBuilder(); parseFromInputStream(request, req.getInputStream()); String service = request.getServiceName(); String method = request.getMethod(); log.fine("remote API call: " + service + ", " + method); if (service.equals("remote_datastore")) { if (method.equals("RunQuery")) { return executeRunQuery(request); } else if (method.equals("Transaction")) { return executeTx(request); } else if (method.equals("TransactionQuery")) { return executeTxQuery(request); } else if (method.equals("GetIDs")) { return executeGetIDs(request, false); } else if (method.equals("GetIDsXG")) { return executeGetIDs(request, true); } else { throw new ApiProxy.CallNotFoundException(service, method); } } else { return ApiProxy.makeSyncCall(service, method, request.getRequest().toByteArray()); } } // Datastore utility functions. private static byte[] beginTransaction(boolean allowMultipleEg) { String appId = ApiProxy.getCurrentEnvironment().getAppId(); byte[] req = BeginTransactionRequest.newBuilder() .setApp(appId) .setAllowMultipleEg(allowMultipleEg) .build() .toByteArray(); return ApiProxy.makeSyncCall("datastore_v3", "BeginTransaction", req); } private static void rollback(byte[] tx) { ApiProxy.makeSyncCall("datastore_v3", "Rollback", tx); } private static GetResponse.Builder txGet(byte[] tx, GetRequest.Builder request) { parseFromBytes(request.getTransactionBuilder(), tx); GetResponse.Builder response = GetResponse.newBuilder(); byte[] resultBytes = ApiProxy.makeSyncCall("datastore_v3", "Get", request.build().toByteArray()); parseFromBytes(response, resultBytes); return response; } // @VisibleForTesting static byte[] computeSha1(EntityProto entity) { byte[] entityBytes = entity.toByteArray(); return computeSha1(entityBytes, entityBytes.length); } /** * This is a HACK. There used to be a bug in RemoteDatastore.java in that it would omit the last * byte of the Entity when calculating the hash for the Precondition. If an app has not updated * that library, we may still receive hashes like this. For backwards compatibility, we'll * consider the transaction valid if omitting the last byte of the Entity matches the * Precondition. */ // @VisibleForTesting static byte[] computeSha1OmittingLastByteForBackwardsCompatibility(EntityProto entity) { byte[] entityBytes = entity.toByteArray(); return computeSha1(entityBytes, entityBytes.length - 1); } // private static byte[] computeSha1(byte[] bytes, int length) { MessageDigest md; try { md = MessageDigest.getInstance("SHA-1"); } catch (NoSuchAlgorithmException e) { throw new ApiProxy.ApplicationException( CONCURRENT_TRANSACTION.getNumber(), "Transaction precondition could not be computed"); } md.update(bytes, 0, length); return md.digest(); } private static void parseFromBytes(Message.Builder message, byte[] bytes) { boolean parsed = true; try { message.mergeFrom(bytes, ExtensionRegistry.getEmptyRegistry()); } catch (IOException e) { parsed = false; } checkParse(message.build(), parsed); } private static void parseFromInputStream(Message.Builder message, InputStream inputStream) { boolean parsed = true; try { message.mergeFrom(inputStream, ExtensionRegistry.getEmptyRegistry()); } catch (IOException e) { parsed = false; } checkParse(message.build(), parsed); } private static void checkParse(Message message, boolean parsed) { if (!parsed) { throw new ApiProxy.ApiProxyException("Could not parse protobuf"); } List errors = message.findInitializationErrors(); if (errors != null && !errors.isEmpty()) { throw new ApiProxy.ApiProxyException("Could not parse protobuf: " + errors); - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -