source: trunk/www/biomaterials/biosources/list_biosources.jsp @ 4882

Last change on this file since 4882 was 4882, checked in by Nicklas Nordborg, 13 years ago

References #1271: Add extension points to all toolbars

Added code for displaying extensions to all biomaterial pages.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Date Id
File size: 19.9 KB
Line 
1<%-- $Id: list_biosources.jsp 4882 2009-04-03 10:53:42Z nicklas $
2  ------------------------------------------------------------------
3  Copyright (C) 2006 Jari Hakkinen, 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 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.BioSource"
31  import="net.sf.basedb.core.Sample"
32  import="net.sf.basedb.core.AnnotationType"
33  import="net.sf.basedb.core.AnnotationSet"
34  import="net.sf.basedb.core.Annotation"
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.Type"
44  import="net.sf.basedb.core.query.Hql"
45  import="net.sf.basedb.core.query.Restrictions"
46  import="net.sf.basedb.core.query.Expressions"
47  import="net.sf.basedb.core.query.Orders"
48  import="net.sf.basedb.core.plugin.GuiContext"
49  import="net.sf.basedb.core.plugin.Plugin"
50  import="net.sf.basedb.util.Enumeration"
51  import="net.sf.basedb.util.ShareableUtil"
52  import="net.sf.basedb.clients.web.Base"
53  import="net.sf.basedb.clients.web.ModeInfo"
54  import="net.sf.basedb.clients.web.PermissionUtil"
55  import="net.sf.basedb.clients.web.util.HTML"
56  import="net.sf.basedb.util.formatter.Formatter"
57  import="net.sf.basedb.clients.web.formatter.FormatterFactory"
58  import="net.sf.basedb.clients.web.extensions.ExtensionsControl"
59  import="net.sf.basedb.clients.web.extensions.JspContext"
60  import="net.sf.basedb.clients.web.extensions.renderer.PrefixSuffixRenderer"
61  import="net.sf.basedb.clients.web.extensions.toolbar.ToolbarUtil"
62  import="net.sf.basedb.util.extensions.ExtensionsInvoker"
63  import="net.sf.basedb.util.Values"
64  import="java.util.Iterator"
65  import="java.util.Date"
66  import="java.util.List"
67  import="java.util.Map"
68%>
69<%@ taglib prefix="base" uri="/WEB-INF/base.tld" %>
70<%@ taglib prefix="tbl" uri="/WEB-INF/table.tld" %>
71<%@ taglib prefix="ext" uri="/WEB-INF/extensions.tld" %>
72<%!
73  private static final Item itemType = Item.BIOSOURCE;
74  private static final GuiContext guiContext = new GuiContext(itemType, GuiContext.Type.LIST);
75%>
76<%
77final SessionControl sc = Base.getExistingSessionControl(pageContext, Permission.DENIED, itemType);
78final String ID = sc.getId();
79final boolean createPermission = sc.hasPermission(Permission.CREATE, itemType);
80final ItemContext cc = Base.getAndSetCurrentContext(sc, itemType, null, null);
81
82final ModeInfo mode = ModeInfo.get(request.getParameter("mode"));
83final String callback = request.getParameter("callback");
84final String title = mode.generateTitle("biosource", "biosources");
85final DbControl dc = sc.newDbControl();
86ItemResultIterator<BioSource> bioSources = null;
87ItemResultList<AnnotationType> annotationTypes = null;
88try
89{
90  final ItemQuery<AnnotationType> annotationTypeQuery = Base.getAnnotationTypesQuery(itemType);
91  final ItemQuery<Sample> sampleQuery = Sample.getQuery();
92  sampleQuery.include(cc.getInclude());
93  sampleQuery.restrict(Restrictions.eq(Hql.property("parent"), Expressions.parameter("bioSource")));
94  sampleQuery.order(Orders.asc(Hql.property("name")));
95  final boolean createSamplePermission = sc.hasPermission(Permission.CREATE, Item.SAMPLE);
96
97  Map<Plugin.MainType, Integer> pluginCount = PluginDefinition.countPlugins(dc, guiContext);
98  annotationTypes = annotationTypeQuery.list(dc);
99  try
100  {
101    final ItemQuery<BioSource> query = Base.getConfiguredQuery(dc, cc, true, BioSource.getQuery(), mode);
102    bioSources = query.iterate(dc);
103  }
104  catch (Throwable t)
105  {
106    cc.setMessage(t.getMessage());
107    t.printStackTrace();
108  }
109  int numListed = 0;
110  Formatter<Date> dateFormatter = FormatterFactory.getDateFormatter(sc);
111  JspContext jspContext = ExtensionsControl.createContext(dc, pageContext, guiContext, null);
112  ExtensionsInvoker invoker = ToolbarUtil.useExtensions(jspContext);
113  %>
114  <base:page title="<%=title==null ? "Biosources" : title%>" type="<%=mode.getPageType()%>">
115  <base:head scripts="menu.js,table.js" styles="menu.css,table.css">
116    <ext:scripts context="<%=jspContext%>" />
117    <ext:stylesheets context="<%=jspContext%>" />
118    <script language="JavaScript">
119    var submitPage = 'index.jsp';
120    var formId = 'biosources';
121    function newItem()
122    {
123      Main.viewOrEditItem('<%=ID%>', '<%=itemType.name()%>', 0, true);
124    }
125    function editItem(itemId)
126    {
127      Main.viewOrEditItem('<%=ID%>', '<%=itemType.name()%>', itemId, true);
128    }
129    function viewItem(itemId)
130    {
131      Main.viewOrEditItem('<%=ID%>', '<%=itemType.name()%>', itemId, false);
132    }
133    function itemOnClick(evt, itemId)
134    {
135      Table.itemOnClick(formId, evt, itemId, '<%=mode.getName()%>', viewItem, editItem, returnSelected);
136    }
137    function deleteItems()
138    {
139      var frm = document.forms[formId];
140      if (Forms.numChecked(frm) == 0)
141      {
142        alert('Please select at least one item in the list');
143        return;
144      }
145      frm.action = submitPage;
146      frm.cmd.value = 'DeleteItems';
147      frm.submit();
148    }
149    function restoreItems()
150    {
151      var frm = document.forms[formId];
152      if (Forms.numChecked(frm) == 0)
153      {
154        alert('Please select at least one item in the list');
155        return;
156      }
157      frm.action = submitPage;
158      frm.cmd.value = 'RestoreItems';
159      frm.submit();
160    }
161    function deleteItemPermanently(itemId)
162    {
163      Main.deleteItemPermanently('<%=ID%>', true, '<%=itemType.name()%>', itemId);
164    }
165    function setOwner()
166    {
167      Table.setOwnerOfItems(submitPage, '<%=ID%>', formId, '<%=itemType.name()%>', 'SetOwnerOfItems');
168    }
169    function shareItem(itemId)
170    {
171      Main.openPopup('index.jsp?ID=<%=ID%>&cmd=ShareItem&item_id='+itemId, 'ShareBiosources', 600, 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    function newSample(bioSourceId)
195    {
196      Main.viewOrEditItem('<%=ID%>', 'SAMPLE', 0, true, '&biosource_id='+bioSourceId);
197    }
198    function newBioMaterialList()
199    {
200      var controller = Main.getController('BIOMATERIALLIST');
201      Table.submitToPopup(formId, 'CreateBioMaterialList', controller.width, controller.height);
202    }
203    </script>
204  </base:head>
205 
206  <base:body>
207    <%
208    if (cc.getMessage() != null)
209    {
210      %>
211      <div class="error"><%=cc.getMessage()%></div>
212      <%
213      cc.setMessage(null);
214    }
215    %>
216    <tbl:table 
217      id="biosources" 
218      clazz="itemlist" 
219      columns="<%=cc.getSetting("columns")%>"
220      sortby="<%=cc.getSortProperty()%>" 
221      direction="<%=cc.getSortDirection()%>"
222      title="<%=title%>"
223      action="index.jsp"
224      sc="<%=sc%>"
225      item="<%=itemType%>"
226      >
227      <tbl:hidden 
228        name="mode" 
229        value="<%=mode.getName()%>" 
230      />
231      <tbl:hidden 
232        name="callback" 
233        value="<%=callback%>" 
234        skip="<%=callback == null%>" 
235      />
236      <tbl:columndef 
237        id="name"
238        property="name"
239        datatype="string"
240        title="Name"
241        sortable="true" 
242        filterable="true"
243        exportable="true"
244        show="always" 
245      />
246      <tbl:columndef 
247         id="id"
248        clazz="uniquecol"
249         property="id"
250         datatype="int"
251         title="ID"
252         sortable="true" 
253         filterable="true"
254         exportable="true"
255      />
256      <tbl:columndef 
257        id="externalId"
258        property="externalId"
259        datatype="string"
260        title="External id"
261        sortable="true" 
262        filterable="true"
263        exportable="true"
264      />
265      <tbl:columndef 
266        id="entryDate"
267        property="entryDate"
268        datatype="date"
269        title="Registered"
270        sortable="true" 
271        filterable="true"
272        exportable="true"
273        formatter="<%=dateFormatter%>"
274      />
275      <tbl:columndef
276        id="samples"
277        title="Samples"
278        property="&children(name)"
279        datatype="string"
280        filterable="true"
281      />
282      <tbl:columndef 
283        id="owner"
284        property="owner.name"
285        datatype="string"
286        title="Owner"
287        sortable="true" 
288        filterable="true"
289        exportable="true"
290      />
291      <tbl:columndef 
292        id="description"
293        property="description"
294        datatype="string"
295        title="Description" 
296        sortable="true" 
297        filterable="true" 
298        exportable="true"
299      />     
300      <tbl:columndef
301        id="bioMaterialList"
302        property="@bioMaterialLists"
303        datatype="int"
304        title="Biomaterial list"
305        filterable="true"
306        enumeration="<%=Base.getBioMaterialListsEnum(dc, itemType, cc.getInclude())%>"
307        multiple="false"
308      />
309      <%
310      for (AnnotationType at : annotationTypes)
311      {
312        Enumeration<String, String> annotationEnum = null;
313        Formatter formatter = FormatterFactory.getTypeFormatter(sc, at.getValueType());
314        if (at.isEnumeration())
315        {
316          annotationEnum = new Enumeration<String, String>();
317          List<?> values = at.getValues();
318          for (Object value : values)
319          {
320            String encoded = formatter.format(value);
321            annotationEnum.add(encoded, encoded);
322          }
323        }
324        %>
325        <tbl:columndef 
326          id="<%="at"+at.getId()%>"
327          title="<%=HTML.encodeTags(at.getName())+" [A]"%>" 
328          property="<%="#"+at.getId()%>"
329          annotation="true"
330          datatype="<%=at.getValueType().getStringValue()%>"
331          enumeration="<%=annotationEnum%>"
332          sortable="false" 
333          filterable="true" 
334          exportable="true"
335          formatter="<%=formatter%>"
336          unit="<%=at.getDefaultUnit()%>"
337        />
338        <%
339      }
340      %>
341      <tbl:columndef
342        id="permission"
343        title="Permission"
344      />
345      <tbl:columndef 
346        id="sharedTo"
347        title="Shared to"
348      />
349      <tbl:toolbar
350        visible="<%=mode.hasToolbar()%>"
351        >
352        <tbl:button 
353          disabled="<%=createPermission ? false : true%>" 
354          image="<%=createPermission ? "new.gif" : "new_disabled.gif"%>" 
355          onclick="newItem()" 
356          title="New&hellip;" 
357          tooltip="<%=createPermission ? "Create new biosource" : "You do not have permission to create biosources"%>" 
358        />
359        <tbl:button 
360          image="delete.gif"
361          onclick="deleteItems()" 
362          title="Delete" 
363          tooltip="Delete the selected items" 
364        />
365        <tbl:button 
366          image="restore.gif"
367          onclick="restoreItems()" 
368          title="Restore" 
369          tooltip="Restore the selected (deleted) items"
370        />
371        <tbl:button 
372          image="share.gif"
373          onclick="shareItems()" 
374          title="Share&hellip;" 
375          tooltip="Share the selected items"
376        />
377        <tbl:button 
378          image="take_ownership.png"
379          onclick="setOwner()" 
380          title="Set owner&hellip;"
381          tooltip="Change owner of the selected items"
382        />
383        <tbl:button 
384          image="columns.gif" 
385          onclick="configureColumns()" 
386          title="Columns&hellip;" 
387          tooltip="Show, hide and re-order columns" 
388        />
389        <tbl:button
390          image="add.png"
391          onclick="newBioMaterialList()"
392          title="New biomaterial list&hellip;"
393          tooltip="Create a new biomaterial list from matching biosources"
394          visible="<%=sc.hasPermission(Permission.CREATE, Item.BIOMATERIALLIST)%>"
395        />
396        <tbl:button 
397          image="import.gif" 
398          onclick="runPlugin('ImportItems')" 
399          title="Import&hellip;" 
400          tooltip="Import data" 
401          visible="<%=pluginCount.containsKey(Plugin.MainType.IMPORT)%>"
402        />
403        <tbl:button 
404          image="export.gif" 
405          onclick="runPlugin('ExportItems')" 
406          title="Export&hellip;" 
407          tooltip="Export data" 
408          visible="<%=pluginCount.containsKey(Plugin.MainType.EXPORT)%>"
409        />
410        <tbl:button 
411          image="runplugin.gif" 
412          onclick="runPlugin('RunListPlugin')" 
413          title="Run plugin&hellip;" 
414          tooltip="Run a plugin" 
415          visible="<%=pluginCount.containsKey(Plugin.MainType.OTHER)%>"
416        />
417        <ext:render extensions="<%=invoker%>" context="<%=jspContext%>" 
418          wrapper="<%=new PrefixSuffixRenderer(jspContext, "<td>", "</td>") %>"/>
419      </tbl:toolbar>
420      <tbl:navigator
421        page="<%=cc.getPage()%>" 
422        rowsperpage="<%=cc.getRowsPerPage()%>" 
423        totalrows="<%=bioSources == null ? 0 : bioSources.getTotalCount()%>" 
424        visible="<%=mode.hasNavigator()%>"
425      />
426      <tbl:data>
427        <tbl:columns>
428        <tbl:presetselector 
429          clazz="columnheader"
430          colspan="3"
431          onchange="presetOnChange()"
432        />
433        </tbl:columns>
434
435        <tr>
436          <tbl:header 
437            clazz="index"
438            >&nbsp;</tbl:header>
439          <tbl:header 
440            clazz="check" 
441            visible="<%=mode.hasCheck()%>"
442            ><base:icon 
443              image="check_uncheck.gif" 
444              tooltip="Check/uncheck all" 
445              onclick="Forms.checkUncheck(document.forms[formId])" style="align: left;"
446            /></tbl:header>
447          <tbl:header 
448            clazz="check" 
449            visible="<%=mode.hasRadio()%>"
450            >&nbsp;</tbl:header>
451          <tbl:header 
452            clazz="icons" 
453            visible="<%=mode.hasIcons()%>"
454            >&nbsp;</tbl:header>
455          <tbl:propertyfilter />
456        </tr>
457         
458          <tbl:rows>
459          <%
460          int index = cc.getPage()*cc.getRowsPerPage();
461          int selectedItemId = cc.getId();
462          if (bioSources != null)
463          {           
464            while (bioSources.hasNext())
465            {
466              BioSource item = bioSources.next();
467              int itemId = item.getId();
468              boolean usePermission = item.hasPermission(Permission.USE);
469              String openSharePopup = "shareItem("+itemId+")";
470              String deletePermanently = "deleteItemPermanently("+itemId+")";
471              boolean deletePermission = item.hasPermission(Permission.DELETE);
472              boolean sharePermission = item.hasPermission(Permission.SET_PERMISSION);
473              boolean writePermission = item.hasPermission(Permission.WRITE);
474              String tooltip = mode.isSelectionMode() ? 
475                  "Select this item" : "View this item" + (writePermission ? " (use CTRL, ALT or SHIFT to edit)" : "");
476              String name = HTML.encodeTags(item.getName());
477              index++;
478              numListed++;
479              %>
480              <tbl:row>
481                <tbl:header 
482                  clazz="index"
483                  ><%=index%></tbl:header>
484                <tbl:header 
485                  clazz="check" 
486                  visible="<%=mode.hasCheck()%>"
487                  ><input 
488                    type="checkbox" 
489                    name="<%=itemId%>" 
490                    value="<%=itemId%>" 
491                    title="<%=name%>" 
492                    <%=cc.getSelected().contains(itemId) ? "checked" : ""%> 
493                  ></tbl:header>
494                <tbl:header 
495                  clazz="check" 
496                  visible="<%=mode.hasRadio()%>"
497                  ><input 
498                    type="radio" 
499                    name="item_id" 
500                    value="<%=itemId%>" 
501                    title="<%=name%>" 
502                    <%=selectedItemId == itemId ? "checked" : ""%>
503                  ></tbl:header>
504                <tbl:header 
505                  clazz="icons" 
506                  visible="<%=mode.hasIcons()%>"
507                  ><base:icon 
508                    image="<%=deletePermission ? "deleted.gif" : "deleted_disabled.gif"%>"
509                    onclick="<%=deletePermission ? deletePermanently : null%>"
510                    tooltip="This item has been scheduled for deletion" 
511                    visible="<%=item.isRemoved()%>"
512                  /><base:icon 
513                    image="<%=sharePermission ? "shared.gif" : "shared_disabled.gif"%>" 
514                    onclick="<%=sharePermission ? openSharePopup : null%>"
515                    tooltip="This item is shared to other users, groups and/or projects" 
516                    visible="<%=item.isShared()%>"
517                  />&nbsp;</tbl:header>
518                <tbl:cell column="name"><div class="link" 
519                  onclick="itemOnClick(<%=writePermission ? "event" : null%>, <%=itemId%>)" 
520                  title="<%=tooltip%>"><%=name%></div></tbl:cell>
521                <tbl:cell column="id"><%=item.getId()%></tbl:cell>
522                <tbl:cell column="externalId"><%=HTML.encodeTags(item.getExternalId())%></tbl:cell>
523                <tbl:cell column="samples">
524                  <%
525                  sampleQuery.setParameter("bioSource", itemId, Type.INT);
526                  try
527                  {
528                    String separator = "";
529                    for (Sample s : sampleQuery.list(dc))
530                    {
531                      out.write(separator);
532                      if (mode.hasPropertyLink())
533                      {
534                        out.write(Base.getLinkedName(ID, s, false, mode.hasEditLink()));
535                      }
536                      else
537                      {
538                        out.write(HTML.encodeTags(s.getName()));
539                      }
540                      separator = ", ";
541                    }
542                  }
543                  catch (Throwable t)
544                  {
545                    %>
546                    <div class="error"><%=t.getMessage()%></div>
547                    <%
548                  }
549                  %>
550                  <base:icon
551                    image="add.png" 
552                    onclick="<%="newSample("+itemId+")"%>" 
553                    tooltip="Create new sample" 
554                    visible="<%=mode.hasEditLink() && createSamplePermission && usePermission %>"
555                  />
556                </tbl:cell>
557                <tbl:cell column="owner"
558                  ><base:propertyvalue 
559                    item="<%=item%>" 
560                    property="owner"
561                    enableEditLink="<%=mode.hasEditLink()%>" 
562                    enablePropertyLink="<%=mode.hasPropertyLink()%>"
563                  /></tbl:cell>
564                <tbl:cell column="entryDate" value="<%=item.getEntryDate()%>" />
565                <tbl:cell column="description"><%=HTML.encodeTags(item.getDescription())%></tbl:cell>               
566                <%
567                AnnotationSet as = item.isAnnotated() ? item.getAnnotationSet() : null;
568                if (as != null)
569                {
570                  for (AnnotationType at : annotationTypes)
571                  {
572                    if (as.hasAnnotation(at))
573                    {
574                      Annotation a = as.getAnnotation(at);
575                      String suffix = a.getUnitSymbol(null);
576                      if (suffix != null) suffix = "&nbsp;" + suffix;
577                      %>
578                      <tbl:cell 
579                        column="<%="at"+at.getId()%>"
580                        ><tbl:cellvalue 
581                          list="<%=a.getValues(null)%>"
582                          suffix="<%=suffix%>"
583                      /></tbl:cell>
584                      <%
585                    }
586                  }
587                }
588                %>
589                <tbl:cell column="permission"><%=PermissionUtil.getShortPermissions(item)%></tbl:cell>
590                <tbl:cell column="sharedTo">
591                  <%
592                  Iterator<Nameable> sharees = ShareableUtil.getSharedTo(dc, item).iterator();
593                  while(sharees.hasNext())
594                  {
595                    Nameable n = sharees.next();
596                    if (mode.hasPropertyLink())
597                    {
598                      out.write(Base.getLinkedName(ID, n, false, mode.hasEditLink()));
599                    }
600                    else
601                    {
602                      out.write(HTML.encodeTags(n.getName()));
603                    }
604                    out.write(sharees.hasNext() ? ", " : "");
605                  }
606                  %>
607                </tbl:cell>
608              </tbl:row>
609              <%
610              }
611            }
612          %>
613          </tbl:rows>
614      </tbl:data>
615      <%
616      if (numListed == 0)
617      {
618        %>
619        <tbl:panel><%=bioSources == null || bioSources.getTotalCount() == 0 ? "No biosources were found" : "No biosources on this page. Please select another page!" %></tbl:panel>
620        <%
621      }
622      else
623      {
624        %>
625        <tbl:navigator
626          page="<%=cc.getPage()%>" 
627          rowsperpage="<%=cc.getRowsPerPage()%>" 
628          totalrows="<%=bioSources == null ? 0 : bioSources.getTotalCount()%>" 
629          visible="<%=mode.hasNavigator()%>"
630          locked="true"
631        />
632        <%
633      }
634      %>
635    </tbl:table>
636    <base:buttongroup align="center" clazz="fixedatbottom">
637      <base:button onclick="returnSelected();" title="Ok" visible="<%=mode.hasOkButton()%>" />
638      <base:button onclick="window.close();" title="Cancel" visible="<%=mode.hasCancelButton()%>" />
639      <base:button onclick="window.close();" title="Close" visible="<%=mode.hasCloseButton()%>" />
640    </base:buttongroup>
641    <br><br><br>
642  </base:body>
643  </base:page>
644  <%
645}
646finally
647{
648  if (bioSources != null) bioSources.close();
649  if (dc != null) dc.close();
650}
651%>
Note: See TracBrowser for help on using the repository browser.