source: trunk/www/admin/protocols/list_protocol.jsp @ 6705

Last change on this file since 6705 was 6705, checked in by Nicklas Nordborg, 7 years ago

References #1912: Add more filter rows in list pages

Implemented in Administrate menu: Quota, software, hardware, protocols, clients, news, reporter clone templates.

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