Changeset 1159 for trunk

Timestamp:

Nov 17, 2010, 4:20:33 PM (11 years ago)

Author:

robert@…

Message:

Improved the template editor so that template fields can be removed from templates, even if the templates are in use, but only if the template fields are never filled. (see ticket #74)

Also changed the user registration so that the administrator confirmation mails will be sent to the administrators in production environment, but still to gscfproject@… in other environments.

Location:

trunk/grails-app

Files:

• controllers/dbnp/authentication/UserRegistrationController.groovy (modified) (2 diffs)
• controllers/dbnp/studycapturing/TemplateEditorController.groovy (modified) (2 diffs)
• domain/dbnp/authentication/SecRole.groovy (modified) (1 diff)
• domain/dbnp/studycapturing/TemplateField.groovy (modified) (1 diff)
• views/templateEditor/_ontologyDialog.gsp (modified) (2 diffs)
• views/templateEditor/elements/_liFieldInUse.gsp (modified) (1 diff)
• views/templateEditor/elements/_liFieldNotInUse.gsp (modified) (1 diff)
• views/templateEditor/elements/_liFieldSelected.gsp (modified) (2 diffs)
• views/templateEditor/elements/_liTemplateEditable.gsp (modified) (1 diff)
• views/templateEditor/elements/_liTemplateNonEditable.gsp (modified) (1 diff)
• views/templateEditor/elements/_selected.gsp (modified) (1 diff)
• views/templateEditor/index.gsp (modified) (1 diff)
• views/user/edit.gsp (modified) (2 diffs)

trunk/grails-app/controllers/dbnp/authentication/UserRegistrationController.groovy

@@ -15 +15 @@
 package dbnp.authentication
 import grails.plugins.springsecurity.Secured
+import org.codehaus.groovy.grails.commons.GrailsApplication
+import grails.util.GrailsUtil
 
 class UserRegistrationController {
@@ -125 +127 @@
         def adminLink = createLink( controller: 'userRegistration', action: 'confirmAdmin', params: [code: adminCode.token], absolute: true )
 
+                // If we are in production, send the mails to all administrators
+                // Otherwise, send it to a default (spam) mail address
+                def adminMail = "gscfproject@gmail.com";
+                if ( GrailsUtil.getEnvironment().equals(GrailsApplication.ENV_PRODUCTION) ) {
+                        def administrators = SecRole.findUsers( 'ROLE_ADMIN' );
+                        if( administrators.size() > 0 ) {
+                                adminMail = administrators.email.toArray();
+                        }
+                }
+
         // Send an email to the administrators
         try {
                         // Determine administrator email addresses
             sendMail {
-                to      "gscfproject@gmail.com"
+                to      adminMail
                 subject "New user (" + user.username + ") at GSCF"
                 html    g.render(template:"/email/registrationConfirmationAdmin", model:[username: user.username, email: user.email, link: adminLink])

trunk/grails-app/controllers/dbnp/studycapturing/TemplateEditorController.groovy

@@ -494 +494 @@
                 templateField.properties = params
         if (!templateField.hasErrors() && templateField.save(flush: true)) {
-                        def html = g.render( template: 'elements/available', model: [templateField: templateField, ontologies: Ontology.list(), fieldTypes: TemplateFieldType.list()] );
+
+                        // Select the template to use for the HTML output
+                        def renderTemplate = 'elements/available';
+                        if( params.renderTemplate == 'selected' ) {
+                                renderTemplate = 'elements/selected';
+                        }
+
+                        // Selected fields should have a template given
+                        def template = null;
+                        if( params.templateId )
+                                template = Template.findById( params.templateId );
+                        
+                        def html = g.render( template: renderTemplate, model: [template: template, templateField: templateField, ontologies: Ontology.list(), fieldTypes: TemplateFieldType.list()] );
                         def output = [ id: templateField.id, html: html ];
                         render output as JSON;
@@ -635 +647 @@
 
                 // If the template is in use, field can not be removed
-                if( template.inUse() ) {
-                        response.status = 500;
-                        render 'No fields can be removed from templates that are in use.'
+                if( templateField.isFilledInTemplate(template) ) {
+                        response.status = 500;
+                        render 'Fields can not be removed from a template if it has been filled somewhere.'
                         return;
                 }

trunk/grails-app/domain/dbnp/authentication/SecRole.groovy

@@ -12 +12 @@
                 authority blank: false, unique: true
         }
+
+        static List<SecUser> findUsers(String authority) {
+                def userRoles = SecUserSecRole.findAllBySecRole( SecRole.findByAuthority( authority ) );
+                
+                def users = [];
+                userRoles.each { users.add( it.secUser ) }
+                
+                return users
+        }
 }

trunk/grails-app/domain/dbnp/studycapturing/TemplateField.groovy

@@ -118 +118 @@
 
         /**
-         * The number of templates that use this template
-         *
-         * @returns             the number of templates that use this template.
+         * The number of templates that use this template field
+         *
+         * @returns             the number of templates that use this template field.
          */
         def numUses() {
+                return getUses().size();
+        }
+
+        /**
+         * Retrieves the templates that use this template field
+         *
+         * @returns             a list of templates that use this template field.
+         */
+        def getUses() {
                 def templates = Template.findAll();
                 def elements;
+
                 if( templates && templates.size() > 0 ) {
                         elements = templates.findAll { template -> template.fields.contains( this ) };
                 } else {
-                        return 0;
+                        return [];
                 }
 
-                return elements.size();
-        }
+                return elements;
+        }
+
+        /**
+         * Checks whether this template field is used in a template and also filled in any instance of that template
+         *
+         * @returns             true iff this template field is used in a template, the template is instantiated
+         *                              and an instance has a value for this field. false otherwise
+         */
+        def isFilled() {
+                // Find all entities that use this template
+                def templates = getUses();
+
+                if( templates.size() == 0 )
+                        return false;
+
+                def c = this.entity.createCriteria()
+                def entities = c {
+                        'in'("template",templates)
+                }
+
+                def filledEntities = entities.findAll { entity -> entity.getFieldValue( this.name ) }
+
+                return filledEntities.size() > 0;
+        }
+
+        /**
+         * Checks whether this template field is used in the given template and also filled in an instance of that template
+         *
+         * @returns             true iff this template field is used in the given template, the template is instantiated
+         *                              and an instance has a value for this field. false otherwise
+         */
+        def isFilledInTemplate(Template t) {
+                println( "Checking field " + this.name )
+                println( "Filled in template: " + t)
+                if( t == null ) 
+                        return false;
+                        
+                // If the template is not used, if can never be filled
+                if( !t.fields.contains( this ) )
+                        return false;
+
+                // Find all entities that use this template
+                def entities = entity.findAllByTemplate( t );
+
+                println( "Num entities: " + entities.size() )
+
+                def filledEntities = entities.findAll { entity -> entity.getFieldValue( this.name ) }
+
+                println( "Num filled entities: " + filledEntities.size() )
+                println( "Values: " + filledEntities*.getFieldValue( this.name ).join( ', ' ) )
+                return filledEntities.size() > 0;
+        }
+
+        /**
+         * Check whether a templatefield that is used in a template may still be edited or deleted.
+         * That is possible if the templatefield is never filled and the template is only used in one template
+         *
+         * This method should only be used for templatefields used in a template that is currently shown. Otherwise
+         * the user may edit this template field, while it is also in use in another template than is currently shown.
+         * That lead to confusion.
+         *
+         * @returns true iff this template may still be edited or deleted.
+         */
+        def isEditable() {
+                return !isFilled() && numUses() == 1;
+        }
+
+        /**
+         * Checks whether the given list item is selected in an entity where this template field is used
+         *
+         * @param       item    ListItem to check.
+         * @returns                     true iff the list item is part of this template field and the given list
+         *                                      item is selected in an entity where this template field is used. false otherwise
+         *                                      Returns false if the type of this template field is other than STRINGLIST
+         */
+        def entryUsed(TemplateFieldListItem item) {
+                //return numUses() > 0;
+        }
+
+        /**
+         * Checks whether a term from the given ontology is selected in an entity where this template field is used
+         *
+         * @param       item    ListItem to check.
+         * @returns                     true iff the ontology is part of this template field and a term from the given
+         *                                      ontology is selected in an entity where this template field is used. false otherwise
+         *                                      Returns false if the type of this template field is other than ONTOLOGY
+         */
+        def entryUsed(Ontology item) {
+                //return numUses() > 0;
+        }
+
 }

trunk/grails-app/views/templateEditor/_ontologyDialog.gsp

@@ -4 +4 @@
         Search by ncboID. Fill in the ncboID of the ontology you want to add.<br />
         <input class="text" type="text" name="ncboID" id="ncboIDText" onClick="$('#searchType_ncbo').attr( 'checked', true ); $( '#termID' ).val( '' );">
-        <img id="ncbo_spinner" src="${createLinkTo( dir: 'images', file: 'spinner.gif' )}" style="margin-left: 5px; display: none;">
+        <img id="ncbo_spinner" src="${resource( dir: 'images', file: 'spinner.gif' )}" style="margin-left: 5px; display: none;">
   </li>
   <li onClick="$('#searchType_term').attr( 'checked', true ); $( '#ncboIDText' ).val( '' );">
@@ -11 +11 @@
         be added to the system.<br />
         <g:textField class="text" name="termID" rel="ontology-all" onClick="\$('#searchType_term').attr( 'checked', true ); \$( '#ncboIDText' ).val( '' );"/>
-        <img id="term_spinner" src="${createLinkTo( dir: 'images', file: 'spinner.gif' )}" style="margin-left: 5px; display: none;">
+        <img id="term_spinner" src="${resource( dir: 'images', file: 'spinner.gif' )}" style="margin-left: 5px; display: none;">
   </li>
 </ul>

trunk/grails-app/views/templateEditor/elements/_liFieldInUse.gsp

@@ -1 +1 @@
 <g:set var="numUses" value="${templateField.numUses()}" />
 <span class="listButtons">
-  <img onClick="showTemplateFieldForm( 'templateField_' + ${templateField.id}); this.blur(); return false;" src="${createLinkTo( dir: 'images/icons', file: 'application_edit.png', plugin: 'famfamfam' )}" alt="Edit template field properties" title="Edit template field properties">
-  <img class="disabled" src="${createLinkTo( dir: 'images/icons', file: 'delete.png', plugin: 'famfamfam' )}" alt="Deleting this field is not possible. Field is used in ${numUses} templates." title="Deleting this field is not possible. Field is used in ${numUses} templates.">
-  <img onClick="addTemplateField( ${templateField.id}, null, true );" src="${createLinkTo( dir: 'images/icons', file: 'add.png', plugin: 'famfamfam' )}" alt="Add field to template" title="Add field to template">
+  <img onClick="showTemplateFieldForm( 'templateField_' + ${templateField.id}); this.blur(); return false;" src="${resource( dir: 'images/icons', file: 'application_edit.png', plugin: 'famfamfam' )}" alt="Edit template field properties" title="Edit template field properties">
+  <img class="disabled" src="${resource( dir: 'images/icons', file: 'delete.png', plugin: 'famfamfam' )}" alt="Deleting this field is not possible. Field is used in ${numUses} templates." title="Deleting this field is not possible. Field is used in ${numUses} templates.">
+  <img onClick="addTemplateField( ${templateField.id}, null, true );" src="${resource( dir: 'images/icons', file: 'add.png', plugin: 'famfamfam' )}" alt="Add field to template" title="Add field to template">
 </span>
 

trunk/grails-app/views/templateEditor/elements/_liFieldNotInUse.gsp

@@ -1 +1 @@
 <span class="listButtons">
-  <img onClick="showTemplateFieldForm( 'templateField_' + ${templateField.id}); this.blur(); return false;" src="${createLinkTo( dir: 'images/icons', file: 'application_edit.png', plugin: 'famfamfam' )}" alt="Edit template field properties" title="Edit template field properties">
-  <img onClick="if( confirm( 'Are you sure?' ) ) { deleteTemplateField( ${templateField.id} ); }" src="${createLinkTo( dir: 'images/icons', file: 'delete.png', plugin: 'famfamfam' )}" alt="Delete this template field" title="Delete this template field">
-  <img onClick="addTemplateField( ${templateField.id}, null, true );" src="${createLinkTo( dir: 'images/icons', file: 'add.png', plugin: 'famfamfam' )}" alt="Add field to template" title="Add field to template">
+  <img onClick="showTemplateFieldForm( 'templateField_' + ${templateField.id}); this.blur(); return false;" src="${resource( dir: 'images/icons', file: 'application_edit.png', plugin: 'famfamfam' )}" alt="Edit template field properties" title="Edit template field properties">
+  <img onClick="if( confirm( 'Are you sure?' ) ) { deleteTemplateField( ${templateField.id} ); }" src="${resource( dir: 'images/icons', file: 'delete.png', plugin: 'famfamfam' )}" alt="Delete this template field" title="Delete this template field">
+  <img onClick="addTemplateField( ${templateField.id}, null, true );" src="${resource( dir: 'images/icons', file: 'add.png', plugin: 'famfamfam' )}" alt="Add field to template" title="Add field to template">
 </span>
 

trunk/grails-app/views/templateEditor/elements/_liFieldSelected.gsp

@@ -1 +1 @@
 <span class="listButtons">
-  <img onClick="showTemplateFieldForm( 'templateField_' + ${templateField.id}); this.blur(); return false;" src="${createLinkTo( dir: 'images/icons', file: 'application_edit.png', plugin: 'famfamfam' )}" alt="Show template field properties" title="Show template field properties">
-
-  <g:if test="${template.inUse()}">
-        <img class="disabled" src="${createLinkTo( dir: 'images/icons', file: 'delete.png', plugin: 'famfamfam' )}" alt="This field can not be removed from the template, as the template is still in use." title="This field can not be removed from the template, as the template is still in use.">
+  <img onClick="showTemplateFieldForm( 'templateField_' + ${templateField.id}); this.blur(); return false;" src="${resource( dir: 'images/icons', file: 'application_edit.png', plugin: 'famfamfam' )}" alt="Show template field properties" title="Show template field properties">
+  <g:if test="${templateField.isFilledInTemplate(template)}">
+        <img class="disabled" src="${resource( dir: 'images/icons', file: 'delete.png', plugin: 'famfamfam' )}" alt="This field can not be removed from the template, as this field is already in use." title="This field can not be removed from the template, as this field is already in use.">
   </g:if>
   <g:else>
-        <img onClick="removeTemplateField( ${templateField.id} ); moveFieldListItem( ${templateField.id}, '#availableTemplateFields' );" src="${createLinkTo( dir: 'images/icons', file: 'delete.png', plugin: 'famfamfam' )}" alt="Remove this template field from the template" title="Remove this template field from the template">
+        <img onClick="removeTemplateField( ${templateField.id} ); moveFieldListItem( ${templateField.id}, '#availableTemplateFields' );" src="${resource( dir: 'images/icons', file: 'delete.png', plugin: 'famfamfam' )}" alt="Remove this template field from the template" title="Remove this template field from the template">
   </g:else>
 </span>
@@ -14 +13 @@
   (<g:if test="${templateField.unit}">${templateField.unit}, </g:if><g:render template="elements/${templateField.type.toString().toLowerCase().replaceAll(/ /,'_')}" model="[templateField: templateField]"/>)
 
-  <form class="templateField_form" id="templateField_${templateField.id}_form">
-          <g:render template="elements/disabledFieldForm" model="['templateField': templateField, 'ontologies': ontologies, 'fieldTypes': fieldTypes]"/>
-          <div class="templateFieldButtons">
-                  <input type="button" value="Close" onClick="hideTemplateFieldForm( ${templateField.id} );">
-          </div>
+  <form class="templateField_form" id="templateField_${templateField.id}_form" action="updateField">
+          <g:if test="${templateField.isEditable()}">
+                <g:hiddenField name="id" value="${templateField.id}" />
+                <g:hiddenField name="version" value="${templateField.version}" />
+                <g:hiddenField name="renderTemplate" value="selected" />
+                <g:hiddenField name="templateId" value="${template.id}" />
+                <g:render template="elements/fieldForm" model="['templateField': templateField, 'ontologies': ontologies, 'fieldTypes': fieldTypes]"/>
+                <div class="templateFieldButtons">
+                        <input type="button" value="Save" onClick="updateTemplateField( ${templateField.id} );">
+                        <input type="button" value="Close" onClick="hideTemplateFieldForm( ${templateField.id} );">
+                </div>
+          </g:if>
+        <g:else>
+                <g:render template="elements/disabledFieldForm" model="['templateField': templateField, 'ontologies': ontologies, 'fieldTypes': fieldTypes]"/>
+                <div class="templateFieldButtons">
+                        <input type="button" value="Close" onClick="hideTemplateFieldForm( ${templateField.id} );">
+                </div>
+        </g:else>
   </form>

trunk/grails-app/views/templateEditor/elements/_liTemplateEditable.gsp

@@ -1 +1 @@
 <span class="listButtons">
-  <img onClick="editTemplate( ${template.id} );" src="${createLinkTo( dir: 'images/icons', file: 'application_edit.png', plugin: 'famfamfam' )}" alt="Edit template properties" title="Edit template properties">
-  <img onClick="editFields( ${template.id} );"src="${createLinkTo( dir: 'images/icons', file: 'application_form.png', plugin: 'famfamfam' )}" alt="Add/remove template fields" title="Add/remove template fields">
-  <img onClick="cloneTemplate( ${template.id} );"src="${createLinkTo( dir: 'images/icons', file: 'page_copy.png', plugin: 'famfamfam' )}" alt="Clone this template" title="Clone this template">
-  <img onClick="if( confirm( 'Are you sure?' ) ) { deleteTemplate( ${template.id} ); }" src="${createLinkTo( dir: 'images/icons', file: 'delete.png', plugin: 'famfamfam' )}" alt="Delete this template" title="Delete this template">
+  <img onClick="editTemplate( ${template.id} );" src="${resource( dir: 'images/icons', file: 'application_edit.png', plugin: 'famfamfam' )}" alt="Edit template properties" title="Edit template properties">
+  <img onClick="editFields( ${template.id} );"src="${resource( dir: 'images/icons', file: 'application_form.png', plugin: 'famfamfam' )}" alt="Add/remove template fields" title="Add/remove template fields">
+  <img onClick="cloneTemplate( ${template.id} );"src="${resource( dir: 'images/icons', file: 'page_copy.png', plugin: 'famfamfam' )}" alt="Clone this template" title="Clone this template">
+  <img onClick="if( confirm( 'Are you sure?' ) ) { deleteTemplate( ${template.id} ); }" src="${resource( dir: 'images/icons', file: 'delete.png', plugin: 'famfamfam' )}" alt="Delete this template" title="Delete this template">
 </span>
 ${template.name}

trunk/grails-app/views/templateEditor/elements/_liTemplateNonEditable.gsp

@@ -1 +1 @@
 <g:set var="numUses" value="${template.numUses()}" />
 <span class="listButtons">
-  <img onClick="editTemplate( ${template.id} );" src="${createLinkTo( dir: 'images/icons', file: 'application_edit.png', plugin: 'famfamfam' )}" alt="Edit template properties" title="Edit template properties">
-  <img onClick="editFields( ${template.id} );"src="${createLinkTo( dir: 'images/icons', file: 'application_form.png', plugin: 'famfamfam' )}" alt="Add/remove template fields" title="Add/remove template fields">
-  <img onClick="cloneTemplate( ${template.id} );"src="${createLinkTo( dir: 'images/icons', file: 'page_copy.png', plugin: 'famfamfam' )}" alt="Clone this template" title="Clone this template">
-  <img class="disabled" src="${createLinkTo( dir: 'images/icons', file: 'delete.png', plugin: 'famfamfam' )}" alt="Deleting this template is not possible. Template is used in ${numUses} objects." title="Deleting this template is not possible. Template is used in ${numUses} objects.">
+  <img onClick="editTemplate( ${template.id} );" src="${resource( dir: 'images/icons', file: 'application_edit.png', plugin: 'famfamfam' )}" alt="Edit template properties" title="Edit template properties">
+  <img onClick="editFields( ${template.id} );"src="${resource( dir: 'images/icons', file: 'application_form.png', plugin: 'famfamfam' )}" alt="Add/remove template fields" title="Add/remove template fields">
+  <img onClick="cloneTemplate( ${template.id} );"src="${resource( dir: 'images/icons', file: 'page_copy.png', plugin: 'famfamfam' )}" alt="Clone this template" title="Clone this template">
+  <img class="disabled" src="${resource( dir: 'images/icons', file: 'delete.png', plugin: 'famfamfam' )}" alt="Deleting this template is not possible. Template is used in ${numUses} objects." title="Deleting this template is not possible. Template is used in ${numUses} objects.">
 </span>
 ${template.name}

trunk/grails-app/views/templateEditor/elements/_selected.gsp

@@ -1 +1 @@
 <li class="ui-state-default  <g:if test="${templateField.required}">required</g:if>" id="templateField_${templateField.id}">
-    <g:render template="elements/liFieldSelected" model="['templateField': templateField, 'template': template, 'fieldTypes': fieldTypes]"/>
+  <g:render template="elements/liFieldSelected" model="['templateField': templateField, 'template': template, 'ontologies': ontologies, 'fieldTypes': fieldTypes]"/>
 </li>

trunk/grails-app/views/templateEditor/index.gsp

@@ -19 +19 @@
                 <meta name="layout" content="${layout}"/>
                 <title>template editor</title>
-                <script src="${createLinkTo(dir: 'js', file: 'templateEditor.js')}" type="text/javascript"></script>
-                <link rel="stylesheet" href="${createLinkTo(dir: 'css', file: 'templateEditor.css')}" />
+                <script src="${resource(dir: 'js', file: 'templateEditor.js')}" type="text/javascript"></script>
+                <link rel="stylesheet" href="${resource(dir: 'css', file: 'templateEditor.css')}" />
                 <style type="text/css">
                   #content .templateEditorStep { font-size: 0.8em; }

trunk/grails-app/views/user/edit.gsp

@@ -24 +24 @@
                         </p>
           </div>
+        </g:if>
         <h3><g:message code="default.edit.label" args="[entityName]"/></h3>
 
@@ -56 +57 @@
                 <div>
                         <g:checkBox name="${entry.key.authority}" value="${entry.value}"/>
-                        <g:link controller='role' action='edit' id='${entry.key.id}'>${entry.key.authority.encodeAsHTML()}</g:link>
+                        ${entry.key.authority.encodeAsHTML()}
                 </div>
                 </g:each>