source: trunk/www/admin/plugintypes/view_plugintype.jsp @ 5425

<%-- $Id: view_plugintype.jsp 5425 2010-09-23 13:30:07Z nicklas $
  ------------------------------------------------------------------
  Copyright (C) 2006 Jari Häkkinen, Nicklas Nordborg, Martin Svensson

  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 session="false"
  import="net.sf.basedb.core.SessionControl"
  import="net.sf.basedb.core.DbControl"
  import="net.sf.basedb.core.SystemItems"
  import="net.sf.basedb.core.Item"
  import="net.sf.basedb.core.Include"
  import="net.sf.basedb.core.ItemContext"
  import="net.sf.basedb.core.Permission"
  import="net.sf.basedb.core.PluginType"
  import="net.sf.basedb.core.ItemQuery"
  import="net.sf.basedb.core.ItemResultList"
  import="net.sf.basedb.core.PermissionDeniedException"
  import="net.sf.basedb.core.PluginDefinition"
  import="net.sf.basedb.core.plugin.GuiContext"
  import="net.sf.basedb.core.plugin.Plugin"
  import="net.sf.basedb.core.query.Restrictions"
  import="net.sf.basedb.core.query.Hql"
  import="net.sf.basedb.core.query.Orders"
  import="net.sf.basedb.clients.web.Base"
  import="net.sf.basedb.clients.web.PermissionUtil"
  import="net.sf.basedb.clients.web.util.HTML"
  import="net.sf.basedb.util.Values"
  import="net.sf.basedb.clients.web.util.NameablePluginAdaptor"
  import="net.sf.basedb.util.formatter.Formatter"
  import="net.sf.basedb.clients.web.formatter.FormatterFactory"
  import="net.sf.basedb.clients.web.extensions.ExtensionsControl"
  import="net.sf.basedb.clients.web.extensions.JspContext"
  import="net.sf.basedb.clients.web.extensions.renderer.PrefixSuffixRenderer"
  import="net.sf.basedb.clients.web.extensions.toolbar.ToolbarUtil"
  import="net.sf.basedb.util.extensions.ExtensionsInvoker"
  import="java.util.Date"
  import="java.util.Map"
%>
<%@ taglib prefix="base" uri="/WEB-INF/base.tld" %>
<%@ taglib prefix="tbl" uri="/WEB-INF/table.tld" %>
<%@ taglib prefix="t" uri="/WEB-INF/tab.tld" %>
<%@ taglib prefix="p" uri="/WEB-INF/path.tld" %>
<%@ taglib prefix="ext" uri="/WEB-INF/extensions.tld" %>
<%!
  private static final Item itemType = Item.PLUGINTYPE;
  private static final GuiContext guiContext = new GuiContext(itemType, GuiContext.Type.ITEM);
%>
<%
final SessionControl sc = Base.getExistingSessionControl(pageContext, true);
final String ID = sc.getId();
final ItemContext cc = Base.getAndSetCurrentContext(sc, itemType, null, null);
final int itemId = cc.getId();
final float scale = Base.getScale(sc);
final DbControl dc = sc.newDbControl();
try
{
  Formatter<Date> dateFormatter = FormatterFactory.getDateFormatter(sc);
  Map<Plugin.MainType, Integer> pluginCount = PluginDefinition.countPlugins(dc, guiContext);

  String title = null;
  PluginType pluginType = PluginType.getById(dc, itemId);
  
  final boolean writePermission = pluginType.hasPermission(Permission.WRITE);
  final boolean deletePermission = pluginType.hasPermission(Permission.DELETE);
  final boolean isRemoved = pluginType.isRemoved();
  final boolean isUsed = isRemoved && pluginType.isUsed();
  final boolean deletePermanentlyPermission = deletePermission && !isUsed;
  JspContext jspContext = ExtensionsControl.createContext(dc, pageContext, guiContext, pluginType);
  ExtensionsInvoker invoker = ToolbarUtil.useExtensions(jspContext);
  %>
  <base:page title="<%=title%>">
  <base:head scripts="tabcontrol.js" styles="toolbar.css,headertabcontrol.css,path.css,table.css">
    <ext:scripts context="<%=jspContext%>" />
    <ext:stylesheets context="<%=jspContext%>" />
    <script language="JavaScript">
    function editItem()
    {
      Main.viewOrEditItem('<%=ID%>', '<%=itemType.name()%>', <%=itemId%>, true);
    }
    function deleteItem()
    {
      location.replace('index.jsp?ID=<%=ID%>&cmd=DeleteItem&item_id=<%=itemId%>');
    }
    function restoreItem()
    {
      location.replace('index.jsp?ID=<%=ID%>&cmd=RestoreItem&item_id=<%=itemId%>');
    }
    function deleteItemPermanently()
    {
      Main.deleteItemPermanently('<%=ID%>', true, '<%=itemType.name()%>', <%=itemId%>, '&callback=itemDeleted');
    }
    function itemDeleted()
    {
      Main.listItems('<%=ID%>', '<%=itemType.name()%>');
    }
    function showUsingItems()
    {
      Main.showUsingItems('<%=ID%>', '<%=itemType.name()%>', <%=itemId%>);
    }
    function runPlugin(cmd)
    {
      Main.openPopup('index.jsp?ID=<%=ID%>&cmd='+cmd+'&item_id=<%=itemId%>', 'RunPlugin'+cmd, 740, 540);
    }
    </script>
  </base:head>
  <base:body>
    <p>
    <p:path>
      <p:pathelement title="Plugin types" href="<%="index.jsp?ID="+ID%>" />
      <p:pathelement title="<%=HTML.encodeTags(pluginType.getName())%>" />
    </p:path>
    
    <t:tabcontrol id="main" active="properties">
    <t:tab id="properties" title="Properties">
    
    <tbl:toolbar
      >
      <tbl:button 
        disabled="<%=writePermission ? false : true%>" 
        image="<%=writePermission ? "edit.gif" : "edit_disabled.gif"%>" 
        onclick="editItem()" 
        title="Edit&hellip;" 
        tooltip="<%=writePermission ? "Edit this plugin type" : "You do not have permission to edit this plugin type"%>" 
      />
      <tbl:button 
        disabled="<%=deletePermission ? false : true%>" 
        image="<%=deletePermission ? "delete.gif" : "delete_disabled.gif"%>" 
        onclick="deleteItem()" 
        title="Delete"
        visible="<%=!pluginType.isRemoved()%>"
        tooltip="<%=deletePermission ? "Delete this plugin type" : "You do not have permission to delete this plugin type"%>" 
      />
      <tbl:button 
        disabled="<%=writePermission ? false : true%>" 
        image="<%=writePermission ? "restore.gif" : "restore_disabled.gif"%>" 
        onclick="restoreItem()" 
        title="Restore"
        visible="<%=pluginType.isRemoved()%>"
        tooltip="<%=writePermission ? "Restore this plugin type" : "You do not have permission to restore this plugin type"%>" 
      />
      <tbl:button 
        image="import.gif" 
        onclick="runPlugin('ImportItem')" 
        title="Import&hellip;" 
        tooltip="Import data" 
        visible="<%=pluginCount.containsKey(Plugin.MainType.IMPORT)%>"
      />
      <tbl:button 
        image="export.gif" 
        onclick="runPlugin('ExportItem')" 
        title="Export&hellip;" 
        tooltip="Export data" 
        visible="<%=pluginCount.containsKey(Plugin.MainType.EXPORT)%>"
      />
      <tbl:button 
        image="runplugin.gif" 
        onclick="runPlugin('RunPlugin')" 
        title="Run plugin&hellip;" 
        tooltip="Run a plugin" 
        visible="<%=pluginCount.containsKey(Plugin.MainType.OTHER)%>"
      />
      <ext:render extensions="<%=invoker%>" context="<%=jspContext%>" 
        wrapper="<%=new PrefixSuffixRenderer(jspContext, "<td>", "</td>") %>"/>
      <tbl:button
        image="help.gif"
        onclick="<%="Main.openHelp('" + ID +"', 'plugintype.view.properties')"%>"
        title="Help&hellip;"
        tooltip="Get help about this page"
      />
      </tbl:toolbar>
    <div class="boxedbottom">
      <div class="itemstatus">Permissions on this item: <i><%=PermissionUtil.getFullPermissionNames(pluginType)%></i></div>
      <%
      if (pluginType.isRemoved())
      {
        %>
        <div class="itemstatus">
          <base:icon 
            image="<%=deletePermanentlyPermission ? "deleted.gif" : "deleted_disabled.gif"%>"
            onclick="<%=deletePermanentlyPermission ? "deleteItemPermanently()" : null%>"
            tooltip="<%=deletePermanentlyPermission ? "Permanently delete this item" : null%>"
            visible="<%=isRemoved%>"> This item has been flagged for deletion<br></base:icon>
          <base:icon image="used.gif" 
            onclick="showUsingItems()"
            tooltip="Show the items that are using this one"
            visible="<%=isUsed%>"> This item is used by other items and can't be permanently deleted<br></base:icon>
        </div>
        <%
      }
      %>
      <table class="form" cellspacing=0>
      <tr>
        <td class="prompt">Name</td>
        <td><%=HTML.encodeTags(pluginType.getName())%></td>
      </tr>
      <tr>
        <td class="prompt">Registered</td>
        <td><%=dateFormatter.format(pluginType.getEntryDate())%></td>
      </tr>
      <tr>
        <td class="prompt">Interface</td>
        <td><%=HTML.encodeTags(pluginType.getInterfaceName())%></td>
      </tr>
      <tr>
        <td class="prompt">Jar path</td>
        <td><%=Values.getString(pluginType.getJarPath(), "<i>- internal -</i>")%></td>
      </tr>
      <tr>
        <td class="prompt">Description</td>
        <td><%=HTML.niceFormat(pluginType.getDescription())%></td>
      </tr>
      </table>
      
      <%
      ItemQuery<PluginDefinition> pluginQuery = pluginType.getPlugins();
      pluginQuery.include(Include.ALL);
      pluginQuery.order(Orders.asc(Hql.property("name")));
      ItemResultList<PluginDefinition> plugins = pluginQuery.list(dc);
    
      if (plugins.size() == 0)
      {
        %>
        <h4>Plugins</h4>
        There are no plugins of this type (or, you don't have permission to view them).
        <%
      }
      else
      {
        %>
        <base:section
          id="plugins"
          title="<%="Plugins (" + plugins.size() + ")"%>"
          context="<%=cc%>"
          >       
          <tbl:table
            id="plugins"
            clazz="itemlist"
            columns="all"
            >
          <tbl:columndef 
            id="name"
            title="Name"
          />
          <tbl:columndef 
            id="class"
            title="Class"
          />
          <tbl:columndef 
            id="description"
            title="Description"
          />
          <tbl:data>
            <tbl:columns>
            </tbl:columns>
            <tbl:rows>
            <%
            for (PluginDefinition plugin : plugins)
            {
              %>
              <tbl:row>
                <tbl:cell column="name"><base:icon 
                    image="deleted.gif" 
                    tooltip="This item has been scheduled for deletion" 
                    visible="<%=plugin.isRemoved()%>"
                  /><%=Base.getLinkedName(ID, new NameablePluginAdaptor(plugin), false, true)%></tbl:cell>
                <tbl:cell column="class"><%=HTML.encodeTags(plugin.getClassName())%></tbl:cell>
                <tbl:cell column="description"><%=HTML.encodeTags(plugin.getDescription())%></tbl:cell>
              </tbl:row>
              <%
            }
            %>
            </tbl:rows>
          </tbl:data>
          </tbl:table>
        </base:section>
        <%
      }
      %>
    </div>
      </t:tab>
      </t:tabcontrol>

  </base:body>
  </base:page>
  <%
}
finally
{
  if (dc != null) dc.close();
}

%>