source: trunk/www/admin/pluginconfigurations/view_configuration.jsp @ 5941

Last change on this file since 5941 was 5941, checked in by Nicklas Nordborg, 10 years ago

References #1655: GUI improvements

View pages for all items in the Adminstrate menu.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Date Id
File size: 16.6 KB
Line 
1<%-- $Id: view_configuration.jsp 5941 2012-02-01 13:26:23Z nicklas $
2  ------------------------------------------------------------------
3  Copyright (C) 2006 Jari Häkkinen, Nicklas Nordborg, Martin Svensson
4  Copyright (C) 2007 Martin Svensson
5
6  This file is part of BASE - BioArray Software Environment.
7  Available at http://base.thep.lu.se/
8
9  BASE is free software; you can redistribute it and/or
10  modify it under the terms of the GNU General Public License
11  as published by the Free Software Foundation; either version 3
12  of the License, or (at your option) any later version.
13
14  BASE is distributed in the hope that it will be useful,
15  but WITHOUT ANY WARRANTY; without even the implied warranty of
16  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  GNU General Public License for more details.
18
19  You should have received a copy of the GNU General Public License
20  along with BASE. If not, see <http://www.gnu.org/licenses/>.
21  ------------------------------------------------------------------
22
23  @author Nicklas
24  @version 2.0
25--%>
26<%@ page pageEncoding="UTF-8" session="false"
27  import="net.sf.basedb.core.SessionControl"
28  import="net.sf.basedb.core.DbControl"
29  import="net.sf.basedb.core.SystemItems"
30  import="net.sf.basedb.core.Group"
31  import="net.sf.basedb.core.Item"
32  import="net.sf.basedb.core.ItemContext"
33  import="net.sf.basedb.core.ItemResultIterator"
34  import="net.sf.basedb.core.Permission"
35  import="net.sf.basedb.core.PluginDefinition"
36  import="net.sf.basedb.core.PluginConfiguration"
37  import="net.sf.basedb.core.ParameterInfo"
38  import="net.sf.basedb.core.User"
39  import="net.sf.basedb.core.BasicItem"
40  import="net.sf.basedb.core.File"
41  import="net.sf.basedb.core.MultiPermissions"
42  import="net.sf.basedb.core.Nameable"
43  import="net.sf.basedb.core.PermissionDeniedException"
44  import="net.sf.basedb.core.PluginDefinition"
45  import="net.sf.basedb.core.plugin.GuiContext"
46  import="net.sf.basedb.core.plugin.Plugin"
47  import="net.sf.basedb.core.Project"
48  import="net.sf.basedb.core.Type"
49  import="net.sf.basedb.util.JarClassLoader"
50  import="net.sf.basedb.util.ToStringComparator"
51  import="net.sf.basedb.clients.web.Base"
52  import="net.sf.basedb.clients.web.ChangeHistoryUtil"
53  import="net.sf.basedb.clients.web.PermissionUtil"
54  import="net.sf.basedb.clients.web.util.HTML"
55  import="net.sf.basedb.util.Values"
56  import="net.sf.basedb.util.formatter.Formatter"
57  import="net.sf.basedb.clients.web.formatter.FormatterFactory"
58  import="net.sf.basedb.clients.web.extensions.ExtensionsControl"
59  import="net.sf.basedb.clients.web.extensions.JspContext"
60  import="net.sf.basedb.clients.web.extensions.renderer.PrefixSuffixRenderer"
61  import="net.sf.basedb.clients.web.extensions.toolbar.ToolbarUtil"
62  import="net.sf.basedb.util.extensions.ExtensionsInvoker"
63  import="java.util.Map"
64  import="java.util.Set"
65  import="java.util.TreeSet"
66  import="java.util.List"
67  import="java.util.Collections"
68  import="java.util.Date"
69%>
70<%@ taglib prefix="base" uri="/WEB-INF/base.tld" %>
71<%@ taglib prefix="tbl" uri="/WEB-INF/table.tld" %>
72<%@ taglib prefix="t" uri="/WEB-INF/tab.tld" %>
73<%@ taglib prefix="p" uri="/WEB-INF/path.tld" %>
74<%@ taglib prefix="ext" uri="/WEB-INF/extensions.tld" %>
75<%!
76  private static final Item itemType = Item.PLUGINCONFIGURATION;
77  private static final GuiContext guiContext = new GuiContext(itemType, GuiContext.Type.ITEM);
78%>
79<%
80final SessionControl sc = Base.getExistingSessionControl(pageContext, true);
81final String ID = sc.getId();
82final String root = request.getContextPath() + "/";
83final ItemContext cc = Base.getAndSetCurrentContext(sc, itemType, null, null);
84final int itemId = cc.getId();
85final String tab = Values.getString(request.getParameter("tab"), "properties");
86final float scale = Base.getScale(sc);
87final DbControl dc = sc.newDbControl();
88try
89{
90  Map<Plugin.MainType, Integer> pluginCount = PluginDefinition.countPlugins(dc, guiContext);
91  Formatter<Date> dateFormatter = FormatterFactory.getDateFormatter(sc);
92  Formatter<Date> dateTimeFormatter = FormatterFactory.getDateTimeFormatter(sc);
93
94  String title = null;
95  PluginConfiguration configuration = PluginConfiguration.getById(dc, itemId);
96 
97  final boolean createPermission = sc.hasPermission(Permission.CREATE, itemType);
98  final boolean writePermission = configuration.hasPermission(Permission.WRITE);
99  final boolean deletePermission = configuration.hasPermission(Permission.DELETE);
100  final boolean sharePermission = configuration.hasPermission(Permission.SET_PERMISSION);
101  final boolean setOwnerPermission = configuration.hasPermission(Permission.SET_OWNER);
102  final boolean isRemoved = configuration.isRemoved();
103  final boolean isUsed = isRemoved && configuration.isUsed();
104  final boolean deletePermanentlyPermission = deletePermission && !isUsed;
105  final boolean isOwner = configuration.isOwner();
106
107  final Set<GuiContext> contexts = new TreeSet<GuiContext>(new ToStringComparator<GuiContext>(false));
108  PluginDefinition plugin = null;
109  Nameable nameableProxy = null;
110  boolean readPlugin = true;
111  boolean configurable = false;
112  try
113  {
114    plugin = configuration.getPluginDefinition();
115    contexts.addAll(plugin.getGuiContexts());
116    configurable = plugin.isInteractive() && plugin.supportsConfigurations();
117  }
118  catch (PermissionDeniedException ex)
119  {
120    readPlugin = false;
121  }
122  JspContext jspContext = ExtensionsControl.createContext(dc, pageContext, guiContext, configuration);
123  ExtensionsInvoker invoker = ToolbarUtil.useExtensions(jspContext);
124  %>
125  <base:page title="<%=title%>">
126  <base:head scripts="table.js,tabcontrol.js" styles="table.css,toolbar.css,headertabcontrol.css,path.css">
127    <ext:scripts context="<%=jspContext%>" />
128    <ext:stylesheets context="<%=jspContext%>" />
129    <script language="JavaScript">
130    function editItem()
131    {
132      Main.viewOrEditItem('<%=ID%>', '<%=itemType.name()%>', <%=itemId%>, true);
133    }
134    function copyItem()
135    {
136      Main.copyItem('<%=ID%>', '<%=itemType.name()%>', <%=itemId%>);
137    }
138    function shareItem()
139    {
140      Main.openPopup('index.jsp?ID=<%=ID%>&cmd=ShareItem&item_id=<%=itemId%>', 'ShareConfiguration', 600, 400);
141    }
142    function deleteItem()
143    {
144      location.replace('index.jsp?ID=<%=ID%>&cmd=DeleteItem&item_id=<%=itemId%>');
145    }
146    function restoreItem()
147    {
148      location.replace('index.jsp?ID=<%=ID%>&cmd=RestoreItem&item_id=<%=itemId%>');
149    }
150    function deleteItemPermanently()
151    {
152      Main.deleteItemPermanently('<%=ID%>', true, '<%=itemType.name()%>', <%=itemId%>, '&callback=itemDeleted');
153    }
154    function itemDeleted()
155    {
156      Main.listItems('<%=ID%>', '<%=itemType.name()%>');
157    }
158    function showUsingItems()
159    {
160      Main.showUsingItems('<%=ID%>', '<%=itemType.name()%>', <%=itemId%>);
161    }
162    function setOwner()
163    {
164      Main.openPopup('index.jsp?ID=<%=ID%>&cmd=SetOwnerOfItem&item_id=<%=itemId%>', 'SetOwnerOfItem', 450, 300);
165    }
166    function runPlugin(cmd)
167    {
168      Main.openPopup('index.jsp?ID=<%=ID%>&cmd='+cmd+'&item_id=<%=itemId%>', 'RunPlugin'+cmd, 750, 500);
169    }
170    function configure()
171    {
172      Main.openPopup('../../common/plugin/index.jsp?ID=<%=ID%>&cmd=ConfigurePlugin&pluginconfiguration_id=<%=itemId%>', 'ConfigurePlugin', 750, 500);
173    }
174    function switchTab(tabControlId, tabId)
175    {
176      if (TabControl.isActive(tabControlId, tabId)) return;
177      if (tabId == 'history' && tabId != '<%=tab%>')
178      {
179        location.href = 'index.jsp?ID=<%=ID%>&cmd=ViewItem&item_id=<%=itemId%>&tab='+tabId;
180      }
181      else
182      {
183        TabControl.setActiveTab(tabControlId, tabId);
184      }
185    }
186    </script>
187  </base:head>
188  <base:body>
189    <p:path><p:pathelement 
190      title="Plugin configurations" href="<%="index.jsp?ID="+ID%>" 
191      /><p:pathelement title="<%=HTML.encodeTags(configuration.getName())%>" 
192      /></p:path>
193   
194    <t:tabcontrol 
195      id="main" 
196      subclass="content mastertabcontrol" 
197      active="<%=tab%>" switch="switchTab" remember="false">
198    <t:tab id="properties" title="Properties">
199      <div>
200      <table class="fullform bottomborder">
201      <tr>
202        <th class="itemstatus">
203          <base:icon 
204            image="shared.gif" 
205            visible="<%=configuration.isShared()%>"
206            tooltip="This item is shared to other users, groups and/or projects"
207          />
208          <base:icon 
209            image="deleted.gif"
210            onclick="deleteItemPermanently()"
211            tooltip="This item has been flagged for deletion. Click to delete it now."
212            enabled="<%=deletePermanentlyPermission %>"
213            visible="<%=isRemoved%>" 
214          />
215          <base:icon image="used.gif" 
216            onclick="showUsingItems()"
217            tooltip="This item is used by other items and can't be permanently deleted. Show the items that are using this one"
218            visible="<%=isRemoved && isUsed%>" />
219        </th>
220        <td style="padding: 0px;">
221          <tbl:toolbar subclass="bottomborder">
222            <tbl:button 
223              disabled="<%=writePermission ? false : true%>" 
224              image="edit.gif" 
225              onclick="editItem()" 
226              title="Edit&hellip;" 
227              tooltip="<%=writePermission ? "Edit this plugin configuration" : "You do not have permission to edit this plugin configuration"%>" 
228            />
229            <tbl:button 
230              disabled="<%=!createPermission%>" 
231              image="copy.gif"
232              onclick="copyItem()" 
233              title="Copy&hellip;" 
234              tooltip="<%=createPermission ? "Create a copy of this configuration" : "You do not have permission to create new configurations"%>"
235            />
236            <tbl:button 
237              disabled="<%=deletePermission ? false : true%>" 
238              image="delete.gif" 
239              onclick="deleteItem()" 
240              title="Delete"
241              visible="<%=!configuration.isRemoved()%>"
242              tooltip="<%=deletePermission ? "Delete this plugin configuration" : "You do not have permission to delete this plugin configuration"%>" 
243            />
244            <tbl:button 
245              disabled="<%=writePermission ? false : true%>" 
246              image="restore.gif" 
247              onclick="restoreItem()" 
248              title="Restore"
249              visible="<%=configuration.isRemoved()%>"
250              tooltip="<%=writePermission ? "Restore this plugin configuration" : "You do not have permission to restore this plugin configuration"%>" 
251            />
252            <tbl:button 
253              disabled="<%=sharePermission ? false : true%>"
254              image="share.gif"
255              onclick="shareItem()" 
256              title="Share&hellip;" 
257              tooltip="<%=sharePermission ? "Share this plugin configuration to other user, groups and projects" : "You do not have permission to share this plugin configuration"%>"
258            />
259            <tbl:button 
260              disabled="<%=setOwnerPermission ? false : true%>"
261              image="take_ownership.png"
262              onclick="setOwner()" 
263              title="Set owner&hellip;"
264              tooltip="<%=setOwnerPermission ? "Change owner of this item" : "You do not have permission to change ownership of this item"%>"
265            />
266            <tbl:button 
267              image="import.gif" 
268              onclick="runPlugin('ImportItem')" 
269              title="Import&hellip;" 
270              tooltip="Import data" 
271              visible="<%=pluginCount.containsKey(Plugin.MainType.IMPORT)%>"
272            />
273            <tbl:button 
274              image="export.gif" 
275              onclick="runPlugin('ExportItem')" 
276              title="Export&hellip;" 
277              tooltip="Export data" 
278              visible="<%=pluginCount.containsKey(Plugin.MainType.EXPORT)%>"
279            />
280            <tbl:button 
281              image="runplugin.gif" 
282              onclick="runPlugin('RunPlugin')" 
283              title="Run plugin&hellip;" 
284              tooltip="Run a plugin" 
285              visible="<%=pluginCount.containsKey(Plugin.MainType.OTHER)%>"
286            />
287            <tbl:button
288              image="runplugin.gif"
289              onclick="configure()"
290              title="Configure&hellip;"
291              tooltip="Configure this plugin"
292              visible="<%=configurable && writePermission%>"
293            />
294            <ext:render extensions="<%=invoker%>" context="<%=jspContext%>" 
295              wrapper="<%=new PrefixSuffixRenderer(jspContext, "<td>", "</td>") %>"/>
296            <tbl:button
297              image="help.png"
298              onclick="<%="Main.openHelp('" + ID +"', 'pluginconfiguration.view.properties')"%>"
299              title="Help&hellip;"
300              tooltip="Get help about this page"
301            />
302          </tbl:toolbar>
303        </td>
304      </tr>
305      <tr>
306        <th>Name</th>
307        <td><%=HTML.encodeTags(configuration.getName())%></td>
308      </tr>
309      <tr>
310        <th>Registered</th>
311        <td><%=dateFormatter.format(configuration.getEntryDate())%></td>
312      </tr>
313      <tr>
314        <th>Plugin</th>
315        <td><%=Base.getLinkedName(ID, plugin, plugin == null, true)%></td>
316      </tr>
317      <tr>
318        <th>Type</th>
319        <td><%=plugin == null ? "<i>- denied -</i>" : plugin.getMainType().toString()%></td>
320      </tr>
321      <tr>
322        <th>Owner</th>
323        <td><base:propertyvalue item="<%=configuration%>" property="owner" /></td>
324      </tr>
325      <tr>
326        <th>Permissions</th>
327        <td><%=PermissionUtil.getFullPermissionNames(configuration)%></td>
328      </tr>
329      <tr >
330        <th>Description</th>
331        <td><%=HTML.niceFormat(configuration.getDescription())%></td>
332      </tr>
333      </table>
334      </div>
335     
336      <%
337      if (plugin != null)
338      {
339        List<String> names = new java.util.ArrayList<String>(configuration.getParameterNames());
340        %>
341        <base:section
342          id="parameters"
343          title="Configuration parameters"
344          context="<%=cc %>"
345          >
346          <%
347          if (names == null || names.size() == 0)
348          {
349            %>
350            <div class="messagecontainer note">
351            No parameters has been specified.
352            </div>
353            <%
354          }
355          else
356          {
357            Collections.sort(names);
358            %>
359            <table class="fullform fullborder">
360              <%
361              for (String name : names)
362              {
363                StringBuilder sb = new StringBuilder();
364                String displayValue = "";
365                String description = "";
366                try
367                {
368                  ParameterInfo pi = configuration.getParameterInfo(name);
369                  if (pi.getLabel() != null) name = HTML.encodeTags(pi.getLabel());
370                  description = HTML.encodeTags(pi.getDescription());
371                  List<?> values = pi.getValues();
372                  int i = 0;
373                  for (Object value : values)
374                  {
375                    if (value != null)
376                    {
377                      if (i > 0) sb.append(", ");
378                      i++;
379                      if (value instanceof BasicItem)
380                      {
381                        BasicItem item = (BasicItem)value;
382                        String itemName = "";
383                        if (item instanceof File)
384                        {
385                          sb.append(Base.getLinkedFile(ID, (File)item, false, true, true, root));
386                        }
387                        else 
388                        {
389                          if (item instanceof Nameable)
390                          {
391                            itemName = ((Nameable)item).getName();
392                          }
393                          else
394                          {
395                            itemName = item.toString();
396                          }
397                          sb.append(Base.getLink(ID, HTML.encodeTags(itemName), 
398                            item.getType(), item.getId(), item.hasPermission(Permission.WRITE)));
399                        }
400                      }
401                      else if (value instanceof Date)
402                      {
403                        if (pi.getValueType() == Type.TIMESTAMP)
404                        {
405                          sb.append(dateTimeFormatter.format((Date)value));
406                        }
407                        else
408                        {
409                          sb.append(dateFormatter.format((Date)value));
410                        }
411                      }
412                      else
413                      {
414                        sb.append(HTML.encodeTags(value.toString()));
415                      }
416                    }
417                  }
418                  displayValue = sb.toString();
419                }
420                catch (Throwable ex)
421                {
422                  displayValue = "<i>ERROR: "+ex.getMessage()+"</i>";
423                }
424                %>
425                <tr>
426                  <th><span title="<%=description%>"><%=name%></span></th>
427                  <td><%=displayValue%></td>
428                </tr>
429                <%
430              }
431              %>
432            </table>
433            <%
434          }
435          %>
436        </base:section>
437        <%
438      }
439      %>
440     
441      <jsp:include page="../../common/anytoany/list_anytoany.jsp">
442        <jsp:param name="ID" value="<%=ID%>" />
443        <jsp:param name="item_type" value="<%=itemType.name()%>" />
444        <jsp:param name="item_id" value="<%=itemId%>" />
445        <jsp:param name="title" value="Other items related to this plugin configuration" />
446      </jsp:include>
447      <jsp:include page="../../common/share/list_share.jsp">
448        <jsp:param name="ID" value="<%=ID%>" />
449        <jsp:param name="item_type" value="<%=itemType.name()%>" />
450        <jsp:param name="item_id" value="<%=itemId%>" />
451        <jsp:param name="title" value="Shared to" />
452      </jsp:include>
453      </t:tab>
454     
455      <t:tab id="annotations" title="Annotations" 
456        tooltip="View annotation values" clazz="white"
457        visible="<%=plugin != null && plugin.supports("net.sf.basedb.core.plugin.AnnotationSetterPlugin") %>">
458        <jsp:include page="../../common/annotations/list_annotations.jsp">
459          <jsp:param name="item_type" value="<%=itemType.name()%>" />
460          <jsp:param name="item_id" value="<%=itemId%>" />
461          <jsp:param name="ID" value="<%=ID%>" />
462        </jsp:include>
463      </t:tab>
464      <t:tab id="history" title="Change history" 
465        tooltip="Displays a log of all modifications made to this item"
466        visible="<%=ChangeHistoryUtil.showChangeHistoryTab(sc)%>">
467        <%
468        if ("history".equals(tab))
469        {
470          %>
471          <jsp:include page="../../common/history/frameset.jsp">
472            <jsp:param name="source_type" value="<%=itemType.name()%>" />
473            <jsp:param name="source_id" value="<%=itemId%>" />
474            <jsp:param name="ID" value="<%=ID%>" />
475          </jsp:include>
476          <%
477        }
478        %>
479      </t:tab>
480      </t:tabcontrol>
481
482  </base:body>
483  </base:page>
484  <%
485}
486finally
487{
488  if (dc != null) dc.close();
489}
490
491%>
Note: See TracBrowser for help on using the repository browser.