Skip to content

Commit

Permalink
#11303: Get Velocity root folder method created. Classes that had the… (
Browse files Browse the repository at this point in the history 
#11335)

* #11303: Get Velocity root folder method created. Classes that had the hardcoded path were modified.

* #10370: Final adjustments to Velocity folder capabilities. Use the VELOCITY_ROOT property to override the default path
  • Loading branch information
@danlaguna @dsilvam
danlaguna authored and dsilvam committed Apr 28, 2017
1 parent cfdeabb commit dc47dca
Show file tree
Hide file tree
Showing 13 changed files with 184 additions and 89 deletions.
55 changes: 55 additions & 0 deletions dotCMS/src/integration-test/java/com/dotcms/velocity/VelocityUtilTest.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
package com.dotcms.velocity;

import com.dotcms.util.IntegrationTestInitService;
import com.dotmarketing.util.Config;
import com.dotmarketing.util.VelocityUtil;

import org.junit.Assert;
import org.junit.BeforeClass;
import org.junit.FixMethodOrder;
import org.junit.Test;
import org.junit.runners.MethodSorters;
import org.mockito.Mockito;

import static org.hamcrest.MatcherAssert.assertThat;

/**
* VelocityUtilTest
*/
@FixMethodOrder(MethodSorters.NAME_ASCENDING)
public class VelocityUtilTest {

@BeforeClass
public static void prepare() throws Exception {
IntegrationTestInitService.getInstance().init();
Mockito.when(Config.CONTEXT.getRealPath("/WEB-INF/velocity"))
.thenReturn(Config.getStringProperty("VELOCITY_ROOT", "/WEB-INF/velocity"));
}

/**
* Test the velocity path is the default path
*/
@Test
public void test01DefaultVelocityPath() throws Exception {
String velocityPath = VelocityUtil.getVelocityRootPath();

Assert.assertNotNull(velocityPath);
assertThat("Path ends with /WEB-INF/velocity", velocityPath.endsWith("/WEB-INF/velocity"));
}

/**
* Test the velocity path is a custom path
*/
@Test
public void test02CustomVelocityPath() throws Exception {
String velocityPath = Config.getStringProperty("VELOCITY_ROOT", "/WEB-INF/velocity");
velocityPath = velocityPath.replace("/WEB-INF/velocity", "/WEB-INF/customvelocity");
Config.setProperty("VELOCITY_ROOT", velocityPath);

String customVelocityPath = VelocityUtil.getVelocityRootPath();

Assert.assertNotNull(customVelocityPath);
assertThat("Path ends with /WEB-INF/customvelocity", customVelocityPath.endsWith("/WEB-INF/customvelocity"));
}

}
9 changes: 4 additions & 5 deletions dotCMS/src/main/java/com/dotmarketing/osgi/ActivatorUtil.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
import com.dotcms.repackage.org.apache.struts.config.ModuleConfig;
import com.dotcms.repackage.org.apache.struts.config.impl.ModuleConfigImpl;
import com.dotmarketing.util.Config;
import com.dotmarketing.util.VelocityUtil;
import com.liferay.portal.util.Constants;
import com.liferay.util.FileUtil;
import org.apache.felix.http.api.ExtHttpService;
Expand All @@ -23,9 +24,8 @@

class ActivatorUtil {

static final String PATH_SEPARATOR = "/";
static final String PATH_SEPARATOR = "/";
static final String OSGI_FOLDER = "/osgi";
static final String VELOCITY_FOLDER = "/WEB-INF/velocity";

static String getBundleFolder ( BundleContext context, String separator ) {

Expand Down Expand Up @@ -75,7 +75,7 @@ static void cleanResources ( BundleContext context ) {
}

//Now cleaning the resources under the velocity folder
resourcesPath = servletContext.getRealPath( VELOCITY_FOLDER + getBundleFolder( context, "/" ) );
resourcesPath = VelocityUtil.getVelocityRootPath() + getBundleFolder( context, "/" );
resources = new File( resourcesPath );
if ( resources.exists() ) {
FileUtil.deltree( resources );
Expand All @@ -91,8 +91,7 @@ static void cleanResources ( BundleContext context ) {
*/
static void moveVelocityResources ( BundleContext context, String referenceResourcePath ) throws Exception {

ServletContext servletContext = Config.CONTEXT;
String destinationPath = servletContext.getRealPath( VELOCITY_FOLDER + getBundleFolder( context, "/" ) );
String destinationPath = VelocityUtil.getVelocityRootPath() + getBundleFolder( context, "/" );

moveResources( context, referenceResourcePath, destinationPath );
}
Expand Down
11 changes: 2 additions & 9 deletions dotCMS/src/main/java/com/dotmarketing/services/ContainerServices.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
import com.dotmarketing.util.ConfigUtils;
import com.dotmarketing.util.Logger;
import com.dotmarketing.util.UtilMethods;
import com.dotmarketing.util.VelocityUtil;
import com.dotmarketing.velocity.DotResourceCache;
import com.liferay.util.FileUtil;

Expand Down Expand Up @@ -285,11 +286,6 @@ public static InputStream buildVelocity(Container container, Identifier identifi

try {
String folderPath = (!EDIT_MODE) ? "live" + File.separator: "working" + File.separator;
String velocityRootPath = Config.getStringProperty("VELOCITY_ROOT");
if (velocityRootPath.startsWith("/WEB-INF")) {
velocityRootPath = FileUtil.getRealPath(velocityRootPath);
}
velocityRootPath += File.separator;
String filePath = folderPath + identifier.getInode() + "." + Config.getStringProperty("VELOCITY_CONTAINER_EXTENSION");

if(Config.getBooleanProperty("SHOW_VELOCITYFILES", false)){
Expand Down Expand Up @@ -332,10 +328,7 @@ public static void removeContainerFile(Container container, boolean EDIT_MODE) t

public static void removeContainerFile (Container container, Identifier identifier, boolean EDIT_MODE) {
String folderPath = (!EDIT_MODE) ? "live" + java.io.File.separator: "working" + java.io.File.separator;
String velocityRootPath = Config.getStringProperty("VELOCITY_ROOT");
if (velocityRootPath.startsWith("/WEB-INF")) {
velocityRootPath = FileUtil.getRealPath(velocityRootPath);
}
String velocityRootPath = VelocityUtil.getVelocityRootPath();
velocityRootPath += java.io.File.separator;
String filePath = folderPath + identifier.getInode() + "." + Config.getStringProperty("VELOCITY_CONTAINER_EXTENSION");
java.io.File f = new java.io.File(velocityRootPath + filePath);
Expand Down
14 changes: 5 additions & 9 deletions dotCMS/src/main/java/com/dotmarketing/services/ContentletMapServices.java
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package com.dotmarketing.services;

import java.io.ByteArrayInputStream;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStreamWriter;
Expand Down Expand Up @@ -34,6 +35,7 @@
import com.dotmarketing.util.InodeUtils;
import com.dotmarketing.util.Logger;
import com.dotmarketing.util.UtilMethods;
import com.dotmarketing.util.VelocityUtil;
import com.dotmarketing.velocity.DotResourceCache;
import com.liferay.portal.model.User;
import com.liferay.util.FileUtil;
Expand Down Expand Up @@ -402,14 +404,6 @@ else if (field.getFieldType().equals(Field.FieldType.BINARY.toString())) {

if(Config.getBooleanProperty("SHOW_VELOCITYFILES", false)){
try {

String velocityRootPath=Config.getStringProperty("VELOCITY_ROOT");

if (velocityRootPath.startsWith("/WEB-INF")) {
velocityRootPath=FileUtil.getRealPath(velocityRootPath);
}
velocityRootPath += java.io.File.separator;

String veloExt=Config.getStringProperty("VELOCITY_CONTENT_MAP_EXTENSION");
String baseFilename=String.format("%s_%d.%s", content.getIdentifier(), content.getLanguageId(), veloExt);

Expand Down Expand Up @@ -466,7 +460,9 @@ private static void removeContentletMapFile(Contentlet asset, boolean EDIT_MODE)

private static void removeContentletMapFile(Contentlet asset, Identifier identifier, boolean EDIT_MODE) {
String folderPath=(!EDIT_MODE) ? "live/" : "working/";
String velocityRoot=FileUtil.getRealPath("/WEB-INF/velocity/") + folderPath;

String velocityRootPath = VelocityUtil.getVelocityRootPath();
String velocityRoot = velocityRootPath + File.separator + folderPath;

String filePath= folderPath + identifier.getInode() + "_" + asset.getLanguageId() + "." + Config.getStringProperty("VELOCITY_CONTENT_MAP_EXTENSION");
java.io.File f=new java.io.File (velocityRoot + filePath);
Expand Down
14 changes: 2 additions & 12 deletions dotCMS/src/main/java/com/dotmarketing/services/ContentletServices.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
import com.dotmarketing.util.InodeUtils;
import com.dotmarketing.util.Logger;
import com.dotmarketing.util.UtilMethods;
import com.dotmarketing.util.VelocityUtil;
import com.dotmarketing.velocity.DotResourceCache;
import com.dotmarketing.viewtools.LanguageWebAPI;
import com.liferay.portal.model.User;
Expand Down Expand Up @@ -478,14 +479,6 @@ else if (field.getFieldType().equals(Field.FieldType.CATEGORY.toString())) {

if(Config.getBooleanProperty("SHOW_VELOCITYFILES", false)){
try {

String velocityRootPath= Config.getStringProperty("VELOCITY_ROOT");

if (velocityRootPath.startsWith("/WEB-INF")) {
velocityRootPath= FileUtil.getRealPath(velocityRootPath);
}
velocityRootPath += java.io.File.separator;

String veloExt= Config.getStringProperty("VELOCITY_CONTENT_EXTENSION");
String baseFilename= String.format("%s_%d.%s", identifier.getInode(), content.getLanguageId(), veloExt);

Expand Down Expand Up @@ -554,10 +547,7 @@ private static void removeContentletFile(Contentlet asset, Identifier identifier
CacheLocator.getContentletCache().remove(asset.getInode());

String folderPath= (!EDIT_MODE) ? "live" + java.io.File.separator : "working" + java.io.File.separator;
String velocityRootPath= Config.getStringProperty("VELOCITY_ROOT");
if (velocityRootPath.startsWith("/WEB-INF")) {
velocityRootPath= FileUtil.getRealPath(velocityRootPath);
}
String velocityRootPath = VelocityUtil.getVelocityRootPath();
velocityRootPath += java.io.File.separator;

Set<Long> langs = new HashSet<Long>();
Expand Down
12 changes: 2 additions & 10 deletions dotCMS/src/main/java/com/dotmarketing/services/FieldServices.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
import com.dotmarketing.util.ConfigUtils;
import com.dotmarketing.util.Logger;
import com.dotmarketing.util.UtilMethods;
import com.dotmarketing.util.VelocityUtil;
import com.dotmarketing.velocity.DotResourceCache;
import com.liferay.util.FileUtil;

Expand Down Expand Up @@ -66,12 +67,6 @@ public static InputStream buildVelocity(String fieldInode, String contentInode,
}

if(Config.getBooleanProperty("SHOW_VELOCITYFILES", false)){
String velocityRootPath = Config.getStringProperty("VELOCITY_ROOT");
if (velocityRootPath.startsWith("/WEB-INF")) {
velocityRootPath = FileUtil.getRealPath(velocityRootPath);
}
velocityRootPath += java.io.File.separator;

String folderPath = (!EDIT_MODE) ? "live" + java.io.File.separator: "working" + java.io.File.separator;
String filePath=folderPath + contentInode + "_" + fieldInode + "." + Config.getStringProperty("VELOCITY_FIELD_EXTENSION");
//Specify a proper character encoding
Expand Down Expand Up @@ -99,10 +94,7 @@ public static InputStream buildVelocity(String fieldInode, String contentInode,
}

public static void removeFieldFile (String fieldInode, String contentInode, boolean EDIT_MODE) {
String velocityRootPath = Config.getStringProperty("VELOCITY_ROOT");
if (velocityRootPath.startsWith("/WEB-INF")) {
velocityRootPath = FileUtil.getRealPath(velocityRootPath);
}
String velocityRootPath = VelocityUtil.getVelocityRootPath();
velocityRootPath += java.io.File.separator;
String folderPath = (!EDIT_MODE) ? "live" + java.io.File.separator: "working" + java.io.File.separator;
String filePath=folderPath + contentInode + "_" + fieldInode + "." + Config.getStringProperty("VELOCITY_FIELD_EXTENSION");
Expand Down
16 changes: 5 additions & 11 deletions dotCMS/src/main/java/com/dotmarketing/services/HostServices.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
import com.dotmarketing.util.ConfigUtils;
import com.dotmarketing.util.Logger;
import com.dotmarketing.util.UtilMethods;
import com.dotmarketing.util.VelocityUtil;
import com.dotmarketing.velocity.DotResourceCache;
import com.liferay.portal.model.User;
import com.liferay.util.FileUtil;
Expand Down Expand Up @@ -73,13 +74,9 @@ public static InputStream buildStream(Host host, boolean EDIT_MODE) throws DotDa

if(Config.getBooleanProperty("SHOW_VELOCITYFILES", false)){
String realFolderPath = (!EDIT_MODE) ? "live" + java.io.File.separator: "working" + java.io.File.separator;
String velocityRootPath = Config.getStringProperty("VELOCITY_ROOT");
String filePath = realFolderPath + host.getIdentifier() + "." + Config.getStringProperty("VELOCITY_HOST_EXTENSION");
if (velocityRootPath.startsWith("/WEB-INF")) {
velocityRootPath = FileUtil.getRealPath(velocityRootPath);
}
velocityRootPath += java.io.File.separator;


String filePath = realFolderPath + host.getIdentifier() + "." + Config.getStringProperty("VELOCITY_HOST_EXTENSION");

java.io.BufferedOutputStream tmpOut = new java.io.BufferedOutputStream(new java.io.FileOutputStream(new java.io.File(ConfigUtils.getDynamicVelocityPath()+java.io.File.separator + filePath)));
//Specify a proper character encoding
OutputStreamWriter out = new OutputStreamWriter(tmpOut, UtilMethods.getCharsetConfiguration());
Expand Down Expand Up @@ -112,10 +109,7 @@ public static void unpublishPageFile(Host host) {

public static void removeHostFile (Host host, boolean EDIT_MODE) {
String folderPath = (!EDIT_MODE) ? "live" + java.io.File.separator: "working" + java.io.File.separator;
String velocityRootPath = Config.getStringProperty("VELOCITY_ROOT");
if (velocityRootPath.startsWith("/WEB-INF")) {
velocityRootPath = FileUtil.getRealPath(velocityRootPath);
}
String velocityRootPath = VelocityUtil.getVelocityRootPath();
String filePath = folderPath + host.getIdentifier() + "." + Config.getStringProperty("VELOCITY_HOST_EXTENSION");
velocityRootPath += java.io.File.separator;
java.io.File f = new java.io.File(velocityRootPath + filePath);
Expand Down
13 changes: 3 additions & 10 deletions dotCMS/src/main/java/com/dotmarketing/services/PageServices.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -356,13 +356,9 @@ public static InputStream buildStream(IHTMLPage htmlPage, Identifier identifier,
String languageStr = htmlPage.isContent() ? "_" + ((Contentlet)htmlPage).getLanguageId():"";

String realFolderPath = (!EDIT_MODE) ? "live" + java.io.File.separator: "working" + java.io.File.separator;
String velocityRootPath = Config.getStringProperty("VELOCITY_ROOT");

String filePath = realFolderPath + identifier.getInode() + languageStr + "." + Config.getStringProperty("VELOCITY_HTMLPAGE_EXTENSION","dotpage");
if (velocityRootPath.startsWith("/WEB-INF")) {
velocityRootPath = com.liferay.util.FileUtil.getRealPath(velocityRootPath);
}
velocityRootPath += java.io.File.separator;


java.io.BufferedOutputStream tmpOut = new java.io.BufferedOutputStream(new java.io.FileOutputStream(new java.io.File(ConfigUtils.getDynamicVelocityPath()+java.io.File.separator + filePath)));
//Specify a proper character encoding
OutputStreamWriter out = new OutputStreamWriter(tmpOut, UtilMethods.getCharsetConfiguration());
Expand All @@ -387,10 +383,7 @@ public static InputStream buildStream(IHTMLPage htmlPage, Identifier identifier,

public static void removePageFile (IHTMLPage htmlPage, Identifier identifier, boolean EDIT_MODE) {
String folderPath = (!EDIT_MODE) ? "live" + java.io.File.separator: "working" + java.io.File.separator;
String velocityRootPath = Config.getStringProperty("VELOCITY_ROOT");
if (velocityRootPath.startsWith("/WEB-INF")) {
velocityRootPath = com.liferay.util.FileUtil.getRealPath(velocityRootPath);
}
String velocityRootPath = VelocityUtil.getVelocityRootPath();
String languageStr = htmlPage.isContent() ? "_" + ((Contentlet)htmlPage).getLanguageId():"";
String filePath = folderPath + identifier.getInode() + languageStr + "." + Config.getStringProperty("VELOCITY_HTMLPAGE_EXTENSION","dotpage");
velocityRootPath += java.io.File.separator;
Expand Down
11 changes: 5 additions & 6 deletions dotCMS/src/main/java/com/dotmarketing/services/StructureServices.java
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package com.dotmarketing.services;

import java.io.ByteArrayInputStream;
import java.io.File;
import java.io.InputStream;
import java.io.OutputStreamWriter;
import java.io.UnsupportedEncodingException;
Expand All @@ -16,6 +17,7 @@
import com.dotmarketing.util.ConfigUtils;
import com.dotmarketing.util.Logger;
import com.dotmarketing.util.UtilMethods;
import com.dotmarketing.util.VelocityUtil;
import com.dotmarketing.velocity.DotResourceCache;
import com.liferay.util.FileUtil;

Expand Down Expand Up @@ -151,11 +153,6 @@ public static InputStream buildVelocity(Structure structure,boolean EDIT_MODE) {

try {
if(Config.getBooleanProperty("SHOW_VELOCITYFILES", false)){
String velocityRootPath = Config.getStringProperty("VELOCITY_ROOT");
if (velocityRootPath.startsWith("/WEB-INF")) {
velocityRootPath = FileUtil.getRealPath(velocityRootPath);
}
velocityRootPath += java.io.File.separator;

String relativePath = "/working/" + structure.getInode() + "." + Config.getStringProperty("VELOCITY_STRUCTURE_EXTENSION");

Expand All @@ -181,7 +178,9 @@ public static InputStream buildVelocity(Structure structure,boolean EDIT_MODE) {
public static void removeStructureFile(Structure structure) {
String folderPath = "working/";
String filePath=folderPath + structure.getInode() + "." + Config.getStringProperty("VELOCITY_STRUCTURE_EXTENSION");
String absolutPath = FileUtil.getRealPath("/WEB-INF/velocity/" +filePath);

String velocityRootPath = VelocityUtil.getVelocityRootPath();
String absolutPath = velocityRootPath + File.separator + filePath;
java.io.File f = new java.io.File(absolutPath);
f.delete();
DotResourceCache vc = CacheLocator.getVeloctyResourceCache();
Expand Down
12 changes: 2 additions & 10 deletions dotCMS/src/main/java/com/dotmarketing/services/TemplateServices.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
import com.dotmarketing.util.Constants;
import com.dotmarketing.util.Logger;
import com.dotmarketing.util.UtilMethods;
import com.dotmarketing.util.VelocityUtil;
import com.dotmarketing.velocity.DotResourceCache;
import com.liferay.util.FileUtil;

Expand Down Expand Up @@ -55,12 +56,6 @@ public static InputStream buildVelocity(Template template, Identifier identifier
InputStream result;
StringBuilder templateBody = new StringBuilder();
try {
String velocityRootPath = Config.getStringProperty("VELOCITY_ROOT");
if (velocityRootPath.startsWith("/WEB-INF")) {
velocityRootPath = FileUtil.getRealPath(velocityRootPath);
}
velocityRootPath += java.io.File.separator;

String folderPath = (!EDIT_MODE) ? "live" + java.io.File.separator: "working" + java.io.File.separator;
String filePath=folderPath + identifier.getInode() + "." + Config.getStringProperty("VELOCITY_TEMPLATE_EXTENSION");

Expand Down Expand Up @@ -112,10 +107,7 @@ public static void removeTemplateFile(Template asset, boolean EDIT_MODE) throws
}

public static void removeTemplateFile (Template asset, Identifier identifier, boolean EDIT_MODE) {
String velocityRootPath = Config.getStringProperty("VELOCITY_ROOT");
if (velocityRootPath.startsWith("/WEB-INF")) {
velocityRootPath = FileUtil.getRealPath(velocityRootPath);
}
String velocityRootPath = VelocityUtil.getVelocityRootPath();
velocityRootPath += java.io.File.separator;

String folderPath = (!EDIT_MODE) ? "live" + java.io.File.separator: "working" + java.io.File.separator;
Expand Down
Loading

0 comments on commit dc47dca

Please sign in to comment.