source: trunk/www/admin/protocols/view_protocol.jsp @ 4938

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

Fixes #1310: Annotations for protocols

The code worked perfectly right away. Thanks Pawel!

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 15.4 KB
Line 
1<%-- $Id: view_protocol.jsp 4938 2009-05-19 09:24:55Z nicklas $
2  ------------------------------------------------------------------
3  Copyright (C) 2006 Jari Häkkinen, Nicklas Nordborg, Martin Svensson
4  Copyright (C) 2007 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.SystemItems"
30  import="net.sf.basedb.core.Group"
31  import="net.sf.basedb.core.Item"
32  import="net.sf.basedb.core.ItemContext"
33  import="net.sf.basedb.core.Permission"
34  import="net.sf.basedb.core.Protocol"
35  import="net.sf.basedb.core.ProtocolType"
36  import="net.sf.basedb.core.AnnotationType"
37  import="net.sf.basedb.core.File"
38  import="net.sf.basedb.core.User"
39  import="net.sf.basedb.core.PermissionDeniedException"
40  import="net.sf.basedb.core.PluginDefinition"
41  import="net.sf.basedb.core.ItemQuery"
42  import="net.sf.basedb.core.ItemResultIterator"
43  import="net.sf.basedb.core.ItemResultList"
44  import="net.sf.basedb.core.Include"
45  import="net.sf.basedb.core.MultiPermissions"
46  import="net.sf.basedb.core.plugin.GuiContext"
47  import="net.sf.basedb.core.plugin.Plugin"
48  import="net.sf.basedb.core.Project"
49  import="net.sf.basedb.core.query.Orders"
50  import="net.sf.basedb.core.query.Hql"
51  import="net.sf.basedb.clients.web.Base"
52  import="net.sf.basedb.clients.web.PermissionUtil"
53  import="net.sf.basedb.clients.web.util.HTML"
54  import="net.sf.basedb.util.formatter.Formatter"
55  import="net.sf.basedb.clients.web.formatter.FormatterFactory"
56  import="net.sf.basedb.clients.web.extensions.ExtensionsControl"
57  import="net.sf.basedb.clients.web.extensions.JspContext"
58  import="net.sf.basedb.clients.web.extensions.renderer.PrefixSuffixRenderer"
59  import="net.sf.basedb.clients.web.extensions.toolbar.ToolbarUtil"
60  import="net.sf.basedb.util.extensions.ExtensionsInvoker"
61  import="java.util.Date"
62  import="net.sf.basedb.util.Values"
63  import="java.util.Collections"
64  import="java.util.Map"
65  import="java.util.Set"
66%>
67<%@ taglib prefix="base" uri="/WEB-INF/base.tld" %>
68<%@ taglib prefix="tbl" uri="/WEB-INF/table.tld" %>
69<%@ taglib prefix="t" uri="/WEB-INF/tab.tld" %>
70<%@ taglib prefix="p" uri="/WEB-INF/path.tld" %>
71<%@ taglib prefix="ext" uri="/WEB-INF/extensions.tld" %>
72<%!
73  private static final Item itemType = Item.PROTOCOL;
74  private static final GuiContext guiContext = new GuiContext(itemType, GuiContext.Type.ITEM);
75%>
76<%
77final SessionControl sc = Base.getExistingSessionControl(pageContext, true);
78final String ID = sc.getId();
79final ItemContext cc = Base.getAndSetCurrentContext(sc, itemType, null, null);
80final int itemId = cc.getId();
81final float scale = Base.getScale(sc);
82final DbControl dc = sc.newDbControl();
83try
84{
85  Formatter<Date> dateFormatter = FormatterFactory.getDateFormatter(sc);
86  Map<Plugin.MainType, Integer> pluginCount = PluginDefinition.countPlugins(dc, guiContext);
87
88  String title = null;
89  Protocol protocol = Protocol.getById(dc, itemId);
90 
91  final boolean writePermission = protocol.hasPermission(Permission.WRITE);
92  final boolean deletePermission = protocol.hasPermission(Permission.DELETE);
93  final boolean sharePermission = protocol.hasPermission(Permission.SET_PERMISSION);
94  final boolean setOwnerPermission = protocol.hasPermission(Permission.SET_OWNER);
95  final boolean isRemoved = protocol.isRemoved();
96  final boolean isUsed = isRemoved && protocol.isUsed();
97  final boolean deletePermanentlyPermission = deletePermission && !isUsed;
98  final boolean isOwner = protocol.isOwner();
99  JspContext jspContext = ExtensionsControl.createContext(dc, pageContext, guiContext, protocol);
100  ExtensionsInvoker invoker = ToolbarUtil.useExtensions(jspContext);
101  %>
102  <base:page title="<%=title%>">
103  <base:head scripts="tabcontrol.js,table.js" styles="toolbar.css,headertabcontrol.css,path.css,table.css">
104    <ext:scripts context="<%=jspContext%>" />
105    <ext:stylesheets context="<%=jspContext%>" />
106    <script language="JavaScript">
107    function editItem()
108    {
109      Main.viewOrEditItem('<%=ID%>', '<%=itemType.name()%>', <%=itemId%>, true);
110    }
111    function shareItem()
112    {
113      Main.openPopup('index.jsp?ID=<%=ID%>&cmd=ShareItem&item_id=<%=itemId%>', 'ShareProtocol', 600, 400);
114    }
115    function deleteItem()
116    {
117      location.replace('index.jsp?ID=<%=ID%>&cmd=DeleteItem&item_id=<%=itemId%>');
118    }
119    function restoreItem()
120    {
121      location.replace('index.jsp?ID=<%=ID%>&cmd=RestoreItem&item_id=<%=itemId%>');
122    }
123    function deleteItemPermanently()
124    {
125      Main.deleteItemPermanently('<%=ID%>', true, '<%=itemType.name()%>', <%=itemId%>, '&callback=itemDeleted');
126    }
127    function itemDeleted()
128    {
129      Main.listItems('<%=ID%>', '<%=itemType.name()%>');
130    }
131    function showUsingItems()
132    {
133      Main.showUsingItems('<%=ID%>', '<%=itemType.name()%>', <%=itemId%>);
134    }
135    function setOwner()
136    {
137      Main.openPopup('index.jsp?ID=<%=ID%>&cmd=SetOwnerOfItem&item_id=<%=itemId%>', 'SetOwnerOfItem', 450, 150);
138    }
139    function runPlugin(cmd)
140    {
141      Main.openPopup('index.jsp?ID=<%=ID%>&cmd='+cmd+'&item_id=<%=itemId%>', 'RunPlugin'+cmd, 740, 540);
142    }
143    </script>
144  </base:head>
145  <base:body>
146    <p>
147    <p:path>
148      <p:pathelement title="Protocols" href="<%="index.jsp?ID="+ID%>" />
149      <p:pathelement title="<%=HTML.encodeTags(protocol.getName())%>" />
150    </p:path>
151   
152    <t:tabcontrol id="main" active="properties">
153    <t:tab id="properties" title="Properties">
154   
155    <tbl:toolbar
156      >
157      <tbl:button 
158        disabled="<%=writePermission ? false : true%>" 
159        image="<%=writePermission ? "edit.gif" : "edit_disabled.gif"%>" 
160        onclick="editItem()" 
161        title="Edit&hellip;" 
162        tooltip="<%=writePermission ? "Edit this protocol" : "You do not have permission to edit this protocol"%>" 
163      />
164      <tbl:button 
165        disabled="<%=deletePermission ? false : true%>" 
166        image="<%=deletePermission ? "delete.gif" : "delete_disabled.gif"%>" 
167        onclick="deleteItem()" 
168        title="Delete"
169        visible="<%=!protocol.isRemoved()%>"
170        tooltip="<%=deletePermission ? "Delete this protocol" : "You do not have permission to delete this protocol"%>" 
171      />
172      <tbl:button 
173        disabled="<%=writePermission ? false : true%>" 
174        image="<%=writePermission ? "restore.gif" : "restore_disabled.gif"%>" 
175        onclick="restoreItem()" 
176        title="Restore"
177        visible="<%=protocol.isRemoved()%>"
178        tooltip="<%=writePermission ? "Restore this protocol" : "You do not have permission to restore this protocol"%>" 
179      />
180      <tbl:button 
181        disabled="<%=sharePermission ? false : true%>"
182        image="<%=sharePermission ? "share.gif" : "share_disabled.gif"%>"
183        onclick="shareItem()" 
184        title="Share&hellip;" 
185        tooltip="<%=sharePermission ? "Share this protocol to other user, groups and projects" : "You do not have permission to share this protocol"%>"
186      />
187      <tbl:button 
188        disabled="<%=setOwnerPermission ? false : true%>"
189        image="<%=setOwnerPermission ? "take_ownership.png" : "take_ownership_disabled.png"%>"
190        onclick="setOwner()" 
191        title="Set owner&hellip;"
192        tooltip="<%=setOwnerPermission ? "Change owner of this item" : "You do not have permission to change ownership of this item"%>"
193      />
194      <tbl:button 
195        image="import.gif" 
196        onclick="runPlugin('ImportItem')" 
197        title="Import&hellip;" 
198        tooltip="Import data" 
199        visible="<%=pluginCount.containsKey(Plugin.MainType.IMPORT)%>"
200      />
201      <tbl:button 
202        image="export.gif" 
203        onclick="runPlugin('ExportItem')" 
204        title="Export&hellip;" 
205        tooltip="Export data" 
206        visible="<%=pluginCount.containsKey(Plugin.MainType.EXPORT)%>"
207      />
208      <tbl:button 
209        image="runplugin.gif" 
210        onclick="runPlugin('RunPlugin')" 
211        title="Run plugin&hellip;" 
212        tooltip="Run a plugin" 
213        visible="<%=pluginCount.containsKey(Plugin.MainType.OTHER)%>"
214      />
215      <ext:render extensions="<%=invoker%>" context="<%=jspContext%>" 
216        wrapper="<%=new PrefixSuffixRenderer(jspContext, "<td>", "</td>") %>"/>
217      <tbl:button
218        image="help.gif"
219        onclick="<%="Main.openHelp('" + ID +"', 'protocol.view.properties')"%>"
220        title="Help&hellip;"
221        tooltip="Get help about this page"
222      />
223      </tbl:toolbar>
224    <div class="boxedbottom">
225      <div class="itemstatus">Permissions on this item: <i><%=PermissionUtil.getFullPermissionNames(protocol)%></i></div>
226      <%
227      if (protocol.isRemoved() || protocol.isShared())
228      {
229        %>
230        <div class="itemstatus">
231          <base:icon 
232            image="<%=deletePermanentlyPermission ? "deleted.gif" : "deleted_disabled.gif"%>"
233            onclick="<%=deletePermanentlyPermission ? "deleteItemPermanently()" : null%>"
234            tooltip="<%=deletePermanentlyPermission ? "Permanently delete this item" : null%>"
235            visible="<%=isRemoved%>"> This item has been flagged for deletion<br></base:icon>
236          <base:icon image="used.gif" 
237            onclick="showUsingItems()"
238            tooltip="Show the items that are using this one"
239            visible="<%=isUsed%>"> This item is used by other items and can't be permanently deleted<br></base:icon>
240          <base:icon image="shared.gif" 
241            visible="<%=protocol.isShared()%>"> This item is shared to other users, groups and/or projects</base:icon>
242        </div>
243        <%
244      }
245      %>
246      <table class="form" cellspacing="0">
247      <tr>
248        <td class="prompt">Name</td>
249        <td><%=HTML.encodeTags(protocol.getName())%></td>
250      </tr>
251      <tr>
252        <td class="prompt">Type</td>
253        <td><base:propertyvalue item="<%=protocol%>" property="protocolType" /></td>
254      </tr>
255      <tr>
256        <td class="prompt">Registered</td>
257        <td><%=dateFormatter.format(protocol.getEntryDate())%></td>
258      </tr>
259      <tr>
260        <td class="prompt">File</td>
261        <td><base:propertyvalue item="<%=protocol%>" property="file" /></td>
262      </tr>
263      <tr>
264        <td class="prompt">Owner</td>
265        <td><base:propertyvalue item="<%=protocol%>" property="owner" /></td>
266      </tr>
267      <tr>
268        <td class="prompt">Description</td>
269        <td><%=HTML.niceFormat(protocol.getDescription())%></td>
270      </tr>
271      </table>
272
273      <%
274      ItemQuery<AnnotationType> parameterQuery = protocol.getParameters();
275      parameterQuery.include(Include.ALL);
276      parameterQuery.order(Orders.asc(Hql.property("name")));
277      ItemResultList<AnnotationType> parameters = parameterQuery.list(dc);
278      if (parameters.size() == 0)
279      {
280        %>
281        <h4>Parameters</h4>
282        No parameters has been added to this protocol
283        (or, you don't have permission to view them).
284        <%
285      }
286      else
287      {
288        %>
289        <h4 class="docked">Parameters</h4>
290        <tbl:table
291          id="parameters"
292          clazz="itemlist"
293          columns="all"
294          >
295        <tbl:columndef 
296          id="name"
297          title="Name"
298        />
299        <tbl:columndef
300          id="values"
301          title="Values"
302        />
303        <tbl:columndef 
304          id="description"
305          title="Description"
306        />
307        <tbl:data>
308          <tbl:columns>
309          </tbl:columns>
310          <tbl:rows>
311          <%
312          for (AnnotationType item : parameters)
313          {
314            %>
315            <tbl:row>
316              <tbl:cell column="name"><base:icon 
317                  image="deleted.gif" 
318                  tooltip="This item has been scheduled for deletion" 
319                  visible="<%=item.isRemoved()%>"
320                /><%=Base.getLinkedName(ID, item, false, true)%></tbl:cell>
321              <tbl:cell column="description"><%=HTML.encodeTags(item.getDescription())%></tbl:cell>
322              <tbl:cell column="values">
323              <%=item.isEnumeration() ? 
324                "Enumeration: " + HTML.encodeTags(Values.getString(item.getValues(), ", ", true)) :
325                item.getValueType()%>
326              </tbl:cell>
327            </tbl:row>
328            <%
329          }
330          %>
331          </tbl:rows>
332        </tbl:data>
333        </tbl:table>
334        <%
335      }     
336     
337      // Tables with users/groups/projects that this item is shared to
338      MultiPermissions mp = new MultiPermissions(Collections.singleton(protocol));
339      ItemResultIterator<User> users = mp.getUsers().iterate(dc);
340      ItemResultIterator<Group> groups = mp.getGroups().iterate(dc);
341      ItemResultIterator<Project> projects = mp.getProjects().iterate(dc);
342     
343      if (users.hasNext() || groups.hasNext() || projects.hasNext())
344      {
345        %>
346        <h4 class="docked">Shared to</h4>
347        <tbl:table 
348          id="itemsSharedTo"
349          clazz="itemlist"
350          columns="all"
351        >
352          <tbl:columndef 
353            id="itemType"
354            title="Item type"
355          />
356          <tbl:columndef 
357            id="name"
358            title="Name"
359          />
360          <tbl:columndef 
361            id="permissions"
362            title="Permissions"
363          />
364          <tbl:data>
365            <tbl:columns>
366            </tbl:columns>
367            <tbl:rows>
368            <%
369            while(projects.hasNext())
370            {
371              Project project = projects.next();
372              Set<Permission> permissions = mp.getPermissions(project).values().iterator().next();
373              %>     
374              <tbl:row>
375                <tbl:cell column="itemType"><%=project.getType()%></tbl:cell>
376                <tbl:cell column="name"><base:icon 
377                  image="deleted.gif" 
378                  tooltip="This item has been scheduled for deletion" 
379                  visible="<%=project.isRemoved()%>"
380                /><%=Base.getLinkedName(ID, project, false, true)%></tbl:cell>
381                <tbl:cell column="permissions">
382                  <%=PermissionUtil.translatePermissionsToString(permissions)%>
383                </tbl:cell>
384              </tbl:row>
385              <%
386            }
387            while(groups.hasNext())
388            {
389              Group group = groups.next();
390              Set<Permission> permissions = mp.getPermissions(group).values().iterator().next();
391              %>
392              <tbl:row>             
393                <tbl:cell column="itemType"><%=group.getType()%></tbl:cell>
394                <tbl:cell column="name"><base:icon 
395                  image="deleted.gif" 
396                  tooltip="This item has been scheduled for deletion" 
397                  visible="<%=group.isRemoved()%>"
398                /><%=Base.getLinkedName(ID, group, false, true)%></tbl:cell>
399                <tbl:cell column="permissions">
400                  <%=PermissionUtil.translatePermissionsToString(permissions)%>
401                </tbl:cell>
402              </tbl:row>
403              <% 
404            }
405            while (users.hasNext())
406            {
407              User user = users.next();
408              Set<Permission> permissions = mp.getPermissions(user).values().iterator().next();
409              %>
410              <tbl:row>             
411                <tbl:cell column="itemType"><%=user.getType()%></tbl:cell>
412                <tbl:cell column="name"><base:icon 
413                  image="deleted.gif" 
414                  tooltip="This item has been scheduled for deletion" 
415                  visible="<%=user.isRemoved()%>"
416                /><%=Base.getLinkedName(ID, user, false, true)%></tbl:cell>
417                <tbl:cell column="permissions">
418                  <%=PermissionUtil.translatePermissionsToString(permissions)%>
419                </tbl:cell>
420              </tbl:row>
421              <%
422            }
423            %>
424            </tbl:rows>
425          </tbl:data>
426        </tbl:table>
427        <%
428      }
429      else
430      {
431        %>
432        <h4>Shared to</h4>
433        This protocol is not shared
434        (or, you don't have permission to view the ones it is shared to).
435        <%
436      }
437      %> 
438    </div>
439    </t:tab>
440     
441    <t:tab id="annotations" title="Annotations" 
442      tooltip="View annotation values">
443      <div class="boxed">
444      <jsp:include page="../../common/annotations/list_annotations.jsp">
445        <jsp:param name="item_type" value="<%=itemType.name()%>" />
446        <jsp:param name="item_id" value="<%=itemId%>" />
447        <jsp:param name="ID" value="<%=ID%>" />
448      </jsp:include>
449      </div>
450    </t:tab>
451     
452    </t:tabcontrol>
453
454  </base:body>
455  </base:page>
456  <%
457}
458finally
459{
460  if (dc != null) dc.close();
461}
462
463%>
Note: See TracBrowser for help on using the repository browser.