source: trunk/grails-app/controllers/dbnp/importer/ImporterController.groovy @ 1472

Last change on this file since 1472 was 1472, checked in by t.w.abma@…, 9 years ago
  • after assigning properties, entities are read from Excel and invalid entities are added to wizardErrors variable to be used by the "imported data" step
  • Property svn:keywords set to Rev Author Date
File size: 17.0 KB
Line 
1package dbnp.importer
2
3import dbnp.studycapturing.*
4import org.dbnp.gdt.*
5import grails.converters.JSON
6import org.codehaus.groovy.grails.plugins.web.taglib.ValidationTagLib
7import grails.plugins.springsecurity.Secured
8
9/**
10 * Wizard Controller
11 *
12 * @author Jeroen Wesbeek
13 * @since 20101206
14 *
15 * Revision information:
16 * $Rev: 1472 $
17 * $Author: t.w.abma@umcutrecht.nl $
18 * $Date: 2011-02-02 09:59:54 +0000 (wo, 02 feb 2011) $
19 */
20@Secured(['IS_AUTHENTICATED_REMEMBERED'])
21class ImporterController {
22        // the pluginManager is used to check if the Grom
23        // plugin is available so we can 'Grom' development
24        // notifications to the unified notifications daemon
25        // (see http://www.grails.org/plugin/grom)
26        def pluginManager
27        def authenticationService
28        def fileService
29        def ImporterService
30        def validationTagLib = new ValidationTagLib()
31        def GdtService
32
33        /**
34         * index method, redirect to the webflow
35         * @void
36         */
37        def index = {
38                // Grom a development message
39                if (pluginManager.getGrailsPlugin('grom')) "redirecting into the webflow".grom()
40
41                /**
42                 * Do you believe it in your head?
43                 * I can go with the flow
44                 * Don't say it doesn't matter (with the flow) matter anymore
45                 * I can go with the flow (I can go)
46                 * Do you believe it in your head?
47                 */
48                redirect(action: 'pages')
49        }
50
51        /**
52         * WebFlow definition
53         * @void
54         */
55        def pagesFlow = {
56                // start the flow
57                onStart {
58                        // Grom a development message
59                        if (pluginManager.getGrailsPlugin('grom')) "entering the WebFlow".grom()
60
61                        // define variables in the flow scope which is availabe
62                        // throughout the complete webflow also have a look at
63                        // the Flow Scopes section on http://www.grails.org/WebFlow
64                        //
65                        // The following flow scope variables are used to generate
66                        // wizard tabs. Also see common/_tabs.gsp for more information
67                        flow.page = 0
68                        flow.pages = [
69                                [title: 'Import file'],
70                                [title: 'Assign properties'],
71                                [title: 'Check imported data'],
72                                //[title: 'Imported'],
73                                [title: 'Done']
74                        ]
75                        flow.cancel = true;
76                        flow.quickSave = true;
77
78                        success()
79                }
80
81                // render the main wizard page which immediately
82                // triggers the 'next' action (hence, the main
83                // page dynamically renders the study template
84                // and makes the flow jump to the study logic)
85                mainPage {
86                        render(view: "/importer/index")
87                        onRender {
88                                // Grom a development message
89                                if (pluginManager.getGrailsPlugin('grom')) "rendering the main Ajaxflow page (index.gsp)".grom()
90
91                                // let the view know we're in page 1
92                                flow.page = 1
93                                success()
94                        }
95                        on("next").to "pageOne"
96                }
97
98                // File import and entitie template selection page
99                pageOne {
100                        render(view: "_page_one")
101                        onRender {
102                                log.info ".entering import wizard"
103                                // Grom a development message
104                                if (pluginManager.getGrailsPlugin('grom')) ".rendering the partial: pages/_page_one.gsp".grom()
105
106                                flow.page = 1
107                                flow.studies = Study.findAllWhere(owner: authenticationService.getLoggedInUser())
108
109                                success()
110                        }
111
112            on("refresh") {
113                flash.importer_params = params
114                                success()
115                        }.to "pageOne"
116
117                        on("next") {
118                                flash.wizardErrors = [:]
119
120                                // Study selected?
121                                flow.importer_study = (params.study) ? Study.get(params.study.id.toInteger()) : null
122
123                                // Trying to import data into an existing study?
124                                if (flow.importer_study)
125                                        if (flow.importer_study.canWrite(authenticationService.getLoggedInUser())) {
126                                                if (fileImportPage(flow, params)) {
127                                                        success()
128                                                } else {
129                                                        log.error ".importer wizard not all fields are filled in"
130                                                        this.appendErrorMap(['error': "Not all fields are filled in, please fill in or select all fields"], flash.wizardErrors)
131                                                        error()
132                                                }
133                                        } else {
134                                                log.error ".importer wizard wrong permissions"
135                                                this.appendErrorMap(['error': "You don't have the right permissions"], flash.wizardErrors)
136
137                                                error()
138                                        }
139                                else {
140                                        if (fileImportPage(flow, params)) {
141                                                success()
142                                        } else {
143                                                log.error ".importer wizard not all fields are filled in"
144                                                this.appendErrorMap(['error': "Not all fields are filled in, please fill in or select all fields"], flash.wizardErrors)
145                                                error()
146                                        }
147                                }
148
149                                // put your bussiness logic (if applicable) in here
150                        }.to "pageTwo"
151                }
152
153                // Property to column assignment page
154                pageTwo {
155                        render(view: "_page_two")
156                        onRender {
157                                log.info ".import wizard properties page"
158                                // Grom a development message
159                                if (pluginManager.getGrailsPlugin('grom')) ".rendering the partial: pages/_page_two.gsp".grom()
160
161                                flow.page = 2
162                                success()
163                        }
164                        on("next") {
165                                if (propertiesPage(flow, flash, params)) {
166                                        success()
167                                } else {
168                                        log.error ".import wizard, properties are set wrong"
169                                        error()
170                                }
171                        }.to "pageThree"
172                        on("previous").to "pageOne"
173                }
174
175                // Mapping page
176                pageThree {
177                        render(view: "_page_three")
178                        onRender {
179                                log.info ".import wizard mapping page"
180                                // Grom a development message
181                                if (pluginManager.getGrailsPlugin('grom')) ".rendering the partial pages/_page_three.gsp".grom()
182
183                                flow.page = 3
184                                success()
185                        }
186                        on("refresh") {
187                                success()
188                        }.to "pageThree"
189                        on("next") {
190                                if (mappingsPage(flow, flash, params)) {
191                                        flow.page = 4
192                                        success()
193                                } else {
194                                        log.error ".import wizard mapping error, could not validate all entities"
195                                        error()
196                                }
197                        }.to "save"
198                        on("previous").to "pageTwo"
199                }
200
201                // Imported data overview page
202                pageFour {
203                        render(view: "_page_four")
204                        onRender {
205                                // Grom a development message
206                                if (pluginManager.getGrailsPlugin('grom')) ".rendering the partial pages/_page_four.gsp".grom()
207
208                                flow.page = 4
209                                success()
210                        }
211                        on("next") {
212                                if (importedPage(flow, params)) {
213                                        flow.page = 4
214                                        success()
215                                } else {
216                                        log.error ".import wizard imported error, something went wrong showing the imported entities"
217                                        error()
218                                }
219                        }.to "save"
220                        on("previous").to "pageThree"
221                }
222
223                // Save the imported data
224                save {
225                        action {
226                                // here you can validate and save the
227                                // instances you have created in the
228                                // ajax flow.
229                                // Grom a development message
230                                if (pluginManager.getGrailsPlugin('grom')) ".persisting instances to the database...".grom()
231
232                                if (saveEntities(flow, params)) {
233                                        //if (ImporterService.saveDatamatrix(flow.importer_study, flow.importer_importeddata)) {
234                                        //log.error ".import wizard succesfully persisted all entities"
235                                        //def session = sessionFactory.getCurrentSession()
236                                        //session.clear()
237                                        success()
238                                } else {
239                                        log.error ".import wizard, could not save entities:\n" + e.dump()
240                                        flow.page = 4
241                                        error()
242                                }
243                        }
244                        on("error").to "error"
245                        on(Exception).to "error"
246                        on("success").to "finalPage"
247                }
248
249                // render errors
250                error {
251                        render(view: "_error")
252                        onRender {
253
254                                // Grom a development message
255                                if (pluginManager.getGrailsPlugin('grom')) ".rendering the partial pages/_error.gsp".grom()
256
257                                // set page to 4 so that the navigation
258                                // works (it is disabled on the final page)
259                                flow.page = 4
260                        }
261                        on("next").to "save"
262                        on("previous").to "pageFour"
263                }
264
265                // last wizard page
266                finalPage {
267                        render(view: "_final_page")
268                        onRender {
269                                println "EEN"
270                                // Grom a development message
271                                if (pluginManager.getGrailsPlugin('grom')) ".rendering the partial pages/_final_page.gsp".grom()
272                                println "TWEE"
273
274                                success()
275                                println "DRIE"
276                        }
277                        onEnd {
278                                // clean flow scope
279                                flow.clear()
280                        }
281                }
282        }
283
284        /**
285         * Return templates which belong to a certain entity type
286         *
287         * @param entity entity name string (Sample, Subject, Study et cetera)
288         * @return JSON object containing the found templates
289         */
290        def ajaxGetTemplatesByEntity = {
291                // fetch all templates for a specific entity
292                def templates = Template.findAllByEntity(GdtService.getInstanceByEntity(params.entity.decodeURL()))
293
294
295                // render as JSON
296                render templates as JSON
297        }
298
299        /**
300         * Handle the file import page.
301         *
302         * @param Map LocalAttributeMap (the flow scope)
303         * @param Map GrailsParameterMap (the flow parameters = form data)
304         * @returns boolean true if correctly validated, otherwise false
305         */
306        boolean fileImportPage(flow, params) {
307                def importedfile = fileService.get(params['importfile'])
308                //fileService.delete(YourFile)
309
310                if (params.entity && params.template_id && importedfile.exists()) {
311                        // create a workbook instance of the file
312                        session.importer_workbook = ImporterService.getWorkbook(new FileInputStream(importedfile))
313
314                        def selectedentities = []
315
316                        def entityName = GdtService.decryptEntity(params.entity.decodeURL())
317                        def entityClass = GdtService.getInstanceByEntityName(entityName)
318
319                        // Initialize some session variables
320                        //flow.importer_workbook = wb // workbook object must be serialized for this to work
321
322                        flow.importer_template_id = params.template_id
323                        flow.importer_sheetindex = params.sheetindex.toInteger() - 1 // 0 == first sheet
324                        flow.importer_datamatrix_start = params.datamatrix_start.toInteger() - 1 // 0 == first row
325                        flow.importer_headerrow = params.headerrow.toInteger()
326
327                        // Get the header from the Excel file using the arguments given in the first step of the wizard
328                        flow.importer_header = ImporterService.getHeader(session.importer_workbook,
329                                flow.importer_sheetindex,
330                                flow.importer_headerrow,
331                                flow.importer_datamatrix_start,
332                                entityClass)
333
334                        // Initialize 'selected entities', used to show entities above the columns
335                        flow.importer_header.each {
336                                selectedentities.add([name: entityName, columnindex: it.key.toInteger()])
337                        }
338
339                        flow.importer_selectedentities = selectedentities
340
341                        session.importer_datamatrix = ImporterService.getDatamatrix(
342                                session.importer_workbook, flow.importer_header,
343                                flow.importer_sheetindex,
344                                flow.importer_datamatrix_start,
345                                5)
346
347                        flow.importer_templates = Template.get(flow.importer_template_id)
348                        flow.importer_allfieldtypes = "true"
349
350                        return true
351                }
352        }
353
354        /**
355         * Handle the property mapping page.
356         *
357         * @param Map LocalAttributeMap (the flow scope)
358         * @param Map GrailsParameterMap (the flow parameters = form data)
359         * @returns boolean true if correctly validated, otherwise false
360         */
361        boolean propertiesPage(flow, flash, params) {
362        flash.wizardErrors = [:]
363       
364                // Find actual Template object from the chosen template name
365                def template = Template.get(flow.importer_template_id)
366
367                params.columnproperty.index.each { columnindex, property ->
368                        // Create an actual class instance of the selected entity with the selected template
369                        // This should be inside the closure because in some cases in the advanced importer, the fields can have different target entities
370                        def entityClass = Class.forName(flow.importer_header[columnindex.toInteger()].entity.getName(), true, this.getClass().getClassLoader())
371                        def entityObj = entityClass.newInstance(template: template)
372
373                        // Store the selected property for this column into the column map for the ImporterService
374                        flow.importer_header[columnindex.toInteger()].property = property
375
376                        // Look up the template field type of the target TemplateField and store it also in the map
377                        flow.importer_header[columnindex.toInteger()].templatefieldtype = entityObj.giveFieldType(property)
378
379                        // Is a "Don't import" property assigned to the column?
380                        flow.importer_header[columnindex.toInteger()].dontimport = (property == "dontimport") ? true : false
381
382                        //if it's an identifier set the mapping column true or false
383                        entityObj.giveFields().each {
384                                (it.preferredIdentifier && (it.name == property)) ? flow.importer_header[columnindex.toInteger()].identifier = true : false
385                        }
386                }
387
388                // Import the workbook and store the table with entity records and store the failed cells
389                def (table, failedcells) = ImporterService.importData(flow.importer_template_id,
390                        session.importer_workbook,
391                        flow.importer_sheetindex,
392                        flow.importer_datamatrix_start,
393                        flow.importer_header)
394
395                flow.importer_importeddata = table
396
397        // loop through all entities to validate them and add them to wizardErrors flash when invalid
398        table.each { record ->
399            record.each { entity ->
400                if (!entity.validate()) {
401                                this.appendErrors(entity, flash.wizardErrors, 'entity_' + entity.getIdentifier() + '_')
402                }
403            }
404        }
405
406        flow.importer_failedcells = failedcells
407
408                return true
409        }
410
411        /**
412         * Handle the mapping page.
413         *
414         * @param Map LocalAttributeMap (the flow scope)
415         * @param Map GrailsParameterMap (the flow parameters = form data)
416         * @returns boolean true if correctly validated, otherwise false
417         */
418        boolean mappingsPage(flow, flash, params) {
419                flash.wizardErrors = [:]
420                flow.importer_invalidentities = 0
421
422                flow.importer_importeddata.each { table ->
423                        table.each { entity ->
424                                def invalidontologies = 0
425
426                                // Set the fields for this entity by retrieving values from the params
427                                entity.giveFields().each { field ->
428                                        // field of type ontology and value "#invalidterm"?
429                                        if (field.type == org.dbnp.gdt.TemplateFieldType.ONTOLOGYTERM &&
430                                                params["entity_" + entity.getIdentifier() + "_" + field.escapedName()] == "#invalidterm"
431                                        ) {
432                                                invalidontologies++
433                                        } else
434                                        if (field.type == org.dbnp.gdt.TemplateFieldType.ONTOLOGYTERM &&
435                                                params["entity_" + entity.getIdentifier() + "_" + field.escapedName()] != "#invalidterm") {
436                                                removeFailedCell(flow.importer_failedcells, entity)
437                                                entity.setFieldValue(field.toString(), params["entity_" + entity.getIdentifier() + "_" + field.escapedName()])
438                                        }
439                                        else
440                                                entity.setFieldValue(field.toString(), params["entity_" + entity.getIdentifier() + "_" + field.escapedName()])
441                                }
442
443                                // Determine entity class and add a parent (defined as Study in first step of wizard)
444                                switch (entity.getClass()) {
445                                        case [Subject, Sample, Event]: entity.parent = flow.importer_study
446                                }
447
448                                // Try to validate the entity now all fields have been set
449                                if (!entity.validate() || invalidontologies) {
450                                        flow.importer_invalidentities++
451
452                                        // add errors to map
453                                        this.appendErrors(entity, flash.wizardErrors, "entity_" + entity.getIdentifier() + "_")
454
455                                        entity.errors.getAllErrors().each() {
456                                                log.error ".import wizard imported validation error:" + it
457                                        }
458                                } else {
459                                        removeFailedCell(flow.importer_failedcells, entity)
460                                } // end else if
461
462                        } // end of record
463                } // end of table
464
465                return (flow.importer_invalidentities == 0) ? true : false
466        } // end of method
467
468        /**
469         * @param failedcell failed ontology cells
470         * @param entity entity to remove from the failedcells list
471         */
472        def removeFailedCell(failedcells, entity) {
473                // Valid entity, remove it from failedcells
474                failedcells.each { record ->
475                        def tempimportcells = []
476
477                        record.importcells.each { cell ->
478                                // remove the cell from the failed cells session
479                                if (cell.entityidentifier != entity.getIdentifier()) {
480                                        //record.removeFromImportcells(cell)
481                                        tempimportcells.add(cell)
482                                }
483                        }
484
485                        record.importcells = tempimportcells
486                        // } // end of importcells
487                } // end of failedcells
488        }
489
490        /**
491         * Handle the imported entities page.
492         *
493         * @param Map LocalAttributeMap (the flow scope)
494         * @param Map GrailsParameterMap (the flow parameters = form data)
495         * @returns boolean true if correctly validated, otherwise false
496         */
497        boolean importedPage(flow, params) {
498                return true
499        }
500
501        boolean saveEntities(flow, params) {
502                //def (validatedSuccesfully, updatedEntities, failedToPersist) =
503                //try {
504                ImporterService.saveDatamatrix(flow.importer_study, flow.importer_importeddata, authenticationService, log)
505
506                //}
507                //catch (Exception e) {
508//                log.error ".import wizard saveEntities error\n" + e.dump()
509//            }
510
511                //flow.importer_validatedsuccesfully = validatedSuccesfully
512                //flow.importer_failedtopersist = failedToPersist
513                //flow.imported_updatedentities = updatedEntities
514                //flow.importer_totalrows = flow.importer_importeddata.size
515                //flow.importer_referer = ""
516
517                return true
518        }
519
520        /**
521         * append errors of a particular object to a map
522         * @param object
523         * @param map linkedHashMap
524         * @void
525         */
526        def appendErrors(object, map) {
527                this.appendErrorMap(getHumanReadableErrors(object), map)
528        }
529
530        def appendErrors(object, map, prepend) {
531                this.appendErrorMap(getHumanReadableErrors(object), map, prepend)
532        }
533
534        /**
535         * append errors of one map to another map
536         * @param map linkedHashMap
537         * @param map linkedHashMap
538         * @void
539         */
540        def appendErrorMap(map, mapToExtend) {
541                map.each() {key, value ->
542                        mapToExtend[key] = ['key': key, 'value': value, 'dynamic': false]
543                }
544        }
545
546        def appendErrorMap(map, mapToExtend, prepend) {
547                map.each() {key, value ->
548                        mapToExtend[prepend + key] = ['key': key, 'value': value, 'dynamic': true]
549                }
550        }
551
552        /**
553         * transform domain class validation errors into a human readable
554         * linked hash map
555         * @param object validated domain class
556         * @return object  linkedHashMap
557         */
558        def getHumanReadableErrors(object) {
559                def errors = [:]
560                object.errors.getAllErrors().each() { error ->
561                        // error.codes.each() { code -> println code }           
562
563                        // generally speaking g.message(...) should work,
564                        // however it fails in some steps of the wizard
565                        // (add event, add assay, etc) so g is not always
566                        // availably. Using our own instance of the
567                        // validationTagLib instead so it is always
568                        // available to us
569                        errors[error.getArguments()[0]] = validationTagLib.message(error: error)
570                }
571
572                return errors
573        }
574}
Note: See TracBrowser for help on using the repository browser.