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

Last change on this file since 1511 was 1511, checked in by t.w.abma@…, 9 years ago
  • added initial property manager (load/save import mappings) just in case
  • Property svn:keywords set to Rev Author Date
File size: 18.5 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: 1511 $
17 * $Author: t.w.abma@umcutrecht.nl $
18 * $Date: 2011-02-09 19:55:29 +0000 (wo, 09 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                flow.importer_fuzzymatching="false"
109
110                                success()
111                        }
112
113            on("refresh") {
114                flash.importer_params = params           
115                                success()
116                        }.to "pageOne"
117
118                        on("next") {
119                                flash.wizardErrors = [:]
120                //flash.importer_params = params
121
122                                // Study selected?
123                                flow.importer_study = (params.study) ? Study.get(params.study.id.toInteger()) : null
124
125                                // Trying to import data into an existing study?
126                                if (flow.importer_study)
127                                        if (flow.importer_study.canWrite(authenticationService.getLoggedInUser())) 
128                                                fileImportPage(flow, flash, params) ? success() : error()                                       
129                                        else {
130                                                log.error ".importer wizard wrong permissions"
131                                                this.appendErrorMap(['error': "You don't have the right permissions"], flash.wizardErrors)
132                                                error()
133                                        }
134                                else {
135                                        fileImportPage(flow, flash, params) ? success() : error()
136                                }
137
138                                // put your bussiness logic (if applicable) in here
139                        }.to "pageTwo"
140                }
141
142                // Property to column assignment page
143                pageTwo {
144                        render(view: "_page_two")
145                        onRender {
146                                log.info ".import wizard properties page"
147                                // Grom a development message
148                                if (pluginManager.getGrailsPlugin('grom')) ".rendering the partial: pages/_page_two.gsp".grom()
149
150                                flow.page = 2
151                                success()
152                        }
153            on("refresh") {
154                if (params.savepropertymapping) println "saved properties"
155                flow.importer_fuzzymatching="true"
156                                success()
157                        }.to "pageTwo"
158
159                        on("next") {
160                                if (propertiesPage(flow, flash, params)) {
161                                        success()
162                                } else {
163                                        log.error ".import wizard, properties are set wrong"
164                                        error()
165                                }
166                        }.to "pageThree"
167                        on("previous").to "pageOne"
168                }
169
170                // Mapping page
171                pageThree {
172                        render(view: "_page_three")
173                        onRender {
174                                log.info ".import wizard mapping page"
175                                // Grom a development message
176                                if (pluginManager.getGrailsPlugin('grom')) ".rendering the partial pages/_page_three.gsp".grom()
177
178                                flow.page = 3
179                                success()
180                        }
181                        on("refresh") {
182                                success()
183                        }.to "pageThree"
184                        on("next") {
185                                if (mappingsPage(flow, flash, params)) {
186                                        flow.page = 4
187                                        success()
188                                } else {
189                                        log.error ".import wizard mapping error, could not validate all entities"
190                                        error()
191                                }
192                        }.to "save"
193                        on("previous").to "pageTwo"
194                }
195
196                // Imported data overview page
197                pageFour {
198                        render(view: "_page_four")
199                        onRender {
200                                // Grom a development message
201                                if (pluginManager.getGrailsPlugin('grom')) ".rendering the partial pages/_page_four.gsp".grom()
202
203                                flow.page = 4
204                                success()
205                        }
206                        on("next") {
207                                if (importedPage(flow, params)) {
208                                        flow.page = 4
209                                        success()
210                                } else {
211                                        log.error ".import wizard imported error, something went wrong showing the imported entities"
212                                        error()
213                                }
214                        }.to "save"
215                        on("previous").to "pageThree"
216                }
217
218                // Save the imported data
219                save {
220                        action {
221                                // here you can validate and save the
222                                // instances you have created in the
223                                // ajax flow.
224                                // Grom a development message
225                                if (pluginManager.getGrailsPlugin('grom')) ".persisting instances to the database...".grom()
226
227                                if (saveEntities(flow, params)) {
228                                        //if (ImporterService.saveDatamatrix(flow.importer_study, flow.importer_importeddata)) {
229                                        //log.error ".import wizard succesfully persisted all entities"
230                                        //def session = sessionFactory.getCurrentSession()
231                                        //session.clear()
232                                        success()
233                                } else {
234                                        log.error ".import wizard, could not save entities:\n" + e.dump()
235                                        flow.page = 4
236                                        error()
237                                }
238                        }
239                        on("error").to "error"
240                        on(Exception).to "error"
241                        on("success").to "finalPage"
242                }
243
244                // render errors
245                error {
246                        render(view: "_error")
247                        onRender {
248                                // Grom a development message
249                                if (pluginManager.getGrailsPlugin('grom')) ".rendering the partial pages/_error.gsp".grom()
250
251                                // set page to 4 so that the navigation
252                                // works (it is disabled on the final page)
253                                flow.page = 4
254                        }
255                        on("next").to "save"
256                        on("previous").to "pageFour"
257                }
258
259                // last wizard page
260                finalPage {
261                        render(view: "_final_page")
262                        onRender {
263                                // Grom a development message
264                                if (pluginManager.getGrailsPlugin('grom')) ".rendering the partial pages/_final_page.gsp".grom()
265                                success()
266                        }
267                        onEnd {
268                                // clean flow scope
269                                flow.clear()
270                        }
271                }
272        }
273
274    def propertiesManager = {
275        render (view:"common/_propertiesManager")
276    }
277
278        /**
279         * Return templates which belong to a certain entity type
280         *
281         * @param entity entity name string (Sample, Subject, Study et cetera)
282         * @return JSON object containing the found templates
283         */
284        def ajaxGetTemplatesByEntity = {
285                // fetch all templates for a specific entity
286                def templates = Template.findAllByEntity(GdtService.getInstanceByEntity(params.entity.decodeURL()))
287
288
289                // render as JSON
290                render templates as JSON
291        }
292
293        /**
294         * Handle the file import page.
295         *
296         * @param Map LocalAttributeMap (the flow scope)
297         * @param Map GrailsParameterMap (the flow parameters = form data)
298         * @returns boolean true if correctly validated, otherwise false
299         */
300        boolean fileImportPage(flow, flash, params) {
301                def importedfile = fileService.get(params['importfile'])
302                //fileService.delete(YourFile)
303
304        if (importedfile.exists()) {
305            try {
306                session.importer_workbook = ImporterService.getWorkbook(new FileInputStream(importedfile))
307            } catch (Exception e) {
308                log.error ".importer wizard could not load file: " + e
309                this.appendErrorMap(['error': "Wrong file (format), the importer requires an Excel file as input"], flash.wizardErrors)
310                return false
311            }
312        }
313
314                if (params.entity && params.template_id) {           
315                       
316            try {
317                session.importer_workbook = ImporterService.getWorkbook(new FileInputStream(importedfile))
318            } catch (Exception e) {
319                log.error ".importer wizard could not load file: " + e
320                this.appendErrorMap(['error': "Excel file required as input"], flash.wizardErrors)
321                return false
322            }
323
324                        def selectedentities = []
325
326                        def entityName = GdtService.decryptEntity(params.entity.decodeURL())
327                        def entityClass = GdtService.getInstanceByEntityName(entityName)
328
329                        // Initialize some session variables
330                        //flow.importer_workbook = wb // workbook object must be serialized for this to work
331
332                        flow.importer_template_id = params.template_id
333                        flow.importer_sheetindex = params.sheetindex.toInteger() - 1 // 0 == first sheet
334                        flow.importer_datamatrix_start = params.datamatrix_start.toInteger() - 1 // 0 == first row
335                        flow.importer_headerrow = params.headerrow.toInteger()
336
337                        // Get the header from the Excel file using the arguments given in the first step of the wizard
338                        flow.importer_header = ImporterService.getHeader(session.importer_workbook,
339                                flow.importer_sheetindex,
340                                flow.importer_headerrow,
341                                flow.importer_datamatrix_start,
342                                entityClass)
343
344                        // Initialize 'selected entities', used to show entities above the columns
345                        flow.importer_header.each {
346                                selectedentities.add([name: entityName, columnindex: it.key.toInteger()])
347                        }
348
349                        flow.importer_selectedentities = selectedentities
350
351                        session.importer_datamatrix = ImporterService.getDatamatrix(
352                                session.importer_workbook, flow.importer_header,
353                                flow.importer_sheetindex,
354                                flow.importer_datamatrix_start,
355                                5)
356
357                        flow.importer_templates = Template.get(flow.importer_template_id)
358                        flow.importer_allfieldtypes = "true"
359
360                        return true
361                }
362
363        log.error ".importer wizard not all fields are filled in"
364        this.appendErrorMap(['error': "Not all fields are filled in, please fill in or select all fields"], flash.wizardErrors)
365        return false
366        }
367
368        /**
369         * Handle the property mapping page.
370         *
371         * @param Map LocalAttributeMap (the flow scope)
372         * @param Map GrailsParameterMap (the flow parameters = form data)
373         * @returns boolean true if correctly validated, otherwise false
374         */
375        boolean propertiesPage(flow, flash, params) {
376        flash.wizardErrors = [:]
377       
378                // Find actual Template object from the chosen template name
379                def template = Template.get(flow.importer_template_id)
380
381                params.columnproperty.index.each { columnindex, property ->
382                        // Create an actual class instance of the selected entity with the selected template
383                        // This should be inside the closure because in some cases in the advanced importer, the fields can have different target entities
384                        def entityClass = Class.forName(flow.importer_header[columnindex.toInteger()].entity.getName(), true, this.getClass().getClassLoader())
385                        def entityObj = entityClass.newInstance(template: template)
386
387                        // Store the selected property for this column into the column map for the ImporterService
388                        flow.importer_header[columnindex.toInteger()].property = property
389
390                        // Look up the template field type of the target TemplateField and store it also in the map
391                        flow.importer_header[columnindex.toInteger()].templatefieldtype = entityObj.giveFieldType(property)
392
393                        // Is a "Don't import" property assigned to the column?
394                        flow.importer_header[columnindex.toInteger()].dontimport = (property == "dontimport") ? true : false
395
396                        //if it's an identifier set the mapping column true or false
397                        entityObj.giveFields().each {
398                                (it.preferredIdentifier && (it.name == property)) ? flow.importer_header[columnindex.toInteger()].identifier = true : false
399                        }
400                }
401
402                // Import the workbook and store the table with entity records and store the failed cells
403                def (table, failedcells) = ImporterService.importData(flow.importer_template_id,
404                        session.importer_workbook,
405                        flow.importer_sheetindex,
406                        flow.importer_datamatrix_start,
407                        flow.importer_header)
408
409                flow.importer_importeddata = table
410
411        // loop through all entities to validate them and add them to wizardErrors flash when invalid
412        table.each { record ->
413            record.each { entity ->
414                if (!entity.validate()) {
415                                this.appendErrors(entity, flash.wizardErrors, 'entity_' + entity.getIdentifier() + '_')
416                }
417            }
418        }
419
420        flow.importer_failedcells = failedcells
421
422                return true
423        }
424
425        /**
426         * Handle the mapping page.
427         *
428         * @param Map LocalAttributeMap (the flow scope)
429         * @param Map GrailsParameterMap (the flow parameters = form data)
430         * @returns boolean true if correctly validated, otherwise false
431         */
432        boolean mappingsPage(flow, flash, params) {
433                flash.wizardErrors = [:]
434                flow.importer_invalidentities = 0
435
436                flow.importer_importeddata.each { table ->
437                        table.each { entity ->
438                                def invalidfields = 0
439
440                                // Set the fields for this entity by retrieving values from the params
441                                entity.giveFields().each { field ->
442                                        // field of type ontology and value "#invalidterm"?
443                                        if (field.type == org.dbnp.gdt.TemplateFieldType.ONTOLOGYTERM &&
444                                                params["entity_" + entity.getIdentifier() + "_" + field.escapedName()] == "#invalidterm"
445                                        ) {
446                                                invalidfields++
447                                        } else
448                                        if (field.type == org.dbnp.gdt.TemplateFieldType.ONTOLOGYTERM &&
449                                                params["entity_" + entity.getIdentifier() + "_" + field.escapedName()] != "#invalidterm") {
450                                                if (entity) removeFailedCell(flow.importer_failedcells, entity, field)                       
451                                                entity.setFieldValue(field.toString(), params["entity_" + entity.getIdentifier() + "_" + field.escapedName()])
452                                        }
453                                        else
454
455                    if (field.type == org.dbnp.gdt.TemplateFieldType.STRINGLIST &&
456                                                params["entity_" + entity.getIdentifier() + "_" + field.escapedName()] != "#invalidterm") {
457                                                if (entity) removeFailedCell(flow.importer_failedcells, entity, field)                       
458                                                entity.setFieldValue(field.toString(), params["entity_" + entity.getIdentifier() + "_" + field.escapedName()])
459                    } else
460                    if (field.type == org.dbnp.gdt.TemplateFieldType.STRINGLIST &&
461                                                params["entity_" + entity.getIdentifier() + "_" + field.escapedName()] == "#invalidterm"
462                                        ) {
463                                                invalidfields++
464                                        } else
465
466                                                entity.setFieldValue(field.toString(), params["entity_" + entity.getIdentifier() + "_" + field.escapedName()])
467                                }
468
469                                // Determine entity class and add a parent (defined as Study in first step of wizard)
470                                switch (entity.getClass()) {
471                                        case [Subject, Sample, Event]: entity.parent = flow.importer_study
472                                }
473
474                                // Try to validate the entity now all fields have been set
475                                if (!entity.validate() || invalidfields) {
476                                        flow.importer_invalidentities++
477
478                                        // add errors to map
479                                        this.appendErrors(entity, flash.wizardErrors, "entity_" + entity.getIdentifier() + "_")
480
481                                        entity.errors.getAllErrors().each() {
482                                                log.error ".import wizard imported validation error:" + it
483                                        }
484                                } else {
485                                        //removeFailedCell(flow.importer_failedcells, entity)
486                                } // end else if
487
488                        } // end of record
489                } // end of table
490
491                return (flow.importer_invalidentities == 0) ? true : false
492        } // end of method
493
494        /**
495         * @param failedcell failed ontology cells
496         * @param entity entity to remove from the failedcells list
497         */
498        def removeFailedCell(failedcells, entity, field) {
499                // Valid entity, remove it from failedcells
500        def entityidfield = "entity_" + entity.getIdentifier() + "_" + field.name.toLowerCase()
501
502                failedcells.each { record ->
503                        def tempimportcells = []
504
505
506                        record.importcells.each { cell ->               
507                                // remove the cell from the failed cells session
508                                if (cell.entityidentifier != entityidfield) {
509                                        //record.removeFromImportcells(cell)
510                                        tempimportcells.add(cell)
511                                }
512                        }
513
514                        record.importcells = tempimportcells
515                        // } // end of importcells
516                } // end of failedcells
517        }
518
519        /**
520         * Handle the imported entities page.
521         *
522         * @param Map LocalAttributeMap (the flow scope)
523         * @param Map GrailsParameterMap (the flow parameters = form data)
524         * @returns boolean true if correctly validated, otherwise false
525         */
526        boolean importedPage(flow, params) {
527                return true
528        }
529
530        boolean saveEntities(flow, params) {
531                //def (validatedSuccesfully, updatedEntities, failedToPersist) =
532                //try {
533                ImporterService.saveDatamatrix(flow.importer_study, flow.importer_importeddata, authenticationService, log)
534
535                //}
536                //catch (Exception e) {
537//                log.error ".import wizard saveEntities error\n" + e.dump()
538//            }
539
540                //flow.importer_validatedsuccesfully = validatedSuccesfully
541                //flow.importer_failedtopersist = failedToPersist
542                //flow.imported_updatedentities = updatedEntities
543                //flow.importer_totalrows = flow.importer_importeddata.size
544                //flow.importer_referer = ""
545
546                return true
547        }
548
549        /**
550         * append errors of a particular object to a map
551         * @param object
552         * @param map linkedHashMap
553         * @void
554         */
555        def appendErrors(object, map) {
556                this.appendErrorMap(getHumanReadableErrors(object), map)
557        }
558
559        def appendErrors(object, map, prepend) {
560                this.appendErrorMap(getHumanReadableErrors(object), map, prepend)
561        }
562
563        /**
564         * append errors of one map to another map
565         * @param map linkedHashMap
566         * @param map linkedHashMap
567         * @void
568         */
569        def appendErrorMap(map, mapToExtend) {
570                map.each() {key, value ->
571                        mapToExtend[key] = ['key': key, 'value': value, 'dynamic': false]
572                }
573        }
574
575        def appendErrorMap(map, mapToExtend, prepend) {
576                map.each() {key, value ->
577                        mapToExtend[prepend + key] = ['key': key, 'value': value, 'dynamic': true]
578                }
579        }
580
581        /**
582         * transform domain class validation errors into a human readable
583         * linked hash map
584         * @param object validated domain class
585         * @return object  linkedHashMap
586         */
587        def getHumanReadableErrors(object) {
588                def errors = [:]
589                object.errors.getAllErrors().each() { error ->
590                        // error.codes.each() { code -> println code }           
591
592                        // generally speaking g.message(...) should work,
593                        // however it fails in some steps of the wizard
594                        // (add event, add assay, etc) so g is not always
595                        // availably. Using our own instance of the
596                        // validationTagLib instead so it is always
597                        // available to us
598                        errors[error.getArguments()[0]] = validationTagLib.message(error: error)
599                }
600
601                return errors
602        }
603}
Note: See TracBrowser for help on using the repository browser.