rubyfox-server 2.3.0.pre2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rvmrc

@@ -0,0 +1 @@
+rvm @rubyfox-server --create

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 TODO: Write your name
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,23 @@
+# Rubyfox server
+
+SmartFox Server bundled as a gem.
+
+## Installation
+
+    $ gem install rubyfox-server
+
+## Usage
+
+    $ smartfox install /path/to/smartfox
+
+    $ smartfox config /path/to/smartfox /path/to/template/dir
+
+    $ smartfox start /path/to/smartfox
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/smartfox

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+
+require 'rubyfox/server/cli'
+
+Rubyfox::Server::CLI.start

data/lib/rubyfox/server/cli.rb

@@ -0,0 +1,59 @@
+require 'thor'
+require 'mime/types'
+
+require 'rubyfox/server'
+require 'rubyfox/server/environment'
+
+module Rubyfox
+  module Server
+    class CLI < Thor
+      include Thor::Actions
+
+      def self.source_root
+        Rubyfox::Server.data_dir
+      end
+
+      desc "install TARGET_DIR", "install SmartFox Server into TARGET_DIR"
+      def install(target_dir)
+        if File.exist?(target_dir)
+          abort "Directory #{target_dir} already exists!"
+        end
+
+        directory self.class.source_root, target_dir
+      end
+
+      desc "configure TARGET_DIR TEMPLATE_DIR", "configures SmartFox Server in TARGET_DIR via TEMPLATE_DIR"
+      def configure(target_dir, template_dir)
+        template_dir = File.expand_path(template_dir, Dir.pwd)
+        target_dir = File.expand_path(target_dir, Dir.pwd)
+
+        Dir["#{template_dir}/**/*"].each do |file|
+          if File.file?(file)
+            part = file.partition(template_dir).last
+            target_file = "#{target_dir}/#{part}"
+            binary = MIME::Types.type_for(file).any?(&:binary?)
+            if binary
+              copy_file file, target_file
+            else
+              template file, target_file
+            end
+          end
+        end
+      end
+      map "config" => :configure
+
+      desc "start TARGET_DIR", "start SmartFox Server in TARGET_DIR"
+      def start(target_dir)
+        inside(target_dir) do
+          system "sh ./sfs2x.sh"
+        end
+      end
+
+      no_tasks do
+        def env
+          @env ||= Environment.new(ENV)
+        end
+      end
+    end
+  end
+end

data/lib/rubyfox/server/data/config/ascii/boot.txt

@@ -0,0 +1,5 @@
+
+ _____ _____ _____    ___ __ __    _____ _____ _____ _____ 
+|   __|   __|   __|  |_  |  |  |  | __  |     |     |_   _|
+|__   |   __|__   |  |  _|-   -|  | __ -|  |  |  |  | | |  
+|_____|__|  |_____|  |___|__|__|  |_____|_____|_____| |_|

data/lib/rubyfox/server/data/config/ascii/ready.txt

@@ -0,0 +1,9 @@
+ 
+ _____ _____ _____    ___ __ __ 
+|   __|   __|   __|  |_  |  |  |
+|__   |   __|__   |  |  _|-   -|
+|_____|__|  |_____|  |___|__|__|                                         
+ _____ _____ _____ ____  __ __ 
+| __  |   __|  _  |    \|  |  |
+|    -|   __|     |  |  |_   _|
+|__|__|_____|__|__|____/  |_|  

data/lib/rubyfox/server/data/config/core.xml

@@ -0,0 +1,44 @@
+<!--
+	SmartFoxServer 2X 
+	<<< Core Configuration >>>
+	
+	(c) gotoAndPlay 2009-2012
+	www.smartfoxserver.com
+-->
+
+<coreSettings>
+	<systemControllerClass>com.smartfoxserver.v2.controllers.SystemController</systemControllerClass>
+	<extensionControllerClass>com.smartfoxserver.v2.controllers.ExtensionController</extensionControllerClass>
+	<ioHandlerClass>com.smartfoxserver.v2.protocol.DefaultIoHandler</ioHandlerClass>
+	<sessionManagerClass>it.gotoandplay.alt.AltSessionManager</sessionManagerClass>
+	<packetQueuePolicyClass>it.test.PacketQueueClass</packetQueuePolicyClass>
+	<readBufferType>Heap</readBufferType>
+	<writeBufferType>Heap</writeBufferType>
+	
+	<!-- Editable settings -->
+	
+	<!-- Max size of incoming packet -->
+	<maxIncomingRequestSize>8000000</maxIncomingRequestSize>
+	
+	<!-- Max Size for read buffer -->
+	<maxReadBufferSize>1024</maxReadBufferSize>
+	
+	<!-- Max Size for write buffer -->
+	<maxWriteBufferSize>32768</maxWriteBufferSize>
+	
+	<!-- Session Queue Size -->
+	<sessionPacketQueueSize>160</sessionPacketQueueSize>
+	
+	<!-- Thread Pool Size of the 3 main stages of the Bitswarm Engine -->
+	<socketAcceptorThreadPoolSize>1</socketAcceptorThreadPoolSize>
+	<socketReaderThreadPoolSize>1</socketReaderThreadPoolSize>
+	<socketWriterThreadPoolSize>1</socketWriterThreadPoolSize>	
+	
+	<!-- Enable disable Nagle algorithm on sockets, true == disable -->
+	<tcpNoDelay>true</tcpNoDelay>
+	
+	<!-- BlueBox Settings -->
+	<bbMaxLogFiles>10</bbMaxLogFiles>
+	<bbMaxLogFileSize>5000000</bbMaxLogFileSize>
+	<bbDebugMode>false</bbDebugMode>
+</coreSettings>

data/lib/rubyfox/server/data/config/crossdomain.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0"?>
+<!DOCTYPE cross-domain-policy SYSTEM "/xml/dtds/cross-domain-policy.dtd">
+<cross-domain-policy>
+   <!-- This is a master-policy file. site-control can be all,none,master-only -->
+   <site-control permitted-cross-domain-policies="all"/>
+
+   <!-- Instead of setting to-ports="*", administrators can use ranges and commas -->
+   <!-- This will allow access to ports 123, 456, 457, and 458 -->
+   <allow-access-from domain="*" to-ports="9933" />
+</cross-domain-policy>

data/lib/rubyfox/server/data/config/descriptors/config_room.txt

@@ -0,0 +1,323 @@
+// SMARTFOXSERVER 2X ADMIN TOOL'S ZONE CONFIGURATOR MODULE
+// Room configuration settings descriptor file
+// 
+// The "category" attribute indicates in which tab on the interface (if a TabNavigator is used) the parameter will be displayed. If missing a default category is used.
+
+//-------------------------------------------
+// GENERAL SETTINGS
+//-------------------------------------------
+
+// ROOM NAME
+{
+	"name":"name",
+	"label":"Room name",
+	"tooltip":"The Room name",
+	"type":"TextInput",
+	"value":"{$BasicValue=roomSettings.name}",
+	"validator":"notNull"
+},
+
+// GROUP ID
+{
+	"name":"groupId",
+	"label":"Group ID",
+	"tooltip":"The Group to which the Room belongs; if left empty, the Room is assigned to the 'default' Group",
+	"type":"TextInput",
+	"value":"{$BasicValue=roomSettings.groupId}"
+},
+
+// PASSWORD
+{
+	"name":"password",
+	"label":"Password",
+	"tooltip":"The Room password (optional). If null or empty string the Room will be public",
+	"type":"TextInput",
+	"value":"{$BasicValue=roomSettings.password}"
+},
+
+// MAX USERS
+{
+	"name":"maxUsers",
+	"label":"Maximum # of users",
+	"tooltip":"The maximum number of users/players allowed in the Room",
+	"type":"NumericStepper",
+	"value":{$BasicValue=roomSettings.maxUsers},
+	"componentParams":
+	{
+		"minimum":1,
+		"maximum":2147483647
+	}
+},
+
+// MAX SPECTATORS
+{
+	"name":"maxSpectators",
+	"label":"Maximum # of spectators",
+	"tooltip":"The maximum number of spectators allowed in the Room",
+	"type":"NumericStepper",
+	"value":{$BasicValue=roomSettings.maxSpectators},
+	"componentParams":
+	{
+		"minimum":0,
+		"maximum":2147483647
+	}
+},
+
+// IS DYNAMIC
+{
+	"name":"isDynamic",
+	"label":"Is dynamic",
+	"tooltip":"Dynamic Rooms are removed automatically according the 'Auto-remove mode' setting",
+	"type":"CheckBox",
+	"value":{$BasicValue=roomSettings.isDynamic}
+},
+
+// IS GAME
+{
+	"name":"isGame",
+	"label":"Is game",
+	"tooltip":"Marks the Room as a Game Room",
+	"type":"CheckBox",
+	"value":{$BasicValue=roomSettings.isGame}
+},
+
+// IS HIDDEN
+{
+	"name":"isHidden",
+	"label":"Is hidden",
+	"tooltip":"This Room can be hidden from the view of the users",
+	"type":"CheckBox",
+	"value":{$BasicValue=roomSettings.isHidden}
+},
+
+// AUTO-REMOVE MODE
+
+{
+	"name":"autoRemoveMode",
+	"label":"Auto-remove mode",
+	"tooltip":"Declares the modality of dynamic Rooms removal; if the 'DEFAULT' setting is used, regular Rooms will be removed when empty and their creator is disconnected, while Game Rooms will be removed when empty",
+	"type":"ComboBox",
+	"value":"{$BasicValue=roomSettings.autoRemoveMode}",
+	"componentParams":
+	{
+		"dataProvider":"DEFAULT,WHEN_EMPTY,WHEN_EMPTY_AND_CREATOR_IS_GONE,NEVER_REMOVE"
+	}
+},
+
+// ACTIVATE BAD WORDS FILTER
+{
+	"name":"badWordsFilter.isActive",
+	"label":"Use bad words filter",
+	"tooltip":"Toggles on/off the words filter for public messages",
+	"type":"CheckBox",
+	"value":{$BasicValue=badWordsFilter.isActive}
+},
+
+//-------------------------------------------
+// PERMISSIONS AND EVENTS
+//-------------------------------------------
+
+// PERMISSIONS
+{
+	"name":"permissions.flags",
+	"label":"Permission flags",
+	"tooltip":"These flags indicate which operations are permitted in the Room",
+	"category":"Permissions and events",
+	"type":"DualList",
+	"value":"{$BasicValue=permissions.flags}",
+	"componentParams":
+	{
+		"selectableValues":"{$BasicValue=permissions.availableFlags}"
+	}
+},
+
+// MAX ROOM VARIABLES ALLOWED
+{
+	"name":"permissions.maxRoomVariablesAllowed",
+	"label":"Max # of Room Variables",
+	"tooltip":"The maximum number of Room Variables allowed in the Room",
+	"category":"Permissions and events",
+	"type":"NumericStepper",
+	"value":{$BasicValue=permissions.maxRoomVariablesAllowed},
+	"componentParams":
+	{
+		"minimum":0,
+		"maximum":2147483647
+	}
+},
+
+// EVENTS
+{
+	"name":"events",
+	"label":"Events",
+	"tooltip":"Specify which events can be fired by the Room",
+	"category":"Permissions and events",
+	"type":"DualList",
+	"value":"{$BasicValue=roomSettings.events}",
+	"componentParams":
+	{
+		"selectableValues":"{$BasicValue=roomSettings.availableEvents}"
+	}
+},
+
+//-------------------------------------------
+// ROOM VARIABLES
+//-------------------------------------------
+
+// ROOM VARIABLES
+{
+	"name":"roomVariables",
+	"label":"Room Variables",
+	"tooltip":"Customize the Room Variables",
+	"category":"Room Variables",
+	"type":"DataGrid",
+	"componentParams":
+	{
+		"height":200
+	},
+	"defaultListItem":
+	[
+		{
+			"name":"name",
+			"label":"Name",
+			"tooltip":"Name",
+			"type":"TextInput",
+			"value":"",
+			"validator":"notNull"
+		},
+		{
+			"name":"type",
+			"label":"Type",
+			"tooltip":"The variable data type",
+			"type":"ComboBox",
+			"value":"STRING",
+			"componentParams":
+			{
+				"dataProvider":"BOOL,INT,DOUBLE,STRING,OBJECT,ARRAY"
+			}
+		},
+		{
+			"name":"isPrivate",
+			"label":"Private",
+			"tooltip":"A private variable can be modified only by its owner",
+			"type":"CheckBox",
+			"value":false
+		},
+		{
+			"name":"isPersistent",
+			"label":"Persistent",
+			"tooltip":"A persistent variable will remain active in the Room even if the owner is not in that Room any more. It will be removed when the user disconnects",
+			"type":"CheckBox",
+			"value":false
+		},
+		{
+			"name":"isGlobal",
+			"label":"Global",
+			"tooltip":"A global variable will be broadcast not only to the users in the Room but also outside of it",
+			"type":"CheckBox",
+			"value":false
+		},
+		{
+			"name":"isHidden",
+			"label":"Hidden",
+			"tooltip":"An hidden variable will be server-side only and it is never transmitted to the client(s)",
+			"type":"CheckBox",
+			"value":false
+		},
+		{
+			"name":"value",
+			"label":"Value",
+			"tooltip":"Primitive value or JSON block",
+			"type":"TextInput",
+			"value":"",
+			"validator":"notNull"
+		}
+	],
+	"listValues":{$List=roomVariables, instance=roomSettings, fields=name;type;isPrivate;isPersistent;isGlobal;isHidden;value},
+	"clazz":"ZoneSettings$RoomVariableDefinition"
+},
+
+//-------------------------------------------
+// EXTENSION
+//-------------------------------------------
+
+// NAME
+{
+	"name":"extension.name",
+	"label":"Name",
+	"tooltip":"The name of the Extension to be plugged at Room level; if a new Extension is deployed on the server while editing the Zone settings, cancel and re-edit the zone to update this list",
+	"category":"Room Extension",
+	"type":"ComboBox",
+	"value":"{$BasicValue=extension.name}",
+	"trigger":true,
+	"triggerData":{$List=extClasses, instance=extensionsHelper, fields=name;type;classesString},
+	"componentParams":
+	{
+		"dataProvider":"{$ListToString=extNames, instance=extensionsHelper}"
+	}
+},
+
+// TYPE
+{
+	"name":"extension.type",
+	"label":"Type",
+	"tooltip":"If 'JAVA' is selected, all jar files contained in the Extension's folder are processed, provided their name ends with 'Extension.jar' (for example 'MyExtension.jar'); this is required to avoid receiving useless data on the Admin Tool (like the list of classes contained in library jar files)\n\n<b>NOTE</b>: 'PYTHON' Extension type can be useful for fast testing and prototyping, but it is NOT RECOMMENDED for production environments (due to performance limitations)",
+	"category":"Room Extension",
+	"type":"ComboBox",
+	"value":"{$BasicValue=extension.type}",
+	"trigger":true,
+	"componentParams":
+	{
+		"dataProvider":"JAVA,PYTHON"
+	}
+},
+
+// MAIN CLASS
+{
+	"name":"extension.file",
+	"label":"Main class",
+	"tooltip":"The fully qualified name of the main Extension class; this class must extend either SFSExtension or BaseSFSExtension classes",
+	"category":"Room Extension",
+	"type":"ComboBox",
+	"value":"{$BasicValue=extension.file}",
+	"componentParams":
+	{
+		"dataProvider":""
+	}
+},
+
+// USE NAMING CONVENTION
+{
+	"name":"extension.filterClass",
+	"label":"Use naming convention",
+	"tooltip":"Filter the 'Main class' box showing the classes with names ending with the word 'Extension' only (for example 'com.example.MyJavaExtension' or 'MyPythonExtension.py')\n\n<b>NOTE</b>: this setting is used to improve the Admin Tool usage only, so it doesn't affect the server configuration in any way",
+	"category":"Room Extension",
+	"type":"CheckBox",
+	"value":false,
+	"trigger":true,
+	"clientOnly":true
+},
+
+// PROPERTIES FILE
+{
+	"name":"extension.propertiesFile",
+	"label":"Properties file",
+	"tooltip":"The name of a properties file that will be loaded during the initialization of the Extension. By default a 'config.properties' file is load, if existing",
+	"category":"Room Extension",
+	"type":"TextInput",
+	"value":"{$BasicValue=extension.propertiesFile}"
+},
+
+// RELOAD MODE
+{
+	"name":"extension.reloadMode",
+	"label":"Reload mode",
+	"tooltip":"Determine which mode will be used for Extensions reloading. 'AUTO' is recommended for development/testing environments, 'MANUAL' or 'NONE' for production environments",
+	"category":"Room Extension",
+	"type":"ComboBox",
+	"value":"{$BasicValue=extension.reloadMode}",
+	"componentParams":
+	{
+		"dataProvider":"AUTO,MANUAL,NONE"
+	}
+}