Changeset 622 for trunk

Timestamp:

Jul 10, 2010, 10:48:50 PM (14 years ago)

Author:

gav

Message:

Apply bug fix for ticket #76.
Rename all instances of Lucene to Searchable.
Improved global directory config.
Add log levels for searchable plugin and compass.

Location:

trunk/grails-app

Files:

• conf/BootStrap.groovy (modified) (3 diffs)
• conf/Config.groovy (modified) (4 diffs)
• conf/Searchable.groovy (modified) (2 diffs)
• controllers/AppCoreController.groovy (modified) (1 diff)
• domain/Asset.groovy (modified) (2 diffs)
• domain/InventoryGroup.groovy (modified) (2 diffs)
• domain/InventoryLocation.groovy (modified) (2 diffs)
• i18n/messages.properties (modified) (1 diff)
• jobs/InventoryIndexJob.groovy (moved) (moved from trunk/grails-app/jobs/InventoryReindexJob.groovy) (3 diffs)
• services/CreateBulkDataService.groovy (modified) (5 diffs)
• services/CreateDataService.groovy (modified) (2 diffs)
• views/appCore/manager.gsp (modified) (1 diff)

trunk/grails-app/conf/BootStrap.groovy

@@ -16 +16 @@
                 createDataService.createBaseData()
                 createDataService.createDemoData()
-                createDataService.startLucene()
+                createDataService.startSearchableIndex()
             }
             test {
@@ -22 +22 @@
                 createDataService.ensureSystemAndAdminAccess()
                 createDataService.createBaseData()
-                createDataService.startLucene(false)
+                createDataService.startSearchableIndex(false)
             }
             production {
@@ -28 +28 @@
                 createDataService.ensureSystemAndAdminAccess()
                 createDataService.createBaseData()
-                createDataService.startLucene()
+                createDataService.startSearchableIndex()
             }
         }

trunk/grails-app/conf/Config.groovy

@@ -49 +49 @@
 grails.spring.bean.packages = []
 
+/**
+* Internal searchable index config.
+*/
+// Is set true by createDataService.startSearchableIndex() once bootstrap completes.
+appSearchable.cascadeOnUpdate = false
+
+/**
+* Directory configuration.
+* Pickup the Tomcat/Catalina directory else use the target or current dir.
+*/
+def fs = File.separator // Local variable.
+globalDirs.targetDir = new File("target${fs}").isDirectory() ? "target${fs}" : ''
+globalDirs.catalinaBase = System.properties.getProperty('catalina.base')
+globalDirs.logDirectory = globalDirs.catalinaBase ? "${globalDirs.catalinaBase}${fs}logs${fs}" : globalDirs.targetDir
+globalDirs.workDirectory = globalDirs.catalinaBase ? "${globalDirs.catalinaBase}${fs}work${fs}" : globalDirs.targetDir
+globalDirs.searchableIndexDirectory = "${globalDirs.workDirectory}SearchableIndex${fs}${appName}${fs}"
 
 /**
@@ -58 +74 @@
  * Basic log levels are ALL < TRACE < DEBUG < INFO < WARN < ERROR < FATAL < OFF
  */
-// Pickup the Tomcat/Catalina work directory else use the current or temp dir.
-def catalinaBase = System.properties.getProperty('catalina.base')
-def fs = File.separator
-def logDirectory = catalinaBase ? "${catalinaBase}${fs}logs${fs}" : ''
 
 log4j = {
@@ -73 +85 @@
         // Custom log file.
         rollingFile name:"appLog",
-                        file:"${logDirectory}${appName}.log".toString(),
+                        file:"${globalDirs.logDirectory}${appName}.log".toString(),
                         maxFileSize:'300kB',
                         maxBackupIndex:1,
@@ -99 +111 @@
     error 'grails.app.service.NavigationService'
     error 'grails.app.service.com.zeddware.grails.plugins.filterpane.FilterService'
+    info 'org.codehaus.groovy.grails.plugins.searchable'
+    //info 'org.compass'
     error 'grails.app.task' // Quartz jobs.
-    info 'grails.app.task.InventoryReindexJob'
+    info 'grails.app.task.InventoryIndexJob'
 
     // Move anything that should behave differently into this section.

trunk/grails-app/conf/Searchable.groovy

@@ +1 @@
+import org.codehaus.groovy.grails.commons.ConfigurationHolder
+
 /**
  * This {@link groovy.util.ConfigObject} script provides Grails Searchable Plugin configuration.
@@ -26 +28 @@
 
     /**
-     * The location of the Compass index
-     *
-     * Examples: "/home/app/compassindex", "ram://app-index" or null to use the default
-     *
-     * The default is "${user.home}/.grails/projects/${app.name}/searchable-index/${grails.env}"
-     */
-    // Pickup the Tomcat/Catalina work directory else use the current or temp dir.
-    def catalinaBase = System.properties.getProperty('catalina.base')
-    def fs = File.separator
-    def indexDirectory = catalinaBase ? "${catalinaBase}${fs}work${fs}Lucene${fs}" : "Lucene${fs}"
-
-    compassConnection = new File("${indexDirectory}${appName}").absolutePath
+    * The location of the Compass index
+    *
+    * Examples: "/home/app/compassindex", "ram://app-index" or null to use the default
+    *
+    * The default is "${user.home}/.grails/projects/${app.name}/searchable-index/${grails.env}"
+    */
+    compassConnection = new File(ConfigurationHolder.config.globalDirs.searchableIndexDirectory).absolutePath
 
     /**

trunk/grails-app/controllers/AppCoreController.groovy

@@ -253 +253 @@
 
     /**
-    * Rebuild the lucene text search index.
+    * Rebuild the text search index.
     */
     @Secured(['ROLE_AppAdmin', 'ROLE_Manager'])
     def rebuildTextSearchIndex = {
-        log.info "Rebuilding lucene text search index."
-        searchableService.reindex()
-        log.info "Rebuilding lucene text search index, complete."
-
-        flash.message = g.message(code:"default.update.success", args:["Index ", ''])
+        InventoryIndexJob.triggerNow(['calledBy':'AppCoreController rebuildTextSearchIndex{}'])
+
+        flash.message = g.message(code:"appCore.rebuild.text.search.index")
         redirect(action: manager)
     }

trunk/grails-app/domain/Asset.groovy

@@ +1 @@
+import org.codehaus.groovy.grails.commons.ConfigurationHolder
+
 class Asset {
 
@@ -35 +37 @@
     }
 
+    def afterUpdate = {
+        // Update the Inventory searchable index, since cascading in searchable-0.5.5 is broken.
+        if(ConfigurationHolder.config.appSearchable.cascadeOnUpdate) {
+            try {
+                InventoryIndexJob.triggerNow(['calledBy':'Asset afterUpdate{}'])
+            }
+            catch(e) {log.error e}
+        } // if
+    } // afterUpdate
+
     //  This additional setter is used to convert the checkBoxList string or string array
     //  of ids selected to the corresponding domain objects.

trunk/grails-app/domain/InventoryGroup.groovy

@@ +1 @@
+import org.codehaus.groovy.grails.commons.ConfigurationHolder
+
 class InventoryGroup {
     String name
@@ -18 +20 @@
     }
 
+    def afterUpdate = {
+        // Update the Inventory searchable index, since cascading in searchable-0.5.5 is broken.
+        if(ConfigurationHolder.config.appSearchable.cascadeOnUpdate) {
+            try {
+                InventoryIndexJob.triggerNow(['calledBy':'InventoryGroup afterUpdate{}'])
+            }
+            catch(e) {log.error e}
+        } // if
+    } // afterUpdate
+
 }

trunk/grails-app/domain/InventoryLocation.groovy

@@ +1 @@
+import org.codehaus.groovy.grails.commons.ConfigurationHolder
+
 class InventoryLocation {
 
@@ -22 +24 @@
     }
 
+    def afterUpdate = {
+        // Update the Inventory searchable index, since cascading in searchable-0.5.5 is broken.
+        if(ConfigurationHolder.config.appSearchable.cascadeOnUpdate) {
+            try {
+                InventoryIndexJob.triggerNow(['calledBy':'InventoryLocation afterUpdate{}'])
+            }
+            catch(e) {log.error e}
+        } // if
+    } // afterUpdate
+
 }

trunk/grails-app/i18n/messages.properties

@@ -423 +423 @@
 report.error.no.inventory.items.found=Error: no inventory items found, please run report again.
 report.error.too.many.inventory.items=Error: over {0} inventory items, please run report again.
+
+#
+# AppCore messages.
+#
+appCore.rebuild.text.search.index=The text search index is being rebuilt in the background, see log file for details.

trunk/grails-app/jobs/InventoryIndexJob.groovy

@@ -1 @@
-import org.codehaus.groovy.grails.commons.*
+import org.codehaus.groovy.grails.commons.ConfigurationHolder
 
 /**
-* Provides a quartz job that reindex's the Lucene index for the Inventory domain class.
-* With concurrent=false the repeat interval starts after the previous job completes.
+* Provides a quartz job that rebuilds the searchable index for the inventory search.
+* With concurrent=false the next job is blocked until the previous job completes.
 * We need a hibernate session otherwise we get a LazyInitializationException, default is true but we specify it to be sure.
+* Rebuilding the index is required since searchable components are not updated when they change, that is
+* until the parent is updated and reindexed. Cascade update is broken in searchable-0.5.5
 */
-class InventoryReindexJob {
+class InventoryIndexJob {
 
     def concurrent = false
@@ -16 +18 @@
         // See: http://www.quartz-scheduler.org/docs/tutorials/crontrigger.html
         // Trigger every hour on the hour:
-        cron name: 'RebuildInventoryIndex', cronExpression: "0 0 * * * ?"
+        //cron name: 'RebuildInventoryIndex', cronExpression: "0 0 * * * ?"
     }
 
-    def execute() {
+    def execute(context) {
 
         // Some information can be accessed if we run with "def execute(context) ".
@@ -27 +29 @@
         // log.debug context.getFireTime()
 
-        // Reindex the Inventory domain class.
-        log.info "Rebuilding Lucene index, Inventory.reindex()."
-        InventoryItem.reindex()
-        log.info "Rebuilding Lucene index, complete."
+        // Called by.
+        def calledBy =  context.mergedJobDataMap.get('calledBy')
+        log.info "Called By: " + calledBy
+
+        // Rebuild the Inventory searchable index.
+        log.info "Calling, Inventory.index()."
+        InventoryItem.index()
     }
 }

trunk/grails-app/services/CreateBulkDataService.groovy

@@ -12 +12 @@
     def dateUtilService
     def appConfigService
+    def createDataService
     def searchableService
     def assignedGroupService
@@ -43 +44 @@
             return fail(code: 'default.not.development.environment.failure')
 
-        log.info "Stop mirroring lucene index."
-        searchableService.stopMirroring()
+        createDataService.stopSearchableIndex()
 
         log.info "Creating BULK data..."
@@ -83 +83 @@
         log.info "Creating BULK data...complete."
 
-        log.info "Start mirroring Lucene index."
-        searchableService.startMirroring()
-        log.info "Rebuilding Lucene index, bulkIndex."
-        searchableService.reindex()
-        log.info "Rebuilding Lucene index, complete."
+        createDataService.startSearchableIndex()
 
         return result
@@ -107 +103 @@
             return fail(code: 'default.not.development.environment.failure')
 
-        log.info "Stop mirroring Lucene index."
-        searchableService.stopMirroring()
+        createDataService.stopSearchableIndex()
 
         log.info "Creating BULK data..."
@@ -121 +116 @@
         log.info "Creating BULK data...complete."
 
-        log.info "Start mirroring Lucene index."
-        searchableService.startMirroring()
-        log.info "Rebuilding Lucene index, bulkIndex."
-        searchableService.reindex()
-        log.info "Rebuilding Lucene index, complete."
+        createDataService.startSearchableIndex()
 
         return result

trunk/grails-app/services/CreateDataService.groovy

@@ +1 @@
+import org.codehaus.groovy.grails.commons.ConfigurationHolder
+
 /**
 * Provides a data service to create base and demo data.
@@ -1525 +1527 @@
 
     /**
-    * Lucene index and mirroring is disabled at startup.
-    * Us this to start Lucene indexing after creating bootstrap data.
+    * SearchableIndex and mirroring is disabled at startup.
+    * Use this to start indexing after creating bootstrap data.
     * @param indexInNewThread Whether to run the index in a new thread, defaults to true.
     */
-    def startLucene(Boolean indexInNewThread = true) {
-        log.info "Start mirroring Lucene index."
+    def startSearchableIndex(Boolean indexInNewThread = true) {
+        log.info "Start mirroring searchable index."
+        ConfigurationHolder.config.appSearchable.cascadeOnUpdate = true
         searchableService.startMirroring()
         if(indexInNewThread) {
             Thread.start {
-                log.info "Rebuilding Lucene index, bulkIndex (new thread)."
+                log.info "Rebuilding searchable index, bulkIndex (new thread)."
                 searchableService.index()
-                log.info "Rebuilding Lucene index, complete."
+                log.info "Rebuilding searchable index, complete."
             }
         }
         else {
-            log.info "Rebuilding Lucene index, bulkIndex."
+            log.info "Rebuilding searchable index, bulkIndex."
             searchableService.index()
-            log.info "Rebuilding Lucene index, complete."
+            log.info "Rebuilding searchable index, complete."
         }
     }
 
     /**
-    * Lucene index and mirroring during bulk data creation may be slow.
-    * Us this to stop lucene indexing and restart with startLucene() after data creation.
+    * Searchable index and mirroring during bulk data creation may be slow.
+    * Use this to stop indexing and restart with startSearchableIndex() after data creation.
     */
-    def stopLucene() {
-        log.info "Stop mirroring lucene index."
+    def stopSearchableIndex() {
+        log.info "Stop mirroring searchable index."
+        ConfigurationHolder.config.appSearchable.cascadeOnUpdate = false
         searchableService.stopMirroring()
     }

trunk/grails-app/views/appCore/manager.gsp

@@ -80 +80 @@
                                 <g:link action="rebuildTextSearchIndex">
                                     Rebuild
-                                </g:link> - Reindex the entire text search index.
+                                </g:link> - Rebuild the text search index.
                                 <br />
                             </td>