Add code to detect a missing user id where it is required.

Author: pjewald

src/main/java/com/parallax/server/blocklyprop/db/dao/impl/ProjectDaoImpl.java

@@ -412,8 +412,10 @@ public List<ProjectRecord> getUserProjects(
      * @param order
      * @param limit
      * @param offset
-     * @param idUser
+
      * @return
+     * Returns a list of ProjectRecord objects corresponding to the projects
+     * matching the selection creiteria
      */
     @Override
     public List<ProjectRecord> getSharedProjects(
@@ -563,39 +565,61 @@ public boolean deleteProject(Long idProject) {
     }
 
     /**
-     * TODO: add details.
+     * Update the code block in the specified project
      *
      * @param idProject
      * @param code
+     *
      * @return
      */
     @Override
     public ProjectRecord updateProjectCode(Long idProject, String code) {
         LOG.info("Update code for project {}.", idProject);
+
+        // Retrieve the specified project
         ProjectRecord record = create.selectFrom(Tables.PROJECT)
                 .where(Tables.PROJECT.ID.equal(idProject))
                 .fetchOne();
 
+        // Get a timestamp used to update the modified field of the project record
         GregorianCalendar cal = new GregorianCalendar();
         cal.setTime(new java.util.Date());
 
         if (record != null) {
+            // Found the project. Verify that the current user owns it
             Long idUser = BlocklyPropSecurityUtils.getCurrentUserId();
+
+            // TODO: Detecting a zero user id
+            if (idUser == 0) {
+                LOG.error("Detected current user ID is zero for project {}", idProject);
+                return null;
+            }
+
+            if (record.getIdUser() == 0) {
+                LOG.error("Detected project user ID is zero for project {}", idProject);
+                return null;
+            }
+
+            // Update the project if the current user owns it
             if (record.getIdUser().equals(idUser)) {
                 record.setCode(code);
                 record.setModified(cal);
                 record.setCodeBlockVersion(BLOCKLY_LIBRARY_VERSION);
                 record.update();
                 return record;
             } else {
+                // If the project is a shared project, allow the current user
+                // to clone the project into their library
                 if (record.getShared()) {
                     ProjectRecord cloned = doProjectClone(record);
                     cloned.setCode(code);
                     cloned.setModified(cal);
                     cloned.setCodeBlockVersion(BLOCKLY_LIBRARY_VERSION);
+                    cloned.setIdUser(idUser);   // The logged in user owns this copy of the project
                     cloned.update();
                     return cloned;
                 }
+
                 LOG.error("User {} tried and failed to update project {}.", idUser, idProject);
                 throw new UnauthorizedException();
             }
@@ -605,6 +629,8 @@ public ProjectRecord updateProjectCode(Long idProject, String code) {
         }
     }
 
+
+
     /**
      * Save the current project as a new project
      *
@@ -700,7 +726,7 @@ private ProjectRecord doProjectClone(ProjectRecord original) {
                 original.getBoard(),
                 original.getPrivate(),
                 original.getShared(),
-                original.getId()
+                original.getId()        // set the parent project id
         );
 
 //        cloned.setBasedOn(original.getId());

src/main/java/com/parallax/server/blocklyprop/rest/RestProject.java

@@ -54,6 +54,7 @@ public class RestProject {
     // Connector to project converter object
     private ProjectConverter projectConverter;
 
+
     /**
      * Connect to the project service object
      * @param projectService 
@@ -63,6 +64,7 @@ public void setProjectService(ProjectService projectService) {
         this.projectService = projectService;
     }
 
+
     /**
      * Connect to the project converter object
      * @param projectConverter 
@@ -72,6 +74,7 @@ public void setProjectConverter(ProjectConverter projectConverter) {
         this.projectConverter = projectConverter;
     }
 
+
     /**
      * Return a list of projects owned by the currently authenticated user.
      * 
@@ -124,10 +127,13 @@ public Response get(
 
             JsonObject result = new JsonObject();
             JsonArray jsonProjects = new JsonArray();
+
+            // Loop through user projects and build a Json array
             for (ProjectRecord project : userProjects) {
                 jsonProjects.add(projectConverter.toListJson(project));
             }
 
+            // Add payload details
             result.add("rows", jsonProjects);
             result.addProperty("total", projectCount);
 
@@ -139,9 +145,15 @@ public Response get(
             LOG.warn("Error is {}", ex.getMessage());
             return Response.status(Response.Status.INTERNAL_SERVER_ERROR).build();
         }
-
     }
 
+
+    /**
+     * Retreive a project based on the supplied project ID
+     *
+     * @param idProject
+     * @return
+     */
     @GET
     @Path("/get/{id}")
     @Detail("Get project by id")
@@ -177,6 +189,7 @@ public Response get(@PathParam("id") @ParameterDetail("Project identifier") Long
         }
     }
 
+
     /**
      * Update the code in an existing project.
      * 
@@ -202,11 +215,13 @@ public Response saveProjectCode(
             LOG.debug("Code for project {} has been saved", idProject);
 
             JsonObject result = projectConverter.toJson(savedProject,false);
+
             LOG.debug("Returning JSON: {}", result);
 
             result.addProperty("success", true);
 
             return Response.ok(result.toString()).build();
+
         } catch (AuthorizationException ae) {
             LOG.warn("Project code not saved. Not Authorized");
             return Response.status(Response.Status.UNAUTHORIZED).build();
@@ -217,6 +232,15 @@ public Response saveProjectCode(
         }
     }
 
+
+    /**
+     *
+     * @param idProject
+     * @param code
+     * @param newName
+     * @param newBoard
+     * @return
+     */
     @POST
     @Path("/code-as")
     @Detail("Save project code")

src/main/java/com/parallax/server/blocklyprop/services/impl/ProjectServiceImpl.java

@@ -252,11 +252,28 @@ public boolean deleteProject(Long idProject) {
         return projectDao.deleteProject(idProject);
     }
 
+
+    /**
+     * Update the code block in the specified project
+     *
+     * @param idProject
+     * @param code
+     * @return
+     */
     @Override
     public ProjectRecord saveProjectCode(Long idProject, String code) {
         return projectDao.updateProjectCode(idProject, code);
     }
 
+
+    /**
+     *
+     * @param idProject
+     * @param code
+     * @param newName
+     * @param newBoard
+     * @return
+     */
     @Override
     public ProjectRecord saveProjectCodeAs(Long idProject, String code, String newName, String newBoard) {
         return projectDao.saveProjectCodeAs(idProject, code, newName, newBoard);