├── .github ├── release-drafter.yml ├── CODEOWNERS ├── renovate.json ├── workflows │ ├── release-drafter.yml │ ├── build.yml │ ├── codeql.yml │ ├── upload-release-asset.yml │ └── announce-release-on-discord.yml └── ISSUE_TEMPLATE │ ├── config.yml │ ├── feature_request.yml │ └── bug_report.yml ├── settings.gradle.kts ├── gradle ├── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties └── libs.versions.toml ├── src └── main │ ├── resources │ └── lang │ │ └── messages_en.json │ └── java │ └── com │ └── plotsquared │ └── plothider │ ├── storage │ ├── palette │ │ ├── PalettedContainerType.java │ │ ├── SinglePalettedContainer.java │ │ ├── PalettedContainer.java │ │ └── PaddedPalettedContainer.java │ ├── FlexibleStorage.java │ └── BlockStorage.java │ ├── HideFlag.java │ ├── PlotSquaredListener.java │ ├── PlotHiderPlugin.java │ └── PacketHandler.java ├── .gitignore ├── HEADER.txt ├── README.md ├── gradlew.bat ├── gradlew └── LICENSE /.github/release-drafter.yml: -------------------------------------------------------------------------------- 1 | _extends: .github 2 | -------------------------------------------------------------------------------- /.github/CODEOWNERS: -------------------------------------------------------------------------------- 1 | * @IntellectualSites/plotsquared-team 2 | -------------------------------------------------------------------------------- /settings.gradle.kts: -------------------------------------------------------------------------------- 1 | rootProject.name = "plothider" 2 | 3 | enableFeaturePreview("TYPESAFE_PROJECT_ACCESSORS") 4 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/IntellectualSites/plothider/HEAD/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /src/main/resources/lang/messages_en.json: -------------------------------------------------------------------------------- 1 | { 2 | "flags.flag_description_hide": "Set to `true` to hide the plot from other players." 3 | } 4 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_STORE 2 | .gradle/ 3 | build/ 4 | *.iml 5 | *.idea 6 | */.classpath 7 | */.project 8 | */.settings 9 | */bin 10 | */*.jar 11 | */lib/spigot*.jar 12 | */libs/spigot*.jar 13 | */dist/lib/spigot*.jar 14 | */build 15 | */nbproject 16 | *.prefs 17 | *.class 18 | .project 19 | /bin -------------------------------------------------------------------------------- /.github/renovate.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://docs.renovatebot.com/renovate-schema.json", 3 | "extends": [ 4 | "config:recommended", 5 | ":semanticCommitsDisabled" 6 | ], 7 | "automerge": true, 8 | "labels": [ 9 | "Renovate" 10 | ], 11 | "rebaseWhen": "conflicted" 12 | } 13 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionBase=GRADLE_USER_HOME 2 | distributionPath=wrapper/dists 3 | distributionUrl=https\://services.gradle.org/distributions/gradle-9.2.1-bin.zip 4 | networkTimeout=10000 5 | validateDistributionUrl=true 6 | zipStoreBase=GRADLE_USER_HOME 7 | zipStorePath=wrapper/dists 8 | -------------------------------------------------------------------------------- /.github/workflows/release-drafter.yml: -------------------------------------------------------------------------------- 1 | name: draft release 2 | on: 3 | push: 4 | branches: 5 | - main 6 | jobs: 7 | update_release_draft: 8 | if: ${{ github.event_name != 'pull_request' || github.repository != github.event.pull_request.head.repo.full_name }} 9 | runs-on: ubuntu-latest 10 | steps: 11 | - uses: release-drafter/release-drafter@v6 12 | env: 13 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 14 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/config.yml: -------------------------------------------------------------------------------- 1 | blank_issues_enabled: false 2 | contact_links: 3 | - name: IntellectualSites Discord 4 | url: https://discord.gg/intellectualsites 5 | about: Our support Discord, please ask questions and seek support here. 6 | - name: PlotSquared Wiki 7 | url: https://intellectualsites.github.io/plotsquared-documentation/ 8 | about: Take a look at the wiki page for instructions how to setup PlotSquared and use its commands. 9 | -------------------------------------------------------------------------------- /gradle/libs.versions.toml: -------------------------------------------------------------------------------- 1 | [versions] 2 | # Plugins 3 | worldedit = "7.3.17" 4 | protocollib = "5.4.0" 5 | 6 | # Third party 7 | bstats = "3.0.0" 8 | 9 | # Gradle plugins 10 | shadow = "9.2.2" 11 | spotless = "8.1.0" 12 | bukkityml = "0.6.0" 13 | minotaur = "2.8.10" 14 | 15 | [libraries] 16 | # Plugins 17 | worldedit = { group = "com.sk89q.worldedit", name = "worldedit-bukkit", version.ref = "worldedit" } 18 | protocollib = { group = "net.dmulloy2", name = "ProtocolLib", version.ref = "protocollib" } 19 | 20 | [plugins] 21 | shadow = { id = "com.gradleup.shadow", version.ref = "shadow" } 22 | spotless = { id = "com.diffplug.spotless", version.ref = "spotless" } 23 | pluginyml = { id = "net.minecrell.plugin-yml.bukkit", version.ref = "bukkityml" } 24 | minotaur = { id = "com.modrinth.minotaur", version.ref = "minotaur" } 25 | -------------------------------------------------------------------------------- /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | name: build 2 | on: [pull_request, push] 3 | jobs: 4 | build: 5 | if: ${{ github.event_name != 'pull_request' || github.repository != github.event.pull_request.head.repo.full_name }} 6 | runs-on: ubuntu-latest 7 | steps: 8 | - name: Checkout Repository 9 | uses: actions/checkout@v6 10 | - name: Validate Gradle Wrapper 11 | uses: gradle/wrapper-validation-action@v3 12 | - name: Setup Java 13 | uses: actions/setup-java@v5 14 | with: 15 | distribution: temurin 16 | java-version: 21 17 | - name: Clean Build 18 | run: ./gradlew clean build 19 | - name: Archive Artifacts 20 | uses: actions/upload-artifact@v6 21 | with: 22 | name: PlotHider-SNAPSHOT 23 | path: build/libs/*-SNAPSHOT.jar 24 | -------------------------------------------------------------------------------- /.github/workflows/codeql.yml: -------------------------------------------------------------------------------- 1 | name: "CodeQL" 2 | on: 3 | push: 4 | branches: [main] 5 | pull_request: 6 | # The branches below must be a subset of the branches above 7 | branches: [main] 8 | jobs: 9 | analyze: 10 | name: Analyze 11 | runs-on: ubuntu-latest 12 | permissions: 13 | actions: read 14 | contents: read 15 | security-events: write 16 | strategy: 17 | fail-fast: false 18 | matrix: 19 | language: ['java'] 20 | steps: 21 | - name: Checkout repository 22 | uses: actions/checkout@v6 23 | - name: Initialize CodeQL 24 | uses: github/codeql-action/init@v4 25 | with: 26 | languages: ${{ matrix.language }} 27 | - name: Autobuild 28 | uses: github/codeql-action/autobuild@v4 29 | - name: Perform CodeQL Analysis 30 | uses: github/codeql-action/analyze@v4 31 | -------------------------------------------------------------------------------- /HEADER.txt: -------------------------------------------------------------------------------- 1 | /* 2 | * PlotHider, an addon to hide plots for the PlotSquared plugin for Minecraft. 3 | * Copyright (C) IntellectualSites 4 | * Copyright (C) IntellectualSites team and contributors 5 | * 6 | * This program is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program. If not, see . 18 | */ 19 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # PlotHider 2 | This is an official PlotSquared addon which hides your plot. 3 | 4 | ## Installation 5 | 6 | ### Download PlotHider 7 | 8 | The download is available at [Modrinth](https://modrinth.com/plugin/plothider). 9 | 10 | This addon requires PlotSquared and ProtocolLib to be installed. You can get them below: 11 | 12 | - [PlotSquared](https://www.spigotmc.org/resources/77506/) 13 | - [ProtocolLib](https://www.spigotmc.org/resources/protocollib.1997/) 14 | 15 | ## Configuration 16 | 17 | You can set the `hide` flag on a per-plot or global basis. 18 | 19 | Invisible plots can be bypassed with the permission `plots.plothider.bypass`. 20 | 21 | ## Preview 22 | 23 | ![](http://i.imgur.com/yP6Now7.png) 24 | 25 | Support is available on [discord](https://discord.gg/intellectualsites) server. If you encounter an issue or want to add a feature, 26 | you are welcome to open an issue or raise a pull request. 27 | 28 | -------------------------------------------------------------------------------- /.github/workflows/upload-release-asset.yml: -------------------------------------------------------------------------------- 1 | name: Upload release assets 2 | on: 3 | release: 4 | types: [published] 5 | jobs: 6 | upload_asset: 7 | runs-on: ubuntu-latest 8 | steps: 9 | - name: Checkout Repository 10 | uses: actions/checkout@v6 11 | - name: Validate Gradle Wrapper 12 | uses: gradle/wrapper-validation-action@v3 13 | - name: Setup Java 14 | uses: actions/setup-java@v5 15 | with: 16 | distribution: temurin 17 | cache: gradle 18 | java-version: 21 19 | - name: Clean Build 20 | run: ./gradlew clean build 21 | - name: Upload Release Assets 22 | uses: AButler/upload-release-assets@v3.0 23 | with: 24 | files: 'build/libs/plothider-*.jar' 25 | repo-token: ${{ secrets.GITHUB_TOKEN }} 26 | release-tag: ${{ github.event.release.tag_name }} 27 | - name: Upload to Modrinth 28 | run: ./gradlew clean build modrinth publishAllPublicationsToHangar 29 | env: 30 | MODRINTH_TOKEN: ${{ secrets.MODRINTH_TOKEN }} 31 | -------------------------------------------------------------------------------- /.github/workflows/announce-release-on-discord.yml: -------------------------------------------------------------------------------- 1 | name: Announce release on discord 2 | on: 3 | release: 4 | types: [published] 5 | jobs: 6 | send_announcement: 7 | runs-on: ubuntu-latest 8 | steps: 9 | - name: send custom message with args 10 | env: 11 | DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }} 12 | DISCORD_USERNAME: PlotHider Release 13 | uses: Ilshidur/action-discord@0.4.0 14 | with: 15 | args: | 16 | "<@&673138796690276352>" 17 | "" 18 | "<:plothider:730750385177886820> **PlotHider ${{ github.event.release.tag_name }} has been released!**" 19 | "" 20 | "Click here to view changelog: https://github.com/IntellectualSites/plothider/releases/tag/${{ github.event.release.tag_name }}" 21 | "" 22 | "The primary download is available at Modrinth: " 23 | "" 24 | "An alternative download is available at:" 25 | "- Spigot: " 26 | -------------------------------------------------------------------------------- /src/main/java/com/plotsquared/plothider/storage/palette/PalettedContainerType.java: -------------------------------------------------------------------------------- 1 | /* 2 | * PlotHider, an addon to hide plots for the PlotSquared plugin for Minecraft. 3 | * Copyright (C) IntellectualSites 4 | * Copyright (C) IntellectualSites team and contributors 5 | * 6 | * This program is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program. If not, see . 18 | */ 19 | package com.plotsquared.plothider.storage.palette; 20 | 21 | public enum PalettedContainerType { 22 | 23 | BLOCKS, 24 | BIOMES 25 | 26 | } 27 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.yml: -------------------------------------------------------------------------------- 1 | name: Feature request 2 | description: Suggest an idea for this project 3 | labels: 'Enhancement' 4 | 5 | body: 6 | - type: markdown 7 | attributes: 8 | value: | 9 | Thanks for taking the time to fill out this feature request for PlotHider! Fill out the following form to your best ability to help us understand your feature request and greately improve the change of it getting added. 10 | For anything else than a feature request, use: [our Discord server](https://discord.gg/intellectualsites) or [the wiki](https://intellectualsites.github.io/plotsquared-documentation/). 11 | - type: textarea 12 | attributes: 13 | label: What feature do you want to see added? 14 | description: A clear and concise description of your feature request. 15 | validations: 16 | required: true 17 | 18 | - type: textarea 19 | attributes: 20 | label: Are there any alternatives? 21 | description: List any alternatives you might have tried 22 | validations: 23 | required: true 24 | 25 | - type: textarea 26 | attributes: 27 | label: Anything else? 28 | description: You can provide additional context below. 29 | -------------------------------------------------------------------------------- /src/main/java/com/plotsquared/plothider/storage/palette/SinglePalettedContainer.java: -------------------------------------------------------------------------------- 1 | /* 2 | * PlotHider, an addon to hide plots for the PlotSquared plugin for Minecraft. 3 | * Copyright (C) IntellectualSites 4 | * Copyright (C) IntellectualSites team and contributors 5 | * 6 | * This program is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program. If not, see . 18 | */ 19 | package com.plotsquared.plothider.storage.palette; 20 | 21 | import java.util.List; 22 | 23 | /** 24 | * Single-valued palette container implementation. 25 | * 26 | * @since TODO 27 | */ 28 | public class SinglePalettedContainer extends PalettedContainer { 29 | 30 | public SinglePalettedContainer(PalettedContainerType palettedContainerType, byte bitsPerEntry, List states, long[] data) { 31 | super(palettedContainerType, bitsPerEntry, states, data); 32 | } 33 | 34 | @Override 35 | public int get(int index) { 36 | return 0; 37 | } 38 | 39 | @Override 40 | public void set(int index, int value) { 41 | this.states.set(0, value); 42 | } 43 | } 44 | -------------------------------------------------------------------------------- /src/main/java/com/plotsquared/plothider/HideFlag.java: -------------------------------------------------------------------------------- 1 | /* 2 | * PlotHider, an addon to hide plots for the PlotSquared plugin for Minecraft. 3 | * Copyright (C) IntellectualSites 4 | * Copyright (C) IntellectualSites team and contributors 5 | * 6 | * This program is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program. If not, see . 18 | */ 19 | package com.plotsquared.plothider; 20 | 21 | import com.plotsquared.core.configuration.caption.TranslatableCaption; 22 | import com.plotsquared.core.plot.flag.types.BooleanFlag; 23 | import org.jetbrains.annotations.NotNull; 24 | 25 | public class HideFlag extends BooleanFlag { 26 | 27 | public static final HideFlag HIDE_FLAG_TRUE = new HideFlag(true); 28 | public static final HideFlag HIDE_FLAG_FALSE = new HideFlag(false); 29 | 30 | private HideFlag(boolean value) { 31 | super(value, TranslatableCaption.of(PlotHiderPlugin.PLOT_HIDER_NAMESPACE, "flags.flag_description_hide")); 32 | } 33 | 34 | @Override 35 | protected HideFlag flagOf(@NotNull Boolean value) { 36 | return value ? HIDE_FLAG_TRUE : HIDE_FLAG_FALSE; 37 | } 38 | 39 | } 40 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @rem 2 | @rem Copyright 2015 the original author or authors. 3 | @rem 4 | @rem Licensed under the Apache License, Version 2.0 (the "License"); 5 | @rem you may not use this file except in compliance with the License. 6 | @rem You may obtain a copy of the License at 7 | @rem 8 | @rem https://www.apache.org/licenses/LICENSE-2.0 9 | @rem 10 | @rem Unless required by applicable law or agreed to in writing, software 11 | @rem distributed under the License is distributed on an "AS IS" BASIS, 12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | @rem See the License for the specific language governing permissions and 14 | @rem limitations under the License. 15 | @rem 16 | @rem SPDX-License-Identifier: Apache-2.0 17 | @rem 18 | 19 | @if "%DEBUG%"=="" @echo off 20 | @rem ########################################################################## 21 | @rem 22 | @rem Gradle startup script for Windows 23 | @rem 24 | @rem ########################################################################## 25 | 26 | @rem Set local scope for the variables with windows NT shell 27 | if "%OS%"=="Windows_NT" setlocal 28 | 29 | set DIRNAME=%~dp0 30 | if "%DIRNAME%"=="" set DIRNAME=. 31 | @rem This is normally unused 32 | set APP_BASE_NAME=%~n0 33 | set APP_HOME=%DIRNAME% 34 | 35 | @rem Resolve any "." and ".." in APP_HOME to make it shorter. 36 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi 37 | 38 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 39 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" 40 | 41 | @rem Find java.exe 42 | if defined JAVA_HOME goto findJavaFromJavaHome 43 | 44 | set JAVA_EXE=java.exe 45 | %JAVA_EXE% -version >NUL 2>&1 46 | if %ERRORLEVEL% equ 0 goto execute 47 | 48 | echo. 1>&2 49 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 50 | echo. 1>&2 51 | echo Please set the JAVA_HOME variable in your environment to match the 1>&2 52 | echo location of your Java installation. 1>&2 53 | 54 | goto fail 55 | 56 | :findJavaFromJavaHome 57 | set JAVA_HOME=%JAVA_HOME:"=% 58 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 59 | 60 | if exist "%JAVA_EXE%" goto execute 61 | 62 | echo. 1>&2 63 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 64 | echo. 1>&2 65 | echo Please set the JAVA_HOME variable in your environment to match the 1>&2 66 | echo location of your Java installation. 1>&2 67 | 68 | goto fail 69 | 70 | :execute 71 | @rem Setup the command line 72 | 73 | 74 | 75 | @rem Execute Gradle 76 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %* 77 | 78 | :end 79 | @rem End local scope for the variables with windows NT shell 80 | if %ERRORLEVEL% equ 0 goto mainEnd 81 | 82 | :fail 83 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 84 | rem the _cmd.exe /c_ return code! 85 | set EXIT_CODE=%ERRORLEVEL% 86 | if %EXIT_CODE% equ 0 set EXIT_CODE=1 87 | if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% 88 | exit /b %EXIT_CODE% 89 | 90 | :mainEnd 91 | if "%OS%"=="Windows_NT" endlocal 92 | 93 | :omega 94 | -------------------------------------------------------------------------------- /src/main/java/com/plotsquared/plothider/storage/FlexibleStorage.java: -------------------------------------------------------------------------------- 1 | /* 2 | * PlotHider, an addon to hide plots for the PlotSquared plugin for Minecraft. 3 | * Copyright (C) IntellectualSites 4 | * Copyright (C) IntellectualSites team and contributors 5 | * 6 | * This program is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program. If not, see . 18 | */ 19 | package com.plotsquared.plothider.storage; 20 | 21 | import com.plotsquared.plothider.storage.palette.PalettedContainer; 22 | import com.plotsquared.plothider.storage.palette.PalettedContainerType; 23 | 24 | import java.io.ByteArrayOutputStream; 25 | import java.util.List; 26 | import java.util.Objects; 27 | 28 | public class FlexibleStorage { 29 | 30 | private PalettedContainer blocksPalletedContainer; 31 | private PalettedContainer biomesPalletedContainer; 32 | 33 | public FlexibleStorage() { 34 | this.blocksPalletedContainer = null; 35 | this.biomesPalletedContainer = null; 36 | } 37 | 38 | public FlexibleStorage(byte bitsPerEntry, List states, int bytes) { 39 | this(bitsPerEntry, states, new long[(bytes + ((char) (64 / PalettedContainer.getRealUsedBits(bitsPerEntry))) - 1) 40 | / ((char) (64 / PalettedContainer.getRealUsedBits(bitsPerEntry)))]); 41 | } 42 | 43 | public FlexibleStorage(byte bitsPerEntry, List states, long[] data) { 44 | this.blocksPalletedContainer = PalettedContainer.build(PalettedContainerType.BLOCKS, bitsPerEntry, states, data); 45 | this.biomesPalletedContainer = null; 46 | } 47 | 48 | public PalettedContainer getBlocksPalletedContainer() { 49 | return blocksPalletedContainer; 50 | } 51 | 52 | public PalettedContainer getBiomesPalletedContainer() { 53 | return biomesPalletedContainer; 54 | } 55 | 56 | public void setBlocksPalletedContainer(PalettedContainer blocksPalletedContainer) { 57 | this.blocksPalletedContainer = blocksPalletedContainer; 58 | } 59 | 60 | public void setBiomesPalletedContainer(PalettedContainer biomesPalletedContainer) { 61 | this.biomesPalletedContainer = biomesPalletedContainer; 62 | } 63 | 64 | public void write(ByteArrayOutputStream out) { 65 | this.blocksPalletedContainer.write(out); 66 | 67 | if (biomesPalletedContainer != null) 68 | this.biomesPalletedContainer.write(out); 69 | } 70 | 71 | @Override 72 | public boolean equals(Object o) { 73 | if (this == o) 74 | return true; 75 | if (!(o instanceof FlexibleStorage that)) 76 | return false; 77 | return blocksPalletedContainer.equals(that.blocksPalletedContainer) 78 | && biomesPalletedContainer.equals(that.biomesPalletedContainer); 79 | } 80 | 81 | @Override 82 | public int hashCode() { 83 | return Objects.hash(blocksPalletedContainer, biomesPalletedContainer); 84 | } 85 | } 86 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.yml: -------------------------------------------------------------------------------- 1 | name: Bug report 2 | description: Create a report to help us improve 3 | labels: 'Requires Testing' 4 | 5 | body: 6 | - type: markdown 7 | attributes: 8 | value: | 9 | Thanks for taking the time to fill out this bug report for PlotHider! Fill out the following form to your best ability to help us fix the problem. 10 | Only use this if you're absolutely sure that you found a bug and can reproduce it. For anything else, use: [our Discord server](https://discord.gg/intellectualsites) or [the wiki](https://intellectualsites.github.io/plotsquared-documentation/). 11 | Do NOT use the public issue tracker to report security vulnerabilities! They are disclosed using [this](https://github.com/IntellectualSites/plothider/security/policy) GitHub form! 12 | 13 | - type: dropdown 14 | attributes: 15 | label: Server Implementation 16 | description: Which server Implementation are you using? If your server implementation is not listed, it is not supported. Switch to a supported version first. 17 | multiple: false 18 | options: 19 | - Paper 20 | - Spigot 21 | validations: 22 | required: true 23 | 24 | - type: dropdown 25 | attributes: 26 | label: Server Version 27 | description: Which server version version you using? If your server version is not listed, it is not supported. Update to a supported version first. 28 | multiple: false 29 | options: 30 | - '1.20.1' 31 | - '1.19.4' 32 | - '1.18.2' 33 | - '1.17.1' 34 | - '1.16.5' 35 | validations: 36 | required: true 37 | 38 | - type: textarea 39 | attributes: 40 | label: Describe the bug 41 | description: A clear and concise description of what the bug is. 42 | validations: 43 | required: true 44 | 45 | - type: textarea 46 | attributes: 47 | label: To Reproduce 48 | description: Steps to reproduce this behaviour 49 | placeholder: | 50 | 1. Go to '...' 51 | 2. Click on '...' 52 | 3. Scroll down to '...' 53 | 4. See error 54 | validations: 55 | required: true 56 | 57 | - type: textarea 58 | attributes: 59 | label: Expected behaviour 60 | description: A clear and concise description of what you expected to happen. 61 | validations: 62 | required: true 63 | 64 | - type: textarea 65 | attributes: 66 | label: Screenshots / Videos 67 | description: If applicable, add screenshots to help explain your problem. 68 | 69 | - type: input 70 | attributes: 71 | label: Error log (if applicable) 72 | description: If you are reporting a console error, upload any relevant log excerpts to either https://paste.gg/ or https://gist.github.com, save and the paste the link in this box. 73 | 74 | - type: input 75 | attributes: 76 | label: Plot Debugpaste 77 | description: Run `/plot debugpaste` in your console or ingame and provide the output link here. 78 | validations: 79 | required: true 80 | 81 | - type: input 82 | attributes: 83 | label: PlotHider Version 84 | description: What version of PlotHider are you running? (`/version PlotHider`) 85 | placeholder: "For example: PlotHider version 5.0.0" 86 | validations: 87 | required: true 88 | 89 | - type: checkboxes 90 | attributes: 91 | label: Checklist 92 | description: Make sure you have followed each of the steps outlined here. 93 | options: 94 | - label: I have included a Plot debugpaste. 95 | required: true 96 | - label: I am using the newest build from https://www.spigotmc.org/resources/20701/ and the issue still persists. 97 | required: true 98 | 99 | - type: textarea 100 | attributes: 101 | label: Anything else? 102 | description: You can provide additional context below. 103 | -------------------------------------------------------------------------------- /src/main/java/com/plotsquared/plothider/PlotSquaredListener.java: -------------------------------------------------------------------------------- 1 | /* 2 | * PlotHider, an addon to hide plots for the PlotSquared plugin for Minecraft. 3 | * Copyright (C) IntellectualSites 4 | * Copyright (C) IntellectualSites team and contributors 5 | * 6 | * This program is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program. If not, see . 18 | */ 19 | package com.plotsquared.plothider; 20 | 21 | import com.google.common.eventbus.Subscribe; 22 | import com.plotsquared.core.PlotAPI; 23 | import com.plotsquared.core.events.*; 24 | import com.plotsquared.core.location.Location; 25 | import com.plotsquared.core.plot.Plot; 26 | import com.plotsquared.core.util.task.TaskManager; 27 | import com.plotsquared.core.util.task.TaskTime; 28 | import org.bukkit.World; 29 | import org.bukkit.event.Listener; 30 | 31 | public class PlotSquaredListener implements Listener { 32 | 33 | public static final PlotAPI PLOT_API; 34 | 35 | static { 36 | PLOT_API = new PlotAPI(); 37 | } 38 | 39 | public PlotSquaredListener() { 40 | PLOT_API.registerListener(this); 41 | } 42 | 43 | @Subscribe 44 | public void onPlayerPlotDeniedEvent(PlayerPlotDeniedEvent event) { 45 | Plot plot = event.getPlot(); 46 | if (plot.getFlag(HideFlag.class)) { 47 | refreshPlot(event.getPlot()); 48 | } 49 | } 50 | 51 | @Subscribe 52 | public void onPlayerPlotTrusted(PlayerPlotTrustedEvent event) { 53 | Plot plot = event.getPlot(); 54 | if (plot.getFlag(HideFlag.class)) { 55 | refreshPlot(plot); 56 | } 57 | } 58 | 59 | @Subscribe 60 | public void onPlayerPlotHelperEvent(PlayerPlotHelperEvent event) { 61 | Plot plot = event.getPlot(); 62 | if (plot.getFlag(HideFlag.class)) { 63 | refreshPlot(plot); 64 | } 65 | } 66 | 67 | @Subscribe 68 | public void onPlotFlagAddEvent(PlotFlagAddEvent event) { 69 | Plot plot = event.getPlot(); 70 | if (event.getFlag() instanceof HideFlag) { 71 | // Waits a bit because the flag is added after the event call. 72 | TaskManager.runTaskLater(() -> refreshPlot(plot), TaskTime.ticks(1)); 73 | } 74 | } 75 | 76 | @Subscribe 77 | public void onPlotFlagRemoveEvent(PlotFlagRemoveEvent event) { 78 | Plot plot = event.getPlot(); 79 | if (event.getFlag() instanceof HideFlag) { 80 | // Waits a bit because the flag is removed after the event call. 81 | TaskManager.runTaskLater(() -> refreshPlot(plot), TaskTime.ticks(1)); 82 | } 83 | } 84 | 85 | private void refreshPlot(Plot plot) { 86 | int regionBottomCornerX = plot.getBottomAbs().getX(); 87 | int regionBottomCornerZ = plot.getBottomAbs().getZ(); 88 | int regionTopCornerX = plot.getTopAbs().getX(); 89 | int regionTopCornerZ = plot.getTopAbs().getZ(); 90 | 91 | for (Plot connectedPlot : plot.getConnectedPlots()) { 92 | Location bottomCorner = connectedPlot.getBottomAbs(); 93 | Location topCorner = connectedPlot.getTopAbs(); 94 | 95 | if (bottomCorner.getX() < regionBottomCornerX) { 96 | regionBottomCornerX = bottomCorner.getX(); 97 | } 98 | if (bottomCorner.getZ() < regionBottomCornerZ) { 99 | regionBottomCornerZ = bottomCorner.getZ(); 100 | } 101 | if (topCorner.getX() > regionTopCornerX) { 102 | regionTopCornerX = topCorner.getX(); 103 | } 104 | if (topCorner.getZ() > regionTopCornerZ) { 105 | regionTopCornerZ = topCorner.getZ(); 106 | } 107 | } 108 | 109 | World world = (World) plot.getBottomAbs().getWorld().getPlatformWorld(); 110 | int fromChunkX = regionBottomCornerX >> 4; 111 | int fromChunkZ = regionBottomCornerZ >> 4; 112 | int toChunkX = regionTopCornerX >> 4; 113 | int toChunkZ = regionTopCornerZ >> 4; 114 | 115 | for (int x = fromChunkX; x <= toChunkX; x++) { 116 | for (int z = fromChunkZ; z <= toChunkZ; z++) { 117 | // Triggers a MapChunk packet, later handled by PlotHider's packet listener. 118 | world.refreshChunk(x, z); 119 | } 120 | } 121 | } 122 | 123 | } 124 | -------------------------------------------------------------------------------- /src/main/java/com/plotsquared/plothider/storage/palette/PalettedContainer.java: -------------------------------------------------------------------------------- 1 | /* 2 | * PlotHider, an addon to hide plots for the PlotSquared plugin for Minecraft. 3 | * Copyright (C) IntellectualSites 4 | * Copyright (C) IntellectualSites team and contributors 5 | * 6 | * This program is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program. If not, see . 18 | */ 19 | package com.plotsquared.plothider.storage.palette; 20 | 21 | import com.plotsquared.plothider.storage.BlockStorage; 22 | 23 | import java.io.ByteArrayOutputStream; 24 | import java.util.Arrays; 25 | import java.util.List; 26 | import java.util.Objects; 27 | 28 | /** 29 | * Abstract class for the implementation of a palette container storage. 30 | * This format is used by Minecraft to store various elements such as blocks and biome in chunk sections. 31 | * 32 | * @since TODO 33 | */ 34 | public abstract class PalettedContainer { 35 | 36 | public static final int CHUNK_SECTION_SIZE = 16 * 16 * 16; 37 | public static final int BIOME_SECTION_SIZE = 4 * 4 * 4; 38 | public static final byte DIRECT_PALETTE_SIZE = 14; 39 | public static final int AIR = 0; 40 | 41 | protected final PalettedContainerType palettedContainerType; 42 | protected byte bitsPerEntry; 43 | protected final List states; 44 | protected final long[] data; 45 | 46 | protected int size; 47 | protected final long maxEntryValue; 48 | 49 | public PalettedContainer(PalettedContainerType palettedContainerType, byte bitsPerEntry, List states, long[] data) { 50 | // Yes, bitsPerEntry may be equal to 0. https://wiki.vg/Chunk_Format#Data_structure 51 | if ((bitsPerEntry < 0)) { 52 | throw new IllegalArgumentException( 53 | "BitsPerEntry cannot be outside of accepted range. " + bitsPerEntry); 54 | } 55 | this.palettedContainerType = palettedContainerType; 56 | this.bitsPerEntry = bitsPerEntry; 57 | this.states = states; 58 | this.data = data; 59 | 60 | this.size = palettedContainerType == PalettedContainerType.BLOCKS 61 | ? PalettedContainer.CHUNK_SECTION_SIZE 62 | : PalettedContainer.BIOME_SECTION_SIZE; 63 | this.maxEntryValue = ((1L << this.bitsPerEntry) - 1); 64 | } 65 | 66 | public byte getBitsPerEntry() { 67 | return bitsPerEntry; 68 | } 69 | 70 | public byte getRealUsedBitsPerEntry() { 71 | return getRealUsedBits(this.bitsPerEntry); 72 | } 73 | 74 | public List getStates() { 75 | return states; 76 | } 77 | 78 | public int getSize() { 79 | return size; 80 | } 81 | 82 | public abstract int get(int index); 83 | 84 | public abstract void set(int index, int value); 85 | 86 | public void write(ByteArrayOutputStream out) { 87 | out.write(this.bitsPerEntry); 88 | if (this.bitsPerEntry <= 8) { 89 | if (this.bitsPerEntry == 0) { 90 | BlockStorage.writeVarInt(out, this.states.get(0)); 91 | } else { 92 | BlockStorage.writeVarInt(out, this.states.size()); 93 | for (int state : this.states) { 94 | BlockStorage.writeVarInt(out, state); 95 | } 96 | } 97 | } 98 | BlockStorage.writeVarInt(out, data.length); 99 | BlockStorage.writeLongs(out, data); 100 | } 101 | 102 | @Override 103 | public boolean equals(Object o) { 104 | if (this == o) 105 | return true; 106 | if (!(o instanceof PalettedContainer that)) 107 | return false; 108 | return bitsPerEntry == that.bitsPerEntry && size == that.size && maxEntryValue == that.maxEntryValue 109 | && palettedContainerType == that.palettedContainerType && states.equals(that.states) 110 | && Arrays.equals(data, that.data); 111 | } 112 | 113 | @Override 114 | public int hashCode() { 115 | int result = Objects.hash(palettedContainerType, bitsPerEntry, states, size, maxEntryValue); 116 | result = 31 * result + Arrays.hashCode(data); 117 | return result; 118 | } 119 | 120 | public static PalettedContainer build(PalettedContainerType palettedContainerType, byte bitsPerEntry, List states, long[] data) { 121 | // Special case for single-valued palette. 122 | if (bitsPerEntry == 0) 123 | return new SinglePalettedContainer(palettedContainerType, bitsPerEntry, states, data); 124 | 125 | // 1.16+ 126 | return new PaddedPalettedContainer(palettedContainerType, bitsPerEntry, states, data); 127 | } 128 | 129 | public static byte getRealUsedBits(byte bits) { 130 | if (bits == 0) 131 | return 0; 132 | if (bits > 8) 133 | return DIRECT_PALETTE_SIZE; 134 | 135 | return bits; 136 | } 137 | } 138 | -------------------------------------------------------------------------------- /src/main/java/com/plotsquared/plothider/PlotHiderPlugin.java: -------------------------------------------------------------------------------- 1 | /* 2 | * PlotHider, an addon to hide plots for the PlotSquared plugin for Minecraft. 3 | * Copyright (C) IntellectualSites 4 | * Copyright (C) IntellectualSites team and contributors 5 | * 6 | * This program is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program. If not, see . 18 | */ 19 | package com.plotsquared.plothider; 20 | 21 | import com.comphenix.protocol.ProtocolLibrary; 22 | import com.plotsquared.bukkit.util.BukkitUtil; 23 | import com.plotsquared.core.PlotSquared; 24 | import com.plotsquared.core.configuration.Settings; 25 | import com.plotsquared.core.configuration.caption.CaptionMap; 26 | import com.plotsquared.core.configuration.caption.load.CaptionLoader; 27 | import com.plotsquared.core.configuration.caption.load.DefaultCaptionProvider; 28 | import com.plotsquared.core.player.PlotPlayer; 29 | import com.plotsquared.core.plot.Plot; 30 | import com.plotsquared.core.plot.flag.GlobalFlagContainer; 31 | import org.bstats.bukkit.Metrics; 32 | import org.bukkit.Bukkit; 33 | import org.bukkit.Location; 34 | import org.bukkit.entity.Player; 35 | import org.bukkit.event.EventHandler; 36 | import org.bukkit.event.Listener; 37 | import org.bukkit.event.player.PlayerTeleportEvent; 38 | import org.bukkit.plugin.java.JavaPlugin; 39 | 40 | import java.io.IOException; 41 | import java.nio.file.Files; 42 | import java.nio.file.Path; 43 | import java.util.Locale; 44 | import java.util.logging.Level; 45 | import java.util.regex.Pattern; 46 | 47 | public class PlotHiderPlugin extends JavaPlugin implements Listener { 48 | 49 | public static final String PLOT_HIDER_NAMESPACE = "plothider"; 50 | private static final int BSTATS_ID = 6412; 51 | 52 | @SuppressWarnings("deprecation") // Paper deprecation 53 | @Override 54 | public void onEnable() { 55 | // Check based on #startsWith because plugin version contains the build number. 56 | if (!ProtocolLibrary.getPlugin().getDescription().getVersion().startsWith("5")) { 57 | getLogger().log(Level.SEVERE, "ProtocolLib 5 is required to run " + 58 | "PlotHider, please install the latest update:"); 59 | getLogger().log(Level.INFO, "https://www.spigotmc.org/resources/protocollib.1997/"); 60 | Bukkit.getPluginManager().disablePlugin(this); 61 | return; 62 | } 63 | 64 | new PacketHandler(this); 65 | Bukkit.getPluginManager().registerEvents(this, this); 66 | new PlotSquaredListener(); 67 | GlobalFlagContainer.getInstance().addFlag(HideFlag.HIDE_FLAG_FALSE); 68 | try { 69 | loadCaptions(); 70 | } catch (IOException e) { 71 | getLogger().log(Level.SEVERE, "Failed to load captions", e); 72 | } 73 | new Metrics(this, BSTATS_ID); 74 | } 75 | 76 | private void loadCaptions() throws IOException { 77 | Path msgFilePath = getDataFolder().toPath().resolve("lang").resolve("messages_en.json"); 78 | if (!Files.exists(msgFilePath)) { 79 | this.saveResource("lang/messages_en.json", false); 80 | } 81 | CaptionLoader captionLoader = CaptionLoader.of( 82 | Locale.ENGLISH, 83 | CaptionLoader.patternExtractor(Pattern.compile("messages_(.*)\\.json")), 84 | DefaultCaptionProvider.forClassLoaderFormatString( 85 | this.getClass().getClassLoader(), 86 | "lang/messages_%s.json" 87 | ), 88 | PLOT_HIDER_NAMESPACE 89 | ); 90 | CaptionMap captionMap; 91 | if (Settings.Enabled_Components.PER_USER_LOCALE) { 92 | captionMap = captionLoader.loadAll(getDataFolder().toPath().resolve("lang")); 93 | } else { 94 | String fileName = "messages_" + Settings.Enabled_Components.DEFAULT_LOCALE + ".json"; 95 | captionMap = captionLoader.loadSingle(getDataFolder().toPath().resolve("lang").resolve(fileName)); 96 | } 97 | PlotSquared.get().registerCaptionMap(PLOT_HIDER_NAMESPACE, captionMap); 98 | getLogger().info("Loaded caption map for namespace '" + PLOT_HIDER_NAMESPACE + "': " 99 | + captionMap.getClass().getCanonicalName()); 100 | } 101 | 102 | @EventHandler 103 | public void onTeleport(PlayerTeleportEvent event) { 104 | Player player = event.getPlayer(); 105 | PlotPlayer plotPlayer = BukkitUtil.adapt(player); 106 | if (plotPlayer.hasPermission("plots.plothider.bypass")) { 107 | return; 108 | } 109 | Plot plot = plotPlayer.getCurrentPlot(); 110 | if (plot != null && (plot.isDenied(plotPlayer.getUUID()) || (!plot.isAdded(plotPlayer.getUUID()) && plot 111 | .getFlag(HideFlag.class)))) { 112 | Location to = event.getTo(); 113 | Location from = event.getFrom(); 114 | if (to.getWorld() == from.getWorld() && to.distanceSquared(from) < 8.0D) { 115 | event.setTo(player.getLocation()); 116 | event.setCancelled(true); 117 | player.setVelocity(player.getVelocity()); 118 | } 119 | } 120 | } 121 | } 122 | -------------------------------------------------------------------------------- /src/main/java/com/plotsquared/plothider/storage/palette/PaddedPalettedContainer.java: -------------------------------------------------------------------------------- 1 | /* 2 | * PlotHider, an addon to hide plots for the PlotSquared plugin for Minecraft. 3 | * Copyright (C) IntellectualSites 4 | * Copyright (C) IntellectualSites team and contributors 5 | * 6 | * This program is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program. If not, see . 18 | */ 19 | package com.plotsquared.plothider.storage.palette; 20 | 21 | import java.util.List; 22 | import java.util.Objects; 23 | 24 | /** 25 | * Modern and padded palette container implementation. 26 | * Used by Minecraft 1.16+. 27 | * 28 | * @since TODO 29 | */ 30 | public class PaddedPalettedContainer extends PalettedContainer { 31 | 32 | private static final int[] MAGIC = new int[]{-1, -1, 0, Integer.MIN_VALUE, 0, 0, 1431655765, 1431655765, 0, Integer.MIN_VALUE, 0, 1, 858993459, 858993459, 0, 715827882, 715827882, 0, 613566756, 613566756, 0, Integer.MIN_VALUE, 0, 2, 477218588, 477218588, 0, 429496729, 429496729, 0, 390451572, 390451572, 0, 357913941, 357913941, 0, 330382099, 330382099, 0, 306783378, 306783378, 0, 286331153, 286331153, 0, Integer.MIN_VALUE, 0, 3, 252645135, 252645135, 0, 238609294, 238609294, 0, 226050910, 226050910, 0, 214748364, 214748364, 0, 204522252, 204522252, 0, 195225786, 195225786, 0, 186737708, 186737708, 0, 178956970, 178956970, 0, 171798691, 171798691, 0, 165191049, 165191049, 0, 159072862, 159072862, 0, 153391689, 153391689, 0, 148102320, 148102320, 0, 143165576, 143165576, 0, 138547332, 138547332, 0, Integer.MIN_VALUE, 0, 4, 130150524, 130150524, 0, 126322567, 126322567, 0, 122713351, 122713351, 0, 119304647, 119304647, 0, 116080197, 116080197, 0, 113025455, 113025455, 0, 110127366, 110127366, 0, 107374182, 107374182, 0, 104755299, 104755299, 0, 102261126, 102261126, 0, 99882960, 99882960, 0, 97612893, 97612893, 0, 95443717, 95443717, 0, 93368854, 93368854, 0, 91382282, 91382282, 0, 89478485, 89478485, 0, 87652393, 87652393, 0, 85899345, 85899345, 0, 84215045, 84215045, 0, 82595524, 82595524, 0, 81037118, 81037118, 0, 79536431, 79536431, 0, 78090314, 78090314, 0, 76695844, 76695844, 0, 75350303, 75350303, 0, 74051160, 74051160, 0, 72796055, 72796055, 0, 71582788, 71582788, 0, 70409299, 70409299, 0, 69273666, 69273666, 0, 68174084, 68174084, 0, Integer.MIN_VALUE, 0, 5}; 33 | private final int valuesPerLong; 34 | private final int divideMul; 35 | private final long divideMulUnsigned; 36 | private final int divideAdd; 37 | private final long divideAddUnsigned; 38 | private final int divideShift; 39 | 40 | public PaddedPalettedContainer(PalettedContainerType palettedContainerType, byte bitsPerEntry, List states, long[] data) { 41 | super(palettedContainerType, bitsPerEntry, states, data); 42 | 43 | this.valuesPerLong = bitsPerEntry == 0 ? 64 : (char) (64 / getRealUsedBitsPerEntry()); 44 | 45 | int i = 3 * (this.valuesPerLong - 1); 46 | this.divideMul = MAGIC[i]; 47 | this.divideMulUnsigned = Integer.toUnsignedLong(this.divideMul); 48 | this.divideAdd = MAGIC[i + 1]; 49 | this.divideAddUnsigned = Integer.toUnsignedLong(this.divideAdd); 50 | this.divideShift = MAGIC[i + 2]; 51 | } 52 | 53 | @Override 54 | public int get(int index) { 55 | if ((index < 0) || (index >= this.size)) { 56 | throw new IndexOutOfBoundsException("Index " + index + " is < than 0 or >= than " + this.size + "."); 57 | } 58 | 59 | int bitIndex = this.cellIndex(index); 60 | long l = this.data[bitIndex]; 61 | int j = (index - bitIndex * this.valuesPerLong) * this.getRealUsedBitsPerEntry(); 62 | return (int) (l >> j & this.maxEntryValue); 63 | } 64 | 65 | @Override 66 | public void set(int index, int value) { 67 | if ((index < 0) || (index >= this.size)) { 68 | throw new IndexOutOfBoundsException("Index " + index + " is < than 0 or >= than " + this.size + "."); 69 | } 70 | if ((value < 0) || (value > this.maxEntryValue)) { 71 | throw new IllegalArgumentException("Value cannot be outside of accepted range."); 72 | } 73 | 74 | int bitIndex = this.cellIndex(index); 75 | long l = this.data[bitIndex]; 76 | int j = (index - bitIndex * this.valuesPerLong) * this.getRealUsedBitsPerEntry(); 77 | this.data[bitIndex] = l & ~(this.maxEntryValue << j) | ((long) value & this.maxEntryValue) << j; 78 | } 79 | 80 | private int cellIndex(int index) { 81 | return (int) ((long) index * this.divideMulUnsigned + this.divideAddUnsigned >> 32 >> this.divideShift); 82 | } 83 | 84 | @Override 85 | public boolean equals(Object o) { 86 | if (this == o) 87 | return true; 88 | if (!(o instanceof PaddedPalettedContainer that) || !super.equals(o)) 89 | return false; 90 | return valuesPerLong == that.valuesPerLong && divideMul == that.divideMul 91 | && divideMulUnsigned == that.divideMulUnsigned && divideAdd == that.divideAdd 92 | && divideAddUnsigned == that.divideAddUnsigned && divideShift == that.divideShift; 93 | } 94 | 95 | @Override 96 | public int hashCode() { 97 | return Objects.hash(valuesPerLong, divideMul, divideMulUnsigned, divideAdd, divideAddUnsigned, divideShift); 98 | } 99 | } 100 | -------------------------------------------------------------------------------- /src/main/java/com/plotsquared/plothider/storage/BlockStorage.java: -------------------------------------------------------------------------------- 1 | /* 2 | * PlotHider, an addon to hide plots for the PlotSquared plugin for Minecraft. 3 | * Copyright (C) IntellectualSites 4 | * Copyright (C) IntellectualSites team and contributors 5 | * 6 | * This program is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program. If not, see . 18 | */ 19 | package com.plotsquared.plothider.storage; 20 | 21 | import com.plotsquared.plothider.storage.palette.PalettedContainer; 22 | import com.plotsquared.plothider.storage.palette.PalettedContainerType; 23 | 24 | import java.io.ByteArrayInputStream; 25 | import java.io.ByteArrayOutputStream; 26 | import java.io.IOException; 27 | import java.io.InputStream; 28 | import java.util.ArrayList; 29 | import java.util.List; 30 | import java.util.Objects; 31 | 32 | public class BlockStorage { 33 | private short blockCount; 34 | private FlexibleStorage storage; 35 | 36 | public BlockStorage(short blockCount) { 37 | this.blockCount = blockCount; 38 | this.storage = new FlexibleStorage(); 39 | } 40 | 41 | public void write(ByteArrayOutputStream out) { 42 | writeShort(out, this.blockCount); 43 | storage.write(out); 44 | } 45 | 46 | public void read(ByteArrayInputStream buffer, PalettedContainerType palettedContainerType) { 47 | try { 48 | // First part, Block states, as a Paletted Container. 49 | byte bitsPerEntry = (byte) buffer.read(); 50 | 51 | ArrayList states = new ArrayList<>(); 52 | if (bitsPerEntry <= 8) { 53 | // bitsPerBlock == 0 is an edge case to handle. 54 | if (bitsPerEntry == 0) { 55 | int palette = readVarInt(buffer); 56 | states.add(palette); 57 | } else { 58 | int paletteLength = readVarInt(buffer); 59 | states.ensureCapacity(paletteLength); 60 | for (int i = 0; i < paletteLength; i++) { 61 | states.add(readVarInt(buffer)); 62 | } 63 | } 64 | } 65 | 66 | int dataArrayLength = readVarInt(buffer); 67 | 68 | // Read the actual (compressed) block data. 69 | long[] data = BlockStorage.readLongs(buffer, dataArrayLength); 70 | 71 | PalettedContainer palettedContainer = PalettedContainer.build(palettedContainerType, bitsPerEntry, states, data); 72 | if (palettedContainerType == PalettedContainerType.BLOCKS) { 73 | storage.setBlocksPalletedContainer(palettedContainer); 74 | } else { 75 | storage.setBiomesPalletedContainer(palettedContainer); 76 | } 77 | } catch (Throwable e) { 78 | e.printStackTrace(); 79 | } 80 | } 81 | 82 | public int getBlock(int x, int y, int z) { 83 | PalettedContainer palettedContainer = this.storage.getBlocksPalletedContainer(); 84 | 85 | int id = palettedContainer.get(index(x, y, z)); 86 | return palettedContainer.getBitsPerEntry() <= 8 ? 87 | (id >= 0 && id < palettedContainer.getStates().size() 88 | ? palettedContainer.getStates().get(id) 89 | : PalettedContainer.AIR) : 90 | id; 91 | } 92 | 93 | public void setBlock(int x, int y, int z, int state) { 94 | PalettedContainer palettedContainer = this.storage.getBlocksPalletedContainer(); 95 | byte bitsPerEntry = palettedContainer.getBitsPerEntry(); 96 | 97 | int id = bitsPerEntry <= 8 98 | ? palettedContainer.getStates().indexOf(state) 99 | : state; 100 | if (id == -1) { 101 | palettedContainer.getStates().add(state); 102 | 103 | // Update storage if necessary. 104 | if (palettedContainer.getStates().size() > 1 << bitsPerEntry) { 105 | bitsPerEntry++; 106 | 107 | List oldStates = palettedContainer.getStates(); 108 | if (bitsPerEntry > 8) { 109 | oldStates = new ArrayList<>(palettedContainer.getStates()); 110 | palettedContainer.getStates().clear(); 111 | bitsPerEntry = PalettedContainer.DIRECT_PALETTE_SIZE; 112 | } 113 | FlexibleStorage oldStorage = this.storage; 114 | this.storage = new FlexibleStorage(bitsPerEntry, palettedContainer.getStates(), 115 | palettedContainer.getSize()); 116 | this.storage.setBiomesPalletedContainer(oldStorage.getBiomesPalletedContainer()); 117 | 118 | palettedContainer = this.storage.getBlocksPalletedContainer(); 119 | for (int index = 0; index < palettedContainer.getSize(); index++) { 120 | palettedContainer.set(index, 121 | bitsPerEntry <= 8 122 | ? oldStorage.getBlocksPalletedContainer().get(index) 123 | : oldStates.get(index)); 124 | } 125 | } 126 | 127 | // Update id. 128 | id = bitsPerEntry <= 8 ? palettedContainer.getStates().indexOf(state) : state; 129 | } 130 | 131 | // Make the changes. 132 | palettedContainer.set(index(x, y, z), id); 133 | 134 | if (state == PalettedContainer.AIR) 135 | blockCount--; 136 | } 137 | 138 | @Override 139 | public boolean equals(Object o) { 140 | if (this == o) 141 | return true; 142 | if (!(o instanceof BlockStorage that)) 143 | return false; 144 | return blockCount == that.blockCount && storage.equals(that.storage); 145 | } 146 | 147 | @Override 148 | public int hashCode() { 149 | return Objects.hash(blockCount, storage); 150 | } 151 | 152 | private static int index(int x, int y, int z) { 153 | return y << 8 | z << 4 | (x); 154 | } 155 | 156 | private static int readVarInt(InputStream stream) throws IOException { 157 | int i = 0; 158 | int j = 0; 159 | 160 | byte b0; 161 | do { 162 | b0 = (byte) stream.read(); 163 | i |= (b0 & 127) << j++ * 7; 164 | if (j > 5) { 165 | throw new RuntimeException("VarInt too big"); 166 | } 167 | } while ((b0 & 128) == 128); 168 | 169 | return i; 170 | } 171 | 172 | private static long[] readLongs(ByteArrayInputStream buffer, int length) { 173 | if (length < 0) { 174 | throw new IllegalArgumentException("Array cannot have length less than 0."); 175 | } 176 | 177 | long[] l = new long[length]; 178 | for (int index = 0; index < length; index++) { 179 | long result = 0; 180 | for (int i = 0; i < Long.BYTES; i++) { 181 | result |= (buffer.read() & 0xFFL) << (i << 3); 182 | } 183 | l[index] = Long.reverseBytes(result); // little endian to big endian conversion 184 | } 185 | 186 | return l; 187 | } 188 | 189 | public static void writeShort(ByteArrayOutputStream out, short s) { 190 | out.write((s >> 8) & 0xFF); 191 | out.write(s & 0xFF); 192 | } 193 | 194 | public static void writeVarInt(ByteArrayOutputStream out, int i) { 195 | while ((i & ~0x7F) != 0) { 196 | out.write((i & 0x7F) | 0x80); 197 | i >>>= 7; 198 | } 199 | 200 | out.write(i); 201 | } 202 | 203 | public static void writeLongs(ByteArrayOutputStream out, long[] l) { 204 | for (long value : l) { 205 | writeLong(out, value); 206 | } 207 | } 208 | 209 | public static void writeLong(ByteArrayOutputStream out, long l) { 210 | out.write((byte) (l >>> 56)); 211 | out.write((byte) (l >>> 48)); 212 | out.write((byte) (l >>> 40)); 213 | out.write((byte) (l >>> 32)); 214 | out.write((byte) (l >>> 24)); 215 | out.write((byte) (l >>> 16)); 216 | out.write((byte) (l >>> 8)); 217 | out.write((byte) (l)); 218 | } 219 | } 220 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # 4 | # Copyright © 2015 the original authors. 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # https://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # 18 | # SPDX-License-Identifier: Apache-2.0 19 | # 20 | 21 | ############################################################################## 22 | # 23 | # Gradle start up script for POSIX generated by Gradle. 24 | # 25 | # Important for running: 26 | # 27 | # (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is 28 | # noncompliant, but you have some other compliant shell such as ksh or 29 | # bash, then to run this script, type that shell name before the whole 30 | # command line, like: 31 | # 32 | # ksh Gradle 33 | # 34 | # Busybox and similar reduced shells will NOT work, because this script 35 | # requires all of these POSIX shell features: 36 | # * functions; 37 | # * expansions «$var», «${var}», «${var:-default}», «${var+SET}», 38 | # «${var#prefix}», «${var%suffix}», and «$( cmd )»; 39 | # * compound commands having a testable exit status, especially «case»; 40 | # * various built-in commands including «command», «set», and «ulimit». 41 | # 42 | # Important for patching: 43 | # 44 | # (2) This script targets any POSIX shell, so it avoids extensions provided 45 | # by Bash, Ksh, etc; in particular arrays are avoided. 46 | # 47 | # The "traditional" practice of packing multiple parameters into a 48 | # space-separated string is a well documented source of bugs and security 49 | # problems, so this is (mostly) avoided, by progressively accumulating 50 | # options in "$@", and eventually passing that to Java. 51 | # 52 | # Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, 53 | # and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; 54 | # see the in-line comments for details. 55 | # 56 | # There are tweaks for specific operating systems such as AIX, CygWin, 57 | # Darwin, MinGW, and NonStop. 58 | # 59 | # (3) This script is generated from the Groovy template 60 | # https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt 61 | # within the Gradle project. 62 | # 63 | # You can find Gradle at https://github.com/gradle/gradle/. 64 | # 65 | ############################################################################## 66 | 67 | # Attempt to set APP_HOME 68 | 69 | # Resolve links: $0 may be a link 70 | app_path=$0 71 | 72 | # Need this for daisy-chained symlinks. 73 | while 74 | APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path 75 | [ -h "$app_path" ] 76 | do 77 | ls=$( ls -ld "$app_path" ) 78 | link=${ls#*' -> '} 79 | case $link in #( 80 | /*) app_path=$link ;; #( 81 | *) app_path=$APP_HOME$link ;; 82 | esac 83 | done 84 | 85 | # This is normally unused 86 | # shellcheck disable=SC2034 87 | APP_BASE_NAME=${0##*/} 88 | # Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) 89 | APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit 90 | 91 | # Use the maximum available, or set MAX_FD != -1 to use that value. 92 | MAX_FD=maximum 93 | 94 | warn () { 95 | echo "$*" 96 | } >&2 97 | 98 | die () { 99 | echo 100 | echo "$*" 101 | echo 102 | exit 1 103 | } >&2 104 | 105 | # OS specific support (must be 'true' or 'false'). 106 | cygwin=false 107 | msys=false 108 | darwin=false 109 | nonstop=false 110 | case "$( uname )" in #( 111 | CYGWIN* ) cygwin=true ;; #( 112 | Darwin* ) darwin=true ;; #( 113 | MSYS* | MINGW* ) msys=true ;; #( 114 | NONSTOP* ) nonstop=true ;; 115 | esac 116 | 117 | 118 | 119 | # Determine the Java command to use to start the JVM. 120 | if [ -n "$JAVA_HOME" ] ; then 121 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 122 | # IBM's JDK on AIX uses strange locations for the executables 123 | JAVACMD=$JAVA_HOME/jre/sh/java 124 | else 125 | JAVACMD=$JAVA_HOME/bin/java 126 | fi 127 | if [ ! -x "$JAVACMD" ] ; then 128 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 129 | 130 | Please set the JAVA_HOME variable in your environment to match the 131 | location of your Java installation." 132 | fi 133 | else 134 | JAVACMD=java 135 | if ! command -v java >/dev/null 2>&1 136 | then 137 | die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 138 | 139 | Please set the JAVA_HOME variable in your environment to match the 140 | location of your Java installation." 141 | fi 142 | fi 143 | 144 | # Increase the maximum file descriptors if we can. 145 | if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then 146 | case $MAX_FD in #( 147 | max*) 148 | # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. 149 | # shellcheck disable=SC2039,SC3045 150 | MAX_FD=$( ulimit -H -n ) || 151 | warn "Could not query maximum file descriptor limit" 152 | esac 153 | case $MAX_FD in #( 154 | '' | soft) :;; #( 155 | *) 156 | # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. 157 | # shellcheck disable=SC2039,SC3045 158 | ulimit -n "$MAX_FD" || 159 | warn "Could not set maximum file descriptor limit to $MAX_FD" 160 | esac 161 | fi 162 | 163 | # Collect all arguments for the java command, stacking in reverse order: 164 | # * args from the command line 165 | # * the main class name 166 | # * -classpath 167 | # * -D...appname settings 168 | # * --module-path (only if needed) 169 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. 170 | 171 | # For Cygwin or MSYS, switch paths to Windows format before running java 172 | if "$cygwin" || "$msys" ; then 173 | APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) 174 | 175 | JAVACMD=$( cygpath --unix "$JAVACMD" ) 176 | 177 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 178 | for arg do 179 | if 180 | case $arg in #( 181 | -*) false ;; # don't mess with options #( 182 | /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath 183 | [ -e "$t" ] ;; #( 184 | *) false ;; 185 | esac 186 | then 187 | arg=$( cygpath --path --ignore --mixed "$arg" ) 188 | fi 189 | # Roll the args list around exactly as many times as the number of 190 | # args, so each arg winds up back in the position where it started, but 191 | # possibly modified. 192 | # 193 | # NB: a `for` loop captures its iteration list before it begins, so 194 | # changing the positional parameters here affects neither the number of 195 | # iterations, nor the values presented in `arg`. 196 | shift # remove old arg 197 | set -- "$@" "$arg" # push replacement arg 198 | done 199 | fi 200 | 201 | 202 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 203 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' 204 | 205 | # Collect all arguments for the java command: 206 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, 207 | # and any embedded shellness will be escaped. 208 | # * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be 209 | # treated as '${Hostname}' itself on the command line. 210 | 211 | set -- \ 212 | "-Dorg.gradle.appname=$APP_BASE_NAME" \ 213 | -jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \ 214 | "$@" 215 | 216 | # Stop when "xargs" is not available. 217 | if ! command -v xargs >/dev/null 2>&1 218 | then 219 | die "xargs is not available" 220 | fi 221 | 222 | # Use "xargs" to parse quoted args. 223 | # 224 | # With -n1 it outputs one arg per line, with the quotes and backslashes removed. 225 | # 226 | # In Bash we could simply go: 227 | # 228 | # readarray ARGS < <( xargs -n1 <<<"$var" ) && 229 | # set -- "${ARGS[@]}" "$@" 230 | # 231 | # but POSIX shell has neither arrays nor command substitution, so instead we 232 | # post-process each arg (as a line of input to sed) to backslash-escape any 233 | # character that might be a shell metacharacter, then use eval to reverse 234 | # that process (while maintaining the separation between arguments), and wrap 235 | # the whole thing up as a single "set" statement. 236 | # 237 | # This will of course break if any of these variables contains a newline or 238 | # an unmatched quote. 239 | # 240 | 241 | eval "set -- $( 242 | printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | 243 | xargs -n1 | 244 | sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | 245 | tr '\n' ' ' 246 | )" '"$@"' 247 | 248 | exec "$JAVACMD" "$@" 249 | -------------------------------------------------------------------------------- /src/main/java/com/plotsquared/plothider/PacketHandler.java: -------------------------------------------------------------------------------- 1 | /* 2 | * PlotHider, an addon to hide plots for the PlotSquared plugin for Minecraft. 3 | * Copyright (C) IntellectualSites 4 | * Copyright (C) IntellectualSites team and contributors 5 | * 6 | * This program is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program. If not, see . 18 | */ 19 | package com.plotsquared.plothider; 20 | 21 | import com.comphenix.protocol.PacketType; 22 | import com.comphenix.protocol.ProtocolLibrary; 23 | import com.comphenix.protocol.ProtocolManager; 24 | import com.comphenix.protocol.events.ListenerPriority; 25 | import com.comphenix.protocol.events.PacketAdapter; 26 | import com.comphenix.protocol.events.PacketContainer; 27 | import com.comphenix.protocol.events.PacketEvent; 28 | import com.comphenix.protocol.reflect.StructureModifier; 29 | import com.comphenix.protocol.wrappers.BlockPosition; 30 | import com.comphenix.protocol.wrappers.ChunkCoordIntPair; 31 | import com.comphenix.protocol.wrappers.WrappedBlockData; 32 | import com.comphenix.protocol.wrappers.WrappedLevelChunkData; 33 | import com.comphenix.protocol.wrappers.nbt.NbtBase; 34 | import com.google.common.primitives.Shorts; 35 | import com.plotsquared.bukkit.util.BukkitUtil; 36 | import com.plotsquared.core.PlotSquared; 37 | import com.plotsquared.core.location.Location; 38 | import com.plotsquared.core.location.World; 39 | import com.plotsquared.core.player.PlotPlayer; 40 | import com.plotsquared.core.plot.Plot; 41 | import com.plotsquared.core.plot.PlotArea; 42 | import com.plotsquared.plothider.storage.BlockStorage; 43 | import com.plotsquared.plothider.storage.palette.PalettedContainer; 44 | import com.plotsquared.plothider.storage.palette.PalettedContainerType; 45 | import org.bukkit.entity.Player; 46 | 47 | import java.io.ByteArrayInputStream; 48 | import java.io.ByteArrayOutputStream; 49 | import java.util.*; 50 | 51 | public class PacketHandler { 52 | 53 | private static final int SECTIONS_PER_CHUNK = (PlotSquared.platform().versionMaxHeight() + 1 - PlotSquared.platform().versionMinHeight()) >> 4; 54 | 55 | PacketHandler(PlotHiderPlugin main) { 56 | ProtocolManager manager = ProtocolLibrary.getProtocolManager(); 57 | manager.addPacketListener( 58 | new PacketAdapter(main, ListenerPriority.NORMAL, PacketType.Play.Server.BLOCK_CHANGE) { 59 | public void onPacketSending(PacketEvent event) { 60 | Player player = event.getPlayer(); 61 | PlotPlayer plotPlayer = BukkitUtil.adapt(player); 62 | World world = plotPlayer.getLocation().getWorld(); 63 | if (!canHide(plotPlayer, world)) { 64 | return; 65 | } 66 | 67 | PacketContainer packet = event.getPacket(); 68 | StructureModifier positions = packet.getBlockPositionModifier(); 69 | BlockPosition position = positions.read(0); 70 | Location loc = Location.at(world, position.getX(), 0, position.getZ()); 71 | Plot plot = loc.getOwnedPlot(); 72 | if (shouldHide(plot, plotPlayer)) { 73 | event.setCancelled(true); 74 | } 75 | } 76 | }); 77 | 78 | manager.addPacketListener(new PacketAdapter(main, ListenerPriority.NORMAL, 79 | PacketType.Play.Server.MULTI_BLOCK_CHANGE) { 80 | @Override 81 | public void onPacketSending(PacketEvent event) { 82 | Player player = event.getPlayer(); 83 | PlotPlayer plotPlayer = BukkitUtil.adapt(player); 84 | World world = plotPlayer.getLocation().getWorld(); 85 | if (!canHide(plotPlayer, world)) { 86 | return; 87 | } 88 | 89 | PacketContainer packet = event.getPacket(); 90 | StructureModifier sectionPositions = packet.getSectionPositions(); 91 | BlockPosition sectionPosition = sectionPositions.read(0); 92 | ChunkCoordIntPair chunk = new ChunkCoordIntPair(sectionPosition.getX(), sectionPosition.getZ()); 93 | int cx = chunk.getChunkX(); 94 | int cz = chunk.getChunkZ(); 95 | int bx = cx << 4; 96 | int bz = cz << 4; 97 | Location corner1 = Location.at(world, bx, 0, bz); 98 | Location corner2 = Location.at(world, bx + 15, 0, bz); 99 | Location corner3 = Location.at(world, bx, 0, bz + 15); 100 | Location corner4 = Location.at(world, bx + 15, 0, bz + 15); 101 | Plot plot1 = corner1.getOwnedPlot(); 102 | Plot plot2 = corner2.getOwnedPlot(); 103 | Plot plot3 = corner3.getOwnedPlot(); 104 | Plot plot4 = corner4.getOwnedPlot(); 105 | plot1 = shouldHide(plot1, plotPlayer) ? plot1 : null; 106 | plot2 = shouldHide(plot2, plotPlayer) ? plot2 : null; 107 | plot3 = shouldHide(plot3, plotPlayer) ? plot3 : null; 108 | plot4 = shouldHide(plot4, plotPlayer) ? plot4 : null; 109 | if (plot1 == null && plot2 == null && plot3 == null && plot4 == null) { // No plots to hide 110 | return; 111 | } 112 | if (plot1 == plot4 && plot1 != null) { // Not allowed to see the entire chunk 113 | event.setCancelled(true); 114 | return; 115 | } 116 | StructureModifier positionsArray = 117 | packet.getShortArrays(); 118 | StructureModifier blocksArray = 119 | packet.getBlockDataArrays(); 120 | // Hide some of the blocks (but maybe not all) 121 | List positions = 122 | new ArrayList<>(Shorts.asList(positionsArray.read(0))); 123 | List blocks = 124 | new ArrayList<>(Arrays.asList(blocksArray.read(0))); 125 | // Both lists have same length. 126 | Iterator positionsIter = positions.iterator(); 127 | Iterator blocksIter = blocks.iterator(); 128 | Plot denied = plot1 != null ? plot1 : plot2 != null ? plot2 : plot3 != null ? plot3 : plot4; 129 | PlotArea area = denied.getArea(); 130 | while (positionsIter.hasNext()) { 131 | short change = positionsIter.next(); 132 | blocksIter.next(); 133 | // Binary operators give section-relative coordinates. 134 | int x = bx + (change >>> 8 & 15); 135 | int z = bz + (change >>> 4 & 15); 136 | Plot current = area.getOwnedPlot(Location.at(world, x, 0, z)); 137 | if (current == null) { 138 | continue; 139 | } 140 | if (current == plot1 || current == plot2 || current == plot3 141 | || current == plot4) { 142 | positionsIter.remove(); 143 | blocksIter.remove(); 144 | } 145 | } 146 | if (positions.size() == 0) { 147 | event.setCancelled(true); 148 | return; 149 | } 150 | positionsArray.write(0, Shorts.toArray(positions)); 151 | blocksArray.write(0, blocks.toArray(new WrappedBlockData[0])); 152 | event.setPacket(packet); 153 | } 154 | }); 155 | 156 | manager.addPacketListener( 157 | new PacketAdapter(main, ListenerPriority.NORMAL, PacketType.Play.Server.MAP_CHUNK) { 158 | public void onPacketSending(PacketEvent event) { 159 | Player player = event.getPlayer(); 160 | PlotPlayer plotPlayer = BukkitUtil.adapt(player); 161 | World world = plotPlayer.getLocation().getWorld(); 162 | if (!canHide(plotPlayer, world)) { 163 | return; 164 | } 165 | 166 | PacketContainer packet = event.getPacket(); 167 | StructureModifier ints = packet.getIntegers(); 168 | 169 | // 1.18+ 170 | StructureModifier chunkDataModifier = packet.getLevelChunkData(); 171 | WrappedLevelChunkData.ChunkData chunkData = chunkDataModifier.read(0); 172 | 173 | StructureModifier byteArrays = packet.getByteArrays(); 174 | StructureModifier>> nbtLists = packet.getListNbtModifier(); 175 | 176 | // Chunk X,Z & Block X,Z 177 | int cx = ints.read(0); 178 | int cz = ints.read(1); 179 | int bx = cx << 4; 180 | int bz = cz << 4; 181 | 182 | Location corner1 = Location.at(world, bx, 0, bz); 183 | Location corner2 = Location.at(world, bx + 15, 0, bz); 184 | Location corner3 = Location.at(world, bx, 0, bz + 15); 185 | Location corner4 = Location.at(world, bx + 15, 0, bz + 15); 186 | Plot plot1 = corner1.getOwnedPlot(); 187 | Plot plot2 = corner2.getOwnedPlot(); 188 | Plot plot3 = corner3.getOwnedPlot(); 189 | Plot plot4 = corner4.getOwnedPlot(); 190 | 191 | plot1 = shouldHide(plot1, plotPlayer) ? plot1 : null; 192 | plot2 = shouldHide(plot2, plotPlayer) ? plot2 : null; 193 | plot3 = shouldHide(plot3, plotPlayer) ? plot3 : null; 194 | plot4 = shouldHide(plot4, plotPlayer) ? plot4 : null; 195 | 196 | if (plot1 == null && plot2 == null && plot3 == null 197 | && plot4 == null) { // No plots to hide 198 | return; 199 | } 200 | 201 | if (plot1 == plot4 && plot1 != null) { // Not allowed to see the entire chunk 202 | if (chunkData != null) { 203 | // 1.18+ 204 | // Replaces buffer, i.e. chunk data. 205 | chunkData.setBuffer(new byte[chunkData.getBuffer().length]); 206 | chunkData.setBlockEntityInfo(Collections.emptyList()); 207 | } else if (byteArrays != null) { 208 | // 1.17- 209 | byteArrays.write(0, new byte[byteArrays.read(0).length]); 210 | nbtLists.write(0, new ArrayList<>()); 211 | } 212 | event.setPacket(packet); 213 | return; 214 | } 215 | 216 | // Not allowed to see part of the chunk 217 | Plot denied = plot1 != null ? 218 | plot1 : 219 | plot2 != null ? plot2 : plot3 != null ? plot3 : plot4; 220 | PlotArea area = denied.getArea(); 221 | 222 | /* 223 | * With 1.17, block section count depends on variable world height 224 | * represented as a BitSet internally. We just use a BitSet for older 225 | * versions too because it performs good enough. 226 | */ 227 | BitSet bitMask; 228 | int sectionsSize = 0; 229 | if (PlotSquared.platform().serverVersion()[1] >= 17) { 230 | if (chunkData != null) { 231 | // 1.18+ 232 | sectionsSize = SECTIONS_PER_CHUNK; 233 | } else { 234 | // 1.17 unique BitSet behavior. 235 | bitMask = packet.getSpecificModifier(BitSet.class).read(0); 236 | 237 | for (int layer = 0; layer < bitMask.size(); layer++) { 238 | if (bitMask.get(layer)) 239 | sectionsSize += 1; 240 | } 241 | } 242 | } else { 243 | int bitMaskLegacy = ints.read(2); 244 | bitMask = intToBitSet(bitMaskLegacy); 245 | 246 | for (int layer = 0; layer < bitMask.size(); layer++) { 247 | if (bitMask.get(layer)) 248 | sectionsSize += 1; 249 | } 250 | } 251 | 252 | byte[] sections; 253 | if (chunkData != null) { 254 | // 1.18+ 255 | sections = chunkData.getBuffer(); 256 | } else { 257 | // 1.17- 258 | sections = byteArrays.read(0); 259 | } 260 | 261 | ByteArrayInputStream buffer = new ByteArrayInputStream(sections); 262 | int size = sections.length; 263 | 264 | List array = new ArrayList<>(); 265 | 266 | try { 267 | for (int layer = 0; layer < sectionsSize; layer++) { 268 | // Both values represent a short. 269 | int blockCountHigh = buffer.read(); 270 | int blockCountLow = buffer.read(); 271 | 272 | short blockCount = (short) ((blockCountHigh & 0xFF) << 8 | (blockCountLow & 0xFF)); 273 | 274 | BlockStorage storage = new BlockStorage(blockCount); 275 | 276 | storage.read(buffer, PalettedContainerType.BLOCKS); 277 | if (chunkData != null) { 278 | // 1.18+, also contains biomes. 279 | storage.read(buffer, PalettedContainerType.BIOMES); 280 | } 281 | 282 | array.add(storage); 283 | } 284 | 285 | for (int x = 0; x < 16; x++) { 286 | for (int z = 0; z < 16; z++) { 287 | Location loc = Location.at(world, bx + x, 0, bz + z); 288 | Plot current = area.getOwnedPlot(loc); 289 | if (current != null) { 290 | if ((current == plot1) || (current == plot2) || (current == plot3) 291 | || (current == plot4)) { 292 | for (BlockStorage section1 : array) { 293 | for (int y = 0; y < 16; y++) { 294 | if (section1.getBlock(x, y, z) != PalettedContainer.AIR) { 295 | section1.setBlock(x, y, z, PalettedContainer.AIR); 296 | } 297 | } 298 | } 299 | } 300 | } 301 | } 302 | } 303 | 304 | ByteArrayOutputStream baos = new ByteArrayOutputStream(size); 305 | for (BlockStorage section1 : array) { 306 | section1.write(baos); 307 | } 308 | 309 | if (chunkData != null) { 310 | // 1.18+ 311 | chunkData.setBuffer(baos.toByteArray()); 312 | 313 | // Also remove block entities. 314 | List newBlockEntities = new ArrayList<>(); 315 | for (WrappedLevelChunkData.BlockEntityInfo blockEntity : chunkData.getBlockEntityInfo()) { 316 | Location loc = Location.at(world, bx + blockEntity.getSectionX(), blockEntity.getY(), bz + blockEntity.getSectionZ()); 317 | Plot current = area.getOwnedPlot(loc); 318 | if (current == null || ((current != plot1) && (current != plot2) && (current 319 | != plot3) && (current != plot4))) { 320 | newBlockEntities.add(blockEntity); 321 | } 322 | } 323 | 324 | chunkData.setBlockEntityInfo(newBlockEntities); 325 | } else { 326 | // 1.17- 327 | byteArrays.write(0, baos.toByteArray()); 328 | } 329 | 330 | event.setPacket(packet); 331 | } catch (Throwable e) { 332 | e.printStackTrace(); 333 | } 334 | } 335 | }); 336 | 337 | manager.addPacketListener(new PacketAdapter(main, ListenerPriority.NORMAL, 338 | PacketType.Play.Server.SPAWN_ENTITY) { 339 | @Override 340 | public void onPacketSending(PacketEvent event) { 341 | Player player = event.getPlayer(); 342 | PlotPlayer plotPlayer = BukkitUtil.adapt(player); 343 | World world = plotPlayer.getLocation().getWorld(); 344 | if (!canHide(plotPlayer, world)) { 345 | return; 346 | } 347 | 348 | PacketContainer packet = event.getPacket(); 349 | StructureModifier doubles = packet.getDoubles(); 350 | double x = doubles.read(0); 351 | double y = doubles.read(1); 352 | double z = doubles.read(2); 353 | 354 | Location loc = Location.at(world, (int) x, (int) y, (int) z); 355 | Plot plot = loc.getOwnedPlot(); 356 | if (shouldHide(plot, plotPlayer)) { 357 | event.setCancelled(true); 358 | } 359 | } 360 | }); 361 | } 362 | 363 | private boolean canHide(PlotPlayer plotPlayer, World world) { 364 | // Check admin bypass and existing plot area. 365 | return !plotPlayer.hasPermission("plots.plothider.bypass") && hasPlotArea(world); 366 | } 367 | 368 | private boolean hasPlotArea(World world) { 369 | return PlotSquared.get().getPlotAreaManager().hasPlotArea(world.getName()); 370 | } 371 | 372 | private boolean shouldHide(Plot plot, PlotPlayer plotPlayer) { 373 | return plot != null && (plot.isDenied(plotPlayer.getUUID()) || (!plot.isAdded(plotPlayer.getUUID()) 374 | && plot.getFlag(HideFlag.class))); 375 | } 376 | 377 | private static BitSet intToBitSet(int n) { 378 | BitSet bits = new BitSet(Integer.SIZE); 379 | for (int i = 0; i < Integer.SIZE; i++) { 380 | if (((n >> i) & 0x1) == 1) { 381 | bits.set(i); 382 | } 383 | } 384 | return bits; 385 | } 386 | 387 | } 388 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------