Changeset 562

Timestamp:

Jun 2, 2010, 4:31:17 PM (15 years ago)

Author:

gav

Message:

Install searchable plugin, configure and start inventory search.

Location:

trunk

Files:

• application.properties (modified) (2 diffs)
• grails-app/conf/Searchable.groovy (added)
• grails-app/controllers/AppCoreController.groovy (modified) (2 diffs)
• grails-app/controllers/InventoryItemDetailedController.groovy (modified) (3 diffs)
• grails-app/domain/Asset.groovy (modified) (1 diff)
• grails-app/domain/InventoryItem.groovy (modified) (1 diff)
• grails-app/domain/InventoryLocation.groovy (modified) (1 diff)
• grails-app/i18n/messages.properties (modified) (1 diff)
• grails-app/services/InventoryItemSearchService.groovy (modified) (2 diffs)
• grails-app/views/appCore/manager.gsp (modified) (1 diff)
• grails-app/views/inventoryItemDetailed/search.gsp (modified) (5 diffs)
• grails-app/views/taskDetailed/_quickSearchPane.gsp (modified) (1 diff)

trunk/application.properties

@@ -1 +1 @@
 #Grails Metadata file
-#Sun May 23 23:41:38 EST 2010
+#Wed Jun 02 11:20:51 EST 2010
 app.grails.version=1.2.2
 app.name=gnuMims
@@ -16 +16 @@
 plugins.quartz=0.4.2
 plugins.richui=0.8
+plugins.searchable=0.5.5
 plugins.tomcat=1.2.2

trunk/grails-app/controllers/AppCoreController.groovy

@@ -11 +11 @@
     def appConfigService
     def createDataService
+    def searchableService
     def createBulkDataService
 
@@ -251 +252 @@
     }
 
+    /**
+    * Rebuild the lucene 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 ", ''])
+        redirect(action: manager)
+    }
+
 } // end of class.

trunk/grails-app/controllers/InventoryItemDetailedController.groovy

@@ -134 +134 @@
         def isFilterApplied = FilterUtils.isFilterApplied(params)
 
+        // Restore default sort if a new text search is requested
+        if(params.newTextSearch) {
+            params.sort = 'id'
+            params.order = 'desc'
+        }
+
         // Restore search unless a new search is being requested.
-        if(!params.quickSearch && !filterParams) {
-            if(session.inventoryItemQuickSearch) {
+        if(!params.searchText && !params.quickSearch && !filterParams) {
+            if(session.inventoryItemSearchText) {
+                params.searchText = session.inventoryItemSearchText
+                params.searchName = session.inventoryItemSearchName
+                params.searchDescription = session.inventoryItemSearchDescription
+                params.searchComment = session.inventoryItemSearchComment
+                params.searchLocation = session.inventoryItemSearchLocation
+                params.searchSpareFor = session.inventoryItemSearchSpareFor
+            }
+            else if(session.inventoryItemQuickSearch) {
                 params.quickSearch = session.inventoryItemQuickSearch
                 if(session.inventoryItemQuickSearchDaysBack)
@@ -166 +180 @@
             session.inventoryItemSearchFilterParams = new LinkedHashMap(filterParams)
             session.inventoryItemSearchFilter = new LinkedHashMap(params.filter)
+            // Clear any previous search.
+            session.removeAttribute("inventoryItemSearchText")
+            session.removeAttribute("inventoryItemSearchName")
+            session.removeAttribute("inventoryItemSearchDescription")
+            session.removeAttribute("inventoryItemSearchComment")
+            session.removeAttribute("inventoryItemSearchLocation")
+            session.removeAttribute("inventoryItemSearchSpareFor")
             session.removeAttribute("inventoryItemQuickSearch")
             session.removeAttribute("inventoryItemQuickSearchDaysBack")
         }
+        else if(params.searchText) {
+            // Quick Search Text:
+            def result = inventoryItemSearchService.getTextSearch(params, RCU.getLocale(request))
+            inventoryItemInstanceList = result.inventoryItemList
+            inventoryItemInstanceTotal = result.inventoryItemList.totalCount
+            params.message = result.message
+            filterParams.searchText = result.searchText
+            // Remember search.
+            session.inventoryItemSearchText = params.searchText
+            session.inventoryItemSearchName = params.searchName
+            session.inventoryItemSearchDescription = params.searchDescription
+            session.inventoryItemSearchComment = params.searchComment
+            session.inventoryItemSearchLocation = params.searchLocation
+            session.inventoryItemSearchSpareFor = params.searchSpareFor
+            // Clear any previous search.
+            session.removeAttribute("inventoryItemQuickSearch")
+            session.removeAttribute("inventoryItemQuickSearchDaysBack")
+            session.removeAttribute("inventoryItemSearchFilterParams")
+            session.removeAttribute("inventoryItemSearchFilter")
+        }
         else {
-            // Quick Search:
+            // Quick Search Links:
             if(!params.quickSearch) params.quickSearch = "all"
             def result = inventoryItemSearchService.getQuickSearch(params, RCU.getLocale(request))
@@ -178 +219 @@
             filterParams.quickSearch = result.quickSearch
             // Remember search.
-            session.removeAttribute("inventoryItemSearchFilterParams")
-            session.removeAttribute("inventoryItemSearchFilter")
             session.inventoryItemQuickSearch = result.quickSearch
             if(result.daysBack)
                 session.inventoryItemQuickSearchDaysBack = result.daysBack
+            // Clear any previous search.
+            session.removeAttribute("inventoryItemSearchText")
+            session.removeAttribute("inventoryItemSearchName")
+            session.removeAttribute("inventoryItemSearchDescription")
+            session.removeAttribute("inventoryItemSearchComment")
+            session.removeAttribute("inventoryItemSearchLocation")
+            session.removeAttribute("inventoryItemSearchSpareFor")
+            session.removeAttribute("inventoryItemSearchFilterParams")
+            session.removeAttribute("inventoryItemSearchFilter")
         }
 

trunk/grails-app/domain/Asset.groovy

@@ -30 +30 @@
     }
 
+    static searchable = {
+        root false // only index as a component of InventoryItem.
+        only = ['name', 'description', 'comment']
+    }
+
     //  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/InventoryItem.groovy

@@ -61 +61 @@
     String toString() {"${this.name}"}
 
+    static searchable = {
+        only = ['name', 'description', 'comment', 'inventoryLocation', 'spareFor']
+        //name boost: 1.5
+        inventoryLocation component: true
+        spareFor component: true
+    }
+
     def afterInsert = {
         addReverseAlternateItems()

trunk/grails-app/domain/InventoryLocation.groovy

@@ -16 +16 @@
         "${this.name}"
     }
+
+    static searchable = {
+        root false // only index as a component of InventoryItem.
+        only = ['name']
+    }
+
 }

trunk/grails-app/i18n/messages.properties

@@ -308 +308 @@
 
 # InventoryItemSearch
+inventoryItem.search.text.found=Results for: {0}
+inventoryItem.search.text.none.found=No results for: {0}
 inventoryItem.search.text.below.reorder=Below Reorder
 inventoryItem.search.text.below.reorder.description=Inventory items at or below reorder point, with reorder enabled.

trunk/grails-app/services/InventoryItemSearchService.groovy

@@ -1 +1 @@
 import grails.orm.PagedResultList
+import org.compass.core.engine.SearchEngineQueryParseException
 
 /**
@@ -138 +139 @@
     } // getRecentlyUsed
 
+    /**
+    * Get a list of inventory items by search text.
+    * @param params The request params.
+    * @param locale The locale to use when generating result.message.
+    */
+    def getTextSearch(params, locale) {
+        def result = [:]
+        result.searchText = params.searchText.trim() ?: ""
+
+        def getMessage = { Map m ->
+            messageSource.getMessage(m.code, m.args == null ? null : m.args.toArray(), locale)
+        }
+
+        params.max = Math.min(params?.max?.toInteger() ?: 10, paramsMax)
+        params.offset = params?.offset?.toInteger() ?: 0
+        params.sort = params?.sort ?: "id"
+        params.order = params?.order ?: "asc"
+
+        // Build searchableParams.
+        // Do not include params.sort, since not all properites are indexed.
+        def searchableParams = [max: params.max, offset: params.offset,
+                                                    reload: true, defaultOperator: 'or']
+
+        // Perform the searchable query.
+        try {
+            result.inventoryItemList = InventoryItem.search(result.searchText, searchableParams)
+        } catch (e) {
+            log.error e
+            result.inventoryItemList = [:]
+            result.inventoryItemList.results = []
+            result.inventoryItemList.total = 0
+        }
+
+        // Sort the returned instances.
+        if(params.sort != 'id') {
+            if(params.order == 'asc') {
+                if(params.sort == 'name' || params.sort == 'description')
+                    result.inventoryItemList.results.sort { p1, p2 -> p1[params.sort].compareToIgnoreCase(p2[params.sort]) }
+                else if(params.sort == 'inventoryGroup') {
+                    result.inventoryItemList.results.sort { p1, p2 ->
+                        p1.inventoryGroup.name.compareToIgnoreCase(p2.inventoryGroup.name)
+                    }
+                }
+                else if(params.sort == 'unitsInStock')
+                    result.inventoryItemList.results.sort {p1, p2 -> p1[params.sort]  <=> p2[params.sort] }
+            } // asc.
+            else {
+                if(params.sort == 'name' || params.sort == 'description')
+                    result.inventoryItemList.results.sort { p1, p2 -> p2[params.sort].compareToIgnoreCase(p1[params.sort]) }
+                else if(params.sort == 'inventoryGroup') {
+                    result.inventoryItemList.results.sort { p1, p2 ->
+                        p2.inventoryGroup.name.compareToIgnoreCase(p1.inventoryGroup.name)
+                    }
+                }
+                else if(params.sort == 'unitsInStock')
+                    result.inventoryItemList.results.sort {p1, p2 -> p2[params.sort] <=> p1[params.sort]}
+            } // desc.
+        } // sort.
+
+        // Create a PagedResultList.
+        result.inventoryItemList = new PagedResultList(result.inventoryItemList.results, result.inventoryItemList.total)
+
+        // Get the result message.
+        if(result.inventoryItemList.totalCount > 0)
+            result.message = getMessage(code:"inventoryItem.search.text.found", args: [result.searchText])
+        else
+            result.message = getMessage(code:"inventoryItem.search.text.none.found", args: [result.searchText])
+
+        // Success.
+        return result
+
+    } // getTextSearch()
+
 } // end class

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

@@ -75 +75 @@
                         <tr class="prop">
                             <td valign="top" class="name">
+                                <label>Search Index:</label>
+                            </td>
+                            <td valign="top" class="value">
+                                <g:link action="rebuildTextSearchIndex">
+                                    Rebuild
+                                </g:link> - Reindex the entire text search index.
+                                <br />
+                            </td>
+                        </tr>
+
+                        <tr class="prop">
+                            <td valign="top" class="name">
                                 <label>Entity Relationship Diagram:</label>
                             </td>

trunk/grails-app/views/inventoryItemDetailed/search.gsp

@@ -22 +22 @@
                                     removeImgDir="images" 
                                     removeImgFile="bullet_delete.png"
-                                    title="Search"/>
+                                    title="Advanced Search"/>
 
             <div class="paginateButtons">
@@ -30 +30 @@
                 Results: ${inventoryItemInstanceList.size()} / ${inventoryItemInstanceTotal}
                 <span class="searchButtons">
-                    <filterpane:filterButton text="Search" appliedText="Change Search" />
+                    <filterpane:filterButton text="Advanced" appliedText="Advanced" />
                 </span>
             </div>
@@ -178 +178 @@
 
             <filterpane:filterPane domainBean="InventoryItem"
-                                    title="Search"
+                                    title="Advanced Search"
                                     action="search"
                                     class="overlayPane"
@@ -197 +197 @@
         <div class="overlayPane" id="searchPane" style="display:none;">
             <h2>Quick Search</h2>
+
             <g:form method="post" id="searchForm" name="searchForm" >
+                <g:hiddenField name="newTextSearch" value="true" />
+
                 <table>
                     <tbody>
@@ -252 +255 @@
                     </tbody>
                 </table>
+
+                <table>
+                    <tbody>
+
+                        <tr class="prop">
+                            <td valign="top" class="name">
+                                <label for="searchText">Search:</label>
+                            </td>
+                            <td valign="top" class="value">
+                                <input type="text" style="width:450px" maxlength="75" id="searchText" name="searchText" value="${filterParams.searchText}"/>
+                            </td>
+                        </tr>
+
+                        <tr class="prop">
+                            <td valign="top" class="name">
+                            </td>
+                            <td valign="top" class="value">
+<!--                                 <g:checkBox name="searchName" value="${true}" ></g:checkBox> -->
+                                <label for="searchName">Name,</label>
+<!--                                 <g:checkBox name="searchDescription" value="${true}" ></g:checkBox> -->
+                                <label for="searchDescription">Description,</label>
+<!--                                 <g:checkBox name="searchComment" value="${true}" ></g:checkBox> -->
+                                <label for="searchComment">Comment,</label>
+<!--                                 <g:checkBox name="searchLocation" value="${true}" ></g:checkBox> -->
+                                <label for="searchLocation">Location and</label>
+<!--                                 <g:checkBox name="searchSpareFor" value="${true}" ></g:checkBox> -->
+                                <label for="searchSpareFor">Spare For.</label>
+                            </td>
+                        </tr>
+
+                    </tbody>
+                </table>
+
                 <div class="buttons">
                     <span class="button">
-                        <input type="button" value="${g.message(code:'fp.tag.filterPane.button.cancel.text', default:'Cancel')}" onclick="return hideElement('searchPane');" />
+                        <g:actionSubmit class="save" value="Update" action="search" />
+                        <g:actionSubmit class="cancel" value="${g.message(code:'fp.tag.filterPane.button.cancel.text', default:'Cancel')}" onclick="return hideElement('searchPane');" />
                     </span>
                 </div>

trunk/grails-app/views/taskDetailed/_quickSearchPane.gsp

@@ -110 +110 @@
         <div class="buttons">
             <span class="button">
-                <input type="button" value="${g.message(code:'fp.tag.filterPane.button.cancel.text', default:'Cancel')}" onclick="return hideElement('searchPane');" />
+                <g:actionSubmit class="cancel" value="${g.message(code:'fp.tag.filterPane.button.cancel.text', default:'Cancel')}" onclick="return hideElement('searchPane');" />
             </span>
         </div>