Support ruby-only event handler chains; Add friend/ignore list support and private messaging; Format.

data/events.xml

@@ -1,10 +1,4 @@
 <events>
-  <event>
-    <type>org.apollo.game.event.impl.PrivacyOptionEvent</type>
-    <chain>
-      <handler>org.apollo.game.event.handler.impl.PrivacyOptionEventHandler</handler>
-    </chain>
-  </event>
   <event>
     <type>org.apollo.game.event.impl.PlayerDesignEvent</type>
     <chain>

data/plugins/bootstrap.rb

@@ -13,11 +13,14 @@
 # *****************************************************************************
 
 require 'java'
-java_import 'org.apollo.game.event.handler.EventHandler'
+
 java_import 'org.apollo.game.command.CommandListener'
+java_import 'org.apollo.game.event.handler.EventHandler'
+java_import 'org.apollo.game.login.LoginListener'
+java_import 'org.apollo.game.login.LogoutListener'
 java_import 'org.apollo.game.model.Player'
-java_import 'org.apollo.game.model.settings.PrivilegeLevel'
 java_import 'org.apollo.game.model.World'
+java_import 'org.apollo.game.model.settings.PrivilegeLevel'
 java_import 'org.apollo.game.scheduling.ScheduledTask'
 
 # Alias the privilege levels.
@@ -33,7 +36,7 @@ class String
   end
 end
 
-# A CommandListener which executes a Proc object with two arguments: the player
+# A CommandListener that executes a Proc object with two arguments: the player
 # and the command.
 class ProcCommandListener < CommandListener
   def initialize(rights, block)
@@ -46,6 +49,30 @@ class ProcCommandListener < CommandListener
   end
 end
 
+# A LoginListener that executes a Proc object with the player argument.
+class ProcLoginListener < LoginListener
+  def initialize(block)
+    super()
+    @block = block
+  end
+
+  def execute(player)
+    @block.call player
+  end
+end
+
+# A LogoutListener that executes a Proc object with the player argument.
+class ProcLogoutListener < LogoutListener
+  def initialize(block)
+    super()
+    @block = block
+  end
+
+  def execute(player)
+    @block.call player
+  end
+end
+
 # An EventHandler which executes a Proc object with three arguments: the chain
 # context, the player and the event.
 class ProcEventHandler < EventHandler
@@ -114,6 +141,8 @@ def on(type, *args, &block)
     when :command then on_command(args, block)
     when :event   then on_event(args, block)
     when :button  then on_button(args, block)
+    when :login   then on_login(args, block)
+    when :logout  then on_logout(args, block)
     else raise "unknown event type"
   end
 end
@@ -125,7 +154,7 @@ def on_button(args, proc)
   id = args[0].to_i
 
   on :event, :button do |ctx, player, event|
-    proc.call(player) if event.widget_id == id
+    proc.call player if event.widget_id == id
   end
 end
 
@@ -151,4 +180,14 @@ def on_command(args, proc)
   rights = args.length == 2 ? args[1] : RIGHTS_STANDARD
 
   $ctx.add_command_listener(args[0].to_s, ProcCommandListener.new(rights, proc))
+end
+
+# Defines an action to be taken upon login.
+def on_login(args, proc)
+  $ctx.add_login_listener ProcLoginListener.new(proc)
+end
+
+# Defines an action to be taken upon logout.
+def on_logout(args, proc)
+  $ctx.add_logout_listener ProcLogoutListener.new(proc)
 end

data/plugins/chat-privacy/plugin.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0"?>
+<plugin>
+  <id>chat-privacy</id>
+  <version>1</version>
+  <name>Chat privacy</name>
+  <description>Adds chat privacy support.</description>
+  <authors>
+    <author>Major</author>
+  </authors>
+  <scripts>
+    <script>privacy.rb</script>
+  </scripts>
+  <dependencies>
+    <dependency>private-messaging</dependency>
+  </dependencies>
+</plugin>

data/plugins/chat-privacy/privacy.rb

@@ -0,0 +1,11 @@
+require 'java'
+
+java_import 'org.apollo.game.model.settings.PrivacyState'
+
+on :event, :privacy_option do |ctx, player, event|
+  player.chat_privacy = event.chat_privacy
+  player.friend_privacy = event.friend_privacy
+  player.trade_privacy = event.trade_privacy
+
+  update_friends(player, event.friend_privacy == PrivacyState::OFF ? 0 : player.world_id)
+end

data/plugins/private-messaging/friend.rb

@@ -0,0 +1,82 @@
+require 'java'
+
+java_import 'org.apollo.game.event.impl.FriendServerStatusEvent'
+java_import 'org.apollo.game.event.impl.SendFriendEvent'
+java_import 'org.apollo.game.model.Player'
+java_import 'org.apollo.game.model.World'
+java_import 'org.apollo.game.model.settings.ServerStatus'
+java_import 'org.apollo.game.model.settings.PrivacyState'
+
+
+# Processes an add friend event, updating the logged-in status of the player (and the person they added) if necessary.
+on :event, :add_friend do |ctx, player, event|
+  friend_username = event.username
+  player_username = player.username
+
+  player.add_friend(friend_username)
+  friend = World.world.get_player(friend_username)
+
+  if (friend == nil) # the friend the player added is offline
+    player.send(SendFriendEvent.new(friend_username, 0))
+  elsif (friend.friends_with(player_username)) # new friend already has the player added
+    unless (player.friend_privacy == PrivacyState::OFF) # player's private chat state is not off
+      friend.send(SendFriendEvent.new(player_username, player.world_id)) # ... so we can tell the friend what world they're on
+    end
+
+    unless (friend.friend_privacy == PrivacyState::OFF) # new friend's private chat state is not off 
+      player.send(SendFriendEvent.new(friend_username, friend.world_id)) # ... so we can let the player know what world they're on
+    end
+  elsif (friend.friend_privacy == PrivacyState::ON) # new friend doesn't have the player added but their private chat state is online
+	  player.send(SendFriendEvent.new(friend_username, friend.world_id)) # ... so we can let the player know what world they're on
+  end
+end
+
+# Processes a remove friend event, updating the logged-in status of the player if necessary.
+on :event, :remove_friend do |ctx, player, event|
+  friend_username = event.username
+  player_username = player.username
+
+  player.remove_friend(friend_username)
+  friend = World.world.get_player(friend_username)
+  next if friend == nil
+
+  friend.send(SendFriendEvent.new(player_username, 0)) if (friend.friends_with(player_username) && player.friend_privacy != PrivacyState::ON)
+end
+
+# Update the friend server status and send the friend/ignore lists of the player logging in.
+on :login do |player|
+  player.send(FriendServerStatusEvent.new(ServerStatus::CONNECTING))
+
+  player.send(IgnoreListEvent.new(player.ignored_usernames)) if player.ignored_usernames.size > 0
+
+  world = World.world
+  iterator = player.friend_usernames.iterator
+  while iterator.has_next
+    username = iterator.next
+    world_id = world.is_player_online(username) ? world.get_player(username).world_id : 0;
+    player.send(SendFriendEvent.new(username, world_id))
+  end
+
+  player.send(FriendServerStatusEvent.new(ServerStatus::ONLINE))
+  update_friends(player, player.world_id)
+end
+
+on :logout do |player|
+  update_friends(player, 0)
+end
+
+
+# Notifies the currently logged in players that the specified player has logged into the specified world, unless the 
+# newly logged-in player has their friend privacy state set to 'off'.
+def update_friends(player, world=0)
+  privacy = player.friend_privacy
+  
+  iterator = World.world.player_repository.iterator
+  username = player.username
+
+  while iterator.has_next
+    other = iterator.next
+    next if other == player
+    other.send(SendFriendEvent.new(username, world)) if (player.friends_with(other.username) || player.private_chat_privacy == PrivacyState::ON)
+  end
+end

data/plugins/private-messaging/ignore.rb

@@ -0,0 +1,9 @@
+on :event, :add_ignore do |ctx, player, event|
+  username = event.username
+  player.add_ignore(username)
+end
+
+on :event, :remove_ignore do |ctx, player, event|
+  username = event.username
+  player.remove_ignore(username)
+end

data/plugins/private-messaging/messaging.rb

@@ -0,0 +1,21 @@
+require 'java'
+
+java_import 'org.apollo.game.event.impl.ForwardPrivateMessageEvent'
+java_import 'org.apollo.game.model.World'
+java_import 'org.apollo.game.model.settings.PrivacyState'
+
+on :event, :send_private_message do |ctx, player, event|
+  friend = World.world.get_player(event.username)
+  return unless interaction_permitted(player, friend)
+
+  friend.send(ForwardPrivateMessageEvent.new(player.username, player.privilege_level, event.compressed_message))
+end
+
+# Checks if the sender is permitted to interact with the friend they have added:
+def interaction_permitted(sender, friend)
+  if friend == nil || friend.has_ignored(sender.username)
+  	return false
+  end
+  
+  return friend.friends_with(sender.username) ? friend.friend_privacy != PrivacyState::OFF : friend.friend_privacy == PrivacyState::ON
+end

data/plugins/private-messaging/plugin.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0"?>
+<plugin>
+  <id>private-messaging</id>
+  <version>1</version>
+  <name>Private Messaging</name>
+  <description>Adds friend and ignore list support, and private messaging.</description>
+  <authors>
+    <author>Major</author>
+  </authors>
+  <scripts>
+    <script>friend.rb</script>
+    <script>ignore.rb</script>
+    <script>messaging.rb</script>
+  </scripts>
+  <dependencies />
+</plugin>