simple-transfer 0.0.1 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f69f3c96aad7319e99191e7e4cc291a9b75a8997aeec61c8acd6fac55e230322
-  data.tar.gz: 9ab1d2e0b548b65e6f09d677f0295ab16b87d5dab71be58c7d2faa516c1ec92c
+  metadata.gz: 83a010fdd44ee8da6b309e8b61d757d79e17979e6e6cd25fe28e639f9f57e483
+  data.tar.gz: d6b07967f13aad9e4ef32616d3308d99f624df9c1be1050a9fbcaed29f981f7d
 SHA512:
-  metadata.gz: 62867c898cad672b01ee0f35d976d770246a7e44725cf37fdab3db79d6a0a97d476363a3b300c7dfccb3969ba67f7ad8b62181eaf9d010eae8f978770c1d5989
-  data.tar.gz: 5b7b9a30ff2d42f10b8507157892f0677fadf20d1143ef27a9a3668dda004492821e092aba78f433faa19a6b8a18c30b83d62cbffb5906fd7841260a1a9755cb
+  metadata.gz: 7b13491d37fbc3ff29ad6eed31ff4f7c275ce85cfd837ac463e951fe530f065b1952a359e68329b0e07569416aee72592bc7332000adf15a6a7665df9bb42f1f
+  data.tar.gz: 023dbde679d7dbd4883391fff0641db0be52ab8eb53b84bea18744691751cf55ef66ce5580885b7891147d451358457e5de455d5e51ab530bf9c0c38d174886c

data/bin/simple-transfer

@@ -0,0 +1,83 @@
+#! /usr/bin/env ruby  
+
+require_relative "../lib/transfer.rb"
+require_relative "../lib/repl.rb"
+
+include SimpleTransfer
+
+$valid_server_commands = ["--server", "-s", "server", "--serve"]
+$valid_client_commands = ["--client", "-c", "client", "--cli"]
+
+def numeric?(str)
+    true if Float(str) rescue false
+end
+
+def is_valid_command(command)
+  if $valid_server_commands.include?(command)
+    return "server"
+  elsif $valid_client_commands.include?(command)
+    return "client"
+  end
+  return nil
+end
+
+def init_server(port)
+  myserver = Server.new(port)
+  myserver.start()
+end
+
+def init_client(server_addr, server_port)
+  myshell = STShell.new(server_addr, server_port)
+  myshell.init_loop()
+end
+
+
+def check_mode(mode)
+    if mode.nil?
+        puts "Please provide a mode, friend; >:3\
+            --server <port> or --client <server_addr> <server_port>"
+        return false
+    elsif not is_valid_command(mode)
+        puts "#{mode} is not a valid mode, friend; >:3\
+            --server <port> or --client <server_addr> <server_port>"
+        return false
+    end
+    return true
+end
+
+def check_port(port)
+    if port.nil?
+        puts "Please provide a port number, friend :3"
+        return false
+    elsif not numeric?(port)
+        puts "Port number must be an integer, friend :3"
+        return false
+    end
+    return true
+end
+
+def check_addr(mode, addr)
+    if addr.nil? and is_valid_command(mode) == "client"
+        puts "Please provide a server address, friend :3"
+        return false
+    end
+    return true
+end
+
+def main()
+  mode, port, addr = ARGV
+  if not check_mode(mode) or not check_port(port)
+    return
+  end
+  if not check_addr(mode, addr)
+    return
+  end
+  if is_valid_command(mode) == "server"
+    init_server(port)
+  else
+    init_client(addr, port)
+  end
+  puts "Goodbye friend, hope you enjoyed Simple-Transfer :3" #!
+end
+
+main() # real!

data/lib/repl.rb

@@ -0,0 +1,106 @@
+
+require_relative "transfer.rb"
+
+
+$logo = <<EOF
+
+.---.             .         .                             
+\___  . ,-,-. ,-. |  ,-.    |- ,-. ,-. ,-. ,-. ," ,-. ,-. 
+    \ | | | | | | |  |-' -- |  |   ,-| | | `-. |- |-' |   
+`---' ' ' ' ' |-' `' `-'    `' '   `-^ ' ' `-' |  `-' '   
+              |                                '          
+              '                                                                     
+EOF
+    
+
+class STShell
+    def initialize(server_addr, port)
+        @port = port
+        @client = SimpleTransfer::Sender.new(server_addr, port, logging=true)
+    end
+
+    def self.list_files(path)
+        Dir.entries(path).each do |f|
+            if File.directory?(f)
+                puts "#{f}/"
+            else
+                puts f
+            end
+        end
+    end
+
+    
+    def eval(query)
+        p1, p2 = query.split(" ")
+        if p1 == "clear"
+            system "clear"
+        elsif p1 == "send_file"
+            if File.directory?(p2)
+                puts "You can't send a directory as a file, friend!"
+            else
+                @client.send_file(p2)
+            end
+        elsif p1 == "send_directory"
+            if not File.directory?(p2)
+                puts "You can't send a file as a directory, friend!"
+            else
+                @client.send_directory(p2)
+            end
+        elsif p1 == "cd"
+            Dir.chdir(p2)
+        elsif p1 == "ls"
+            if p2.nil?
+              STShell.list_files(Dir.pwd)
+            else
+                STShell.list_files(p2)
+            end
+        elsif p1 == "help"
+            help()
+        else
+            p "I don't recognize this command: `#{p1}` friend!"
+        end
+    end
+
+    def help()
+        puts "Type 'send_file <filename>' to send a file"
+        puts "Type 'send_directory <directory>' to send a directory"
+        puts "Type 'cd <directory>' to change directory"
+        puts "Type 'ls <directory>' to list directory contents"
+        puts "Type help to see this message"
+    end
+
+    def read()
+        query = $stdin.gets.chomp
+        #puts query, echo is very annoying
+        return query
+    end
+
+    def print()
+        Kernel.print("[ST]🍀 #{Dir.pwd} >>>> ")
+    end
+
+    def init_loop()
+        puts $logo
+        puts "STShell initialized on port #{@port}!"
+        puts "Hello friend, thank you for using simple transfer!"
+        puts "Are you ready to drown in simplicity?"
+        puts "It is indeed extremely simple:"
+        help()
+        repl()
+        #real...
+        # let it be
+    end
+
+    def repl()
+        while true
+            print()
+            query = read()
+            begin
+                eval(query)
+            rescue => e
+                p e
+                puts "An error occurred, friend! >:3"
+            end
+        end
+    end
+end

data/lib/transfer.rb

@@ -1,225 +1,196 @@
-
-require_relative 'buffer/buffer'
-require 'socket'
-require 'fileutils'
-
-
-
-$socket = Socket::new(Socket::AF_INET, Socket::SOCK_STREAM)
-$socket.setsockopt(:SOCKET, :REUSEADDR, true)
-
-$PORT = 30317
-
-
-$MAX_BUFFER_SIZE = 65000
-
-
-def set_server(port=$PORT)
-	myaddr = Socket.pack_sockaddr_in(port, '0.0.0.0')
-
-	$socket.bind(myaddr)
-
-	$socket.listen(5)
-
-	puts "server listening on port: #{port}."
-end
-
-
-
-
-
-
-
-
-
-
-def accept_client
-	puts "waiting for the client to connect..."
-
-	$conn = $socket.accept
-
-	puts "#{$conn[1].ip_unpack()[0]} has connected!"
-end
-
-
-
-
-
-def connectto_target(ip, port=$PORT)
-	remote_addr = Socket.pack_sockaddr_in(port, ip) 
-
-	puts "trying to connect to the target..."
-	$socket.connect(remote_addr)
-	puts "connected to the target!"
-end
-
-
-
-
-
-
-
-
-
-
-def recv_file
-
-	file_size = $conn[0].recv(1024).chomp
-
-	unless file_size == ''
-
-		begin
-			file_size = Integer(file_size)
-		rescue ArgumentError
-			puts "Oops, there was a problem..."
-
-			return nil
-		end
-
-	else
-		puts "file receiving ended."
-		exit()
-	end
-
-	filename = $conn[0].recv(1024).chomp
-	
-	if file_size > 31457280
-		puts "#{filename} is bigger than 30 MB, cannot save!"
-
-		return nil
-
-
-	elsif file_size < $MAX_BUFFER_SIZE
-		file_content = $conn[0].recv($MAX_BUFFER_SIZE).chomp
-	
-	else
-		file_content = ''
-
-		while true
-			data = $conn[0].recv($MAX_BUFFER_SIZE).chomp
-
-			if data == "END"
-				break
-			else
-				file_content += data
-			end
-
-		end
-	end
-
-
-	begin
-		open("./"+filename, "a").write(file_content)
-
-	rescue Errno::ENOENT
-		dirname = File.dirname(filename)
-
-		unless File.directory?(dirname)
-		  FileUtils.mkdir_p(dirname)
-		  open("./"+filename, "a").write(file_content)
-		end
-	end
-
-	puts "received file '#{filename}'"
-end
-
-
-
-
-
-def send_file(filename)
-
-	puts "sending #{filename}..."
-
-	file_content = open(filename, "r").read()
-
-	file_size = file_content.length
-	  
-	$socket.puts(file_size)
-	sleep(0.5)
-	
-	$socket.puts(filename)                     
-	sleep(0.5)
-
-	if file_size > 31457280
-		return nil
-
-	elsif file_size < $MAX_BUFFER_SIZE
-		$socket.puts(file_content)
-	
-	else               
-		buffers = buffer(file_content, buffer_size=$MAX_BUFFER_SIZE)
-
-		for buffer in buffers.values
-			$socket.puts(buffer)
-			sleep(0.1)
-
-		end
-
-		$socket.puts "END"
-	end
-end
-
-
-
-
-
-def send_dir(dirname)
-	Dir["#{dirname}/**/*"].each do |file|
-		unless File.directory?(file)
-			send_file(file)
-		end
-	end
+require "socket"
+require "fileutils"
+require "time"
+
+module SimpleTransfer
+  def log_transfer(message, level = "INFO")
+    Kernel.puts "[#{level}] [%s] #{message}" % Time.now.utc.iso8601
+  end
+
+  def progress_bar(download, length)
+    i = (download.to_f / length.to_f * 30).to_i
+    return "[" + "❚" * i + " " * (30 - i) + "]"
+  end
+
+  def log_progress(downloaded, length, filename)
+    Kernel.print "\r[TRANSFER!] Downloading #{filename}... #{downloaded}/#{length} bytes"
+  end
+
+  class Server < TCPServer
+    @@recv_size = 1024 * 30
+
+    def initialize(*args)
+      super(*args)
+      @logging = true
+    end
+
+    def port()
+      return self.addr[1]
+    end
+
+    def recv_chunk()
+      return @conn.recv(@@recv_size)
+    end
+
+    def init_transfer()
+      @conn.send("SYNC OK", 1024)
+      data_length = Integer(recv_chunk()) # receive data length
+      log_transfer("received data length: #{data_length}", level = "DEBUGGING") if @logging
+      @conn.send("LENGTH OK", 1024)
+      filename = recv_chunk() # receive file name
+      log_transfer("received filename: #{filename}", level = "DEBUGGING") if @logging
+      @conn.send("FILENAME OK", 1024)
+      log_transfer(
+        "transfer initiated for #{filename} size: #{data_length}", level = "INFO"
+      ) if @logging
+      return data_length, filename
+    end
+
+    def recv_initiation()
+      start_sign = recv_chunk() # wait for the client to sync
+      log_transfer("received start sign: #{start_sign}", level = "DEBUGGING") if @logging
+      if start_sign != "SYNC NOW"
+        if start_sign.empty?
+          return 0
+        end
+        return nil
+      end
+      return init_transfer()
+    end
+
+    def handle_init()
+      init_data = recv_initiation()
+      if init_data == nil
+        log_transfer("Failed to receive initiation data", level = "WARNING") if @logging
+        return false, nil
+      elsif init_data == 0
+        log_transfer("Connection closed by the client", level = "WARNING") if @logging
+        return false, 0
+        return false, init_data
+      end
+      return init_data
+    end
+
+    def recv_file()
+      init = handle_init()
+      if not init[0]
+        return init[1]
+      end
+      data_length, filename = init
+      data = ""
+      while data.length < data_length
+        data += recv_chunk()
+        sleep(0.01)
+        log_progress(data.length, data_length, filename) if @logging
+      end
+      Kernel.print "\n"
+      if data.length != data_length
+        log_transfer(
+          "partial data received for #{filename}", level = "WARNING"
+        ) if @logging
+      end
+      return data, filename
+    end
+
+    def copyto_local(data)
+      fdata, filename = data
+      dirname = File.dirname(filename)
+      if not File.exist?('.' + dirname)
+        FileUtils.mkdir_p(dirname)
+      end
+      File.open(filename, "wb") do |f|
+        f.write(fdata)
+      end
+    end
+
+    def start()
+      log_transfer("(Re)starting Simple-Transfer server!") if @logging
+      log_transfer("listening at port %s..." % port) if @logging
+      self.listen(16)
+      @conn = accept()
+      log_transfer("Accepted client: #{@conn.peeraddr[2]}: #{@conn.peeraddr[1]}")
+      while true
+        filedata = recv_file()
+        if filedata == nil
+          next
+        elsif filedata == 0
+          start()
+          return
+        end
+        copyto_local(filedata)
+        sleep 0.01
+      end
+    end
+  end
+
+  class Sender < TCPSocket
+    @@chunk_size = 5000
+
+    def initialize(host, port, logging = false)
+      super(host, port)
+      @logging = logging
+    end
+
+    def self.buffer(data)
+      buffers = Array.new
+      data = String(data)
+      buffer_amount = @@chunk_size > data.length ? 1 : data.length / @@chunk_size + 1
+
+      for i in 0..buffer_amount - 1
+        buffers.push data.slice(i * @@chunk_size, @@chunk_size)
+      end
+
+      return buffers
+    end
+
+    def self.pack(filename, data)
+      buffers = self.buffer(data)
+
+      buffers.unshift filename
+      buffers.unshift String(data.length)
+      return buffers
+    end
+
+    def send_chunk(chunk)
+      send(chunk, @@chunk_size)
+    end
+
+    def initiate_exchange(package)
+      send_chunk("SYNC NOW")
+      log_transfer("sent start sign: SYNC NOW", level = "DEBUGGING") if @logging
+      recv(1024)
+      send_chunk(package.shift)
+      log_transfer("sent data length", level = "DEBUGGING") if @logging
+      recv(1024)
+      send_chunk(package.shift)
+      log_transfer("sent filename", level = "DEBUGGING") if @logging
+      recv(1024)
+    end
+
+    def send_file(filename)
+      package = nil
+      File.open(filename, "rb") do |f|
+        log_transfer("sending #{f.path}") if @logging
+        package = Sender.pack(filename, f.read())
+      end
+      initiate_exchange(package)
+      package.each do |chunk|
+        send_chunk(chunk)
+      end
+    end
+
+    def scan_directory(directory_name)
+      return Dir["%s/**/*" % directory_name]
+    end
+
+    def send_directory(directory)
+      scan_directory(directory).each do |f|
+        #sleep because there is no sync for end of transfer
+        sleep 0.5 
+        if File.directory?(f)
+          send_directory(f)
+        else send_file(f)         end
+      end
+    end
+  end
 end
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-module Transfer
-	def self.run_server
-		set_server
-		accept_client
-		while true
-			begin
-				recv_file
-			ensure
-			end
-		end
-	end
-
-	def self.transfer(ip, file)
-		begin
-			connectto_target(ip)
-		rescue Errno::EISCONN
-		end
-
-		if File.directory?(file)
-			send_dir(file)
-		else
-			send_file(file)
-		end
-	end
-end
-
-
-
-
-
-
-

metadata

@@ -1,29 +1,33 @@
 --- !ruby/object:Gem::Specification
 name: simple-transfer
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.1
 platform: ruby
 authors:
 - Burzum
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-16 00:00:00.000000000 Z
+date: 2025-02-24 00:00:00.000000000 Z
 dependencies: []
-description: 
-email: 
-executables: []
+description: |-
+  An extremely simple gem that relies on the TCP stack for transfer of files over a IP network.
+      It is as simple as it gets. Relies on no other protocol.
+email:
+- atifaydinturanli@gmail.com
+executables:
+- simple-transfer
 extensions: []
-extra_rdoc_files:
-- README.md
+extra_rdoc_files: []
 files:
-- README.md
-- lib/buffer/buffer.rb
+- bin/simple-transfer
+- lib/repl.rb
 - lib/transfer.rb
-homepage: 
-licenses: []
+homepage: https://github.com/unhappygirl/simple-transfer
+licenses:
+- MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -38,8 +42,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.4.20
+signing_key:
 specification_version: 4
-summary: A gem for transfering files up to 30 mbs simply and with ease.
+summary: A gem for transfering files over your network with extreme simplicity -and
+  fast.
 test_files: []

data/README.md

@@ -1,56 +0,0 @@
-This gem is created to make transfering whole directories; scripts, photos, videos, any files that are up to 30 MB simple and easy.
-
-**Please don't forget to read the notes section.**
-
-
-
-## Usage
-
-As the name suggests, to transfer files is simple and easy with ```simple-transfer```.
-
-The ```Transfer``` module has two methods: ```Transfer::run_server``` and ```Transfer::transfer```.
-
-#### ```Transfer::run_server```
-
-This method will run a server on your local machine. Once you call it, the server will listen for connections.
-
-The server is for receiving files only. So the machine that will receive files needs to call this method first.
-
-#### ```Transfer::transfer```
-This method takes two arguments, first argument is the IPv4 of the target; second one is the name of the file, directory that will be sent.
-
-It will try to connect to the target machine if not already connected and send the files that are specified.
-
-
-## Example
-
-
-The server:
-
-```
-require 'transfer'
-include Transfer
-
-Transfer.run_server
-
-```
-
-The client:
-
-```
-require 'transfer'
-include Transfer
-
-Transfer.transfer('192.168.1.25', 'foo.png')
-
-```
-
-## Notes
-
-* Using ```simple-transfer``` from the interactive ruby shell is terribly bad.
-
-* ```simple-transfer``` uses tcp sockets and buffers data that are bigger than 65 KB. If you are receiving files only partially and encountering strange errors, try setting the ```$MAX_BUFFER_SIZE``` constant to a lower value.
-
-* To make ```simple-transfer``` work on the internetwork, port forwarding is required.
-
-* Relative paths are NOT supported in simple-transfer. Files need to be in the cwd to be transfered.

data/lib/buffer/buffer.rb

@@ -1,27 +0,0 @@
-
-
-
-def buffer(data, buffer_size=65000)
-
-	labelnum = 0
-	
-	buffers = Hash.new
-
-	data = String(data)
-
-	buffer_amount = ( data.length / buffer_size ) + 1
-
-	sindex = 0
-
-	while labelnum != buffer_amount
-		buffers["buffer#{labelnum}"] = data.slice(sindex, buffer_size)
-
-		sindex += buffer_size
-
-		labelnum += 1
-
-	end
-
-	return buffers
-
-end