Merge pull request #1646 from zfi/1.1.453

Update 1.1.453

Author: zfi

.gitignore

@@ -12,6 +12,9 @@ nb*
 # /src/main/java/com/parallax/server/blocklyprop/db/generated/*
 #
 
+*.sh
+
+
 #################
 ## NetBeans
 #################

pom.xml

@@ -549,5 +549,12 @@
             <version>4.12</version>
             <scope>test</scope>
         </dependency>
-        </dependencies>
+
+        <!-- https://mvnrepository.com/artifact/org.jetbrains/annotations -->
+        <dependency>
+            <groupId>org.jetbrains</groupId>
+            <artifactId>annotations</artifactId>
+            <version>17.0.0</version>
+        </dependency>
+    </dependencies>
 </project>

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,68 @@ public boolean deleteProject(Long idProject) {
     }
 
     /**
-     * TODO: add details.
+     * Update the code block in the specified project
      *
      * @param idProject
      * @param code
+     *
      * @return
+     * Returns the specified project record, otherwise it returns a null if
+     * the current user does not own the project and the project is not shared
+     * or public, or the requested project record was not found.
+     *
+     * @implNote This method will actually create a new project record based on the
+     * existing project under specific conditions. Since this is an update record method,
+     * the creation of a new project my be unexpected at higher layers of the application.
      */
     @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 +636,8 @@ public ProjectRecord updateProjectCode(Long idProject, String code) {
         }
     }
 
+
+
     /**
      * Save the current project as a new project
      *
@@ -617,16 +650,21 @@ public ProjectRecord updateProjectCode(Long idProject, String code) {
     @Override
     public ProjectRecord saveProjectCodeAs(Long idProject, String code, String newName, String newBoard) {
 
-        LOG.info("Saving project code as '{}'", newName);
+        LOG.info("Saving project code from project {} as '{}'", idProject,  newName);
 
         // Retreive the source project
         ProjectRecord original = getProject(idProject);
+
         if (original == null) {
             LOG.error("Original project {} is missing. Unable to save code as...", idProject);
             throw new NullPointerException("Project doesn't exist");
-        } else if (newBoard == null) {
+        }
+
+        // Use the board type from the parent project if it was not provided
+        if (newBoard == null) {
             newBoard = original.getBoard();
         }
+
 
         // Obtain the current bp user record. 
         Long idUser = BlocklyPropSecurityUtils.getCurrentUserId();
@@ -637,6 +675,7 @@ public ProjectRecord saveProjectCodeAs(Long idProject, String code, String newNa
             // shared or community project
             // --------------------------------------------------------------------
             if (original.getIdUser().equals(idUser) || original.getShared()) {
+
                 ProjectRecord cloned = createProject(
                         newName, 
                         original.getDescription(),
@@ -648,7 +687,13 @@ public ProjectRecord saveProjectCodeAs(Long idProject, String code, String newNa
                         false,                  // Set project unshared
                         original.getId());
 
+                if (cloned == null) {
+                    LOG.warn("Unable to create a copy og the project.");
+                }
                 return cloned;
+            } else {
+                LOG.warn("Unable to copy the project. UID: {}, PUID: {}, Shared: {}",
+                        idUser, original.getIdUser(), original.getShared());
             }
         } else {
             LOG.info("Unable to retreive BP user id");
@@ -700,7 +745,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());