You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by dk...@apache.org on 2018/11/06 05:24:05 UTC
[sling-whiteboard] branch master updated: Adding a first crack at
the web console
This is an automated email from the ASF dual-hosted git repository.
dklco pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-whiteboard.git
The following commit(s) were added to refs/heads/master by this push:
new 21b2693 Adding a first crack at the web console
21b2693 is described below
commit 21b26934a9c70bb729443e7b2f1a8c7073e1a05f
Author: Dan Klco <dk...@apache.org>
AuthorDate: Tue Nov 6 00:23:56 2018 -0500
Adding a first crack at the web console
---
upgrade/pom.xml | 33 ++--
.../java/org/apache/sling/upgrade/BundleEntry.java | 9 +-
.../sling/upgrade/impl/UpgradeWebConsole.java | 207 +++++++++++++++++++++
3 files changed, 235 insertions(+), 14 deletions(-)
diff --git a/upgrade/pom.xml b/upgrade/pom.xml
index 5b2eb20..69483e9 100644
--- a/upgrade/pom.xml
+++ b/upgrade/pom.xml
@@ -1,17 +1,12 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
-<!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor
- license agreements. See the NOTICE file distributed with this work for additional
- information regarding copyright ownership. The ASF licenses this file to
- you under the Apache License, Version 2.0 (the "License"); you may not use
- this file except in compliance with the License. You may obtain a copy of
- the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required
- by applicable law or agreed to in writing, software distributed under the
- License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS
- OF ANY KIND, either express or implied. See the License for the specific
- language governing permissions and limitations under the License. -->
-<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/maven-v4_0_0.xsd">
+<!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional
+ information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except
+ in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to
+ in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See
+ the License for the specific language governing permissions and limitations under the License. -->
+<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/maven-v4_0_0.xsd"
+>
<modelVersion>4.0.0</modelVersion>
<parent>
@@ -105,6 +100,18 @@
<version>1.4</version>
<scope>provided</scope>
</dependency>
+ <dependency>
+ <groupId>org.apache.felix</groupId>
+ <artifactId>org.apache.felix.webconsole</artifactId>
+ <version>3.0.0</version>
+ <scope>provided</scope>
+ </dependency>
+ <dependency>
+ <groupId>commons-fileupload</groupId>
+ <artifactId>commons-fileupload</artifactId>
+ <version>1.3.3</version>
+ <scope>provided</scope>
+ </dependency>
<!-- Test Dependencies -->
<dependency>
diff --git a/upgrade/src/main/java/org/apache/sling/upgrade/BundleEntry.java b/upgrade/src/main/java/org/apache/sling/upgrade/BundleEntry.java
index eb34423..f607e2f 100644
--- a/upgrade/src/main/java/org/apache/sling/upgrade/BundleEntry.java
+++ b/upgrade/src/main/java/org/apache/sling/upgrade/BundleEntry.java
@@ -26,6 +26,7 @@ import java.util.jar.Manifest;
import java.util.regex.Pattern;
import org.apache.commons.io.IOUtils;
+import org.apache.commons.lang.StringUtils;
import org.osgi.framework.Bundle;
import org.osgi.framework.BundleContext;
import org.osgi.framework.Version;
@@ -37,6 +38,8 @@ import org.slf4j.LoggerFactory;
* manifest data, start level, bundle contents and installation requirements.
*/
public class BundleEntry implements Comparable<BundleEntry> {
+ private static final String BUNDLE_SYMBOLIC_NAME = "Bundle-SymbolicName";
+
private static final Pattern ENTRY_PATTERN = Pattern.compile("resources\\/install\\/\\d{1,2}\\/[\\w\\-\\.]+\\.jar");
private static final Logger log = LoggerFactory.getLogger(BundleEntry.class);
@@ -69,7 +72,11 @@ public class BundleEntry implements Comparable<BundleEntry> {
Manifest manifest = bundleIs.getManifest();
Attributes attributes = manifest.getMainAttributes();
- symbolicName = attributes.getValue("Bundle-SymbolicName");
+ if (attributes.getValue(BUNDLE_SYMBOLIC_NAME).contains(";")) {
+ symbolicName = StringUtils.substringBefore(attributes.getValue(BUNDLE_SYMBOLIC_NAME), ";");
+ } else {
+ symbolicName = attributes.getValue(BUNDLE_SYMBOLIC_NAME);
+ }
log.debug("Loaded symbolic name: {}", symbolicName);
version = new Version(attributes.getValue("Bundle-Version"));
diff --git a/upgrade/src/main/java/org/apache/sling/upgrade/impl/UpgradeWebConsole.java b/upgrade/src/main/java/org/apache/sling/upgrade/impl/UpgradeWebConsole.java
new file mode 100644
index 0000000..4022436
--- /dev/null
+++ b/upgrade/src/main/java/org/apache/sling/upgrade/impl/UpgradeWebConsole.java
@@ -0,0 +1,207 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.sling.upgrade.impl;
+
+import java.io.File;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.PrintWriter;
+import java.io.Writer;
+import java.util.List;
+
+import javax.servlet.Servlet;
+import javax.servlet.ServletConfig;
+import javax.servlet.ServletException;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+
+import org.apache.commons.fileupload.FileItem;
+import org.apache.commons.fileupload.FileUploadException;
+import org.apache.commons.fileupload.disk.DiskFileItemFactory;
+import org.apache.commons.fileupload.servlet.ServletFileUpload;
+import org.apache.felix.webconsole.AbstractWebConsolePlugin;
+import org.apache.sling.upgrade.BundleEntry;
+import org.apache.sling.upgrade.UpgradeRequest;
+import org.apache.sling.upgrade.UpgradeService;
+import org.osgi.service.component.annotations.Component;
+import org.osgi.service.component.annotations.Reference;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * Web Console for the upgrading an Apache Sling instance
+ */
+@Component(service = Servlet.class, property = {
+ "service.description=Web Console for upgrading an Apache Sling instance",
+ "service.vendor=The Apache Software Foundation", "felix.webconsole.label=" + UpgradeWebConsole.APP_ROOT,
+ "felix.webconsole.title=Upgrade", "felix.webconsole.category=Sling" })
+public class UpgradeWebConsole extends AbstractWebConsolePlugin {
+
+ /**
+ *
+ */
+ private static final long serialVersionUID = 2255746886735460607L;
+
+ static final String APP_ROOT = "upgrade";
+
+ private static final Logger log = LoggerFactory.getLogger(UpgradeWebConsole.class);
+
+ @Reference
+ private UpgradeService upgradeService;
+
+ /*
+ * (non-Javadoc)
+ *
+ * @see javax.servlet.Servlet#destroy()
+ */
+ @Override
+ public void destroy() {
+ // nothing needed
+ }
+
+ @Override
+ protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
+ if (ServletFileUpload.isMultipartContent(req)) {
+
+ DiskFileItemFactory factory = new DiskFileItemFactory();
+ factory.setRepository(new File(System.getProperty("java.io.tmpdir")));
+
+ ServletFileUpload upload = new ServletFileUpload(factory);
+
+ InputStream jarIs = null;
+ List<FileItem> formItems;
+ try {
+ formItems = upload.parseRequest(req);
+ if (formItems != null && !formItems.isEmpty()) {
+ for (FileItem it : formItems) {
+ if (it != null && !it.isFormField()) {
+ jarIs = it.getInputStream();
+ break;
+ }
+ }
+ }
+ } catch (IOException | FileUploadException e1) {
+ log.error("Exception reading file input", e1);
+ throw new ServletException(e1);
+ }
+
+ // start the html response, write the header, open body and main div
+ PrintWriter pw = startResponse(req, resp);
+
+ // render top navigation
+ renderTopNavigation(req, pw);
+
+ // wrap content in a separate div
+ pw.println("<div id='content'>");
+ renderContent(req, resp);
+ writeUpgradeInfo(resp, jarIs);
+ pw.println("</div>");
+
+ // close the main div, body, and html
+ endResponse(pw);
+ }
+ }
+
+ private void writeUpgradeInfo(HttpServletResponse resp, InputStream jarIs) throws IOException {
+ Writer out = resp.getWriter();
+ UpgradeRequest request = upgradeService.readSlingJar(jarIs);
+
+ out.write("<h2>" + request.getTitle() + " version " + request.getVersion());
+ out.write("<br/><small>" + request.getVendor() + "</small></h2>");
+
+ out.write("<h3>Startup Bundles</h3><ul>");
+ request.getStartupBundles().forEach(e -> {
+ writeBundle(e, out);
+ });
+
+ out.write("</ul><h3>Install Bundles</h3><ul>");
+ request.getBundles().forEach(e -> {
+ writeBundle(e, out);
+ });
+ out.write("</ul>");
+ }
+
+ /*
+ * (non-Javadoc)
+ *
+ * @see org.apache.felix.webconsole.AbstractWebConsolePlugin#getLabel()
+ */
+ @Override
+ public String getLabel() {
+ return "fsclassloader";
+ }
+
+ /*
+ * (non-Javadoc)
+ *
+ * @see javax.servlet.Servlet#getServletInfo()
+ */
+ @Override
+ public String getServletInfo() {
+ return "";
+ }
+
+ /*
+ * (non-Javadoc)
+ *
+ * @see org.apache.felix.webconsole.AbstractWebConsolePlugin#getTitle()
+ */
+ @Override
+ public String getTitle() {
+ return "Upgrade Service";
+ }
+
+ /*
+ * (non-Javadoc)
+ *
+ * @see javax.servlet.Servlet#init(javax.servlet.ServletConfig)
+ */
+ @Override
+ public void init(ServletConfig config) throws ServletException {
+ // nothing needed
+ }
+
+ @Override
+ protected void renderContent(HttpServletRequest req, HttpServletResponse res) throws ServletException, IOException {
+ Writer out = res.getWriter();
+ out.write("<h1>Update Sling</h1>");
+ out.write(
+ "<form method=\"post\" enctype=\"multipart/form-data\"><label for=\"jar\">Update Jar File</lable><br/><input type=\"file\" name=\"jar\" accepts=\"application/java-archive\"><input type=\"submit\" /></form>");
+
+ }
+
+ private void writeBundle(BundleEntry be, Writer out) {
+ try {
+ out.write("<li>");
+
+ if (!be.isInstalled()) {
+ out.write("I ");
+ } else if (be.isUpdated()) {
+ out.write("U ");
+ } else {
+ out.write("N ");
+ }
+
+ out.write(be.getSymbolicName() + " v" + be.getVersion());
+ out.write("</li>");
+ } catch (IOException e) {
+ log.error("This really shouldn't happen", e);
+ }
+ }
+}