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

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

References #2246: Sticky table headers

It should now be implemented on all list pages.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Date Id
File size: 18.4 KB
Line 
1<%-- $Id: list_configurations.jsp 7939 2021-05-04 07:30:31Z 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"
147      stickyheaders="name"
148      >
149      <tbl:hidden 
150        name="mode" 
151        value="<%=mode.getName()%>" 
152      />
153      <tbl:hidden 
154        name="callback" 
155        value="<%=callback%>" 
156        skip="<%=callback == null%>" 
157      />
158      <tbl:columndef 
159        id="name"
160        property="name"
161        datatype="string"
162        title="Name"
163        sortable="true" 
164        filterable="true"
165        exportable="true"
166        show="always" 
167      />
168      <tbl:columndef 
169        id="id"
170        clazz="uniquecol"
171        property="id"
172        datatype="int"
173        title="ID"
174        sortable="true"
175        filterable="true"
176        exportable="true"
177      />
178      <tbl:columndef 
179        id="entryDate"
180        property="entryDate"
181        datatype="date"
182        title="Registered"
183        sortable="true" 
184        filterable="true"
185        exportable="true"
186        formatter="<%=dateFormatter%>"
187      />
188      <tbl:columndef 
189        id="pluginType"
190        property="pluginDefinition.mainType"
191        datatype="int"
192        enumeration="<%=mainTypes%>"
193        title="Type"
194        sortable="true" 
195        filterable="true"
196        exportable="true"
197      />
198      <tbl:columndef 
199        id="contexts"
200        property="$ctx.itemType"
201        datatype="int"
202        enumeration="<%=itemTypes%>"
203        title="Items"
204        sortable="false" 
205        filterable="true"
206        exportable="false"
207      />
208      <tbl:columndef 
209        id="pluginDefinition"
210        property="pluginDefinition.name"
211        datatype="string"
212        title="Plugin definition"
213        sortable="true" 
214        filterable="true"
215        exportable="true"
216      />
217      <tbl:columndef 
218        id="owner"
219        property="owner.name"
220        datatype="string"
221        title="Owner"
222        sortable="true" 
223        filterable="true"
224        exportable="true"
225      />
226      <tbl:columndef 
227        id="description"
228        property="description"
229        datatype="string"
230        title="Description" 
231        sortable="true" 
232        filterable="true" 
233        exportable="true"
234      />
235      <tbl:columndef 
236        id="actions"
237        title="Actions"
238      />
239      <tbl:columndef
240        id="permission"
241        title="Permission"
242      />
243      <tbl:columndef
244        id="sharedTo"
245        title="Shared to"
246        filterable="true"
247        filterproperty="!sharedTo.name"
248        datatype="string"
249      />
250      <tbl:columndef 
251        id="xt-columns" 
252        extensions="<%=columnsInvoker%>" 
253        jspcontext="<%=jspContext%>" 
254      />
255      <div class="panelgroup bg-filled-50 bottomborder">
256        <tbl:toolbar
257          subclass="bottomborder"
258          visible="<%=mode.hasToolbar()%>"
259          >
260          <tbl:button 
261            id="btnNewItem"
262            disabled="<%=!createPermission%>" 
263            image="new.png" 
264            title="New&hellip;" 
265            tooltip="<%=createPermission ? "Create new configuration" : "You do not have permission to create configurations"%>" 
266          />
267          <tbl:button 
268            id="btnDeleteItems"
269            image="delete.png"
270            title="Delete" 
271            tooltip="Delete the selected items" 
272          />
273          <tbl:button 
274            id="btnRestoreItems"
275            image="restore.png"
276            title="Restore" 
277            tooltip="Restore the selected (deleted) items"
278          />
279          <tbl:button 
280            id="btnShareItems"
281            image="share.png"
282            title="Share&hellip;" 
283            tooltip="Share the selected items"
284          />
285          <tbl:button 
286            id="btnSetOwner"
287            image="take_ownership.png"
288            title="Set owner&hellip;"
289            tooltip="Change owner of the selected items"
290          />
291          <tbl:button 
292            id="btnColumns"
293            image="columns.png" 
294            title="Columns&hellip;" 
295            tooltip="Show, hide and re-order columns" 
296          />
297          <tbl:button 
298            id="btnImport"
299            data-plugin-type="IMPORT"
300            image="import.png" 
301            title="Import&hellip;" 
302            tooltip="Import data" 
303            visible="<%=pluginCount.containsKey(Plugin.MainType.IMPORT)%>"
304          />
305          <tbl:button 
306            id="btnExport"
307            data-plugin-type="EXPORT"
308            image="export.png" 
309            title="Export&hellip;" 
310            tooltip="Export data" 
311            visible="<%=pluginCount.containsKey(Plugin.MainType.EXPORT)%>"
312          />
313          <tbl:button 
314            id="btnRunPlugin"
315            data-plugin-type="OTHER"
316            image="runplugin.png" 
317            title="Run plugin&hellip;" 
318            tooltip="Run a plugin" 
319            visible="<%=pluginCount.containsKey(Plugin.MainType.OTHER)%>"
320          />
321          <ext:render extensions="<%=invoker%>" context="<%=jspContext%>" 
322            wrapper="<%=new PrefixSuffixRenderer<ButtonAction>(jspContext, "<td>", "</td>") %>"/>
323        </tbl:toolbar>
324        <tbl:panel>
325          <tbl:presetselector />
326          <tbl:navigator
327            page="<%=cc.getPage()%>" 
328            rowsperpage="<%=cc.getRowsPerPage()%>" 
329            totalrows="<%=configurations == null ? 0 : configurations.getTotalCount()%>" 
330            visible="<%=mode.hasNavigator()%>"
331          />
332        </tbl:panel>
333      </div>
334      <tbl:data>
335        <tbl:headers>
336          <tbl:headerrow>
337            <tbl:header clazz="row-index bg-filled-100" />
338            <tbl:columnheaders />
339          </tbl:headerrow>
340          <%
341          int numFilters = cc.getNumPropertyFilters();
342          int numRows = cc.getFilterRows();
343          for (int filterNo = 0; filterNo < numRows; filterNo++)
344          {
345            boolean lastRow = filterNo == numRows-1;
346            %>
347            <tbl:headerrow>
348              <tbl:header subclass="row-index bg-filled-100">
349                <div class="index-<%=mode.getName()%>">
350                  <div class="index"></div>
351                  <div class="check">
352                    <base:icon 
353                      subclass="link table-check"
354                      image="check_uncheck.png" 
355                      tooltip="Toggle all (use CTRL, ALT or SHIFT to check/uncheck)" 
356                      visible="<%=lastRow && mode.hasCheck()%>"
357                    />
358                  </div>
359                  <div class="icons">
360                    <base:icon
361                      subclass="link table-filter-row-action"
362                      image="add.png"
363                      tooltip="Add extra filter row"
364                      visible="<%=lastRow%>"
365                    /><base:icon
366                      subclass="link table-filter-row-action"
367                      image="remove.png"
368                      tooltip="Remove this filter row"
369                      visible="<%=numRows > 1 || numFilters > 0 %>"
370                      data-remove-row="<%=filterNo%>"
371                    />
372                  </div>
373                </div>
374              </tbl:header>
375              <tbl:propertyfilter row="<%=filterNo%>" />
376            </tbl:headerrow>
377            <%
378          }
379          %>
380          <tbl:columnsubtitles />
381        </tbl:headers>
382        <tbl:rows>
383          <%
384          if (cc.getMessage() != null)
385          {
386            %>
387            <tbl:panel subclass="bg-filled-50">
388              <div class="messagecontainer error"><%=cc.getMessage()%></div>
389            </tbl:panel>
390            <%
391            cc.setMessage(null);
392          }
393          int index = cc.getPage()*cc.getRowsPerPage();
394          int selectedItemId = cc.getId();
395          Set<GuiContext> contexts = new TreeSet<GuiContext>(new ToStringComparator<GuiContext>(false));
396          if (configurations != null)
397          {           
398            while (configurations.hasNext())
399            {
400              PluginConfiguration item = configurations.next();
401              PluginDefinition plugin = null;
402              Nameable nameableProxy = null;
403              contexts.clear();
404              try
405              {
406                plugin = item.getPluginDefinition();
407                contexts.addAll(plugin.getGuiContexts());
408              }
409              catch (PermissionDeniedException ex)
410              {}
411              int itemId = item.getId();
412             
413              boolean deletePermission = item.hasPermission(Permission.DELETE);
414              boolean sharePermission = item.hasPermission(Permission.SET_PERMISSION);
415              boolean writePermission = item.hasPermission(Permission.WRITE);
416              String name = HTML.encodeTags(item.getName());
417              String tooltip = mode.isSelectionMode() ? 
418                  "Select this item" : "View this item" + (writePermission ? " (use CTRL, ALT or SHIFT to edit)" : "");
419              index++;
420              numListed++;
421              %>
422              <tbl:row>
423                <tbl:header clazz="row-index bg-filled-100">
424                  <div class="index-<%=mode.getName()%>">
425                    <div class="index <%=index>999?"index-smaller":""%>"><%=index%></div>
426                    <div class="check">
427                      <base:input
428                        type="checkbox" 
429                        name="<%=itemId%>" 
430                        value="<%=itemId%>" 
431                        title="<%=name%>" 
432                        checked="<%=cc.getSelected().contains(itemId)%>"
433                        visible="<%=mode.hasCheck()%>"
434                      />
435                      <base:input 
436                        type="radio" 
437                        name="item_id" 
438                        value="<%=itemId%>" 
439                        title="<%=name%>" 
440                        checked="<%=selectedItemId == itemId%>"
441                        visible="<%=mode.hasRadio()%>"
442                      />
443                    </div>
444                    <div class="icons">
445                      <base:icon 
446                        image="deleted.png"
447                        id="<%="delete."+itemId %>"
448                        subclass="<%=deletePermission ? "table-delete-item" : "disabled" %>"
449                        data-item-id="<%=itemId%>"
450                        tooltip="This item has been scheduled for deletion" 
451                        visible="<%=item.isRemoved()%>"
452                      /><base:icon 
453                        image="shared.png" 
454                        id="<%="share."+itemId %>"
455                        subclass="<%=sharePermission ? "table-share-item" : "disabled" %>"
456                        data-item-id="<%=itemId%>"
457                        tooltip="This item is shared to other users, groups and/or projects" 
458                        visible="<%=item.isShared()%>"
459                      />
460                    </div>
461                  </div>
462                </tbl:header>
463                <tbl:cell column="name"><div 
464                  class="link table-item"
465                  data-item-id="<%=itemId%>"
466                  data-no-edit="<%=writePermission ? 0 : 1 %>" 
467                  tabindex="0"
468                  title="<%=tooltip%>"><%=name%></div></tbl:cell>
469                <tbl:cell column="id"><%=item.getId()%></tbl:cell>
470                <tbl:cell column="entryDate" value="<%=item.getEntryDate()%>" />
471                <tbl:cell column="pluginType"><%=plugin == null ? "<i>- denied -</i>" : plugin.getMainType().toString()%></tbl:cell>
472                <tbl:cell column="contexts"><%=plugin == null ? "<i>- denied -</i>" : (contexts.isEmpty() ? "<i>- none -</i>" : Values.getString(contexts, ", ", true))%></tbl:cell>
473                <tbl:cell column="pluginDefinition"><%=mode.hasPropertyLink() ? Base.getLinkedName(ID, plugin, plugin == null, mode.hasEditLink()): Base.getEncodedName(nameableProxy, plugin == null)%></tbl:cell>
474                <tbl:cell column="owner"
475                  ><base:propertyvalue 
476                    item="<%=item%>" 
477                    property="owner"
478                    enableEditLink="<%=mode.hasEditLink()%>" 
479                    enablePropertyLink="<%=mode.hasPropertyLink()%>"
480                  /></tbl:cell>
481                <tbl:cell column="description"><%=HTML.encodeTags(item.getDescription())%></tbl:cell>
482                <tbl:cell column="actions">
483                  <%
484                  if (plugin != null && plugin.isInteractive() && plugin.supportsConfigurations())
485                  {
486                    %>
487                    <base:icon 
488                      id="<%="configure."+itemId%>"
489                      subclass="auto-init"
490                      data-auto-init="configure-plugin"
491                      data-item-id="<%=itemId%>"
492                      image="runplugin.png" 
493                      tooltip="Configure this plugin " 
494                      visible="<%=writePermission%>" />
495                    <%
496                  }
497                  %>
498                  <base:icon
499                    id="<%="copy."+itemId%>"
500                    image="copy.png"
501                    subclass="auto-init"
502                    data-auto-init="copy-config"
503                    data-item-id="<%=itemId%>"
504                    tooltip="Create a copy of this item"
505                    visible="<%=createPermission%>"
506                  />
507                </tbl:cell>
508                <tbl:cell column="permission"><%=PermissionUtil.getShortPermissions(item)%></tbl:cell>
509                <tbl:cell column="sharedTo">
510                  <%
511                  Iterator<Nameable> sharees = ShareableUtil.getSharedTo(dc, item).iterator();
512                  while(sharees.hasNext())
513                  {
514                    Nameable n = sharees.next();
515                    if (mode.hasPropertyLink())
516                    {
517                      out.write(Base.getLinkedName(ID, n, false, mode.hasEditLink()));
518                    }
519                    else
520                    {
521                      out.write(HTML.encodeTags(n.getName()));
522                    }
523                    out.write(sharees.hasNext() ? ", " : "");
524                  }
525                  %>
526                </tbl:cell>
527                <tbl:xt-cells dc="<%=dc%>" item="<%=item%>">
528                  <tbl:cell column="xt-columns" />
529                </tbl:xt-cells>
530              </tbl:row>
531              <%
532              }
533            }
534          if (numListed == 0)
535          {
536            %>
537            <tbl:panel subclass="bg-filled-50">
538              <div class="messagecontainer note">
539              <%=configurations == null || configurations.getTotalCount() == 0 ? "No configurations were found" : "No configurations on this page. Please select another page!" %>
540              </div>
541            </tbl:panel>
542            <%
543          }
544          %>
545        </tbl:rows>
546      </tbl:data>
547    </tbl:table>
548    </div>
549   
550    <base:buttongroup subclass="dialogbuttons">
551      <base:button id="btnOk" title="Ok" visible="<%=mode.hasOkButton()%>" />
552      <base:button id="close" title="Cancel" visible="<%=mode.hasCancelButton()%>" />
553      <base:button id="close" title="Close" visible="<%=mode.hasCloseButton()%>" />
554    </base:buttongroup>
555   
556  </base:body>
557  </base:page>
558  <%
559}
560finally
561{
562  if (configurations != null) configurations.close();
563  if (dc != null) dc.close();
564}
565%>
Note: See TracBrowser for help on using the repository browser.