source: branches/3.18-stable/www/admin/pluginconfigurations/list_configurations.jsp @ 7932

Last change on this file since 7932 was 7932, checked in by Nicklas Nordborg, 6 months ago

References #2246: Sticky table headers

Implemented for all item list pages and a few other places:

  • Extensions installation dialog
  • Administrate / Services list page
  • Batch inherit annotations
  • Manage list presets
  • List of changed item in view job dialog


  • Property svn:eol-style set to native
  • Property svn:keywords set to Date Id
File size: 18.3 KB
Line 
1<%-- $Id: list_configurations.jsp 7932 2021-04-28 07:16:56Z nicklas $
2  ------------------------------------------------------------------
3  Copyright (C) 2006 Jari Häkkinen, 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 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.Item"
30  import="net.sf.basedb.core.PluginConfiguration"
31  import="net.sf.basedb.core.ItemQuery"
32  import="net.sf.basedb.core.Include"
33  import="net.sf.basedb.core.ItemResultIterator"
34  import="net.sf.basedb.core.ItemResultList"
35  import="net.sf.basedb.core.ItemContext"
36  import="net.sf.basedb.core.Nameable"
37  import="net.sf.basedb.core.Permission"
38  import="net.sf.basedb.core.PluginDefinition"
39  import="net.sf.basedb.core.PermissionDeniedException"
40  import="net.sf.basedb.core.query.Orders"
41  import="net.sf.basedb.core.query.Hql"
42  import="net.sf.basedb.core.plugin.GuiContext"
43  import="net.sf.basedb.core.plugin.Plugin"
44  import="net.sf.basedb.util.Enumeration"
45  import="net.sf.basedb.util.JarClassLoader"
46  import="net.sf.basedb.util.ShareableUtil"
47  import="net.sf.basedb.util.ToStringComparator"
48  import="net.sf.basedb.clients.web.Base"
49  import="net.sf.basedb.clients.web.ModeInfo"
50  import="net.sf.basedb.clients.web.PermissionUtil"
51  import="net.sf.basedb.clients.web.util.HTML"
52  import="net.sf.basedb.util.Values"
53  import="net.sf.basedb.util.formatter.Formatter"
54  import="net.sf.basedb.clients.web.formatter.FormatterFactory"
55  import="net.sf.basedb.clients.web.extensions.ExtensionsControl"
56  import="net.sf.basedb.clients.web.extensions.JspContext"
57  import="net.sf.basedb.clients.web.extensions.renderer.PrefixSuffixRenderer"
58  import="net.sf.basedb.clients.web.extensions.toolbar.ButtonAction" 
59  import="net.sf.basedb.clients.web.extensions.toolbar.ToolbarUtil"
60  import="net.sf.basedb.util.extensions.ExtensionsInvoker"
61  import="net.sf.basedb.clients.web.extensions.list.ListColumnAction"
62  import="net.sf.basedb.clients.web.extensions.list.ListColumnUtil"
63  import="java.util.Date"
64  import="java.util.Iterator"
65  import="java.util.List"
66  import="java.util.Map"
67  import="java.util.Set"
68  import="java.util.EnumSet"
69  import="java.util.TreeSet"
70%>
71<%@ taglib prefix="base" uri="/WEB-INF/base.tld" %>
72<%@ taglib prefix="tbl" uri="/WEB-INF/table.tld" %>
73<%@ taglib prefix="ext" uri="/WEB-INF/extensions.tld" %>
74<%!
75  private static final Item itemType = Item.PLUGINCONFIGURATION;
76  private static final GuiContext guiContext = new GuiContext(itemType, GuiContext.Type.LIST);
77  private static final Enumeration<String, String> itemTypes = new Enumeration<String, String>();
78  private static final Enumeration<String, String> mainTypes = new Enumeration<String, String>();
79
80  static
81  {
82    Set<Item> temp = new TreeSet<Item>(new ToStringComparator<Item>(false));
83    temp.addAll(EnumSet.complementOf(EnumSet.of(Item.SYSTEM)));
84    itemTypes.add("", "- none -");   
85    for (Item item : temp)
86    {
87      itemTypes.add(Integer.toString(item.getValue()), item.toString());
88    }
89    for (Plugin.MainType v : Plugin.MainType.values())
90    {
91      mainTypes.add(Integer.toString(v.getValue()), v.toString());
92    }
93  }
94%>
95<%
96final SessionControl sc = Base.getExistingSessionControl(pageContext, Permission.DENIED, itemType);
97final String ID = sc.getId();
98final boolean createPermission = sc.hasPermission(Permission.CREATE, itemType);
99final ItemContext cc = Base.getAndSetCurrentContext(sc, itemType, null, null);
100
101final ModeInfo mode = ModeInfo.get(request.getParameter("mode"));
102final String callback = request.getParameter("callback");
103final String title = mode.generateTitle("plugin configuration", "plugin configurations");
104final DbControl dc = sc.newDbControl();
105ItemResultIterator<PluginConfiguration> configurations = null;
106try
107{
108  Formatter<Date> dateFormatter = FormatterFactory.getDateFormatter(sc);
109  Map<Plugin.MainType, Integer> pluginCount = PluginDefinition.countPlugins(dc, guiContext);
110  JspContext jspContext = ExtensionsControl.createContext(dc, pageContext, guiContext, null);
111  try
112  {
113    final ItemQuery<PluginConfiguration> query = Base.getConfiguredQuery(dc, cc, jspContext, true, PluginConfiguration.getQuery(), mode);
114    query.join(Hql.innerJoin("pluginDefinition", Item.PLUGINDEFINITION.getAlias()));
115    query.join(Hql.leftJoin(Item.PLUGINDEFINITION.getAlias(), "guiContexts", "ctx", null, false));
116    query.setDistinct(true);
117    configurations = query.iterate(dc);
118  }
119  catch (Throwable t)
120  {
121    cc.setMessage(t.getMessage());
122    t.printStackTrace();
123  }
124  int numListed = 0;
125  ExtensionsInvoker<ButtonAction> invoker = ToolbarUtil.useExtensions(jspContext);
126  ExtensionsInvoker<ListColumnAction<PluginConfiguration,?>> columnsInvoker = ListColumnUtil.useExtensions(jspContext);
127  %>
128  <base:page title="<%=title==null ? "Plugin configurations" : title%>" type="<%=mode.getPageType()%>" id="list-page">
129  <base:head scripts="table.js,~configurations.js" styles="table.css,toolbar.css">
130    <ext:scripts context="<%=jspContext%>" />
131    <ext:stylesheets context="<%=jspContext%>" />
132  </base:head>
133 
134  <base:body>
135    <h1><%=title==null ? "Plugin configurations" : title%></h1>
136    <div class="content">
137    <tbl:table 
138      id="configurations" 
139      columns="<%=cc.getSetting("columns")%>"
140      sortby="<%=cc.getSortProperty()%>" 
141      direction="<%=cc.getSortDirection()%>"
142      action="index.jsp"
143      sc="<%=sc%>"
144      item="<%=itemType%>"
145      filterrows="<%=cc.getFilterRows()%>"
146      subclass="fulltable sticky-headers"
147      >
148      <tbl:hidden 
149        name="mode" 
150        value="<%=mode.getName()%>" 
151      />
152      <tbl:hidden 
153        name="callback" 
154        value="<%=callback%>" 
155        skip="<%=callback == null%>" 
156      />
157      <tbl:columndef 
158        id="name"
159        property="name"
160        datatype="string"
161        title="Name"
162        sortable="true" 
163        filterable="true"
164        exportable="true"
165        show="always" 
166      />
167      <tbl:columndef 
168        id="id"
169        clazz="uniquecol"
170        property="id"
171        datatype="int"
172        title="ID"
173        sortable="true"
174        filterable="true"
175        exportable="true"
176      />
177      <tbl:columndef 
178        id="entryDate"
179        property="entryDate"
180        datatype="date"
181        title="Registered"
182        sortable="true" 
183        filterable="true"
184        exportable="true"
185        formatter="<%=dateFormatter%>"
186      />
187      <tbl:columndef 
188        id="pluginType"
189        property="pluginDefinition.mainType"
190        datatype="int"
191        enumeration="<%=mainTypes%>"
192        title="Type"
193        sortable="true" 
194        filterable="true"
195        exportable="true"
196      />
197      <tbl:columndef 
198        id="contexts"
199        property="$ctx.itemType"
200        datatype="int"
201        enumeration="<%=itemTypes%>"
202        title="Items"
203        sortable="false" 
204        filterable="true"
205        exportable="false"
206      />
207      <tbl:columndef 
208        id="pluginDefinition"
209        property="pluginDefinition.name"
210        datatype="string"
211        title="Plugin definition"
212        sortable="true" 
213        filterable="true"
214        exportable="true"
215      />
216      <tbl:columndef 
217        id="owner"
218        property="owner.name"
219        datatype="string"
220        title="Owner"
221        sortable="true" 
222        filterable="true"
223        exportable="true"
224      />
225      <tbl:columndef 
226        id="description"
227        property="description"
228        datatype="string"
229        title="Description" 
230        sortable="true" 
231        filterable="true" 
232        exportable="true"
233      />
234      <tbl:columndef 
235        id="actions"
236        title="Actions"
237      />
238      <tbl:columndef
239        id="permission"
240        title="Permission"
241      />
242      <tbl:columndef
243        id="sharedTo"
244        title="Shared to"
245        filterable="true"
246        filterproperty="!sharedTo.name"
247        datatype="string"
248      />
249      <tbl:columndef 
250        id="xt-columns" 
251        extensions="<%=columnsInvoker%>" 
252        jspcontext="<%=jspContext%>" 
253      />
254      <div class="panelgroup bg-filled-50 bottomborder">
255        <tbl:toolbar
256          subclass="bottomborder"
257          visible="<%=mode.hasToolbar()%>"
258          >
259          <tbl:button 
260            id="btnNewItem"
261            disabled="<%=!createPermission%>" 
262            image="new.png" 
263            title="New&hellip;" 
264            tooltip="<%=createPermission ? "Create new configuration" : "You do not have permission to create configurations"%>" 
265          />
266          <tbl:button 
267            id="btnDeleteItems"
268            image="delete.png"
269            title="Delete" 
270            tooltip="Delete the selected items" 
271          />
272          <tbl:button 
273            id="btnRestoreItems"
274            image="restore.png"
275            title="Restore" 
276            tooltip="Restore the selected (deleted) items"
277          />
278          <tbl:button 
279            id="btnShareItems"
280            image="share.png"
281            title="Share&hellip;" 
282            tooltip="Share the selected items"
283          />
284          <tbl:button 
285            id="btnSetOwner"
286            image="take_ownership.png"
287            title="Set owner&hellip;"
288            tooltip="Change owner of the selected items"
289          />
290          <tbl:button 
291            id="btnColumns"
292            image="columns.png" 
293            title="Columns&hellip;" 
294            tooltip="Show, hide and re-order columns" 
295          />
296          <tbl:button 
297            id="btnImport"
298            data-plugin-type="IMPORT"
299            image="import.png" 
300            title="Import&hellip;" 
301            tooltip="Import data" 
302            visible="<%=pluginCount.containsKey(Plugin.MainType.IMPORT)%>"
303          />
304          <tbl:button 
305            id="btnExport"
306            data-plugin-type="EXPORT"
307            image="export.png" 
308            title="Export&hellip;" 
309            tooltip="Export data" 
310            visible="<%=pluginCount.containsKey(Plugin.MainType.EXPORT)%>"
311          />
312          <tbl:button 
313            id="btnRunPlugin"
314            data-plugin-type="OTHER"
315            image="runplugin.png" 
316            title="Run plugin&hellip;" 
317            tooltip="Run a plugin" 
318            visible="<%=pluginCount.containsKey(Plugin.MainType.OTHER)%>"
319          />
320          <ext:render extensions="<%=invoker%>" context="<%=jspContext%>" 
321            wrapper="<%=new PrefixSuffixRenderer<ButtonAction>(jspContext, "<td>", "</td>") %>"/>
322        </tbl:toolbar>
323        <tbl:panel>
324          <tbl:presetselector />
325          <tbl:navigator
326            page="<%=cc.getPage()%>" 
327            rowsperpage="<%=cc.getRowsPerPage()%>" 
328            totalrows="<%=configurations == null ? 0 : configurations.getTotalCount()%>" 
329            visible="<%=mode.hasNavigator()%>"
330          />
331        </tbl:panel>
332      </div>
333      <tbl:data>
334        <tbl:headers>
335          <tbl:headerrow>
336            <tbl:header colspan="3" />
337            <tbl:columnheaders />
338          </tbl:headerrow>
339          <%
340          int numFilters = cc.getNumPropertyFilters();
341          int numRows = cc.getFilterRows();
342          for (int filterNo = 0; filterNo < numRows; filterNo++)
343          {
344            boolean lastRow = filterNo == numRows-1;
345            %>
346            <tbl:headerrow>
347              <tbl:header subclass="index" />
348              <tbl:header 
349                subclass="check" 
350                visible="<%=mode.hasCheck()%>"
351                ><base:icon 
352                  subclass="link table-check"
353                  image="check_uncheck.png" 
354                  tooltip="Toggle all (use CTRL, ALT or SHIFT to check/uncheck)" 
355                  visible="<%=lastRow%>"
356                /></tbl:header>
357              <tbl:header 
358                subclass="check" 
359                visible="<%=mode.hasRadio()%>"
360                />
361              <tbl:header 
362                subclass="icons" 
363                visible="<%=mode.hasIcons()%>"
364                >
365                <base:icon
366                  subclass="link table-filter-row-action"
367                  image="add.png"
368                  tooltip="Add extra filter row"
369                  visible="<%=lastRow%>"
370                /><base:icon
371                  subclass="link table-filter-row-action"
372                  image="remove.png"
373                  tooltip="Remove this filter row"
374                  visible="<%=numRows > 1 || numFilters > 0 %>"
375                  data-remove-row="<%=filterNo%>"
376                />
377              </tbl:header>
378              <tbl:propertyfilter row="<%=filterNo%>" />
379            </tbl:headerrow>
380            <%
381          }
382          %>
383          <tbl:columnsubtitles />
384        </tbl:headers>
385        <tbl:rows>
386          <%
387          if (cc.getMessage() != null)
388          {
389            %>
390            <tbl:panel subclass="bg-filled-50">
391              <div class="messagecontainer error"><%=cc.getMessage()%></div>
392            </tbl:panel>
393            <%
394            cc.setMessage(null);
395          }
396          int index = cc.getPage()*cc.getRowsPerPage();
397          int selectedItemId = cc.getId();
398          Set<GuiContext> contexts = new TreeSet<GuiContext>(new ToStringComparator<GuiContext>(false));
399          if (configurations != null)
400          {           
401            while (configurations.hasNext())
402            {
403              PluginConfiguration item = configurations.next();
404              PluginDefinition plugin = null;
405              Nameable nameableProxy = null;
406              contexts.clear();
407              try
408              {
409                plugin = item.getPluginDefinition();
410                contexts.addAll(plugin.getGuiContexts());
411              }
412              catch (PermissionDeniedException ex)
413              {}
414              int itemId = item.getId();
415             
416              boolean deletePermission = item.hasPermission(Permission.DELETE);
417              boolean sharePermission = item.hasPermission(Permission.SET_PERMISSION);
418              boolean writePermission = item.hasPermission(Permission.WRITE);
419              String name = HTML.encodeTags(item.getName());
420              String tooltip = mode.isSelectionMode() ? 
421                  "Select this item" : "View this item" + (writePermission ? " (use CTRL, ALT or SHIFT to edit)" : "");
422              index++;
423              numListed++;
424              %>
425              <tbl:row>
426                <tbl:header 
427                  clazz="index"
428                  ><%=index%></tbl:header>
429                <tbl:header 
430                  clazz="check" 
431                  visible="<%=mode.hasCheck()%>"
432                  ><input 
433                    type="checkbox" 
434                    name="<%=itemId%>" 
435                    value="<%=itemId%>" 
436                    title="<%=name%>" 
437                    <%=cc.getSelected().contains(itemId) ? "checked" : ""%> 
438                  ></tbl:header>
439                <tbl:header 
440                  clazz="check" 
441                  visible="<%=mode.hasRadio()%>"
442                  ><input 
443                    type="radio" 
444                    name="item_id" 
445                    value="<%=itemId%>" 
446                    title="<%=name%>" 
447                    <%=selectedItemId == itemId ? "checked" : ""%>
448                  ></tbl:header>
449                <tbl:header 
450                  clazz="icons" 
451                  visible="<%=mode.hasIcons()%>"
452                  ><base:icon 
453                    image="deleted.png"
454                    id="<%="delete."+itemId %>"
455                    subclass="<%=deletePermission ? "table-delete-item" : "disabled" %>"
456                    data-item-id="<%=itemId%>"
457                    tooltip="This item has been scheduled for deletion" 
458                    visible="<%=item.isRemoved()%>"
459                  /><base:icon 
460                    image="shared.png" 
461                    id="<%="share."+itemId %>"
462                    subclass="<%=sharePermission ? "table-share-item" : "disabled" %>"
463                    data-item-id="<%=itemId%>"
464                    tooltip="This item is shared to other users, groups and/or projects" 
465                    visible="<%=item.isShared()%>"
466                  />&nbsp;</tbl:header>
467                <tbl:cell column="name"><div 
468                  class="link table-item"
469                  data-item-id="<%=itemId%>"
470                  data-no-edit="<%=writePermission ? 0 : 1 %>" 
471                  tabindex="0"
472                  title="<%=tooltip%>"><%=name%></div></tbl:cell>
473                <tbl:cell column="id"><%=item.getId()%></tbl:cell>
474                <tbl:cell column="entryDate" value="<%=item.getEntryDate()%>" />
475                <tbl:cell column="pluginType"><%=plugin == null ? "<i>- denied -</i>" : plugin.getMainType().toString()%></tbl:cell>
476                <tbl:cell column="contexts"><%=plugin == null ? "<i>- denied -</i>" : (contexts.isEmpty() ? "<i>- none -</i>" : Values.getString(contexts, ", ", true))%></tbl:cell>
477                <tbl:cell column="pluginDefinition"><%=mode.hasPropertyLink() ? Base.getLinkedName(ID, plugin, plugin == null, mode.hasEditLink()): Base.getEncodedName(nameableProxy, plugin == null)%></tbl:cell>
478                <tbl:cell column="owner"
479                  ><base:propertyvalue 
480                    item="<%=item%>" 
481                    property="owner"
482                    enableEditLink="<%=mode.hasEditLink()%>" 
483                    enablePropertyLink="<%=mode.hasPropertyLink()%>"
484                  /></tbl:cell>
485                <tbl:cell column="description"><%=HTML.encodeTags(item.getDescription())%></tbl:cell>
486                <tbl:cell column="actions">
487                  <%
488                  if (plugin != null && plugin.isInteractive() && plugin.supportsConfigurations())
489                  {
490                    %>
491                    <base:icon 
492                      id="<%="configure."+itemId%>"
493                      subclass="auto-init"
494                      data-auto-init="configure-plugin"
495                      data-item-id="<%=itemId%>"
496                      image="runplugin.png" 
497                      tooltip="Configure this plugin " 
498                      visible="<%=writePermission%>" />
499                    <%
500                  }
501                  %>
502                  <base:icon
503                    id="<%="copy."+itemId%>"
504                    image="copy.png"
505                    subclass="auto-init"
506                    data-auto-init="copy-config"
507                    data-item-id="<%=itemId%>"
508                    tooltip="Create a copy of this item"
509                    visible="<%=createPermission%>"
510                  />
511                </tbl:cell>
512                <tbl:cell column="permission"><%=PermissionUtil.getShortPermissions(item)%></tbl:cell>
513                <tbl:cell column="sharedTo">
514                  <%
515                  Iterator<Nameable> sharees = ShareableUtil.getSharedTo(dc, item).iterator();
516                  while(sharees.hasNext())
517                  {
518                    Nameable n = sharees.next();
519                    if (mode.hasPropertyLink())
520                    {
521                      out.write(Base.getLinkedName(ID, n, false, mode.hasEditLink()));
522                    }
523                    else
524                    {
525                      out.write(HTML.encodeTags(n.getName()));
526                    }
527                    out.write(sharees.hasNext() ? ", " : "");
528                  }
529                  %>
530                </tbl:cell>
531                <tbl:xt-cells dc="<%=dc%>" item="<%=item%>">
532                  <tbl:cell column="xt-columns" />
533                </tbl:xt-cells>
534              </tbl:row>
535              <%
536              }
537            }
538          if (numListed == 0)
539          {
540            %>
541            <tbl:panel subclass="bg-filled-50">
542              <div class="messagecontainer note">
543              <%=configurations == null || configurations.getTotalCount() == 0 ? "No configurations were found" : "No configurations on this page. Please select another page!" %>
544              </div>
545            </tbl:panel>
546            <%
547          }
548          %>
549        </tbl:rows>
550      </tbl:data>
551    </tbl:table>
552    </div>
553   
554    <base:buttongroup subclass="dialogbuttons">
555      <base:button id="btnOk" title="Ok" visible="<%=mode.hasOkButton()%>" />
556      <base:button id="close" title="Cancel" visible="<%=mode.hasCancelButton()%>" />
557      <base:button id="close" title="Close" visible="<%=mode.hasCloseButton()%>" />
558    </base:buttongroup>
559   
560  </base:body>
561  </base:page>
562  <%
563}
564finally
565{
566  if (configurations != null) configurations.close();
567  if (dc != null) dc.close();
568}
569%>
Note: See TracBrowser for help on using the repository browser.