MONDRIAN: [MONDRIAN-1079] Allow turning off drillthrough.

[git-p4: depot-paths = "//open/mondrian/": change = 14987]
pentaho · Mar 2, 2012 · b9c58c5 · b9c58c5
1 parent 607f71d
commit b9c58c5
Show file tree

Hide file tree

Showing 4 changed files with 63 additions and 0 deletions.
diff --git a/src/main/mondrian/olap/MondrianProperties.xml b/src/main/mondrian/olap/MondrianProperties.xml
@@ -784,6 +784,16 @@ unrecognized action is specified)</li>
         <Type>String</Type>
         <Default>OFF</Default>
     </PropertyDefinition>
+    <PropertyDefinition>
+        <Name>EnableDrillThrough</Name>
+        <Path>mondrian.drillthrough.enable</Path>
+        <Description>
+If disabled, Mondrian will throw an exception if someone attempts to
+perform a drillthrough of any kind.
+        </Description>
+        <Type>boolean</Type>
+        <Default>true</Default>
+    </PropertyDefinition>
     <PropertyDefinition>
         <Name>EnableTotalCount</Name>
         <Path>mondrian.xmla.drillthroughTotalCount.enable</Path>

diff --git a/src/main/mondrian/resource/MondrianResource.xml b/src/main/mondrian/resource/MondrianResource.xml
@@ -280,6 +280,10 @@
     <text>Don''t know how to rollup aggregator ''avg'' because the cube doesn''t contain at least one ''count'' and one ''sum'' measures based on the same column.</text>
 </exception>
 
+<exception id="350650" name="DrillthroughDisabled">
+    <text>Can''t perform drillthrough operations because ''{0}'' is set to false.</text>
+</exception>bacon
+
 <!-- ====================================================================== -->
 <!-- Connectivity errors -->
 

diff --git a/src/main/mondrian/rolap/RolapCell.java b/src/main/mondrian/rolap/RolapCell.java
@@ -13,6 +13,7 @@
 import mondrian.olap.*;
 import mondrian.olap.fun.AggregateFunDef;
 import mondrian.olap.fun.SetFunDef;
+import mondrian.resource.MondrianResource;
 import mondrian.rolap.agg.*;
 import mondrian.server.*;
 import mondrian.server.monitor.SqlStatementEvent;
@@ -103,6 +104,14 @@ public String getDrillThroughSQL(
         List<Exp> fields,
         boolean extendedContext)
     {
+        if (!MondrianProperties.instance()
+            .EnableDrillThrough.get())
+        {
+            throw MondrianResource.instance()
+                .DrillthroughDisabled.ex(
+                    MondrianProperties.instance()
+                        .EnableDrillThrough.getPath());
+        }
         final Member[] currentMembers = getMembersForDrillThrough();
         // Create a StarPredicate to represent the compound slicer
         // (if necessary)
@@ -305,6 +314,11 @@ private StarPredicate buildDrillthroughSlicerPredicate(
      * @return true if can drill through
      */
     public boolean canDrillThrough() {
+        if (!MondrianProperties.instance()
+            .EnableDrillThrough.get())
+        {
+            return false;
+        }
         // get current members
         final Member[] currentMembers = getMembersForDrillThrough();
         if (containsCalcMembers(currentMembers)) {

diff --git a/testsrc/main/mondrian/test/DrillThroughTest.java b/testsrc/main/mondrian/test/DrillThroughTest.java
@@ -12,6 +12,7 @@
 package mondrian.test;
 
 import mondrian.olap.*;
+import mondrian.resource.MondrianResource;
 import mondrian.rolap.*;
 import mondrian.spi.Dialect;
 
@@ -1189,6 +1190,40 @@ public void testDrillThroughMultiPositionCompoundSlicer() {
         }
         getTestContext().assertSqlEquals(expectedSql, sql, 27402);
     }
+
+    public void testDrillthroughDisable() {
+        propSaver.set(
+            MondrianProperties.instance().EnableDrillThrough,
+            true);
+        Result result =
+            executeQuery(
+                "SELECT {[Measures].[Unit Sales]} ON COLUMNS,\n"
+                + " {[Product].[All Products]} ON ROWS\n"
+                + "FROM [Sales]\n"
+                + "WHERE {[Time].[1997].[Q1], [Time].[1997].[Q2]}");
+        Cell cell = result.getCell(new int[]{0, 0});
+        assertTrue(cell.canDrillThrough());
+
+        propSaver.set(
+            MondrianProperties.instance().EnableDrillThrough,
+            false);
+        result =
+            executeQuery(
+                "SELECT {[Measures].[Unit Sales]} ON COLUMNS,\n"
+                + " {[Product].[All Products]} ON ROWS\n"
+                + "FROM [Sales]\n"
+                + "WHERE {[Time].[1997].[Q1], [Time].[1997].[Q2]}");
+        cell = result.getCell(new int[]{0, 0});
+        assertFalse(cell.canDrillThrough());
+        try {
+            cell.getDrillThroughSQL(false);
+            fail();
+        } catch (MondrianException e) {
+            assertTrue(
+                e.getMessage().contains(
+                    "Can't perform drillthrough operations because"));
+        }
+    }
 }
 
 // End DrillThroughTest.java