source: branches/3.4-stable/www/admin/protocols/list_protocol.jsp @ 6780

Last change on this file since 6780 was 6780, checked in by Nicklas Nordborg, 8 years ago

Fixes #1929: Add 'none' option in annotation filters

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 17.5 KB
Line 
1<%-- $Id: list_protocol.jsp 6780 2015-03-18 06:53:09Z 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      subclass="fulltable"
137      >
138      <tbl:hidden 
139        name="mode" 
140        value="<%=mode.getName()%>" 
141      />
142      <tbl:hidden 
143        name="callback" 
144        value="<%=callback%>" 
145        skip="<%=callback == null%>" 
146      />
147      <tbl:columndef 
148        id="name"
149        property="name"
150        datatype="string"
151        title="Name"
152        sortable="true" 
153        filterable="true"
154        exportable="true"
155        show="always" 
156      />
157      <tbl:columndef 
158        id="id"
159        clazz="uniquecol"
160        property="id"
161        datatype="int"
162        title="ID"
163        sortable="true"
164        filterable="true"
165        exportable="true"
166      />
167      <tbl:columndef 
168        id="entryDate"
169        property="entryDate"
170        datatype="date"
171        title="Registered"
172        sortable="true" 
173        filterable="true"
174        exportable="true"
175        formatter="<%=dateFormatter%>"
176      />
177      <tbl:columndef 
178        id="externalId"
179        property="externalId"
180        datatype="string"
181        title="External id"
182        sortable="true" 
183        filterable="true"
184        exportable="true"
185      />     
186      <tbl:columndef 
187        id="itemSubtype"
188        property="itemSubtype"
189        sortproperty="itemSubtype.name"
190        exportproperty="itemSubtype.name:string"
191        datatype="int"
192        enumeration="<%=Enumeration.fromItems(subtypesQuery.list(dc), "-none-")%>"
193        title="Type"
194        sortable="true" 
195        filterable="true"
196        exportable="true"
197      />
198      <tbl:columndef
199        id="file"
200        property="file.name"
201        datatype="string"
202        title="File"
203        sortable="true" 
204        filterable="true"
205        exportable="true"
206      />
207      <tbl:columndef 
208        id="owner"
209        property="owner.name"
210        datatype="string"
211        title="Owner"
212        sortable="true" 
213        filterable="true"
214        exportable="true"
215      />
216      <tbl:columndef 
217        id="description"
218        property="description"
219        datatype="string"
220        title="Description" 
221        sortable="true" 
222        filterable="true" 
223        exportable="true"
224      />
225      <%
226      for (AnnotationLoaderUtil loader : annotationLoaders)
227      {
228        AnnotationType at = loader.getAnnotationType();
229        Enumeration<String, String> annotationEnum = null;
230        Formatter formatter = FormatterFactory.getTypeFormatter(sc, at.getValueType());
231        if (at.isEnumeration())
232        {
233          annotationEnum = new Enumeration<String, String>();
234          if (!at.getDisplayAsList()) annotationEnum.add("", "-none-");
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          <tbl:headerrow>
362            <tbl:header subclass="index" />
363            <tbl:header 
364              subclass="check" 
365              visible="<%=mode.hasCheck()%>"
366              ><base:icon 
367                id="check.uncheck"
368                image="check_uncheck.png" 
369                tooltip="Check/uncheck all" 
370                 
371              /></tbl:header>
372            <tbl:header 
373              subclass="check" 
374              visible="<%=mode.hasRadio()%>"
375              />
376            <tbl:header 
377              subclass="icons" 
378              visible="<%=mode.hasIcons()%>"
379              />
380            <tbl:propertyfilter />
381          </tbl:headerrow>
382        </tbl:headers>
383        <tbl:rows>
384          <%
385          if (cc.getMessage() != null)
386          {
387            %>
388            <tbl:panel subclass="bg-filled-50">
389              <div class="messagecontainer error"><%=cc.getMessage()%></div>
390            </tbl:panel>
391            <%
392            cc.setMessage(null);
393          }
394          int index = cc.getPage()*cc.getRowsPerPage();
395          int selectedItemId = Values.getInt(request.getParameter("item_id"));
396          if (protocols != null)
397          {
398            while (protocols.hasNext())
399            {
400              Protocol item = protocols.next();
401              int itemId = item.getId();
402             
403             
404              boolean deletePermission = item.hasPermission(Permission.DELETE);
405              boolean sharePermission = item.hasPermission(Permission.SET_PERMISSION);
406              boolean writePermission = item.hasPermission(Permission.WRITE);
407              String name = HTML.encodeTags(item.getName());
408              String tooltip = mode.isSelectionMode() ? 
409                  "Select this item" : "View this item" + (writePermission ? " (use CTRL, ALT or SHIFT to edit)" : "");
410              index++;
411              numListed++;
412              %>
413              <tbl:row>
414                <tbl:header 
415                  clazz="index"
416                  ><%=index%></tbl:header>
417                <tbl:header 
418                  clazz="check" 
419                  visible="<%=mode.hasCheck()%>"
420                  ><input 
421                    type="checkbox" 
422                    name="<%=itemId%>" 
423                    value="<%=itemId%>" 
424                    title="<%=name%>" 
425                    <%=cc.getSelected().contains(itemId) ? "checked" : ""%> 
426                  ></tbl:header>
427                <tbl:header 
428                  clazz="check" 
429                  visible="<%=mode.hasRadio()%>"
430                  ><input 
431                    type="radio" 
432                    name="item_id" 
433                    value="<%=itemId%>" 
434                    title="<%=name%>" 
435                    <%=selectedItemId == itemId ? "checked" : ""%>
436                  ></tbl:header>
437                <tbl:header 
438                  clazz="icons" 
439                  visible="<%=mode.hasIcons()%>"
440                  ><base:icon 
441                    image="deleted.png"
442                    id="<%="delete."+itemId %>"
443                    subclass="<%=deletePermission ? "table-delete-item" : null %>"
444                    data-item-id="<%=itemId%>"
445                    tooltip="This item has been scheduled for deletion" 
446                    visible="<%=item.isRemoved()%>"
447                  /><base:icon 
448                    image="shared.png" 
449                    id="<%="share."+itemId %>"
450                    subclass="<%=sharePermission ? "table-share-item" : null %>"
451                    data-item-id="<%=itemId%>"
452                    tooltip="This item is shared to other users, groups and/or projects" 
453                    visible="<%=item.isShared()%>"
454                  />&nbsp;</tbl:header>
455                <tbl:cell column="name"><div
456                  class="link table-item"
457                  data-item-id="<%=itemId%>"
458                  data-no-edit="<%=writePermission ? 0 : 1 %>" 
459                  tabindex="0"
460                  title="<%=tooltip%>"><%=name%></div></tbl:cell>
461                <tbl:cell column="id"><%=item.getId()%></tbl:cell>
462                <tbl:cell column="entryDate" value="<%=item.getEntryDate()%>" />
463                <tbl:cell column="owner"
464                  ><base:propertyvalue 
465                    item="<%=item%>" 
466                    property="owner"
467                    enableEditLink="<%=mode.hasEditLink()%>" 
468                    enablePropertyLink="<%=mode.hasPropertyLink()%>"
469                  /></tbl:cell>
470                <tbl:cell column="file"
471                  ><base:propertyvalue 
472                    item="<%=item%>" 
473                    property="file"
474                    enableEditLink="<%=mode.hasEditLink()%>" 
475                    enablePropertyLink="<%=mode.hasPropertyLink()%>"
476                  /></tbl:cell>
477                <tbl:cell column="itemSubtype"
478                  ><base:propertyvalue 
479                    item="<%=item%>" 
480                    property="itemSubtype"
481                    enableEditLink="<%=mode.hasEditLink()%>" 
482                    enablePropertyLink="<%=mode.hasPropertyLink()%>"
483                  /></tbl:cell>
484                <tbl:cell column="externalId"><%=HTML.encodeTags(item.getExternalId())%></tbl:cell>               
485                <tbl:cell column="description"><%=HTML.encodeTags(item.getDescription())%></tbl:cell>
486                <%
487                if (item.isAnnotated())
488                {
489                  AnnotationSetSnapshot snapshot = manager.getSnapshot(dc, item.getAnnotationSet().getId());
490                  for (AnnotationLoaderUtil loader : annotationLoaders)
491                  {
492                    %>
493                    <tbl:cell 
494                      column="<%="at"+loader.getId()%>"
495                      ><%
496                      if (loader.find(snapshot)) 
497                      {
498                        %><tbl:cellvalue 
499                          list="<%=loader.getValues()%>"
500                          suffix="<%=loader.getUnitSymbol()%>"
501                        /><%
502                      }
503                      %></tbl:cell>
504                    <%
505                  }
506                }
507                %>
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              <%=protocols == null || protocols.getTotalCount() == 0 ? "No protocols were found" : "No protocols 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 (protocols != null) protocols.close();
563  if (dc != null) dc.close();
564}
565%>
Note: See TracBrowser for help on using the repository browser.