| /* |
| * 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.installer.core.impl.console; |
| |
| import java.io.IOException; |
| import java.io.PrintWriter; |
| import java.io.StringWriter; |
| import java.net.URL; |
| import java.text.DateFormat; |
| import java.text.SimpleDateFormat; |
| import java.util.Collection; |
| import java.util.Date; |
| import java.util.Iterator; |
| |
| import javax.servlet.GenericServlet; |
| import javax.servlet.ServletRequest; |
| import javax.servlet.ServletResponse; |
| |
| import org.apache.sling.installer.api.InstallableResource; |
| import org.apache.sling.installer.api.info.InfoProvider; |
| import org.apache.sling.installer.api.info.InstallationState; |
| import org.apache.sling.installer.api.info.Resource; |
| import org.apache.sling.installer.api.info.ResourceGroup; |
| import org.apache.sling.installer.api.tasks.RegisteredResource; |
| import org.apache.sling.installer.api.tasks.ResourceState; |
| import org.apache.sling.installer.api.tasks.TaskResource; |
| import org.osgi.framework.Constants; |
| import org.osgi.service.component.annotations.Component; |
| import org.osgi.service.component.annotations.Reference; |
| import org.osgi.service.component.annotations.ReferencePolicyOption; |
| |
| |
| @Component(service=javax.servlet.Servlet.class, |
| property = { |
| Constants.SERVICE_VENDOR + "=The Apache Software Foundation", |
| Constants.SERVICE_DESCRIPTION + "=Apache Sling OSGi Installer Web Console Plugin", |
| "felix.webconsole.label=" + OsgiInstallerWebConsolePlugin.LABEL, |
| "felix.webconsole.title=OSGi Installer", |
| "felix.webconsole.category=OSGi", |
| "felix.webconsole.configprinter.modes=zip", |
| "felix.webconsole.configprinter.modes=txt", |
| "felix.webconsole.css=" + OsgiInstallerWebConsolePlugin.RES_LOC + "/list.css" |
| }) |
| @SuppressWarnings("serial") |
| public class OsgiInstallerWebConsolePlugin extends GenericServlet { |
| |
| public static final String LABEL = "osgi-installer"; |
| protected static final String RES_LOC = LABEL + "/res/ui"; |
| |
| |
| @Reference(policyOption=ReferencePolicyOption.GREEDY) |
| private InfoProvider installer; |
| |
| private String getType(final RegisteredResource rsrc) { |
| final String type = rsrc.getType(); |
| if ( type.equals(InstallableResource.TYPE_BUNDLE) ) { |
| return "Bundles"; |
| } else if ( type.equals(InstallableResource.TYPE_CONFIG) ) { |
| return "Configurations"; |
| } else if ( type.equals(InstallableResource.TYPE_FILE) ) { |
| return "Files"; |
| } else if ( type.equals(InstallableResource.TYPE_PROPERTIES) ) { |
| return "Properties"; |
| } |
| return type; |
| } |
| |
| private String getEntityId(final RegisteredResource rsrc, String alias) { |
| String id = rsrc.getEntityId(); |
| final int pos = id.indexOf(':'); |
| if ( pos != -1 ) { |
| id = id.substring(pos + 1); |
| } |
| return (alias == null ? id : id + '\n' + alias); |
| } |
| |
| private String getURL(final Resource rsrc) { |
| if ( rsrc.getVersion() != null ) { |
| return rsrc.getURL() + " (" + rsrc.getVersion() + ")"; |
| } |
| return rsrc.getURL(); |
| } |
| |
| private String getState(final Resource rsrc) { |
| String stateInfo = rsrc.getState().toString(); |
| // INSTALLED state has some variants |
| if ( rsrc.getState() == ResourceState.INSTALLED) { |
| if (rsrc.getAttribute(TaskResource.ATTR_INSTALL_EXCLUDED) != null ) { |
| stateInfo = "EXCLUDED"; |
| } |
| if (rsrc.getAttribute(TaskResource.ATTR_INSTALL_INFO) != null) { |
| stateInfo = stateInfo + "(*)"; |
| } |
| } |
| return stateInfo; |
| } |
| |
| private String getError(final Resource rsrc) { |
| String error = rsrc.getError(); |
| return error != null ? error : ""; |
| } |
| |
| private String getInfo(final RegisteredResource rsrc) { |
| return rsrc.getDigest() + '/' + String.valueOf(rsrc.getPriority()); |
| } |
| |
| /** Default date format used. */ |
| private final DateFormat dateFormat = new SimpleDateFormat("HH:mm:ss:SSS yyyy-MMM-dd"); |
| |
| /** |
| * Format a date |
| */ |
| private synchronized String formatDate(final long time) { |
| if ( time == -1 ) { |
| return "-"; |
| } |
| final Date d = new Date(time); |
| return dateFormat.format(d); |
| } |
| |
| @Override |
| public void service(final ServletRequest req, final ServletResponse res) |
| throws IOException { |
| StringWriter bufferedWriter = new StringWriter(); |
| final PrintWriter bufferedPw = new PrintWriter(bufferedWriter); |
| |
| PrintWriter pw = res.getWriter(); |
| final InstallationState state = this.installer.getInstallationState(); |
| pw.print("<p class='statline ui-state-highlight'>Apache Sling OSGi Installer"); |
| if ( state.getActiveResources().size() == 0 && state.getInstalledResources().size() == 0 && state.getUntransformedResources().size() == 0 ) { |
| pw.print(" - no resources registered."); |
| } |
| |
| pw.print("</p>"); |
| pw.println("<ul class=list>"); |
| pw.println("<li>Active Resources"); |
| pw.println("<ul>"); |
| |
| String rt = null; |
| for (final ResourceGroup group : state.getActiveResources()) { |
| final Resource toActivate = group.getResources().get(0); |
| if ( !toActivate.getType().equals(rt) ) { |
| if ( rt != null ) { |
| bufferedPw.println("</tbody></table>"); |
| } |
| String anchor = "active-" + getType(toActivate); |
| pw.println("<li><a href='#" + anchor + "'>" + getType(toActivate) + "</a></li>"); |
| bufferedPw.println("<div id='" + anchor + "' class='ui-widget-header ui-corner-top buttonGroup' style='height: 15px;'>"); |
| bufferedPw.printf("<span style='float: left; margin-left: 1em;'>Active Resources - %s</span>", getType(toActivate)); |
| bufferedPw.println("</div>"); |
| bufferedPw.println("<table class='nicetable'><tbody>"); |
| bufferedPw.printf("<tr><th>Entity ID</th><th>Digest/Priority</th><th>URL (Version)</th><th>State</th><th>Error</th></tr>"); |
| rt = toActivate.getType(); |
| } |
| bufferedPw.printf("<tr><td>%s</td><td>%s</td><td>%s</td><td>%s</td><td>%s</td></tr>", |
| getEntityId(toActivate, group.getAlias()), |
| getInfo(toActivate), |
| getURL(toActivate), |
| toActivate.getState(), |
| getError(toActivate)); |
| } |
| if ( rt != null ) { |
| bufferedPw.println("</tbody></table>"); |
| } else { |
| pw.println("<li>none</li>"); |
| } |
| rt = null; |
| |
| pw.println("</ul></li>"); |
| pw.println("<li>Processed Resources"); |
| pw.println("<ul>"); |
| |
| for(final ResourceGroup group : state.getInstalledResources()) { |
| final Collection<Resource> resources = group.getResources(); |
| if (resources.size() > 0) { |
| final Iterator<Resource> iter = resources.iterator(); |
| final Resource first = iter.next(); |
| if ( !first.getType().equals(rt) ) { |
| if ( rt != null ) { |
| bufferedPw.println("</tbody></table>"); |
| } |
| String anchor = "processed-" + getType(first); |
| pw.println("<li><a href='#" + anchor + "'>" + getType(first) + "</a></li>"); |
| |
| bufferedPw.println("<div id='" + anchor + "' class='ui-widget-header ui-corner-top buttonGroup' style='height: 15px;'>"); |
| bufferedPw.printf("<span style='float: left; margin-left: 1em;'>Processed Resources - %s</span>", getType(first)); |
| bufferedPw.println("</div>"); |
| bufferedPw.println("<table class='nicetable'><tbody>"); |
| bufferedPw.printf("<tr><th>Entity ID</th><th>Digest/Priority</th><th>URL (Version)</th><th>State</th><th>Error</th></tr>"); |
| rt = first.getType(); |
| } |
| bufferedPw.print("<tr><td>"); |
| bufferedPw.print(getEntityId(first, group.getAlias())); |
| bufferedPw.print("</td><td>"); |
| bufferedPw.print(getInfo(first)); |
| bufferedPw.print("</td><td>"); |
| bufferedPw.print(getURL(first)); |
| bufferedPw.print("</td><td>"); |
| bufferedPw.print(getState(first)); |
| if ( first.getState() == ResourceState.INSTALLED ) { |
| final long lastChange = first.getLastChange(); |
| if ( lastChange > 0 ) { |
| bufferedPw.print("<br/>"); |
| bufferedPw.print(formatDate(lastChange)); |
| } |
| } |
| bufferedPw.print("</td><td>"); |
| bufferedPw.print(getError(first)); |
| bufferedPw.print("</td></tr>"); |
| if ( first.getAttribute(TaskResource.ATTR_INSTALL_EXCLUDED) != null ) { |
| bufferedPw.printf("<tr><td></td><td colspan='2'>%s</td><td></td><td></td></tr>", |
| first.getAttribute(TaskResource.ATTR_INSTALL_EXCLUDED)); |
| } |
| if ( first.getAttribute(TaskResource.ATTR_INSTALL_INFO) != null ) { |
| bufferedPw.printf("<tr><td></td><td colspan='2'>%s</td><td></td><td></td></tr>", |
| first.getAttribute(TaskResource.ATTR_INSTALL_INFO)); |
| |
| } |
| while ( iter.hasNext() ) { |
| final Resource resource = iter.next(); |
| bufferedPw.printf("<tr><td></td><td>%s</td><td>%s</td><td>%s</td><td>%s</td></tr>", |
| getInfo(resource), |
| getURL(resource), |
| resource.getState(), |
| getError(resource)); |
| } |
| } |
| } |
| if ( rt != null ) { |
| bufferedPw.println("</tbody></table>"); |
| } else { |
| pw.println("<li>none</li>"); |
| } |
| |
| pw.println("</ul></li>"); |
| pw.println("<li>Untransformed Resources"); |
| pw.println("<ul>"); |
| |
| rt = null; |
| for(final RegisteredResource registeredResource : state.getUntransformedResources()) { |
| if ( !registeredResource.getType().equals(rt) ) { |
| if ( rt != null ) { |
| bufferedPw.println("</tbody></table>"); |
| } |
| String anchor = "untransformed-" + getType(registeredResource); |
| pw.println("<li><a href='#" + anchor + "'>" + getType(registeredResource) + "</a></li>"); |
| |
| bufferedPw.println("<div id='" + anchor + "' class='ui-widget-header ui-corner-top buttonGroup' style='height: 15px;'>"); |
| bufferedPw.printf("<span style='float: left; margin-left: 1em;'>Untransformed Resources - %s</span>", getType(registeredResource)); |
| bufferedPw.println("</div>"); |
| bufferedPw.println("<table class='nicetable'><tbody>"); |
| bufferedPw.printf("<tr><th>Digest/Priority</th><th>URL</th></tr>"); |
| |
| rt = registeredResource.getType(); |
| } |
| bufferedPw.printf("<tr><td>%s</td><td>%s</td></tr>", |
| getInfo(registeredResource), |
| registeredResource.getURL()); |
| } |
| if ( rt != null ) { |
| bufferedPw.println("</tbody></table>"); |
| } else { |
| pw.println("<li>none</li>"); |
| } |
| |
| pw.println("</ul></li>"); |
| pw.println("</ul>"); |
| pw.print(bufferedWriter.toString()); |
| } |
| |
| /** |
| * Method for the configuration printer. |
| */ |
| public void printConfiguration(final PrintWriter pw, final String mode) { |
| if ( !"zip".equals(mode) && !"txt".equals(mode) ) { |
| return; |
| } |
| pw.println("Apache Sling OSGi Installer"); |
| pw.println("==========================="); |
| final InstallationState state = this.installer.getInstallationState(); |
| pw.println("Active Resources"); |
| pw.println("----------------"); |
| String rt = null; |
| for(final ResourceGroup group : state.getActiveResources()) { |
| final Resource toActivate = group.getResources().get(0); |
| if ( !toActivate.getType().equals(rt) ) { |
| pw.printf("%s:%n", getType(toActivate)); |
| rt = toActivate.getType(); |
| } |
| pw.printf("- %s: %s, %s, %s, %s%n", |
| getEntityId(toActivate, group.getAlias()), |
| getInfo(toActivate), |
| getURL(toActivate), |
| toActivate.getState(), |
| getError(toActivate)); |
| } |
| pw.println(); |
| |
| pw.println("Processed Resources"); |
| pw.println("-------------------"); |
| rt = null; |
| for(final ResourceGroup group : state.getInstalledResources()) { |
| final Collection<Resource> resources = group.getResources(); |
| if (resources.size() > 0) { |
| final Iterator<Resource> iter = resources.iterator(); |
| final Resource first = iter.next(); |
| if ( !first.getType().equals(rt) ) { |
| pw.printf("%s:%n", getType(first)); |
| rt = first.getType(); |
| } |
| pw.printf("* %s: %s, %s, %s, %s%n", |
| getEntityId(first, group.getAlias()), |
| getInfo(first), |
| getURL(first), |
| getState(first), |
| getError(first)); |
| if ( first.getAttribute(TaskResource.ATTR_INSTALL_EXCLUDED) != null ) { |
| pw.printf(" : %s", |
| first.getAttribute(TaskResource.ATTR_INSTALL_EXCLUDED)); |
| } |
| if ( first.getAttribute(TaskResource.ATTR_INSTALL_INFO) != null ) { |
| pw.printf(" : %s", |
| first.getAttribute(TaskResource.ATTR_INSTALL_INFO)); |
| |
| } |
| while ( iter.hasNext() ) { |
| final Resource resource = iter.next(); |
| pw.printf(" - %s, %s, %s, %s%n", |
| getInfo(resource), |
| getURL(resource), |
| resource.getState(), |
| getError(resource)); |
| } |
| } |
| } |
| pw.println(); |
| |
| pw.println("Untransformed Resources"); |
| pw.println("-----------------------"); |
| rt = null; |
| for(final RegisteredResource registeredResource : state.getUntransformedResources()) { |
| if ( !registeredResource.getType().equals(rt) ) { |
| pw.printf("%s:%n", getType(registeredResource)); |
| rt = registeredResource.getType(); |
| } |
| pw.printf("- %s, %s%n", |
| getInfo(registeredResource), |
| registeredResource.getURL()); |
| } |
| } |
| |
| /** |
| * Method to retrieve static resources from this bundle. |
| */ |
| @SuppressWarnings("unused") |
| private URL getResource(final String path) { |
| if (path.startsWith("/" + RES_LOC)) { |
| return this.getClass().getResource(path.substring(LABEL.length()+1)); |
| } |
| return null; |
| } |
| } |
