remote_sh 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2cb32323000e3b9ae8bad777982e2b0f305cfb7f58a5963165b623b90957c3c0
+  data.tar.gz: c016fb49746c43098ded07c64a88f5cace021facca28fd8d7fa48d8bce33a43b
+SHA512:
+  metadata.gz: 76c505f34d51c8ae4ce831358dd40841ca846697247831586ee59b0ccb36ca1e565efba0dd210716cc85e2039b819186fbecada4df56a720ed3dcc7b7bc9bcd1
+  data.tar.gz: 65dfa6e49f6112303b5ce406703e60560dc378728e2fbd0a660147311c514e9912431fb1ea54fc92e5512174cfc33f5719032053c42ab7b6ce508518fe9348dd

data/README.md

@@ -0,0 +1,39 @@
+# Remote
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/remote`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/remote.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/remote_sh/cli.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require "thor"
+require "fileutils"
+
+module RemoteSh
+  class Cli < Thor
+    desc "attach", "attaches to remote host and starts file sync"
+    def attach
+      hostname = WorkspaceConfiguration.host_config["name"]
+
+      FileUtils.mkdir_p("#{PID_FOLDER}/#{hostname}")
+
+      local_path = WorkspaceConfiguration::WOKRING_DIR
+      pid_filename = "#{PID_FOLDER}/#{hostname}/#{local_path.gsub("/", "__")}"
+
+      unless File.exist?(pid_filename)
+        File.open(pid_filename, "w") do |f|
+          @owns_sync = true
+          f.write("busy")
+        end
+      end
+
+      host = WorkspaceConfiguration.host_config["host"]
+      host_path = WorkspaceConfiguration.config["host_path"]
+
+      if @owns_sync
+        FileSyncer.start(host, host_path, WorkspaceConfiguration.config["ignore"] || [])
+        PortForwarder.start_or_skip(WorkspaceConfiguration.host_config)
+      end
+
+      SshHelper.attach(host, host_path)
+    ensure
+      File.delete(pid_filename) if @owns_sync
+    end
+
+    desc "sync_down", "synces down remote changes"
+    def sync_down
+      RsyncHelper.down(
+        WorkspaceConfiguration::WOKRING_DIR,
+        WorkspaceConfiguration.config["host_path"],
+        WorkspaceConfiguration.host_config["host"],
+        WorkspaceConfiguration.config["ignore"] || []
+      )
+    end
+
+    desc "init", "inits"
+    def init
+      WorkspaceConfiguration.init!
+    end
+  end
+end

data/lib/remote_sh/file_syncer.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require 'open3'
+require 'webrick'
+require 'socket'
+require 'filewatcher'
+
+module RemoteSh
+  module FileSyncer
+    module_function
+
+    def start(host, host_path, ignored_files)
+      local_path = WorkspaceConfiguration::WOKRING_DIR
+
+      RsyncHelper.up(local_path, host_path, host, ignored_files)
+
+      mutex = Mutex.new
+
+      Thread.new do
+        Filewatcher.new("#{local_path}/**/{.[^\.]*,*}", interval: 1).watch do |_changes|
+          if @sync_side == :client || !mutex.locked?
+            mutex.synchronize do
+              @sync_side = :client
+              RsyncHelper.up(local_path, host_path, host, ignored_files)
+              @sync_side = nil
+            end
+          end
+        end
+      end
+
+      Thread.new do
+        start_server(mutex, local_path, host_path, host, ignored_files)
+      end
+    end
+
+    def start_server(mutex, local_path, host_path, host, ignored_files)
+      pid_filename = "#{PID_FOLDER}/#{local_path.gsub("/", "__")}_syncing"
+      socket_file = "#{pid_filename}_socket"
+
+      path = socket_file.split("/")[...-1].join("/")
+
+      `ssh #{host} "rm #{socket_file}"`
+      `ssh #{host} "mkdir -p #{path}"`
+
+      Thread.new do
+        ruby_code = <<~RUBY.gsub('"', '\"')
+          require "net_http_unix"
+          require "filewatcher"
+
+          Thread.new do
+            Filewatcher.new("#{host_path}/**/{.[^\.]*,*}", interval: 1).watch do |_changes|
+              request = Net::HTTP::Get.new("/request_sync")
+              NetX::HTTPUnix.new("unix://" + "#{socket_file}").request(request)
+            end
+          end
+
+          loop do
+            request = Net::HTTP::Get.new("/ping")
+            NetX::HTTPUnix.new("unix://" + "#{socket_file}").request(request)
+            sleep(3)
+          end
+        RUBY
+
+        Open3.capture3("ssh -q #{host} 'ruby -e \"#{ruby_code}\"'")
+      end
+
+      UNIXServer.open(socket_file) do |ssocket|
+        SshHelper.forward_local_socket(host, socket_file)
+
+        server = WEBrick::HTTPServer.new(
+          DoNotListen: true,
+          Logger: WEBrick::Log.new("/dev/null"),
+          AccessLog: [],
+        )
+        server.listeners << ssocket
+
+        server.mount_proc "/request_sync" do |_req, res|
+          if @sync_side == :server || !mutex.locked?
+            mutex.synchronize do
+              @sync_side = :server
+              RsyncHelper.down(local_path, host_path, host, ignored_files)
+              @sync_side = nil
+            end
+          end
+
+          res.body = "request_sync"
+        end
+
+        server.mount_proc "/ping" do |_req, res|
+          res.body = "ping"
+        end
+
+        trap("INT") { server.shutdown }
+
+        server.start
+      end
+    ensure
+      SshHelper.close_local_socket(host, socket_file)
+      File.unlink(socket_file)
+    end
+  end
+end

data/lib/remote_sh/hosts_configuration.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "yaml"
+
+module RemoteSh
+  class HostsConfiguration
+    include Singleton
+
+    CONFIGURATION_PATH = "#{Dir.home}/.config/remote_sh"
+    CONFIGURATION_FILE = "#{CONFIGURATION_PATH}/servers.yaml"
+
+    # servers:
+    # - name: main
+    #   host: root@127.0.0.1
+    #   blacklist_ports: ['22', '25', '631']
+
+    def self.config
+      instance.config
+    end
+
+    def parse
+      FileUtils.mkdir_p(CONFIGURATION_PATH)
+      @config = YAML.load_file(CONFIGURATION_FILE)
+    end
+
+    def config
+      @config || parse
+    end
+  end
+end

data/lib/remote_sh/port_forwarder.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module RemoteSh
+  module PortForwarder
+    module_function
+
+    def start_or_skip(host_config)
+      host_name = host_config["name"]
+      host_host = host_config["host"]
+
+      remote_blacklist_ports = host_config["blacklist_ports"]
+      local_blacklisted_ports = HostsConfiguration.config["blacklisted_ports"]
+
+      pid_filename = "#{PID_FOLDER}/#{host_name}_portforwarding"
+
+      return if File.exist?(pid_filename)
+
+      # puts "started"
+
+      pid_folder = "#{PID_FOLDER}/#{host_name}"
+
+      local_opened_ports = current_ports(local_blacklisted_ports)
+      local_opened_ports.each { |port| SshHelper.forward_local_port(host_host, port) }
+
+      remote_opened_ports = SshHelper.current_ports(host_host, remote_blacklist_ports + local_opened_ports)
+      remote_opened_ports.each { |port| SshHelper.forward_port(host_host, port) }
+
+      Process.fork do
+        File.open(pid_filename, "w") { |f| f.write("busy") }
+
+        work_loop(
+          host_host,
+          pid_folder,
+          remote_blacklist_ports,
+          remote_opened_ports,
+          local_blacklisted_ports,
+          local_opened_ports
+        )
+        SshHelper.current_ports(host_host, remote_blacklist_ports + local_opened_ports).each { |port| SshHelper.close_port(host_host, port) }
+        current_ports(local_blacklisted_ports + remote_opened_ports).each { |port| SshHelper.close_local_port(host_host, port) }
+      ensure
+        File.delete(pid_filename)
+      end
+    end
+
+    def current_ports(local_blacklisted_ports)
+      `lsof -PiTCP -sTCP:LISTEN`
+        .split("\n")
+        .map(&:split)[1..]
+        .map { _1[8].split(":").last }
+        .uniq - local_blacklisted_ports
+    end
+
+    def work_loop(
+      host,
+      pid_folder,
+      remote_blacklisted_ports,
+      remote_opened_ports,
+      local_blacklisted_ports,
+      local_opened_ports
+    )
+      # remote ports
+      remote_opened_ports_was = remote_opened_ports
+      remote_opened_ports = SshHelper.current_ports(host, remote_blacklisted_ports + local_opened_ports)
+
+      remote_ports_to_close = remote_opened_ports_was - remote_opened_ports
+      remote_ports_to_open = remote_opened_ports - remote_opened_ports_was
+
+      remote_ports_to_open.each { |port| SshHelper.forward_port(host, port) }
+      remote_ports_to_close.each { |port| SshHelper.close_port(host, port) }
+
+      #local ports
+
+      local_opened_ports_was = local_opened_ports
+      local_opened_ports = current_ports(local_blacklisted_ports + remote_opened_ports)
+
+      local_ports_to_close = local_opened_ports_was - local_opened_ports
+      local_ports_to_open = local_opened_ports - local_opened_ports_was
+
+      # puts 'local_ports_to_open' + local_ports_to_open.inspect
+      local_ports_to_open.each { |port| SshHelper.forward_local_port(host, port) }
+      # puts 'local_ports_to_close' + local_ports_to_close.inspect
+      local_ports_to_close.each { |port| SshHelper.close_local_port(host, port) }
+
+      sleep(1)
+
+      work_loop(
+        host,
+        pid_folder,
+        remote_blacklisted_ports,
+        remote_opened_ports,
+        local_blacklisted_ports,
+        local_opened_ports
+      ) unless Dir["#{pid_folder}/*"].empty?
+    end
+  end
+end

data/lib/remote_sh/rsync_helper.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module RemoteSh
+  module RsyncHelper
+    module_function
+
+    # def create_filters(ignore_paths)
+    #   included_files_arg = ""
+    #   excluded_files_arg = ""
+    #
+    #   ignore_paths.each do |path|
+    #     expanded_path = "#{WorkspaceConfiguration::WOKRING_DIR}/#{path}"
+    #
+    #     next unless File.exist?(expanded_path)
+    #
+    #     File.foreach(expanded_path) do |line|
+    #       line = line.strip
+    #       next if line.start_with?("#")
+    #
+    #       if line.start_with?("!")
+    #         included_files_arg += "--include='#{line[1..-1]}' "
+    #       else
+    #         excluded_files_arg += "--exclude='#{line}' "
+    #       end
+    #     end
+    #   end
+    #
+    #   "#{excluded_files_arg} #{included_files_arg} -f'- .remote_sh'"
+    # end
+
+    def up(from, to, host, _ignore_paths)
+      # result = `rsync -varz --delete --rsync-path="sudo rsync" #{create_filters(ignore_paths)} #{from}/ #{host}:#{to}/`
+      result = `rsync -azl --safe-links --delete --rsync-path="sudo rsync" -f'- .remote_sh' #{from}/ #{host}:#{to}/`
+      raise result if $?.exitstatus != 0
+      result
+    end
+
+    def down(from, to, host, _ignore_paths)
+      # result = `rsync -varz --rsync-path="sudo rsync" #{create_filters(ignore_paths)} #{host}:#{to}/ #{from}/`
+      result = `rsync -azl --safe-links --rsync-path="sudo rsync" -f'- .remote_sh' #{host}:#{to}/ #{from}/`
+      raise result if $?.exitstatus != 0
+      result
+    end
+  end
+end

data/lib/remote_sh/ssh_helper.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+require 'digest/sha1'
+
+module RemoteSh
+  module SshHelper
+    module_function
+
+    def attach(host, dir)
+      system("ssh -t #{host} \"cd #{dir}; exec \$SHELL -l\"")
+    end
+
+    def current_ports(host, blacklist_ports)
+      `ssh #{host} "netstat -tuln | grep LISTEN"`
+        .split("\n")
+        .map(&:split)
+        .map { _1[3].split(':').last }
+        .uniq - blacklist_ports
+    end
+
+    def normalize_port(port)
+      port = port.to_i
+
+      if port == 80 || port == 443
+        port += 8000
+      elsif port <= 1024
+        port += 10000
+      end
+
+      port.to_s
+    end
+
+    def forward_local_port(host, port)
+      normalized_port = normalize_port(port)
+      system("ssh -q -f -N -M -S /tmp/remote_local_pf_#{port} -R #{port}:localhost:#{normalized_port} #{host}")
+    end
+
+    def close_local_port(host, port)
+      system("ssh -q -S /tmp/remote_local_pf_#{port} -O exit #{host}")
+    end
+
+    def forward_local_socket(host, socket)
+      system("ssh -f -N -M -S /tmp/remote_local_pf_#{Digest::SHA1.hexdigest(socket)} -R #{socket}:#{socket} #{host}")
+    end
+
+    def close_local_socket(host, socket)
+      system("ssh -q -S /tmp/remote_local_pf_#{Digest::SHA1.hexdigest(socket)} -O exit #{host}")
+    end
+
+    def forward_port(host, port)
+      normalized_port = normalize_port(port)
+      # puts "forwarding #{port} to #{normalized_port}"
+      system("ssh -f -N -M -S /tmp/remote_pf_#{port} -L #{normalized_port}:localhost:#{port} #{host}")
+    end
+
+    def close_port(host, port)
+      # normalized_port = normalize_port(port)
+      # puts "closing #{port} forwarded to #{normalized_port}"
+      system("ssh -q -S /tmp/remote_pf_#{port} -O exit #{host}")
+    end
+  end
+end

data/lib/remote_sh/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RemoteSh
+  VERSION = "0.1.0"
+end

data/lib/remote_sh/workspace_configuration.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require "yaml"
+
+module RemoteSh
+  class WorkspaceConfiguration
+    include Singleton
+
+    WOKRING_DIR = Dir.pwd
+    CONFIGURATION_FILE = "#{WOKRING_DIR}/.remote_sh/connection.yaml"
+
+    # host: name_from_config
+    # host_path: path_on_server
+    # ignore: ...
+
+    def self.config
+      instance.config
+    end
+
+    def self.host_config
+      instance.host_config
+    end
+
+    def self.init!
+      current_path = Dir.getwd
+
+      default_server = HostsConfiguration.config['default_server']
+      default_remote_root_path = HostsConfiguration.config['default_remote_root_path']
+      default_local_root_path = HostsConfiguration.config['default_local_root_path']
+
+      Dir.mkdir("#{current_path}/.remote_sh")
+
+      current_relative_path = current_path.delete_prefix(default_local_root_path)
+
+      remote_path = "#{default_remote_root_path}#{current_relative_path}"
+      host = HostsConfiguration.config['servers'].find { |s| s['name'] == default_server }['host']
+
+      `ssh #{host} "mkdir -p #{remote_path}"`
+
+      File.open("#{Dir.getwd}/.remote_sh/connection.yaml", 'w') do |file|
+        file.write(<<~YAML)
+          host: main
+          host_path: #{remote_path}
+          ignore:
+            - .gitignore
+        YAML
+      end
+    end
+
+    def parse
+      @config = YAML.load_file(CONFIGURATION_FILE)
+    end
+
+    def config
+      @config || parse
+    end
+
+    def host_config
+      @host_config ||=
+        HostsConfiguration.config["servers"].find { _1["name"] == config["host"] }
+    end
+  end
+end

data/lib/remote_sh.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "zeitwerk"
+require "singleton"
+
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+
+module RemoteSh
+  PID_FOLDER = "/tmp/remote_sh"
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: remote_sh
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pavel Egorov
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-12-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: filewatcher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: CLI for remote development
+email:
+- moonmeander47@ya.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/remote_sh.rb
+- lib/remote_sh/cli.rb
+- lib/remote_sh/file_syncer.rb
+- lib/remote_sh/hosts_configuration.rb
+- lib/remote_sh/port_forwarder.rb
+- lib/remote_sh/rsync_helper.rb
+- lib/remote_sh/ssh_helper.rb
+- lib/remote_sh/version.rb
+- lib/remote_sh/workspace_configuration.rb
+homepage: https://github.com/emfy0/remote_sh
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/emfy0/remote_sh
+  source_code_uri: https://github.com/emfy0/remote_sh
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: CLI for remote development
+test_files: []