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