Repository: Hexaoxide/Carbon
Branch: trunk
Commit: 3f445b6955b8
Files: 376
Total size: 1.3 MB
Directory structure:
gitextract_gdfuth62/
├── .checkstyle/
│ ├── checkstyle.xml
│ └── suppressions.xml
├── .editorconfig
├── .github/
│ ├── FUNDING.yml
│ ├── ISSUE_TEMPLATE/
│ │ ├── bug_report.md
│ │ ├── config.yml
│ │ └── feature_request.md
│ └── workflows/
│ └── build.yml
├── .gitignore
├── LICENSE
├── LICENSE_HEADER
├── README.md
├── api/
│ ├── build.gradle.kts
│ └── src/
│ └── main/
│ └── java/
│ └── net/
│ └── draycia/
│ └── carbon/
│ └── api/
│ ├── CarbonChat.java
│ ├── CarbonChatProvider.java
│ ├── CarbonServer.java
│ ├── channels/
│ │ ├── ChannelPermissionResult.java
│ │ ├── ChannelPermissionResultImpl.java
│ │ ├── ChannelPermissions.java
│ │ ├── ChannelRegistry.java
│ │ └── ChatChannel.java
│ ├── event/
│ │ ├── Cancellable.java
│ │ ├── CarbonEvent.java
│ │ ├── CarbonEventHandler.java
│ │ ├── CarbonEventSubscriber.java
│ │ ├── CarbonEventSubscription.java
│ │ └── events/
│ │ ├── CarbonChannelRegisterEvent.java
│ │ ├── CarbonChatEvent.java
│ │ ├── CarbonPrivateChatEvent.java
│ │ ├── ChannelSwitchEvent.java
│ │ ├── PartyJoinEvent.java
│ │ └── PartyLeaveEvent.java
│ ├── users/
│ │ ├── CarbonPlayer.java
│ │ ├── Party.java
│ │ └── UserManager.java
│ └── util/
│ ├── ChatComponentRenderer.java
│ ├── InventorySlot.java
│ ├── KeyedRenderer.java
│ └── KeyedRendererImpl.java
├── build-logic/
│ ├── build.gradle.kts
│ ├── settings.gradle.kts
│ └── src/
│ └── main/
│ └── kotlin/
│ ├── CarbonPermissionsExtension.kt
│ ├── CarbonPlatformExtension.kt
│ ├── ConfigurablePluginsExt.kt
│ ├── FetchLuckPermsDownloads.kt
│ ├── FetchLuckPermsJar.kt
│ ├── FileCopyTask.kt
│ ├── carbon.base-conventions.gradle.kts
│ ├── carbon.build-logic.gradle.kts
│ ├── carbon.configurable-plugins.gradle.kts
│ ├── carbon.permissions.gradle.kts
│ ├── carbon.platform-conventions.gradle.kts
│ ├── carbon.publishing-conventions.gradle.kts
│ ├── carbon.shadow-platform.gradle.kts
│ ├── constants.kt
│ └── extensions.kt
├── build.gradle.kts
├── common/
│ ├── build.gradle.kts
│ └── src/
│ └── main/
│ ├── java/
│ │ ├── com/
│ │ │ └── google/
│ │ │ └── inject/
│ │ │ └── assistedinject/
│ │ │ └── FactoryProvider3.java
│ │ └── net/
│ │ └── draycia/
│ │ └── carbon/
│ │ └── common/
│ │ ├── CarbonChatInternal.java
│ │ ├── CarbonCommonModule.java
│ │ ├── CarbonPlatformModule.java
│ │ ├── DataDirectory.java
│ │ ├── PeriodicTasks.java
│ │ ├── PlatformScheduler.java
│ │ ├── RawChat.java
│ │ ├── channels/
│ │ │ ├── CarbonChannelRegistry.java
│ │ │ ├── ChannelPermissionsImpl.java
│ │ │ ├── ConfigChannelSettings.java
│ │ │ ├── ConfigChatChannel.java
│ │ │ ├── PartyChatChannel.java
│ │ │ └── messages/
│ │ │ ├── ConfigChannelMessageSource.java
│ │ │ └── ConfigChannelMessages.java
│ │ ├── command/
│ │ │ ├── CarbonCommand.java
│ │ │ ├── CommandSettings.java
│ │ │ ├── Commander.java
│ │ │ ├── ExecutionCoordinatorHolder.java
│ │ │ ├── ParserFactory.java
│ │ │ ├── PlayerCommander.java
│ │ │ ├── argument/
│ │ │ │ ├── CarbonPlayerParser.java
│ │ │ │ └── PlayerSuggestions.java
│ │ │ ├── commands/
│ │ │ │ ├── ClearChatCommand.java
│ │ │ │ ├── ContinueCommand.java
│ │ │ │ ├── DebugCommand.java
│ │ │ │ ├── FilterCommand.java
│ │ │ │ ├── HelpCommand.java
│ │ │ │ ├── IgnoreCommand.java
│ │ │ │ ├── IgnoreListCommand.java
│ │ │ │ ├── JoinCommand.java
│ │ │ │ ├── LeaveCommand.java
│ │ │ │ ├── MuteCommand.java
│ │ │ │ ├── MuteInfoCommand.java
│ │ │ │ ├── NicknameCommand.java
│ │ │ │ ├── PartyCommands.java
│ │ │ │ ├── RealNameCommand.java
│ │ │ │ ├── ReloadCommand.java
│ │ │ │ ├── ReplyCommand.java
│ │ │ │ ├── SpyCommand.java
│ │ │ │ ├── ToggleMessagesCommand.java
│ │ │ │ ├── UnignoreCommand.java
│ │ │ │ ├── UnmuteCommand.java
│ │ │ │ ├── UpdateUsernameCommand.java
│ │ │ │ └── WhisperCommand.java
│ │ │ └── exception/
│ │ │ ├── CommandCompleted.java
│ │ │ └── ComponentException.java
│ │ ├── config/
│ │ │ ├── ClearChatSettings.java
│ │ │ ├── CommandConfig.java
│ │ │ ├── ConfigHeader.java
│ │ │ ├── ConfigManager.java
│ │ │ ├── DatabaseSettings.java
│ │ │ ├── IntegrationConfigContainer.java
│ │ │ ├── MessagingSettings.java
│ │ │ ├── PingSettings.java
│ │ │ └── PrimaryConfig.java
│ │ ├── event/
│ │ │ ├── CancellableImpl.java
│ │ │ ├── CarbonEventHandlerImpl.java
│ │ │ ├── CarbonEventSubscriptionImpl.java
│ │ │ └── events/
│ │ │ ├── CarbonChatEventImpl.java
│ │ │ ├── CarbonEarlyChatEvent.java
│ │ │ ├── CarbonPrivateChatEventImpl.java
│ │ │ ├── CarbonReloadEvent.java
│ │ │ ├── ChannelRegisterEventImpl.java
│ │ │ └── ChannelSwitchEventImpl.java
│ │ ├── integration/
│ │ │ ├── Integration.java
│ │ │ └── miniplaceholders/
│ │ │ ├── MiniPlaceholdersExpansion.java
│ │ │ ├── MiniPlaceholdersIntegration.java
│ │ │ └── MiniPlaceholdersUtil.java
│ │ ├── listeners/
│ │ │ ├── ChatListenerInternal.java
│ │ │ ├── DeafenHandler.java
│ │ │ ├── FilterHandler.java
│ │ │ ├── HyperlinkHandler.java
│ │ │ ├── IgnoreHandler.java
│ │ │ ├── ItemLinkHandler.java
│ │ │ ├── Listener.java
│ │ │ ├── MessagePacketHandler.java
│ │ │ ├── MuteHandler.java
│ │ │ ├── PartyChatSpyHandler.java
│ │ │ ├── PartyPingHandler.java
│ │ │ ├── PingHandler.java
│ │ │ └── RadiusListener.java
│ │ ├── messages/
│ │ │ ├── CarbonMessageRenderer.java
│ │ │ ├── CarbonMessageSender.java
│ │ │ ├── CarbonMessageSource.java
│ │ │ ├── CarbonMessages.java
│ │ │ ├── NotPlaceholder.java
│ │ │ ├── Option.java
│ │ │ ├── OptionTagResolver.java
│ │ │ ├── PrefixedDelegateIterator.java
│ │ │ ├── RenderForTagResolver.java
│ │ │ ├── SourcedAudience.java
│ │ │ ├── SourcedAudienceImpl.java
│ │ │ ├── SourcedMessageSender.java
│ │ │ ├── SourcedReceiverResolver.java
│ │ │ ├── StandardPlaceholderResolverStrategyButDifferent.java
│ │ │ ├── TagPermissions.java
│ │ │ └── placeholders/
│ │ │ ├── BooleanPlaceholderResolver.java
│ │ │ ├── ComponentPlaceholderResolver.java
│ │ │ ├── IntPlaceholderResolver.java
│ │ │ ├── KeyPlaceholderResolver.java
│ │ │ ├── LongPlaceholderResolver.java
│ │ │ ├── OptionPlaceholderResolver.java
│ │ │ ├── StringPlaceholderResolver.java
│ │ │ └── UUIDPlaceholderResolver.java
│ │ ├── messaging/
│ │ │ ├── CarbonChatPacketHandler.java
│ │ │ ├── MessagingManager.java
│ │ │ ├── ServerId.java
│ │ │ └── packets/
│ │ │ ├── CarbonPacket.java
│ │ │ ├── ChatMessagePacket.java
│ │ │ ├── DisbandPartyPacket.java
│ │ │ ├── InvalidatePartyInvitePacket.java
│ │ │ ├── LocalPlayerChangePacket.java
│ │ │ ├── LocalPlayersPacket.java
│ │ │ ├── PacketFactory.java
│ │ │ ├── PartyChangePacket.java
│ │ │ ├── PartyInvitePacket.java
│ │ │ ├── SaveCompletedPacket.java
│ │ │ └── WhisperPacket.java
│ │ ├── serialisation/
│ │ │ └── gson/
│ │ │ ├── ChatChannelSerializerGson.java
│ │ │ ├── LocaleSerializerConfigurate.java
│ │ │ └── UUIDSerializerGson.java
│ │ ├── users/
│ │ │ ├── Backing.java
│ │ │ ├── CachingUserManager.java
│ │ │ ├── CarbonPlayerCommon.java
│ │ │ ├── ConsoleCarbonPlayer.java
│ │ │ ├── MojangProfileResolver.java
│ │ │ ├── NetworkUsers.java
│ │ │ ├── PartyImpl.java
│ │ │ ├── PartyInvites.java
│ │ │ ├── PersistentUserProperty.java
│ │ │ ├── PlatformUserManager.java
│ │ │ ├── PlayerUtils.java
│ │ │ ├── ProfileCache.java
│ │ │ ├── ProfileResolver.java
│ │ │ ├── UserManagerInternal.java
│ │ │ ├── WrappedCarbonPlayer.java
│ │ │ ├── db/
│ │ │ │ ├── DatabaseUserManager.java
│ │ │ │ ├── QueriesLocator.java
│ │ │ │ ├── argument/
│ │ │ │ │ ├── BinaryUUIDArgumentFactory.java
│ │ │ │ │ ├── ComponentArgumentFactory.java
│ │ │ │ │ └── KeyArgumentFactory.java
│ │ │ │ └── mapper/
│ │ │ │ ├── BinaryUUIDColumnMapper.java
│ │ │ │ ├── ComponentColumnMapper.java
│ │ │ │ ├── KeyColumnMapper.java
│ │ │ │ ├── NativeUUIDColumnMapper.java
│ │ │ │ ├── PartyRowMapper.java
│ │ │ │ └── PlayerRowMapper.java
│ │ │ └── json/
│ │ │ └── JSONUserManager.java
│ │ └── util/
│ │ ├── CarbonDependencies.java
│ │ ├── ChannelUtils.java
│ │ ├── CloudUtils.java
│ │ ├── ColorUtils.java
│ │ ├── ConcurrentUtil.java
│ │ ├── DiscordRecipient.java
│ │ ├── EmptyAudienceWithPointers.java
│ │ ├── ExceptionLoggingScheduledThreadPoolExecutor.java
│ │ ├── Exceptions.java
│ │ ├── FastUuidSansHyphens.java
│ │ ├── FileUtil.java
│ │ ├── Pagination.java
│ │ ├── PaginationHelper.java
│ │ ├── SQLDrivers.java
│ │ ├── Strings.java
│ │ └── UpdateChecker.java
│ └── resources/
│ ├── carbon-permissions.yml
│ ├── locale/
│ │ ├── messages-de_AT.properties
│ │ ├── messages-de_CH.properties
│ │ ├── messages-de_DE.properties
│ │ ├── messages-en_US.properties
│ │ ├── messages-es_CL.properties
│ │ ├── messages-es_ES.properties
│ │ ├── messages-fi_FI.properties
│ │ ├── messages-fr_CA.properties
│ │ ├── messages-fr_FR.properties
│ │ ├── messages-ja_JP.properties
│ │ ├── messages-nl_NL.properties
│ │ ├── messages-nn_NO.properties
│ │ ├── messages-no_NO.properties
│ │ ├── messages-pl_PL.properties
│ │ ├── messages-pt_BR.properties
│ │ ├── messages-ru_RU.properties
│ │ ├── messages-tr_TR.properties
│ │ ├── messages-uk_UA.properties
│ │ ├── messages-zh_CN.properties
│ │ └── messages-zh_TW.properties
│ └── queries/
│ ├── clear-ignores.sql
│ ├── clear-leftchannels.sql
│ ├── clear-party-members.sql
│ ├── drop-party-member.sql
│ ├── drop-party.sql
│ ├── insert-party-member.sql
│ ├── insert-party.sql
│ ├── insert-player.sql
│ ├── migrations/
│ │ ├── h2/
│ │ │ ├── V1__create_tables.sql
│ │ │ ├── V2__increase_nickname_size.sql
│ │ │ ├── V3__parties.sql
│ │ │ ├── V4__filters.sql
│ │ │ ├── V5__tempmute.sql
│ │ │ └── V6__tempmute.sql
│ │ ├── mysql/
│ │ │ ├── V10__tempmute.sql
│ │ │ ├── V1__create_tables.sql
│ │ │ ├── V2__create_tables.sql
│ │ │ ├── V3__fix_leftchannels.sql
│ │ │ ├── V4__drop_usernames.sql
│ │ │ ├── V5__add_dmtoggle.sql
│ │ │ ├── V6__increase_nickname_size.sql
│ │ │ ├── V7__parties.sql
│ │ │ ├── V8__filters.sql
│ │ │ └── V9__tempmute.sql
│ │ └── postgresql/
│ │ ├── V10__tempmute.sql
│ │ ├── V1__create_tables.sql
│ │ ├── V2__create_tables.sql
│ │ ├── V3__fix_leftchannels.sql
│ │ ├── V4__drop_usernames.sql
│ │ ├── V5__add_dmtoggle.sql
│ │ ├── V6__increase_nickname_size.sql
│ │ ├── V7__parties.sql
│ │ ├── V8__filters.sql
│ │ └── V9__tempmute.sql
│ ├── save-ignores.sql
│ ├── save-leftchannels.sql
│ ├── select-ignores.sql
│ ├── select-leftchannels.sql
│ ├── select-party-members.sql
│ ├── select-party.sql
│ ├── select-player.sql
│ └── update-player.sql
├── crowdin.yml
├── fabric/
│ ├── build.gradle.kts
│ └── src/
│ └── main/
│ ├── java/
│ │ └── net/
│ │ └── draycia/
│ │ └── carbon/
│ │ └── fabric/
│ │ ├── CarbonChatFabric.java
│ │ ├── CarbonChatFabricModule.java
│ │ ├── CarbonFabricBootstrap.java
│ │ ├── CarbonServerFabric.java
│ │ ├── FabricMessageRenderer.java
│ │ ├── FabricScheduler.java
│ │ ├── MinecraftServerHolder.java
│ │ ├── command/
│ │ │ ├── FabricCommander.java
│ │ │ └── FabricPlayerCommander.java
│ │ ├── listeners/
│ │ │ ├── FabricChatHandler.java
│ │ │ └── FabricJoinQuitListener.java
│ │ └── users/
│ │ ├── CarbonPlayerFabric.java
│ │ └── FabricProfileResolver.java
│ └── resources/
│ ├── carbonchat.mixins.json
│ ├── data/
│ │ └── carbonchat/
│ │ └── chat_type/
│ │ └── chat.json
│ └── pack.mcmeta
├── gradle/
│ ├── libs.versions.toml
│ └── wrapper/
│ ├── gradle-wrapper.jar
│ └── gradle-wrapper.properties
├── gradle.properties
├── gradlew
├── gradlew.bat
├── paper/
│ ├── build.gradle.kts
│ └── src/
│ └── main/
│ └── java/
│ └── net/
│ └── draycia/
│ └── carbon/
│ └── paper/
│ ├── CarbonChatPaper.java
│ ├── CarbonChatPaperModule.java
│ ├── CarbonPaperBootstrap.java
│ ├── CarbonPaperLoader.java
│ ├── CarbonServerPaper.java
│ ├── PaperScheduler.java
│ ├── command/
│ │ ├── PaperCommander.java
│ │ └── PaperPlayerCommander.java
│ ├── hooks/
│ │ ├── CarbonPAPIPlaceholders.java
│ │ └── PAPIChatHook.java
│ ├── integration/
│ │ ├── alessiodp_parties/
│ │ │ ├── AlessiodpPartiesIntegration.java
│ │ │ └── AlessiodpPartiesPartyChannel.java
│ │ ├── dsrv/
│ │ │ ├── DSRVIntegration.java
│ │ │ └── DSRVListener.java
│ │ ├── essxd/
│ │ │ ├── EssXDIntegration.java
│ │ │ └── EssXDListener.java
│ │ ├── fuuid/
│ │ │ ├── AbstractFactionsChannel.java
│ │ │ ├── AllianceChannel.java
│ │ │ ├── FactionChannel.java
│ │ │ ├── FactionModChannel.java
│ │ │ ├── FactionsIntegration.java
│ │ │ └── TruceChannel.java
│ │ ├── mcmmo/
│ │ │ ├── McmmoIntegration.java
│ │ │ └── McmmoPartyChannel.java
│ │ ├── plotsquared/
│ │ │ ├── PlotChannel.java
│ │ │ └── PlotSquaredIntegration.java
│ │ └── towny/
│ │ ├── AllianceChannel.java
│ │ ├── NationChannel.java
│ │ ├── ResidentListChannel.java
│ │ ├── TownChannel.java
│ │ └── TownyIntegration.java
│ ├── listeners/
│ │ ├── PaperChatListener.java
│ │ └── PaperPlayerJoinListener.java
│ ├── messages/
│ │ ├── PaperMessageRenderer.java
│ │ └── PlaceholderAPIMiniMessageParser.java
│ └── users/
│ ├── CarbonPlayerPaper.java
│ └── PaperProfileResolver.java
├── renovate.json
├── settings.gradle.kts
├── sponge/
│ ├── build.gradle.kts
│ └── src/
│ └── main/
│ └── java/
│ └── net/
│ └── draycia/
│ └── carbon/
│ └── sponge/
│ ├── CarbonChatSponge.java
│ ├── CarbonChatSpongeModule.java
│ ├── CarbonServerSponge.java
│ ├── SpongeMessageRenderer.java
│ ├── SpongeUserManager.java
│ ├── command/
│ │ ├── SpongeCommander.java
│ │ └── SpongePlayerCommander.java
│ ├── listeners/
│ │ ├── SpongeChatListener.java
│ │ ├── SpongePlayerJoinListener.java
│ │ └── SpongeReloadListener.java
│ └── users/
│ └── CarbonPlayerSponge.java
└── velocity/
├── build.gradle.kts
└── src/
└── main/
└── java/
└── net/
└── draycia/
└── carbon/
└── velocity/
├── CarbonChatVelocity.java
├── CarbonChatVelocityModule.java
├── CarbonServerVelocity.java
├── CarbonVelocityBootstrap.java
├── VelocityMessageRenderer.java
├── command/
│ ├── VelocityCommander.java
│ └── VelocityPlayerCommander.java
├── listeners/
│ ├── VelocityChatListener.java
│ ├── VelocityListener.java
│ ├── VelocityPlayerJoinListener.java
│ └── VelocityPlayerLeaveListener.java
└── users/
├── CarbonPlayerVelocity.java
└── VelocityProfileResolver.java
================================================
FILE CONTENTS
================================================
================================================
FILE: .checkstyle/checkstyle.xml
================================================
================================================
FILE: .checkstyle/suppressions.xml
================================================
================================================
FILE: .editorconfig
================================================
# MIT License
#
# Copyright (c) 2017-2020 KyoriPowered
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
root = true
[*]
charset = utf-8
indent_size = 4
indent_style = space
insert_final_newline = true
max_line_length = off
[*.java]
ij_java_imports_layout = *, |, $*
ij_java_class_count_to_use_import_on_demand = 999
ij_java_names_count_to_use_import_on_demand = 999
[{*.kt,*.kts,*.yml}]
indent_size = 2
================================================
FILE: .github/FUNDING.yml
================================================
github: [Draycia, jpenilla]
================================================
FILE: .github/ISSUE_TEMPLATE/bug_report.md
================================================
---
name: "\U0001F41E Bug report"
about: Describe a bug in Carbon
title: "[Bug]"
labels: unconfirmed bug
assignees: ''
---
## Bug Description:
### What is not working as it should?
### Steps to reproduce:
### System Details:
1. Server Type:
2. Server Software:
3. MC Version:
4. Carbon Version:
### Pastebins:
### Any other relevant details:
================================================
FILE: .github/ISSUE_TEMPLATE/config.yml
================================================
blank_issues_enabled: false
contact_links:
- name: 💬 Ask a question
url: https://discord.gg/S8s75Yf
about: Support for Carbon is provided on Discord. Instead of making an issue to ask a question, join us on discord and we'll be happy to help!
================================================
FILE: .github/ISSUE_TEMPLATE/feature_request.md
================================================
---
name: "⚡ Feature request"
about: Suggest an idea for Carbon
title: "[Feature]"
labels: proposed enhancement
assignees: ''
---
### Proposed Feature Description:
### Proposed Feature Functionality:
================================================
FILE: .github/workflows/build.yml
================================================
name: Build
on:
push:
branches: [ "**" ]
tags: [ "v**" ]
pull_request:
release:
types: [ published ]
jobs:
build:
# Only run on PRs if the source branch is on someone else's repo
if: ${{ (github.event_name != 'pull_request' || github.repository != github.event.pull_request.head.repo.full_name) && (github.event.name != 'push' || !startsWith(github.ref, 'refs/tags/') || contains(github.ref, '-beta.')) }}
runs-on: ubuntu-latest
strategy:
matrix:
java: [ 21 ]
fail-fast: true
steps:
- uses: actions/checkout@v6
- name: JDK ${{ matrix.java }}
uses: actions/setup-java@v5
with:
java-version: ${{ matrix.java }}
distribution: 'temurin'
- name: Setup Gradle
uses: gradle/actions/setup-gradle@v6
# gradle build action can't handle project dir local caches
- uses: actions/cache@v5
name: Cache Loom Files
with:
path: |
.gradle/loom-cache
key: ${{ runner.os }}-gradle-${{ hashFiles('**/libs.versions.*', '**/*.gradle*', '**/gradle-wrapper.properties') }}
restore-keys: ${{ runner.os }}-gradle-
- name: Build
run: ./gradlew build --stacktrace
- name: Determine Snapshot Status
run: |
if [ "$(./gradlew properties | awk '/^version:/ { print $2; }' | grep '\-SNAPSHOT')" ]; then
echo "STATUS=snapshot" >> $GITHUB_ENV
else
echo "STATUS=release" >> $GITHUB_ENV
fi
- name: "publish snapshot to sonatype snapshots"
if: "${{ env.STATUS != 'release' && github.event_name == 'push' && github.ref == 'refs/heads/trunk' }}"
run: ./gradlew publishAllPublicationsToSonatypeSnapshots
env:
ORG_GRADLE_PROJECT_sonatypeUsername: "${{ secrets.SONATYPE_USERNAME }}"
ORG_GRADLE_PROJECT_sonatypePassword: "${{ secrets.SONATYPE_PASSWORD }}"
- name: "publish (pre-)release to maven central"
if: "${{ env.STATUS == 'release' && github.event_name == 'release' }}"
run: ./gradlew publishReleaseCentralPortalBundle
env:
ORG_GRADLE_PROJECT_sonatypeUsername: "${{ secrets.SONATYPE_USERNAME }}"
ORG_GRADLE_PROJECT_sonatypePassword: "${{ secrets.SONATYPE_PASSWORD }}"
ORG_GRADLE_PROJECT_signingKey: "${{ secrets.SIGNING_KEY }}"
ORG_GRADLE_PROJECT_signingPassword: "${{ secrets.SIGNING_PASSWORD }}"
- name: Parse tag
if: "${{ github.event_name == 'push' && contains(github.ref, '-beta.') }}"
id: vars
run: echo ::set-output name=tag::${GITHUB_REF#refs/*/}
- name: Create changelog and Pre-Release
if: "${{ github.event_name == 'push' && contains(github.ref, '-beta.') }}"
uses: MC-Machinations/auto-release-changelog@v1.1.3
with:
token: ${{ secrets.RELEASE_TOKEN }}
title: CarbonChat ${{ steps.vars.outputs.tag }}
pre-release: true
files: |
build/libs/carbonchat-paper-*.jar
build/libs/carbonchat-velocity-*.jar
build/libs/carbonchat-fabric-*.jar
- name: Publish (Pre-)Release to Modrinth
if: "${{ env.STATUS == 'release' && github.event_name == 'release' }}"
run: ./gradlew :carbonchat-paper:publishModrinth :carbonchat-velocity:publishModrinth :carbonchat-fabric:publishModrinth
env:
MODRINTH_TOKEN: "${{ secrets.MODRINTH_TOKEN }}"
RELEASE_NOTES: "${{ github.event.release.body }}"
- name: Publish (Pre-)Release to Hangar
if: "${{ env.STATUS == 'release' && github.event_name == 'release' }}"
run: ./gradlew publishAllPublicationsToHangar
env:
HANGAR_UPLOAD_KEY: "${{ secrets.HANGAR_UPLOAD_KEY }}"
RELEASE_NOTES: "${{ github.event.release.body }}"
- name: Upload Artifacts
uses: actions/upload-artifact@v7
with:
name: Jars
path: build/libs/*.jar
smoketest:
needs: build
runs-on: ubuntu-latest
services:
postgres:
image: postgres:13
env:
POSTGRES_USER: username
POSTGRES_PASSWORD: password
POSTGRES_DB: carbon
ports:
- 5432:5432
options: >-
--health-cmd pg_isready
--health-interval 10s
--health-timeout 5s
--health-retries 5
mariadb:
image: mariadb:10.11
env:
MARIADB_USER: username
MARIADB_PASSWORD: password
MARIADB_ROOT_PASSWORD: rootpassword
MARIADB_DATABASE: carbon
ports:
- 3306:3306
options: >-
--health-cmd="mysqladmin ping"
--health-interval=10s
--health-timeout=5s
--health-retries=3
strategy:
matrix:
java: [ 21 ]
fail-fast: true
steps:
- uses: actions/checkout@v6
- name: JDK ${{ matrix.java }}
uses: actions/setup-java@v5
with:
java-version: ${{ matrix.java }}
distribution: 'temurin'
- name: Setup Gradle
uses: gradle/actions/setup-gradle@v6
# gradle build action can't handle project dir local caches
- uses: actions/cache@v5
name: Cache Loom Files
with:
path: |
.gradle/loom-cache
key: ${{ runner.os }}-gradle-${{ hashFiles('**/libs.versions.*', '**/*.gradle*', '**/gradle-wrapper.properties') }}
restore-keys: ${{ runner.os }}-gradle-
- uses: actions/cache@v5
name: Cache Smoke Test Files
with:
path: |
paper/build/tmp/smokeTest/cache
paper/build/tmp/smokeTest/libraries
paper/build/tmp/smokeTest/plugins/CarbonChat/libraries
paper/build/tmp/smokeTest/world
paper/build/tmp/smokeTest/world_nether
paper/build/tmp/smokeTest/world_the_end
key: ${{ runner.os }}-gradle-${{ hashFiles('**/libs.versions.*', '**/*.gradle*', '**/gradle-wrapper.properties') }}
restore-keys: ${{ runner.os }}-gradle-smoketest-
- name: Prime Build
run: ./gradlew build --stacktrace
- name: Smoke test (Paper, JSON)
run: ./gradlew :carbonchat-paper:runServer -PsmokeTest=true -PsmokeTestMode=json
timeout-minutes: 5
- name: Smoke test (Paper, H2)
run: ./gradlew :carbonchat-paper:runServer -PsmokeTest=true -PsmokeTestMode=h2
timeout-minutes: 5
- name: Smoke test (Paper, MariaDB)
run: ./gradlew :carbonchat-paper:runServer -PsmokeTest=true -PsmokeTestMode=mariadb
timeout-minutes: 5
- name: Smoke test (Paper, Postgres)
run: ./gradlew :carbonchat-paper:runServer -PsmokeTest=true -PsmokeTestMode=postgres
timeout-minutes: 5
================================================
FILE: .gitignore
================================================
# Compiled class file
*.class
# Kotlin temp files
.kotlin/
# Log file
*.log
# BlueJ files
*.ctxt
# Mobile Tools for Java (J2ME)
.mtj.tmp/
# Package Files #
*.jar
*.war
*.ear
*.zip
*.tar.gz
*.rar
# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
hs_err_pid*
*.iml
*.ipr
*.iws
/out/
/bin/
# User-specific stuff
.idea/**/workspace.xml
.idea/**/tasks.xml
.idea/**/usage.statistics.xml
.idea/**/dictionaries
.idea/**/shelf
/.idea/
# Generated files
.idea/**/contentModel.xml
# Sensitive or high-churn files
.idea/**/dataSources/
.idea/**/dataSources.ids
.idea/**/dataSources.local.xml
.idea/**/sqlDataSources.xml
.idea/**/dynamic.xml
.idea/**/uiDesigner.xml
.idea/**/dbnavigator.xml
# Gradle
.idea/**/gradle.xml
.idea/**/libraries
# Gradle and Maven with auto-import
# When using Gradle or Maven with auto-import, you should exclude module files,
# since they will be recreated, and may cause churn. Uncomment if using
# auto-import.
.idea/modules.xml
.idea/*.iml
.idea/modules
.idea/misc.xml
# Dolphin browser keeps recreating this
.directory
# Gradle
.gradle
**/build/
!src/**/build/
# Ignore Gradle GUI config
gradle-app.setting
# Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored)
!gradle-wrapper.jar
# Cache of project
.gradletasknamecache
# Mac filesystem dust
.DS_Store/
.DS_Store
**/run/
**/run2/
**/run-plugins.yml
================================================
FILE: LICENSE
================================================
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc.
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
Copyright (C)
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see .
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
Copyright (C)
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
.
================================================
FILE: LICENSE_HEADER
================================================
CarbonChat
Copyright (c) 2024 Josua Parks (Vicarious)
Contributors
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see .
================================================
FILE: README.md
================================================
Carbon is a modern chat Java Edition plugin built on channels, with just about every single setting and format configurable.
## Support
Support is given through [GitHub Issues](https://github.com/Hexaoxide/Carbon/issues)
and [Discord](https://discord.gg/S8s75Yf).
Please use the discord for help setting up the plugin, and use issues for bug reports.
## Checkstyle
Carbon uses (a fork of) checkstyle to ensure code style is consistent across the entire project.
For checkstyle support in IDEA:
1. Install the [checkstyle plugin](https://github.com/jshiell/checkstyle-idea).
2. Compile https://gitlab.com/stellardrift/stylecheck
3. `Settings` -> `Tools` -> `Checkstyle` `Third-Party Checks`, add the compiled stylecheck jar
4. While still in the `Checkstyle` tab, go to `Configuration File`, add `.checkstyle/checkstyle.xml` and tick the check
box.
================================================
FILE: api/build.gradle.kts
================================================
plugins {
id("carbon.publishing-conventions")
alias(libs.plugins.javadoc.links)
}
description = "API for interfacing with the CarbonChat Minecraft mod/plugin"
dependencies {
// Doesn't add any dependencies, only version constraints
api(platform(libs.adventureBom))
// Provided by platform
compileOnlyApi(libs.adventureApi)
compileOnlyApi(libs.adventureTextSerializerPlain)
compileOnlyApi(libs.adventureTextSerializerLegacy)
compileOnlyApi(libs.adventureTextSerializerGson) {
exclude("com.google.code.gson")
}
compileOnlyApi(libs.minimessage)
compileOnlyApi(libs.checkerQual)
// Provided by Minecraft
compileOnlyApi(libs.gson)
}
================================================
FILE: api/src/main/java/net/draycia/carbon/api/CarbonChat.java
================================================
/*
* CarbonChat
*
* Copyright (c) 2024 Josua Parks (Vicarious)
* Contributors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see .
*/
package net.draycia.carbon.api;
import net.draycia.carbon.api.channels.ChannelRegistry;
import net.draycia.carbon.api.event.CarbonEvent;
import net.draycia.carbon.api.event.CarbonEventHandler;
import net.draycia.carbon.api.users.UserManager;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.framework.qual.DefaultQualifier;
/**
* The {@link CarbonChat} interface is the gateway to interacting with the majority of the CarbonChat API.
*
*
Instances may be obtained through {@link CarbonChatProvider#carbonChat()} once Carbon is loaded.
*
*
On most platforms, you should use the provided load order mechanism to ensure your addon loads after
* Carbon.
*
*
On Fabric, use the {@code carbonchat} entrypoint (type: {@code Consumer}) to have a callback
* when Carbon is loaded.
*
* @since 1.0.0
*/
@DefaultQualifier(NonNull.class)
public interface CarbonChat {
/**
* The {@link CarbonEventHandler event handler}, used for listening to
* and emitting {@link CarbonEvent events}.
*
* @return the event handler
* @since 2.0.0
*/
CarbonEventHandler eventHandler();
/**
* The server that carbon is running on.
*
* @return the server
* @since 2.0.0
*/
CarbonServer server();
/**
* The user manager.
*
* @return the user manager
* @since 3.0.0
*/
UserManager userManager();
/**
* The registry that channels are registered to.
*
* @return the channel registry
* @since 2.0.0
*/
ChannelRegistry channelRegistry();
}
================================================
FILE: api/src/main/java/net/draycia/carbon/api/CarbonChatProvider.java
================================================
/*
* CarbonChat
*
* Copyright (c) 2024 Josua Parks (Vicarious)
* Contributors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see .
*/
package net.draycia.carbon.api;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.checker.nullness.qual.Nullable;
import org.checkerframework.framework.qual.DefaultQualifier;
import org.jetbrains.annotations.ApiStatus;
/**
* Static accessor for the {@link CarbonChat} instance.
*
* @since 1.0.0
*/
@DefaultQualifier(NonNull.class)
public final class CarbonChatProvider {
private static @Nullable CarbonChat instance;
private CarbonChatProvider() {
}
/**
* Registers the {@link CarbonChat} implementation.
*
* @param carbonChat the carbon implementation
* @since 1.0.0
*/
@ApiStatus.Internal
public static void register(final CarbonChat carbonChat) {
CarbonChatProvider.instance = carbonChat;
}
/**
* Gets the currently registered {@link CarbonChat} implementation.
*
* @return the registered carbon implementation
* @since 1.0.0
*/
public static CarbonChat carbonChat() {
if (CarbonChatProvider.instance == null) {
throw new IllegalStateException("CarbonChat not initialized!");
}
return CarbonChatProvider.instance;
}
}
================================================
FILE: api/src/main/java/net/draycia/carbon/api/CarbonServer.java
================================================
/*
* CarbonChat
*
* Copyright (c) 2024 Josua Parks (Vicarious)
* Contributors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see .
*/
package net.draycia.carbon.api;
import java.util.List;
import net.draycia.carbon.api.users.CarbonPlayer;
import net.kyori.adventure.audience.Audience;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.framework.qual.DefaultQualifier;
/**
* The server that carbon is running on.
*
* @since 2.0.0
*/
@DefaultQualifier(NonNull.class)
public interface CarbonServer extends Audience {
/**
* The server's console.
*
* @return the server's console
* @since 2.0.0
*/
Audience console();
/**
* The players that are online on the server.
*
* @return the online players
* @since 2.0.0
*/
List players();
}
================================================
FILE: api/src/main/java/net/draycia/carbon/api/channels/ChannelPermissionResult.java
================================================
/*
* CarbonChat
*
* Copyright (c) 2024 Josua Parks (Vicarious)
* Contributors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see .
*/
package net.draycia.carbon.api.channels;
import java.util.function.Supplier;
import net.kyori.adventure.text.Component;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.framework.qual.DefaultQualifier;
/**
* Represents the result of a channel permission check.
*
* @since 3.0.0
*/
@DefaultQualifier(NonNull.class)
public interface ChannelPermissionResult {
/**
* Check whether the action checked was permitted.
*
* @return permitted
* @since 3.0.0
*/
boolean permitted();
/**
* Reason for permission being denied. When the action
* was permitted, this should be equal to {@link Component#empty()}.
*
* @return deny reason
* @since 3.0.0
*/
Component reason();
/**
* Returns a result denoting that the player is permitted for the action.
*
* @return that the action is allowed
* @since 3.0.0
*/
static ChannelPermissionResult allowed() {
return ChannelPermissionResultImpl.ALLOWED;
}
/**
* Returns a result denoting that the action is denied for the player.
*
* @param reason the reason the action was denied
* @return that the action is denied
* @since 3.0.0
*/
static ChannelPermissionResult denied(final Component reason) {
return new ChannelPermissionResultImpl(false, () -> reason);
}
/**
* Returns a result denoting that the action is denied for the player.
*
* @param reason the reason the action was denied
* @return that the action is denied
* @since 3.0.0
*/
static ChannelPermissionResult denied(final Supplier reason) {
return new ChannelPermissionResultImpl(false, reason);
}
/**
* Create a {@link ChannelPermissionResult} based on {@code allowed},
* computing {@code denyReason} when needed.
*
* @param allowed whether the result is allowed
* @param denyReason deny reason supplier
* @return permission result
* @since 3.0.0
*/
static ChannelPermissionResult channelPermissionResult(
final boolean allowed,
final Supplier denyReason
) {
if (allowed) {
return allowed();
}
return denied(denyReason);
}
}
================================================
FILE: api/src/main/java/net/draycia/carbon/api/channels/ChannelPermissionResultImpl.java
================================================
/*
* CarbonChat
*
* Copyright (c) 2024 Josua Parks (Vicarious)
* Contributors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see .
*/
package net.draycia.carbon.api.channels;
import java.util.function.Supplier;
import net.kyori.adventure.text.Component;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.framework.qual.DefaultQualifier;
@DefaultQualifier(NonNull.class)
record ChannelPermissionResultImpl(
boolean permitted,
Supplier reasonSupplier
) implements ChannelPermissionResult {
static final ChannelPermissionResult ALLOWED =
new ChannelPermissionResultImpl(true, Component::empty);
@Override
public Component reason() {
return this.reasonSupplier.get();
}
}
================================================
FILE: api/src/main/java/net/draycia/carbon/api/channels/ChannelPermissions.java
================================================
/*
* CarbonChat
*
* Copyright (c) 2024 Josua Parks (Vicarious)
* Contributors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see .
*/
package net.draycia.carbon.api.channels;
import java.util.function.Function;
import net.draycia.carbon.api.users.CarbonPlayer;
/**
* Permissions handling for a channel.
*
* @since 3.0.0
*/
public interface ChannelPermissions {
/**
* Checks if the player may join this channel.
*
* @param carbonPlayer the player attempting to join
* @return if the player may join
* @since 3.0.0
*/
ChannelPermissionResult joinPermitted(CarbonPlayer carbonPlayer);
/**
* Checks if the player may send messages in this channel.
*
* @param carbonPlayer the player attempting to speak
* @return if the player may speak
* @since 3.0.0
*/
ChannelPermissionResult speechPermitted(CarbonPlayer carbonPlayer);
/**
* Checks if the player may receive messages from this channel.
*
* @param player the player that's receiving messages
* @return if the player may receive messages
* @since 3.0.0
*/
ChannelPermissionResult hearingPermitted(CarbonPlayer player);
/**
* Returns whether the result of {@link #joinPermitted(CarbonPlayer)} is dynamic.
*
*
An example of a dynamic permissions is the built-in party channel that only allows players in a party to join.
*
*
An example of static permissions is the built-in config channels that simply check permission strings. The fact that a player's
* permissions may change during gameplay does not make the permission dynamic, as the server will resend commands on permission changes.
*
*
If the result is static, then we can avoid sending commands to the player that they will just get denied use
* of on execute. If it's dynamic, we must send the command regardless in case they gain permission later.
*
* @return whether the permissions are dynamic
* @since 3.0.0
*/
boolean dynamic();
/**
* Creates a new {@link ChannelPermissions} that performs the same check for
* {@link #joinPermitted(CarbonPlayer)}, {@link #hearingPermitted(CarbonPlayer)},
* and {@link #speechPermitted(CarbonPlayer)}.
*
* @param check permission check
* @return new permissions object
* @since 3.0.0
*/
static ChannelPermissions uniformDynamic(final Function check) {
return new ChannelPermissions() {
@Override
public ChannelPermissionResult joinPermitted(final CarbonPlayer player) {
return check.apply(player);
}
@Override
public ChannelPermissionResult speechPermitted(final CarbonPlayer player) {
return check.apply(player);
}
@Override
public ChannelPermissionResult hearingPermitted(final CarbonPlayer player) {
return check.apply(player);
}
@Override
public boolean dynamic() {
return true;
}
};
}
}
================================================
FILE: api/src/main/java/net/draycia/carbon/api/channels/ChannelRegistry.java
================================================
/*
* CarbonChat
*
* Copyright (c) 2024 Josua Parks (Vicarious)
* Contributors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see .
*/
package net.draycia.carbon.api.channels;
import java.util.NoSuchElementException;
import java.util.Set;
import java.util.function.Consumer;
import net.kyori.adventure.key.Key;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.checker.nullness.qual.Nullable;
/**
* Registry for {@link ChatChannel chat channels}.
*
* @since 2.0.0
*/
public interface ChannelRegistry {
/**
* Registers the chat channel with its key.
*
*
Registrations will persist when reloading Carbon's configuration.
*
* @param channel the channel to register
* @since 3.0.0
*/
void register(ChatChannel channel);
/**
* Retrieve a channel by its key. If there is no matching channel,
* returns {@code null}.
*
* @param key the channel's key
* @return the channel
* @since 3.0.0
*/
@Nullable ChatChannel channel(Key key);
/**
* Gets the key for the default channel.
*
* @return the default key
* @since 3.0.0
*/
@NonNull Key defaultKey();
/**
* Gets the default channel.
*
* @return the default value
* @since 3.0.0
*/
@NonNull ChatChannel defaultChannel();
/**
* Gets the list of registered channel keys.
*
* @return the registered channel keys
* @since 3.0.0
*/
@NonNull Set keys();
/**
* Retrieve a channel by its key. If there is no matching channel,
* returns {@link #defaultChannel() the default channel}.
*
* @param key the channel key
* @return the channel, or the default one
* @since 3.0.0
*/
ChatChannel channelOrDefault(Key key);
/**
* Retrieve a channel by its key. If there is no matching channel,
* throws {@link NoSuchElementException}.
*
* @param key channel key
* @return channel
* @throws NoSuchElementException when no matching channel is found
* @since 3.0.0
*/
ChatChannel channelOrThrow(Key key);
/**
* The provided action will be executed immediately for all currently registered
* channels.
*
*
When new channels are registered, the action will be invoked again for each new channel.
*
* @param action action
* @since 3.0.0
*/
void allKeys(Consumer action);
/**
* Create a {@link ChannelPermissions channel permissions handler} for the provided base permission string.
*
*
The handler will check the base permission for joins, {@literal .see} for receiving/seeing messages,
* and {@literal .speak} for speaking/sending messages.
*
*
The built-in deny messages are used, same as user-configured config channels.
*
* @param permission permission string
* @return permission handler
* @since 3.0.0
*/
ChannelPermissions permission(String permission);
}
================================================
FILE: api/src/main/java/net/draycia/carbon/api/channels/ChatChannel.java
================================================
/*
* CarbonChat
*
* Copyright (c) 2024 Josua Parks (Vicarious)
* Contributors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see .
*/
package net.draycia.carbon.api.channels;
import java.util.List;
import net.draycia.carbon.api.users.CarbonPlayer;
import net.draycia.carbon.api.util.ChatComponentRenderer;
import net.kyori.adventure.audience.Audience;
import net.kyori.adventure.key.Keyed;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.checker.nullness.qual.Nullable;
import org.checkerframework.framework.qual.DefaultQualifier;
/**
* ChatChannel interface, supplies a formatter and filters recipients.
* Extends Keyed for identification purposes.
*
* @since 2.0.0
*/
@DefaultQualifier(NonNull.class)
public interface ChatChannel extends Keyed, ChatComponentRenderer {
/**
* Returns the permissions handler for the channel.
*
* @return the permissions handler
* @since 3.0.0
*/
ChannelPermissions permissions();
/**
* Returns a list of all recipients that will receive messages from the sender.
*
* @param sender the sender of messages
* @return the recipients
* @since 2.0.0
*/
List recipients(CarbonPlayer sender);
/**
* Messages will be sent in this channel if they start with this prefix.
*
* @return the message prefix that sends messages in this channel
* @since 2.0.0
*/
@Nullable String quickPrefix();
/**
* If commands should be registered for this channel.
*
* @return if commands should be registered for this channel.
* @since 2.0.0
*/
boolean shouldRegisterCommands();
/**
* The text that can be used to refer to this channel in commands.
*
* @return this channel's name when used in commands
* @since 2.0.0
*/
String commandName();
/**
* Alternative command names for this channel.
*
* @return alternative command names
* @since 2.0.0
*/
List commandAliases();
/**
* The distance from the sender players must be to receive chat messages.
* Return of '0' means players must be in the same world/server.
* Return of '-1' means there is no radius.
*
* @return the channel radius
* @since 3.0.0
*/
double radius();
/**
* If the empty receipt message should be sent to the sender.
*
* @return Returns true if the channel should display a message when a player is out of range.
* @since 3.0.0
*/
boolean emptyRadiusRecipientsMessage();
/**
* The time in milliseconds between player messages.
* -1 and 0 disable the cooldown for this channel.
*
* @return The message cooldown in millis.
* @since 3.0.0
*/
long cooldown();
/**
* The epoch time (millis) when the player's cooldown expires.
*
* @param player The player
* @return The epoch time (millis) when the player's cooldown expires.
* @since 3.0.0
*/
long playerCooldown(CarbonPlayer player);
/**
* Starts the cooldown timer for the specified player. Duration will be the channel cooldown.
* Returns the player's old cooldown time, if they have one.
*
* @param player The player
* @return The player's old cooldown, or 0 if they don't have one.
* @since 3.0.0
*/
long startCooldown(CarbonPlayer player);
/**
* Whether messages from this channel should be broadcast and sent to other servers.
*
* @return if this channel's messages should be sent cross-server
* @since 3.0.0
*/
boolean shouldCrossServer();
}
================================================
FILE: api/src/main/java/net/draycia/carbon/api/event/Cancellable.java
================================================
/*
* CarbonChat
*
* Copyright (c) 2024 Josua Parks (Vicarious)
* Contributors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see .
*/
package net.draycia.carbon.api.event;
/**
* Marks an event as cancellable.
*
* @since 3.0.0
*/
public interface Cancellable {
/**
* Gets if the event is cancelled.
*
* @return if the event is cancelled
* @since 3.0.0
*/
boolean cancelled();
/**
* Sets the cancelled state.
*
* @param cancelled new cancelled state
* @since 3.0.0
*/
void cancelled(boolean cancelled);
}
================================================
FILE: api/src/main/java/net/draycia/carbon/api/event/CarbonEvent.java
================================================
/*
* CarbonChat
*
* Copyright (c) 2024 Josua Parks (Vicarious)
* Contributors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see .
*/
package net.draycia.carbon.api.event;
/**
* Marker interface for events.
*
* @since 1.0.0
*/
public interface CarbonEvent {
}
================================================
FILE: api/src/main/java/net/draycia/carbon/api/event/CarbonEventHandler.java
================================================
/*
* CarbonChat
*
* Copyright (c) 2024 Josua Parks (Vicarious)
* Contributors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see .
*/
package net.draycia.carbon.api.event;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.framework.qual.DefaultQualifier;
/**
* The {@link CarbonEventHandler} is responsible for managing {@link CarbonEventSubscription event subscriptions}
* and emitting {@link CarbonEvent events}.
*
* @since 3.0.0
*/
@DefaultQualifier(NonNull.class)
public interface CarbonEventHandler {
/**
* Registers a subscriber for the given event class.
*
* @param eventClass the class to listen for
* @param subscriber the subscriber that's executed when the event is emitted
* @param the class to listen for
* @return the subscription, so that it may be unregistered
* @since 2.0.0
*/
CarbonEventSubscription subscribe(
Class eventClass,
CarbonEventSubscriber subscriber
);
/**
* Registers a subscriber for the given event class.
* Includes extra values to control when the consumer is executed.
*
* @param eventClass the class to listen for
* @param order the order of the consumer
* @param acceptsCancelled if the consumer should be executed if the event is cancelled early
* @param subscriber the consumer that's executed when the event is emitted
* @param the class to listen for
* @return the subscription, so that it may be unregistered
* @since 2.0.0
*/
CarbonEventSubscription subscribe(
Class eventClass,
int order,
boolean acceptsCancelled,
CarbonEventSubscriber subscriber
);
/**
* Emits the supplied event.
*
*
Events are modified in place, meaning you must keep a reference to the event
* yourself if you wish to inspect it's state after this call.
*
* @param event the event to be emitted
* @param the class to emit
* @since 2.0.0
*/
void emit(T event);
}
================================================
FILE: api/src/main/java/net/draycia/carbon/api/event/CarbonEventSubscriber.java
================================================
/*
* CarbonChat
*
* Copyright (c) 2024 Josua Parks (Vicarious)
* Contributors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see .
*/
package net.draycia.carbon.api.event;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.framework.qual.DefaultQualifier;
/**
* An EventSubscriber.
*
* @param CarbonEvent implementations
* @since 3.0.0
*/
@DefaultQualifier(NonNull.class)
public interface CarbonEventSubscriber {
/**
* Invokes this event consumer.
*
* @param event the event
* @throws Throwable if an exception is thrown
* @since 1.0.0
*/
void on(T event) throws Throwable;
}
================================================
FILE: api/src/main/java/net/draycia/carbon/api/event/CarbonEventSubscription.java
================================================
/*
* CarbonChat
*
* Copyright (c) 2024 Josua Parks (Vicarious)
* Contributors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see .
*/
package net.draycia.carbon.api.event;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.framework.qual.DefaultQualifier;
/**
* A subscription to a specific event type.
*
* @param event type
* @since 3.0.0
*/
@DefaultQualifier(NonNull.class)
public interface CarbonEventSubscription {
/**
* Gets the event type.
*
* @return the event type
* @since 3.0.0
*/
Class event();
/**
* Gets the {@link CarbonEventSubscriber subscriber}.
*
* @return the subscriber
* @since 3.0.0
*/
CarbonEventSubscriber subscriber();
/**
* Disposes this subscription.
*
*
The subscriber held by this subscription will no longer receive events.
*
* @since 3.0.0
*/
void dispose();
}
================================================
FILE: api/src/main/java/net/draycia/carbon/api/event/events/CarbonChannelRegisterEvent.java
================================================
/*
* CarbonChat
*
* Copyright (c) 2024 Josua Parks (Vicarious)
* Contributors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see .
*/
package net.draycia.carbon.api.event.events;
import java.util.Set;
import java.util.function.Consumer;
import net.draycia.carbon.api.channels.ChannelRegistry;
import net.draycia.carbon.api.event.CarbonEvent;
import net.kyori.adventure.key.Key;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.framework.qual.DefaultQualifier;
/**
* {@link CarbonEvent} that's called after new channels are registered.
*
*
Note that some invocations of this event may be too early for
* API consumers to be notified. {@link ChannelRegistry#allKeys(Consumer)}
* is provided as a helper for when knowledge of all registered channels
* is needed.
*
* @since 3.0.0
*/
@DefaultQualifier(NonNull.class)
public interface CarbonChannelRegisterEvent extends CarbonEvent {
/**
* Gets the channel registry.
*
* @return the channel registry
* @since 3.0.0
*/
ChannelRegistry channelRegistry();
/**
* Gets the key(s) that were registered to trigger this event.
*
* @return key(s) registered
* @since 3.0.0
*/
Set registered();
}
================================================
FILE: api/src/main/java/net/draycia/carbon/api/event/events/CarbonChatEvent.java
================================================
/*
* CarbonChat
*
* Copyright (c) 2024 Josua Parks (Vicarious)
* Contributors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see .
*/
package net.draycia.carbon.api.event.events;
import java.util.List;
import net.draycia.carbon.api.channels.ChatChannel;
import net.draycia.carbon.api.event.Cancellable;
import net.draycia.carbon.api.event.CarbonEvent;
import net.draycia.carbon.api.users.CarbonPlayer;
import net.draycia.carbon.api.util.KeyedRenderer;
import net.kyori.adventure.audience.Audience;
import net.kyori.adventure.chat.SignedMessage;
import net.kyori.adventure.text.Component;
import org.checkerframework.checker.nullness.qual.MonotonicNonNull;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.framework.qual.DefaultQualifier;
/**
* Event that's called when chat components are rendered for online players.
*
* @since 2.0.0
*/
@DefaultQualifier(NonNull.class)
public interface CarbonChatEvent extends CarbonEvent, Cancellable {
/**
* Get the renderers used to construct components for each of the recipients. The returned list
* is mutable.
*
* @return renderers
* @since 2.0.0
*/
List renderers();
/**
* If the message is being previewed by the player.
*
* @return if the message is being previewed
* @since 3.0.0
*/
@MonotonicNonNull SignedMessage signedMessage();
/**
* Get the sender of the message.
*
* @return The message sender.
* @since 2.0.0
*/
CarbonPlayer sender();
/**
* Get the original message that was sent.
*
* @return The original message.
* @since 2.0.0
*/
Component originalMessage();
/**
* Get the chat message that will be sent.
*
* @return The chat message.
* @since 2.0.0
*/
Component message();
/**
* Set the chat message that will be sent.
*
* @param message new message
* @since 2.0.0
*/
void message(final Component message);
/**
* The chat channel the message was sent in.
*
* @return the chat channel
* @since 2.0.0
*/
@MonotonicNonNull ChatChannel chatChannel();
/**
* The recipients of the message.
* List is mutable and elements may be added/removed.
*
* @return the recipients of the message.
* entries may be players, console, or other audience implementations
* @since 2.0.0
*/
List recipients();
}
================================================
FILE: api/src/main/java/net/draycia/carbon/api/event/events/CarbonPrivateChatEvent.java
================================================
/*
* CarbonChat
*
* Copyright (c) 2024 Josua Parks (Vicarious)
* Contributors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see .
*/
package net.draycia.carbon.api.event.events;
import net.draycia.carbon.api.event.Cancellable;
import net.draycia.carbon.api.event.CarbonEvent;
import net.draycia.carbon.api.users.CarbonPlayer;
import net.kyori.adventure.text.Component;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.framework.qual.DefaultQualifier;
/**
* Called whenever a player privately messages another player.
*
* @since 3.0.0
*/
@DefaultQualifier(NonNull.class)
public interface CarbonPrivateChatEvent extends CarbonEvent, Cancellable {
/**
* Sets the message that will be sent.
*
* @param message the new message
* @throws NullPointerException if message is null
* @since 3.0.0
*/
void message(Component message);
/**
* The message that will be sent.
*
* @return the message
* @since 3.0.0
*/
Component message();
/**
* The message sender.
*
* @return the sender of the message
* @since 3.0.0
*/
CarbonPlayer sender();
/**
* The message recipient.
*
* @return the recipient of the message
* @since 3.0.0
*/
CarbonPlayer recipient();
}
================================================
FILE: api/src/main/java/net/draycia/carbon/api/event/events/ChannelSwitchEvent.java
================================================
/*
* CarbonChat
*
* Copyright (c) 2024 Josua Parks (Vicarious)
* Contributors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see .
*/
package net.draycia.carbon.api.event.events;
import net.draycia.carbon.api.channels.ChatChannel;
import net.draycia.carbon.api.event.CarbonEvent;
import net.draycia.carbon.api.users.CarbonPlayer;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.framework.qual.DefaultQualifier;
/**
* Called when a player switches channels.
*
* @since 3.0.0
*/
@DefaultQualifier(NonNull.class)
public interface ChannelSwitchEvent extends CarbonEvent {
/**
* The player switching channels.
*
* @since 3.0.0
*/
CarbonPlayer player();
/**
* The channel the player is switching to.
*
* @since 3.0.0
*/
ChatChannel channel();
/**
* Sets the player's new channel.
*
* @param chatChannel the new channel
* @since 3.0.0
*/
void channel(final ChatChannel chatChannel);
}
================================================
FILE: api/src/main/java/net/draycia/carbon/api/event/events/PartyJoinEvent.java
================================================
/*
* CarbonChat
*
* Copyright (c) 2024 Josua Parks (Vicarious)
* Contributors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see .
*/
package net.draycia.carbon.api.event.events;
import java.util.UUID;
import net.draycia.carbon.api.event.CarbonEvent;
import net.draycia.carbon.api.users.CarbonPlayer;
import net.draycia.carbon.api.users.Party;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.framework.qual.DefaultQualifier;
/**
* Called when a player is added to a {@link Party}.
*
* @since 3.0.0
*/
@DefaultQualifier(NonNull.class)
public interface PartyJoinEvent extends CarbonEvent {
/**
* ID of the player joining a party.
*
*
The player's {@link CarbonPlayer#party()} field is not guaranteed to be updated immediately,
* especially if the change needs to propagate cross-server.
*
* @return player id
* @since 3.0.0
*/
UUID playerId();
/**
* The party being joined.
*
*
{@link Party#members()} will reflect the new member.
*
* @return party
* @since 3.0.0
*/
Party party();
}
================================================
FILE: api/src/main/java/net/draycia/carbon/api/event/events/PartyLeaveEvent.java
================================================
/*
* CarbonChat
*
* Copyright (c) 2024 Josua Parks (Vicarious)
* Contributors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see .
*/
package net.draycia.carbon.api.event.events;
import java.util.UUID;
import net.draycia.carbon.api.event.CarbonEvent;
import net.draycia.carbon.api.users.CarbonPlayer;
import net.draycia.carbon.api.users.Party;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.framework.qual.DefaultQualifier;
/**
* Called when a player is removed from a {@link Party}.
*
* @since 3.0.0
*/
@DefaultQualifier(NonNull.class)
public interface PartyLeaveEvent extends CarbonEvent {
/**
* ID of the player leaving a party.
*
*
The player's {@link CarbonPlayer#party()} field is not guaranteed to be updated immediately,
* especially if the change needs to propagate cross-server.
*
* @return player id
* @since 3.0.0
*/
UUID playerId();
/**
* The party being left.
*
*
{@link Party#members()} will reflect the removed member.
*
* @return party
* @since 3.0.0
*/
Party party();
}
================================================
FILE: api/src/main/java/net/draycia/carbon/api/users/CarbonPlayer.java
================================================
/*
* CarbonChat
*
* Copyright (c) 2024 Josua Parks (Vicarious)
* Contributors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see .
*/
package net.draycia.carbon.api.users;
import java.util.List;
import java.util.Locale;
import java.util.Set;
import java.util.UUID;
import java.util.concurrent.CompletableFuture;
import net.draycia.carbon.api.channels.ChatChannel;
import net.draycia.carbon.api.util.InventorySlot;
import net.kyori.adventure.audience.Audience;
import net.kyori.adventure.identity.Identified;
import net.kyori.adventure.key.Key;
import net.kyori.adventure.text.Component;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.checker.nullness.qual.Nullable;
import org.checkerframework.framework.qual.DefaultQualifier;
/**
* Generic abstraction for players.
*
* @since 2.0.0
*/
@DefaultQualifier(NonNull.class)
public interface CarbonPlayer extends Audience, Identified {
/**
* Returns the distance from the other {@link CarbonPlayer}, or -1 if the players are not in the same world.
*
* @param other the other player
* @return the distance from the other player, or -1
* @since 3.0.0
*/
double distanceSquaredFrom(CarbonPlayer other);
/**
* Returns if both players are in the same world or server.
*
* @param other the other player
* @return if both players are in the same world/server
* @since 3.0.0
*/
boolean sameWorldAs(CarbonPlayer other);
/**
* Gets the player's username.
*
* @return the player's username
* @since 2.0.0
*/
String username();
/**
* Returns the player's display name.
*
*
The display name is the effective or displayed name of a player.
* When the player has a nickname set, either through Carbon or the platform,
* it will be reflected here. Else, a plain text component representing
* the player's name may be returned.
*
* @return the player's display name
* @since 3.0.0
*/
Component displayName();
/**
* Checks if the player has a nickname set.
*
*
Will always return {@code false} when Carbon's nickname management is disabled.
*
* @return if the player has a nickname set
* @see #nickname()
* @see #nickname(Component)
* @since 3.0.0
*/
boolean hasNickname();
/**
* Gets the player's nickname, shown in places like chat and tab menu.
*
*
Will always return {@code null} when Carbon's nickname management is disabled.
Setting {@code null} will remove any current nickname.
*
*
Won't have any visible effect when Carbon's nickname management is disabled.
*
* @param nickname the new nickname
* @see #hasNickname()
* @see #nickname()
* @see #displayName()
* @since 3.0.0
*/
void nickname(@Nullable Component nickname);
/**
* The player's UUID, often used for identification purposes.
*
* @return the player's UUID
* @since 2.0.0
*/
UUID uuid();
/**
* Creates the chat component for the item in the {@link InventorySlot}, or null if the slot is empty.
*
* @param slot the inventory slot containing the item
* @return the chat component for the item in the slot, or null if the slot is empty
* @since 2.0.0
*/
@Nullable Component createItemHoverComponent(InventorySlot slot);
/**
* The player's locale.
*
* @return the player's locale, or null if offline
* @since 2.0.0
*/
@Nullable Locale locale();
/**
* The player's selected channel, or null if one isn't set.
*
* @return the player's selected channel
* @since 2.0.0
*/
@Nullable ChatChannel selectedChannel();
/**
* Sets the player's selected channel.
*
* @param chatChannel the channel
* @since 2.0.0
*/
void selectedChannel(@Nullable ChatChannel chatChannel);
/**
* Determines which channel the message should go to, and removes any channel prefixes from the message.
*
* @param message the message to be sent
* @return the channel and message
* @since 3.0.0
*/
ChannelMessage channelForMessage(Component message);
/**
* A message and which channel it should be sent in.
*
* @param message The channel message without any prefixes
* @param channel The channel the message should be sent to
* @since 3.0.0
*/
record ChannelMessage(Component message, ChatChannel channel) {}
/**
* Checks if the player has the specified permission.
*
* @param permission the permission to check
* @return if the player has the permission
* @since 2.0.0
*/
boolean hasPermission(String permission);
/**
* Returns the player's primary group.
*
* @return the player's primary group
* @since 2.0.0
*/
String primaryGroup();
/**
* Returns the complete list of groups the player is in.
*
* @return the groups the player is in
* @since 2.0.0
*/
List groups();
/**
* Returns if the player is muted.
*
* @return if the player is muted
* @since 2.0.0
*/
boolean muted();
/**
* The time the mute will expire, in epoch millis.
*
* @return the mute expiration time
* @since 3.0.0
*/
long muteExpiration();
/**
* Mutes and unmutes the player.
*
* @param muted if the player is now muted
* @since 2.0.0
*/
void muted(boolean muted);
/**
* Sets the epoch time the player's mute will expire.
*
* @param epochMillis the expiration time
* @since 3.0.0
*/
void muteExpiration(long epochMillis);
/**
* Gets the ids of the players this player is currently ignoring.
*
* @return the players currently ignored
* @since 3.0.0
*/
Set ignoring();
/**
* Checks if the other player is being ignored by this player.
*
* @param player the potential source of a message
* @return if this player is ignoring the sender
* @since 2.0.5
*/
boolean ignoring(UUID player);
/**
* Checks if the other player is being ignored by this player.
*
* @param player the potential source of a message
* @return if this player is ignoring the sender
* @since 2.0.0
*/
boolean ignoring(CarbonPlayer player);
/**
* Adds the player to and removes the player from the ignore list.
*
* @param player the player to be added/removed
* @param nowIgnoring if the player should be ignored
* @since 2.0.0
*/
void ignoring(UUID player, boolean nowIgnoring);
/**
* Adds the player to and removes the player from the ignore list.
*
* @param player the player to be added/removed
* @param nowIgnoring if the player should be ignored
* @since 2.0.0
*/
void ignoring(CarbonPlayer player, boolean nowIgnoring);
/**
* Returns if the player is deafened and unable to read messages.
*
* @return if the player is deafened
* @since 2.0.0
*/
boolean deafened();
/**
* Deafens and undeafens the player.
*
* @since 2.0.0
*/
void deafened(boolean deafened);
/**
* Returns if the player is spying on messages and able to read muted/private messages.
*
* @return if the player is spying on messages
* @since 2.0.0
*/
boolean spying();
/**
* Sets and unsets the player's ability to spy.
*
* @since 2.0.0
*/
void spying(boolean spying);
/**
* Controls if the player should receive direct messages or if they should be hidden.
*
* @return if the player is ignoring direct messages
* @since 3.0.0
*/
boolean ignoringDirectMessages();
/**
* Sets whether the player should receive direct messages or if they should be hidden.
*
* @param ignoring if the player is ignoring direct messages
* @since 3.0.0
*/
void ignoringDirectMessages(boolean ignoring);
/**
* Sends the message as the player.
*
* @param message the message to be sent
* @since 2.0.0
*/
void sendMessageAsPlayer(String message);
/**
* Returns whether the player is online.
*
* @return if the player is online.
* @since 2.0.0
*/
boolean online();
/**
* The UUID of the player that replies will be sent to.
*
* @return the player's reply target
* @since 2.0.0
*/
@Nullable UUID whisperReplyTarget();
/**
* Sets the whisper reply target for this player.
*
* @param uuid the uuid of the reply target
* @since 2.0.0
*/
void whisperReplyTarget(@Nullable UUID uuid);
/**
* The last player this player has whispered.
*
* @return the player's last whisper target
* @since 2.0.0
*/
@Nullable UUID lastWhisperTarget();
/**
* Sets the last player this player has whispered.
*
* @param uuid the uuid of the whisper target
* @since 2.0.0
*/
void lastWhisperTarget(@Nullable UUID uuid);
/**
* If this player is vanished in another supported plugin.
* Other players will be unaware of this player.
* There is no way to set this state through Carbon, we do not store this information; but merely bridge it.
*
* @return If this player is vanished in another plugin.
* @since 2.0.0
*/
boolean vanished();
/**
* Whether this player can see the other player.
*
* @param other the other, potentially vanished, player
* @return if this player is aware of the other player
* @since 2.0.0
*/
boolean awareOf(CarbonPlayer other);
/**
* A list of all the channels the player has left
* using the leave command.
*
*
The returned collection is immutable, use
* {@link #joinChannel(ChatChannel)} and {@link #leaveChannel(ChatChannel)} to mutate.
*
* @return a list of the channels.
* @since 3.0.0
*/
List leftChannels();
/**
* Join a channel for this player if they have left it.
*
* @param channel the channel to join.
* @since 3.0.0
*/
void joinChannel(ChatChannel channel);
/**
* Leave a channel for this player.
*
* @param channel the channel to leave.
* @since 3.0.0
*/
void leaveChannel(ChatChannel channel);
/**
* Get this player's current {@link Party}.
*
* @return party future
* @since 3.0.0
*/
CompletableFuture<@Nullable Party> party();
/**
* Whether the optional chat filters apply to messages send to this player or not.
*
* @return if this player's using the optional chat filters
* @since 3.0.0
*/
boolean applyOptionalChatFilters();
/**
* Whether the optional chat filters apply to messages send to this player or not.
*
* @param applyOptionalChatFilters if this player's using the optional chat filters
* @since 3.0.0
*/
void applyOptionalChatFilters(boolean applyOptionalChatFilters);
}
================================================
FILE: api/src/main/java/net/draycia/carbon/api/users/Party.java
================================================
/*
* CarbonChat
*
* Copyright (c) 2024 Josua Parks (Vicarious)
* Contributors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see .
*/
package net.draycia.carbon.api.users;
import java.util.Set;
import java.util.UUID;
import net.kyori.adventure.text.Component;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.framework.qual.DefaultQualifier;
/**
* Reference to a chat party.
*
* @see UserManager#createParty(Component)
* @see UserManager#party(UUID)
* @since 3.0.0
*/
@DefaultQualifier(NonNull.class)
public interface Party {
/**
* Get the name of this party.
*
* @return party name
* @since 3.0.0
*/
Component name();
/**
* Get the unique id of this party.
*
* @return party id
* @since 3.0.0
*/
UUID id();
/**
* Get a snapshot of the current party members.
*
* @return party members
* @since 3.0.0
*/
Set members();
/**
* Add a user to this party. They will automatically be removed from their previous party if necessary.
*
* @param id user id
* @since 3.0.0
*/
void addMember(UUID id);
/**
* Remove a user from this party.
*
* @param id user id
* @since 3.0.0
*/
void removeMember(UUID id);
/**
* Disband this party. Will remove all members and delete persistent data.
*
* @since 3.0.0
*/
void disband();
}
================================================
FILE: api/src/main/java/net/draycia/carbon/api/users/UserManager.java
================================================
/*
* CarbonChat
*
* Copyright (c) 2024 Josua Parks (Vicarious)
* Contributors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see .
*/
package net.draycia.carbon.api.users;
import java.util.UUID;
import java.util.concurrent.CompletableFuture;
import net.kyori.adventure.text.Component;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.checker.nullness.qual.Nullable;
import org.checkerframework.framework.qual.DefaultQualifier;
/**
* Manager used to load/obtain and save {@link CarbonPlayer CarbonPlayers}.
*
* @since 2.0.0
*/
@DefaultQualifier(NonNull.class)
public interface UserManager {
/**
* Gets the {@link CarbonPlayer} for the provided player {@link UUID}, whether they are online or not.
*
*
Note that the returned user object/future is not guaranteed to be the same for subsequent calls.
*
*
Because of this, the return value should not be cached, it should be queried each time it is needed. The implementation handles caching as is appropriate.
*
* @param uuid the player's id
* @return the player
* @since 3.0.0
*/
CompletableFuture user(UUID uuid);
/**
* Create a new {@link Party} with the specified name.
*
*
Parties with no users will not be saved. Use {@link Party#disband()} to discard.
*
*
The returned reference will expire after one minute, store {@link Party#id()} rather than the instance and use {@link #party(UUID)} to retrieve.
*
* @param name party name
* @return new party
* @since 3.0.0
*/
Party createParty(Component name);
/**
* Look up an existing party by its id.
*
*
As parties that have never had a user are not saved, they are not retrievable here.
*
*
The returned reference will expire after one minute, do not cache it. The implementation handles caching as is appropriate.
*
* @param id party id
* @return existing party
* @see #createParty(Component)
* @since 3.0.0
*/
CompletableFuture<@Nullable Party> party(UUID id);
}
================================================
FILE: api/src/main/java/net/draycia/carbon/api/util/ChatComponentRenderer.java
================================================
/*
* CarbonChat
*
* Copyright (c) 2024 Josua Parks (Vicarious)
* Contributors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see .
*/
package net.draycia.carbon.api.util;
import net.draycia.carbon.api.users.CarbonPlayer;
import net.kyori.adventure.audience.Audience;
import net.kyori.adventure.text.Component;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.framework.qual.DefaultQualifier;
/**
* Renderer used to construct chat components on a per-player basis.
*
* @since 2.0.0
*/
@FunctionalInterface
@DefaultQualifier(NonNull.class)
public interface ChatComponentRenderer {
/**
* Renders a Component for the specified recipient.
*
* @param sender the player that sent the message
* @param recipient a recipient of the message.
* may be a player, console, or other Audience implementations
* @param message the message being sent
* @param originalMessage the original message that was sent
* @return the component to be shown to the recipient,
* or empty if the recipient should not receive the message
* @since 2.0.0
*/
Component render(CarbonPlayer sender,
Audience recipient,
Component message,
Component originalMessage);
}
================================================
FILE: api/src/main/java/net/draycia/carbon/api/util/InventorySlot.java
================================================
/*
* CarbonChat
*
* Copyright (c) 2024 Josua Parks (Vicarious)
* Contributors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see .
*/
package net.draycia.carbon.api.util;
import java.util.List;
/**
* A slot in a player's inventory.
*
* @since 2.0.0
*/
public final class InventorySlot {
/**
* An {@link InventorySlot} instance, usable in chat with the given placeholders.
*
* @param placeholders the placeholders that can be used in chat
* @return the instance
* @since 2.0.0
*/
public static InventorySlot of(final String... placeholders) {
return new InventorySlot(placeholders);
}
private final List placeholders;
private InventorySlot(final String... placeholders) {
this.placeholders = List.of(placeholders);
}
/**
* Returns this slot's placeholders, which can be used in chat to show the item in said slot.
*
* @return this slot's placeholders
* @since 2.0.0
*/
public List placeholders() {
return this.placeholders;
}
public static final InventorySlot HELMET = InventorySlot.of("helm", "helmet", "hat", "head");
public static final InventorySlot CHEST = InventorySlot.of("chest", "chestplate");
public static final InventorySlot LEGS = InventorySlot.of("legs", "leggings");
public static final InventorySlot BOOTS = InventorySlot.of("boots", "feet");
public static final InventorySlot MAIN_HAND = InventorySlot.of("main_hand", "hand", "item");
public static final InventorySlot OFF_HAND = InventorySlot.of("off_hand");
public static List SLOTS = List.of(HELMET, CHEST, LEGS, BOOTS, MAIN_HAND, OFF_HAND);
}
================================================
FILE: api/src/main/java/net/draycia/carbon/api/util/KeyedRenderer.java
================================================
/*
* CarbonChat
*
* Copyright (c) 2024 Josua Parks (Vicarious)
* Contributors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see .
*/
package net.draycia.carbon.api.util;
import net.kyori.adventure.key.Key;
import net.kyori.adventure.key.Keyed;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.framework.qual.DefaultQualifier;
/**
* A {@link ChatComponentRenderer chat renderer} that's identifiable by key.
*
* @since 2.0.0
*/
@DefaultQualifier(NonNull.class)
public interface KeyedRenderer extends Keyed, ChatComponentRenderer {
/**
* Creates a new renderer with the corresponding key.
*
* @param key the renderer's key
* @param renderer the chat renderer
* @return the keyed renderer
* @since 2.0.0
*/
static KeyedRenderer keyedRenderer(final Key key, final ChatComponentRenderer renderer) {
return new KeyedRendererImpl(key, renderer);
}
}
================================================
FILE: api/src/main/java/net/draycia/carbon/api/util/KeyedRendererImpl.java
================================================
/*
* CarbonChat
*
* Copyright (c) 2024 Josua Parks (Vicarious)
* Contributors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see .
*/
package net.draycia.carbon.api.util;
import net.draycia.carbon.api.users.CarbonPlayer;
import net.kyori.adventure.audience.Audience;
import net.kyori.adventure.key.Key;
import net.kyori.adventure.text.Component;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.framework.qual.DefaultQualifier;
@DefaultQualifier(NonNull.class)
record KeyedRendererImpl(Key key, ChatComponentRenderer renderer) implements KeyedRenderer {
@Override
public Component render(
final CarbonPlayer sender,
final Audience recipient,
final Component message,
final Component originalMessage
) {
return this.renderer.render(sender, recipient, message, originalMessage);
}
}
================================================
FILE: build-logic/build.gradle.kts
================================================
plugins {
`kotlin-dsl`
}
repositories {
gradlePluginPortal()
maven("https://oss.sonatype.org/content/repositories/snapshots/") {
mavenContent { snapshotsOnly() }
}
}
dependencies {
implementation(libs.shadow)
implementation(libs.indraCommon)
implementation(libs.cloud.build.logic)
implementation(libs.indraLicenseHeader)
implementation(libs.mod.publish.plugin)
implementation(libs.configurateYaml)
implementation(libs.gremlin.gradle)
implementation(libs.run.task)
implementation(libs.gson)
// https://github.com/gradle/gradle/issues/15383#issuecomment-779893192
implementation(files(libs.javaClass.superclass.protectionDomain.codeSource.location))
}
================================================
FILE: build-logic/settings.gradle.kts
================================================
dependencyResolutionManagement {
versionCatalogs {
create("libs") {
from(files("../gradle/libs.versions.toml"))
}
}
}
================================================
FILE: build-logic/src/main/kotlin/CarbonPermissionsExtension.kt
================================================
import io.leangen.geantyref.TypeToken
import org.gradle.api.file.RegularFileProperty
import org.gradle.api.model.ObjectFactory
import org.gradle.api.provider.ListProperty
import org.gradle.api.provider.Provider
import org.gradle.kotlin.dsl.listProperty
import org.spongepowered.configurate.ConfigurationNode
import org.spongepowered.configurate.yaml.NodeStyle
import org.spongepowered.configurate.yaml.YamlConfigurationLoader
import javax.inject.Inject
abstract class CarbonPermissionsExtension @Inject constructor(private val objects: ObjectFactory) {
abstract val yaml: RegularFileProperty
val permissions: Provider> = create()
private fun create(): ListProperty = objects.listProperty().also {
it.set(yaml.map { file ->
val loader = YamlConfigurationLoader.builder()
.path(file.asFile.toPath())
.nodeStyle(NodeStyle.BLOCK)
.build()
loader.load().childrenMap().map { (name, child) ->
loadPermission(name as String, child)
}
})
it.disallowChanges()
it.finalizeValueOnRead()
}
private fun loadPermission(name: String, node: ConfigurationNode): Permission {
return if (node.isMap) {
Permission(
name,
node.node("description").string,
node.node("children").takeIf { c -> !c.virtual() }
?.get(object : TypeToken>() {})
)
} else {
Permission(name, node.string, null)
}
}
data class Permission(
val string: String,
val description: String?,
val children: Map?
)
}
================================================
FILE: build-logic/src/main/kotlin/CarbonPlatformExtension.kt
================================================
import org.gradle.api.file.RegularFileProperty
abstract class CarbonPlatformExtension {
abstract val productionJar: RegularFileProperty
}
================================================
FILE: build-logic/src/main/kotlin/ConfigurablePluginsExt.kt
================================================
import org.gradle.api.Action
import org.gradle.api.artifacts.ExternalModuleDependency
import org.gradle.api.artifacts.MinimalExternalModuleDependency
import org.gradle.api.provider.ListProperty
import org.gradle.api.provider.Provider
abstract class ConfigurablePluginsExt {
data class DepPlugin(
val dep: Provider,
val op: Action?,
val defaultEnabled: Boolean = false,
val name: String = dep.get().name
)
abstract val gradleDependencyBased: ListProperty
fun dependency(lib: Provider, op: Action? = null) {
gradleDependencyBased.add(DepPlugin(lib, op))
}
fun dependency(lib: Provider, defaultEnabled: Boolean, op: Action? = null) {
gradleDependencyBased.add(DepPlugin(lib, op, defaultEnabled))
}
}
================================================
FILE: build-logic/src/main/kotlin/FetchLuckPermsDownloads.kt
================================================
import org.gradle.api.DefaultTask
import org.gradle.api.file.ProjectLayout
import org.gradle.api.file.RegularFileProperty
import org.gradle.api.tasks.OutputFile
import org.gradle.api.tasks.TaskAction
import org.gradle.api.tasks.UntrackedTask
import java.net.URI
import javax.inject.Inject
@UntrackedTask(because = "Always check for new metadata")
abstract class FetchLuckPermsDownloads : DefaultTask() {
companion object {
const val ENDPOINT: String = "https://metadata.luckperms.net/data/downloads"
}
@get:Inject
abstract val layout: ProjectLayout
@get:OutputFile
abstract val outputFile: RegularFileProperty
init {
init()
}
private fun init() {
outputFile.convention(layout.buildDirectory.file("luckperms/downloads.json"))
}
@TaskAction
fun run () {
val url = URI.create(ENDPOINT).toURL()
val data = url.readText(Charsets.UTF_8)
val outFile = outputFile.get().asFile.also {
it.parentFile.mkdirs()
if (it.exists()) {
it.delete()
}
}
outFile.writeText(data, Charsets.UTF_8)
}
}
================================================
FILE: build-logic/src/main/kotlin/FetchLuckPermsJar.kt
================================================
import com.google.gson.Gson
import com.google.gson.JsonElement
import org.gradle.api.DefaultTask
import org.gradle.api.Project
import org.gradle.api.file.ProjectLayout
import org.gradle.api.file.RegularFileProperty
import org.gradle.api.provider.Property
import org.gradle.api.tasks.CacheableTask
import org.gradle.api.tasks.Input
import org.gradle.api.tasks.InputFile
import org.gradle.api.tasks.OutputFile
import org.gradle.api.tasks.PathSensitive
import org.gradle.api.tasks.PathSensitivity
import org.gradle.api.tasks.TaskAction
import org.gradle.api.tasks.TaskProvider
import org.gradle.kotlin.dsl.register
import java.net.URI
import javax.inject.Inject
@CacheableTask
abstract class FetchLuckPermsJar : DefaultTask() {
companion object {
fun setup(
project: Project,
type: String,
): TaskProvider {
val getMeta = project.tasks.register("fetchLuckPermsDownloads")
return project.tasks.register("fetchLuckPermsJar") {
this.type.set(type)
inputFile.set(getMeta.flatMap { it.outputFile })
}
}
}
@get:Inject
abstract val layout: ProjectLayout
@get:Input
abstract val type: Property
@get:InputFile
@get:PathSensitive(PathSensitivity.NONE)
abstract val inputFile: RegularFileProperty
@get:OutputFile
abstract val outputFile: RegularFileProperty
init {
init()
}
private fun init() {
outputFile.convention(type.flatMap {
layout.buildDirectory.file("luckperms/${it}.jar")
})
}
@TaskAction
fun run () {
val json = inputFile.get().asFile.readText(Charsets.UTF_8)
val map = Gson().fromJson(json, JsonElement::class.java).asJsonObject.get("downloads").asJsonObject
val url = map.get(type.get()).asString
val data = URI.create(url).toURL().readBytes()
val outFile = outputFile.get().asFile.also {
it.parentFile.mkdirs()
if (it.exists()) {
it.delete()
}
}
outFile.writeBytes(data)
}
}
================================================
FILE: build-logic/src/main/kotlin/FileCopyTask.kt
================================================
import org.gradle.api.DefaultTask
import org.gradle.api.tasks.InputFile
import org.gradle.api.tasks.OutputFile
import org.gradle.api.tasks.TaskAction
abstract class FileCopyTask : DefaultTask() {
@InputFile
val fileToCopy = project.objects.fileProperty()
@OutputFile
val destination = project.objects.fileProperty()
@TaskAction
fun copyFile() {
destination.get().asFile.parentFile.mkdirs()
fileToCopy.get().asFile.copyTo(destination.get().asFile, overwrite = true)
}
}
================================================
FILE: build-logic/src/main/kotlin/carbon.base-conventions.gradle.kts
================================================
plugins {
id("net.kyori.indra")
id("net.kyori.indra.git")
id("net.kyori.indra.checkstyle")
id("net.kyori.indra.licenser.spotless")
}
version = rootProject.version
indra {
gpl3OnlyLicense()
javaVersions {
target(21)
}
github(GITHUB_ORGANIZATION, GITHUB_REPO)
}
spotless {
java {
targetExclude(
"src/main/java/net/draycia/carbon/common/messages/PrefixedDelegateIterator.java",
"src/main/java/net/draycia/carbon/common/messages/StandardPlaceholderResolverStrategyButDifferent.java",
"src/main/java/com/google/inject/assistedinject/**"
)
}
}
indraSpotlessLicenser {
licenseHeaderFile(rootProject.file("LICENSE_HEADER"))
}
tasks {
withType {
// disable unclaimed annotation and missing annotation warnings
options.compilerArgs.add("-Xlint:-processing,-classfile")
options.compilerArgs.add("-parameters")
}
}
dependencies {
checkstyle(libs.stylecheck)
}
================================================
FILE: build-logic/src/main/kotlin/carbon.build-logic.gradle.kts
================================================
plugins {
id("base")
}
================================================
FILE: build-logic/src/main/kotlin/carbon.configurable-plugins.gradle.kts
================================================
import org.spongepowered.configurate.objectmapping.ConfigSerializable
import org.spongepowered.configurate.yaml.NodeStyle
import org.spongepowered.configurate.yaml.YamlConfigurationLoader
import xyz.jpenilla.runtask.task.RunWithPlugins
val pluginsExt = extensions.create("configurablePlugins", ConfigurablePluginsExt::class.java)
afterEvaluate {
val configs = pluginsExt.gradleDependencyBased.get().map { entry ->
val c = configurations.register(entry.name + "Plugin") {
isTransitive = false
}
dependencies {
c.name(entry.dep) { entry.op?.execute(this) }
}
entry to c
}
tasks.withType(RunWithPlugins::class).configureEach {
val cfg = readConfig()
configs.forEach { (entry, configuration) ->
val enabled = cfg.taskOverrides[name]?.get(entry.name)
?: cfg.defaults[entry.name]
?: false
if (enabled) {
pluginJars.from(configuration)
}
}
}
}
@ConfigSerializable
class Config {
var defaults: MutableMap = mutableMapOf()
var taskOverrides: MutableMap> = mutableMapOf(
"someTaskName" to mutableMapOf("somePlugin" to false)
)
}
@Synchronized
fun readConfig(): Config {
val loader = YamlConfigurationLoader.builder()
.file(file("run-plugins.yml"))
.nodeStyle(NodeStyle.BLOCK)
.defaultOptions {
it.header("Enable and disable optional plugins for run tasks in this project")
}
.build()
val n = loader.load()
val c = n.get(Config::class.java) as Config
var write = false
for (e in pluginsExt.gradleDependencyBased.get()) {
if (!c.defaults.containsKey(e.name)) {
write = true
c.defaults[e.name] = e.defaultEnabled
}
}
if (write) {
n.set(c)
loader.save(n)
}
return c
}
================================================
FILE: build-logic/src/main/kotlin/carbon.permissions.gradle.kts
================================================
val ext = extensions.create("carbonPermission", CarbonPermissionsExtension::class.java)
ext.yaml.convention(rootProject.layout.projectDirectory.file("common/src/main/resources/carbon-permissions.yml"))
================================================
FILE: build-logic/src/main/kotlin/carbon.platform-conventions.gradle.kts
================================================
import me.modmuss50.mpp.ReleaseType
plugins {
id("carbon.base-conventions")
id("me.modmuss50.mod-publish-plugin")
id("xyz.jpenilla.gremlin-gradle")
}
decorateVersion()
configurations.runtimeDownload {
exclude("org.slf4j", "slf4j-api")
exclude("com.google.errorprone", "error_prone_annotations")
exclude("io.leangen.geantyref", "geantyref")
}
val platformExtension = extensions.create("carbonPlatform")
dependencies {
runtimeDownload(libs.h2)
runtimeDownload(libs.postgresql)
runtimeDownload(libs.mariadb)
runtimeDownload(libs.zstdjni)
runtimeDownload(libs.jdbiCore)
runtimeDownload(libs.jdbiObject)
runtimeDownload(libs.jdbiPostgres)
runtimeDownload(libs.caffeine)
runtimeDownload(libs.jedis) {
exclude("com.google.code.gson", "gson")
}
runtimeDownload(libs.rabbitmq)
runtimeDownload(libs.nats)
runtimeDownload(libs.guice) {
exclude("com.google.guava")
}
runtimeDownload(libs.assistedInject) {
isTransitive = false
}
runtimeDownload(libs.flyway) {
exclude("com.google.code.gson", "gson")
}
runtimeDownload(libs.flywayMysql) {
isTransitive = false
}
runtimeDownload(libs.flywayPostgres) {
isTransitive = false
}
}
tasks {
jar {
manifest {
attributes(
"carbon-version" to project.version,
"carbon-commit" to lastCommitHash(),
"carbon-branch" to currentBranch(),
)
}
}
val copyJar = register("copyJar") {
fileToCopy = platformExtension.productionJar
destination = rootProject.layout.buildDirectory.dir("libs").flatMap {
it.file(fileToCopy.map { file -> file.asFile.name })
}
}
build {
dependsOn(copyJar)
}
javadoc {
enabled = false
}
}
val projectVersion = project.version as String
publishMods.modrinth {
projectId = "QzooIsZI"
type = if (projectVersion.contains("-beta.")) ReleaseType.BETA else ReleaseType.STABLE
file = platformExtension.productionJar
changelog = releaseNotes
accessToken = providers.environmentVariable("MODRINTH_TOKEN")
requires("luckperms")
optional("miniplaceholders")
minecraftVersions.addAll(
"1.21.4",
"1.21.5",
"1.21.6",
"1.21.7",
"1.21.8",
"1.21.9",
"1.21.10",
"1.21.11",
"26.1",
"26.1.1",
"26.1.2",
)
}
tasks.writeDependencies {
outputFileName = "carbon-dependencies.txt"
repos.add("https://repo.papermc.io/repository/maven-public/")
repos.add("https://repo.maven.apache.org/maven2/")
}
gremlin {
defaultJarRelocatorDependencies = false
defaultGremlinRuntimeDependency = false
}
================================================
FILE: build-logic/src/main/kotlin/carbon.publishing-conventions.gradle.kts
================================================
plugins {
id("carbon.base-conventions")
id("net.kyori.indra.publishing")
id("org.incendo.cloud-build-logic.publishing")
}
signing {
val signingKey: String? by project
val signingPassword: String? by project
useInMemoryPgpKeys(signingKey, signingPassword)
}
indra {
configurePublications {
pom {
developers {
developer {
id.set("Vicarious")
name.set("Josua Parks")
}
developer {
id.set("jmp")
name.set("Jason Penilla")
}
}
}
}
}
javadocLinks {
defaultJavadocProvider = "https://www.javadocs.dev/{group}/{name}/{version}"
}
================================================
FILE: build-logic/src/main/kotlin/carbon.shadow-platform.gradle.kts
================================================
plugins {
id("carbon.platform-conventions")
id("com.gradleup.shadow")
}
tasks {
jar {
archiveClassifier = "unshaded"
}
shadowJar {
archiveClassifier.set(null as String?)
configureShadowJar()
mergeServiceFiles()
// Needed for mergeServiceFiles to work properly in Shadow 9+
filesMatching("META-INF/services/**") {
duplicatesStrategy = DuplicatesStrategy.INCLUDE
}
}
}
extensions.configure {
productionJar = tasks.shadowJar.flatMap { it.archiveFile }
}
================================================
FILE: build-logic/src/main/kotlin/constants.kt
================================================
const val GITHUB_ORGANIZATION = "Hexaoxide"
const val GITHUB_REPO = "Carbon"
const val GITHUB_REPO_URL = "https://github.com/$GITHUB_ORGANIZATION/$GITHUB_REPO"
================================================
FILE: build-logic/src/main/kotlin/extensions.kt
================================================
import com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar
import net.kyori.indra.git.IndraGitExtension
import org.apache.tools.ant.filters.ReplaceTokens
import org.gradle.accessors.dm.LibrariesForLibs
import org.gradle.api.Project
import org.gradle.api.Task
import org.gradle.api.provider.Provider
import org.gradle.kotlin.dsl.filter
import org.gradle.kotlin.dsl.the
import org.gradle.language.jvm.tasks.ProcessResources
import xyz.jpenilla.gremlin.gradle.ShadowGremlin
fun ProcessResources.replace(
pattern: String,
tokens: Map
) {
inputs.properties(tokens)
filesMatching(pattern) {
filter(
"beginToken" to "\${",
"endToken" to "}",
"tokens" to tokens
)
}
}
val Project.releaseNotes: Provider
get() = providers.environmentVariable("RELEASE_NOTES")
/**
* Relocate a package into the `carbonchat.libs.` namespace.
*/
fun Task.relocateDependency(pkg: String) {
ShadowGremlin.relocateWithPrefix(this, "carbonchat.libs", pkg)
}
fun Task.standardRuntimeRelocations() {
relocateDependency("com.github.benmanes")
// relocateDependency("com.github.luben.zstd") // natives don't like relocation - hopefully nothing breaks :)
relocateDependency("com.google.protobuf")
relocateDependency("com.mysql.cj")
relocateDependency("com.mysql.jdbc")
relocateDependency("com.rabbitmq")
relocateDependency("io.nats")
relocateDependency("net.i2p.crypto")
relocateDependency("org.apache.commons.pool2")
relocateDependency("org.jdbi")
relocateDependency("org.mariadb.jdbc")
relocateDependency("org.postgresql")
relocateDependency("redis.clients.jedis")
relocateDependency("org.flywaydb")
relocateDependency("com.fasterxml")
relocateDependency("org.h2")
}
/**
* Relocates dependencies which we bundle and relocate on all platforms.
*/
fun Task.standardRelocations() {
relocateDependency("org.bstats")
relocateDependency("net.kyori.adventure.serializer.configurate4")
relocateDependency("com.sasorio.event")
relocateDependency("net.kyori.moonshine")
relocateDependency("com.seiama.registry")
relocateDependency("org.spongepowered.configurate")
relocateDependency("com.google.thirdparty.publicsuffix")
relocateDependency("com.zaxxer.hikari")
relocateDependency("ninja.egg82.messenger")
relocateDependency("org.antlr")
relocateDependency("com.electronwill")
relocateDependency("xyz.jpenilla.gremlin")
}
fun Task.relocateCloud() {
relocateDependency("org.incendo.cloud")
}
fun Task.relocateGuice() {
relocateDependency("com.google.inject")
relocateDependency("org.aopalliance")
relocateDependency("jakarta.inject")
}
fun ShadowJar.configureShadowJar() {
//minimize()
standardRelocations()
dependencies {
// not needed or provided by platform at runtime
exclude(dependency("com.google.code.findbugs:jsr305"))
exclude(dependency("com.google.errorprone:error_prone_annotations"))
exclude { it.moduleGroup == "com.google.guava" }
exclude(dependency("com.google.j2objc:j2objc-annotations"))
exclude(dependency("io.netty:netty-all"))
exclude(dependency("io.netty:netty-buffer"))
exclude(dependency("it.unimi.dsi:fastutil"))
exclude(dependency("org.checkerframework:checker-qual"))
exclude(dependency("org.slf4j:slf4j-api"))
}
}
fun Project.lastCommitHash(): String =
the().commit().orNull?.name?.substring(0, 7)
?: error("Could not determine commit hash")
fun Project.decorateVersion() {
val versionString = version as String
version = if (versionString.endsWith("-SNAPSHOT")) {
"$versionString+${lastCommitHash()}"
} else {
versionString
}
}
fun Project.currentBranch(): String {
System.getenv("GITHUB_HEAD_REF")?.takeIf { it.isNotEmpty() }
?.let { return it }
System.getenv("GITHUB_REF")?.takeIf { it.isNotEmpty() }
?.let { return it.replaceFirst("refs/heads/", "") }
val indraGit = the().takeIf { it.isPresent }
return indraGit?.branchName()?.orNull ?: "detached-head"
}
val Project.libs: LibrariesForLibs
get() = the()
================================================
FILE: build.gradle.kts
================================================
plugins {
id("carbon.build-logic")
alias(libs.plugins.hangar.publish)
alias(libs.plugins.cloud.buildLogic.rootProject.publishing)
}
val projectVersion: String by project // get from gradle.properties
version = projectVersion
fun Project.platformJar(): Provider =
extensions.getByType().productionJar
hangarPublish.publications.register("plugin") {
version = projectVersion
id = "Carbon"
channel = if (projectVersion.contains("-beta.")) "Beta" else "Release"
changelog = releaseNotes
apiKey = providers.environmentVariable("HANGAR_UPLOAD_KEY")
platforms.paper {
jar = project(":carbonchat-paper").platformJar()
platformVersions.add("1.21.4-26.1.2")
dependencies {
url("LuckPerms", "https://luckperms.net/")
hangar("Essentials") {
required = false
}
url("DiscordSRV", "https://www.spigotmc.org/resources/discordsrv.18494/") {
required = false
}
url("PlaceholderAPI", "https://www.spigotmc.org/resources/placeholderapi.6245/") {
required = false
}
hangar("MiniPlaceholders") {
required = false
}
}
}
platforms.velocity {
jar = project(":carbonchat-velocity").platformJar()
platformVersions.add("3.5")
dependencies {
url("LuckPerms", "https://luckperms.net/")
hangar("MiniPlaceholders") {
required = false
}
hangar("SignedVelocity") {
required = false
}
}
}
}
================================================
FILE: common/build.gradle.kts
================================================
plugins {
id("carbon.base-conventions")
}
dependencies {
api(projects.carbonchatApi)
api(libs.gremlin.runtime)
compileOnlyApi(platform(libs.log4jBom))
compileOnlyApi(libs.log4jApi)
// Configs
api(libs.configurateHocon) {
// Provided at platform level (usually through adventure)
exclude("net.kyori", "option")
}
// Bring in option for -common compile
compileOnly(libs.configurateHocon)
api(libs.adventureSerializerConfigurate4) {
isTransitive = false
}
// Cloud
api(platform(libs.cloudBom))
api(libs.cloudCore)
api(platform(libs.cloudMinecraftBom))
api(libs.cloudMinecraftExtras) {
isTransitive = false
}
api(libs.cloudSigned)
// Other
compileOnlyApi(libs.guice) {
exclude("com.google.guava")
}
compileOnlyApi(libs.assistedInject) {
isTransitive = false
}
compileOnlyApi(libs.luckPermsApi)
compileOnlyApi(libs.event)
// Storage
compileOnlyApi(libs.jdbiCore)
compileOnlyApi(libs.jdbiObject)
compileOnlyApi(libs.jdbiPostgres)
api(libs.hikariCP)
compileOnlyApi(libs.flyway) {
exclude("com.google.code.gson", "gson")
}
compileOnlyApi(libs.flywayMysql) {
isTransitive = false
}
compileOnlyApi(libs.flywayPostgres) {
isTransitive = false
}
// Messaging
api(libs.messenger)
api(libs.messengerNats)
api(libs.messengerRabbitmq)
api(libs.messengerRedis)
compileOnlyApi(libs.netty)
api(libs.event)
api(libs.registry) {
exclude("com.google.guava")
}
api(libs.kyoriMoonshine)
api(libs.kyoriMoonshineCore)
api(libs.kyoriMoonshineStandard)
compileOnlyApi(libs.caffeine)
// we shade and relocate a newer version than minecraft provides
compileOnlyApi(libs.guava)
// Plugins
compileOnly(libs.miniplaceholders)
}
================================================
FILE: common/src/main/java/com/google/inject/assistedinject/FactoryProvider3.java
================================================
/*
* Copyright (C) 2008 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.inject.assistedinject;
import static com.google.common.base.Preconditions.checkState;
import static com.google.common.collect.Iterables.getOnlyElement;
import com.google.common.base.MoreObjects;
import com.google.common.base.Objects;
import com.google.common.collect.HashMultimap;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Iterables;
import com.google.common.collect.Lists;
import com.google.common.collect.Multimap;
import com.google.common.collect.Sets;
import com.google.inject.AbstractModule;
import com.google.inject.Binder;
import com.google.inject.Binding;
import com.google.inject.ConfigurationException;
import com.google.inject.Inject;
import com.google.inject.Injector;
import com.google.inject.Key;
import com.google.inject.Module;
import com.google.inject.Provider;
import com.google.inject.ProvisionException;
import com.google.inject.Scopes;
import com.google.inject.TypeLiteral;
import com.google.inject.internal.Annotations;
import com.google.inject.internal.Errors;
import com.google.inject.internal.ErrorsException;
import com.google.inject.internal.UniqueAnnotations;
import com.google.inject.internal.util.Classes;
import com.google.inject.spi.BindingTargetVisitor;
import com.google.inject.spi.Dependency;
import com.google.inject.spi.HasDependencies;
import com.google.inject.spi.InjectionPoint;
import com.google.inject.spi.Message;
import com.google.inject.spi.ProviderInstanceBinding;
import com.google.inject.spi.ProviderWithExtensionVisitor;
import com.google.inject.spi.Toolable;
import com.google.inject.util.Providers;
import java.lang.annotation.Annotation;
import java.lang.invoke.MethodHandle;
import java.lang.invoke.MethodHandles;
import java.lang.invoke.MethodType;
import java.lang.reflect.Constructor;
import java.lang.reflect.Field;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Modifier;
import java.lang.reflect.Proxy;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.function.Supplier;
import java.util.logging.Level;
import java.util.logging.Logger;
/**
* The newer implementation of factory provider. This implementation uses a child injector to create
* values.
*
*
Carbon - modified from FactoryProvider2 for default method support
*
* @author jessewilson@google.com (Jesse Wilson)
* @author dtm@google.com (Daniel Martin)
* @author schmitt@google.com (Peter Schmitt)
* @author sameb@google.com (Sam Berlin)
*/
public final class FactoryProvider3 // Carbon - public
implements InvocationHandler,
ProviderWithExtensionVisitor,
HasDependencies,
AssistedInjectBinding {
/** A constant annotation to denote the return value, instead of creating a new one each time. */
static final Annotation RETURN_ANNOTATION = UniqueAnnotations.create();
// use the logger under a well-known name, not FactoryProvider2
static final Logger logger = Logger.getLogger(AssistedInject.class.getName());
/**
* A constant that determines if we allow fallback to using the JDK internals to make a "private
* lookup". Typically always true, but reflectively set to false in tests.
*/
@SuppressWarnings("FieldCanBeFinal") // non-final for testing
private static boolean allowPrivateLookupFallback = true;
/**
* A constant that determines if we allow fallback to using method handle workarounds (if
* required). Typically always true, but reflectively set to false in tests.
*/
@SuppressWarnings("FieldCanBeFinal") // non-final for testing
private static boolean allowMethodHandleWorkaround = true;
/** if a factory method parameter isn't annotated, it gets this annotation. */
static final Assisted DEFAULT_ANNOTATION =
new Assisted() {
@Override
public String value() {
return "";
}
@Override
public Class annotationType() {
return Assisted.class;
}
@Override
public boolean equals(Object o) {
return o instanceof Assisted && ((Assisted) o).value().isEmpty();
}
@Override
public int hashCode() {
return 127 * "value".hashCode() ^ "".hashCode();
}
@Override
public String toString() {
return "@"
+ Assisted.class.getName()
+ "("
+ Annotations.memberValueString("value", "")
+ ")";
}
};
/** All the data necessary to perform an assisted inject. */
private static class AssistData implements AssistedMethod {
/** the constructor the implementation is constructed with. */
final Constructor constructor;
/** the return type in the factory method that the constructor is bound to. */
final Key returnType;
/** the parameters in the factory method associated with this data. */
final ImmutableList> paramTypes;
/** the type of the implementation constructed */
final TypeLiteral implementationType;
/** All non-assisted dependencies required by this method. */
final Set> dependencies;
/** The factory method associated with this data */
final Method factoryMethod;
/** true if {@link #isValidForOptimizedAssistedInject} returned true. */
final boolean optimized;
/** the list of optimized providers, empty if not optimized. */
final List providers;
/** used to perform optimized factory creations. */
volatile Binding cachedBinding; // TODO: volatile necessary?
AssistData(
Constructor constructor,
Key returnType,
ImmutableList> paramTypes,
TypeLiteral implementationType,
Method factoryMethod,
Set> dependencies,
boolean optimized,
List providers) {
this.constructor = constructor;
this.returnType = returnType;
this.paramTypes = paramTypes;
this.implementationType = implementationType;
this.factoryMethod = factoryMethod;
this.dependencies = dependencies;
this.optimized = optimized;
this.providers = providers;
}
@Override
public String toString() {
return MoreObjects.toStringHelper(getClass())
.add("ctor", constructor)
.add("return type", returnType)
.add("param type", paramTypes)
.add("implementation type", implementationType)
.add("dependencies", dependencies)
.add("factory method", factoryMethod)
.add("optimized", optimized)
.add("providers", providers)
.add("cached binding", cachedBinding)
.toString();
}
@Override
public Set> getDependencies() {
return dependencies;
}
@Override
public Method getFactoryMethod() {
return factoryMethod;
}
@Override
public Constructor getImplementationConstructor() {
return constructor;
}
@Override
public TypeLiteral getImplementationType() {
return implementationType;
}
}
/** Mapping from method to the data about how the method will be assisted. */
private final ImmutableMap assistDataByMethod;
/** Mapping from method to method handle, for generated default methods. */
private final ImmutableMap methodHandleByMethod;
/** the hosting injector, or null if we haven't been initialized yet */
private Injector injector;
/** the factory interface, implemented and provided */
private final F factory;
/** The key that this is bound to. */
private final Key factoryKey;
/** The binding collector, for equality/hashing purposes. */
private final BindingCollector collector;
/**
* Utility class for collecting factory bindings. Used for configuring {@link FactoryProvider3}.
*
* @author schmitt@google.com (Peter Schmitt)
*/
static class BindingCollector {
private final Map, TypeLiteral> bindings = new HashMap<>();
public BindingCollector addBinding(Key key, TypeLiteral target) {
if (bindings.containsKey(key)) {
throw new ConfigurationException(
ImmutableSet.of(new Message("Only one implementation can be specified for " + key)));
}
bindings.put(key, target);
return this;
}
public Map, TypeLiteral> getBindings() {
return Collections.unmodifiableMap(bindings);
}
@Override
public int hashCode() {
return bindings.hashCode();
}
@Override
public boolean equals(Object obj) {
return (obj instanceof BindingCollector) && bindings.equals(((BindingCollector) obj).bindings);
}
}
/**
* @param factoryKey a key for a Java interface that defines one or more create methods.
* @param collector binding configuration that maps method return types to implementation types.
* @param userLookups user provided lookups, optional.
*/
public FactoryProvider3(
Key factoryKey, BindingCollector collector, MethodHandles.Lookup userLookups) {
this.factoryKey = factoryKey;
this.collector = collector == null ? new BindingCollector() : collector; collector = this.collector; // Carbon
TypeLiteral factoryType = factoryKey.getTypeLiteral();
Errors errors = new Errors();
@SuppressWarnings("unchecked") // we imprecisely treat the class literal of T as a Class
Class factoryRawType = (Class) (Class) factoryType.getRawType();
try {
if (!factoryRawType.isInterface()) {
throw errors.addMessage("%s must be an interface.", factoryRawType).toException();
}
Multimap defaultMethods = HashMultimap.create();
Multimap otherMethods = HashMultimap.create();
ImmutableMap.Builder assistDataBuilder = ImmutableMap.builder();
// TODO: also grab methods from superinterfaces
for (Method method : factoryRawType.getMethods()) {
// Skip static methods
if (Modifier.isStatic(method.getModifiers())) {
continue;
}
// Skip default methods that java8 may have created.
if (method.isDefault()/*isDefault(method) && (method.isBridge() || method.isSynthetic())*/) { // Carbon - allow non-generated default methods
// Even synthetic default methods need the return type validation...
// unavoidable consequence of javac8. :-(
validateFactoryReturnType(errors, method.getReturnType(), factoryRawType);
defaultMethods.put(method.getName(), method);
continue;
}
otherMethods.put(method.getName(), method);
TypeLiteral returnTypeLiteral = factoryType.getReturnType(method);
Key returnType;
try {
returnType =
Annotations.getKey(returnTypeLiteral, method, method.getAnnotations(), errors);
} catch (ConfigurationException ce) {
// If this was an error due to returnTypeLiteral not being specified, rephrase
// it as our factory not being specified, so it makes more sense to users.
if (isTypeNotSpecified(returnTypeLiteral, ce)) {
throw errors.keyNotFullySpecified(TypeLiteral.get(factoryRawType)).toException();
} else {
throw ce;
}
}
validateFactoryReturnType(errors, returnType.getTypeLiteral().getRawType(), factoryRawType);
List> params = factoryType.getParameterTypes(method);
Annotation[][] paramAnnotations = method.getParameterAnnotations();
int p = 0;
List> keys = Lists.newArrayList();
for (TypeLiteral param : params) {
Key paramKey = Annotations.getKey(param, method, paramAnnotations[p++], errors);
Class underlylingType = paramKey.getTypeLiteral().getRawType();
if (underlylingType.equals(Provider.class)
|| underlylingType.equals(jakarta.inject.Provider.class)) {
errors.addMessage(
"A Provider may not be a type in a factory method of an AssistedInject."
+ "\n Offending instance is parameter [%s] with key [%s] on method [%s]",
p, paramKey, method);
}
keys.add(assistKey(method, paramKey, errors));
}
ImmutableList> immutableParamList = ImmutableList.copyOf(keys);
// try to match up the method to the constructor
TypeLiteral implementation = collector.getBindings().get(returnType);
if (implementation == null) {
implementation = returnType.getTypeLiteral();
}
Class scope =
Annotations.findScopeAnnotation(errors, implementation.getRawType());
if (scope != null) {
errors.addMessage(
"Found scope annotation [%s] on implementation class "
+ "[%s] of AssistedInject factory [%s].\nThis is not allowed, please"
+ " remove the scope annotation.",
scope, implementation.getRawType(), factoryType);
}
InjectionPoint ctorInjectionPoint;
try {
ctorInjectionPoint =
findMatchingConstructorInjectionPoint(
method, returnType, implementation, immutableParamList);
} catch (ErrorsException ee) {
errors.merge(ee.getErrors());
continue;
}
Constructor constructor = (Constructor) ctorInjectionPoint.getMember();
List providers = Collections.emptyList();
Set> deps = getDependencies(ctorInjectionPoint, implementation);
boolean optimized = false;
// Now go through all dependencies of the implementation and see if it is OK to
// use an optimized form of assistedinject2. The optimized form requires that
// all injections directly inject the object itself (and not a Provider of the object,
// or an Injector), because it caches a single child injector and mutates the Provider
// of the arguments in a ThreadLocal.
if (isValidForOptimizedAssistedInject(deps, implementation.getRawType(), factoryType)) {
ImmutableList.Builder providerListBuilder = ImmutableList.builder();
for (int i = 0; i < params.size(); i++) {
providerListBuilder.add(new ThreadLocalProvider());
}
providers = providerListBuilder.build();
optimized = true;
}
AssistData data =
new AssistData(
constructor,
returnType,
immutableParamList,
implementation,
method,
removeAssistedDeps(deps),
optimized,
providers);
assistDataBuilder.put(method, data);
}
factory =
factoryRawType.cast(
Proxy.newProxyInstance(
factoryRawType.getClassLoader(), new Class[] {factoryRawType}, this));
// Now go back through default methods. Try to use MethodHandles to make things
// work. If that doesn't work, fallback to trying to find compatible method
// signatures.
Map dataSoFar = assistDataBuilder.build();
ImmutableMap.Builder methodHandleBuilder = ImmutableMap.builder();
boolean warnedAboutUserLookups = false;
for (Map.Entry entry : defaultMethods.entries()) {
if (!warnedAboutUserLookups
&& userLookups == null
&& !Modifier.isPublic(factory.getClass().getModifiers())) {
warnedAboutUserLookups = true;
logger.log(
Level.WARNING,
"AssistedInject factory {0} is non-public and has default methods. " // Carbon - adjust message
+ " Please pass a `MethodHandles.lookup()` with"
+ " FactoryModuleBuilder.withLookups when using this factory so that Guice can"
+ " properly call the default methods. Guice will try to workaround this, but "
+ "it does not always work (depending on the method signatures of the factory).",
new Object[] {factoryType});
}
// Note: If the user didn't supply a valid lookup, we always try to fallback to the hacky
// signature comparing workaround below.
// This is because all these shenanigans are only necessary because we're implementing
// AssistedInject through a Proxy. If we were to generate a subclass (which we theoretically
// _could_ do), then we wouldn't inadvertantly proxy the javac-generated default methods
// too (and end up with a stack overflow from infinite recursion).
// As such, we try our hardest to "make things work" requiring requiring extra effort from
// the user.
Method defaultMethod = entry.getValue();
MethodHandle handle = null;
try {
handle =
superMethodHandle(
SuperMethodSupport.METHOD_LOOKUP, defaultMethod, factory, userLookups);
} catch (ReflectiveOperationException e1) {
// If the user-specified lookup failed, try again w/ the private lookup hack.
// If _that_ doesn't work, try the below workaround.
if (allowPrivateLookupFallback
&& SuperMethodSupport.METHOD_LOOKUP != SuperMethodLookup.PRIVATE_LOOKUP) {
try {
handle =
superMethodHandle(
SuperMethodLookup.PRIVATE_LOOKUP, defaultMethod, factory, userLookups);
} catch (ReflectiveOperationException e2) {
// ignored, use below workaround.
}
}
}
Supplier failureMsg =
() ->
"Unable to use non-public factory "
+ factoryRawType.getName()
+ ". Please call"
+ " FactoryModuleBuilder.withLookups(MethodHandles.lookup()) (with a"
+ " lookups that has access to the factory), or make the factory"
+ " public.";
if (handle != null) {
methodHandleBuilder.put(defaultMethod, handle);
} else if (!allowMethodHandleWorkaround) {
errors.addMessage(failureMsg.get());
} else {
boolean foundMatch = false;
for (Method otherMethod : otherMethods.get(defaultMethod.getName())) {
if (dataSoFar.containsKey(otherMethod) && isCompatible(defaultMethod, otherMethod)) {
if (foundMatch) {
errors.addMessage(failureMsg.get());
break;
} else {
assistDataBuilder.put(defaultMethod, dataSoFar.get(otherMethod));
foundMatch = true;
}
}
}
// We always expect to find at least one match, because we only deal with javac-generated
// default methods. If we ever allow user-specified default methods, this will need to
// change.
if (!foundMatch) {
throw new IllegalStateException("Can't find method compatible with: " + defaultMethod);
}
}
}
// If we generated any errors (from finding matching constructors, for instance), throw an
// exception.
if (errors.hasErrors()) {
throw errors.toException();
}
assistDataByMethod = assistDataBuilder.build();
methodHandleByMethod = methodHandleBuilder.build();
} catch (ErrorsException e) {
throw new ConfigurationException(e.getErrors().getMessages());
}
}
static boolean isDefault(Method method) {
// Per the javadoc, default methods are non-abstract, public, non-static.
// They're also in interfaces, but we can guarantee that already since we only act
// on interfaces.
return (method.getModifiers() & (Modifier.ABSTRACT | Modifier.PUBLIC | Modifier.STATIC))
== Modifier.PUBLIC;
}
private boolean isCompatible(Method src, Method dst) {
if (!src.getReturnType().isAssignableFrom(dst.getReturnType())) {
return false;
}
Class[] srcParams = src.getParameterTypes();
Class[] dstParams = dst.getParameterTypes();
if (srcParams.length != dstParams.length) {
return false;
}
for (int i = 0; i < srcParams.length; i++) {
if (!srcParams[i].isAssignableFrom(dstParams[i])) {
return false;
}
}
return true;
}
@Override
public F get() {
return factory;
}
@Override
public Set> getDependencies() {
Set> combinedDeps = new HashSet<>();
for (AssistData data : assistDataByMethod.values()) {
combinedDeps.addAll(data.dependencies);
}
return ImmutableSet.copyOf(combinedDeps);
}
@Override
public Key getKey() {
return factoryKey;
}
// Safe cast because values are typed to AssistedData, which is an AssistedMethod, and
// the collection is immutable.
@Override
@SuppressWarnings("unchecked")
public Collection getAssistedMethods() {
return (Collection) (Collection) assistDataByMethod.values();
}
@Override
@SuppressWarnings("unchecked")
public V acceptExtensionVisitor(
BindingTargetVisitor visitor, ProviderInstanceBinding binding) {
if (visitor instanceof AssistedInjectTargetVisitor) {
return ((AssistedInjectTargetVisitor) visitor).visit((AssistedInjectBinding) this);
}
return visitor.visit(binding);
}
private void validateFactoryReturnType(Errors errors, Class returnType, Class factoryType) {
if (Modifier.isPublic(factoryType.getModifiers())
&& !Modifier.isPublic(returnType.getModifiers())) {
errors.addMessage(
"%s is public, but has a method that returns a non-public type: %s. "
+ "Due to limitations with java.lang.reflect.Proxy, this is not allowed. "
+ "Please either make the factory non-public or the return type public.",
factoryType, returnType);
}
}
/**
* Returns true if the ConfigurationException is due to an error of TypeLiteral not being fully
* specified.
*/
private boolean isTypeNotSpecified(TypeLiteral typeLiteral, ConfigurationException ce) {
Collection messages = ce.getErrorMessages();
if (messages.size() == 1) {
Message msg =
Iterables.getOnlyElement(new Errors().keyNotFullySpecified(typeLiteral).getMessages());
return msg.getMessage().equals(Iterables.getOnlyElement(messages).getMessage());
} else {
return false;
}
}
/**
* Finds a constructor suitable for the method. If the implementation contained any constructors
* marked with {@link AssistedInject}, this requires all {@link Assisted} parameters to exactly
* match the parameters (in any order) listed in the method. Otherwise, if no {@link
* AssistedInject} constructors exist, this will default to looking for an {@literal @}{@link
* Inject} constructor.
*/
private InjectionPoint findMatchingConstructorInjectionPoint(
Method method, Key returnType, TypeLiteral implementation, List> paramList)
throws ErrorsException {
Errors errors = new Errors(method);
if (returnType.getTypeLiteral().equals(implementation)) {
errors = errors.withSource(implementation);
} else {
errors = errors.withSource(returnType).withSource(implementation);
}
Class rawType = implementation.getRawType();
if (Modifier.isInterface(rawType.getModifiers())) {
errors.addMessage(
"%s is an interface, not a concrete class. Unable to create AssistedInject factory.",
implementation);
throw errors.toException();
} else if (Modifier.isAbstract(rawType.getModifiers())) {
errors.addMessage(
"%s is abstract, not a concrete class. Unable to create AssistedInject factory.",
implementation);
throw errors.toException();
} else if (Classes.isInnerClass(rawType)) {
errors.cannotInjectInnerClass(rawType);
throw errors.toException();
}
Constructor matchingConstructor = null;
boolean anyAssistedInjectConstructors = false;
// Look for AssistedInject constructors...
for (Constructor constructor : rawType.getDeclaredConstructors()) {
if (constructor.isAnnotationPresent(AssistedInject.class)) {
anyAssistedInjectConstructors = true;
if (constructorHasMatchingParams(implementation, constructor, paramList, errors)) {
if (matchingConstructor != null) {
errors.addMessage(
"%s has more than one constructor annotated with @AssistedInject"
+ " that matches the parameters in method %s. Unable to create "
+ "AssistedInject factory.",
implementation, method);
throw errors.toException();
} else {
matchingConstructor = constructor;
}
}
}
}
if (!anyAssistedInjectConstructors) {
// If none existed, use @Inject or a no-arg constructor.
try {
return InjectionPoint.forConstructorOf(implementation);
} catch (ConfigurationException e) {
errors.merge(e.getErrorMessages());
throw errors.toException();
}
} else {
// Otherwise, use it or fail with a good error message.
if (matchingConstructor != null) {
// safe because we got the constructor from this implementation.
@SuppressWarnings("unchecked")
InjectionPoint ip =
InjectionPoint.forConstructor(
(Constructor) matchingConstructor, implementation);
return ip;
} else {
errors.addMessage(
"%s has @AssistedInject constructors, but none of them match the"
+ " parameters in method %s. Unable to create AssistedInject factory.",
implementation, method);
throw errors.toException();
}
}
}
/**
* Matching logic for constructors annotated with AssistedInject. This returns true if and only if
* all @Assisted parameters in the constructor exactly match (in any order) all @Assisted
* parameters the method's parameter.
*/
private boolean constructorHasMatchingParams(
TypeLiteral type, Constructor constructor, List> paramList, Errors errors)
throws ErrorsException {
List> params = type.getParameterTypes(constructor);
Annotation[][] paramAnnotations = constructor.getParameterAnnotations();
int p = 0;
List> constructorKeys = Lists.newArrayList();
for (TypeLiteral param : params) {
Key paramKey = Annotations.getKey(param, constructor, paramAnnotations[p++], errors);
constructorKeys.add(paramKey);
}
// Require that every key exist in the constructor to match up exactly.
for (Key key : paramList) {
// If it didn't exist in the constructor set, we can't use it.
if (!constructorKeys.remove(key)) {
return false;
}
}
// If any keys remain and their annotation is Assisted, we can't use it.
for (Key key : constructorKeys) {
if (key.getAnnotationType() == Assisted.class) {
return false;
}
}
// All @Assisted params match up to the method's parameters.
return true;
}
/** Calculates all dependencies required by the implementation and constructor. */
private Set> getDependencies(
InjectionPoint ctorPoint, TypeLiteral implementation) {
ImmutableSet.Builder> builder = ImmutableSet.builder();
builder.addAll(ctorPoint.getDependencies());
if (!implementation.getRawType().isInterface()) {
for (InjectionPoint ip : InjectionPoint.forInstanceMethodsAndFields(implementation)) {
builder.addAll(ip.getDependencies());
}
}
return builder.build();
}
/** Return all non-assisted dependencies. */
private Set> removeAssistedDeps(Set> deps) {
ImmutableSet.Builder> builder = ImmutableSet.builder();
for (Dependency dep : deps) {
Class annotationType = dep.getKey().getAnnotationType();
if (annotationType == null || !annotationType.equals(Assisted.class)) {
builder.add(dep);
}
}
return builder.build();
}
/**
* Returns true if all dependencies are suitable for the optimized version of AssistedInject. The
* optimized version caches the binding and uses a ThreadLocal Provider, so can only be applied if
* the assisted bindings are immediately provided. This looks for hints that the values may be
* lazily retrieved, by looking for injections of Injector or a Provider for the assisted values.
*/
private boolean isValidForOptimizedAssistedInject(
Set> dependencies, Class implementation, TypeLiteral factoryType) {
Set> badDeps = null; // optimization: create lazily
for (Dependency dep : dependencies) {
if (isInjectorOrAssistedProvider(dep)) {
if (badDeps == null) {
badDeps = Sets.newHashSet();
}
badDeps.add(dep);
}
}
if (badDeps != null && !badDeps.isEmpty()) {
logger.log(
Level.WARNING,
"AssistedInject factory {0} will be slow "
+ "because {1} has assisted Provider dependencies or injects the Injector. "
+ "Stop injecting @Assisted Provider (instead use @Assisted T) "
+ "or Injector to speed things up. (It will be a ~6500% speed bump!) "
+ "The exact offending deps are: {2}",
new Object[] {factoryType, implementation, badDeps});
return false;
}
return true;
}
/**
* Returns true if the dependency is for {@link Injector} or if the dependency is a {@link
* Provider} for a parameter that is {@literal @}{@link Assisted}.
*/
private boolean isInjectorOrAssistedProvider(Dependency dependency) {
Class annotationType = dependency.getKey().getAnnotationType();
if (annotationType != null && annotationType.equals(Assisted.class)) { // If it's assisted..
if (dependency
.getKey()
.getTypeLiteral()
.getRawType()
.equals(Provider.class)) { // And a Provider...
return true;
}
} else if (dependency
.getKey()
.getTypeLiteral()
.getRawType()
.equals(Injector.class)) { // If it's the Injector...
return true;
}
return false;
}
/**
* Returns a key similar to {@code key}, but with an {@literal @}Assisted binding annotation. This
* fails if another binding annotation is clobbered in the process. If the key already has the
* {@literal @}Assisted annotation, it is returned as-is to preserve any String value.
*/
private Key assistKey(Method method, Key key, Errors errors) throws ErrorsException {
if (key.getAnnotationType() == null) {
return key.withAnnotation(DEFAULT_ANNOTATION);
} else if (key.getAnnotationType() == Assisted.class) {
return key;
} else {
errors
.withSource(method)
.addMessage(
"Only @Assisted is allowed for factory parameters, but found @%s",
key.getAnnotationType());
throw errors.toException();
}
}
/**
* At injector-creation time, we initialize the invocation handler. At this time we make sure all
* factory methods will be able to build the target types.
*/
@Inject
@Toolable
void initialize(Injector injector) {
if (this.injector != null) {
throw new ConfigurationException(
ImmutableList.of(
new Message(
FactoryProvider3.class,
"Factories.create() factories may only be used in one Injector!")));
}
this.injector = injector;
for (Map.Entry entry : assistDataByMethod.entrySet()) {
Method method = entry.getKey();
AssistData data = entry.getValue();
Object[] args;
if (!data.optimized) {
args = new Object[method.getParameterTypes().length];
Arrays.fill(args, "dummy object for validating Factories");
} else {
args = null; // won't be used -- instead will bind to data.providers.
}
getBindingFromNewInjector(
method, args, data); // throws if the binding isn't properly configured
}
}
/**
* Creates a child injector that binds the args, and returns the binding for the method's result.
*/
public Binding getBindingFromNewInjector(
final Method method, final Object[] args, final AssistData data) {
checkState(
injector != null,
"Factories.create() factories cannot be used until they're initialized by Guice.");
final Key returnType = data.returnType;
// We ignore any pre-existing binding annotation.
final Key returnKey = Key.get(returnType.getTypeLiteral(), RETURN_ANNOTATION);
Module assistedModule =
new AbstractModule() {
@Override
@SuppressWarnings({
"unchecked",
"rawtypes"
}) // raw keys are necessary for the args array and return value
protected void configure() {
Binder binder = binder().withSource(method);
int p = 0;
if (!data.optimized) {
for (Key paramKey : data.paramTypes) {
// Wrap in a Provider to cover null, and to prevent Guice from injecting the
// parameter
binder.bind((Key) paramKey).toProvider(Providers.of(args[p++]));
}
} else {
for (Key paramKey : data.paramTypes) {
// Bind to our ThreadLocalProviders.
binder.bind((Key) paramKey).toProvider(data.providers.get(p++));
}
}
Constructor constructor = data.constructor;
// Constructor *should* always be non-null here,
// but if it isn't, we'll end up throwing a fairly good error
// message for the user.
if (constructor != null) {
binder
.bind(returnKey)
.toConstructor(constructor, (TypeLiteral) data.implementationType)
.in(Scopes.NO_SCOPE); // make sure we erase any scope on the implementation type
}
}
};
Injector forCreate = injector.createChildInjector(assistedModule);
Binding binding = forCreate.getBinding(returnKey);
// If we have providers cached in data, cache the binding for future optimizations.
if (data.optimized) {
data.cachedBinding = binding;
}
return binding;
}
/**
* When a factory method is invoked, we create a child injector that binds all parameters, then
* use that to get an instance of the return type.
*/
@Override
public Object invoke(Object proxy, final Method method, final Object[] args) throws Throwable {
// If we setup a method handle earlier for this method, call it.
// This is necessary for default methods that java8 creates, so we
// can call the default method implementation (and not our proxied version of it).
if (methodHandleByMethod.containsKey(method)) {
return methodHandleByMethod.get(method).invokeWithArguments(args);
}
if (method.getDeclaringClass().equals(Object.class)) {
if ("equals".equals(method.getName())) {
return proxy == args[0];
} else if ("hashCode".equals(method.getName())) {
return System.identityHashCode(proxy);
} else {
return method.invoke(this, args);
}
}
AssistData data = assistDataByMethod.get(method);
checkState(data != null, "No data for method: %s", method);
Provider provider;
if (data.cachedBinding != null) { // Try to get optimized form...
provider = data.cachedBinding.getProvider();
} else {
provider = getBindingFromNewInjector(method, args, data).getProvider();
}
try {
int p = 0;
for (ThreadLocalProvider tlp : data.providers) {
tlp.set(args[p++]);
}
return provider.get();
} catch (ProvisionException e) {
// if this is an exception declared by the factory method, throw it as-is
if (e.getErrorMessages().size() == 1) {
Message onlyError = getOnlyElement(e.getErrorMessages());
Throwable cause = onlyError.getCause();
if (cause != null && canRethrow(method, cause)) {
throw cause;
}
}
throw e;
} finally {
for (ThreadLocalProvider tlp : data.providers) {
tlp.remove();
}
}
}
@Override
public String toString() {
return factory.getClass().getInterfaces()[0].getName();
}
@Override
public int hashCode() {
return Objects.hashCode(factoryKey, collector);
}
@Override
public boolean equals(Object obj) {
if (!(obj instanceof FactoryProvider3)) {
return false;
}
FactoryProvider3 other = (FactoryProvider3) obj;
return factoryKey.equals(other.factoryKey) && Objects.equal(collector, other.collector);
}
/** Returns true if {@code thrown} can be thrown by {@code invoked} without wrapping. */
static boolean canRethrow(Method invoked, Throwable thrown) {
if (thrown instanceof Error || thrown instanceof RuntimeException) {
return true;
}
for (Class declared : invoked.getExceptionTypes()) {
if (declared.isInstance(thrown)) {
return true;
}
}
return false;
}
// not because we'll never know and this is easier than suppressing warnings.
private static class ThreadLocalProvider extends ThreadLocal
