Added web.allowLuceneIndexing to enable/disable Lucene integration

diff --git a/distrib/gitblit.properties b/distrib/gitblit.properties
index ad8228095c7a97e22f17f32c5f5078ebd6ecfb00..2846496e6cb755dfe68570d6e2af7f3e1f381594 100644 (file)
--- a/distrib/gitblit.properties
+++ b/distrib/gitblit.properties
@@ -184,6 +184,15 @@ web.allowGravatar = true
 # SINCE 0.5.0   \r
 web.allowZipDownloads = true\r
 \r
+# Allow optional Lucene integration. Lucene indexing is an opt-in feature.\r
+# A repository may specify branches to index with Lucene instead of using Git\r
+# commit traversal. There are scenarios where you may want to completely disable\r
+# Lucene indexing despite a repository specifying indexed branches.  One such\r
+# scenario is on a resource-constrained federated Gitblit mirror.\r
+#\r
+# SINCE 0.9.0\r
+web.allowLuceneIndexing = true\r
+\r
 # Use Clippy (Flash solution) to provide a copy-to-clipboard button.\r
 # If false, a button with a more primitive JavaScript-based prompt box will\r
 # offer a 3-step (click, ctrl+c, enter) copy-to-clipboard alternative.\r

diff --git a/docs/01_setup.mkd b/docs/01_setup.mkd
index 09ddabbdd49e67722e46ec71de4daab8179beb84..c5d78defcc2415b000f51887bd75e778d774641e 100644 (file)
--- a/docs/01_setup.mkd
+++ b/docs/01_setup.mkd
@@ -385,11 +385,11 @@ Repositories may optionally be indexed using the Lucene search engine.  The Luce
 \r
 ### How do I use it?\r
 \r
-Lucene indexing is an opt-in feature which means that no repositories are automatically indexed.  \r
+First you must ensure that *web.allowLuceneIndexing* is set *true* in `gitblit.properties` or `web.xml`.  Then you must understand that Lucene indexing is an opt-in feature which means that no repositories are automatically indexed.  \r
 Like anything else, this design has pros and cons.\r
 \r
 #### Pros\r
-1. no wasted cycles on repositories you will never search\r
+1. no wasted cycles indexing repositories you will never search\r
 2. you specify exactly what branches are indexed; experimental/dead/personal branches can be ignored\r
 \r
 #### Cons\r
@@ -408,6 +408,10 @@ You may specify which branches should be indexed per-repository in the *Edit Rep
 **NOTE:**  \r
 After specifying branches, only the content from those branches can be searched via Gitblit.  Gitblit will automatically redirect any queries entered on a repository's search box to the Lucene search page. Repositories that do not specify any indexed branches will use the traditional commit-traversal search.\r
 \r
+#### Adequate Heap\r
+\r
+The initial indexing of an existing repository can potentially exhaust the memory allocated to your Java instance and may throw OutOfMemory exceptions.  Be sure to provide your Gitblit server adequate heap space to index your repositories.  The heap is set using the *-Xmx* JVM parameter in your Gitblit launch command (e.g. -Xmx1024M).\r
+\r
 ## Client Setup and Configuration\r
 ### Https with Self-Signed Certificates\r
 You must tell Git/JGit not to verify the self-signed certificate in order to perform any remote Git operations.\r

diff --git a/docs/04_releases.mkd b/docs/04_releases.mkd
index 6e482103e92810eb5b4ddc21db8893594cd2cd2d..5fec6e990d740da759ad340520d6b59db17f2c4b 100644 (file)
--- a/docs/04_releases.mkd
+++ b/docs/04_releases.mkd
@@ -17,10 +17,12 @@
 #### additions\r
 \r
 - Added optional Lucene branch indexing (issue 16)  \r
+    **New:** *web.allowLuceneIndexing = true*  \r
     **New:** *web.luceneIgnoreExtensions = 7z arc arj bin bmp dll doc docx exe gif gz jar jpg lib lzh odg odf odt pdf ppt png so swf xcf xls xlsx zip*  \r
 Repository branches may be optionally indexed by Lucene for improved searching.  To use this feature you must specify which branches to index within the *Edit Repository* page; _no repositories are automatically indexed_.  Gitblit will build or incrementally update enrolled repositories on a 2 minute cycle. (i.e you will have to wait 2-3 minutes after respecifying indexed branches or pushing new commits before Gitblit will build/update the repository's Lucene index.)  \r
 If a repository has Lucene-indexed branches the *search* form on the repository pages will redirect to the root-level Lucene search page and only the content of those branches can be searched.  \r
-If the repository does not specify any indexed branches then repository commit-traversal search is used.\r
+If the repository does not specify any indexed branches then repository commit-traversal search is used.  \r
+**Note:** Initial indexing of an existing repository can be memory-exhaustive. Be sure to provide your Gitblit server adequate heap space to index your repositories (e.g. -Xmx1024M).\r
 - Allow specifying timezone to use for Gitblit which is independent of both the JVM and the system timezone (issue 54)  \r
     **New:** *web.timezone =*  \r
 - Added a built-in AJP connector for integrating Gitblit GO into an Apache mod_proxy setup (issue 59)  \r

diff --git a/resources/gitblit.css b/resources/gitblit.css
index 3c265a4887a5ddf2e974a684566a4a39d4837e2a..8934cb2db06e545615715d60b24ceca6e081b845 100644 (file)
--- a/resources/gitblit.css
+++ b/resources/gitblit.css
@@ -310,7 +310,8 @@ div.searchResult pre {
 }\r
 \r
 div.searchResult .text {\r
-       border-left: 5px solid #EEEEEE;\r
+       border-left: 2px solid #ccc;\r
+       border-radius: 0px;\r
        \r
     padding: 0 0 0 15px;\r
 }\r

diff --git a/src/com/gitblit/LuceneExecutor.java b/src/com/gitblit/LuceneExecutor.java
index 70d666f118656bd54ac2fb0ccf5e870159f4e2e8..cd7074b633822e57e9998ad4918e87738fd7670c 100644 (file)
--- a/src/com/gitblit/LuceneExecutor.java
+++ b/src/com/gitblit/LuceneExecutor.java
@@ -157,6 +157,10 @@ public class LuceneExecutor implements Runnable {
         */\r
        @Override\r
        public void run() {\r
+               if (!storedSettings.getBoolean(Keys.web.allowLuceneIndexing, true)) {\r
+                       // Lucene indexing is disabled\r
+                       return;\r
+               }\r
                // reload the excluded extensions\r
                String exts = storedSettings.getString(Keys.web.luceneIgnoreExtensions, luceneIgnoreExtensions);\r
                excludedExtensions = new TreeSet<String>(StringUtils.getStringsFromValue(exts));\r

diff --git a/src/com/gitblit/wicket/GitBlitWebApp.properties b/src/com/gitblit/wicket/GitBlitWebApp.properties
index 3b78b435aec2ad2de9ff833849ef1aeb944b33b1..4300c04b686c3d024d59bc16cd29bbbd4492be7c 100644 (file)
--- a/src/com/gitblit/wicket/GitBlitWebApp.properties
+++ b/src/com/gitblit/wicket/GitBlitWebApp.properties
@@ -222,4 +222,5 @@ gb.indexedBranches = indexed branches
 gb.indexedBranchesDescription = select the branches to include in your Lucene index\r
 gb.noIndexedRepositoriesWarning = none of your repositories are configured for Lucene indexing\r
 gb.undefinedQueryWarning = query is undefined!\r
-gb.noSelectedRepositoriesWarning = please select one or more repositories!
\ No newline at end of file
+gb.noSelectedRepositoriesWarning = please select one or more repositories!\r
+gb.luceneDisabled = Lucene indexing is disabled
\ No newline at end of file

diff --git a/src/com/gitblit/wicket/pages/EditRepositoryPage.java b/src/com/gitblit/wicket/pages/EditRepositoryPage.java
index 5b2124ac2519aae099d4af9d93806b111e455e54..c2fc9f5f5c1d7447b33cf3ed2bfee8bdbbd2a152 100644 (file)
--- a/src/com/gitblit/wicket/pages/EditRepositoryPage.java
+++ b/src/com/gitblit/wicket/pages/EditRepositoryPage.java
@@ -117,12 +117,11 @@ public class EditRepositoryPage extends RootSubPage {
 \r
                // indexed local branches palette\r
                List<String> allLocalBranches = repositoryModel.getLocalBranches();\r
-\r
+               boolean luceneEnabled = GitBlit.getBoolean(Keys.web.allowLuceneIndexing, true);\r
                final Palette<String> indexedBranchesPalette = new Palette<String>("indexedBranches", new ListModel<String>(\r
                                indexedBranches), new CollectionModel<String>(allLocalBranches),\r
                                new StringChoiceRenderer(), 8, false);\r
-               indexedBranchesPalette.setEnabled(allLocalBranches.size() > 0);\r
-\r
+               indexedBranchesPalette.setEnabled(luceneEnabled && (allLocalBranches.size() > 0));\r
                \r
                // federation sets palette\r
                List<String> sets = GitBlit.getStrings(Keys.federation.sets);\r

diff --git a/src/com/gitblit/wicket/pages/LuceneSearchPage.java b/src/com/gitblit/wicket/pages/LuceneSearchPage.java
index 997ef213837fa3c58f22064672964e1600b3ab0a..ea94fa43eab7e1cbdd03d7e824865879375cd066 100644 (file)
--- a/src/com/gitblit/wicket/pages/LuceneSearchPage.java
+++ b/src/com/gitblit/wicket/pages/LuceneSearchPage.java
@@ -105,9 +105,13 @@ public class LuceneSearchPage extends RootPage {
                                availableRepositories.add(model.name);\r
                        }\r
                }\r
-               \r
-               if (availableRepositories.size() == 0) {\r
-                       info(getString("gb.noIndexedRepositoriesWarning"));\r
+               boolean luceneEnabled = GitBlit.getBoolean(Keys.web.allowLuceneIndexing, true);\r
+               if (luceneEnabled) {\r
+                       if (availableRepositories.size() == 0) {\r
+                               info(getString("gb.noIndexedRepositoriesWarning"));\r
+                       }\r
+               } else {\r
+                       error(getString("gb.luceneDisabled"));\r
                }\r
 \r
                // enforce user-accessible repository selections\r
@@ -146,9 +150,9 @@ public class LuceneSearchPage extends RootPage {
                ListMultipleChoice<String> selections = new ListMultipleChoice<String>("repositories", \r
                                repositoriesModel, availableRepositories, new StringChoiceRenderer());\r
                selections.setMaxRows(8);\r
-               form.add(selections);\r
-               form.add(new TextField<String>("query", queryModel));\r
-               add(form);\r
+               form.add(selections.setEnabled(luceneEnabled));\r
+               form.add(new TextField<String>("query", queryModel).setEnabled(luceneEnabled));\r
+               add(form.setEnabled(luceneEnabled));\r
                                \r
                // execute search\r
                final List<SearchResult> results = new ArrayList<SearchResult>();\r

diff --git a/src/com/gitblit/wicket/pages/RepositoryPage.java b/src/com/gitblit/wicket/pages/RepositoryPage.java
index 132b1f7fe0085a5d4421ed01d87639515c6880ed..d90d6273d0144636d0c6ef667be47f4f13a735ac 100644 (file)
--- a/src/com/gitblit/wicket/pages/RepositoryPage.java
+++ b/src/com/gitblit/wicket/pages/RepositoryPage.java
@@ -360,7 +360,8 @@ public abstract class RepositoryPage extends BasePage {
                        }\r
                        Class<? extends BasePage> searchPageClass = GitSearchPage.class;\r
                        RepositoryModel model = GitBlit.self().getRepositoryModel(repositoryName);\r
-                       if (!ArrayUtils.isEmpty(model.indexedBranches)) {\r
+                       if (GitBlit.getBoolean(Keys.web.allowLuceneIndexing, true)\r
+                                       && !ArrayUtils.isEmpty(model.indexedBranches)) {\r
                                // this repository is Lucene-indexed\r
                                searchPageClass = LuceneSearchPage.class;\r
                        }\r

diff --git a/src/com/gitblit/wicket/pages/RootPage.java b/src/com/gitblit/wicket/pages/RootPage.java
index 57678dfb628d3fbeb81cca46d60b59a8b5ceca57..d7b3ab73dcd4a3d43889102b511045a533abccc3 100644 (file)
--- a/src/com/gitblit/wicket/pages/RootPage.java
+++ b/src/com/gitblit/wicket/pages/RootPage.java
@@ -101,7 +101,9 @@ public abstract class RootPage extends BasePage {
                pages.add(new PageRegistration("gb.repositories", RepositoriesPage.class,\r
                                getRootPageParameters()));\r
                pages.add(new PageRegistration("gb.activity", ActivityPage.class, getRootPageParameters()));\r
-               pages.add(new PageRegistration("gb.search", LuceneSearchPage.class));\r
+               if (GitBlit.getBoolean(Keys.web.allowLuceneIndexing, true)) {\r
+                       pages.add(new PageRegistration("gb.search", LuceneSearchPage.class));\r
+               }\r
                if (showAdmin) {\r
                        pages.add(new PageRegistration("gb.users", UsersPage.class));\r
                }\r