murmur-rpc 0.0.8 → 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9c00935a2c1e63c82960fb0c0ec13e844e0e53ec
+  data.tar.gz: 07b869391a613277388e2d4789fecd73222d4834
+SHA512:
+  metadata.gz: 79c3db87c1b3d776c933fbbcd1fb2d4d8edbdc3b7b40b46c3d8e980b5113609fe0426f410ec3a43562f7c347c922790a0e8737cf4c5a607fa205d2cb6bbb86d7
+  data.tar.gz: 078143492c5360ef460553f083f0e80a1c13899bb356ac2cebeb9352805b461c030a0eeea745c80656c02d3accdd82f406c89aa14c3f6170494f67c44d12c2cc

data/README.md

@@ -0,0 +1,11 @@
+# Murmur RPC Ruby Library
+
+This is a rubygem that allows you to connect and manage a murmurd server using the Ice interface.  It require the ruby Ice libraries to be installed.
+
+### How to update slice
+
+```
+cd vendor/ice
+wget -O Murmur.ice "https://raw.githubusercontent.com/mumble-voip/mumble/master/src/murmur/Murmur.ice"
+slice2rb Murmur.ice
+```

data/lib/murmur-rpc/interfaces/ice.rb

@@ -0,0 +1,161 @@
+require 'timeout'
+require 'benchmark'
+require 'Glacier2'
+
+require File.join(File.expand_path(File.dirname(__FILE__)), "..", "..", "..", "vendor", "ice", "Murmur.rb")
+
+module Murmur
+  module Ice
+    class ::InvalidMetaException < Exception; end
+    class ::Murmur::Ice::InvalidServerException < Exception; end
+    class Meta
+      def initialize(glacierHost = nil, glacierPort = nil, user = nil, pass = nil, host = "127.0.0.1", port = "6502", icesecret = nil, connect_timeout=nil, idletime = nil)
+        ic = nil
+        if icesecret and icesecret != ""
+          props = ::Ice::createProperties
+          props.setProperty "Ice.ImplicitContext", "Shared"
+          props.setProperty "Ice.Override.Timeout", connect_timeout.to_s unless connect_timeout == nil
+          props.setProperty "Ice.MessageSizeMax", "65536"
+          props.setProperty "Ice.Default.EncodingVersion", "1.0"
+          idd = ::Ice::InitializationData.new
+          idd.properties = props
+          ic = ::Ice::initialize idd
+          ic.getImplicitContext.put("secret", icesecret)
+        else
+          ic = ::Ice::initialize
+        end
+
+        if glacierHost and glacierHost != "" then
+          @glacierHost = glacierHost
+          @glacierPort = glacierPort
+          validate_connection(glacierHost, glacierPort)
+          prx = ic.stringToProxy("Glacier2/router:tcp -h #{glacierHost} -p #{glacierPort}")
+          @router = ::Glacier2::RouterPrx::uncheckedCast(prx).ice_router(nil)
+          @session = @router.createSession(user, pass)
+        end
+        conn = "tcp -h #{host} -p #{port}"
+        @meta = add_proxy_router(Murmur::MetaPrx::checkedCast(ic.stringToProxy("Meta:#{conn}")))
+        raise "Invalid proxy" unless @meta
+
+        @servers = {}
+      end
+
+      def destroy
+        begin
+          @router.destroySession @session unless @router.nil?
+        rescue ::Ice::ConnectionLostException
+          # Expected - Ice raises this when the connection is terminated. Yay for exceptions as flow control?
+        end
+        return nil
+      end
+
+      def add_proxy_router(prx)
+        @router ? prx.ice_router(@router) : prx
+      end
+
+      def get_server(id)
+        @servers[id] ||= Server.new(self, @meta, id)
+      end
+
+      def uncache_server(id)
+        @servers[id] = nil
+      end
+
+      def list_servers(only_booted = false)
+        method = only_booted ? :getBootedServers : :getAllServers
+        @meta.send(method).collect do |server|
+          server = add_proxy_router(server)
+          @servers[server.id] ||= Server.new(self, @meta, nil, server)
+        end
+      end
+
+      def validate
+        @meta.getVersion
+        return true
+      end
+
+      def new_server(port = nil)
+        server = @meta.newServer
+        @servers[server.id] = Server.new(self, @meta, nil, add_proxy_router(server))
+      end
+
+      def method_missing(method, *args)
+        method = method.to_s
+        method.gsub!(/_([a-z])/) { $1.upcase }
+        @meta.send method, *args
+      end
+
+      def validate_connection(host, port)
+        Timeout::timeout(2) do
+          begin
+            s = TCPSocket.new(host, port)
+            s.close
+          rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH
+            raise InvalidMetaException
+          end
+        end
+      rescue Timeout::Error
+        raise InvalidMetaException
+      end
+    end
+
+    class Server
+      def initialize(host, meta, id = nil, interface = nil)
+        @meta = meta
+        @host = host
+        if id.nil? and interface.nil? then
+          raise "Must pass either a server ID or a server interface instance"
+        end
+        @interface = interface || begin
+        server = @meta.getServer(id)
+        raise ::Murmur::Ice::InvalidServerException if server.nil?
+        host.add_proxy_router(server)
+        end
+      end
+
+      def id
+        @interface.id
+      end
+
+      def running?
+        @interface.isRunning
+      end
+
+      def config
+        @config = @meta.getDefaultConf.merge(@interface.getAllConf)
+      end
+
+      def destroy!
+        @interface.stop if running?
+        @host.uncache_server @interface.id
+        @interface.delete
+      end
+      alias :delete :destroy!
+
+      def restart!
+        @interface.stop if running?
+        @interface.start
+        @running = nil
+      end
+
+      def [](key)
+        config[key]
+      end
+
+      def []=(key, val)
+        @interface.setConf(key, val.to_s)
+        @config = nil
+      end
+
+      def setConf(key, val)
+        self[key] = val
+      end
+
+      def method_missing(method, *args)
+        method = method.to_s
+        method.gsub!(/_([a-z])/) { $1.upcase }
+        @interface.send method, *args
+      end
+    end
+  end
+end

data/lib/murmur-rpc/version.rb

@@ -0,0 +1,3 @@
+module MurmurRPC
+  VERSION="0.1.1"
+end

data/lib/murmur-rpc.rb

@@ -1,5 +1 @@
-require File.dirname(__FILE__) + '/interfaces/ice.rb'
-
-module MurmurRPC
-  VERSION="0.0.8"
-end
+require 'murmur-rpc/interfaces/ice.rb'

data/vendor/ice/Murmur.ice

@@ -64,10 +64,27 @@ module Murmur
 		bool tcponly;
 		/** Idle time. This is how many seconds it is since the user last spoke. Other activity is not counted. */
 		int idlesecs;
+		/** UDP Ping Average. This is the average ping for the user via UDP over the duration of the connection. */
+		float udpPing;
+		/** TCP Ping Average. This is the average ping for the user via TCP over the duration of the connection. */
+		float tcpPing;
 	};
 
 	sequence<int> IntList;
 
+	/** A text message between users.
+	 **/
+	struct TextMessage {
+		/** Sessions (connected users) who were sent this message. */
+		IntList sessions;
+		/** Channels who were sent this message. */
+		IntList channels;
+		/** Trees of channels who were sent this message. */
+		IntList trees;
+		/** The contents of the message. */
+		string text;
+	};
+
 	/** A channel.
 	 **/
 	struct Channel {
@@ -245,6 +262,8 @@ module Murmur
 	exception InvalidCallbackException extends MurmurException {};
 	/**  This is thrown when you supply the wrong secret in the calling context. */
 	exception InvalidSecretException extends MurmurException {};
+	/** This is thrown when the channel operation would excede the channel nesting limit */
+	exception NestingLimitException extends MurmurException {};
 
 	/** Callback interface for servers. You can supply an implementation of this to receive notification
 	 *  messages from the server.
@@ -270,6 +289,11 @@ module Murmur
 		 *  @param state New state of user.
 		 */
 		idempotent void userStateChanged(User state);
+		/** Called when user writes a text message
+		 *  @param state the User sending the message
+		 *  @param message the TextMessage the user has sent
+		 */
+		idempotent void userTextMessage(User state, TextMessage message);
 		/** Called when a new channel is created. 
 		 *  @param state State of new channel.
 		 */
@@ -414,7 +438,10 @@ module Murmur
 		/** Start server. */
 		void start() throws ServerBootedException, ServerFailureException, InvalidSecretException;
 
-		/** Stop server. */
+		/** Stop server.
+		 * Note: Server will be restarted on Murmur restart unless explicitly disabled
+		 *       with setConf("boot", false)
+		 */
 		void stop() throws ServerBootedException, InvalidSecretException;
 
 		/** Delete server and all it's configuration. */
@@ -550,6 +577,13 @@ module Murmur
 		 * @return true if any of the permissions in perm were set for the user.
 		 */
 		bool hasPermission(int session, int channelid, int perm) throws ServerBootedException, InvalidSessionException, InvalidChannelException, InvalidSecretException;
+		
+		/** Return users effective permissions
+		 * @param session Connection ID of user. See {@link User.session}.
+		 * @param channelid ID of Channel. See {@link Channel.id}.
+		 * @return bitfield of allowed actions
+		 */
+		idempotent int effectivePermissions(int session, int channelid) throws ServerBootedException, InvalidSessionException, InvalidChannelException, InvalidSecretException;
 
 		/** Add a context callback. This is done per user, and will add a context menu action for the user.
 		 *
@@ -581,7 +615,7 @@ module Murmur
 		 * @param state Channel state to set.
 		 * @see getChannelState
 		 */
-		idempotent void setChannelState(Channel state) throws ServerBootedException, InvalidChannelException, InvalidSecretException;
+		idempotent void setChannelState(Channel state) throws ServerBootedException, InvalidChannelException, InvalidSecretException, NestingLimitException;
 
 		/** Remove a channel and all its subchannels.
 		 * @param channelid ID of Channel. See {@link Channel.id}.
@@ -593,7 +627,7 @@ module Murmur
 		 * @param parent Channel ID of parent channel. See {@link Channel.id}.
 		 * @return ID of newly created channel.
 		 */
-		int addChannel(string name, int parent) throws ServerBootedException, InvalidChannelException, InvalidSecretException;
+		int addChannel(string name, int parent) throws ServerBootedException, InvalidChannelException, InvalidSecretException, NestingLimitException;
 
 		/** Send text message to channel or a tree of channels.
 		 * @param channelid Channel ID of channel to send to. See {@link Channel.id}.