diamant 0.0.8 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78504900d38add8a76be57a468a7e3b86284ef964de1e75a6bc40f614649f78b
-  data.tar.gz: b0212f1c5b7180d0b7de192ab13c5abe37863d6fd5dbde61d5dea86dfcba3572
+  metadata.gz: 3aae272eff26676b737dc65ff08ea76b0b4ea1822ec4785dfa47b97f0647dbe8
+  data.tar.gz: dc803566505cbed2653c44ac2bc7d4d3e0767ceb4604f91f32c1523917045192
 SHA512:
-  metadata.gz: da679165a67588a03666ad9e12149927bdbaf6cf663165693cc42c26a70ec39f7f0e19a9b61214d27ba6b2c9ec13f64b55f8059a2d49d4a539940b82c9b39d29
-  data.tar.gz: 814580c5b14c5344b1e2432e7eb078e83c1421b939f11437f6a921f94dec7c066bd8329348d259749dacf7ac033e086d9a1d784773a389e4294b9e6794ef5118
+  metadata.gz: dc0d90505b8e7ef55f679c290aca6288dddd7c5b3208fbcab86dfa9501be7316ae8f425a3e5e4e5a3525d03c8765c397729231a590836bbe168783f162c3a852
+  data.tar.gz: b181654c75861b8a20308513b451999b63ce08b47c527ce2258de451daa16835aba9676c0f0ede70cb609eeb7b1a71f0a8f933b3c031ab39d505e4308396d532

data/bin/diamant

@@ -1,9 +1,9 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'diamant'
-require 'diamant/cert_generator'
 require 'optparse'
+require_relative '../lib/diamant'
+require_relative '../lib/diamant/cert_generator'
 
 options = { hostname: '127.0.0.1', port: 1965 }
 OptionParser.new do |parser| # rubocop:disable Metrics/BlockLength

data/lib/diamant/cert_generator.rb

@@ -23,15 +23,15 @@ module Diamant
     end
 
     def write
-      IO.write('key.rsa', @key.to_pem)
+      File.write('key.rsa', @key.to_pem)
       File.chmod(0o400, 'key.rsa')
-      IO.write('cert.pem', @cert.to_pem)
+      File.write('cert.pem', @cert.to_pem)
       File.chmod(0o644, 'cert.pem')
     end
 
     private
 
-    def init_cert
+    def init_cert # rubocop:disable Metrics/AbcSize
       @cert = OpenSSL::X509::Certificate.new
       @cert.version = 3
       @cert.serial = 0x0
@@ -40,7 +40,7 @@ module Diamant
       @cert.public_key = @key.public_key
       @cert.not_before = Time.now
       # 1 years validity
-      @cert.not_after = @cert.not_before + 1 * 365 * 24 * 60 * 60
+      @cert.not_after = @cert.not_before + (1 * 365 * 24 * 60 * 60)
       @cert
     end
 

data/lib/diamant/mimefile.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module Diamant
+  class MimeError < StandardError; end
+
+  # MIME aware wrapper for file
+  class MimeFile
+    attr_reader :body, :category, :content_type, :extension
+
+    MIMETYPES = {
+      '.gemini' => 'text/gemini',
+      '.gmi' => 'text/gemini',
+      '.txt' => 'text/plain',
+      '.md' => 'text/markdown',
+      '.org' => 'text/org',
+      '.rss' => 'application/rss+xml',
+      '.atom' => 'application/atom+xml',
+      '.xml' => 'application/xml',
+      '.svg' => 'image/svg+xml',
+      '.bmp' => 'image/bmp',
+      '.png' => 'image/png',
+      '.jpg' => 'image/jpeg',
+      '.jpeg' => 'image/jpeg',
+      '.gif' => 'image/gif',
+      '.webp' => 'image/webp',
+      '.mp3' => 'audio/mpeg',
+      '.ogg' => 'audio/ogg'
+    }.freeze
+
+    def initialize(path)
+      @path = path
+      @body = File.read path
+      @extension, @content_type = extract_info
+      @category = classify
+      validate!
+      prepare_gem_file if @content_type == 'text/gemini'
+    end
+
+    # Disable metrics on purpose for big switch
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength
+    def validate
+      return true if @category == :text
+
+      case @content_type
+      when 'image/jpeg'
+        @body[0..1] == "\xFF\xD8"
+      when 'image/png'
+        @body[0..7] == "\x89PNG\r\n\u001A\n"
+      when 'image/gif'
+        @body[0..2] == 'GIF'
+      when 'image/webp'
+        @body[0..3] == 'RIFF' && @body[8..11] == 'WEBP'
+      when 'image/bmp'
+        @body[0..2] == 'BM'
+      when 'image/svg+xml', 'application/xml',
+           'application/rss+xml', 'application/atom+xml'
+        @body[0..5] == '<?xml '
+      when 'audio/mpeg'
+        @body[0..3] == 'ID3'
+      when 'audio/ogg'
+        @body[0..4] == 'OggS'
+      else
+        false
+      end
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/MethodLength
+
+    def validate!
+      return if validate
+
+      raise MimeError, "#{@path} does not looks like a #{@content_type} file!"
+    end
+
+    private
+
+    def extract_info
+      extension = File.extname @path
+      mime = MIMETYPES[extension]
+      raise MimeError, "#{@path} format is not supported!" if mime == ''
+
+      # Any other supported extension
+      [extension, mime]
+    end
+
+    def classify
+      return unless @content_type
+
+      @content_type.split('/', 2).first.to_sym
+    end
+
+    def prepare_gem_file
+      # Ensure each lines finishes with \r\n
+      @body = @body.each_line(chomp: true).to_a.join "\r\n"
+    end
+  end
+end

data/lib/diamant/response.rb

@@ -3,9 +3,13 @@
 require 'net/gemini/request'
 require 'uri/gemini'
 
+require_relative 'mimefile'
+
 module Diamant
   # Methods to generate requests responses
   module Response
+    class NotFound < Net::Gemini::BadResponse; end
+
     private
 
     def reject_request?(sock, current_load)
@@ -13,6 +17,7 @@ module Diamant
       return false if current_load < 11
       # Seppuku
       raise 'Server is under heavy load' if current_load > 1965
+
       if current_load > 42
         @logger.warn '41 - Too much threads...'
         sock.puts "41 See you soon...\r\n"
@@ -24,33 +29,39 @@ module Diamant
       true
     end
 
-    def read_file(client)
+    def build_response(client)
       r = Net::Gemini::Request.read_new(client)
-      [r.uri, route(r.path)]
+      file_path = route r.path
+      [r.uri, read_mime_file(file_path)]
+    rescue NotFound => e
+      @logger.warn "51 - #{e}"
+      [r.uri, "51 Not found!\r\n"]
     rescue Net::Gemini::BadRequest, URI::InvalidURIError => e
       @logger.error "59 - #{e}"
-      [nil, ["59\r\n"]]
+      [nil, "59\r\n"]
     end
 
     def route(path)
       # In any case, remove the / prefix
-      route = File.expand_path path.delete_prefix('/'), Dir.pwd
+      route = File.expand_path path.delete_prefix('/')
       # We better should use some sort of chroot...
       unless route.start_with?(Dir.pwd)
-        @logger.warn "Bad attempt to get something out of public_dir: #{route}"
-        return ['51 Not found!']
+        raise NotFound, "Attempt to get something out of public_dir: #{route}"
       end
+
       route << '/index.gmi' if File.directory?(route)
-      return ['51 Not found!'] unless File.exist?(route)
-      build_response route
+      return route if File.exist?(route)
+
+      raise NotFound, "File #{route} does not exist"
     end
 
-    def build_response(route)
-      info = Diamant::MimeType.new(route)
-      answer = IO.readlines route, chomp: true
-      answer.prepend "20 #{info.content_type}"
-    rescue Diamant::MimeError
-      ['50 Not a supported file!']
+    def read_mime_file(route)
+      info = Diamant::MimeFile.new route
+      header = "20 #{info.content_type}"
+      [header, info.body].join("\r\n")
+    rescue Diamant::MimeError => e
+      @logger.error "50 - #{e}"
+      "50 Not a supported file!\r\n"
     end
   end
 end

data/lib/diamant/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Diamant
-  VERSION = '0.0.8'
+  VERSION = '0.0.10'
 end

data/lib/diamant.rb

@@ -6,9 +6,7 @@ require 'English'
 require 'openssl'
 require 'fileutils'
 
-require 'diamant/version'
-require 'diamant/mimetype'
-require 'diamant/response'
+require_relative 'diamant/response'
 
 module Diamant
   # Runs the server request/answer loop.
@@ -34,13 +32,7 @@ module Diamant
 
     def main_loop(ssl_serv)
       loop do
-        Thread.new(ssl_serv.accept) do |client|
-          handle_client(client)
-        rescue Errno::ECONNRESET, Errno::ENOTCONN => e
-          @logger.error(e.message)
-        ensure
-          client.close
-        end
+        main_loop_tick ssl_serv.accept
       rescue OpenSSL::SSL::SSLError => e
         # Do not even try to answer anything as the socket cannot be
         # built. This will abruptly interrupt the connection from a client
@@ -56,17 +48,26 @@ module Diamant
       end
     end
 
+    # Might raises some errors
+    def main_loop_tick(connection)
+      Thread.new(connection) do |client|
+        handle_client(client)
+      rescue Errno::ECONNRESET, Errno::ENOTCONN, Errno::ETIMEDOUT => e
+        @logger.error(e.message)
+      ensure
+        client.close
+      end
+    end
+
     def handle_client(client)
-      current_load = Thread.list.length - 1
+      current_load = Thread.list.length - 1 # Exclude main thread
       return if reject_request?(client, current_load)
 
-      uri, answer = read_file(client)
+      uri, answer = build_response(client)
       log_line = [current_load, client.peeraddr[3], answer[0]]
       log_line << uri if uri
       @logger.info log_line.join(' - ')
-      answer.each do |line|
-        client.puts "#{line}\r\n"
-      end
+      client.puts answer
     end
 
     def ssl_context

metadata

@@ -1,113 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: diamant
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.10
 platform: ruby
 authors:
 - Étienne Deparis
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-20 00:00:00.000000000 Z
+date: 2024-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-net-text
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.0.9
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.0.9
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.12'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.57'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.57'
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.19'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.19'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.24'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.24'
-- !ruby/object:Gem::Dependency
-  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.22'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.22'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
+        version: '0.1'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0.1'
 description: |
   Diamant is a server for the Gemini network protocol. It can only serve
   static files. Internally, it uses the OpenSSL library to handle the TLS
@@ -122,13 +38,17 @@ files:
 - bin/diamant
 - lib/diamant.rb
 - lib/diamant/cert_generator.rb
-- lib/diamant/mimetype.rb
+- lib/diamant/mimefile.rb
 - lib/diamant/response.rb
 - lib/diamant/version.rb
 homepage: https://git.umaneti.net/diamant/about/
 licenses:
 - WTFPL
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://git.umaneti.net/fronde
+  homepage_uri: https://etienne.depar.is/fronde/
+  funding_uri: https://liberapay.com/milouse
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -144,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.20
+rubygems_version: 3.5.15
 signing_key:
 specification_version: 4
 summary: A simple Gemini server for static files.

data/lib/diamant/mimetype.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-module Diamant
-  class MimeError < StandardError; end
-
-  # Helper to understand what mimetype has a given file
-  class MimeType
-    attr_reader :extension, :content_type
-
-    MIMETYPES = {
-      '.gemini' => 'text/gemini',
-      '.gmi' => 'text/gemini',
-      '.txt' => 'text/plain',
-      '.md' => 'text/markdown',
-      '.org' => 'text/org',
-      '.xml' => 'application/xml',
-      '.png' => 'image/png',
-      '.jpg' => 'image/jpeg',
-      '.jpeg' => 'image/jpeg',
-      '.gif' => 'image/gif'
-    }.freeze
-
-    def initialize(path)
-      @path = path
-      extract_info
-    end
-
-    def supported?
-      @extension != '' && MIMETYPES.has_key?(@extension)
-    end
-
-    private
-
-    def extract_info
-      @extension = File.extname @path
-      raise MimeError, "#{@path} format is not supported!" unless supported?
-      # Any other supported extension
-      @content_type = MIMETYPES[@extension]
-    end
-  end
-end