Haraka 3.1.0 → 3.1.2

package/plugins/process_title.js

@@ -1,200 +1,197 @@
 // process_title
 
-const outbound = require('./outbound');
+const outbound = require('./outbound')
 
-function setupInterval (title, server) {
+function setupInterval(title, server) {
     // Set up a timer to update title
     return setInterval(() => {
         // Connections per second
-        const av_cps = Math.round((server.notes.pt_connections/process.uptime()*100))/100;
-        const cps = server.notes.pt_connections - server.notes.pt_cps_diff;
-        if (cps > server.notes.pt_cps_max) server.notes.pt_cps_max = cps;
-        server.notes.pt_cps_diff = server.notes.pt_connections;
+        const av_cps = Math.round((server.notes.pt_connections / process.uptime()) * 100) / 100
+        const cps = server.notes.pt_connections - server.notes.pt_cps_diff
+        if (cps > server.notes.pt_cps_max) server.notes.pt_cps_max = cps
+        server.notes.pt_cps_diff = server.notes.pt_connections
         // Recipients per second
-        const av_rps = Math.round((server.notes.pt_recipients/process.uptime()*100))/100;
-        const rps = server.notes.pt_recipients - server.notes.pt_rps_diff;
-        if (rps > server.notes.pt_rps_max) server.notes.pt_rps_max = rps;
-        server.notes.pt_rps_diff = server.notes.pt_recipients;
+        const av_rps = Math.round((server.notes.pt_recipients / process.uptime()) * 100) / 100
+        const rps = server.notes.pt_recipients - server.notes.pt_rps_diff
+        if (rps > server.notes.pt_rps_max) server.notes.pt_rps_max = rps
+        server.notes.pt_rps_diff = server.notes.pt_recipients
         // Recipients per message
-        const rpm = Math.round((server.notes.pt_recipients / server.notes.pt_messages)*100)/100 || 0;
+        const rpm = Math.round((server.notes.pt_recipients / server.notes.pt_messages) * 100) / 100 || 0
         // Messages per second
-        const av_mps = Math.round((server.notes.pt_messages/process.uptime()*100))/100;
-        const mps = server.notes.pt_messages - server.notes.pt_mps_diff;
-        if (mps > server.notes.pt_mps_max) server.notes.pt_mps_max = mps;
-        server.notes.pt_mps_diff = server.notes.pt_messages;
+        const av_mps = Math.round((server.notes.pt_messages / process.uptime()) * 100) / 100
+        const mps = server.notes.pt_messages - server.notes.pt_mps_diff
+        if (mps > server.notes.pt_mps_max) server.notes.pt_mps_max = mps
+        server.notes.pt_mps_diff = server.notes.pt_messages
         // Messages per connection
-        const mpc = Math.round((server.notes.pt_messages / server.notes.pt_connections)*100)/100 || 0;
+        const mpc = Math.round((server.notes.pt_messages / server.notes.pt_connections) * 100) / 100 || 0
 
-        const out = server.notes.pt_out_stats || outbound.get_stats();
+        const out = server.notes.pt_out_stats || outbound.get_stats()
         if (/\(worker\)/.test(title)) {
-            process.send({event: 'process_title.outbound_stats', data: out});
+            process.send({ event: 'process_title.outbound_stats', data: out })
         }
         // Update title
-        let new_title = `${title} cn=${server.notes.pt_connections} cc=${server.notes.pt_concurrent
-        } cps=${cps}/${av_cps}/${server.notes.pt_cps_max} rcpts=${server.notes.pt_recipients}/${rpm
-        } rps=${rps}/${av_rps}/${server.notes.pt_rps_max} msgs=${server.notes.pt_messages}/${mpc
-        } mps=${mps}/${av_mps}/${server.notes.pt_mps_max} out=${out} `;
+        let new_title = `${title} cn=${server.notes.pt_connections} cc=${server.notes.pt_concurrent} cps=${cps}/${av_cps}/${server.notes.pt_cps_max} rcpts=${server.notes.pt_recipients}/${rpm} rps=${rps}/${av_rps}/${server.notes.pt_rps_max} msgs=${server.notes.pt_messages}/${mpc} mps=${mps}/${av_mps}/${server.notes.pt_mps_max} out=${out} `
         if (/\(master\)/.test(title)) {
-            new_title += `respawn=${server.notes.pt_child_exits} `;
+            new_title += `respawn=${server.notes.pt_child_exits} `
         }
-        process.title = new_title;
-    }, 1000);
+        process.title = new_title
+    }, 1000)
 }
 
 exports.hook_init_master = function (next, server) {
-    server.notes.pt_connections = 0;
-    server.notes.pt_concurrent = 0;
-    server.notes.pt_cps_diff = 0;
-    server.notes.pt_cps_max = 0;
-    server.notes.pt_recipients = 0;
-    server.notes.pt_rps_diff = 0;
-    server.notes.pt_rps_max = 0;
-    server.notes.pt_messages = 0;
-    server.notes.pt_mps_diff = 0;
-    server.notes.pt_mps_max = 0;
-    server.notes.pt_child_exits = 0;
-    let title = 'Haraka';
+    server.notes.pt_connections = 0
+    server.notes.pt_concurrent = 0
+    server.notes.pt_cps_diff = 0
+    server.notes.pt_cps_max = 0
+    server.notes.pt_recipients = 0
+    server.notes.pt_rps_diff = 0
+    server.notes.pt_rps_max = 0
+    server.notes.pt_messages = 0
+    server.notes.pt_mps_diff = 0
+    server.notes.pt_mps_max = 0
+    server.notes.pt_child_exits = 0
+    let title = 'Haraka'
     if (server.cluster) {
-        title = 'Haraka (master)';
-        process.title = title;
-        server.notes.pt_concurrent_cluster = {};
-        server.notes.pt_new_out_stats = [0,0,0,0];
-        const { cluster } = server;
-        const recvMsg = msg => {
-            let count;
+        title = 'Haraka (master)'
+        process.title = title
+        server.notes.pt_concurrent_cluster = {}
+        server.notes.pt_new_out_stats = [0, 0, 0, 0]
+        const { cluster } = server
+        const recvMsg = (msg) => {
+            let count
             switch (msg.event) {
                 case 'process_title.connect':
-                    server.notes.pt_connections++;
-                    server.notes.pt_concurrent_cluster[msg.wid]++;
-                    count = 0;
-                    Object.keys(server.notes.pt_concurrent_cluster).forEach(id => {
-                        count += server.notes.pt_concurrent_cluster[id];
-                    });
-                    server.notes.pt_concurrent = count;
-                    break;
+                    server.notes.pt_connections++
+                    server.notes.pt_concurrent_cluster[msg.wid]++
+                    count = 0
+                    Object.keys(server.notes.pt_concurrent_cluster).forEach((id) => {
+                        count += server.notes.pt_concurrent_cluster[id]
+                    })
+                    server.notes.pt_concurrent = count
+                    break
                 case 'process_title.disconnect':
-                    server.notes.pt_concurrent_cluster[msg.wid]--;
-                    count = 0;
-                    Object.keys(server.notes.pt_concurrent_cluster).forEach(id => {
-                        count += server.notes.pt_concurrent_cluster[id];
-                    });
-                    server.notes.pt_concurrent = count;
-                    break;
+                    server.notes.pt_concurrent_cluster[msg.wid]--
+                    count = 0
+                    Object.keys(server.notes.pt_concurrent_cluster).forEach((id) => {
+                        count += server.notes.pt_concurrent_cluster[id]
+                    })
+                    server.notes.pt_concurrent = count
+                    break
                 case 'process_title.recipient':
-                    server.notes.pt_recipients++;
-                    break;
+                    server.notes.pt_recipients++
+                    break
                 case 'process_title.message':
-                    server.notes.pt_messages++;
-                    break;
+                    server.notes.pt_messages++
+                    break
                 case 'process_title.outbound_stats': {
-                    const out_stats = msg.data.split('/');
-                    for (let i=0; i<out_stats.length; i++) {
-                        server.notes.pt_new_out_stats[i] += parseInt(out_stats[i], 10);
+                    const out_stats = msg.data.split('/')
+                    for (let i = 0; i < out_stats.length; i++) {
+                        server.notes.pt_new_out_stats[i] += parseInt(out_stats[i], 10)
                     }
-                    server.notes.pt_new_out_stats[3]++;
+                    server.notes.pt_new_out_stats[3]++
                     // Check if we got all results back yet
                     if (server.notes.pt_new_out_stats[3] === Object.keys(cluster.workers).length) {
-                        server.notes.pt_out_stats = server.notes.pt_new_out_stats.slice(0,3).join('/');
-                        server.notes.pt_new_out_stats = [0,0,0,0];
+                        server.notes.pt_out_stats = server.notes.pt_new_out_stats.slice(0, 3).join('/')
+                        server.notes.pt_new_out_stats = [0, 0, 0, 0]
                     }
                 }
                 // fall through
                 default:
-                    // Unknown message
+                // Unknown message
             }
-        };
+        }
         // Register any new workers
-        cluster.on('fork', worker => {
-            server.notes.pt_concurrent_cluster[worker.id] = 0;
-            cluster.workers[worker.id].on('message', recvMsg);
-        });
-        cluster.on('exit', worker => {
-            delete server.notes.pt_concurrent_cluster[worker.id];
+        cluster.on('fork', (worker) => {
+            server.notes.pt_concurrent_cluster[worker.id] = 0
+            cluster.workers[worker.id].on('message', recvMsg)
+        })
+        cluster.on('exit', (worker) => {
+            delete server.notes.pt_concurrent_cluster[worker.id]
             // Update concurrency
-            let count = 0;
-            Object.keys(server.notes.pt_concurrent_cluster).forEach(id => {
-                count += server.notes.pt_concurrent_cluster[id];
-            });
-            server.notes.pt_concurrent = count;
-            server.notes.pt_child_exits++;
-        });
+            let count = 0
+            Object.keys(server.notes.pt_concurrent_cluster).forEach((id) => {
+                count += server.notes.pt_concurrent_cluster[id]
+            })
+            server.notes.pt_concurrent = count
+            server.notes.pt_child_exits++
+        })
     }
-    this._interval = setupInterval(title, server);
-    next();
+    this._interval = setupInterval(title, server)
+    next()
 }
 
 exports.hook_init_child = function (next, server) {
-    server.notes.pt_connections = 0;
-    server.notes.pt_concurrent = 0;
-    server.notes.pt_cps_diff = 0;
-    server.notes.pt_cps_max = 0;
-    server.notes.pt_recipients = 0;
-    server.notes.pt_rps_diff = 0;
-    server.notes.pt_rps_max = 0;
-    server.notes.pt_messages = 0;
-    server.notes.pt_mps_diff = 0;
-    server.notes.pt_mps_max = 0;
-    process.title = 'Haraka (worker)';
-    this._interval = setupInterval(process.title, server);
-    next();
+    server.notes.pt_connections = 0
+    server.notes.pt_concurrent = 0
+    server.notes.pt_cps_diff = 0
+    server.notes.pt_cps_max = 0
+    server.notes.pt_recipients = 0
+    server.notes.pt_rps_diff = 0
+    server.notes.pt_rps_max = 0
+    server.notes.pt_messages = 0
+    server.notes.pt_mps_diff = 0
+    server.notes.pt_mps_max = 0
+    process.title = 'Haraka (worker)'
+    this._interval = setupInterval(process.title, server)
+    next()
 }
 
 exports.shutdown = function () {
-    this.logdebug(`Shutting down interval: ${this._interval}`);
-    clearInterval(this._interval);
+    this.logdebug(`Shutting down interval: ${this._interval}`)
+    clearInterval(this._interval)
 }
 
 exports.hook_connect_init = (next, connection) => {
-    const { server } = connection;
-    connection.notes.pt_connect_run = true;
+    const { server } = connection
+    connection.notes.pt_connect_run = true
     if (server.cluster) {
-        const { worker } = server.cluster;
-        worker.send({event: 'process_title.connect', wid: worker.id});
+        const { worker } = server.cluster
+        worker.send({ event: 'process_title.connect', wid: worker.id })
     }
-    server.notes.pt_connections++;
-    server.notes.pt_concurrent++;
-    next();
+    server.notes.pt_connections++
+    server.notes.pt_concurrent++
+    next()
 }
 
 exports.hook_disconnect = (next, connection) => {
-    const { server } = connection;
+    const { server } = connection
     // Check that the hook above ran
     // It might not if the disconnection is immediate
     // echo "QUIT" | nc localhost 25
     // will exhibit this behaviour.
-    let worker;
+    let worker
     if (!connection.notes.pt_connect_run) {
         if (server.cluster) {
-            worker = server.cluster.worker;
-            worker.send({event: 'process_title.connect', wid: worker.id});
+            worker = server.cluster.worker
+            worker.send({ event: 'process_title.connect', wid: worker.id })
         }
-        server.notes.pt_connections++;
-        server.notes.pt_concurrent++;
+        server.notes.pt_connections++
+        server.notes.pt_concurrent++
     }
     if (server.cluster) {
-        worker = server.cluster.worker;
-        worker.send({event: 'process_title.disconnect', wid: worker.id});
+        worker = server.cluster.worker
+        worker.send({ event: 'process_title.disconnect', wid: worker.id })
     }
-    server.notes.pt_concurrent--;
-    next();
+    server.notes.pt_concurrent--
+    next()
 }
 
 exports.hook_rcpt = (next, connection) => {
-    const { server } = connection;
+    const { server } = connection
     if (server.cluster) {
-        const { worker } = server.cluster;
-        worker.send({event: 'process_title.recipient'});
+        const { worker } = server.cluster
+        worker.send({ event: 'process_title.recipient' })
     }
-    server.notes.pt_recipients++;
-    next();
+    server.notes.pt_recipients++
+    next()
 }
 
 exports.hook_data = (next, connection) => {
-    const { server } = connection;
+    const { server } = connection
     if (server.cluster) {
-        const { worker } = server.cluster;
-        worker.send({event: 'process_title.message'});
+        const { worker } = server.cluster
+        worker.send({ event: 'process_title.message' })
     }
-    server.notes.pt_messages++;
-    next();
+    server.notes.pt_messages++
+    next()
 }

package/plugins/profile.js

@@ -1,11 +1,11 @@
-const prof = require('v8-profiler');
+const prof = require('v8-profiler')
 
 exports.hook_connect_init = (next, conn) => {
-    prof.startProfiling(`Connection from: ${conn.remote.ip}`);
-    next();
+    prof.startProfiling(`Connection from: ${conn.remote.ip}`)
+    next()
 }
 
 exports.hook_disconnect = (next, conn) => {
-    prof.stopProfiling(`Connection from: ${conn.remote.ip}`);
-    next();
+    prof.stopProfiling(`Connection from: ${conn.remote.ip}`)
+    next()
 }

package/plugins/queue/deliver.js

@@ -2,11 +2,11 @@
 // automatically just like this. It is kept here for backwards compatibility
 // purposes only.
 
-const outbound = require('./outbound');
+const outbound = require('./outbound')
 
 exports.hook_queue_outbound = (next, connection) => {
     // if not relaying, don't deliver outbound
-    if (!connection?.relaying) return next();
+    if (!connection?.relaying) return next()
 
-    outbound.send_trans_email(connection?.transaction, next);
+    outbound.send_trans_email(connection?.transaction, next)
 }

package/plugins/queue/discard.js

@@ -1,28 +1,27 @@
 // discard
 
 exports.register = function () {
-    this.register_hook('queue',          'discard');
-    this.register_hook('queue_outbound', 'discard');
+    this.register_hook('queue', 'discard')
+    this.register_hook('queue_outbound', 'discard')
 }
 
 exports.discard = (next, connection) => {
+    const txn = connection.transaction
 
-    const txn = connection.transaction;
+    const q_wants = txn.notes.get('queue.wants')
+    if (q_wants && q_wants !== 'discard') return next()
 
-    const q_wants = txn.notes.get('queue.wants');
-    if (q_wants && q_wants !== 'discard') return next();
-
-    function discard () {
-        connection.loginfo('discarding message');
+    function discard() {
+        connection.loginfo('discarding message')
         // Pretend we delivered the message
-        return next(OK);
+        return next(OK)
     }
 
-    if (connection.notes.discard)          return discard();
-    if (txn.notes.discard)                 return discard();
-    if (q_wants === 'discard')             return discard();
-    if (process.env.YES_REALLY_DO_DISCARD) return discard();
+    if (connection.notes.discard) return discard()
+    if (txn.notes.discard) return discard()
+    if (q_wants === 'discard') return discard()
+    if (process.env.YES_REALLY_DO_DISCARD) return discard()
 
     // Allow other queue plugins to deliver
-    next();
+    next()
 }

package/plugins/queue/lmtp.js

@@ -1,46 +1,45 @@
 //queue/lmtp
 
-'use strict';
+'use strict'
 
-let outbound;
+let outbound
 
 exports.register = function () {
-    this.load_lmtp_ini();
-    outbound = this.haraka_require('outbound');
+    this.load_lmtp_ini()
+    outbound = this.haraka_require('outbound')
 }
 
 exports.load_lmtp_ini = function () {
     this.cfg = this.config.get('lmtp.ini', () => {
-        this.load_lmtp_ini();
+        this.load_lmtp_ini()
     })
 }
 
 exports.hook_get_mx = function (next, hmail, domain) {
+    if (!hmail.todo.notes.using_lmtp) return next()
 
-    if (!hmail.todo.notes.using_lmtp) return next();
-
-    const section = this.cfg[domain] || this.cfg.main;
+    const section = this.cfg[domain] || this.cfg.main
 
     const mx = {
         using_lmtp: true,
         priority: 0,
         exchange: section.host ?? '127.0.0.1',
         port: section.port ?? 24,
-    };
+    }
 
-    if (section.path) mx.path = section.path;
+    if (section.path) mx.path = section.path
 
-    next(OK, mx);
+    next(OK, mx)
 }
 
 exports.hook_queue = (next, connection) => {
-    const txn = connection?.transaction;
-    if (!txn) return next();
+    const txn = connection?.transaction
+    if (!txn) return next()
 
-    const q_wants = txn.notes.get('queue.wants');
+    const q_wants = txn.notes.get('queue.wants')
 
-    if (q_wants && q_wants !== 'lmtp') return next();
+    if (q_wants && q_wants !== 'lmtp') return next()
 
-    txn.notes.using_lmtp = true;
-    outbound.send_trans_email(txn, next);
+    txn.notes.using_lmtp = true
+    outbound.send_trans_email(txn, next)
 }

package/plugins/queue/qmail-queue.js

@@ -1,98 +1,97 @@
 // Queue to qmail-queue
 
-const childproc = require('node:child_process');
-const fs        = require('node:fs');
+const childproc = require('node:child_process')
+const fs = require('node:fs')
 
 exports.register = function () {
-
-    this.queue_exec = this.config.get('qmail-queue.path') || '/var/qmail/bin/qmail-queue';
+    this.queue_exec = this.config.get('qmail-queue.path') || '/var/qmail/bin/qmail-queue'
     if (!fs.existsSync(this.queue_exec)) {
-        throw new Error(`Cannot find qmail-queue binary (${this.queue_exec})`);
+        throw new Error(`Cannot find qmail-queue binary (${this.queue_exec})`)
     }
 
-    this.load_qmail_queue_ini();
+    this.load_qmail_queue_ini()
 
     if (this.cfg.main.enable_outbound) {
-        this.register_hook('queue_outbound', 'hook_queue');
+        this.register_hook('queue_outbound', 'hook_queue')
     }
 }
 
 exports.load_qmail_queue_ini = function () {
-
-    this.cfg = this.config.get('qmail-queue.ini', {
-        booleans: [
-            '+main.enable_outbound',
-        ],
-    },
-    () => {
-        this.load_qmail_queue_ini();
-    });
+    this.cfg = this.config.get(
+        'qmail-queue.ini',
+        {
+            booleans: ['+main.enable_outbound'],
+        },
+        () => {
+            this.load_qmail_queue_ini()
+        },
+    )
 }
 
 exports.hook_queue = function (next, connection) {
-    const plugin = this;
+    const plugin = this
 
-    const txn = connection?.transaction;
-    if (!txn) return next();
+    const txn = connection?.transaction
+    if (!txn) return next()
 
-    const q_wants = txn.notes.get('queue.wants');
-    if (q_wants && q_wants !== 'qmail-queue') return next();
+    const q_wants = txn.notes.get('queue.wants')
+    if (q_wants && q_wants !== 'qmail-queue') return next()
 
     const qmail_queue = childproc.spawn(
         this.queue_exec, // process name
-        [],              // arguments
-        { stdio: ['pipe', 'pipe', process.stderr] }
-    );
+        [], // arguments
+        { stdio: ['pipe', 'pipe', process.stderr] },
+    )
 
-    qmail_queue.on('exit', function finished (code) {
+    qmail_queue.on('exit', function finished(code) {
         if (code !== 0) {
-            connection.logerror(plugin, `Unable to queue message to qmail-queue: ${code}`);
-            next();
+            connection.logerror(plugin, `Unable to queue message to qmail-queue: ${code}`)
+            next()
+        } else {
+            next(OK, 'Queued!')
         }
-        else {
-            next(OK, "Queued!");
-        }
-    });
+    })
 
-    connection.transaction.message_stream.pipe(qmail_queue.stdin, { line_endings: '\n' });
+    connection.transaction.message_stream.pipe(qmail_queue.stdin, {
+        line_endings: '\n',
+    })
 
     qmail_queue.stdin.on('close', () => {
         if (!connection?.transaction) {
-            plugin.logerror("Transaction went away while delivering mail to qmail-queue");
+            plugin.logerror('Transaction went away while delivering mail to qmail-queue')
             try {
-                qmail_queue.stdout.end();
-            }
-            catch (err) {
+                qmail_queue.stdout.end()
+            } catch (err) {
                 if (err.code !== 'ENOTCONN') {
                     // Ignore ENOTCONN and re throw anything else
                     throw err
                 }
             }
 
-            connection.results.add(plugin, { err: 'dead sender' });
-            return;
+            connection.results.add(plugin, { err: 'dead sender' })
+            return
         }
-        plugin.loginfo("Message Stream sent to qmail. Now sending envelope");
+        plugin.loginfo('Message Stream sent to qmail. Now sending envelope')
         // now send envelope
         // Hope this will be big enough...
-        const buf = Buffer.alloc(4096);
-        let p = 0;
-        buf[p++] = 70;
-        const mail_from = connection.transaction.mail_from.address();
+        const buf = Buffer.alloc(4096)
+        let p = 0
+        buf[p++] = 70
+        const mail_from = connection.transaction.mail_from.address()
         for (let i = 0; i < mail_from.length; i++) {
-            buf[p++] = mail_from.charCodeAt(i);
+            buf[p++] = mail_from.charCodeAt(i)
         }
-        buf[p++] = 0;
-        connection.transaction.rcpt_to.forEach(rcpt => {
-            buf[p++] = 84;
-            const rcpt_to = rcpt.address();
+        buf[p++] = 0
+        connection.transaction.rcpt_to.forEach((rcpt) => {
+            buf[p++] = 84
+            const rcpt_to = rcpt.address()
             for (let j = 0; j < rcpt_to.length; j++) {
-                buf[p++] = rcpt_to.charCodeAt(j);
+                buf[p++] = rcpt_to.charCodeAt(j)
             }
-            buf[p++] = 0;
-        });
-        buf[p++] = 0;
-        qmail_queue.stdout.on('error', err => {}); // stdout throws an error on close
-        qmail_queue.stdout.end(buf);
-    });
+            buf[p++] = 0
+        })
+        buf[p++] = 0
+        qmail_queue.stdout.on('error', (err) => {}) // stdout throws an error on close
+        qmail_queue.stdout.end(buf)
+    })
 }