source: trunk/www/biomaterials/samples/list_samples.jsp @ 2917

Last change on this file since 2917 was 2917, checked in by Nicklas Nordborg, 17 years ago

References #348: Take ownership of items

Implemented on all biomaterial pages

  • Property svn:eol-style set to native
  • Property svn:keywords set to Date Id
File size: 20.0 KB
Line 
1<%-- $Id: list_samples.jsp 2917 2006-11-15 10:28:36Z nicklas $
2  ------------------------------------------------------------------
3  Copyright (C) Authors contributing to this file.
4
5  This file is part of BASE - BioArray Software Environment.
6  Available at http://base.thep.lu.se/
7
8  BASE is free software; you can redistribute it and/or
9  modify it under the terms of the GNU General Public License
10  as published by the Free Software Foundation; either version 2
11  of the License, or (at your option) any later version.
12
13  BASE is distributed in the hope that it will be useful,
14  but WITHOUT ANY WARRANTY; without even the implied warranty of
15  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  GNU General Public License for more details.
17
18  You should have received a copy of the GNU General Public License
19  along with this program; if not, write to the Free Software
20  Foundation, Inc., 59 Temple Place - Suite 330,
21  Boston, MA  02111-1307, USA.
22  ------------------------------------------------------------------
23
24  @author Nicklas
25  @version 2.0
26--%>
27<%@ page
28  import="net.sf.basedb.core.SessionControl"
29  import="net.sf.basedb.core.DbControl"
30  import="net.sf.basedb.core.Item"
31  import="net.sf.basedb.core.Sample"
32  import="net.sf.basedb.core.Extract"
33  import="net.sf.basedb.core.BioSource"
34  import="net.sf.basedb.core.BioMaterialEvent"
35  import="net.sf.basedb.core.AnnotationType"
36  import="net.sf.basedb.core.AnnotationSet"
37  import="net.sf.basedb.core.ItemQuery"
38  import="net.sf.basedb.core.Include"
39  import="net.sf.basedb.core.ItemResultIterator"
40  import="net.sf.basedb.core.ItemResultList"
41  import="net.sf.basedb.core.ItemContext"
42  import="net.sf.basedb.core.Permission"
43  import="net.sf.basedb.core.PermissionDeniedException"
44  import="net.sf.basedb.core.PluginDefinition"
45  import="net.sf.basedb.core.query.Hql"
46  import="net.sf.basedb.core.query.Restrictions"
47  import="net.sf.basedb.core.query.Expressions"
48  import="net.sf.basedb.core.query.Orders"
49  import="net.sf.basedb.core.plugin.GuiContext"
50  import="net.sf.basedb.core.plugin.Plugin"
51  import="net.sf.basedb.core.Type"
52  import="net.sf.basedb.util.Enumeration"
53  import="net.sf.basedb.clients.web.Base"
54  import="net.sf.basedb.clients.web.ModeInfo"
55  import="net.sf.basedb.clients.web.PermissionUtil"
56  import="net.sf.basedb.clients.web.util.HTML"
57  import="net.sf.basedb.util.Values"
58  import="java.util.List"
59  import="java.util.Map"
60%>
61<%@ taglib prefix="base" uri="/WEB-INF/base.tld" %>
62<%@ taglib prefix="tbl" uri="/WEB-INF/table.tld" %>
63<%!
64  private static final Item itemType = Item.SAMPLE;
65  private static final GuiContext guiContext = new GuiContext(itemType, GuiContext.Type.LIST);
66%>
67<%
68final SessionControl sc = Base.getExistingSessionControl(pageContext, Permission.DENIED, itemType);
69final String ID = sc.getId();
70final boolean createPermission = sc.hasPermission(Permission.CREATE, itemType);
71final ItemContext cc = Base.getAndSetCurrentContext(sc, itemType, null, null);
72
73final ModeInfo mode = ModeInfo.get(request.getParameter("mode"));
74final String callback = request.getParameter("callback");
75final String title = mode.generateTitle("sample", "samples");
76final DbControl dc = sc.newDbControl();
77ItemResultIterator<Sample> samples = null;
78ItemResultList<AnnotationType> annotationTypes = null;
79try
80{
81  final ItemQuery<AnnotationType> annotationTypeQuery = Base.getAnnotationTypesQuery(itemType);
82  final ItemQuery<Sample> query = Base.getConfiguredQuery(cc, true, Sample.getQuery(), mode);
83  final ItemQuery<Extract> extractQuery = Extract.getQuery();
84  extractQuery.include(cc.getInclude());
85  extractQuery.restrict(Restrictions.eq(Hql.property("parent"), Expressions.parameter("samples")));
86  extractQuery.order(Orders.asc(Hql.property("name")));
87  final boolean createExtractPermission = sc.hasPermission(Permission.CREATE, Item.EXTRACT);
88
89  Map<Plugin.MainType, Integer> pluginCount = PluginDefinition.countPlugins(dc, guiContext);
90  annotationTypes = annotationTypeQuery.list(dc);
91  try
92  {
93    samples = query.iterate(dc);
94  }
95  catch (Throwable t)
96  {
97    cc.setMessage(t.getMessage());
98  }
99  int numListed = 0;
100  %>
101  <base:page title="<%=title==null ? "Samples" : title%>" type="<%=mode.getPageType()%>">
102  <base:head scripts="menu.js,table.js" styles="menu.css,table.css">
103    <script language="JavaScript">
104    var submitPage = 'index.jsp';
105    var formId = 'samples';
106    function newItem()
107    {
108      Main.viewOrEditItem('<%=ID%>', '<%=itemType.name()%>', 0, true);
109    }
110    function newPooledItem()
111    {
112      Table.poolItems(submitPage, '<%=ID%>', formId, '<%=itemType.name()%>', 'NewPooledItem');
113    }
114    function editItem(itemId)
115    {
116      Main.viewOrEditItem('<%=ID%>', '<%=itemType.name()%>', itemId, true);
117    }
118    function viewItem(itemId)
119    {
120      Main.viewOrEditItem('<%=ID%>', '<%=itemType.name()%>', itemId, false);
121    }
122    function itemOnClick(evt, itemId)
123    {
124      Table.itemOnClick(formId, evt, itemId, '<%=mode.getName()%>', viewItem, editItem, returnSelected);
125    }
126    function newExtract(sampleId)
127    {
128      Main.viewOrEditItem('<%=ID%>', 'EXTRACT', 0, true, '&sample_id='+sampleId);
129    }
130    function deleteItems()
131    {
132      var frm = document.forms[formId];
133      if (Forms.numChecked(frm) == 0)
134      {
135        alert('Please select at least one item in the list');
136        return;
137      }
138      frm.action = submitPage;
139      frm.cmd.value = 'DeleteItems';
140      frm.submit();
141    }
142    function restoreItems()
143    {
144      var frm = document.forms[formId];
145      if (Forms.numChecked(frm) == 0)
146      {
147        alert('Please select at least one item in the list');
148        return;
149      }
150      frm.action = submitPage;
151      frm.cmd.value = 'RestoreItems';
152      frm.submit();
153    }
154    function takeOwnership()
155    {
156      var frm = document.forms[formId];
157      if (Forms.numChecked(frm) == 0)
158      {
159        alert('Please select at least one item in the list');
160        return;
161      }
162      if (confirm('Are you sure that you want to take ownership of the selected items? It can\'t be undone.'))
163      {
164        frm.action = submitPage;
165        frm.cmd.value = 'TakeOwnershipOfItems';
166        frm.submit();
167      }
168    }
169    function shareItem(itemId)
170    {
171      Main.openPopup('index.jsp?ID=<%=ID%>&cmd=ShareItem&item_id='+itemId, 'ShareSamples', 500, 400);
172    }
173    function shareItems()
174    {
175      Table.shareItems(submitPage, '<%=ID%>', formId, '<%=itemType.name()%>', 'ShareItems');
176    }
177    function configureColumns()
178    {
179      Table.configureColumns('<%=ID%>', formId, '<%=itemType.name()%>', '<%=(String)cc.getObject("defaultColumns")%>');
180    }
181    function runPlugin(cmd)
182    {
183      Table.submitToPopup(formId, cmd, 740, 540);
184    }
185    function returnSelected()
186    {
187      Table.returnSelected(formId, <%=callback != null ? "window.opener."+callback : "null" %>);
188      window.close();
189    }
190    function presetOnChange()
191    {
192      Table.presetOnChange('<%=ID%>', formId, '<%=itemType.name()%>', '<%=(String)cc.getObject("defaultColumns")%>');
193    }
194    </script>
195  </base:head>
196 
197  <base:body>
198    <%
199    if (cc.getMessage() != null)
200    {
201      %>
202      <div class="error"><%=cc.getMessage()%></div>
203      <%
204      cc.setMessage(null);
205    }
206    %>
207    <tbl:table 
208      id="samples" 
209      clazz="itemlist" 
210      columns="<%=cc.getSetting("columns")%>"
211      sortby="<%=cc.getSortProperty()%>" 
212      direction="<%=cc.getSortDirection()%>"
213      title="<%=title%>"
214      action="index.jsp"
215      sc="<%=sc%>"
216      item="<%=itemType%>"
217      >
218      <tbl:hidden 
219        name="mode" 
220        value="<%=mode.getName()%>" 
221      />
222      <tbl:hidden 
223        name="callback" 
224        value="<%=callback%>" 
225        skip="<%=callback == null%>" 
226      />
227      <tbl:columndef 
228        id="name"
229        property="name"
230        datatype="string"
231        title="Name"
232        sortable="true" 
233        filterable="true"
234        exportable="true"
235        show="always" 
236      />
237      <tbl:columndef 
238        id="externalId"
239        property="externalId"
240        datatype="string"
241        title="External id"
242        sortable="true" 
243        filterable="true"
244        exportable="true"
245      />     
246      <tbl:columndef 
247        id="originalQuantity"
248        property="originalQuantity"
249        datatype="float"
250        title="Original quantity (µg)"
251        sortable="true" 
252        filterable="true"
253        exportable="true"
254      />
255      <tbl:columndef 
256        id="remainingQuantity"
257        property="remainingQuantity"
258        datatype="float"
259        title="Remaining quantity (µg)"
260        sortable="true" 
261        filterable="true"
262        exportable="true"
263      />
264      <tbl:columndef 
265        id="protocol"
266        property="creationEvent.protocol"
267        sortproperty="creationEvent.protocol.name"
268        filterproperty="creationEvent.protocol.name"
269        exportproperty="creationEvent.protocol.name"
270        datatype="string"
271        title="Protocol"
272        sortable="true" 
273        filterable="true"
274        exportable="true"
275      />
276      <tbl:columndef 
277        id="eventDate"
278        property="creationEvent.eventDate"
279        datatype="date"
280        title="Created"
281        sortable="true" 
282        filterable="true"
283        exportable="true"
284      />
285      <tbl:columndef 
286        id="entryDate"
287        property="creationEvent.entryDate"
288        datatype="date"
289        title="Registered"
290        sortable="true" 
291        filterable="true"
292        exportable="true"
293      />
294      <tbl:columndef 
295        id="pooled"
296        property="pooled"
297        datatype="boolean"
298        title="Pooled"
299        sortable="true" 
300        filterable="true"
301        exportable="true"
302      />
303      <tbl:columndef
304        id="parents"
305        title="Parents"
306      />
307      <tbl:columndef
308        id="extracts"
309        title="Extracts"
310      />     
311      <tbl:columndef 
312        id="owner"
313        property="owner.name"
314        datatype="string"
315        title="Owner"
316        sortable="true" 
317        filterable="true"
318        exportable="true"
319      />
320      <tbl:columndef 
321        id="description"
322        property="description"
323        datatype="string"
324        title="Description" 
325        sortable="true" 
326        filterable="true" 
327        exportable="true"
328      />     
329      <%
330      for (AnnotationType at : annotationTypes)
331      {
332        Enumeration<String, String> annotationEnum = null;
333        if (at.isEnumeration())
334        {
335          annotationEnum = new Enumeration<String, String>();
336          List<?> values = at.getValues();
337          for (Object value : values)
338          {
339            String encoded = HTML.encodeTags(value.toString());
340            annotationEnum.add(encoded, encoded);
341          }
342        }
343        %>
344        <tbl:columndef 
345          id="<%="at"+at.getId()%>"
346          title="<%=HTML.encodeTags(at.getName())+" [A]"%>" 
347          property="<%="#"+at.getId()%>"
348          annotation="true"
349          datatype="<%=at.getValueType().getStringValue()%>"
350          enumeration="<%=annotationEnum%>"
351          sortable="false" 
352          filterable="true" 
353          exportable="true"
354        />
355        <%
356      }
357      %>
358      <tbl:columndef
359        id="permission"
360        title="Permission"
361      />
362      <tbl:toolbar
363        visible="<%=mode.hasToolbar()%>"
364        >
365        <tbl:button 
366          disabled="<%=createPermission ? false : true%>" 
367          image="<%=createPermission ? "new.gif" : "new_disabled.gif"%>" 
368          onclick="newItem()" 
369          title="New&hellip;" 
370          tooltip="<%=createPermission ? "Create new sample" : "You do not have permission to create samples"%>" 
371        />
372        <tbl:button 
373          disabled="<%=createPermission ? false : true%>" 
374          image="<%=createPermission ? "new_pooled.gif" : "new_pooled_disabled.gif"%>" 
375          onclick="newPooledItem()" 
376          title="Pool&hellip;" 
377          tooltip="<%=createPermission ? "Create new pooled sample" : "You do not have permission to create samples"%>" 
378        />
379        <tbl:button 
380          image="delete.gif"
381          onclick="deleteItems()" 
382          title="Delete" 
383          tooltip="Delete the selected items" 
384        />
385        <tbl:button 
386          image="restore.gif"
387          onclick="restoreItems()" 
388          title="Restore" 
389          tooltip="Restore the selected (deleted) items"
390        />
391        <tbl:button 
392          image="share.gif"
393          onclick="shareItems()" 
394          title="Share&hellip;" 
395          tooltip="Share the selected items"
396        />
397        <tbl:button 
398          image="take_ownership.png"
399          onclick="takeOwnership()" 
400          title="Take ownership&hellip;"
401          tooltip="Take ownership of the selected items"
402        />
403        <tbl:button 
404          image="columns.gif" 
405          onclick="configureColumns()" 
406          title="Columns&hellip;" 
407          tooltip="Show, hide and re-order columns" 
408        />
409        <tbl:button 
410          image="import.gif" 
411          onclick="runPlugin('ImportItems')" 
412          title="Import&hellip;" 
413          tooltip="Import data" 
414          visible="<%=pluginCount.containsKey(Plugin.MainType.IMPORT)%>"
415        />
416        <tbl:button 
417          image="export.gif" 
418          onclick="runPlugin('ExportItems')" 
419          title="Export&hellip;" 
420          tooltip="Export data" 
421          visible="<%=pluginCount.containsKey(Plugin.MainType.EXPORT)%>"
422        />
423        <tbl:button 
424          image="runplugin.gif" 
425          onclick="runPlugin('RunListPlugin')" 
426          title="Run plugin&hellip;" 
427          tooltip="Run a plugin" 
428          visible="<%=pluginCount.containsKey(Plugin.MainType.OTHER)%>"
429        />
430      </tbl:toolbar>
431      <tbl:navigator
432        page="<%=cc.getPage()%>" 
433        rowsperpage="<%=cc.getRowsPerPage()%>" 
434        totalrows="<%=samples == null ? 0 : samples.getTotalCount()%>" 
435        visible="<%=mode.hasNavigator()%>"
436      />
437      <tbl:data>
438        <tbl:columns>
439        <tbl:presetselector 
440          clazz="columnheader"
441          colspan="3"
442          onchange="presetOnChange()"
443        />
444        </tbl:columns>
445
446        <tr>
447          <tbl:header 
448            clazz="index"
449            >&nbsp;</tbl:header>
450          <tbl:header 
451            clazz="check" 
452            visible="<%=mode.hasCheck()%>"
453            ><base:icon 
454              image="check_uncheck.gif" 
455              tooltip="Check/uncheck all" 
456              onclick="Forms.checkUncheck(document.forms[formId])" style="align: left;"
457            /></tbl:header>
458          <tbl:header 
459            clazz="check" 
460            visible="<%=mode.hasRadio()%>"
461            >&nbsp;</tbl:header>
462          <tbl:header 
463            clazz="icons" 
464            visible="<%=mode.hasIcons()%>"
465            >&nbsp;</tbl:header>
466          <tbl:propertyfilter />
467        </tr>
468         
469          <tbl:rows>
470          <%
471          int index = cc.getPage()*cc.getRowsPerPage();
472          int selectedItemId = cc.getId();
473          if (samples != null)
474          {           
475            while (samples.hasNext())
476            {
477              Sample item = samples.next();
478              BioMaterialEvent creationEvent = item.getCreationEvent();
479              int itemId = item.getId();
480              boolean usePermission = item.hasPermission(Permission.USE);
481              String openSharePopup = "shareItem("+itemId+")";
482              boolean sharePermission = item.hasPermission(Permission.SET_PERMISSION);
483              boolean writePermission = item.hasPermission(Permission.WRITE);
484              String tooltip = mode.isSelectionMode() ?
485                  "Select this item" : "View this item" + (writePermission ? " (use CTRL, ALT or SHIFT to edit)" : "");
486              String name = HTML.encodeTags(item.getName());
487              index++;
488              numListed++;
489              %>
490              <tbl:row>
491                <tbl:header 
492                  clazz="index"
493                  ><%=index%></tbl:header>
494                <tbl:header 
495                  clazz="check" 
496                  visible="<%=mode.hasCheck()%>"
497                  ><input 
498                    type="checkbox" 
499                    name="<%=itemId%>" 
500                    value="<%=itemId%>" 
501                    title="<%=name%>" 
502                    <%=cc.getSelected().contains(itemId) ? "checked" : ""%> 
503                  ></tbl:header>
504                <tbl:header 
505                  clazz="check" 
506                  visible="<%=mode.hasRadio()%>"
507                  ><input 
508                    type="radio" 
509                    name="item_id" 
510                    value="<%=itemId%>" 
511                    title="<%=name%>" 
512                    <%=selectedItemId == itemId ? "checked" : ""%>
513                  ></tbl:header>
514                <tbl:header 
515                  clazz="icons" 
516                  visible="<%=mode.hasIcons()%>"
517                  ><base:icon 
518                    image="deleted.gif" 
519                    tooltip="This item has been scheduled for deletion" 
520                    visible="<%=item.isRemoved()%>"
521                  /><base:icon 
522                    image="<%=sharePermission ? "shared.gif" : "shared_disabled.gif"%>" 
523                    onclick="<%=sharePermission ? openSharePopup : null%>"
524                    tooltip="This item is shared to other users, groups and/or projects" 
525                    visible="<%=item.isShared()%>"
526                  />&nbsp;</tbl:header>
527                <tbl:cell column="name"><div class="link" 
528                  onclick="itemOnClick(<%=writePermission ? "event" : null%>, <%=itemId%>)"
529                  title="<%=tooltip%>"><%=name%></div></tbl:cell>
530                <tbl:cell column="externalId"><%=HTML.encodeTags(item.getExternalId())%></tbl:cell>               
531                <tbl:cell column="originalQuantity"><%=Values.formatNumber(item.getOriginalQuantity(), 2)%></tbl:cell>
532                <tbl:cell column="remainingQuantity"><%=Values.formatNumber(item.getRemainingQuantity(), 2)%></tbl:cell>
533                <tbl:cell column="pooled"><%=item.isPooled()%></tbl:cell>
534                <tbl:cell column="protocol"
535                  ><base:propertyvalue 
536                    item="<%=creationEvent%>" 
537                    property="protocol"
538                    enableEditLink="<%=mode.hasEditLink()%>" 
539                    enablePropertyLink="<%=mode.hasPropertyLink()%>"
540                  /></tbl:cell>
541                <tbl:cell column="eventDate"><%=Values.formatDate(creationEvent.getEventDate())%></tbl:cell>
542                <tbl:cell column="entryDate"><%=Values.formatDate(creationEvent.getEntryDate())%></tbl:cell>
543                <tbl:cell column="parents">
544                  <%
545                  if (!item.isPooled())
546                  {
547                  %>
548                    <base:propertyvalue item="<%=item%>" property="parent"/>
549                  <%
550                  }
551                  else
552                  {
553                    String separator = "";
554                    ItemQuery<Sample> parentQuery = (ItemQuery<Sample>)item.getCreationEvent().getSources();
555                    parentQuery.include(Include.MINE, Include.SHARED, Include.IN_PROJECT, Include.OTHERS);
556                    parentQuery.order(Orders.asc(Hql.property("name")));                   
557                    for(Sample s : parentQuery.list(dc))
558                    {
559                      out.write(separator);
560                      if (mode.hasPropertyLink())
561                      {
562                        out.write(Base.getLinkedName(ID, s, false, mode.hasEditLink()));
563                      }
564                      else
565                      {
566                        out.write(HTML.encodeTags(s.getName()));
567                      }
568                      separator = ", ";
569                    }
570                   
571                  }
572                  %>
573                  </tbl:cell>
574                <tbl:cell column="extracts">
575                  <%
576                  extractQuery.setParameter("samples", itemId, Type.INT);
577                  try
578                  {
579                    String separator = "";
580                    for(Extract e : extractQuery.list(dc))
581                    {
582                      out.write(separator);
583                      if (mode.hasPropertyLink())
584                      {
585                        out.write(Base.getLinkedName(ID, e, false, mode.hasEditLink()));
586                      }
587                      else
588                      {
589                        out.write(HTML.encodeTags(e.getName()));
590                      }
591                      separator = ", ";
592                    }
593                  }
594                  catch (Throwable t)
595                  {
596                    %>
597                    <div class="error"><%=t.getMessage()%></div>
598                    <%
599                  }
600                  %>
601                  <base:icon
602                    image="add.png" 
603                    onclick="<%="newExtract("+itemId+")"%>" 
604                    tooltip="Create new sample" 
605                    visible="<%=mode.hasEditLink() && createExtractPermission && usePermission %>"
606                  />
607                </tbl:cell>
608                <tbl:cell column="owner"
609                  ><base:propertyvalue 
610                    item="<%=item%>" 
611                    property="owner"
612                    enableEditLink="<%=mode.hasEditLink()%>" 
613                    enablePropertyLink="<%=mode.hasPropertyLink()%>" 
614                  /></tbl:cell>
615                <tbl:cell column="description"><%=HTML.encodeTags(item.getDescription())%></tbl:cell>               
616                <%
617                AnnotationSet as = item.isAnnotated() ? item.getAnnotationSet() : null;
618                for (AnnotationType at : annotationTypes)
619                {
620                  %>
621                  <tbl:cell column="<%="at"+at.getId()%>">
622                    <%
623                    List<?> values = as == null || !as.hasAnnotation(at) ? null : as.getAnnotation(at).getValues();
624                    %>
625                    <%=values == null || values.size() == 0 ? "" : HTML.encodeTags(Values.getString(values, ", ", true))%>
626                  </tbl:cell>
627                  <%
628                }
629                %>
630                <tbl:cell column="permission"><%=PermissionUtil.getShortPermissions(item)%></tbl:cell>
631              </tbl:row>
632              <%
633              }
634            }
635          %>
636          </tbl:rows>
637      </tbl:data>
638      <%
639      if (numListed == 0)
640      {
641        %>
642        <tbl:panel><%=samples == null || samples.getTotalCount() == 0 ? "No samples where found" : "No samples on this page. Please select another page!" %></tbl:panel>
643        <%
644      }
645      else
646      {
647        %>
648        <tbl:navigator
649          page="<%=cc.getPage()%>" 
650          rowsperpage="<%=cc.getRowsPerPage()%>" 
651          totalrows="<%=samples == null ? 0 : samples.getTotalCount()%>" 
652          visible="<%=mode.hasNavigator()%>"
653          locked="true"
654        />
655        <%
656      }
657      %>
658    </tbl:table>
659    <base:buttongroup align="center" clazz="fixedatbottom">
660      <base:button onclick="returnSelected();" title="Ok" visible="<%=mode.hasOkButton()%>" />
661      <base:button onclick="window.close();" title="Cancel" visible="<%=mode.hasCancelButton()%>" />
662      <base:button onclick="window.close();" title="Close" visible="<%=mode.hasCloseButton()%>" />
663    </base:buttongroup>
664    <br><br><br>
665  </base:body>
666  </base:page>
667  <%
668}
669finally
670{
671  if (samples != null) samples.close();
672  if (dc != null) dc.close();
673}
674%>
Note: See TracBrowser for help on using the repository browser.