www/admin/protocols/protocols.js

Code
Comments
Other
Rev Date Author Line
7604 25 Feb 19 nicklas 1 /* $Id $
7604 25 Feb 19 nicklas 2   ------------------------------------------------------------------
7604 25 Feb 19 nicklas 3   Copyright (C) 2013 Nicklas Nordborg
7604 25 Feb 19 nicklas 4
7604 25 Feb 19 nicklas 5   This file is part of BASE - BioArray Software Environment.
7604 25 Feb 19 nicklas 6   Available at http://base.thep.lu.se/
7604 25 Feb 19 nicklas 7
7604 25 Feb 19 nicklas 8   BASE is free software; you can redistribute it and/or
7604 25 Feb 19 nicklas 9   modify it under the terms of the GNU General Public License
7604 25 Feb 19 nicklas 10   as published by the Free Software Foundation; either version 3
7604 25 Feb 19 nicklas 11   of the License, or (at your option) any later version.
7604 25 Feb 19 nicklas 12
7604 25 Feb 19 nicklas 13   BASE is distributed in the hope that it will be useful,
7604 25 Feb 19 nicklas 14   but WITHOUT ANY WARRANTY; without even the implied warranty of
7604 25 Feb 19 nicklas 15   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
7604 25 Feb 19 nicklas 16   GNU General Public License for more details.
7604 25 Feb 19 nicklas 17
7604 25 Feb 19 nicklas 18   You should have received a copy of the GNU General Public License
7604 25 Feb 19 nicklas 19   along with BASE. If not, see <http://www.gnu.org/licenses/>.
7604 25 Feb 19 nicklas 20   ------------------------------------------------------------------
7604 25 Feb 19 nicklas 21
7604 25 Feb 19 nicklas 22   @author Nicklas
7604 25 Feb 19 nicklas 23 */
7604 25 Feb 19 nicklas 24 'use strict';
7604 25 Feb 19 nicklas 25
7604 25 Feb 19 nicklas 26 var Protocols = function()
7604 25 Feb 19 nicklas 27 {
7604 25 Feb 19 nicklas 28   var protocols = {};
7604 25 Feb 19 nicklas 29   
7604 25 Feb 19 nicklas 30   /**
7604 25 Feb 19 nicklas 31     Initialize the page.
7604 25 Feb 19 nicklas 32   */
7604 25 Feb 19 nicklas 33   protocols.initPage = function()
7604 25 Feb 19 nicklas 34   {
7604 25 Feb 19 nicklas 35     var pageId = Doc.getPageId();
7604 25 Feb 19 nicklas 36     if (pageId == 'edit-page')
7604 25 Feb 19 nicklas 37     {
7604 25 Feb 19 nicklas 38       Buttons.addClickHandler('btnSave', protocols.save);
7604 25 Feb 19 nicklas 39       Buttons.addClickHandler('close', App.closeWindow);
7604 25 Feb 19 nicklas 40       
7604 25 Feb 19 nicklas 41       // Tab validation
7604 25 Feb 19 nicklas 42       TabControl.addTabActivateListener('settings.annotations', protocols.loadAnnotationsFrame);
7604 25 Feb 19 nicklas 43       TabControl.addTabValidator('settings.info', protocols.validateProtocol);
7604 25 Feb 19 nicklas 44
7604 25 Feb 19 nicklas 45       // Protocol parameters
7604 25 Feb 19 nicklas 46       Buttons.addClickHandler('btnAddProtocolParameters', protocols.addProtocolParameters);
7604 25 Feb 19 nicklas 47       Events.addEventHandler('btnAddProtocolParameters', 'base-selected', protocols.parameterSelected);
7604 25 Feb 19 nicklas 48
7604 25 Feb 19 nicklas 49       // Select file
7604 25 Feb 19 nicklas 50       Buttons.addClickHandler('file_id.select', protocols.selectFile);
7604 25 Feb 19 nicklas 51       Events.addEventHandler('file_id', 'base-selected', Items.onItemSelected);
7604 25 Feb 19 nicklas 52
7604 25 Feb 19 nicklas 53       // Subtype
7604 25 Feb 19 nicklas 54       Events.addEventHandler('subtype_id', 'change', protocols.subtypeOnChange);
7604 25 Feb 19 nicklas 55       protocols.subtypeOnChange();  
7604 25 Feb 19 nicklas 56     }
7604 25 Feb 19 nicklas 57     else if (pageId == 'view-page')
7604 25 Feb 19 nicklas 58     {
7604 25 Feb 19 nicklas 59       var itemId = Data.get('page-data', 'item-id');
7604 25 Feb 19 nicklas 60       var attributes = {'item-type': 'PROTOCOL', 'item-id': itemId};
7604 25 Feb 19 nicklas 61       Buttons.addClickHandler('btnEdit', Buttons.editItem, attributes);
7604 25 Feb 19 nicklas 62       Buttons.addClickHandler('btnDelete', Buttons.deleteItem, attributes);
7604 25 Feb 19 nicklas 63       Buttons.addClickHandler('btnRestore', Buttons.restoreItem, attributes);
7604 25 Feb 19 nicklas 64       Buttons.addClickHandler('btnUsingItems', Buttons.showUsingItems, attributes);
7604 25 Feb 19 nicklas 65       Buttons.addClickHandler('btnDeletePermanently', Buttons.deleteItemPermanently, attributes);
7604 25 Feb 19 nicklas 66       Buttons.addClickHandler('btnShare', Buttons.shareItem, attributes);
7604 25 Feb 19 nicklas 67       Buttons.addClickHandler('btnSetOwner', Buttons.setOwner, attributes);
7604 25 Feb 19 nicklas 68       Buttons.addClickHandler('btnExport', Buttons.runPlugin, attributes);
7604 25 Feb 19 nicklas 69       Buttons.addClickHandler('btnImport', Buttons.runPlugin, attributes);
7604 25 Feb 19 nicklas 70       Buttons.addClickHandler('btnRunPlugin', Buttons.runPlugin, attributes);
7604 25 Feb 19 nicklas 71       
7604 25 Feb 19 nicklas 72       TabControl.addTabActivateListener('main.annotations', AnnotationsList.loadOnce);
7604 25 Feb 19 nicklas 73       TabControl.addTabActivateListener('main.history', History.loadOnce);
7604 25 Feb 19 nicklas 74     }
7604 25 Feb 19 nicklas 75     else if (pageId == 'list-page')
7604 25 Feb 19 nicklas 76     {
7604 25 Feb 19 nicklas 77       var attributes = {'item-type': 'PROTOCOL'};
7604 25 Feb 19 nicklas 78       var tableAttributes = {'table-id': 'protocols'};
7604 25 Feb 19 nicklas 79       Buttons.addClickHandler('btnNewItem', Buttons.newItem, attributes);
7604 25 Feb 19 nicklas 80       Buttons.addClickHandler('btnDeleteItems', Buttons.deleteItems, tableAttributes);
7604 25 Feb 19 nicklas 81       Buttons.addClickHandler('btnRestoreItems', Buttons.restoreItems, tableAttributes);
7604 25 Feb 19 nicklas 82       Buttons.addClickHandler('btnShareItems', Buttons.shareItems, tableAttributes);
7604 25 Feb 19 nicklas 83       Buttons.addClickHandler('btnSetOwner', Buttons.setOwnerOfItems, tableAttributes);
7604 25 Feb 19 nicklas 84       Buttons.addClickHandler('btnColumns', Buttons.configureColumns, tableAttributes);
7604 25 Feb 19 nicklas 85       Buttons.addClickHandler('btnExport', Buttons.runListPlugin, tableAttributes);
7604 25 Feb 19 nicklas 86       Buttons.addClickHandler('btnImport', Buttons.runListPlugin, tableAttributes);
7604 25 Feb 19 nicklas 87       Buttons.addClickHandler('btnRunPlugin', Buttons.runListPlugin, tableAttributes);
7604 25 Feb 19 nicklas 88
7604 25 Feb 19 nicklas 89       Buttons.addClickHandler('close', App.closeWindow);
7604 25 Feb 19 nicklas 90       Buttons.addClickHandler('btnOk', Buttons.returnSelected, tableAttributes);
7604 25 Feb 19 nicklas 91     }
7604 25 Feb 19 nicklas 92   }
7604 25 Feb 19 nicklas 93   
7604 25 Feb 19 nicklas 94   // Submit the form
7604 25 Feb 19 nicklas 95   protocols.save = function()
7604 25 Feb 19 nicklas 96   {
7604 25 Feb 19 nicklas 97     var frm = document.forms['protocol'];
7604 25 Feb 19 nicklas 98     if (TabControl.validateActiveTab('settings'))
7604 25 Feb 19 nicklas 99     {
7604 25 Feb 19 nicklas 100       Annotations.saveModifiedAnnotationsToForm(frm);
7604 25 Feb 19 nicklas 101       Link.exportActions('annotationTypes');
7604 25 Feb 19 nicklas 102       frm.submit();
7604 25 Feb 19 nicklas 103     }
7604 25 Feb 19 nicklas 104   }
7604 25 Feb 19 nicklas 105
7604 25 Feb 19 nicklas 106   protocols.validateProtocol = function()
7604 25 Feb 19 nicklas 107   {
7604 25 Feb 19 nicklas 108     var frm = document.forms['protocol'];
7604 25 Feb 19 nicklas 109     if (Strings.trim(frm.name.value) == '')
7604 25 Feb 19 nicklas 110     {
7604 25 Feb 19 nicklas 111       Forms.showNotification(frm.name, 'You must enter a name');
7604 25 Feb 19 nicklas 112       return false;
7604 25 Feb 19 nicklas 113     }
7604 25 Feb 19 nicklas 114     return true;
7604 25 Feb 19 nicklas 115   }
7604 25 Feb 19 nicklas 116
7604 25 Feb 19 nicklas 117   protocols.loadAnnotationsFrame = function()
7604 25 Feb 19 nicklas 118   {
7604 25 Feb 19 nicklas 119     Annotations.autoLoadEditFrame(null, ItemSubtype.getSubtypeId('subtype_id'));
7604 25 Feb 19 nicklas 120   }
7604 25 Feb 19 nicklas 121
7604 25 Feb 19 nicklas 122   
7604 25 Feb 19 nicklas 123   /**
7604 25 Feb 19 nicklas 124     Open a popup dialog for selecting protocol parameters.
7604 25 Feb 19 nicklas 125   */
7604 25 Feb 19 nicklas 126   protocols.addProtocolParameters = function(event)
7604 25 Feb 19 nicklas 127   {
7604 25 Feb 19 nicklas 128     var frm = document.forms['protocol'];
7604 25 Feb 19 nicklas 129     var currentParameters = Link.getIdsInList(frm.annotationTypes, 'ANNOTATIONTYPE');
7604 25 Feb 19 nicklas 130     var excludes = currentParameters.join(',');
7604 25 Feb 19 nicklas 131     var url = '&resetTemporary=1&tmpfilter:BOOLEAN:protocolParameter=true';
7604 25 Feb 19 nicklas 132     url += "&exclude="+excludes;
7604 25 Feb 19 nicklas 133     Dialogs.selectItem('ANNOTATIONTYPE', event.currentTarget.id, 1, url);
7604 25 Feb 19 nicklas 134   }
7604 25 Feb 19 nicklas 135   
7604 25 Feb 19 nicklas 136   /**
7604 25 Feb 19 nicklas 137     Callback for adding selected protocol parameters to the list.
7604 25 Feb 19 nicklas 138    */
7604 25 Feb 19 nicklas 139   protocols.parameterSelected = function(event)
7604 25 Feb 19 nicklas 140   {
7604 25 Feb 19 nicklas 141     Link.addItem('annotationTypes', 'ANNOTATIONTYPE', event.detail);
7604 25 Feb 19 nicklas 142   }
7604 25 Feb 19 nicklas 143
7604 25 Feb 19 nicklas 144   /**
7604 25 Feb 19 nicklas 145     Select the file with protocol details.
7604 25 Feb 19 nicklas 146    */
7604 25 Feb 19 nicklas 147   protocols.selectFile = function()
7604 25 Feb 19 nicklas 148   {
7604 25 Feb 19 nicklas 149     var frm = document.forms['protocol'];
7604 25 Feb 19 nicklas 150     var url = '&resetTemporary=1';
7604 25 Feb 19 nicklas 151     url += ItemSubtype.createRelatedFilter('subtype_id', 'FILE', Data.int('page-data', 'protocol-filetype-id'));
7604 25 Feb 19 nicklas 152     if (frm.file_id.length > 1) 
7604 25 Feb 19 nicklas 153     {
7604 25 Feb 19 nicklas 154       var id = Math.abs(parseInt(frm.file_id[1].value));
7604 25 Feb 19 nicklas 155       url += '&item_id='+id;
7604 25 Feb 19 nicklas 156     }
7604 25 Feb 19 nicklas 157     Dialogs.selectItem('FILE', 'file_id', 0, url);
7604 25 Feb 19 nicklas 158   }
7604 25 Feb 19 nicklas 159   
7604 25 Feb 19 nicklas 160   
7604 25 Feb 19 nicklas 161   protocols.subtypeOnChange = function()
7604 25 Feb 19 nicklas 162   {
7604 25 Feb 19 nicklas 163     var frm = document.forms['protocol'];
7604 25 Feb 19 nicklas 164     if (frm.replaceExistingDefault)
7604 25 Feb 19 nicklas 165     {
7604 25 Feb 19 nicklas 166       var subtypeId = ItemSubtype.getSubtypeId('subtype_id');
7604 25 Feb 19 nicklas 167       var defaultInfo = ItemSubtype.getProjectDefaultAndRecentItems('PROTOCOL', subtypeId);
7604 25 Feb 19 nicklas 168       var currentDefaultDiv = Doc.element('currentDefault');
7604 25 Feb 19 nicklas 169       
7604 25 Feb 19 nicklas 170       var tooltip = '';
7604 25 Feb 19 nicklas 171       var html = '';
7604 25 Feb 19 nicklas 172       var checked = true;
7604 25 Feb 19 nicklas 173       var disabled = false;
7604 25 Feb 19 nicklas 174       
7604 25 Feb 19 nicklas 175       var numDefaults = defaultInfo['default'] ? defaultInfo['default'].length : 0;
7604 25 Feb 19 nicklas 176       if (numDefaults == 1)
7604 25 Feb 19 nicklas 177       {
7604 25 Feb 19 nicklas 178         html = '('+Strings.encodeTags(Strings.cut(defaultInfo['default'][0].name, 40)) + ')';
7604 25 Feb 19 nicklas 179       }
7604 25 Feb 19 nicklas 180       else if (numDefaults == 0)
7604 25 Feb 19 nicklas 181       {
7604 25 Feb 19 nicklas 182         html = '(-none-)';
7604 25 Feb 19 nicklas 183         checked = false;
7604 25 Feb 19 nicklas 184         disabled = true;
7604 25 Feb 19 nicklas 185       }
7604 25 Feb 19 nicklas 186       else
7604 25 Feb 19 nicklas 187       {
7604 25 Feb 19 nicklas 188         html = '(' + numDefaults + ' different)';
7604 25 Feb 19 nicklas 189         for (var i = 0; i < numDefaults; i++)
7604 25 Feb 19 nicklas 190         {
7604 25 Feb 19 nicklas 191           tooltip += Strings.encodeTags(defaultInfo['default'][i].name) + '\n';
7604 25 Feb 19 nicklas 192         }
7604 25 Feb 19 nicklas 193         checked = false;
7604 25 Feb 19 nicklas 194       }
7604 25 Feb 19 nicklas 195       
7604 25 Feb 19 nicklas 196       currentDefaultDiv.title = tooltip;
7604 25 Feb 19 nicklas 197       currentDefaultDiv.innerHTML = html;
7604 25 Feb 19 nicklas 198       frm.replaceExistingDefault.checked = checked;
7604 25 Feb 19 nicklas 199       frm.replaceExistingDefault.disabled = disabled;
7604 25 Feb 19 nicklas 200     }
7604 25 Feb 19 nicklas 201   }
7604 25 Feb 19 nicklas 202
7604 25 Feb 19 nicklas 203   return protocols;
7604 25 Feb 19 nicklas 204 }();
7604 25 Feb 19 nicklas 205
7604 25 Feb 19 nicklas 206 Doc.onLoad(Protocols.initPage);