Nemcio/SCM-Manager
1
0
Fork 0
mirror of https://github.com/scm-manager/scm-manager.git synced 2025-11-01 19:15:52 +01:00
Code Issues Packages Projects Releases Activity

add i18n Servlet

Browse Source
This commit is contained in:
Mohamed Karray
2018-10-19 11:15:37 +02:00
parent e04ced8e53
commit 9dc32fe128
8 changed files with 182 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
scm-plugins/scm-git-plugin/src/main/resources/locales/de/plugins.json Normal file
View File

@@ -0,0 +1,5 @@
{
"git": {
"description": "die git repo ist super "
}
}

5
scm-plugins/scm-git-plugin/src/main/resources/locales/en/plugins.json Normal file
View File

@@ -0,0 +1,5 @@
{
"git": {
"description": "the git repo is great "
}
}

5
scm-plugins/scm-hg-plugin/src/main/resources/locales/de/plugins.json Normal file
View File

@@ -0,0 +1,5 @@
{
"hg": {
"description": "die hg repo ist super "
}
}

5
scm-plugins/scm-hg-plugin/src/main/resources/locales/en/plugins.json Normal file
View File

@@ -0,0 +1,5 @@
{
"hg": {
"description": "the hg repo is great "
}
}

5
scm-plugins/scm-svn-plugin/src/main/resources/locales/de/plugins.json Normal file
View File

@@ -0,0 +1,5 @@
{
"svn": {
"description": "die svn repo ist super "
}
}

5
scm-plugins/scm-svn-plugin/src/main/resources/locales/en/plugins.json Normal file
View File

@@ -0,0 +1,5 @@
{
"svn": {
"description": "the svn repo is great "
}
}

2
scm-webapp/src/main/java/sonia/scm/WebResourceServlet.java
View File

@@ -33,7 +33,7 @@ public class WebResourceServlet extends HttpServlet {
* TODO remove old protocol servlets and hook. Move /hook/hg to api?
*/
@VisibleForTesting
static final String PATTERN = "/(?!api/|git/|hg/|svn/|hook/|repo/).*";
static final String PATTERN = "/(?!api/|git/|hg/|svn/|hook/|repo/|locales/).*";
private static final Logger LOG = LoggerFactory.getLogger(WebResourceServlet.class);

151
scm-webapp/src/main/java/sonia/scm/web/i18n/I18nServlet.java Normal file
View File

@@ -0,0 +1,151 @@
package sonia.scm.web.i18n;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.github.legman.Subscribe;
import com.google.inject.Singleton;
import com.sun.org.apache.regexp.internal.RE;
import lombok.extern.slf4j.Slf4j;
import sonia.scm.NotFoundException;
import sonia.scm.SCMContext;
import sonia.scm.Stage;
import sonia.scm.boot.RestartEvent;
import sonia.scm.cache.Cache;
import sonia.scm.cache.CacheManager;
import sonia.scm.filter.WebElement;
import sonia.scm.plugin.PluginLoader;
import sonia.scm.plugin.UberClassLoader;
import javax.inject.Inject;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.PrintWriter;
import java.net.URL;
import java.nio.file.Files;
import java.nio.file.Paths;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.Map;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
/**
* Collect
*/
@Singleton
@WebElement(value = I18nServlet.PATTERN, regex = true)
@Slf4j
public class I18nServlet extends HttpServlet {
public static final String PATH = "/locales";
public static final String PLUGINS_JSON = "plugins.json";
public static final String PATTERN = PATH + "/[a-z\\-A-Z]*/" + PLUGINS_JSON;
public static final String CACHE_NAME = "sonia.cache.plugins.translations";
private final UberClassLoader uberClassLoader;
private final Cache<String, HashMap<String, String>> cache;
private RE languagePathPostfix = new RE(".*(\\-[A-Z]+)/.*");
private ObjectMapper objectMapper = new ObjectMapper();
@Inject
public I18nServlet(PluginLoader pluginLoader, CacheManager cacheManager) {
this.uberClassLoader = (UberClassLoader) pluginLoader.getUberClassLoader();
this.cache = cacheManager.getCache(CACHE_NAME);
}
@Subscribe
public void handleRestartEvent(RestartEvent event) {
log.info("clear cache on restart event with reason {}", event.getReason());
cache.clear();
}
public Map<String, String> getCollectedJson(String path,
Function<String, Optional<HashMap<String, String>>> jsonFileProvider,
BiConsumer<String, HashMap<String, String>> createdJsonFileConsumer) throws NotFoundException {
return Optional.ofNullable(jsonFileProvider.apply(path)
.orElseGet(() -> {
Optional<HashMap<String, String>> createdFile = collectJsonFile(path);
createdFile.ifPresent(map -> createdJsonFileConsumer.accept(path, map));
return createdFile.orElse(null);
}
)).orElseThrow(NotFoundException::new);
}
@Override
protected void doGet(HttpServletRequest req, HttpServletResponse response) {
try {
response.setContentType("application/json");
PrintWriter out = response.getWriter();
String path = req.getServletPath();
Function<String, Optional<HashMap<String, String>>> jsonFileProvider = usedPath -> Optional.empty();
BiConsumer<String, HashMap<String, String>> createdJsonFileConsumer = (usedPath, foundJsonMap) -> log.info("A json File is created from the path {}", usedPath);
if (SCMContext.getContext().getStage() == Stage.PRODUCTION) {
log.info("In Production Stage get the plugin translations from the cache");
jsonFileProvider = usedPath -> Optional.ofNullable(
cache.get(usedPath));
createdJsonFileConsumer = createdJsonFileConsumer
.andThen((usedPath, map) -> log.info("Put the created json File in the cache with the key {}", usedPath))
.andThen(cache::put);
}
out.write(objectMapper.writeValueAsString(getCollectedJson(path, jsonFileProvider, createdJsonFileConsumer)));
} catch (IOException e) {
log.error("error on getting the translation of the plugins", e);
response.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
} catch (NotFoundException e) {
log.error("Plugin translations are not found", e);
response.setStatus(HttpServletResponse.SC_NOT_FOUND);
}
// ScmEventBus.getInstance().post(new RestartEvent(I18nServlet.class,"einfach so"));
}
/**
* Return a collected Json File as map with the given path from all plugins in the class path
*
* @param path the searched resource path
* @return a collected Json File as map with the given path from all plugins in the class path
*/
private Optional<HashMap<String, String>> collectJsonFile(String path) {
log.info("Collect plugin translations from path {} for every plugin", path);
HashMap<String, String> result = null;
try {
Enumeration<URL> resources = uberClassLoader.getResources(path.replaceFirst("/", ""));
if (resources.hasMoreElements()) {
result = new HashMap<>();
while (resources.hasMoreElements()) {
URL url = resources.nextElement();
result.putAll(mergeJSONs(objectMapper, url));
}
}
} catch (IOException e) {
log.error("Error on loading sources from {}", path, e);
}
return Optional.ofNullable(result);
}
private boolean hasLanguagePostfix(String path) {
return languagePathPostfix.match(path);
}
/**
* remove the -DE from the path locales/de-DE/plugins
*
* @param servletPath
* @return
* @throws IOException
*/
private String removeLanguagePostfix(String servletPath) {
return servletPath.replace(languagePathPostfix.getParen(1), "");
}
// TODO simplify
private HashMap<String, String> mergeJSONs(ObjectMapper objectMapper, URL url) throws IOException {
byte[] src = Files.readAllBytes(Paths.get(url.getPath()));
Map<String, String> json = objectMapper.readValue(src, HashMap.class);
return objectMapper.readerForUpdating(json).readValue(src);
}
}