mailcatcher-ng 1.3.2 → 1.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94ba0ec31d08bb9451404c14a7da44e9915e5fcb61d979b78a194bb3554cb5b9
-  data.tar.gz: f4c1bd7e99e918867538f43b8de1590e6b7430d581f23479df7e8324b6da0abf
+  metadata.gz: 2238cc35e17eb1bca222b4adf177bd093f9eacf291f5b179c3c1db7cc6ccfc53
+  data.tar.gz: 6d7487a8ef8f6488afa6f83e850c2c3f928424cd870ed313c15849c849873672
 SHA512:
-  metadata.gz: 3cdd308d86e8005320a6837bf89c573593c33965eeb9908b871f1361303c2c65e4cff1b6dc7a3baf7dc8f6c80030bebe5bca325bde1e7b28a79cd21692b932bd
-  data.tar.gz: 8fa8a3b1220b87a4f0d7b011c2b84b5033eb513648a4b25787b0367849e08bd07ce0a2d3f977db717c4007724c04b37e9ed249d67cdd5f74c307d513cec21f64
+  metadata.gz: f784c55cf0eb84d166a48ba99e36e60b3fd4028facf5e2b30fa92c3c6f17814f71434fb6e5be2f68a82c4c3f3b93c7cc2c617c5100a8515ba0e9d2a3331e3272
+  data.tar.gz: 776268ce8b6c14dcb67c5387e03611015c1dab6afc8527ef6a1bd67d42bd510d634eec220df5363625de4536f576e26fd53605140a00a2aaddac2e4190c1fe55

data/lib/mail_catcher/mail.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "eventmachine"
+require "fileutils"
 require "json"
 require "mail"
 require "sqlite3"
@@ -8,9 +9,10 @@ require "sqlite3"
 module MailCatcher::Mail extend self
   def db
     @__db ||= begin
-      SQLite3::Database.new(":memory:", :type_translation => true).tap do |db|
+      db_path = determine_db_path
+      SQLite3::Database.new(db_path, :type_translation => true).tap do |db|
         db.execute(<<-SQL)
-          CREATE TABLE message (
+          CREATE TABLE IF NOT EXISTS message (
             id INTEGER PRIMARY KEY ASC,
             sender TEXT,
             recipients TEXT,
@@ -22,7 +24,7 @@ module MailCatcher::Mail extend self
           )
         SQL
         db.execute(<<-SQL)
-          CREATE TABLE message_part (
+          CREATE TABLE IF NOT EXISTS message_part (
             id INTEGER PRIMARY KEY ASC,
             message_id INTEGER NOT NULL,
             cid TEXT,
@@ -37,7 +39,7 @@ module MailCatcher::Mail extend self
           )
         SQL
         db.execute(<<-SQL)
-          CREATE TABLE smtp_transcript (
+          CREATE TABLE IF NOT EXISTS smtp_transcript (
             id INTEGER PRIMARY KEY ASC,
             message_id INTEGER,
             session_id TEXT NOT NULL,
@@ -55,13 +57,41 @@ module MailCatcher::Mail extend self
             FOREIGN KEY (message_id) REFERENCES message (id) ON DELETE CASCADE
           )
         SQL
-        db.execute("CREATE INDEX idx_smtp_transcript_message_id ON smtp_transcript(message_id)")
-        db.execute("CREATE INDEX idx_smtp_transcript_session_id ON smtp_transcript(session_id)")
+        db.execute(<<-SQL)
+          CREATE TABLE IF NOT EXISTS websocket_connection (
+            id INTEGER PRIMARY KEY ASC,
+            session_id TEXT NOT NULL,
+            client_ip TEXT,
+            opened_at DATETIME,
+            closed_at DATETIME,
+            last_ping_at DATETIME,
+            last_pong_at DATETIME,
+            ping_count INTEGER DEFAULT 0,
+            pong_count INTEGER DEFAULT 0,
+            created_at DATETIME DEFAULT CURRENT_DATETIME,
+            updated_at DATETIME DEFAULT CURRENT_DATETIME
+          )
+        SQL
+        db.execute("CREATE INDEX IF NOT EXISTS idx_smtp_transcript_message_id ON smtp_transcript(message_id)")
+        db.execute("CREATE INDEX IF NOT EXISTS idx_smtp_transcript_session_id ON smtp_transcript(session_id)")
+        db.execute("CREATE INDEX IF NOT EXISTS idx_websocket_connection_session_id ON websocket_connection(session_id)")
         db.execute("PRAGMA foreign_keys = ON")
       end
     end
   end
 
+  def determine_db_path
+    if MailCatcher.options && MailCatcher.options[:persistence]
+      # Use a persistent SQLite file in the user's home directory
+      db_dir = File.expand_path('~/.mailcatcher')
+      FileUtils.mkdir_p(db_dir) unless Dir.exist?(db_dir)
+      File.join(db_dir, 'mailcatcher.db')
+    else
+      # Use in-memory database
+      ':memory:'
+    end
+  end
+
   def add_message(message)
     @add_message_query ||= db.prepare("INSERT INTO message (sender, recipients, subject, source, type, size, created_at) VALUES (?, ?, ?, ?, ?, ?, datetime('now'))")
 
@@ -311,7 +341,10 @@ module MailCatcher::Mail extend self
 
   def delete!
     @delete_all_messages_query ||= db.prepare "DELETE FROM message"
+    @delete_all_transcripts_query ||= db.prepare "DELETE FROM smtp_transcript"
+
     @delete_all_messages_query.execute
+    @delete_all_transcripts_query.execute
 
     EventMachine.next_tick do
       MailCatcher::Bus.push(type: "clear")
@@ -438,7 +471,7 @@ module MailCatcher::Mail extend self
 
   def message_transcript(message_id)
     @message_transcript_query ||= db.prepare(<<-SQL)
-      SELECT id, session_id, client_ip, client_port,
+      SELECT id, message_id, session_id, client_ip, client_port,
              server_ip, server_port, tls_enabled, tls_protocol,
              tls_cipher, connection_started_at, connection_ended_at,
              entries, created_at
@@ -470,6 +503,60 @@ module MailCatcher::Mail extend self
     end
   end
 
+  def all_transcript_entries
+    @all_transcript_entries_query ||= db.prepare(<<-SQL)
+      SELECT id, message_id, session_id, client_ip, client_port,
+             server_ip, server_port, tls_enabled, tls_protocol,
+             tls_cipher, connection_started_at, connection_ended_at,
+             entries, created_at
+      FROM smtp_transcript
+      ORDER BY created_at DESC
+    SQL
+
+    @all_transcript_entries_query.execute.map do |row|
+      result = Hash[@all_transcript_entries_query.columns.zip(row)]
+      result['entries'] = JSON.parse(result['entries']) if result['entries']
+      result['tls_enabled'] = result['tls_enabled'] == 1
+      result
+    end
+  end
+
+  def create_websocket_connection(session_id, client_ip)
+    @create_ws_connection_query ||= db.prepare(<<-SQL)
+      INSERT INTO websocket_connection (session_id, client_ip, opened_at, created_at, updated_at)
+      VALUES (?, ?, datetime('now'), datetime('now'), datetime('now'))
+    SQL
+    @create_ws_connection_query.execute(session_id, client_ip)
+    db.last_insert_row_id
+  end
+
+  def close_websocket_connection(session_id)
+    @close_ws_connection_query ||= db.prepare(<<-SQL)
+      UPDATE websocket_connection
+      SET closed_at = datetime('now'), updated_at = datetime('now')
+      WHERE session_id = ? AND closed_at IS NULL
+    SQL
+    @close_ws_connection_query.execute(session_id)
+  end
+
+  def record_websocket_ping(session_id)
+    @record_ping_query ||= db.prepare(<<-SQL)
+      UPDATE websocket_connection
+      SET last_ping_at = datetime('now'), ping_count = ping_count + 1, updated_at = datetime('now')
+      WHERE session_id = ? AND closed_at IS NULL
+    SQL
+    @record_ping_query.execute(session_id)
+  end
+
+  def record_websocket_pong(session_id)
+    @record_pong_query ||= db.prepare(<<-SQL)
+      UPDATE websocket_connection
+      SET last_pong_at = datetime('now'), pong_count = pong_count + 1, updated_at = datetime('now')
+      WHERE session_id = ? AND closed_at IS NULL
+    SQL
+    @record_pong_query.execute(session_id)
+  end
+
   private
 
   def parse_authentication_results(auth_header)

data/lib/mail_catcher/smtp.rb

@@ -18,6 +18,7 @@ class MailCatcher::Smtp < EventMachine::Protocols::SmtpServer
     @session_id = SecureRandom.uuid
     @connection_started_at = Time.now
     @data_started = false
+    @last_message_id = nil
     super
   end
 
@@ -58,8 +59,9 @@ class MailCatcher::Smtp < EventMachine::Protocols::SmtpServer
     @connection_ended_at = Time.now
     log_transcript('connection', 'server', "Connection closed")
 
-    # Save transcript even if no message was completed
-    save_transcript(nil) if @transcript_entries.any?
+    # Save transcript with the last message if available, otherwise without message_id
+    # This ensures "Connection closed" is included in the transcript
+    save_transcript(@last_message_id) if @transcript_entries.any?
 
     super
   end
@@ -205,6 +207,7 @@ class MailCatcher::Smtp < EventMachine::Protocols::SmtpServer
 
     begin
       message_id = MailCatcher::Mail.add_message current_message
+      @last_message_id = message_id
     rescue => e
       $stderr.puts "Error in add_message: #{e.message}"
       $stderr.puts e.backtrace.join("\n")
@@ -213,16 +216,15 @@ class MailCatcher::Smtp < EventMachine::Protocols::SmtpServer
 
     MailCatcher::Mail.delete_older_messages!
 
-    # Save transcript linked to message
-    save_transcript(message_id)
+    # Don't save transcript here - save it when connection closes (in unbind)
+    # This ensures "Connection closed" entry is included
 
     true
   rescue => exception
     log_transcript('error', 'server', "Exception: #{exception.class} - #{exception.message}")
     MailCatcher.log_exception("Error receiving message", @current_message, exception)
 
-    # Save transcript even on error
-    save_transcript(nil)
+    # Don't save transcript here - save it when connection closes (in unbind)
 
     false
   ensure

data/lib/mail_catcher/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MailCatcher
-  VERSION = '1.3.2'
+  VERSION = '1.4.6'
 end

data/lib/mail_catcher/web/application.rb

@@ -73,6 +73,13 @@ module MailCatcher
         erb :websocket_test
       end
 
+      get "/version.json" do
+        content_type :json
+        JSON.generate({
+          version: MailCatcher::VERSION
+        })
+      end
+
       get "/server-info" do
         @version = MailCatcher::VERSION
         @smtp_ip = MailCatcher.options[:smtp_ip]
@@ -101,9 +108,39 @@ module MailCatcher
           @fqdn = fqdn
         end
 
+        # Fetch all SMTP transcripts and flatten entries for display
+        transcripts = Mail.all_transcript_entries
+        @log_entries = transcripts.flat_map do |transcript|
+          transcript['entries'].map do |entry|
+            entry.merge({
+              'session_id' => transcript['session_id'],
+              'client_ip' => transcript['client_ip'],
+              'server_port' => transcript['server_port'],
+              'tls_enabled' => transcript['tls_enabled']
+            })
+          end
+        end.sort_by { |e| e['timestamp'] }
+
         erb :server_info
       end
 
+      get "/logs.json" do
+        content_type :json
+        transcripts = Mail.all_transcript_entries
+        log_entries = transcripts.flat_map do |transcript|
+          transcript['entries'].map do |entry|
+            entry.merge({
+              'session_id' => transcript['session_id'],
+              'client_ip' => transcript['client_ip'],
+              'server_port' => transcript['server_port'],
+              'tls_enabled' => transcript['tls_enabled']
+            })
+          end
+        end.sort_by { |e| e['timestamp'] }
+
+        JSON.generate(entries: log_entries)
+      end
+
       delete "/" do
         if MailCatcher.quittable?
           MailCatcher.quit!
@@ -116,11 +153,16 @@ module MailCatcher
       get "/messages" do
         if request.websocket?
           bus_subscription = nil
+          ping_timer = nil
+          session_id = SecureRandom.uuid
+          client_ip = request.ip
 
           ws = Faye::WebSocket.new(request.env)
 
           ws.on(:open) do |_|
-            $stderr.puts "[WebSocket] Connection opened"
+            $stderr.puts "[WebSocket] Connection opened (session: #{session_id}, ip: #{client_ip})"
+            MailCatcher::Mail.create_websocket_connection(session_id, client_ip)
+
             bus_subscription = MailCatcher::Bus.subscribe do |message|
               begin
                 $stderr.puts "[WebSocket] Sending message: #{message.inspect}"
@@ -130,15 +172,41 @@ module MailCatcher
                 MailCatcher.log_exception("Error sending message through websocket", message, exception)
               end
             end
+
+            # Send initial ping and set up periodic ping timer (every 30 seconds)
+            ping_interval = 30
+            ping_timer = EventMachine.add_periodic_timer(ping_interval) do
+              begin
+                $stderr.puts "[WebSocket] Sending ping (session: #{session_id})"
+                MailCatcher::Mail.record_websocket_ping(session_id)
+                ws.send(JSON.generate({ type: "ping" }))
+              rescue => exception
+                $stderr.puts "[WebSocket] Error sending ping: #{exception.message}"
+              end
+            end
+          end
+
+          ws.on(:message) do |event|
+            begin
+              data = JSON.parse(event.data)
+              if data["type"] == "pong"
+                $stderr.puts "[WebSocket] Received pong (session: #{session_id})"
+                MailCatcher::Mail.record_websocket_pong(session_id)
+              end
+            rescue => exception
+              $stderr.puts "[WebSocket] Error processing message: #{exception.message}"
+            end
           end
 
           ws.on(:close) do |_|
-            $stderr.puts "[WebSocket] Connection closed"
+            $stderr.puts "[WebSocket] Connection closed (session: #{session_id})"
+            EventMachine.cancel_timer(ping_timer) if ping_timer
             MailCatcher::Bus.unsubscribe(bus_subscription) if bus_subscription
+            MailCatcher::Mail.close_websocket_connection(session_id)
           end
 
           ws.on(:error) do |event|
-            $stderr.puts "[WebSocket] WebSocket error: #{event}"
+            $stderr.puts "[WebSocket] WebSocket error: #{event} (session: #{session_id})"
           end
 
           ws.rack_response

data/lib/mail_catcher.rb

@@ -85,6 +85,7 @@ module MailCatcher
     http_port: '1080',
     http_path: '/',
     messages_limit: nil,
+    persistence: false,
     verbose: false,
     daemon: !windows?,
     browse: false,
@@ -109,7 +110,7 @@ module MailCatcher
         parser.banner = 'Usage: mailcatcher [options]'
         parser.version = VERSION
         parser.separator ''
-        parser.separator "MailCatcher v#{VERSION}"
+        parser.separator "MailCatcher NG v#{VERSION}"
         parser.separator ''
 
         parser.on('--ip IP', 'Set the ip address of both servers') do |ip|
@@ -157,6 +158,10 @@ module MailCatcher
           options[:messages_limit] = count
         end
 
+        parser.on('--persistence', 'Store messages in a persistent SQLite database file') do
+          options[:persistence] = true
+        end
+
         parser.on('--http-path PATH', String, 'Add a prefix to all HTTP paths') do |path|
           clean_path = Rack::Utils.clean_path_info("/#{path}")
 
@@ -342,15 +347,15 @@ module MailCatcher
 
     # Configure the STARTTLS Smtp class
     Smtp.class_variable_set(:@@parms, {
-      starttls: :required,
-      starttls_options: ssl_options
-    })
+                              starttls: :required,
+                              starttls_options: ssl_options
+                            })
 
     # Configure the Direct TLS SmtpTls class
     SmtpTls.class_variable_set(:@@parms, {
-      starttls: :required,
-      starttls_options: ssl_options
-    })
+                                 starttls: :required,
+                                 starttls_options: ssl_options
+                               })
 
     @ssl_options = ssl_options
   end

data/public/assets/atom-one-light.min.css

@@ -1 +1 @@
-pre code.hljs{display:block;overflow-x:auto;padding:1em}code.hljs{padding:3px 5px}.hljs{color:#383a42;background:#fafafa}.hljs-comment,.hljs-quote{color:#a0a1a7;font-style:italic}.hljs-doctag,.hljs-formula,.hljs-keyword{color:#a626a4}.hljs-deletion,.hljs-name,.hljs-section,.hljs-selector-tag,.hljs-subst{color:#e45649}.hljs-literal{color:#0184bb}.hljs-addition,.hljs-attribute,.hljs-meta .hljs-string,.hljs-regexp,.hljs-string{color:#50a14f}.hljs-attr,.hljs-number,.hljs-selector-attr,.hljs-selector-class,.hljs-selector-pseudo,.hljs-template-variable,.hljs-type,.hljs-variable{color:#986801}.hljs-bullet,.hljs-link,.hljs-meta,.hljs-selector-id,.hljs-symbol,.hljs-title{color:#4078f2}.hljs-built_in,.hljs-class .hljs-title,.hljs-title.class_{color:#c18401}.hljs-emphasis{font-style:italic}.hljs-strong{font-weight:700}.hljs-link{text-decoration:underline}
+pre code.hljs{display:block;overflow-x:auto;padding:1em}code.hljs{padding:3px 5px}.hljs{color:#383a42;background:#fafafa}.hljs-comment,.hljs-quote{color:#a0a1a7;font-style:italic}.hljs-doctag,.hljs-formula,.hljs-keyword{color:#a626a4}.hljs-deletion,.hljs-name,.hljs-section,.hljs-selector-tag,.hljs-subst{color:#e45649}.hljs-literal{color:#0184bb}.hljs-addition,.hljs-attribute,.hljs-meta .hljs-string,.hljs-regexp,.hljs-string{color:#50a14f}.hljs-attr,.hljs-number,.hljs-selector-attr,.hljs-selector-class,.hljs-selector-pseudo,.hljs-template-variable,.hljs-type,.hljs-variable{color:#986801}.hljs-bullet,.hljs-link,.hljs-meta,.hljs-selector-id,.hljs-symbol,.hljs-title{color:#4078f2}.hljs-built_in,.hljs-class .hljs-title,.hljs-title.class_{color:#c18401}.hljs-emphasis{font-style:italic}.hljs-strong{font-weight:700}.hljs-link{text-decoration:underline}

data/public/assets/favcount.js

@@ -0,0 +1,102 @@
+/*
+ * favcount.js v1.5.0
+ * http://chrishunt.co/favcount
+ * Dynamically updates the favicon with a number.
+ *
+ * Copyright 2013, Chris Hunt
+ * Released under the MIT license
+ */
+
+(function(){
+  function Favcount(icon) {
+    this.icon = icon;
+    this.opacity = 0.4;
+    this.canvas = document.createElement('canvas');
+    this.font = "Helvetica, Arial, sans-serif";
+  }
+
+  Favcount.prototype.set = function(count) {
+    var self = this,
+        img  = document.createElement('img');
+
+    if (self.canvas.getContext) {
+      img.crossOrigin = "anonymous";
+
+      img.onload = function() {
+        drawCanvas(self.canvas, self.opacity, self.font, img, normalize(count));
+      };
+
+      img.src = this.icon;
+    }
+  };
+
+  function normalize(count) {
+    count = Math.round(count);
+
+    if (isNaN(count) || count < 1) {
+      return '';
+    } else if (count < 10) {
+      return ' ' + count;
+    } else if (count > 99) {
+      return '99';
+    } else {
+      return count;
+    }
+  }
+
+  function drawCanvas(canvas, opacity, font, img, count) {
+    var head = document.getElementsByTagName('head')[0],
+        favicon = document.createElement('link'),
+        multiplier, fontSize, context, xOffset, yOffset, border, shadow;
+
+    favicon.rel = 'icon';
+
+    // Scale canvas elements based on favicon size
+    multiplier = img.width / 16;
+    fontSize   = multiplier * 11;
+    xOffset    = multiplier;
+    yOffset    = multiplier * 11;
+    border     = multiplier;
+    shadow     = multiplier * 2;
+
+    canvas.height = canvas.width = img.width;
+    context = canvas.getContext('2d');
+    context.font = 'bold ' + fontSize + 'px ' + font;
+
+    // Draw faded favicon background
+    if (count) { context.globalAlpha = opacity; }
+    context.drawImage(img, 0, 0);
+    context.globalAlpha = 1.0;
+
+    // Draw white drop shadow
+    context.shadowColor = '#FFF';
+    context.shadowBlur = shadow;
+    context.shadowOffsetX = 0;
+    context.shadowOffsetY = 0;
+
+    // Draw white border
+    context.fillStyle = '#FFF';
+    context.fillText(count, xOffset, yOffset);
+    context.fillText(count, xOffset + border, yOffset);
+    context.fillText(count, xOffset, yOffset + border);
+    context.fillText(count, xOffset + border, yOffset + border);
+
+    // Draw black count
+    context.fillStyle = '#000';
+    context.fillText(count,
+      xOffset + (border / 2.0),
+      yOffset + (border / 2.0)
+    );
+
+    // Replace favicon with new favicon
+    favicon.href = canvas.toDataURL('image/png');
+    head.removeChild(document.querySelector('link[rel=icon]'));
+    head.appendChild(favicon);
+  }
+
+  this.Favcount = Favcount;
+}).call(this);
+
+(function(){
+  Favcount.VERSION = '1.5.0';
+}).call(this);