rubyfox-server 2.13.6.2 → 2.16.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cef7ed9af750db4e2844d20697ce54a66a90d55140ba496788493312785eb6f9
-  data.tar.gz: 84aa2d598d65dfe8e6edcfb35825cc649fa0f271acdf090166130ad50f848b7e
+  metadata.gz: 168c821e6ab397f3e4cd254155eaf57aea11eab72e53c1e8a2ee8d7628f772ca
+  data.tar.gz: fdcf6ce3e8dd917316ae68371f7c68e92c61b6d1dbba6413aee57952957485a9
 SHA512:
-  metadata.gz: 37943b3c4460e1b858ba0cbe562c43d082fde3ef98cbe1e5cf2762df5f4dab6e80d417409ab1858ecc9a65b64afb8cafda17274c276f7f43fe125c3e18eb532e
-  data.tar.gz: 693a4710ad1dbbebca69832e5f5490001734050989a1b8bdaa4940595add29fa64e02f10478c5e73d9a451c9278aa35dc6a7c2a56ab2811d8d6f580bb301fdc6
+  metadata.gz: e75b9b3288c50e515d6a0f288d876865f4a4bc11479f20cde87bb6aa70165b18d508c808401b5427b2e1f78eddaba098c84e0d64eb9551d865fe2f05fad9f20b
+  data.tar.gz: d795286ce956f92a3172b2acae439d17a44c24ea6d30825f1889eb15a8912e8194d9860864b29321ccd5aa7874275b09ec1ce5516c97042dde2ce4bea6a784b7

data/.travis.yml

@@ -1,3 +1,4 @@
 rvm:
-  - 2.3.1
+  - 2.7.1
+  - 2.6.6
   - ruby-head

data/README.md

@@ -19,6 +19,7 @@ See http://www.smartfoxserver.com
     smartfox configure /path/to/smartfox /path/to/template/dir
 
     smartfox start /path/to/smartfox
+    
 
 ## Help
 
@@ -35,6 +36,24 @@ The version of this gem is tied to the real version of SmartFox Server.
 
 Example: Gem version 2.3.0.x contains SmartFox Server version 2.3.0.
 
+## Version check
+
+To enable gem version verification, add a version file to your template folder.
+
+Example: `.../version`
+```
+2.16.0
+```
+
+If the version is not satisfied, the following output is printed:
+```
+Configuration failed!
+
+Your rubyfox-server version: 2.15.0.0
+Needed version: ~>2.16.0
+```
+
+
 ## Contributing
 
 1. Fork it

data/lib/rubyfox/server/cli.rb

@@ -1,9 +1,9 @@
-require 'thor'
-require 'mime/types'
+require "thor"
+require "mime/types"
 
-require 'rubyfox/server'
-require 'rubyfox/server/version'
-require 'rubyfox/server/environment'
+require "rubyfox/server"
+require "rubyfox/server/version"
+require "rubyfox/server/environment"
 
 module Rubyfox
   module Server
@@ -15,6 +15,7 @@ module Rubyfox
       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!"
@@ -24,10 +25,13 @@ module Rubyfox
       end
 
       desc "configure TARGET_DIR TEMPLATE_DIR", "Configure 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)
 
+        verify_version(template_dir)
+
         Dir["#{template_dir}/**/*"].each do |file|
           if File.file?(file)
             part = file.partition(template_dir).last
@@ -39,10 +43,14 @@ module Rubyfox
             end
           end
         end
+      rescue WrongVersionError => e
+        STDERR.puts e.message
       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"
@@ -50,6 +58,7 @@ module Rubyfox
       end
 
       desc "version", "Display version of this command"
+
       def version
         puts Rubyfox::Server::VERSION
       end
@@ -66,6 +75,31 @@ module Rubyfox
         types = MIME::Types.type_for(file)
         types.empty? || types.any? { |type| type.media_type == "text" }
       end
+
+      def verify_version(template_dir)
+        filename = "#{template_dir}/version"
+        if File.exist?(filename)
+          expected_version = File.read(filename)
+          version = Rubyfox::Server::VERSION
+
+          unless satisfied_version?(expected_version, version)
+            msg = query = <<~MSG.chomp
+              Configuration failed!
+
+              Your rubyfox-server version: #{version}
+              Needed version: ~>#{expected_version}
+            MSG
+            raise WrongVersionError.new(msg)
+          end
+        end
+      end
+
+      def satisfied_version?(expected_version, version)
+        requirement = Gem::Requirement.new("~> #{expected_version}")
+        requirement.satisfied_by?(Gem::Version.create(version))
+      end
+
+      class WrongVersionError < RuntimeError; end
     end
   end
 end

data/lib/rubyfox/server/data/config/UploadsLock.txt

@@ -1,3 +1,3 @@
-This file prevents uploads using the Administration Tool's modules that allow it (i.e. Extension Manager).
+This file prevents uploads using the Administration Tool's modules that allow it (e.g. Extension Manager).
 This is an additional security measure. Delete this file to enable file uploads in all modules.
 For more information, please visit this URL: http://docs2x.smartfoxserver.com/GettingStarted/admintool-ExtensionManager

data/lib/rubyfox/server/data/config/admin/admintool.xml

@@ -19,6 +19,7 @@
 		<module id="ExtensionManager" name="Extension Manager" description="Upload Extension files to the SmartFoxServer instance"/>
 		<module id="ServletManager" name="Servlet Manager" description="Upload servlets to SmartFoxServer instance's web server"/>
 		<module id="LicenseManager" name="License Manager" description="Configure the license of the SmartFoxServer instance"/>
+		<!-- <module id="CustomTool" name="Custom Tool" description="This is a test custom module" className="my.namespace.CustomToolReqHandler"/> -->
 	</modules>
 	
 </admintool>

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

@@ -33,9 +33,13 @@
 	"tooltip":"The Room password (optional). If null or empty string the Room will be public",
 	"type":"TextInput",
 	"value":"{$BasicValue=roomSettings.password}",
-	"componentParams":
+	"componentParams": // DEPRECATED
 	{
 		"displayAsPassword":true
+	},
+	"attributes":
+	{
+		"type":"password"
 	}
 },
 
@@ -46,7 +50,12 @@
 	"tooltip":"The maximum number of users/players allowed in the Room",
 	"type":"NumericStepper",
 	"value":{$BasicValue=roomSettings.maxUsers},
-	"componentParams":
+	"componentParams": // DEPRECATED
+	{
+		"minimum":1,
+		"maximum":2147483647
+	},
+	"attributes":
 	{
 		"minimum":1,
 		"maximum":2147483647
@@ -60,7 +69,12 @@
 	"tooltip":"The maximum number of spectators allowed in the Room",
 	"type":"NumericStepper",
 	"value":{$BasicValue=roomSettings.maxSpectators},
-	"componentParams":
+	"componentParams": // DEPRECATED
+	{
+		"minimum":0,
+		"maximum":2147483647
+	},
+	"attributes":
 	{
 		"minimum":0,
 		"maximum":2147483647
@@ -102,10 +116,11 @@
 	"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":
+	"componentParams": // DEPRECATED
 	{
 		"dataProvider":"DEFAULT,WHEN_EMPTY,WHEN_EMPTY_AND_CREATOR_IS_GONE,NEVER_REMOVE"
-	}
+	},
+	"dataProvider":"DEFAULT,WHEN_EMPTY,WHEN_EMPTY_AND_CREATOR_IS_GONE,NEVER_REMOVE"
 },
 
 // ACTIVATE BAD WORDS FILTER
@@ -135,13 +150,14 @@
 	"name":"permissions.flags",
 	"label":"Permission flags",
 	"tooltip":"These flags indicate which operations are permitted in the Room",
-	"category":"Permissions and events",
+	"category":"Permissions & Events",
 	"type":"DualList",
 	"value":"{$BasicValue=permissions.flags}",
-	"componentParams":
+	"componentParams": // DEPRECATED
 	{
 		"selectableValues":"{$BasicValue=permissions.availableFlags}"
-	}
+	},
+	"dataProvider":"{$BasicValue=permissions.availableFlags}"
 },
 
 // MAX ROOM VARIABLES ALLOWED
@@ -149,10 +165,15 @@
 	"name":"permissions.maxRoomVariablesAllowed",
 	"label":"Max # of Room Variables",
 	"tooltip":"The maximum number of Room Variables allowed in the Room",
-	"category":"Permissions and events",
+	"category":"Permissions & Events",
 	"type":"NumericStepper",
 	"value":{$BasicValue=permissions.maxRoomVariablesAllowed},
-	"componentParams":
+	"componentParams": // DEPRECATED
+	{
+		"minimum":0,
+		"maximum":2147483647
+	},
+	"attributes":
 	{
 		"minimum":0,
 		"maximum":2147483647
@@ -164,13 +185,14 @@
 	"name":"events",
 	"label":"Events",
 	"tooltip":"Specify which events can be fired by the Room",
-	"category":"Permissions and events",
+	"category":"Permissions & Events",
 	"type":"DualList",
 	"value":"{$BasicValue=roomSettings.events}",
-	"componentParams":
+	"componentParams": // DEPRECATED
 	{
 		"selectableValues":"{$BasicValue=roomSettings.availableEvents}"
-	}
+	},
+	"dataProvider":"{$BasicValue=roomSettings.availableEvents}"
 },
 
 //-------------------------------------------
@@ -184,7 +206,7 @@
 	"tooltip":"Customize the Room Variables",
 	"category":"Room Variables",
 	"type":"DataGrid",
-	"componentParams":
+	"componentParams": // DEPRECATED
 	{
 		"height":200
 	},
@@ -204,10 +226,19 @@
 			"tooltip":"The variable data type",
 			"type":"ComboBox",
 			"value":"STRING",
-			"componentParams":
+			"componentParams": // DEPRECATED
 			{
 				"dataProvider":"BOOL,INT,DOUBLE,STRING,OBJECT,ARRAY"
-			}
+			},
+			"dataProvider":"BOOL,INT,DOUBLE,STRING,OBJECT,ARRAY"
+		},
+		{
+			"name":"value",
+			"label":"Value",
+			"tooltip":"Primitive value or JSON block",
+			"type":"TextInput",
+			"value":"",
+			"validator":"notNull"
 		},
 		{
 			"name":"isPrivate",
@@ -238,15 +269,14 @@
 			"value":false
 		},
 		{
-			"name":"value",
-			"label":"Value",
-			"tooltip":"Primitive value or JSON block",
-			"type":"TextInput",
-			"value":"",
-			"validator":"notNull"
+			"name":"isStorable",
+			"label":"Storable",
+			"tooltip":"A storable variable will be saved by the active Room persistence system, if any",
+			"type":"CheckBox",
+			"value":true
 		}
 	],
-	"listValues":{$List=roomVariables, instance=roomSettings, fields=name;type;isPrivate;isPersistent;isGlobal;isHidden;value},
+	"listValues":{$List=roomVariables, instance=roomSettings, fields=name;type;value;isPrivate;isPersistent;isGlobal;isHidden;isStorable},
 	"clazz":"ZoneSettings$RoomVariableDefinition"
 },
 
@@ -264,10 +294,11 @@
 	"value":"{$BasicValue=extension.name}",
 	"trigger":true,
 	"triggerData":{$List=extClasses, instance=extensionsHelper, fields=name;type;classesString},
-	"componentParams":
+	"componentParams": // DEPRECATED
 	{
 		"dataProvider":"{$ListToString=extNames, instance=extensionsHelper}"
-	}
+	},
+	"dataProvider":"{$ListToString=extNames, instance=extensionsHelper}"
 },
 
 // TYPE
@@ -279,10 +310,11 @@
 	"type":"ComboBox",
 	"value":"{$BasicValue=extension.type}",
 	"trigger":true,
-	"componentParams":
+	"componentParams": // DEPRECATED
 	{
 		"dataProvider":"JAVA,JAVASCRIPT,PYTHON"
-	}
+	},
+	"dataProvider":"JAVA,JAVASCRIPT,PYTHON"
 },
 
 // MAIN CLASS
@@ -293,10 +325,11 @@
 	"category":"Room Extension",
 	"type":"ComboBox",
 	"value":"{$BasicValue=extension.file}",
-	"componentParams":
+	"componentParams": // DEPRECATED
 	{
 		"dataProvider":""
-	}
+	},
+	"dataProvider":""
 },
 
 // USE NAMING CONVENTION
@@ -329,10 +362,11 @@
 	"category":"Room Extension",
 	"type":"ComboBox",
 	"value":"{$BasicValue=extension.reloadMode}",
-	"componentParams":
+	"componentParams": // DEPRECATED
 	{
 		"dataProvider":"AUTO,MANUAL,NONE"
-	}
+	},
+	"dataProvider":"AUTO,MANUAL,NONE"
 },
 
 //-------------------------------------------
@@ -344,7 +378,7 @@
 	"name":"mmoSettings.isActive",
 	"label":"Is MMO Room",
 	"tooltip":"Create a Room of type MMORoom, in which joined users are mutually 'visible' based on each other's proximity. Read the documentation for more informations\n\n<b>IMPORTANT</b>\nThe following Room characteristics do not apply to MMORooms:\n<i>Spectators</i> - even if the Room is a Game Room, users can't join it as spectators\n<i>USER_ENTER event</i> - this event is never dispatched; other users entering the current user's Area of Interest (AoI) are notified through the PROXIMITY_LIST_UPDATE event\n<i>USER_EXIT event</i> - this event is dispatched to the user leaving the Room only; other users leaving the current user's Area of Interest are notified through the PROXIMITY_LIST_UPDATE event",
-	"category":"MMO settings",
+	"category":"MMO Settings",
 	"type":"CheckBox",
 	"value":{$BasicValue=mmoSettings.isActive}
 },
@@ -354,7 +388,7 @@
 	"name":"mmoSettings.defaultAOI",
 	"label":"Default AoI",
 	"tooltip":"The distance along the x,y,z axes describing the 'Area of Interest' within which the other users presence in the Room is notified to each client through the PROXIMITY_LIST_UPDATE event. Similarly, users actions (public messages, User Variables updates, etc) are notified when they are within this area only\n\n<b>NOTE</b>\nA value of 100 for an axis means an AoI ranging from -100 to +100 along that axis",
-	"category":"MMO settings",
+	"category":"MMO Settings",
 	"type":"Vector3D",
 	"value":"{$BasicValue=mmoSettings.defaultAOI}",
 	"validator":"aoi"
@@ -365,10 +399,15 @@
 	"name":"mmoSettings.lowerMapLimit",
 	"label":"Lower map limits",
 	"tooltip":"The lower limits for each of the user position coordinates (x,y,z) in the MMORoom. Limits are used to validate the request to set the user position coming from the client. Leave empty for no limits\n\n<b>NOTE</b>\nLower and higher map limits must be both set or not set; if only one of the two properties is set, it will be ignored",
-	"category":"MMO settings",
+	"category":"MMO Settings",
 	"type":"Vector3D",
 	"value":"{$BasicValue=mmoSettings.lowerMapLimit}",
-	"componentParams":
+	"componentParams": // DEPRECATED
+	{
+		"enableClear":true,
+		"allowNegative":true
+	},
+	"attributes":
 	{
 		"enableClear":true,
 		"allowNegative":true
@@ -380,10 +419,15 @@
 	"name":"mmoSettings.higherMapLimit",
 	"label":"Higher map limits",
 	"tooltip":"The upper limits for each of the user position coordinates (x,y,z) in the MMORoom. Limits are used to validate the request to set the user position coming from the client. Leave empty for no limits\n\n<b>NOTE</b>\nLower and higher map limits must be both set or not set; if only one of the two properties is set, it will be ignored",
-	"category":"MMO settings",
+	"category":"MMO Settings",
 	"type":"Vector3D",
 	"value":"{$BasicValue=mmoSettings.higherMapLimit}",
-	"componentParams":
+	"componentParams": // DEPRECATED
+	{
+		"enableClear":true,
+		"allowNegative":true
+	},
+	"attributes":
 	{
 		"enableClear":true,
 		"allowNegative":true
@@ -395,7 +439,7 @@
 	"name":"mmoSettings.forceFloats",
 	"label":"Force floating point",
 	"tooltip":"Force the values entered in the AoI and map limits settings above to be parsed as floating point values, even if integers have been entered. Please note that even if this setting is off, if a decimal value is entered above, it will be treated as a floating point value",
-	"category":"MMO settings",
+	"category":"MMO Settings",
 	"type":"CheckBox",
 	"value":{$BasicValue=mmoSettings.forceFloats}
 },
@@ -405,13 +449,18 @@
 	"name":"mmoSettings.userMaxLimboSeconds",
 	"label":"User max limbo time",
 	"tooltip":"The maximum amount of seconds allowed between the MMORoom join and the first time the user position is set in the Room (known as 'limbo', because the user is inside the Room but he knows nothing about the other users in it, because the proximity system based on the AoI requires his position to be set at least one time); if this time is exeeded, the user is kicked from the Room automatically",
-	"category":"MMO settings",
+	"category":"MMO Settings",
 	"type":"NumericStepper",
 	"value":{$BasicValue=mmoSettings.userMaxLimboSeconds},
-	"componentParams":
+	"componentParams": // DEPRECATED
 	{
 		"minimum":10,
 		"maximum":120
+	},
+	"attributes":
+	{
+		"min":10,
+		"max":120
 	}
 },
 
@@ -420,13 +469,18 @@
 	"name":"mmoSettings.proximityListUpdateMillis",
 	"label":"Millis between proximity list updates",
 	"tooltip":"Minimum time between two subsequent PROXIMITY_LIST_UPDATE events sent to the clients; this should be balanced taking into account the user speed when moving inside the MMORoom (frequency of position updates) and the ratio between the actual client viewport size (or area of visibility in case of 3D environments) and the AoI size",
-	"category":"MMO settings",
+	"category":"MMO Settings",
 	"type":"NumericStepper",
 	"value":{$BasicValue=mmoSettings.proximityListUpdateMillis},
-	"componentParams":
+	"componentParams": // DEPRECATED
 	{
 		"minimum":10,
 		"maximum":2147483647
+	},
+	"attributes":
+	{
+		"min":10,
+		"max":2147483647
 	}
 },
 
@@ -435,7 +489,7 @@
 	"name":"mmoSettings.sendAOIEntryPoint",
 	"label":"Send AoI entry point",
 	"tooltip":"Send the other users entry coordinates in the client's AoI as reserved properties on the User object in the PROXIMITY_LIST_UPDATE event",
-	"category":"MMO settings",
+	"category":"MMO Settings",
 	"type":"CheckBox",
 	"value":{$BasicValue=mmoSettings.sendAOIEntryPoint}
 }