Merge pull request #1685 from parallaxinc/1.2

Release 1.2 v1.2.458

Author: zfi

.gitignore

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

db-updates/0014-add-project-settings.sql

@@ -1,15 +1,15 @@
-/* 
- * To change this license header, choose License Headers in Project Properties.
- * To change this template file, choose Tools | Templates
- * and open the template in the editor.
- */
 /**
  * Author:  Jim Ewald
  * Created: Aug 27, 2018
  * 
  * Add a field to the project table to store a JSON encoded group of project
  * settings.
+ *
+ * Add a field to the user profile to store JSON encoded settings related to
+ * specific user.
  */
 
 ALTER TABLE blocklyprop.project ADD settings TEXT NULL;
+ALTER TABLE cloudsession.user ADD settings TEXT NULL;
+
 

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/SessionData.java

@@ -1,8 +1,24 @@
 /*
- * To change this license header, choose License Headers in Project Properties.
- * To change this template file, choose Tools | Templates
- * and open the template in the editor.
+ * Copyright (c) 2019 Parallax Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
+ * and associated documentation files (the “Software”), to deal in the Software without
+ * restriction, including without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or
+ * substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
  */
+
 package com.parallax.server.blocklyprop;
 
 import com.google.inject.servlet.SessionScoped;
@@ -13,15 +29,21 @@
  * User session details.
  * 
  * This class contains the fields used to manage the client's session with
- * the application.
+ * the application. The @SessionScoped decorator will enforce a single
+ * instance per session.
  * 
  * @author Michel
  */
 @SessionScoped
 public class SessionData implements Serializable {
 
+    // A cloud session user profile object
     private User user;
+
+    // A cloud session user profile primary key ID
     private Long idUser;
+
+    // A locale string for this user
     private String locale;
 
     /**
@@ -54,6 +76,11 @@ public void setLocale(String locale) {
         this.locale = locale;
     }
 
+    /**
+     *  Override the default toString method to enumerate all fields
+     *
+     * @return string representation of SessionData fields
+     */
     @Override
     public String toString() {
         return "SessionData{" + "user=" + user + ", idUser=" + idUser + ", locale=" + locale + '}';

src/main/java/com/parallax/server/blocklyprop/TableOrder.java

@@ -1,17 +1,32 @@
 /*
- * To change this license header, choose License Headers in Project Properties.
- * To change this template file, choose Tools | Templates
- * and open the template in the editor.
+ * Copyright (c) 2019 Parallax Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
+ * and associated documentation files (the “Software”), to deal in the Software without
+ * restriction, including without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or
+ * substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
  */
+
 package com.parallax.server.blocklyprop;
 
 /**
+ * Enumberate possible sort orders for project listings
  *
  * @author Michel
  */
 public enum TableOrder {
-
     asc,
     desc
-
 }

src/main/java/com/parallax/server/blocklyprop/TableSort.java

@@ -1,15 +1,32 @@
 /*
- * To change this license header, choose License Headers in Project Properties.
- * To change this template file, choose Tools | Templates
- * and open the template in the editor.
+ * Copyright (c) 2019 Parallax Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
+ * and associated documentation files (the “Software”), to deal in the Software without
+ * restriction, including without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or
+ * substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
  */
+
 package com.parallax.server.blocklyprop;
 
 import com.parallax.server.blocklyprop.db.generated.Tables;
 import com.parallax.server.blocklyprop.db.generated.tables.records.ProjectRecord;
 import org.jooq.TableField;
 
 /**
+ * A list of the possible fields on which to sort project data
  *
  * @author Michel
  */
@@ -21,14 +38,14 @@ public enum TableSort {
     user(Tables.PROJECT.ID_USER),
     modified(Tables.PROJECT.MODIFIED);
 
+    // Map this enum to a Field in the JooQ ProjectRecord class
     private final TableField<ProjectRecord, ?> field;
 
-    private TableSort(TableField<ProjectRecord, ?> field) {
+    TableSort(TableField<ProjectRecord, ?> field) {
         this.field = field;
     }
 
     public TableField<ProjectRecord, ?> getField() {
         return field;
     }
-
 }

src/main/java/com/parallax/server/blocklyprop/config/RestModule.java

@@ -25,10 +25,13 @@
 import com.parallax.server.blocklyprop.rest.RestMotd;
 import com.parallax.server.blocklyprop.rest.RestProfile;
 import com.parallax.server.blocklyprop.rest.RestProject;
+import com.parallax.server.blocklyprop.rest.RestV2Project;
 import com.parallax.server.blocklyprop.rest.RestSharedProject;
 import com.parallax.server.blocklyprop.rest.RestUser;
+
 import com.sun.jersey.guice.JerseyServletModule;
 import com.sun.jersey.guice.spi.container.servlet.GuiceContainer;
+
 import javax.ws.rs.ext.MessageBodyReader;
 import javax.ws.rs.ext.MessageBodyWriter;
 import org.codehaus.jackson.jaxrs.JacksonJsonProvider;
@@ -45,6 +48,8 @@ protected void configureServlets() {
         bind(RestCompile.class);
         bind(RestUser.class);
         bind(RestProject.class);
+        bind(RestV2Project.class);
+
         bind(RestSharedProject.class);
         bind(RestProfile.class);
         bind(RestMotd.class);

src/main/java/com/parallax/server/blocklyprop/config/ServletsModule.java

@@ -27,8 +27,6 @@
 import com.parallax.server.blocklyprop.servlets.PrivacyPolicyServlet;
 import com.parallax.server.blocklyprop.servlets.ConfirmRequestServlet;
 import com.parallax.server.blocklyprop.servlets.ConfirmServlet;
-import com.parallax.server.blocklyprop.servlets.HelpSearchServlet;
-import com.parallax.server.blocklyprop.servlets.HelpServlet;
 import com.parallax.server.blocklyprop.servlets.NewOAuthUserServlet;
 import com.parallax.server.blocklyprop.servlets.OAuthGoogleServlet;
 import com.parallax.server.blocklyprop.servlets.PasswordResetRequestServlet;
@@ -130,9 +128,6 @@ protected void configureServlets() {
         serve("/public/clientinstructions").with(TextileClientInstructionsServlet.class);
         serve("/public/changelog").with(TextileChangeLogServlet.class);
 
-        // Help
-        serve("/public/help").with(HelpServlet.class);
-        serve("/public/helpsearch").with(HelpSearchServlet.class);
 
         // OAuth
         serve("/oauth/newuser").with(NewOAuthUserServlet.class);

src/main/java/com/parallax/server/blocklyprop/config/SetupConfig.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2018 Parallax Inc.
+ * Copyright (c) 2019 Parallax Inc.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
  * and associated documentation files (the “Software”), to deal in the Software without
@@ -26,12 +26,12 @@
 import com.google.inject.Injector;
 import com.google.inject.servlet.GuiceServletContextListener;
 
-import com.parallax.server.blocklyprop.SessionData;
 import com.parallax.server.blocklyprop.jsp.Properties;
 import com.parallax.server.blocklyprop.monitoring.Monitor;
-import com.parallax.server.blocklyprop.utils.HelpFileInitializer;
+
 import java.sql.Driver;
 import java.sql.DriverManager;
+import java.sql.SQLException;
 import java.util.Enumeration;
 import javax.servlet.ServletContextEvent;
 import org.apache.commons.configuration.Configuration;
@@ -40,8 +40,6 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-// import java.sql.SQLException;
-// import ch.qos.logback.classic.LoggerContext;
 
 
 /**
@@ -50,16 +48,18 @@
  */
 public class SetupConfig extends GuiceServletContextListener {
 
-    /**
-     * Application-specific configuration options
-     */
+    // Application logging connector
+    private final Logger LOG = LoggerFactory.getLogger(SetupConfig.class);
+
+    // Application-specific configuration options
     private Configuration configuration;
-    
+
+
     /**
-     * Application logging connector
+     *  Create a Guice injector object
+     *
+     * @return a Guice injector object
      */
-    private final Logger LOG = LoggerFactory.getLogger(SetupConfig.class);
-
     @Override
     protected Injector getInjector() {
         readConfiguration();
@@ -68,12 +68,12 @@ protected Injector getInjector() {
 
             @Override
             protected void configure() {
+
+                LOG.info("Binding Configuration class");
                 bind(Configuration.class).toInstance(configuration);
 
-                bind(SessionData.class);
                 bind(Properties.class).asEagerSingleton();
 
-                bind(HelpFileInitializer.class).asEagerSingleton();
                 bind(Monitor.class).asEagerSingleton();
 
                 // Configure the backend data store
@@ -85,7 +85,6 @@ protected void configure() {
                 install(new ServletsModule());
                 install(new RestModule());
             }
-
         });
     }
 
@@ -123,26 +122,16 @@ public void contextDestroyed(ServletContextEvent servletContextEvent) {
         // This manually deregisters JDBC driver, which prevents Tomcat 7 from
         // complaining about memory leaks into this class
 
-/*        
         while (drivers.hasMoreElements()) {
             Driver driver = drivers.nextElement();
             try {
                 DriverManager.deregisterDriver(driver);
-                LOG.info("deregistering jdbc driver: {}",driver);
+                LOG.info("Deregister the jdbc driver: {}",driver);
             } catch (SQLException sqlE) {
-                LOG.error("Error deregistering driver %s", driver);
+                LOG.error("Unable to deregister the jdbc driver {}", driver.toString());
                 LOG.error("{}", sqlE.getSQLState());
             }
-
-        }
-        
-        // Shut down the loggers. Assume SLF4J is bound to logback-classic
-        // in the current environment
-        LoggerContext loggerContext = (LoggerContext) LoggerFactory.getILoggerFactory();
-        if (loggerContext != null) {
-            loggerContext.stop();
         }
-*/
     }
 
 }