Merge pull request #155 from BentoBoxWorld/133-permission-recheck

Revoke permission-gated generators when island owner loses permission (#133)

Author: tastybento

src/main/java/world/bentobox/magiccobblestonegenerator/managers/StoneGeneratorManager.java

@@ -872,6 +872,47 @@ public void checkGeneratorUnlockStatus(Island island, @Nullable User user, @Null
 		.
 		// Now process each generator.
 		forEach(generator -> this.unlockGenerator(dataObject, user, island, generator));
+
+	// Revoke permission based generators that the current owner no longer qualifies for.
+	// This handles ownership transfer to a player without the required permission (#133).
+	this.revokePermissionGenerators(island, dataObject, owner);
+    }
+
+    /**
+     * This method revokes access to permission based generators that the current island owner no longer holds the
+     * required permissions for. Only the unlocked and active status is revoked; any purchase record is preserved so the
+     * generator becomes available again if the permission is regained.
+     * <p>
+     * Permissions can only be checked reliably for an online owner, so nothing is revoked while the owner is offline.
+     *
+     * @param island     Island which is targeted for the check.
+     * @param dataObject Data object that stores island generators.
+     * @param owner      The island owner, or null (e.g. spawn islands).
+     */
+    private void revokePermissionGenerators(@NotNull Island island, @NotNull GeneratorDataObject dataObject,
+	    @Nullable User owner) {
+	if (owner == null || !owner.isOnline()) {
+	    // Cannot reliably check permissions of an offline owner. Do not revoke anything.
+	    return;
+	}
+
+	List<GeneratorTierObject> revokeList = this.getIslandGeneratorTiers(island.getWorld(), dataObject).stream()
+		// Only permission gated generators can be revoked this way.
+		.filter(generator -> !generator.getRequiredPermissions().isEmpty())
+		// That are currently unlocked.
+		.filter(generator -> dataObject.getUnlockedTiers().contains(generator.getUniqueId()))
+		// But whose required permissions the current owner does not have.
+		.filter(generator -> !Utils.matchAllPermissions(owner, generator.getRequiredPermissions()))
+		.collect(Collectors.toList());
+
+	if (!revokeList.isEmpty()) {
+	    revokeList.forEach(generator -> {
+		dataObject.getUnlockedTiers().remove(generator.getUniqueId());
+		dataObject.getActiveGeneratorList().remove(generator.getUniqueId());
+	    });
+
+	    this.saveGeneratorData(dataObject);
+	}
     }
 
     /**

src/test/java/world/bentobox/magiccobblestonegenerator/managers/StoneGeneratorManagerTest.java

@@ -328,6 +328,69 @@ void testCheckGeneratorUnlockStatus() {
         verify(island, times(2)).isSpawn();
     }
 
+    /**
+     * Seeds a deployed, permission-gated generator tier into the cache and returns the freshly created island data with
+     * that tier already unlocked and active, simulating a generator that a previous owner had unlocked.
+     */
+    private GeneratorDataObject seedPermissionGeneratorAndData() {
+        sgm.addWorld(world);
+        when(island.getUniqueId()).thenReturn("island-133");
+        when(island.getWorld()).thenReturn(world);
+        when(island.isSpawn()).thenReturn(false);
+
+        when(generatorTier.getUniqueId()).thenReturn("magiccobblegenerator_perm");
+        when(generatorTier.isDeployed()).thenReturn(true);
+        when(generatorTier.isDefaultGenerator()).thenReturn(false);
+        when(generatorTier.getGeneratorType()).thenReturn(GeneratorType.COBBLESTONE);
+        when(generatorTier.getRequiredMinIslandLevel()).thenReturn(0L);
+        when(generatorTier.getRequiredPermissions())
+                .thenReturn(java.util.Set.of("magiccobblegenerator.gen.perm"));
+        sgm.loadGeneratorTier(generatorTier, true, null);
+
+        GeneratorDataObject data = sgm.getGeneratorData(island);
+        assertNotNull(data);
+        data.getUnlockedTiers().add("magiccobblegenerator_perm");
+        data.getActiveGeneratorList().add("magiccobblegenerator_perm");
+        return data;
+    }
+
+    @Test
+    void testCheckGeneratorUnlockStatusRevokesPermissionGeneratorWhenOwnerLacksPermission() {
+        GeneratorDataObject data = seedPermissionGeneratorAndData();
+        // Owner is online but does not have the required permission (new owner scenario, #133).
+        when(mockPlayer.isOnline()).thenReturn(true);
+
+        sgm.checkGeneratorUnlockStatus(island, null, null);
+
+        assertFalse(data.getUnlockedTiers().contains("magiccobblegenerator_perm"));
+        assertFalse(data.getActiveGeneratorList().contains("magiccobblegenerator_perm"));
+    }
+
+    @Test
+    void testCheckGeneratorUnlockStatusKeepsPermissionGeneratorWhenOwnerHasPermission() {
+        GeneratorDataObject data = seedPermissionGeneratorAndData();
+        when(mockPlayer.isOnline()).thenReturn(true);
+        // Owner still has the required permission.
+        when(mockPlayer.hasPermission(anyString())).thenReturn(true);
+
+        sgm.checkGeneratorUnlockStatus(island, null, null);
+
+        assertTrue(data.getUnlockedTiers().contains("magiccobblegenerator_perm"));
+        assertTrue(data.getActiveGeneratorList().contains("magiccobblegenerator_perm"));
+    }
+
+    @Test
+    void testCheckGeneratorUnlockStatusDoesNotRevokeWhenOwnerOffline() {
+        GeneratorDataObject data = seedPermissionGeneratorAndData();
+        // Owner is offline, so permissions cannot be checked reliably and nothing is revoked.
+        when(mockPlayer.isOnline()).thenReturn(false);
+
+        sgm.checkGeneratorUnlockStatus(island, null, null);
+
+        assertTrue(data.getUnlockedTiers().contains("magiccobblegenerator_perm"));
+        assertTrue(data.getActiveGeneratorList().contains("magiccobblegenerator_perm"));
+    }
+
     @Test
     void testGetGeneratorDataIsland() {
         assertNotNull(sgm.getGeneratorData(island));