source: trunk/www/admin/extensions/details.jsp @ 6259

<%-- $Id:details.jsp 4187 2008-03-20 11:15:25Z nicklas $
  ------------------------------------------------------------------
  Copyright (C) 2006 Nicklas Nordborg

  This file is part of BASE - BioArray Software Environment.
  Available at http://base.thep.lu.se/

  BASE is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License
  as published by the Free Software Foundation; either version 3
  of the License, or (at your option) any later version.

  BASE is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with BASE. If not, see <http://www.gnu.org/licenses/>.
  ------------------------------------------------------------------

  @author Nicklas
  @version 2.0
--%>
<%@ page pageEncoding="UTF-8" session="false"
  import="net.sf.basedb.core.SessionControl"
  import="net.sf.basedb.core.DbControl"
  import="net.sf.basedb.core.Client"
  import="net.sf.basedb.core.PluginDefinition"
  import="net.sf.basedb.core.Item"
  import="net.sf.basedb.core.Permission"
  import="net.sf.basedb.clients.web.Base"
  import="net.sf.basedb.clients.web.util.HTML"
  import="net.sf.basedb.util.Values"
  import="net.sf.basedb.core.ItemNotFoundException"
  import="net.sf.basedb.util.error.ThrowableUtil"
  import="net.sf.basedb.util.extensions.ExtensionPoint"
  import="net.sf.basedb.util.extensions.Extension"
  import="net.sf.basedb.util.extensions.ActionFactory"
  import="net.sf.basedb.util.extensions.RendererFactory"
  import="net.sf.basedb.util.extensions.AboutBean"
  import="net.sf.basedb.util.extensions.manager.ExtensionsFile"
  import="net.sf.basedb.util.extensions.manager.ExtensionPointKey"
  import="net.sf.basedb.util.extensions.manager.ExtensionKey"
  import="net.sf.basedb.util.extensions.manager.PluginInfoKey"
  import="net.sf.basedb.util.extensions.manager.FactoryParametersKey"
  import="net.sf.basedb.util.extensions.manager.ProcessResults"
  import="net.sf.basedb.util.extensions.manager.ProcessResults.FileResults"
  import="net.sf.basedb.util.extensions.xml.PluginInfo"
  import="net.sf.basedb.clients.web.extensions.ExtensionsControl"
  import="net.sf.basedb.clients.web.formatter.FormatterFactory"
  import="net.sf.basedb.util.formatter.Formatter"
  import="net.sf.basedb.core.plugin.About"
  import="java.util.List"
  import="java.util.Date"
  import="java.util.Iterator"
%>
<%@ taglib prefix="base" uri="/WEB-INF/base.tld" %>
<%@ taglib prefix="tbl" uri="/WEB-INF/table.tld" %>
<%!
String displayFactory(ExtensionsFile file, Object factory)
{
  if (factory == null)
  {
    return "<i>- none -</i>";
  }
  String text = factory.getClass().getName();
  String parameters = file == null ? null : file.getMetadata(new FactoryParametersKey(factory));
  if (parameters != null)
  {
    text += "<pre>" + HTML.encodeTags(parameters) + "</pre>";
  }
  return text;
}
%>
<%
final SessionControl sc = Base.getExistingSessionControl(pageContext, true);
final String ID = sc.getId();
final float scale = Base.getScale(sc);
String extensionId = request.getParameter("extensionId");
String extensionPointId = request.getParameter("extensionPointId");
String fileuri = request.getParameter("fileuri");

DbControl dc = sc.newDbControl();
try
{
  final ExtensionsControl ec = ExtensionsControl.get(dc);
  final boolean writePermission = ec.hasPermission(Permission.WRITE);
  
  Extension<?> ext = null;
  ExtensionPoint<?> ep = null;
  ExtensionsFile file = null;
  ExtensionsFile extFile = null;
  ExtensionsFile epFile = null;

  if (fileuri != null)
  {
    file = ec.getFile(fileuri);
    if (file == null)
    {
      throw new ItemNotFoundException("ExtensionsFile[uri=" + fileuri + "]");
    }
  }
  
  if (extensionId != null)
  {
    ext = ec.getExtension(extensionId);
    if (ext == null)
    {
      throw new ItemNotFoundException("Extension[id=" + extensionId + "]");
    }
    extensionPointId = ext.getExtends();
    extFile = ec.getFileByObjectKey(new ExtensionKey(extensionId));
  }
  
  if (extensionPointId != null)
  {
    ep = ec.getExtensionPoint(extensionPointId);
    if (ep == null)
    {
      throw new ItemNotFoundException("ExtensionPoint[id=" + extensionPointId + "]");
    }
    epFile = ec.getFileByObjectKey(new ExtensionPointKey(extensionPointId));
  }
%>
<base:page title="" type="iframe">
  <base:head scripts="newjoust.js,table.js,dragdrop.js,~details.js" styles="newjoust.css,table.css,toolbar.css" />
  <base:body>

    <div class="absolutefull auto-init" data-auto-init="drag-support">

    <tbl:toolbar subclass="bottomborder">
    <tbl:button
      id="btnInstall"
      title="Install/uninstall&hellip;"
      image="new_wizard.png"
      tooltip="Install and uninstall extensions and plug-ins"
      disabled="<%=!writePermission%>"
    />
    <%
    if (ext != null)
    {
      boolean isEnabled = ec.isEnabled(ext);
      boolean hasRegistrationError = extFile != null && extFile.hasError();
      boolean allow = writePermission && !hasRegistrationError;
      %>
      <tbl:button 
        id="btnToggleExtension"
        data-extension-id="<%=extensionId%>"
        data-is-enabled="<%=isEnabled ? "1" : "0"%>"
        title="<%=isEnabled ? "Disable" : "Enable" %>" 
        image="<%=allow ? "joust/extension.png" : "joust/extensiondisabled.png" %>"
        tooltip="Disable/enable this extension"
        disabled="<%=!allow%>"
      />
      <tbl:button
        image="help.png"
        subclass="auto-init"
        data-auto-init="help"
        data-help-id="extensions.details.extension"
        title="Help&hellip;"
        tooltip="Get help about this page"
      />
      <%
    }
    else if (ep != null)
    {
      boolean isEnabled = ec.isEnabled(ep);
      boolean hasRegistrationError = epFile != null && epFile.hasError();
      boolean allow = writePermission && !hasRegistrationError;
      %>
      <tbl:button 
        id="btnToggleExtensionPoint"
        data-extension-point-id="<%=extensionPointId%>"
        data-is-enabled="<%=isEnabled ? "1" : "0"%>"
        title="<%=isEnabled ? "Disable" : "Enable" %>" 
        image="<%=allow ? "joust/extensionpoint.png" : "joust/extensionpointdisabled.png" %>"
        tooltip="Disable this extension point"
        disabled="<%=!allow%>"
      />
      <tbl:button
        image="help.png"
        subclass="auto-init"
        data-auto-init="help"
        data-help-id="extensions.details.extensionspoint"
        title="Help&hellip;"
        tooltip="Get help about this page"
      />
      <%
    }
    else if (file != null)
    {
      boolean hasRegistrationError = file.hasError();
      boolean allow = writePermission && !hasRegistrationError;
      %>
      <tbl:button
        id="btnEnableFile" 
        data-file-name="<%=HTML.encodeTags(file.getName())%>"
        data-file-uri="<%=HTML.encodeTags(fileuri)%>"
        data-enable="1"
        title="Enable all" 
        image="<%=allow ? "joust/extension.png" : "joust/extensiondisabled.png" %>"
        tooltip="Enable all extensions in this file"
        disabled="<%=!allow%>"
      />
      <tbl:button 
        id="btnDisableFile" 
        data-file-name="<%=HTML.encodeTags(file.getName())%>"
        data-file-uri="<%=HTML.encodeTags(fileuri)%>"
        data-enable="0"
        title="Disable all" 
        image="<%=allow ? "joust/extension.png" : "joust/extensiondisabled.png" %>"
        tooltip="Disable all extensions in this file"
        disabled="<%=!allow%>"
      />
      <%
    }
    else
    {
      %>
      <tbl:button
        image="help.png"
        subclass="auto-init"
        data-auto-init="help"
        data-help-id="extensions.details.main"
        title="Help&hellip;"
        tooltip="Get help about this page"
      />
      <%
    }
    %>
    </tbl:toolbar>

    <div class="bottomborder">
      <table class="fullform outlined">
      <%
      if (ext != null)
      {
        About about = ext.getAbout();
        if (about == null) about = new AboutBean();
        Throwable error = ec.getLastExtensionError(ext.getId());
        %>
        <tbody>
        <%
        if (error != null)
        {
          %>
          <tr>
            <th></th>
            <td>
            <div class="messagecontainer error">
              <base:icon image="error.png"
                subclass="auto-init link"
                data-auto-init="toggle-stacktrace"
                data-stacktrace-id="<%="stacktrace." + ext.getId()%>"
                style="float: left; margin-right: 5px;"
                tooltip="Error - click to show full stack trace"
              /><%=error.getMessage() %>
              <div id="stacktrace.<%=ext.getId()%>"
                class="stacktrace"
                style="display: none;"
                ><%=ThrowableUtil.stackTraceToString(error)%></div>
            </div>
            </td>
          </tr>
          <%
        }
        %>
        <tr>
          <th>ID</th>
          <td><%=ext.getId()%></td>
        </tr>
        <tr>
          <th>Name</th>
          <td><%=HTML.encodeTags(about.getName())%></td>
        </tr>
        <tr>
          <th>File</th>
          <td>
            <a class="auto-init" data-auto-init="show-file" data-file-uri="<%=HTML.encodeTags(extFile.getName()) %>"
            ><%=extFile.getName()%></a> 
            (<%=extFile.checkModified() ? "Modified" : "Up to date" %>;
            <%=extFile.hasError() ? "Error" : "Ok" %>)
          </td>
        </tr>
        <tr>
          <th>Version</th>
          <td><%=HTML.encodeTags(about.getVersion())%></td>
        </tr>
        <tr class="big">
          <th>Description</th>
          <td><%=HTML.niceFormat(about.getDescription())%></td>
        </tr>
        <tr>
          <th>Copyright</th>
          <td><%=HTML.encodeTags(about.getCopyright())%></td>
        </tr>
        <tr>
          <th>Contact</th>
          <td><%=HTML.encodeTags(about.getContact())%></td>
        </tr>
        <tr>
          <th>Email</th>
          <td><%=HTML.scanForLinks(about.getEmail(), HTML.LINK_EMAIL, "_blank")%></td>
        </tr>
        <tr>
          <th>Url</th>
          <td><%=HTML.scanForLinks(about.getUrl(), HTML.LINK_URL, "_blank")%></td>
        </tr>
        <tr class="big">
          <th>Action factory</th>
          <td><%=displayFactory(extFile, ext.getActionFactory())%></td>
        </tr>
        <tr class="big">
          <th>Renderer factory</th>
          <td><%=displayFactory(extFile, ext.getRendererFactory())%></td>
        </tr>
        </tbody>
        <%
      }
      if (ep != null)
      {
        if (ext != null)
        {
          %>
          <tbody class="sectionheader">
            <tr>
              <th colspan="2">Extension point</th>
            </tr>
          </tbody>
          <%
        }
        %>
        <tbody>
        <%
        Throwable error = ec.getLastExtensionPointError(ep.getId());
        if (error != null)
        {
          %>
          <tr>
            <th></th>
            <td>
            <div class="messagecontainer error">
              <base:icon image="error.png" 
                subclass="auto-init link"
                data-auto-init="toggle-stacktrace"
                data-stacktrace-id="<%="stacktrace." + ep.getId()%>"
                style="float: left; margin-right: 5px;"
                tooltip="Error - click to show full stack trace"
              /><%=error.getMessage() %>
              <div id="stacktrace.<%=ep.getId()%>"
                class="stacktrace"
                style="display: none;"
                ><%=ThrowableUtil.stackTraceToString(error)%></div>
            </div>
            </td>
          </tr>
          <%
        }
        %>
        <tr>
          <th>ID</th>
          <td><%=ep.getId()%></td>
        </tr>
        <tr>
          <th>Name</th>
          <td><%=HTML.encodeTags(ep.getName())%></td>
        </tr>
        <tr>
          <th>File</th>
          <td>
            <%
            if (epFile != null)
            {
              %>
              <a class="auto-init" data-auto-init="show-file" data-file-uri="<%=HTML.encodeTags(epFile.getName()) %>"
              ><%=epFile.getName()%></a> 
              (<%=epFile.checkModified() ? "Modified" : "Up to date" %>;
              <%=epFile.hasError() ? "Error" : "Ok" %>)
              <%
            }
            %>
          </td>
        </tr>
        <tr class="big">
          <th>Description</th>
          <td><%=HTML.niceFormat(ep.getDescription())%></td>
        </tr>
        <tr>
          <th>Action class</th>
          <td><%=ep.getActionClass().getName()%></td>
        </tr>
        <tr class="big">
          <th>Renderer factory</th>
          <td><%=displayFactory(epFile, ep.getRendererFactory())%></td>
        </tr>
        <tr class="big">
          <th>Error handler factory</th>
          <td><%=displayFactory(epFile, ep.getErrorHandlerFactory() == null ? 
              ec.getDefaultErrorHandlerFactory() : ep.getErrorHandlerFactory())%></td>
        </tr>
        </tbody>
        <%
      }
      if (file != null)
      {
        About about = file.getAbout();
        if (about == null) about = new AboutBean();
        %>
        <tbody>
        <tr>
          <th>File</th>
          <td><%=file.getName()%></td>
        </tr>
        <tr>
          <th>Type</th>
          <td><%=file.isJar() ? "JAR file" : "XML file"%></td>
        </tr>
        <tr>
          <th>Up to date</th>
          <td><%=file.checkModified() ? "No" : "Yes"%></td>
        </tr>
        <tr class="big">
          <th>Errors</th>
          <td>
            <%
            if (file.hasError())
            {
              ProcessResults results = ec.getLastScanResults();
              FileResults fileResults = results.getResults(file);
              List<String> messages = fileResults.getMessages();
              Throwable validationError = file.getValidationError();
              %>
              <div class="messagecontainer error">
              <ul style="padding-left: 20px; margin: 0px; text-align: left;">
              <%
              if (validationError != null)
              {
                %>
                <li><%=validationError.getClass().getSimpleName()%>: <%=HTML.niceFormat(validationError.getMessage())%>
                <%
              }
              for (String msg : messages)
              {
                %>
                <li><%=HTML.niceFormat(msg)%>
                <%
              }
              %>
              </ul>
              </div>
              <%
            }
            else
            {
              %>
              No
              <%
            }
            %>
          </td>
        </tr>
        <tr>
          <th>Name</th>
          <td><%=HTML.encodeTags(about.getName())%></td>
        </tr>
        <tr>
          <th>Version</th>
          <td><%=HTML.encodeTags(about.getVersion())%></td>
        </tr>
        <tr class="big">
          <th>Description</th>
          <td><%=HTML.niceFormat(about.getDescription())%></td>
        </tr>
        <tr>
          <th>Copyright</th>
          <td><%=HTML.encodeTags(about.getCopyright())%></td>
        </tr>
        <tr>
          <th>Contact</th>
          <td><%=HTML.encodeTags(about.getContact())%></td>
        </tr>
        <tr>
          <th>Email</th>
          <td><%=HTML.scanForLinks(about.getEmail(), HTML.LINK_EMAIL, "_blank")%></td>
        </tr>
        <tr>
          <th>Url</th>
          <td><%=HTML.scanForLinks(about.getUrl(), HTML.LINK_URL, "_blank")%></td>
        </tr>
        </tbody>
        <%
      }
      %>
      <%
      if (ext == null && ep == null && file == null)
      {
        ProcessResults results = ec.getLastScanResults();
        Formatter dateTimeFormatter = FormatterFactory.getDateTimeFormatter(sc);
        %>
        <tbody>
        <tr>
          <th>Last installation</th>
          <td><%=results.hasError() ? "Failed": "Successful" %></td>
        </tr>
        <tr>
          <th class="subprompt">- ended</th>
          <td><%=dateTimeFormatter.format(new Date(results.getEndTime())) %></td>
        </tr>
        <tr class="big">
          <th class="subprompt">- summary</th>
          <td>
          <%=HTML.niceFormat(results.getSummary())%></td>
        </tr>
        <tr>
          <th class="subprompt"></th>
          <td>
            <table><tr><td>
            <base:button 
              id="btnScanResults"
              image="bullet.png" 
              title="More details&hellip;"
              tooltip="Display detailed information about the last scan"
            />
            </td></tr></table>
          </td>
        </tr>
        </tbody>
        <%
      }
      %>
    </table>
    </div>
    </div>
    </base:body>
  </base:page>
  <%
}
finally
{
  if (dc != null) dc.close();
}
%>