telnetd 0.0.1.alpha.2 → 0.0.1.alpha.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d4e64bb72f46024a89922a2f71cf075542e6b615
+  data.tar.gz: be007072af40fc04d3fa06479ba86fedaea26735
+SHA512:
+  metadata.gz: 1fb9016bca31322aab61837721fdbb971ad94c1aad14702f0adb592ae6d554d2947beda7e356cd8c0159619cddfd7b7285a9c40ab3877809a6ee2afcbd33810f
+  data.tar.gz: a7d46ef8aa4a4507068cb868221e58938ebf12b35984cab79c015739f464816441fc53173e794970debbd85e16e670cd03e03b5a79ccd4390652072ebb0215e8

data/README.md

@@ -3,21 +3,34 @@ telnetd
 
 Simple ruby telnet server with build in commands.
 
+Commands available
+==================
+- Cat
+- Cd
+- Dir
+- Exit
+- Help
+- Pwd
+- Uptime
+- Touch
 
-
-
-Commands
-========
+Commands planned
+==================
 - Broadcast
-- Cat
 - Copy
 - Del
-- Exit
-- *Help
-- Pwd
+- Exec
+- Fileinfo
 - Mkdir
 - Move
 - Stats
-- Touch
-- *Uptime
-- Who
+- Who
+
+Known Issues
+============
+- (Solved) Cat cmd does not handle line breaks correct
+- (Solved) Commands with backspaces are not correct handled. Eg. "kat\b\b\bcat"
+
+Execute from Git
+============
+ruby -Ilib bin\telnetd

data/bin/telnetd

@@ -2,4 +2,6 @@
 
 require 'telnetd'
 
-Telnetd.run
+module Telnetd
+	Telnetd.run
+end

data/lib/telnetd.rb

@@ -1,5 +1,6 @@
 require 'telnetd/telnet_server'
 
+module Telnetd
 # telnetd console runner
 class Telnetd
 
@@ -13,5 +14,5 @@ class Telnetd
 		telnetd.stop
 		puts "Telnet server stopped."
 	end
-
 end
+end

data/lib/telnetd/client_context.rb

@@ -1,7 +1,9 @@
+require 'pathname'
+
+module Telnetd
 # Client context instance.
 # Used to handle all informations relevant for a connected client
 # A class instance is valid as long the associated client is conntected.
-
 class ClientContext
 
 	# Read the client connection start timestamp.
@@ -13,11 +15,42 @@ class ClientContext
 	# Create a new instance of the context
 	def initialize
 		@start_time = Time.now
-		@path = application_path
+		@path = Pathname.new(application_path)
+	end
+
+	# Used to list the folders of the current working directory
+	def list_folders
+		result = []
+		@path.each_child { |path|
+			result << path if File::directory?(path)
+		}
+		return result
+	end
+
+	# Used to list the files of the current working directory
+	def list_files
+		result = []
+		@path.each_child { |path|
+			result << path if File::file?(path)
+		}
+		return result
+	end
+
+	# Change the dirctory to the path of the argument
+	# ==== Argument
+	# *+arg+ The path argument. May contain '..' to navigate to the parent folder
+	# ==== Result
+	# * An error message if the requested path does not exists
+	def cd(arg)
+		newpath = @path.join(Pathname.new(arg))
+		return "Path does not exists." unless newpath.exist?
+		@path = newpath
 	end
 
 private
+	# Get the application startup path
 	def application_path
 		 return File.dirname(__FILE__)
 	end
+end
 end

data/lib/telnetd/cmd/cat_cmd.rb

@@ -0,0 +1,39 @@
+
+module Telnetd
+# Cat command implementation
+class CatCmd
+
+	# Handle the touch command.
+	# Create a new empty file with the given file name
+	# ==== Arguments
+	# *+client+ The client to handle the command for
+	# *+commandtime+ The command string content
+	def handle(client, command)
+		args = command.split(' ')
+		if(args.length == 2)
+		#	FileUtils.cd(client.context.path) do
+		#		FileUtils.touch(args[1])	
+		#	end
+			begin
+				file = File.new("#{client.context.path}/#{args[1]}", "r")
+				while (line = file.gets)
+					line = line.gsub("\n", "\r\n")
+					client.print("#{line}")
+				end
+				file.close
+
+		    	#client.println(File.read("#{client.context.path}/#{args[1]}"))
+			rescue => err
+				client.println(err)
+			end
+		else
+			client.println("Missing filename.")
+		end
+	end
+
+	# Describe the uptime command
+	def describe
+		"Print the content of the file to the client"
+	end
+end
+end

data/lib/telnetd/cmd/cd_cmd.rb

@@ -0,0 +1,33 @@
+
+module Telnetd
+# Handle the cd command with the one argument passed
+class CdCmd
+
+	# Handle the cd command. 
+	# Shows the folder and files of the present working directory.
+	# ==== Arguments
+	# *+client+ The client to handle the command for
+	# *+command+ The command string content
+	def handle(client, command)
+		args = command.split(' ')
+		if(args.length == 2)
+			client.println(cd(client.context, args[1]))
+		else
+			client.println("Missing the folder name argument.")
+		end
+	end
+
+	# Execute the cd command against the client context.
+	# ==== Argument
+	# *+context+ The client context to execute the cd command on.
+	# *+arg+ The argument with the requested path to be changed. 
+	def cd(context, arg)
+		context.cd(arg)
+	end
+
+	# Describe the dir command
+	def describe
+		"Change the working directory with the passed argument. Use '..' to navigate upwards."
+	end
+end
+end

data/lib/telnetd/cmd/dir_cmd.rb

@@ -0,0 +1,62 @@
+require 'pathname'
+
+module Telnetd
+# Dir command implementation
+class DirCmd
+
+	# Handle the dir command. 
+	# Shows the folder and files of the present working directory.
+	# ==== Arguments
+	# *+client+ The client to handle the command for
+	# *+command+ The command string content
+	def handle(client, command)
+		client.println(format(client.context))
+	end
+
+	# Describe the dir command
+	def describe
+		"Shows the folder and files of the present working directory."
+	end
+
+	# Format the content of the path as human readable string
+	# ==== Arguments
+	# *+context+ The client context to access the present working directory
+	def format(context)
+		return "#{header(context)}#{folders(context)}#{files(context)}"
+	end
+
+private
+
+	def header(context)
+		"Content of directory: #{context.path}" + 
+		"\r\n-------------------------------------------------------------------" +
+		"\r\n\t%-40s \t %-10s" % ["Name", "Size"] + 
+		"\r\n-------------------------------------------------------------------"
+	end
+
+	def folders(context)
+		result = ""
+		context.list_folders.each { |folder|
+			result +=  "\r\n\t%-40s  \t %-10s" % [Pathname.new(folder).basename, "<DIR>"]
+		}
+		return result
+	end
+
+	def files(context)
+		result = ""
+		context.list_files.each { |file|
+			result +=  "\r\n\t%-40s \t %-10s" % [File.basename(file), as_size(File.size(file))]
+		}
+		return result		
+	end
+
+	def as_size(s)
+  		units = %W(B KiB MiB GiB TiB)
+  		size, unit = units.reduce(s.to_f) do |(fsize, _), utype|
+    			fsize > 512 ? [fsize / 1024, utype] : (break [fsize, utype])
+  		end
+  		"#{size > 9 || size.modulo(1) < 0.1 ? '%d' : '%.1f'} %s" % [size, unit]
+	end
+
+end
+end

data/lib/telnetd/cmd/exit_cmd.rb

@@ -1,5 +1,6 @@
-# Exit command used to close a client connection
 
+module Telnetd
+# Exit command used to close a client connection
 class ExitCmd
 
 	# Handle the exit command by closing the client connection.
@@ -15,4 +16,5 @@ class ExitCmd
 	def describe
 		"Close the connetion to the server."
 	end
+end
 end

data/lib/telnetd/cmd/help_cmd.rb

@@ -1,5 +1,6 @@
-# Help command is used to display all available commands with a one line description
 
+module Telnetd
+# Help command is used to display all available commands with a one line description
 class HelpCmd
 
 	# Used to show all available commands to the client
@@ -10,12 +11,11 @@ class HelpCmd
 		client.command_registry.commands.each { |name,cmd| 
 			client.println("#{name} \t #{cmd.describe}") 
 		}
-		#client.println("#{client.command_registry}")
 	end
 
 	# Describe the help command
 	def describe
 		"Show the list of all available commands."
 	end
-
+end
 end

data/lib/telnetd/cmd/pwd_cmd.rb

@@ -1,5 +1,6 @@
-# Shows the present working directory to the client
 
+module Telnetd
+# Shows the present working directory to the client
 class PwdCmd
 
 	# Handle the uptime command. Shows the connection time span in seconds.
@@ -14,5 +15,5 @@ class PwdCmd
 	def describe
 		"Show the present working directory."
 	end
-
+end
 end

data/lib/telnetd/cmd/touch_cmd.rb

@@ -0,0 +1,29 @@
+require 'fileutils'
+
+module Telnetd
+#Touch command implementation
+class TouchCmd
+
+	# Handle the touch command.
+	# Create a new empty file with the given file name
+	# ==== Arguments
+	# *+client+ The client to handle the command for
+	# *+commandtime+ The command string content
+	def handle(client, command)
+		args = command.split(' ')
+		if(args.length == 2)
+			FileUtils.cd(client.context.path) do
+				FileUtils.touch(args[1])	
+			end
+		else
+			client.println("Missing filename.")
+		end
+	end
+
+	# Describe the uptime command
+	def describe
+		"Create a new file with the new name provided as argument."
+	end
+
+end
+end

data/lib/telnetd/cmd/unknown_cmd.rb

@@ -1,5 +1,6 @@
-# Handle an unknown command
 
+module Telnetd
+# Handle an unknown command
 class UnknownCmd
 
 	# Handle an unknown command by echo the provided command with a string that
@@ -9,8 +10,8 @@ class UnknownCmd
 	# *+client+ The client to handle the command for
 	# *+command+ The command string content
 	def handle(client, command)
-		client.println("Unknown command \"#{command}\"")
+		client.println("Unknown command \"#{command.dump}\"")
 		client.println("Type \"help\" for a full list of available commands.")
 	end
-
+end
 end

data/lib/telnetd/cmd/uptime_cmd.rb

@@ -1,3 +1,5 @@
+
+module Telnetd
 # Uptime command to show the client connection time
 class UptimeCmd
 
@@ -6,12 +8,16 @@ class UptimeCmd
 	# *+client+ The client to handle the command for
 	# *+commandtime+ The command string content
 	def handle(client, command)
-		seconds = Time.now - client.context.start_time;
-		client.println("#{ seconds.to_i } seconds connected")
+		time = (Time.now - client.context.start_time).to_i;
+		hours = time/3600.to_i
+		minutes = (time/60 - hours * 60).to_i
+		seconds = (time - (minutes * 60 + hours * 3600))
+		client.println("Client connected since %02d:%02d:%02d [hh:mm:ss]" % [hours, minutes, seconds])
 	end
 
 	# Describe the uptime command
 	def describe
 		"Show the client connection uptime."
 	end
+end
 end

data/lib/telnetd/command_registry.rb

@@ -3,7 +3,12 @@ require 'telnetd/cmd/exit_cmd'
 require 'telnetd/cmd/help_cmd'
 require 'telnetd/cmd/uptime_cmd'
 require 'telnetd/cmd/pwd_cmd'
+require 'telnetd/cmd/dir_cmd'
+require 'telnetd/cmd/cd_cmd'
+require 'telnetd/cmd/touch_cmd'
+require 'telnetd/cmd/cat_cmd'
 
+module Telnetd
 # Command Registry used to collect and manage the build in commands
 # for the telnetd
 class CommandRegistry
@@ -14,10 +19,14 @@ class CommandRegistry
 	# Create a new instance of the command registry.
 	def initialize
 		@commands = { 
+			"cat" => CatCmd.new,
 			"exit" => ExitCmd.new,
 			"help" => HelpCmd.new,
 			"uptime" => UptimeCmd.new,
-			"pwd" => PwdCmd.new
+			"pwd" => PwdCmd.new,
+			"dir" => DirCmd.new,
+			"cd" => CdCmd.new,
+			"touch" => TouchCmd.new
 		}
 	end
 
@@ -27,17 +36,30 @@ class CommandRegistry
 	# *+client+ The client to execute the command for
 	# *+command+ The command to be executed
 	def handle(client, command)
-		command.strip!
-		if @commands.has_key? command
-			@commands[command].handle(client, command)
+		command = strip_cmd(command)
+		cmd = command.split(' ')[0]
+		if @commands.has_key? cmd
+			@commands[cmd].handle(client, command)
 		else
-			handle_unknown_command(client, command)
+			handle_unknown_command(client, cmd)
 		end
 	end
 
 private
+	def strip_cmd(command)
+		result = ""
+		command.each_char { |c|
+			if c.eql?("\b")
+				result.chop!
+			else
+				result += c
+			end
+		}
+		return result
+	end
+
 	def handle_unknown_command(client, command)
 		UnknownCmd.new.handle(client, command)
 	end
-
-end
+end
+end

data/lib/telnetd/telnet_client.rb

@@ -1,6 +1,7 @@
 require 'telnetd/command_registry'
 require 'telnetd/client_context'
 
+module Telnetd
 # Represent a telnet client. 
 # This class is used to be executed in a single thread
 class TelnetClient
@@ -30,11 +31,9 @@ class TelnetClient
 		promt()
 		while line = @client.gets
 			process_cmd(line)
-
 			if @client.closed?
 				return
 			end
-
   			promt()
 		end
 	end
@@ -60,8 +59,8 @@ class TelnetClient
 	end
 
 private
-
 	def process_cmd(cmd)
+		cmd.strip!
 		@command_registry.handle(self, cmd)
 	end
 
@@ -74,5 +73,5 @@ private
 		println("===================")
 		println("Type 'help' to get a list of all commands or 'exit' to end the session.")
 	end
-
+end
 end

data/lib/telnetd/telnet_server.rb

@@ -1,6 +1,7 @@
 require 'socket'
 require 'telnetd/telnet_client'
 
+module Telnetd
 # The Telnet daemon main class. Create a new thread for each client
 class TelnetServer
 
@@ -26,7 +27,9 @@ class TelnetServer
 	  					handleNewClient(client) 
 	  				end
 	  			rescue Exception => e 
-					puts "Client Error: #{e.message}" 
+					puts "Client Error: #{e.message}"
+					puts e.inspect
+					puts e.backtrace
 				end
 			}
 			rescue Interrupt => e
@@ -63,8 +66,10 @@ private
 		begin
 			client.handle()
   		rescue Exception => e 
-			puts "Client Error: #{e.message}" 
+			puts "Client Error: #{e.message}"
+			puts e.inspect
+			puts e.backtrace 
 		end			
 	end
-
-end
+end
+end

data/telnetd.gemspec

@@ -2,7 +2,7 @@ require 'rake'
 
 Gem::Specification.new do |spec|
   spec.name        = 'telnetd'
-  spec.version     = '0.0.1.alpha.2'
+  spec.version     = '0.0.1.alpha.3'
   spec.date        = '2013-04-04'
   spec.summary     = "Simple telnet daemon"
   spec.description = "Simple telnet daemon to be used from the command line or as embedded service."

data/test/test_client_context.rb

@@ -0,0 +1,28 @@
+
+require 'test/unit'
+require 'telnetd/client_context'
+
+module Telnetd
+# Tests for the client context
+class TestClientContext < Test::Unit::TestCase
+
+	# Test if the start time is set in the past.
+	def test_start_time
+		context = ClientContext.new
+		sleep(1)
+		assert(context.start_time < Time.now, "Expect start time before now.")
+	end
+
+	# Test list the available folders.
+	def test_list_folders
+		context = ClientContext.new
+		assert(context.list_folders.empty? == false)
+	end
+
+	# Test list the available files.
+	def test_list_files
+		context = ClientContext.new
+		assert(context.list_files.empty? == false)
+	end
+end
+end

data/test/test_command_registry.rb

@@ -0,0 +1,19 @@
+require 'test/unit'
+require 'telnetd/command_registry'
+
+module Telnetd
+# Tests for the Command Registry
+class TestCommandRegistry < Test::Unit::TestCase
+	
+	#Test the strip of the command
+	def test_strip_cmd
+		cr = CommandRegistry.new
+		assert_equal("abc", cr.send("strip_cmd", "abc  "))
+	end
+
+	def test_strip_backspace
+		cr = CommandRegistry.new
+		assert_equal("cat", cr.send("strip_cmd", "kat\b\b\bcat"))
+	end
+end
+end

data/test/test_dir_cmd.rb

@@ -0,0 +1,19 @@
+
+require 'test/unit'
+require 'telnetd/client_context'
+require 'telnetd/cmd/dir_cmd'
+
+module Telnetd
+# Tests for the dir command
+class TestDirCmd < Test::Unit::TestCase
+
+	# Test if the dir listing contains expected folder and files.
+	def test_dir_listing
+		dir = DirCmd.new
+		assert(dir.format(ClientContext.new).include?("cmd"))
+		assert(dir.format(ClientContext.new).include?("telnet_client.rb"))
+		assert(dir.format(ClientContext.new).include?("telnet_server.rb"))
+	end
+
+end
+end

data/test/test_telnet_server.rb

@@ -2,6 +2,7 @@ require 'test/unit'
 require 'socket'
 require 'telnetd/telnet_server'
 
+module Telnetd
 # Tests used for the telnet server
 class TelnetServerTest < Test::Unit::TestCase
 
@@ -41,4 +42,5 @@ private
 		sleep(0.1)
 	end
 
-end
+end
+end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: telnetd
 version: !ruby/object:Gem::Version
-  version: 0.0.1.alpha.2
-  prerelease: 6
+  version: 0.0.1.alpha.3
 platform: ruby
 authors:
 - Promotos
@@ -19,45 +18,51 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/telnetd.rb
 - lib/telnetd/client_context.rb
+- lib/telnetd/cmd/cat_cmd.rb
+- lib/telnetd/cmd/cd_cmd.rb
+- lib/telnetd/cmd/dir_cmd.rb
 - lib/telnetd/cmd/exit_cmd.rb
 - lib/telnetd/cmd/help_cmd.rb
 - lib/telnetd/cmd/pwd_cmd.rb
+- lib/telnetd/cmd/touch_cmd.rb
 - lib/telnetd/cmd/unknown_cmd.rb
 - lib/telnetd/cmd/uptime_cmd.rb
 - lib/telnetd/command_registry.rb
 - lib/telnetd/telnet_client.rb
 - lib/telnetd/telnet_server.rb
-- lib/telnetd.rb
 - bin/telnetd
-- make_rdoc.bat
-- Rakefile
 - README.md
-- telnetd-0.0.1.alpha.1.gem
+- Rakefile
+- make_rdoc.bat
+- telnetd-0.0.1.alpha.2.gem
 - telnetd.gemspec
+- test/test_client_context.rb
+- test/test_command_registry.rb
+- test/test_dir_cmd.rb
 - test/test_telnet_server.rb
 homepage: http://rubygems.org/gems/telnetd
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>'
+  - - '>'
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.14
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Simple telnet daemon
 test_files: []