rschneider/ucs-magnolia-utils
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

inital commit

Browse Source
This commit is contained in:
Schneider Roland 2024-09-20 16:57:55 +02:00
commit d9d134cfc1
9 changed files with 387 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
.gitignore vendored Normal file
View File

@ -0,0 +1,40 @@
target/
!.mvn/wrapper/maven-wrapper.jar
!**/src/main/**/target/
!**/src/test/**/target/
### IntelliJ IDEA ###
.idea/modules.xml
.idea/jarRepositories.xml
.idea/compiler.xml
.idea/libraries/
*.iws
*.iml
*.ipr
### Eclipse ###
.apt_generated
.classpath
.factorypath
.project
.settings
.springBeans
.sts4-cache
### NetBeans ###
/nbproject/private/
/nbbuild/
/dist/
/nbdist/
/.nb-gradle/
build/
!**/src/main/**/build/
!**/src/test/**/build/
### VS Code ###
.vscode/
### Mac OS ###
.DS_Store
.idea

91
pom.xml Normal file
View File

@ -0,0 +1,91 @@
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>at.ucs.magnolia.util</groupId>
<artifactId>ucs-magnolia-utils</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>jar</packaging>
<name>ucs-magnolia-utils</name>
<url>http://maven.apache.org</url>
<properties>
<javaVersion>17</javaVersion>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<magnoliaBundleVersion>6.2.46</magnoliaBundleVersion>
<version.lombok>1.18.34</version.lombok>
</properties>
<!-- deploy new versions to ucs nexus repository -->
<distributionManagement>
<repository>
<id>ucs.repo</id>
<url>http://192.168.1.229:8080/nexus/content/repositories/thirdparty/</url>
</repository>
</distributionManagement>
<repositories>
<repository>
<id>magnolia.public</id>
<url>https://nexus.magnolia-cms.com/content/groups/public</url>
<snapshots>
<enabled>true</enabled>
</snapshots>
</repository>
<repository>
<id>vaadin-addons</id>
<url>https://maven.vaadin.com/vaadin-addons</url>
</repository>
</repositories>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>info.magnolia.bundle</groupId>
<artifactId>magnolia-bundle-parent</artifactId>
<version>${magnoliaBundleVersion}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
<dependencies>
<dependency>
<groupId>info.magnolia</groupId>
<artifactId>magnolia-core</artifactId>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>${version.lombok}</version>
<scope>provided</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.7.0</version>
<configuration>
<source>${javaVersion}</source>
<target>${javaVersion}</target>
<annotationProcessorPaths>
<path>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>${version.lombok}</version>
</path>
</annotationProcessorPaths>
</configuration>
</plugin>
</plugins>
</build>
</project>

13
src/main/java/at/ucs/magnolia/util/App.java Normal file
View File

@ -0,0 +1,13 @@
package at.ucs.magnolia.util;
/**
* Hello world!
*
*/
public class App
{
public static void main( String[] args )
{
System.out.println( "Hello World!" );
}
}

42
src/main/java/at/ucs/magnolia/util/bootstrap/simpleUpdate/BootstrapUpdateYamlsWithProperties.java Normal file
View File

@ -0,0 +1,42 @@
package at.ucs.magnolia.util.bootstrap.simpleUpdate;
import info.magnolia.cms.util.ClasspathResourcesUtil;
import info.magnolia.module.InstallContext;
import info.magnolia.module.delta.BootstrapResourcesTask;
import javax.jcr.RepositoryException;
import java.io.IOException;
import java.util.Arrays;
/**
* This task bootstraps all yamls of update-yamls in a specific version and replaces magnolia property placeholder.
*/
public class BootstrapUpdateYamlsWithProperties extends BootstrapResourcesTask {
private final String version;
public BootstrapUpdateYamlsWithProperties(String name, String description, String version) {
super(name, description);
this.version = version;
}
@Override
protected void bootstrap(InstallContext installContext, int importUUIDBehavior) throws IOException, RepositoryException {
// In the original Task super.bootstrap is called, but since we want to call our own BootstrapUtil
// we have to use code called in the super class explicitly
String[] resourcesToBootstrap = ClasspathResourcesUtil.findResources(new ClasspathResourcesUtil.Filter() {
@Override
public boolean accept(final String name) {
return acceptResource(installContext, name);
}
});
resourcesToBootstrap = filterResourcesToBootstrap(resourcesToBootstrap);
UcsBootstrapUtil.bootstrap(resourcesToBootstrap, importUUIDBehavior);
}
private String[] filterResourcesToBootstrap(String[] resourcesToBootstrap) {
return Arrays.stream(resourcesToBootstrap)
.filter(s -> s.startsWith("/update-yamls/" + version+"/"))
.toArray(String[]::new);
}
}

53
src/main/java/at/ucs/magnolia/util/bootstrap/simpleUpdate/SimpleMagnoliaModuleVersionHandler.java Normal file
View File

@ -0,0 +1,53 @@
package at.ucs.magnolia.util.bootstrap.simpleUpdate;
import info.magnolia.module.DefaultModuleVersionHandler;
import info.magnolia.module.InstallContext;
import info.magnolia.module.delta.DeltaBuilder;
import info.magnolia.module.delta.Task;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.stream.Collectors;
/**
* This class is optional and lets you manage the versions of your module,
* by registering "deltas" to maintain the module's configuration, or other type of content.
* If you don't need this, simply remove the reference to this class in the module descriptor xml.
*
* @see info.magnolia.module.DefaultModuleVersionHandler
* @see info.magnolia.module.ModuleVersionHandler
* @see info.magnolia.module.delta.Task
*/
public class SimpleMagnoliaModuleVersionHandler extends DefaultModuleVersionHandler {
private final List<SimpleModuleUpdate> updates = new ArrayList<>();
public SimpleMagnoliaModuleVersionHandler() {
// define here all updates
}
protected void registerUpdate(SimpleModuleUpdate update) {
this.updates.add(update);
register(DeltaBuilder.update(update.getVersion(), "")
.addTasks(update.getAllTasks())
);
}
protected List<Task> getUpdateTasks() {
return this.updates.stream().map(SimpleModuleUpdate::getAllTasks)
.flatMap(Collection::stream)
.collect(Collectors.toList());
}
@Override
protected List<Task> getExtraInstallTasks(InstallContext installContext) {
final List<Task> tasks = new ArrayList<>();
tasks.addAll(super.getExtraInstallTasks(installContext));
tasks.addAll(getUpdateTasks());
return tasks;
}
}

38
src/main/java/at/ucs/magnolia/util/bootstrap/simpleUpdate/SimpleModuleUpdate.java Normal file
View File

@ -0,0 +1,38 @@
package at.ucs.magnolia.util.bootstrap.simpleUpdate;
import at.ucs.magnolia.util.bootstrap.task.LoggingTask;
import info.magnolia.module.delta.Task;
import lombok.AllArgsConstructor;
import lombok.Getter;
import java.util.Collections;
import java.util.List;
import java.util.stream.Collectors;
import java.util.stream.Stream;
@Getter
@AllArgsConstructor
public abstract class SimpleModuleUpdate {
private String version;
public abstract List<Task> getUpdateTasks();
public List<Task> getUpdateTasksAfterBootstrap() {
return Collections.emptyList();
}
public List<Task> getAllTasks() {
return Stream.concat(
Stream.concat(
//Put tasks that should be executed before every update in here
Stream.of(new LoggingTask("updating to version: " + version, "")),
getUpdateTasks().stream()),
Stream.concat(
//Put tasks that should be executed after every update in here
Stream.of(new BootstrapUpdateYamlsWithProperties("Import bootstrap YAML folder", "Imports bootstrap YAML files from /update-yamls/" + version, version)),
getUpdateTasksAfterBootstrap().stream()))
.collect(Collectors.toList());
}
}

60
src/main/java/at/ucs/magnolia/util/bootstrap/simpleUpdate/UcsBootstrapUtil.java Normal file
View File

@ -0,0 +1,60 @@
package at.ucs.magnolia.util.bootstrap.simpleUpdate;
import at.ucs.magnolia.util.configuration.MagnoliaPropertyResolver;
import info.magnolia.cms.util.StringLengthComparator;
import info.magnolia.importexport.BootstrapUtil;
import info.magnolia.init.MagnoliaConfigurationProperties;
import info.magnolia.objectfactory.Components;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import javax.jcr.Node;
import javax.jcr.RepositoryException;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.util.*;
/**
* This class is exactly working like the original BootstrapUtil class of Magnolia,
* with the only difference, that it substitutes Magnolia Property placeholders
* with their actual value, since this is not implemented for bootstrap yamls by Magnolia
*/
public class UcsBootstrapUtil {
private static final Logger log = LoggerFactory.getLogger(BootstrapUtil.class);
public static void bootstrap(String[] resourceNames, int importUUIDBehavior) throws IOException, RepositoryException {
// sort by length --> import parent node firstsubPath
List<String> list = new ArrayList<>(Arrays.asList(resourceNames));
if (list.contains(null)) {
throw new IllegalArgumentException("Resource names contain a <null> entry that cannot be processed.");
}
Collections.sort(list, new StringLengthComparator());
for (Iterator<String> iter = list.iterator(); iter.hasNext(); ) {
bootstrap(iter.next(), null, importUUIDBehavior);
}
}
public static void bootstrap(String resourceName, String subPath, int importUUIDBehavior) throws IOException, RepositoryException {
final InputStream stream = BootstrapUtil.class.getResourceAsStream(resourceName);
if (stream == null) {
throw new IOException("Can't find resource to bootstrap at " + resourceName);
}
MagnoliaConfigurationProperties magnoliaConfiguration = Components.getComponent(MagnoliaConfigurationProperties.class);
InputStream resolvedStream = MagnoliaPropertyResolver.resolve(magnoliaConfiguration, stream);
// Verify if the node already exists and execute jcr import command
bootstrap(resourceName, subPath, resolvedStream, importUUIDBehavior);
}
public static void bootstrap(String resourceName, String subPath, InputStream stream, int importUUIDBehavior) throws RepositoryException {
BootstrapUtil.bootstrap(resourceName, subPath, stream, importUUIDBehavior);
}
public static void export(Node content, File directory) throws IOException, RepositoryException {
BootstrapUtil.export(content, directory);
}
}

20
src/main/java/at/ucs/magnolia/util/bootstrap/task/LoggingTask.java Normal file
View File

@ -0,0 +1,20 @@
package at.ucs.magnolia.util.bootstrap.task;
import info.magnolia.module.InstallContext;
import info.magnolia.module.delta.AbstractTask;
import info.magnolia.module.delta.TaskExecutionException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class LoggingTask extends AbstractTask {
private static final Logger log = LoggerFactory.getLogger(LoggingTask.class.getName());
public LoggingTask(String taskName, String taskDescription) {
super(taskName, taskDescription);
}
@Override
public void execute(InstallContext installContext) throws TaskExecutionException {
log.info(getName());
}
}

30
src/main/java/at/ucs/magnolia/util/configuration/MagnoliaPropertyResolver.java Normal file
View File

@ -0,0 +1,30 @@
package at.ucs.magnolia.util.configuration;
import info.magnolia.init.PropertySource;
import org.apache.commons.io.IOUtils;
import org.apache.commons.text.StringSubstitutor;
import java.io.IOException;
import java.io.InputStream;
import static java.nio.charset.StandardCharsets.UTF_8;
import static org.apache.commons.text.StringSubstitutor.*;
public class MagnoliaPropertyResolver {
private MagnoliaPropertyResolver() {
}
public static InputStream resolve(PropertySource properties, InputStream in) {
try {
return IOUtils.toInputStream(replaceMagnoliaPlaceholders(properties, in), UTF_8);
} catch (IOException e) {
return null;
}
}
private static String replaceMagnoliaPlaceholders(PropertySource properties, InputStream in) throws IOException {
StringSubstitutor substitutor = new StringSubstitutor(properties::getProperty, DEFAULT_PREFIX, DEFAULT_SUFFIX, DEFAULT_ESCAPE);
return substitutor.replace(IOUtils.toString(in, UTF_8));
}
}