LUT-30367: Add theme management feature into LUTECE Core 7.2

pom.xml

@@ -10,7 +10,7 @@
     <groupId>fr.paris.lutece</groupId>
     <artifactId>lutece-core</artifactId>
     <packaging>lutece-core</packaging>
-    <version>7.1.4-SNAPSHOT</version>
+    <version>7.2.0-SNAPSHOT</version>
     <name>Lutece</name>
     <url>http://dev.lutece.paris.fr/</url>
 

src/java/fr/paris/lutece/portal/business/theme/IThemeDAO.java

@@ -0,0 +1,106 @@
+/*
+ * Copyright (c) 2002-2014, Mairie de Paris
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ *  1. Redistributions of source code must retain the above copyright notice
+ *     and the following disclaimer.
+ *
+ *  2. Redistributions in binary form must reproduce the above copyright notice
+ *     and the following disclaimer in the documentation and/or other materials
+ *     provided with the distribution.
+ *
+ *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
+ *     contributors may be used to endorse or promote products derived from
+ *     this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ *
+ * License 1.0
+ */
+package fr.paris.lutece.portal.business.theme;
+
+import fr.paris.lutece.portal.business.style.Theme;
+import fr.paris.lutece.util.ReferenceList;
+
+import java.util.Collection;
+
+
+/**
+ * This class provides Data Access methods for Theme objects
+ */
+public interface IThemeDAO
+{
+    /**
+     * Insert a new record in the table.
+     *
+     * @param mode The mode object
+     */
+    void insert( Theme mode );
+
+    /**
+     * load the data of Level from the table
+     *
+     * @param strCodeTheme The indentifier of the object Theme
+     * @return The Instance of the object Theme
+     */
+    Theme load( String strCodeTheme );
+
+    /**
+     * Delete a record from the table
+     *
+     * @param strCodeTheme The indentifier of the object Theme
+
+     */
+    void delete( String strCodeTheme );
+
+    /**
+     * Update the record in the table
+     *
+     * @param theme The instance of the Theme to update
+     */
+    void store( Theme theme );
+
+    /**
+     * Returns a list of all the themes
+     *
+     * @return A collection of themes objects
+     */
+    Collection<Theme> selectThemesList( );
+
+    /**
+     * Returns the list of the themes in form of a reference list
+     *
+     * @return the themes list in form of a ReferenceList object
+     */
+    ReferenceList getThemesList( );
+
+    /**
+     * Sets the global theme
+     *
+     * @param strGlobalTheme The Global Theme
+
+     */
+    void setGlobalTheme( String strGlobalTheme );
+
+    /**
+     * Returns the global theme
+     *
+
+     * @return The Global Theme
+     */
+    Theme getGlobalTheme(  );
+}

src/java/fr/paris/lutece/portal/business/theme/ThemeDAO.java

@@ -0,0 +1,240 @@
+/*
+ * Copyright (c) 2002-2014, Mairie de Paris
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ *  1. Redistributions of source code must retain the above copyright notice
+ *     and the following disclaimer.
+ *
+ *  2. Redistributions in binary form must reproduce the above copyright notice
+ *     and the following disclaimer in the documentation and/or other materials
+ *     provided with the distribution.
+ *
+ *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
+ *     contributors may be used to endorse or promote products derived from
+ *     this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ *
+ * License 1.0
+ */
+package fr.paris.lutece.portal.business.theme;
+
+import fr.paris.lutece.portal.business.style.Theme;
+import fr.paris.lutece.util.ReferenceList;
+import fr.paris.lutece.util.sql.DAOUtil;
+
+import java.util.ArrayList;
+import java.util.Collection;
+
+
+/**
+ * This class provides Data Access methods for Theme objects
+ */
+public final class ThemeDAO implements IThemeDAO
+{
+    private static final String SQL_QUERY_SELECT = " SELECT code_theme, theme_description, path_images, path_css, theme_author, " +
+        " theme_author_url, theme_version, theme_licence, path_js FROM core_theme WHERE code_theme = ?";
+    private static final String SQL_QUERY_INSERT = " INSERT INTO core_theme ( code_theme, theme_description, path_images, path_css," +
+        " theme_author, theme_author_url, theme_version, theme_licence, path_js ) VALUES ( ?, ?, ?, ?, ?, ?, ?, ?, ? )";
+    private static final String SQL_QUERY_DELETE = " DELETE FROM core_theme WHERE code_theme = ?";
+    private static final String SQL_QUERY_UPDATE = " UPDATE core_theme SET theme_description = ?, path_images = ?, " +
+        " path_css = ? , theme_author = ?, theme_author_url = ?, theme_version = ?, " +
+        " theme_licence = ?, path_js = ? WHERE code_theme = ?";
+    private static final String SQL_QUERY_SELECTALL = " SELECT code_theme, theme_description, path_images, path_css, theme_author, " +
+        " theme_author_url, theme_version, theme_licence, path_js FROM core_theme ORDER BY code_theme";
+    private static final String SQL_QUERY_SELECT_THEME = " SELECT code_theme, theme_description FROM core_theme";
+    private static final String SQL_QUERY_SELECT_GLOBAL_THEME = " SELECT tt.code_theme, tt.theme_description, tt.path_images, tt.path_css, " +
+        " tt.theme_author, tt.theme_author_url, tt.theme_version, tt.theme_licence, tt.path_js " +
+        " FROM core_theme tt INNER JOIN core_theme_global ttg ON tt.code_theme = ttg.global_theme_code ";
+    private static final String SQL_QUERY_UPDATE_GLOBAL_THEME = " UPDATE core_theme_global SET global_theme_code = ? ";
+
+    /**
+     * {@inheritDoc}
+     */
+    public synchronized void insert( Theme theme )
+    {
+        DAOUtil daoUtil = new DAOUtil( SQL_QUERY_INSERT );
+
+        daoUtil.setString( 1, theme.getCodeTheme(  ) );
+        daoUtil.setString( 2, theme.getThemeDescription(  ) );
+        daoUtil.setString( 3, theme.getPathImages(  ) );
+        daoUtil.setString( 4, theme.getPathCss(  ) );
+        daoUtil.setString( 5, theme.getThemeAuthor(  ) );
+        daoUtil.setString( 6, theme.getThemeAuthorUrl(  ) );
+        daoUtil.setString( 7, theme.getThemeVersion(  ) );
+        daoUtil.setString( 8, theme.getThemeLicence(  ) );
+        daoUtil.setString( 9, theme.getPathJs(  ) );
+
+        daoUtil.executeUpdate(  );
+        daoUtil.free(  );
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public Theme load( String strCodeTheme )
+    {
+        Theme theme = null;
+        DAOUtil daoUtil = new DAOUtil( SQL_QUERY_SELECT );
+        daoUtil.setString( 1, strCodeTheme );
+
+        daoUtil.executeQuery(  );
+
+        if ( daoUtil.next(  ) )
+        {
+            theme = new Theme(  );
+            theme.setCodeTheme( daoUtil.getString( 1 ) );
+            theme.setThemeDescription( daoUtil.getString( 2 ) );
+            theme.setPathImages( daoUtil.getString( 3 ) );
+            theme.setPathCss( daoUtil.getString( 4 ) );
+            theme.setThemeAuthor( daoUtil.getString( 5 ) );
+            theme.setThemeAuthorUrl( daoUtil.getString( 6 ) );
+            theme.setThemeVersion( daoUtil.getString( 7 ) );
+            theme.setThemeLicence( daoUtil.getString( 8 ) );
+            theme.setPathJs( daoUtil.getString( 9 ) );
+        }
+
+        daoUtil.free(  );
+
+        return theme;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public void delete( String strCodeTheme )
+    {
+        DAOUtil daoUtil = new DAOUtil( SQL_QUERY_DELETE );
+        daoUtil.setString( 1, strCodeTheme );
+        daoUtil.executeUpdate(  );
+        daoUtil.free(  );
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public void store( Theme theme )
+    {
+        DAOUtil daoUtil = new DAOUtil( SQL_QUERY_UPDATE );
+
+        daoUtil.setString( 1, theme.getThemeDescription(  ) );
+        daoUtil.setString( 2, theme.getPathImages(  ) );
+        daoUtil.setString( 3, theme.getPathCss(  ) );
+        daoUtil.setString( 4, theme.getThemeAuthor(  ) );
+        daoUtil.setString( 5, theme.getThemeAuthorUrl(  ) );
+        daoUtil.setString( 6, theme.getThemeVersion(  ) );
+        daoUtil.setString( 7, theme.getThemeLicence(  ) );
+        daoUtil.setString( 8, theme.getPathJs(  ) );
+        daoUtil.setString( 9, theme.getCodeTheme(  ) );
+
+        daoUtil.executeUpdate(  );
+        daoUtil.free(  );
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public Collection<Theme> selectThemesList( )
+    {
+        Collection<Theme> themeList = new ArrayList<Theme>(  );
+        DAOUtil daoUtil = new DAOUtil( SQL_QUERY_SELECTALL );
+        daoUtil.executeQuery(  );
+
+        while ( daoUtil.next(  ) )
+        {
+            Theme theme = new Theme(  );
+
+            theme.setCodeTheme( daoUtil.getString( 1 ) );
+            theme.setThemeDescription( daoUtil.getString( 2 ) );
+            theme.setPathImages( daoUtil.getString( 3 ) );
+            theme.setPathCss( daoUtil.getString( 4 ) );
+            theme.setThemeAuthor( daoUtil.getString( 5 ) );
+            theme.setThemeAuthorUrl( daoUtil.getString( 6 ) );
+            theme.setThemeVersion( daoUtil.getString( 7 ) );
+            theme.setThemeLicence( daoUtil.getString( 8 ) );
+            theme.setPathJs( daoUtil.getString( 9 ) );
+
+            themeList.add( theme );
+        }
+
+        daoUtil.free(  );
+
+        return themeList;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public ReferenceList getThemesList( )
+    {
+        ReferenceList themesList = new ReferenceList(  );
+        DAOUtil daoUtil = new DAOUtil( SQL_QUERY_SELECT_THEME );
+
+        daoUtil.executeQuery(  );
+
+        while ( daoUtil.next(  ) )
+        {
+            themesList.addItem( daoUtil.getString( 1 ), daoUtil.getString( 2 ) );
+        }
+
+        daoUtil.free(  );
+
+        return themesList;
+    }
+
+    /**
+     * {@inheritDoc }
+     */
+    public void setGlobalTheme( String strGlobalTheme )
+    {
+        DAOUtil daoUtil = new DAOUtil( SQL_QUERY_UPDATE_GLOBAL_THEME );
+
+        daoUtil.setString( 1, strGlobalTheme );
+
+        daoUtil.executeUpdate(  );
+        daoUtil.free(  );
+    }
+
+    /**
+     * {@inheritDoc }
+     */
+    public Theme getGlobalTheme( )
+    {
+        Theme theme = null;
+        DAOUtil daoUtil = new DAOUtil( SQL_QUERY_SELECT_GLOBAL_THEME );
+
+        daoUtil.executeQuery(  );
+
+        if ( daoUtil.next(  ) )
+        {
+            theme = new Theme(  );
+            theme.setCodeTheme( daoUtil.getString( 1 ) );
+            theme.setThemeDescription( daoUtil.getString( 2 ) );
+            theme.setPathImages( daoUtil.getString( 3 ) );
+            theme.setPathCss( daoUtil.getString( 4 ) );
+            theme.setThemeAuthor( daoUtil.getString( 5 ) );
+            theme.setThemeAuthorUrl( daoUtil.getString( 6 ) );
+            theme.setThemeVersion( daoUtil.getString( 7 ) );
+            theme.setThemeLicence( daoUtil.getString( 8 ) );
+            theme.setPathJs( daoUtil.getString( 9 ) );
+        }
+
+        daoUtil.free(  );
+
+        return theme;
+    }
+}