├── src └── main │ └── java │ └── com │ └── ikeirnez │ └── pluginmessageframework │ ├── PacketListener.java │ ├── PacketHandler.java │ ├── RawPacket.java │ ├── packets │ └── bungeecord │ │ ├── PacketIP.java │ │ ├── PacketUUID.java │ │ ├── PacketGetServer.java │ │ ├── PacketGetServers.java │ │ ├── PacketUUIDOther.java │ │ ├── PacketConnect.java │ │ ├── PacketPlayerList.java │ │ ├── PacketPlayerCount.java │ │ ├── PacketMessage.java │ │ ├── PacketConnectOther.java │ │ └── PacketForward.java │ ├── PacketPlayer.java │ ├── StandardPacket.java │ ├── implementations │ ├── BungeeCordPacketManager.java │ └── BukkitPacketManager.java │ ├── PacketWriter.java │ └── PacketManager.java ├── .gitignore ├── pom.xml ├── README.md └── LICENSE.txt /src/main/java/com/ikeirnez/pluginmessageframework/PacketListener.java: -------------------------------------------------------------------------------- 1 | package com.ikeirnez.pluginmessageframework; 2 | 3 | /** 4 | * Classes implementing this interface MUST have an empty constructor (no parameters) in order for the packet api 5 | * to function correctly 6 | */ 7 | public interface PacketListener { 8 | } 9 | -------------------------------------------------------------------------------- /src/main/java/com/ikeirnez/pluginmessageframework/PacketHandler.java: -------------------------------------------------------------------------------- 1 | package com.ikeirnez.pluginmessageframework; 2 | 3 | import java.lang.annotation.ElementType; 4 | import java.lang.annotation.Retention; 5 | import java.lang.annotation.RetentionPolicy; 6 | import java.lang.annotation.Target; 7 | 8 | /** 9 | * Created by iKeirNez on 14/12/13. 10 | */ 11 | @Retention(RetentionPolicy.RUNTIME) 12 | @Target(value = ElementType.METHOD) 13 | public @interface PacketHandler { 14 | } 15 | -------------------------------------------------------------------------------- /src/main/java/com/ikeirnez/pluginmessageframework/RawPacket.java: -------------------------------------------------------------------------------- 1 | package com.ikeirnez.pluginmessageframework; 2 | 3 | import java.io.DataInputStream; 4 | import java.io.IOException; 5 | 6 | /** 7 | * Created by iKeirNez on 01/01/14. 8 | */ 9 | public abstract class RawPacket extends StandardPacket { 10 | 11 | private String channel = null; 12 | 13 | public RawPacket(){} 14 | 15 | public RawPacket(String channel){ 16 | this.channel = channel; 17 | } 18 | 19 | public String getChannel(){ 20 | return channel; 21 | } 22 | 23 | @Override public void handle(DataInputStream dataInputStream) throws IOException {} 24 | 25 | } 26 | -------------------------------------------------------------------------------- /src/main/java/com/ikeirnez/pluginmessageframework/packets/bungeecord/PacketIP.java: -------------------------------------------------------------------------------- 1 | package com.ikeirnez.pluginmessageframework.packets.bungeecord; 2 | 3 | import com.ikeirnez.pluginmessageframework.PacketWriter; 4 | import com.ikeirnez.pluginmessageframework.RawPacket; 5 | 6 | import java.io.IOException; 7 | 8 | /** 9 | * Created by iKeirNez on 01/01/14. 10 | */ 11 | public class PacketIP extends RawPacket { 12 | 13 | public PacketIP(){ 14 | super("BungeeCord"); 15 | } 16 | 17 | @Override 18 | public PacketWriter write() throws IOException { 19 | PacketWriter packetWriter = new PacketWriter(this); 20 | packetWriter.writeUTF("IP"); 21 | return packetWriter; 22 | } 23 | } 24 | -------------------------------------------------------------------------------- /src/main/java/com/ikeirnez/pluginmessageframework/packets/bungeecord/PacketUUID.java: -------------------------------------------------------------------------------- 1 | package com.ikeirnez.pluginmessageframework.packets.bungeecord; 2 | 3 | import com.ikeirnez.pluginmessageframework.PacketWriter; 4 | import com.ikeirnez.pluginmessageframework.RawPacket; 5 | 6 | import java.io.IOException; 7 | 8 | /** 9 | * Created by iKeirNez on 01/01/14. 10 | */ 11 | public class PacketUUID extends RawPacket { 12 | 13 | public PacketUUID(){ 14 | super("BungeeCord"); 15 | } 16 | 17 | @Override 18 | public PacketWriter write() throws IOException { 19 | PacketWriter packetWriter = new PacketWriter(this); 20 | packetWriter.writeUTF("UUID"); 21 | return packetWriter; 22 | } 23 | } 24 | -------------------------------------------------------------------------------- /src/main/java/com/ikeirnez/pluginmessageframework/packets/bungeecord/PacketGetServer.java: -------------------------------------------------------------------------------- 1 | package com.ikeirnez.pluginmessageframework.packets.bungeecord; 2 | 3 | import com.ikeirnez.pluginmessageframework.PacketWriter; 4 | import com.ikeirnez.pluginmessageframework.RawPacket; 5 | 6 | import java.io.IOException; 7 | 8 | /** 9 | * Created by iKeirNez on 01/01/14. 10 | */ 11 | public class PacketGetServer extends RawPacket { 12 | 13 | public PacketGetServer(){ 14 | super("BungeeCord"); 15 | } 16 | 17 | @Override 18 | public PacketWriter write() throws IOException { 19 | PacketWriter packetWriter = new PacketWriter(this); 20 | packetWriter.writeUTF("GetServer"); 21 | return packetWriter; 22 | } 23 | } 24 | -------------------------------------------------------------------------------- /src/main/java/com/ikeirnez/pluginmessageframework/packets/bungeecord/PacketGetServers.java: -------------------------------------------------------------------------------- 1 | package com.ikeirnez.pluginmessageframework.packets.bungeecord; 2 | 3 | import com.ikeirnez.pluginmessageframework.PacketWriter; 4 | import com.ikeirnez.pluginmessageframework.RawPacket; 5 | 6 | import java.io.IOException; 7 | 8 | /** 9 | * Created by iKeirNez on 01/01/14. 10 | */ 11 | public class PacketGetServers extends RawPacket { 12 | 13 | public PacketGetServers(){ 14 | super("BungeeCord"); 15 | } 16 | 17 | @Override 18 | public PacketWriter write() throws IOException { 19 | PacketWriter packetWriter = new PacketWriter(this); 20 | packetWriter.writeUTF("GetServers"); 21 | return packetWriter; 22 | } 23 | } 24 | -------------------------------------------------------------------------------- /src/main/java/com/ikeirnez/pluginmessageframework/packets/bungeecord/PacketUUIDOther.java: -------------------------------------------------------------------------------- 1 | package com.ikeirnez.pluginmessageframework.packets.bungeecord; 2 | 3 | import com.ikeirnez.pluginmessageframework.PacketWriter; 4 | import com.ikeirnez.pluginmessageframework.RawPacket; 5 | 6 | import java.io.IOException; 7 | 8 | /** 9 | * Created by iKeirNez on 01/01/14. 10 | */ 11 | public class PacketUUIDOther extends RawPacket { 12 | 13 | public String name; 14 | 15 | public PacketUUIDOther(String name){ 16 | super("BungeeCord"); 17 | this.name = name; 18 | } 19 | 20 | @Override 21 | public PacketWriter write() throws IOException { 22 | PacketWriter packetWriter = new PacketWriter(this); 23 | packetWriter.writeUTF("UUIDOther"); 24 | packetWriter.writeUTF(name); 25 | return packetWriter; 26 | } 27 | } 28 | -------------------------------------------------------------------------------- /src/main/java/com/ikeirnez/pluginmessageframework/packets/bungeecord/PacketConnect.java: -------------------------------------------------------------------------------- 1 | package com.ikeirnez.pluginmessageframework.packets.bungeecord; 2 | 3 | import com.ikeirnez.pluginmessageframework.PacketWriter; 4 | import com.ikeirnez.pluginmessageframework.RawPacket; 5 | 6 | import java.io.IOException; 7 | 8 | /** 9 | * Created by iKeirNez on 01/01/14. 10 | */ 11 | public class PacketConnect extends RawPacket { 12 | 13 | public String server; 14 | 15 | public PacketConnect(String server){ 16 | super("BungeeCord"); 17 | this.server = server; 18 | } 19 | 20 | @Override 21 | public PacketWriter write() throws IOException { 22 | PacketWriter packetWriter = new PacketWriter(this); 23 | packetWriter.writeUTF("Connect"); 24 | packetWriter.writeUTF(server); 25 | return packetWriter; 26 | } 27 | } 28 | -------------------------------------------------------------------------------- /src/main/java/com/ikeirnez/pluginmessageframework/packets/bungeecord/PacketPlayerList.java: -------------------------------------------------------------------------------- 1 | package com.ikeirnez.pluginmessageframework.packets.bungeecord; 2 | 3 | import com.ikeirnez.pluginmessageframework.PacketWriter; 4 | import com.ikeirnez.pluginmessageframework.RawPacket; 5 | 6 | import java.io.IOException; 7 | 8 | /** 9 | * Created by iKeirNez on 01/01/14. 10 | */ 11 | public class PacketPlayerList extends RawPacket { 12 | 13 | public String server; 14 | 15 | public PacketPlayerList(String server){ 16 | super("BungeeCord"); 17 | this.server = server; 18 | } 19 | 20 | @Override 21 | public PacketWriter write() throws IOException { 22 | PacketWriter packetWriter = new PacketWriter(this); 23 | packetWriter.writeUTF("PlayerList"); 24 | packetWriter.writeUTF(server); 25 | return packetWriter; 26 | } 27 | } 28 | -------------------------------------------------------------------------------- /src/main/java/com/ikeirnez/pluginmessageframework/packets/bungeecord/PacketPlayerCount.java: -------------------------------------------------------------------------------- 1 | package com.ikeirnez.pluginmessageframework.packets.bungeecord; 2 | 3 | import com.ikeirnez.pluginmessageframework.PacketWriter; 4 | import com.ikeirnez.pluginmessageframework.RawPacket; 5 | 6 | import java.io.IOException; 7 | 8 | /** 9 | * Created by iKeirNez on 01/01/14. 10 | */ 11 | public class PacketPlayerCount extends RawPacket { 12 | 13 | public String server; 14 | 15 | public PacketPlayerCount(String server){ 16 | super("BungeeCord"); 17 | this.server = server; 18 | } 19 | 20 | @Override 21 | public PacketWriter write() throws IOException { 22 | PacketWriter packetWriter = new PacketWriter(this); 23 | packetWriter.writeUTF("PlayerCount"); 24 | packetWriter.writeUTF(server); 25 | return packetWriter; 26 | } 27 | } 28 | -------------------------------------------------------------------------------- /src/main/java/com/ikeirnez/pluginmessageframework/packets/bungeecord/PacketMessage.java: -------------------------------------------------------------------------------- 1 | package com.ikeirnez.pluginmessageframework.packets.bungeecord; 2 | 3 | import com.ikeirnez.pluginmessageframework.PacketWriter; 4 | import com.ikeirnez.pluginmessageframework.RawPacket; 5 | 6 | import java.io.IOException; 7 | 8 | /** 9 | * Created by iKeirNez on 01/01/14. 10 | */ 11 | public class PacketMessage extends RawPacket { 12 | 13 | public String name; 14 | public String message; 15 | 16 | public PacketMessage(String name, String message){ 17 | super("BungeeCord"); 18 | this.name = name; 19 | this.message = message; 20 | } 21 | 22 | @Override 23 | public PacketWriter write() throws IOException { 24 | PacketWriter packetWriter = new PacketWriter(this); 25 | packetWriter.writeUTF("Message"); 26 | packetWriter.writeUTF(name); 27 | packetWriter.writeUTF(message); 28 | return packetWriter; 29 | } 30 | } 31 | -------------------------------------------------------------------------------- /src/main/java/com/ikeirnez/pluginmessageframework/packets/bungeecord/PacketConnectOther.java: -------------------------------------------------------------------------------- 1 | package com.ikeirnez.pluginmessageframework.packets.bungeecord; 2 | 3 | import com.ikeirnez.pluginmessageframework.PacketWriter; 4 | import com.ikeirnez.pluginmessageframework.RawPacket; 5 | 6 | import java.io.IOException; 7 | 8 | /** 9 | * Created by iKeirNez on 01/01/14. 10 | */ 11 | public class PacketConnectOther extends RawPacket { 12 | 13 | public String name; 14 | public String server; 15 | 16 | public PacketConnectOther(String name, String server){ 17 | super("BungeeCord"); 18 | this.name = name; 19 | this.server = server; 20 | } 21 | 22 | @Override 23 | public PacketWriter write() throws IOException { 24 | PacketWriter packetWriter = new PacketWriter(this); 25 | packetWriter.writeUTF("ConnectOther"); 26 | packetWriter.writeUTF(name); 27 | packetWriter.writeUTF(server); 28 | return packetWriter; 29 | } 30 | } 31 | -------------------------------------------------------------------------------- /src/main/java/com/ikeirnez/pluginmessageframework/packets/bungeecord/PacketForward.java: -------------------------------------------------------------------------------- 1 | package com.ikeirnez.pluginmessageframework.packets.bungeecord; 2 | 3 | import com.ikeirnez.pluginmessageframework.PacketWriter; 4 | import com.ikeirnez.pluginmessageframework.StandardPacket; 5 | import com.ikeirnez.pluginmessageframework.RawPacket; 6 | 7 | import java.io.IOException; 8 | 9 | /** 10 | * Created by iKeirNez on 22/02/14. 11 | */ 12 | public class PacketForward extends RawPacket { 13 | 14 | public String server; 15 | public String channel; 16 | public StandardPacket packet; 17 | 18 | public PacketForward(String server, StandardPacket packet){ 19 | super("BungeeCord"); 20 | this.server = server; 21 | this.packet = packet; 22 | } 23 | 24 | @Override 25 | public PacketWriter write() throws IOException { 26 | PacketWriter packetWriter = new PacketWriter(this); 27 | packetWriter.writeUTF("Forward"); 28 | packetWriter.writeUTF(server); 29 | packetWriter.writeUTF(channel); 30 | byte[] msgBytes = packet.write().toByteArray(); 31 | packetWriter.writeShort(msgBytes.length); 32 | packetWriter.write(msgBytes); 33 | return packetWriter; 34 | } 35 | } 36 | -------------------------------------------------------------------------------- /src/main/java/com/ikeirnez/pluginmessageframework/PacketPlayer.java: -------------------------------------------------------------------------------- 1 | package com.ikeirnez.pluginmessageframework; 2 | 3 | import net.md_5.bungee.api.connection.ProxiedPlayer; 4 | import org.bukkit.entity.Player; 5 | 6 | /** 7 | * Represents a BungeeCord or Bukkit player 8 | * Created by iKeirNez on 12/12/13. 9 | */ 10 | public class PacketPlayer { 11 | 12 | private String name; 13 | private ProxiedPlayer bungeePlayer = null; 14 | private Player bukkitPlayer = null; 15 | 16 | /** 17 | * Constructor used in the case of a BungeeCord player 18 | * @param bungeePlayer The BungeeCord player instance 19 | */ 20 | public PacketPlayer(ProxiedPlayer bungeePlayer){ 21 | this.bungeePlayer = bungeePlayer; 22 | this.name = bungeePlayer.getName(); 23 | } 24 | 25 | /** 26 | * Constructor used in the case of a Bukkit player 27 | * @param bukkitPlayer The Bukkit player instance 28 | */ 29 | public PacketPlayer(Player bukkitPlayer){ 30 | this.bukkitPlayer = bukkitPlayer; 31 | this.name = bukkitPlayer.getName(); 32 | } 33 | 34 | public String getName(){ 35 | return name; 36 | } 37 | 38 | public ProxiedPlayer getBungeePlayer(){ 39 | return bungeePlayer; 40 | } 41 | 42 | public Player getBukkitPlayer() { 43 | return bukkitPlayer; 44 | } 45 | } 46 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | 2 | ### Maven template 3 | target/ 4 | pom.xml.tag 5 | pom.xml.releaseBackup 6 | pom.xml.versionsBackup 7 | pom.xml.next 8 | release.properties 9 | dependency-reduced-pom.xml 10 | 11 | 12 | ### Java template 13 | *.class 14 | 15 | # Mobile Tools for Java (J2ME) 16 | .mtj.tmp/ 17 | 18 | # Package Files # 19 | *.jar 20 | *.war 21 | *.ear 22 | 23 | # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml 24 | hs_err_pid* 25 | 26 | 27 | ### JetBrains template 28 | # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm 29 | 30 | *.iml 31 | 32 | ## Directory-based project format: 33 | .idea/ 34 | # if you remove the above rule, at least ignore the following: 35 | 36 | # User-specific stuff: 37 | # .idea/workspace.xml 38 | # .idea/tasks.xml 39 | # .idea/dictionaries 40 | 41 | # Sensitive or high-churn files: 42 | # .idea/dataSources.ids 43 | # .idea/dataSources.xml 44 | # .idea/sqlDataSources.xml 45 | # .idea/dynamic.xml 46 | # .idea/uiDesigner.xml 47 | 48 | # Gradle: 49 | # .idea/gradle.xml 50 | # .idea/libraries 51 | 52 | # Mongo Explorer plugin: 53 | # .idea/mongoSettings.xml 54 | 55 | ## File-based project format: 56 | *.ipr 57 | *.iws 58 | 59 | ## Plugin-specific files: 60 | 61 | # IntelliJ 62 | out/ 63 | 64 | # mpeltonen/sbt-idea plugin 65 | .idea_modules/ 66 | 67 | # JIRA plugin 68 | atlassian-ide-plugin.xml 69 | 70 | # Crashlytics plugin (for Android Studio and IntelliJ) 71 | com_crashlytics_export_strings.xml 72 | crashlytics.properties 73 | crashlytics-build.properties 74 | 75 | 76 | -------------------------------------------------------------------------------- /src/main/java/com/ikeirnez/pluginmessageframework/StandardPacket.java: -------------------------------------------------------------------------------- 1 | package com.ikeirnez.pluginmessageframework; 2 | 3 | import java.io.DataInputStream; 4 | import java.io.IOException; 5 | 6 | /** 7 | * Created by iKeirNez on 11/12/13. 8 | */ 9 | public abstract class StandardPacket { 10 | 11 | protected PacketPlayer sender; 12 | 13 | /** 14 | * Gets the player this packet was received from 15 | * PLEASE NOTE for forwarded packets this may not be the player that you send the packet via, it will just be 16 | * the first player found the could deliver that packet 17 | * @return The player this packet was received from 18 | */ 19 | public PacketPlayer getSender(){ 20 | return sender; 21 | } 22 | 23 | /** 24 | * When a packet is received, data is passed through here. The packet class must cache data ready for the instance to be passed t listeners 25 | * @param dataInputStream The data received 26 | * @throws java.io.IOException Thrown if there is an error handling the packet 27 | */ 28 | public abstract void handle(DataInputStream dataInputStream) throws IOException; 29 | 30 | /** 31 | * This function is called when a packet is being prepared to be sent, the function must write cached values to a PacketWriter and return it 32 | * @return The PacketWriter containing all data ready to send 33 | * @throws java.io.IOException Thrown if there is an error writing this packet 34 | */ 35 | public abstract PacketWriter write() throws IOException; 36 | 37 | } 38 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 4.0.0 6 | com.ikeirnez 7 | PluginMessageFramework 8 | 1.0.0-SNAPSHOT 9 | 10 | 11 | spigot-repo 12 | https://hub.spigotmc.org/nexus/content/repositories/snapshots/ 13 | 14 | 15 | sonatype-oss-public 16 | https://oss.sonatype.org/content/groups/public/ 17 | 18 | 19 | 20 | src/main/java 21 | PluginMessageFramework-${project.version} 22 | 23 | 24 | maven-compiler-plugin 25 | 2.3.2 26 | 27 | 1.7 28 | 1.7 29 | 30 | 31 | 32 | 33 | 34 | 35 | net.md-5 36 | bungeecord-api 37 | 1.8-SNAPSHOT 38 | 39 | 40 | org.spigotmc 41 | spigot-api 42 | 1.8.3-R0.1-SNAPSHOT 43 | 44 | 45 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | PluginMessageFramework 2 | ================= 3 | 4 | An extension of the Plugin Message API for Bukkit, BungeeCord 5 | 6 | Links 7 | ----- 8 | 9 | * [Bukkit Post](http://forums.bukkit.org/threads/api-pluginmessageapi.213649/) 10 | * [Spigot Post](http://www.spigotmc.org/resources/pluginmessageapi.294/) 11 | 12 | Example Usage 13 | ------------- 14 | 15 | Initializing Example (Bukkit) 16 | 17 | ```java 18 | public PacketManager packetManager; 19 | 20 | public void onEnable(){ 21 | packetManager = new BukkitPacketManager(this, "MyChannelName"); 22 | packetManager.registerListener(new IncomingPacketHandler()); 23 | } 24 | ``` 25 | 26 | 27 | Initializing Example (BungeeCord) 28 | 29 | ```java 30 | public PacketManager packetManager; 31 | 32 | public void onEnable(){ 33 | packetManager = new BungeeCordPacketManager(this, "MyChannelName"); 34 | packetManager.registerListener(new IncomingPacketHandler()); 35 | } 36 | ``` 37 | 38 | 39 | Packet Class Example 40 | 41 | ```java 42 | public class PacketPlayerUpdatePoints extends StandardPacket { 43 | 44 | public int points; 45 | 46 | public PacketPlayerUpdatePoints(){} 47 | 48 | public PacketPlayerUpdatePoints(int point){ 49 | this.change = change; 50 | } 51 | 52 | public void handle(DataInputStream dataInputStream) throws IOException { 53 | this.point = dataInputStream.readInt(); 54 | } 55 | 56 | public PacketWriter write() throws IOException { 57 | PacketWriter packetWriter = new PacketWriter(this); 58 | packetWriter.writeInt(points); 59 | return packetWriter; 60 | } 61 | } 62 | ``` 63 | 64 | 65 | Sending Example (Bukkit, similar for BungeeCord) 66 | 67 | ```java 68 | packetManager.sendPacket(new PacketPlayer(Bukkit.getOnlinePlayers()[0], new PacketPlayerUpdatePoints(50))); 69 | ``` 70 | 71 | 72 | Listener Example (Bukkit, same for BungeeCord) 73 | 74 | ```java 75 | public class IncomingPacketHandler implements PacketListener { 76 | @PacketHandler 77 | public void onPointsUpdate(PacketPlayerUpdatePoints packet){ 78 | Player player = packet.getSender().getBukkitPlayer(); 79 | int points = packet.points; 80 | 81 | // do something to update points 82 | } 83 | } 84 | ``` 85 | 86 | Plugins/Mods/Addons/Servers using this API 87 | ---------------------------------- 88 | 89 | * [CloudChat](http://www.spigotmc.org/resources/cloudchat.266/) -------------------------------------------------------------------------------- /src/main/java/com/ikeirnez/pluginmessageframework/implementations/BungeeCordPacketManager.java: -------------------------------------------------------------------------------- 1 | package com.ikeirnez.pluginmessageframework.implementations; 2 | 3 | import com.ikeirnez.pluginmessageframework.PacketPlayer; 4 | import com.ikeirnez.pluginmessageframework.PacketManager; 5 | import net.md_5.bungee.api.ProxyServer; 6 | import net.md_5.bungee.api.connection.ProxiedPlayer; 7 | import net.md_5.bungee.api.connection.Server; 8 | import net.md_5.bungee.api.event.PluginMessageEvent; 9 | import net.md_5.bungee.api.event.PostLoginEvent; 10 | import net.md_5.bungee.api.plugin.Listener; 11 | import net.md_5.bungee.api.plugin.Plugin; 12 | import net.md_5.bungee.event.EventHandler; 13 | 14 | /** 15 | * Created by iKeirNez on 24/12/13. 16 | */ 17 | public class BungeeCordPacketManager extends PacketManager implements Listener { 18 | 19 | public BungeeCordPacketManager(Plugin bungeePlugin, String channel){ 20 | super(channel); 21 | bungeePlugin.getProxy().getPluginManager().registerListener(bungeePlugin, this); 22 | bungeePlugin.getProxy().registerChannel(channel); 23 | } 24 | 25 | @Override 26 | protected void sendPluginMessage(PacketPlayer packetPlayer, String channel, byte[] bytes) { 27 | packetPlayer.getBungeePlayer().getServer().sendData(channel, bytes); 28 | } 29 | 30 | @Override 31 | protected int getPlayerCount() { 32 | return ProxyServer.getInstance().getPlayers().size(); 33 | } 34 | 35 | @Override 36 | protected PacketPlayer getRandomPlayer() { 37 | return getPlayerCount() > 0 ? new PacketPlayer(ProxyServer.getInstance().getPlayers().iterator().next()) : null; 38 | } 39 | 40 | @EventHandler 41 | public void onPluginMessage(PluginMessageEvent e){ 42 | String channel = e.getTag(); 43 | 44 | if (channel.equals(getChannel())){ 45 | e.setCancelled(true); 46 | 47 | if (e.getSender() instanceof Server){ // prevents players faking a plugin message 48 | ProxiedPlayer proxiedPlayer = (ProxiedPlayer) e.getReceiver(); 49 | dispatchIncomingPacket(new PacketPlayer(proxiedPlayer), e.getData()); 50 | } 51 | } 52 | } 53 | 54 | @EventHandler 55 | public void onPlayerJoin(PostLoginEvent e){ 56 | if (getPlayerCount() == 1){ 57 | playerJoined(new PacketPlayer(e.getPlayer())); 58 | } 59 | } 60 | } 61 | -------------------------------------------------------------------------------- /src/main/java/com/ikeirnez/pluginmessageframework/implementations/BukkitPacketManager.java: -------------------------------------------------------------------------------- 1 | package com.ikeirnez.pluginmessageframework.implementations; 2 | 3 | import com.ikeirnez.pluginmessageframework.PacketPlayer; 4 | import com.ikeirnez.pluginmessageframework.PacketManager; 5 | import org.bukkit.Bukkit; 6 | import org.bukkit.entity.Player; 7 | import org.bukkit.event.EventHandler; 8 | import org.bukkit.event.Listener; 9 | import org.bukkit.event.player.PlayerJoinEvent; 10 | import org.bukkit.plugin.java.JavaPlugin; 11 | import org.bukkit.plugin.messaging.Messenger; 12 | import org.bukkit.plugin.messaging.PluginMessageListener; 13 | 14 | /** 15 | * Created by iKeirNez on 24/12/13. 16 | */ 17 | public class BukkitPacketManager extends PacketManager implements PluginMessageListener, Listener { 18 | 19 | private JavaPlugin bukkitPlugin; 20 | 21 | public BukkitPacketManager(JavaPlugin bukkitPlugin, String channel){ 22 | super(channel); 23 | this.bukkitPlugin = bukkitPlugin; 24 | 25 | Messenger messenger = Bukkit.getMessenger(); 26 | 27 | messenger.registerOutgoingPluginChannel(bukkitPlugin, channel); 28 | messenger.registerIncomingPluginChannel(bukkitPlugin, channel, this); 29 | messenger.registerIncomingPluginChannel(bukkitPlugin, "BungeeCord", this); 30 | messenger.registerOutgoingPluginChannel(bukkitPlugin, "BungeeCord"); 31 | 32 | Bukkit.getPluginManager().registerEvents(this, bukkitPlugin); 33 | } 34 | 35 | @Override 36 | protected void sendPluginMessage(PacketPlayer packetPlayer, String channel, byte[] bytes) { 37 | packetPlayer.getBukkitPlayer().sendPluginMessage(bukkitPlugin, channel, bytes); 38 | } 39 | 40 | @Override 41 | protected int getPlayerCount() { 42 | return Bukkit.getOnlinePlayers().size(); 43 | } 44 | 45 | @Override 46 | protected PacketPlayer getRandomPlayer() { 47 | return getPlayerCount() > 0 ? new PacketPlayer(Bukkit.getOnlinePlayers().iterator().next()) : null; 48 | } 49 | 50 | public void onPluginMessageReceived(String channel, Player player, byte[] bytes) { 51 | if (channel.equals(getChannel())){ 52 | dispatchIncomingPacket(new PacketPlayer(player), bytes); 53 | } else if (channel.equals("BungeeCord")){ 54 | dispatchIncomingForwardPacket(new PacketPlayer(player), bytes); 55 | } 56 | } 57 | 58 | @EventHandler 59 | public void onPlayerJoin(PlayerJoinEvent e){ 60 | if (getPlayerCount() == 1){ 61 | playerJoined(new PacketPlayer(e.getPlayer())); 62 | } 63 | } 64 | } 65 | -------------------------------------------------------------------------------- /src/main/java/com/ikeirnez/pluginmessageframework/PacketWriter.java: -------------------------------------------------------------------------------- 1 | package com.ikeirnez.pluginmessageframework; 2 | 3 | import java.io.ByteArrayOutputStream; 4 | import java.io.DataOutputStream; 5 | import java.io.IOException; 6 | 7 | /** 8 | * Created by iKeirNez on 12/12/13. 9 | */ 10 | public class PacketWriter { 11 | 12 | private final StandardPacket packet; 13 | 14 | private ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream(); 15 | private DataOutputStream dataOutputStream = new DataOutputStream(byteArrayOutputStream); 16 | 17 | /** 18 | * Creates a new instance of this class 19 | * @param packet The packet that is writing to this instance 20 | */ 21 | public PacketWriter(StandardPacket packet){ 22 | this.packet = packet; 23 | 24 | if (!(packet instanceof RawPacket)){ 25 | try { 26 | dataOutputStream.writeUTF(packet.getClass().getName()); 27 | } catch (IOException e) { 28 | e.printStackTrace(); 29 | } 30 | } 31 | } 32 | 33 | public byte[] toByteArray(){ 34 | return byteArrayOutputStream.toByteArray(); 35 | } 36 | 37 | // DataOutputStream methods 38 | 39 | public void write(int v) throws IOException { 40 | dataOutputStream.write(v); 41 | } 42 | 43 | public void write(byte b[], int off, int len) throws IOException { 44 | dataOutputStream.write(b, off, len); 45 | } 46 | 47 | public void write(byte[] b) throws IOException { 48 | dataOutputStream.write(b); 49 | } 50 | 51 | public void flush() throws IOException { 52 | dataOutputStream.flush(); 53 | } 54 | 55 | public void writeBoolean(boolean v) throws IOException { 56 | dataOutputStream.writeBoolean(v); 57 | } 58 | 59 | public void writeByte(int v) throws IOException { 60 | dataOutputStream.writeByte(v); 61 | } 62 | 63 | public void writeShort(int v) throws IOException { 64 | dataOutputStream.writeShort(v); 65 | } 66 | 67 | public void writeChar(int v) throws IOException { 68 | dataOutputStream.writeChar(v); 69 | } 70 | 71 | public void writeInt(int v) throws IOException { 72 | dataOutputStream.writeInt(v); 73 | } 74 | 75 | public void writeLong(long v) throws IOException { 76 | dataOutputStream.writeLong(v); 77 | } 78 | 79 | public void writeFloat(float v) throws IOException { 80 | dataOutputStream.writeFloat(v); 81 | } 82 | 83 | public void writeDouble(double v) throws IOException { 84 | dataOutputStream.writeDouble(v); 85 | } 86 | 87 | public void writeBytes(String s) throws IOException { 88 | dataOutputStream.writeBytes(s); 89 | } 90 | 91 | public void writeChars(String s) throws IOException { 92 | dataOutputStream.writeChars(s); 93 | } 94 | 95 | public void writeUTF(String str) throws IOException { 96 | dataOutputStream.writeUTF(str); 97 | } 98 | 99 | public int size() { 100 | return dataOutputStream.size(); 101 | } 102 | 103 | } 104 | -------------------------------------------------------------------------------- /src/main/java/com/ikeirnez/pluginmessageframework/PacketManager.java: -------------------------------------------------------------------------------- 1 | package com.ikeirnez.pluginmessageframework; 2 | 3 | import com.ikeirnez.pluginmessageframework.packets.bungeecord.PacketForward; 4 | 5 | import java.io.*; 6 | import java.lang.reflect.InvocationTargetException; 7 | import java.lang.reflect.Method; 8 | import java.util.ArrayList; 9 | import java.util.HashMap; 10 | import java.util.Iterator; 11 | import java.util.List; 12 | 13 | /** 14 | * Created by iKeirNez on 12/12/13. 15 | */ 16 | public abstract class PacketManager { 17 | 18 | private final String channel, forwardChannel; 19 | 20 | private HashMap, List> packetListeners = new HashMap<>(); 21 | private List sendQueue = new ArrayList<>(); 22 | 23 | public PacketManager(String channel){ 24 | this.channel = channel; 25 | this.forwardChannel = channel + "-fwd"; 26 | } 27 | 28 | /** 29 | * Gets the channel this instance is tuned into 30 | * @return The channel this instance is tuned into 31 | */ 32 | public String getChannel(){ 33 | return channel; 34 | } 35 | 36 | /** 37 | * Gets the channel that all forward operations will be executed on 38 | * @return The forward channel 39 | */ 40 | public String getForwardChannel(){ 41 | return forwardChannel; 42 | } 43 | 44 | /** 45 | * Registers a packet, this allows the packet to be sent or received 46 | * A {@link RawPacket} must have an empty constructor (no parameters) 47 | * in order to function 48 | * @param packet The packet to be registered 49 | * @deprecated Packet registering system removed 50 | */ 51 | public void registerPacket(Class packet){ 52 | } 53 | 54 | /** 55 | * Un-registers a packet, this means the packet can no longer be sent or receieved 56 | * @param packet The packet to be un-registered 57 | * @deprecated Packet registering system removed 58 | */ 59 | public void unregisterPacket(Class packet){ 60 | } 61 | 62 | /** 63 | * Checks if a a packet is registered 64 | * @param packet The packet to check if registered 65 | * @return That registered status of the packet 66 | * @deprecated Packet registering system removed 67 | */ 68 | public boolean isPacketRegistered(StandardPacket packet){ 69 | return true; 70 | } 71 | 72 | /** 73 | * Checks if a a packet is registered 74 | * @param packet The packet to check if registered 75 | * @return That registered status of the packet 76 | * @deprecated Packet registering system removed 77 | */ 78 | public boolean isPacketRegistered(Class packet){ 79 | return true; 80 | } 81 | 82 | /** 83 | * Registers a new listener, this class will be able to receive from packets it listens to 84 | * @param packetListener The listener to be registered 85 | */ 86 | public void registerListener(final PacketListener packetListener){ 87 | for (Method method : packetListener.getClass().getMethods()){ 88 | Class[] parameters = method.getParameterTypes(); 89 | 90 | if (parameters.length == 1 && StandardPacket.class.isAssignableFrom(parameters[0])){ 91 | Class parameter = (Class) parameters[0]; 92 | 93 | if (!packetListeners.containsKey(parameter)){ 94 | packetListeners.put(parameter, new ArrayList(){ 95 | { 96 | add(packetListener); 97 | } 98 | }); 99 | } else { 100 | List existingList = packetListeners.get(parameter); 101 | existingList.add(packetListener); 102 | packetListeners.put(parameter, existingList); 103 | } 104 | } 105 | } 106 | } 107 | 108 | /** 109 | * Un-registers a listener, this class will no longer be able to receieve packets 110 | * @param packetListener The listener to be un-registered 111 | */ 112 | public void unregisterListener(PacketListener packetListener){ 113 | Iterator> iterator = packetListeners.keySet().iterator(); 114 | while (iterator.hasNext()){ 115 | Class clazz = iterator.next(); 116 | List list = packetListeners.get(clazz); 117 | 118 | if (list.contains(packetListener)){ 119 | list.remove(packetListener); 120 | packetListeners.put(clazz, list); 121 | } 122 | } 123 | } 124 | 125 | /** 126 | * Dispatches an incoming packet to listeners 127 | * @param packetPlayer The player whom this packet was received from 128 | * @param bytes The byte array containing data 129 | */ 130 | public void dispatchIncomingPacket(PacketPlayer packetPlayer, byte[] bytes){ 131 | DataInputStream dataInputStream = new DataInputStream(new ByteArrayInputStream(bytes)); 132 | doPacket(packetPlayer, dataInputStream); 133 | } 134 | 135 | /** 136 | * Dispatches an incoming forwarded packet to listeners 137 | * PLEASE NOTE the {@link PacketPlayer} is not the "REAL" sender 138 | * as this packet has been forwarded from another server 139 | * @param packetPlayer The player whom this packet was received from 140 | * @param bytes The byte array containing data 141 | */ 142 | public void dispatchIncomingForwardPacket(PacketPlayer packetPlayer, byte[] bytes){ 143 | DataInputStream dataInputStream = new DataInputStream(new ByteArrayInputStream(bytes)); 144 | 145 | try { 146 | if (dataInputStream.readUTF().equals(getForwardChannel())){ 147 | short length = dataInputStream.readShort(); 148 | byte[] msgBytes = new byte[length]; 149 | dataInputStream.readFully(msgBytes); 150 | 151 | DataInputStream realDataInputStream = new DataInputStream(new ByteArrayInputStream(msgBytes)); 152 | doPacket(packetPlayer, realDataInputStream); 153 | } 154 | } catch (IOException e) { 155 | e.printStackTrace(); 156 | } 157 | } 158 | 159 | private void doPacket(PacketPlayer packetPlayer, DataInputStream dataInputStream){ 160 | Class packetClazz; 161 | String packetName = ""; 162 | 163 | try { 164 | packetName = dataInputStream.readUTF(); 165 | Class clazz = Class.forName(packetName); 166 | 167 | if (StandardPacket.class.isAssignableFrom(clazz)){ 168 | packetClazz = (Class) clazz; 169 | 170 | StandardPacket packet = packetClazz.newInstance(); 171 | packet.sender = packetPlayer; 172 | packet.handle(dataInputStream); 173 | 174 | List listeners = packetListeners.get(packetClazz); 175 | if (listeners != null){ 176 | for (PacketListener packetListener : listeners){ 177 | for (Method method : packetListener.getClass().getMethods()){ 178 | if (method.isAnnotationPresent(PacketHandler.class)){ 179 | Class[] parameters = method.getParameterTypes(); 180 | 181 | if (parameters.length == 1 && parameters[0].equals(packetClazz)){ 182 | try { 183 | method.invoke(packetListener, packet); 184 | } catch (InvocationTargetException e) { 185 | System.out.println("Error whilst passing packet to listener " + packetListener.getClass() + "#" + method.getName()); 186 | e.printStackTrace(); 187 | } 188 | } 189 | } 190 | } 191 | } 192 | } 193 | } 194 | } catch (ClassNotFoundException ignored){ // silently ignore packets we don't know about 195 | } catch (Throwable e){ 196 | System.out.println("Error whilst receiving packet " + packetName); 197 | e.printStackTrace(); 198 | } 199 | } 200 | 201 | private String figureChannel(StandardPacket packet){ 202 | String sendChannel = getChannel(); 203 | 204 | if (packet instanceof RawPacket){ 205 | sendChannel = ((RawPacket) packet).getChannel(); 206 | 207 | if (sendChannel == null){ 208 | sendChannel = getChannel(); 209 | } 210 | } 211 | 212 | return sendChannel; 213 | } 214 | 215 | protected void playerJoined(PacketPlayer packetPlayer){ 216 | for (StandardPacket packet : sendQueue){ 217 | sendPacket(packetPlayer, packet); 218 | } 219 | 220 | sendQueue.clear(); 221 | } 222 | 223 | private void addToQueue(StandardPacket packet){ 224 | sendQueue.add(packet); 225 | } 226 | 227 | /** 228 | * Sends a packet via any available means 229 | * @param packet The packet to send 230 | */ 231 | public void sendPacket(StandardPacket packet){ 232 | sendPacket(null, packet, true); 233 | } 234 | 235 | /** 236 | * Sends a packet via a player 237 | * @param packetPlayer The player whom this should be sent to 238 | * @param packet The packet to be sent to the player 239 | */ 240 | public void sendPacket(PacketPlayer packetPlayer, StandardPacket packet){ 241 | sendPacket(packetPlayer, packet, false); 242 | } 243 | 244 | /** 245 | * Sends a packet via a player 246 | * @param packetPlayer The player whom this should be sent to 247 | * @param packet The packet to be sent to the player 248 | * @param random Send via a random player if packetPlayer is null 249 | */ 250 | public void sendPacket(PacketPlayer packetPlayer, StandardPacket packet, boolean random){ 251 | try { 252 | if (packet instanceof PacketForward){ // fix for forward packets 253 | PacketForward packetForward = (PacketForward) packet; 254 | 255 | if (packetForward.channel == null){ 256 | packetForward.channel = getForwardChannel(); 257 | } 258 | } 259 | 260 | if (packetPlayer == null){ 261 | if (random){ 262 | if (getPlayerCount() > 0){ 263 | sendPluginMessage(getRandomPlayer(), figureChannel(packet), packet.write().toByteArray()); 264 | } else { 265 | addToQueue(packet); 266 | } 267 | } 268 | } else { 269 | sendPluginMessage(packetPlayer, figureChannel(packet), packet.write().toByteArray()); 270 | } 271 | } catch (IOException e) { 272 | System.out.println("Error whilst writing packet " + getClass().getSimpleName()); 273 | e.printStackTrace(); 274 | } 275 | } 276 | 277 | protected abstract void sendPluginMessage(PacketPlayer packetPlayer, String channel, byte[] bytes); 278 | protected abstract int getPlayerCount(); 279 | protected abstract PacketPlayer getRandomPlayer(); 280 | 281 | } 282 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . --------------------------------------------------------------------------------