source: branches/2.4-stable/www/admin/pluginconfigurations/list_configurations.jsp @ 3743

Last change on this file since 3743 was 3743, checked in by Nicklas Nordborg, 15 years ago

Fixes #753: NullPointerException? in plugin configuration list

  • Property svn:eol-style set to native
  • Property svn:keywords set to Date Id
File size: 17.8 KB
Line 
1<%-- $Id: list_configurations.jsp 3743 2007-09-17 12:47:03Z nicklas $
2  ------------------------------------------------------------------
3  Copyright (C) 2006 Jari Hakkinen, Nicklas Nordborg, Martin Svensson
4  Copyright (C) 2007 Johan Enell, Nicklas Nordborg, 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 2
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 this program; if not, write to the Free Software
21  Foundation, Inc., 59 Temple Place - Suite 330,
22  Boston, MA  02111-1307, USA.
23  ------------------------------------------------------------------
24
25  @author Nicklas
26  @version 2.0
27--%>
28<%@ page session="false"
29  import="net.sf.basedb.core.SessionControl"
30  import="net.sf.basedb.core.DbControl"
31  import="net.sf.basedb.core.Item"
32  import="net.sf.basedb.core.PluginConfiguration"
33  import="net.sf.basedb.core.ItemQuery"
34  import="net.sf.basedb.core.Include"
35  import="net.sf.basedb.core.ItemResultIterator"
36  import="net.sf.basedb.core.ItemResultList"
37  import="net.sf.basedb.core.ItemContext"
38  import="net.sf.basedb.core.Nameable"
39  import="net.sf.basedb.core.Permission"
40  import="net.sf.basedb.core.PluginDefinition"
41  import="net.sf.basedb.core.PermissionDeniedException"
42  import="net.sf.basedb.core.query.Orders"
43  import="net.sf.basedb.core.query.Hql"
44  import="net.sf.basedb.core.plugin.GuiContext"
45  import="net.sf.basedb.core.plugin.Plugin"
46  import="net.sf.basedb.util.Enumeration"
47  import="net.sf.basedb.util.JarClassLoader"
48  import="net.sf.basedb.util.ShareableUtil"
49  import="net.sf.basedb.util.ToStringComparator"
50  import="net.sf.basedb.clients.web.Base"
51  import="net.sf.basedb.clients.web.ModeInfo"
52  import="net.sf.basedb.clients.web.PermissionUtil"
53  import="net.sf.basedb.clients.web.util.HTML"
54  import="net.sf.basedb.util.Values"
55  import="net.sf.basedb.clients.web.util.NameablePluginAdaptor"
56  import="java.util.Iterator"
57  import="java.util.List"
58  import="java.util.Map"
59  import="java.util.Set"
60  import="java.util.EnumSet"
61  import="java.util.TreeSet"
62%>
63<%@ taglib prefix="base" uri="/WEB-INF/base.tld" %>
64<%@ taglib prefix="tbl" uri="/WEB-INF/table.tld" %>
65<%!
66  private static final Item itemType = Item.PLUGINCONFIGURATION;
67  private static final GuiContext guiContext = new GuiContext(itemType, GuiContext.Type.LIST);
68  private static final Enumeration<String, String> itemTypes = new Enumeration<String, String>();
69  private static final Enumeration<String, String> mainTypes = new Enumeration<String, String>();
70
71  static
72  {
73    Set<Item> temp = new TreeSet<Item>(new ToStringComparator<Item>(false));
74    temp.addAll(EnumSet.complementOf(EnumSet.of(Item.SYSTEM)));
75    for (Item item : temp)
76    {
77      itemTypes.add(Integer.toString(item.getValue()), item.toString());
78    }
79    for (Plugin.MainType v : Plugin.MainType.values())
80    {
81      mainTypes.add(Integer.toString(v.getValue()), v.toString());
82    }
83  }
84%>
85<%
86final SessionControl sc = Base.getExistingSessionControl(pageContext, Permission.DENIED, itemType);
87final String ID = sc.getId();
88final boolean createPermission = sc.hasPermission(Permission.CREATE, itemType);
89final ItemContext cc = Base.getAndSetCurrentContext(sc, itemType, null, null);
90
91final ModeInfo mode = ModeInfo.get(request.getParameter("mode"));
92final String callback = request.getParameter("callback");
93final String title = mode.generateTitle("plugin configuration", "plugin configurations");
94final DbControl dc = sc.newDbControl();
95ItemResultIterator<PluginConfiguration> configurations = null;
96try
97{
98  Map<Plugin.MainType, Integer> pluginCount = PluginDefinition.countPlugins(dc, guiContext);
99  try
100  {
101    final ItemQuery<PluginConfiguration> query = Base.getConfiguredQuery(cc, true, PluginConfiguration.getQuery(), mode);
102    query.join(Hql.innerJoin("pluginDefinition", Item.PLUGINDEFINITION.getAlias()));
103    query.join(Hql.leftJoin(Item.PLUGINDEFINITION.getAlias(), "guiContexts", "ctx", null, false));
104    query.setDistinct(true);
105    configurations = query.iterate(dc);
106  }
107  catch (Throwable t)
108  {
109    cc.setMessage(t.getMessage());
110  }
111  int numListed = 0;
112  %>
113  <base:page title="<%=title==null ? "Plugin configurations" : title%>" type="<%=mode.getPageType()%>">
114  <base:head scripts="menu.js,table.js" styles="menu.css,table.css">
115    <script language="JavaScript">
116    var submitPage = 'index.jsp';
117    var formId = 'configurations';
118    function newItem()
119    {
120      Main.viewOrEditItem('<%=ID%>', '<%=itemType.name()%>', 0, true);
121    }
122    function editItem(itemId)
123    {
124      Main.viewOrEditItem('<%=ID%>', '<%=itemType.name()%>', itemId, true);
125    }
126    function viewItem(itemId)
127    {
128      Main.viewOrEditItem('<%=ID%>', '<%=itemType.name()%>', itemId, false);
129    }
130    function copyItem(itemId)
131    {
132      Main.copyItem('<%=ID%>', '<%=itemType.name()%>', itemId);
133    }
134    function itemOnClick(evt, itemId)
135    {
136      Table.itemOnClick(formId, evt, itemId, '<%=mode.getName()%>', viewItem, editItem, returnSelected);
137    }
138    function deleteItems()
139    {
140      var frm = document.forms[formId];
141      if (Forms.numChecked(frm) == 0)
142      {
143        alert('Please select at least one item in the list');
144        return;
145      }
146      frm.action = submitPage;
147      frm.cmd.value = 'DeleteItems';
148      frm.submit();
149    }
150    function restoreItems()
151    {
152      var frm = document.forms[formId];
153      if (Forms.numChecked(frm) == 0)
154      {
155        alert('Please select at least one item in the list');
156        return;
157      }
158      frm.action = submitPage;
159      frm.cmd.value = 'RestoreItems';
160      frm.submit();
161    }
162    function unloadItems()
163    {
164      var frm = document.forms[formId];
165      if (Forms.numChecked(frm) == 0)
166      {
167        alert('Please select at least one item in the list');
168        return;
169      }
170      frm.action = submitPage;
171      frm.cmd.value = 'UnloadItems';
172      frm.submit();
173    }
174    function takeOwnership()
175    {
176      var frm = document.forms[formId];
177      if (Forms.numChecked(frm) == 0)
178      {
179        alert('Please select at least one item in the list');
180        return;
181      }
182      if (confirm('Are you sure that you want to take ownership of the selected items? It can\'t be undone.'))
183      {
184        frm.action = submitPage;
185        frm.cmd.value = 'TakeOwnershipOfItems';
186        frm.submit();
187      }
188    }
189    function shareItem(itemId)
190    {
191      Main.openPopup('index.jsp?ID=<%=ID%>&cmd=ShareItem&item_id='+itemId, 'ShareConfigurations', 500, 400);
192    }
193    function shareItems()
194    {
195      Table.shareItems(submitPage, '<%=ID%>', formId, '<%=itemType.name()%>', 'ShareItems');
196    }
197    function configureColumns()
198    {
199      Table.configureColumns('<%=ID%>', formId, '<%=itemType.name()%>', '<%=(String)cc.getObject("defaultColumns")%>');
200    }
201    function runPlugin(cmd)
202    {
203      Table.submitToPopup(formId, cmd, 740, 540);
204    }
205    function returnSelected()
206    {
207      Table.returnSelected(formId, <%=callback != null ? "window.opener."+callback : "null" %>);
208      window.close();
209    }
210    function presetOnChange()
211    {
212      Table.presetOnChange('<%=ID%>', formId, '<%=itemType.name()%>', '<%=(String)cc.getObject("defaultColumns")%>');
213    }
214    function configurePlugin(itemId)
215    {
216      Main.openPopup('../../common/plugin/index.jsp?ID=<%=ID%>&cmd=ConfigurePlugin&pluginconfiguration_id='+itemId, 'ConfigurePlugin', 800, 600);
217    }
218    </script>
219  </base:head>
220 
221  <base:body>
222    <%
223    if (cc.getMessage() != null)
224    {
225      %>
226      <div class="error"><%=cc.getMessage()%></div>
227      <%
228      cc.setMessage(null);
229    }
230    %>
231    <tbl:table 
232      id="configurations" 
233      clazz="itemlist" 
234      columns="<%=cc.getSetting("columns")%>"
235      sortby="<%=cc.getSortProperty()%>" 
236      direction="<%=cc.getSortDirection()%>"
237      title="<%=title%>"
238      action="index.jsp"
239      sc="<%=sc%>"
240      item="<%=itemType%>"
241      >
242      <tbl:hidden 
243        name="mode" 
244        value="<%=mode.getName()%>" 
245      />
246      <tbl:hidden 
247        name="callback" 
248        value="<%=callback%>" 
249        skip="<%=callback == null%>" 
250      />
251      <tbl:columndef 
252        id="name"
253        property="name"
254        datatype="string"
255        title="Name"
256        sortable="true" 
257        filterable="true"
258        exportable="true"
259        show="always" 
260      />
261      <tbl:columndef 
262        id="pluginType"
263        property="pluginDefinition.mainType"
264        datatype="int"
265        enumeration="<%=mainTypes%>"
266        title="Type"
267        sortable="true" 
268        filterable="true"
269        exportable="true"
270      />
271      <tbl:columndef 
272        id="contexts"
273        property="$ctx.itemType"
274        datatype="int"
275        enumeration="<%=itemTypes%>"
276        title="Items"
277        sortable="false" 
278        filterable="true"
279        exportable="false"
280      />
281      <tbl:columndef 
282        id="pluginDefinition"
283        property="pluginDefinition.name"
284        datatype="string"
285        title="Plugin definition"
286        sortable="true" 
287        filterable="true"
288        exportable="true"
289      />
290      <tbl:columndef 
291        id="owner"
292        property="owner.name"
293        datatype="string"
294        title="Owner"
295        sortable="true" 
296        filterable="true"
297        exportable="true"
298      />
299      <tbl:columndef 
300        id="description"
301        property="description"
302        datatype="string"
303        title="Description" 
304        sortable="true" 
305        filterable="true" 
306        exportable="true"
307      />
308      <tbl:columndef 
309        id="actions"
310        title="Actions"
311      />
312      <tbl:columndef
313        id="permission"
314        title="Permission"
315      />
316      <tbl:columndef
317        id="sharedTo"
318        title="Shared to"
319      />
320      <tbl:toolbar
321        visible="<%=mode.hasToolbar()%>"
322        >
323        <tbl:button 
324          disabled="<%=createPermission ? false : true%>" 
325          image="<%=createPermission ? "new.gif" : "new_disabled.gif"%>" 
326          onclick="newItem()" 
327          title="New&hellip;" 
328          tooltip="<%=createPermission ? "Create new configuration" : "You do not have permission to create configurations"%>" 
329        />
330        <tbl:button 
331          image="delete.gif"
332          onclick="deleteItems()" 
333          title="Delete" 
334          tooltip="Delete the selected items" 
335        />
336        <tbl:button 
337          image="restore.gif"
338          onclick="restoreItems()" 
339          title="Restore" 
340          tooltip="Restore the selected (deleted) items"
341        />
342        <tbl:button 
343          image="share.gif"
344          onclick="shareItems()" 
345          title="Share&hellip;" 
346          tooltip="Share the selected items"
347        />
348        <tbl:button 
349          image="take_ownership.png"
350          onclick="takeOwnership()" 
351          title="Take ownership&hellip;"
352          tooltip="Take ownership of the selected items"
353        />
354        <tbl:button 
355          image="columns.gif" 
356          onclick="configureColumns()" 
357          title="Columns&hellip;" 
358          tooltip="Show, hide and re-order columns" 
359        />
360        <tbl:button 
361          image="import.gif" 
362          onclick="runPlugin('ImportItems')" 
363          title="Import&hellip;" 
364          tooltip="Import data" 
365          visible="<%=pluginCount.containsKey(Plugin.MainType.IMPORT)%>"
366        />
367        <tbl:button 
368          image="export.gif" 
369          onclick="runPlugin('ExportItems')" 
370          title="Export&hellip;" 
371          tooltip="Export data" 
372          visible="<%=pluginCount.containsKey(Plugin.MainType.EXPORT)%>"
373        />
374        <tbl:button 
375          image="runplugin.gif" 
376          onclick="runPlugin('RunListPlugin')" 
377          title="Run plugin&hellip;" 
378          tooltip="Run a plugin" 
379          visible="<%=pluginCount.containsKey(Plugin.MainType.OTHER)%>"
380        />
381      </tbl:toolbar>
382      <tbl:navigator
383        page="<%=cc.getPage()%>" 
384        rowsperpage="<%=cc.getRowsPerPage()%>" 
385        totalrows="<%=configurations == null ? 0 : configurations.getTotalCount()%>" 
386        visible="<%=mode.hasNavigator()%>"
387      />
388      <tbl:data>
389        <tbl:columns>
390        <tbl:presetselector 
391          clazz="columnheader"
392          colspan="3"
393          onchange="presetOnChange()"
394        />
395        </tbl:columns>
396
397        <tr>
398          <tbl:header 
399            clazz="index"
400            >&nbsp;</tbl:header>
401          <tbl:header 
402            clazz="check" 
403            visible="<%=mode.hasCheck()%>"
404            ><base:icon 
405              image="check_uncheck.gif" 
406              tooltip="Check/uncheck all" 
407              onclick="Forms.checkUncheck(document.forms[formId])" style="align: left;"
408            /></tbl:header>
409          <tbl:header 
410            clazz="check" 
411            visible="<%=mode.hasRadio()%>"
412            >&nbsp;</tbl:header>
413          <tbl:header 
414            clazz="icons" 
415            visible="<%=mode.hasIcons()%>"
416            >&nbsp;</tbl:header>
417          <tbl:propertyfilter />
418        </tr>
419         
420          <tbl:rows>
421          <%
422          int index = cc.getPage()*cc.getRowsPerPage();
423          int selectedItemId = cc.getId();
424          Set<GuiContext> contexts = new TreeSet<GuiContext>(new ToStringComparator<GuiContext>(false));
425          if (configurations != null)
426          {           
427            while (configurations.hasNext())
428            {
429              PluginConfiguration item = configurations.next();
430              PluginDefinition plugin = null;
431              Nameable nameableProxy = null;
432              contexts.clear();
433              try
434              {
435                plugin = item.getPluginDefinition();
436                nameableProxy = new NameablePluginAdaptor(plugin);
437                contexts.addAll(plugin.getGuiContexts());
438              }
439              catch (PermissionDeniedException ex)
440              {}
441              int itemId = item.getId();
442              String openSharePopup = "shareItem("+itemId+")";
443              String openCopyPopup = "copyItem("+itemId+")";
444              boolean sharePermission = item.hasPermission(Permission.SET_PERMISSION);
445              boolean writePermission = item.hasPermission(Permission.WRITE);
446              String name = HTML.encodeTags(item.getName());
447              String tooltip = mode.isSelectionMode() ? 
448                  "Select this item" : "View this item" + (writePermission ? " (use CTRL, ALT or SHIFT to edit)" : "");
449              index++;
450              numListed++;
451              %>
452              <tbl:row>
453                <tbl:header 
454                  clazz="index"
455                  ><%=index%></tbl:header>
456                <tbl:header 
457                  clazz="check" 
458                  visible="<%=mode.hasCheck()%>"
459                  ><input 
460                    type="checkbox" 
461                    name="<%=itemId%>" 
462                    value="<%=itemId%>" 
463                    title="<%=name%>" 
464                    <%=cc.getSelected().contains(itemId) ? "checked" : ""%> 
465                  ></tbl:header>
466                <tbl:header 
467                  clazz="check" 
468                  visible="<%=mode.hasRadio()%>"
469                  ><input 
470                    type="radio" 
471                    name="item_id" 
472                    value="<%=itemId%>" 
473                    title="<%=name%>" 
474                    <%=selectedItemId == itemId ? "checked" : ""%>
475                  ></tbl:header>
476                <tbl:header 
477                  clazz="icons" 
478                  visible="<%=mode.hasIcons()%>"
479                  ><base:icon 
480                    image="deleted.gif" 
481                    tooltip="This item has been scheduled for deletion" 
482                    visible="<%=item.isRemoved()%>"
483                  /><base:icon 
484                    image="<%=sharePermission ? "shared.gif" : "shared_disabled.gif"%>" 
485                    onclick="<%=sharePermission ? openSharePopup : null%>"
486                    tooltip="This item is shared to other users, groups and/or projects" 
487                    visible="<%=item.isShared()%>"
488                  />&nbsp;</tbl:header>
489                <tbl:cell column="name"><div class="link" 
490                  onclick="itemOnClick(<%=writePermission ? "event" : null%>, <%=itemId%>)" 
491                  title="<%=tooltip%>"><%=name%></div></tbl:cell>
492                <tbl:cell column="pluginType"><%=plugin == null ? "<i>- denied -</i>" : plugin.getMainType().toString()%></tbl:cell>
493                <tbl:cell column="contexts"><%=plugin == null ? "<i>- denied -</i>" : (contexts.isEmpty() ? "<i>- none -</i>" : Values.getString(contexts, ", ", true))%></tbl:cell>
494                <tbl:cell column="pluginDefinition"><%=mode.hasPropertyLink() ? Base.getLinkedName(ID, nameableProxy, plugin == null, mode.hasEditLink()): Base.getEncodedName(nameableProxy, plugin == null)%></a></tbl:cell>
495                <tbl:cell column="owner"
496                  ><base:propertyvalue 
497                    item="<%=item%>" 
498                    property="owner"
499                    enableEditLink="<%=mode.hasEditLink()%>" 
500                    enablePropertyLink="<%=mode.hasPropertyLink()%>"
501                  /></tbl:cell>
502                <tbl:cell column="description"><%=HTML.encodeTags(item.getDescription())%></tbl:cell>
503                <tbl:cell column="actions">
504                  <%
505                  if (plugin != null && plugin.isInteractive() && plugin.supportsConfigurations())
506                  {
507                    %>
508                    <base:icon image="runplugin.gif" 
509                      onclick="<%="configurePlugin(" + itemId + ")"%>"
510                      tooltip="Configure this plugin " 
511                      visible="<%=writePermission%>" />
512                    <%
513                  }
514                  %>
515                  <base:icon
516                    image="copy.gif"
517                    onclick="<%=openCopyPopup%>"
518                    tooltip="Create a copy of this item"
519                    visible="<%=createPermission%>"
520                  />
521                </tbl:cell>
522                <tbl:cell column="permission"><%=PermissionUtil.getShortPermissions(item)%></tbl:cell>
523                <tbl:cell column="sharedTo">
524                  <%
525                  Iterator<Nameable> sharees = ShareableUtil.getSharedTo(dc, item).iterator();
526                  while(sharees.hasNext())
527                  {
528                    Nameable n = sharees.next();
529                    if (mode.hasPropertyLink())
530                    {
531                      out.write(Base.getLinkedName(ID, n, false, mode.hasEditLink()));
532                    }
533                    else
534                    {
535                      out.write(HTML.encodeTags(n.getName()));
536                    }
537                    out.write(sharees.hasNext() ? ", " : "");
538                  }
539                  %>
540                </tbl:cell>
541              </tbl:row>
542              <%
543              }
544            }
545          %>
546          </tbl:rows>
547      </tbl:data>
548      <%
549      if (numListed == 0)
550      {
551        %>
552        <tbl:panel><%=configurations == null || configurations.getTotalCount() == 0 ? "No configurations were found" : "No configurations on this page. Please select another page!" %></tbl:panel>
553        <%
554      }
555      else
556      {
557        %>
558        <tbl:navigator
559          page="<%=cc.getPage()%>" 
560          rowsperpage="<%=cc.getRowsPerPage()%>" 
561          totalrows="<%=configurations == null ? 0 : configurations.getTotalCount()%>" 
562          visible="<%=mode.hasNavigator()%>"
563          locked="true"
564        />
565        <%
566      }
567      %>
568    </tbl:table>
569    <base:buttongroup align="center" clazz="fixedatbottom">
570      <base:button onclick="returnSelected();" title="Ok" visible="<%=mode.hasOkButton()%>" />
571      <base:button onclick="window.close();" title="Cancel" visible="<%=mode.hasCancelButton()%>" />
572      <base:button onclick="window.close();" title="Close" visible="<%=mode.hasCloseButton()%>" />
573    </base:buttongroup>
574    <br><br><br>
575  </base:body>
576  </base:page>
577  <%
578}
579finally
580{
581  if (configurations != null) configurations.close();
582  if (dc != null) dc.close();
583}
584%>
Note: See TracBrowser for help on using the repository browser.