EnversGrailsPlugin.groovy

/*
 * Copyright 2011 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import net.lucasward.grails.plugin.EnversPluginSupport
import net.lucasward.grails.plugin.RevisionsOfEntityQueryMethod
import org.codehaus.groovy.grails.commons.GrailsApplication
import org.codehaus.groovy.grails.commons.GrailsDomainClass
import org.codehaus.groovy.grails.orm.hibernate.HibernateEventListeners
import org.hibernate.SessionFactory
import org.hibernate.envers.event.AuditEventListener

class EnversGrailsPlugin {
    // the plugin version
    def version = "1.0-SNAPSHOT"
    // the version or versions of Grails the plugin is designed for
    def grailsVersion = "2.0.0 > *"
    // the other plugins this plugin depends on
    def observe = ['hibernate']
    def loadAfter = ['hibernate']
    // resources that are excluded from plugin packaging
    def pluginExcludes = [
            "grails-app/views/error.gsp",
            "grails-app/domain/net/lucasward/grails/plugin/User.groovy",
            "grails-app/domain/net/lucasward/grails/plugin/Customer.groovy",
            "grails-app/domain/net/lucasward/grails/plugin/Address.groovy",
            "grails-app/domain/net/lucasward/grails/plugin/OrderEntry.groovy",
            "grails-app/domain/net/lucasward/grails/plugin/State.groovy",
            "grails-app/domain/net/lucasward/grails/plugin/inheritance/AbstractPlayer.groovy",
            "grails-app/domain/net/lucasward/grails/plugin/inheritance/AmateurPlayer.groovy",
            "grails-app/domain/net/lucasward/grails/plugin/inheritance/ProfessionalPlayer.groovy",
            "grails-app/domain/net/lucasward/grails/plugin/inheritance/BaseballPlayer.groovy",
            "grails-app/domain/net/lucasward/grails/plugin/inheritance/FootballPlayer.groovy",
            "grails-app/domain/net/lucasward/grails/plugin/inheritance/entry/AbstractPerformanceYear.groovy",
            "grails-app/domain/net/lucasward/grails/plugin/inheritance/entry/AmateurPerformanceYear.groovy",
            "grails-app/domain/net/lucasward/grails/plugin/inheritance/entry/ProfessionalPerformanceYear.groovy",
            "src/groovy/net/lucasward/grails/plugin/StubSpringSecurityService.groovy",
            "src/java/net/lucasward/grails/plugin/Book.java",
            "src/java/net/lucasward/grails/plugin/SpringSecurityRevisionListener.java",
            "src/java/net/lucasward/grails/plugin/SpringSecurityServiceHolder.java",
            "src/java/net/lucasward/grails/plugin/UserRevisionEntity.java",
            "grails-app/conf/hibernate/hibernate.cfg.xml"
    ]

    def author = "Lucas Ward, Jay Hogan"
    def authorEmail = ""
    def title = "Grails Envers Plugin"
    def description = 'Plugin to integrate grails with Hibernate Envers'

    // URL to the plugin's documentation
    def documentation = "http://grails.org/plugin/envers"

    def doWithWebDescriptor = { xml ->

    }

    def doWithSpring = {
        auditEventListener(AuditEventListener)

        hibernateEventListeners(HibernateEventListeners) {
            listenerMap = ['post-insert': auditEventListener,
                    'post-update': auditEventListener,
                    'post-delete': auditEventListener,
                    'pre-collection-update': auditEventListener,
                    'pre-collection-remove': auditEventListener,
                    'post-collection-recreate': auditEventListener]
        }
    }

    def doWithDynamicMethods = { ctx ->
        for (entry in ctx.getBeansOfType(SessionFactory)) {
            SessionFactory sessionFactory = entry.value
            registerDomainMethods(application, sessionFactory)
        }
    }

    private def registerDomainMethods(GrailsApplication application, SessionFactory sessionFactory) {
        application.domainClasses.each { GrailsDomainClass gc ->
            def getAllRevisions = new RevisionsOfEntityQueryMethod(sessionFactory, gc.clazz)
            if (EnversPluginSupport.isAudited(gc)) {
                MetaClass mc = gc.getMetaClass()
                mc.static.findAllRevisions = {
                    getAllRevisions.query(null, null, [:])
                }
                mc.static.findAllRevisions = { Map parameters ->
                    getAllRevisions.query(null, null, parameters)
                }
                EnversPluginSupport.generateFindAllMethods(gc, sessionFactory)
                EnversPluginSupport.generateAuditReaderMethods(gc, sessionFactory)
            }
        }
    }

    def doWithApplicationContext = { applicationContext ->

    }

    def onChange = { event ->
    }

    def onConfigChange = { event ->

    }
}