net-snmp 3.9.1 → 3.9.3

package/README.md

@@ -655,7 +655,7 @@ for v1 and v2c.
 
 ## session.on ("close", callback)
 
-The `close` event is emitted by the session when the sessions underlying UDP
+The `close` event is emitted by the session when the session's underlying UDP
 socket is closed.
 
 No arguments are passed to the callback.
@@ -665,7 +665,7 @@ in the failure of each outstanding request.  The error passed back through to
 each request will be an instance of the `Error` class with the errors
 `message` attribute set to `Socket forcibly closed`.
 
-The following example prints a message to the console when a sessions
+The following example prints a message to the console when a session's
 underlying UDP socket is closed:
 
 ```js
@@ -676,7 +676,7 @@ session.on ("close", function () {
 
 ## session.on ("error", callback)
 
-The `error` event is emitted by the session when the sessions underlying UDP
+The `error` event is emitted by the session when the session's underlying UDP
 socket emits an error.
 
 The following arguments will be passed to the `callback` function:
@@ -685,7 +685,7 @@ The following arguments will be passed to the `callback` function:
    will contain a detailed error message.
 
 The following example prints a message to the console when an error occurs
-with a sessions underlying UDP socket, the session is then closed:
+with a session's underlying UDP socket, the session is then closed:
 
 ```js
 session.on ("error", function (error) {
@@ -2704,6 +2704,40 @@ Sends a "ping" to the master agent using a `Ping` PDU, to confirm that the maste
 responsive.  The supplied `callback` is called on reception of the subsequent
 `Response` PDU from the master to the `Ping` PDU.
 
+## subagent.on ("close", callback)
+
+The `close` event is emitted by the subagent when its underlying TCP socket is closed.
+
+No arguments are passed to the callback.
+
+The following example prints a message to the console when a subagent's
+underlying TCP socket is closed:
+
+```js
+subagent.on ("close", function () {
+    console.log ("Subagent socket closed");
+});
+```
+
+## subagent.on ("error", callback)
+
+The `error` event is emitted by the subagent when its underlying TCP socket emits an error.
+
+The following argument will be passed to the `callback` function:
+
+ * `error` - An instance of the `Error` class, the exposed `message` attribute
+   will contain a detailed error message.
+
+The following example prints a message to the console when an error occurs
+with a subagent's underlying TCP socket, and the subagent is then closed:
+
+```js
+subagent.on ("error", function (error) {
+    console.log (error.toString ());
+    subagent.close ();
+});
+```
+
 
 # Example Programs
 
@@ -3247,6 +3281,14 @@ Example programs are included under the module's `example` directory.
 
  * Fix MIB parsing of unclosed brackets in comments
 
+## Version 3.9.2 - 26/04/2023
+
+ * Fix MIB parsing of non-comments in descriptions and unmatched quotations
+
+## Version 3.9.3 - 28/04/2023
+
+ * Add AgentX subagent "error" and "close" events
+
 # License
 
 Copyright (c) 2020 Mark Abrahams <mark@abrahams.co.nz>

package/example/agentx-subagent.js

@@ -66,6 +66,9 @@ agent.open(function (error, data) {
         agent.registerProvider (tableProvider, null);
         agent.getMib ().addTableRow ("smallIfTable", [1, "lo", 24]);
         agent.getMib ().addTableRow ("smallIfTable", [2, "eth0", 6]);
+        agent.on("close", function() {
+            console.log ("Subagent socket closed");
+        });
     }
 });
 

package/index.js

@@ -5708,6 +5708,16 @@ var Subagent = function (options) {
 	this.setTransactions = {};
 };
 
+util.inherits (Subagent, events.EventEmitter);
+
+Subagent.prototype.onClose = function () {
+	this.emit ("close");
+};
+
+Subagent.prototype.onError = function (error) {
+	this.emit ("error", error);
+};
+
 Subagent.prototype.getMib = function () {
 	return this.mib;
 };
@@ -5720,9 +5730,8 @@ Subagent.prototype.connectSocket = function () {
 	});
 
 	this.socket.on ("data", me.onMsg.bind (me));
-	this.socket.on ("error", function (error) {
-		console.error (error);
-	});
+	this.socket.on ("error", me.onError.bind (me));
+	this.socket.on ("close", me.onClose.bind (me));
 };
 
 Subagent.prototype.open = function (callback) {

package/lib/mib.js

@@ -1,18 +1,9 @@
 var fs = require('fs');
 
 var MIB = function (dir) {
-    return ({
-        directory: dir ? dir : '',
-        SymbolBuffer: {},
-        StringBuffer: '',
-        Modules: {},
-        Objects: {},
-        MACROS: [],
-        CurrentObject: null,
-        TempObject: {},
-        CurrentClause: '',
-        WaitFor: '',
-        CharBuffer: {
+
+    var initializeBuffer = function (buffer) {
+        return Object.assign(buffer, {
             logit: false,
             lastChar: '',
             state: '',
@@ -27,11 +18,26 @@ var MIB = function (dir) {
             inComment: false,
             inGroup: 0,
             builder: '',
-            Table: {},
             ColumnIndex: 0,
             RowIndex: 0,
+            PreviousRow: 0
+        });
+    };
+
+    var newMIB = ({
+        directory: dir ? dir : '',
+        SymbolBuffer: {},
+        StringBuffer: '',
+        Modules: {},
+        Objects: {},
+        MACROS: [],
+        CurrentObject: null,
+        TempObject: {},
+        CurrentClause: '',
+        WaitFor: '',
+        CharBuffer: {
+            Table: {},
             ModuleName: {},
-            PreviousRow: 0,
             Append: function (char) {
                 this.builder += char;
             },
@@ -45,12 +51,7 @@ var MIB = function (dir) {
                 this.builder.length = 0;
                 if (!this.Table[FileName]) {
                     this.Table[FileName] = [];
-                }
-                if (row == 0) {
-                    this.RowIndex = 0;
-                    this.PreviousRow = 0;
-                }
-                if (this.PreviousRow < row) {
+                } else if (this.PreviousRow < row) {
                     this.RowIndex++;
                     this.ColumnIndex = 0;
                     this.PreviousRow = row;
@@ -60,7 +61,10 @@ var MIB = function (dir) {
                 var C = this.ColumnIndex;
 
                 if (!this.Table[FileName][R]) {
-                    this.Table[FileName][R] = [];
+                    this.Table[FileName][R] = Object.defineProperty([], "line", {
+                        enumerable: false,
+                        value: row + 1
+                    });
                 }
                 this.isEqual = false;
                 switch (symbol) {
@@ -128,8 +132,7 @@ var MIB = function (dir) {
             this.ParseModule(FileName.split('/')[FileName.split('/').length - 1].split('.')[0], fs.readFileSync(FileName).toString());
         },
         ParseModule: function (FileName, Contents) {
-            this.CharBuffer.RowIndex = 0;
-            this.CharBuffer.ColumnIndex = 0;
+            initializeBuffer(this.CharBuffer);
 
             var lines = Contents.split('\n');
             var line = '';
@@ -234,7 +237,7 @@ var MIB = function (dir) {
                     break;
                 case "-":
                     this.CharBuffer.Append(char);
-                    if (this.CharBuffer.lastChar == '-') {
+                    if (!this.CharBuffer.isString && this.CharBuffer.lastChar == '-') {
                         this.CharBuffer.isComment = true;
                         this.CharBuffer.builder = this.CharBuffer.builder.split('--')[0];
                         this.CharBuffer.Fill(FileName, row, column);
@@ -244,7 +247,7 @@ var MIB = function (dir) {
                     break;
                 case '"':
                     if (this.CharBuffer.isComment && !this.CharBuffer.isString && !this.CharBuffer.inComment) {
-                        //011 = COMMENT 
+                        //011 = COMMENT
                         //IF 011 SET 101
                         this.CharBuffer.isComment = true;
                         this.CharBuffer.isString = false;
@@ -289,18 +292,42 @@ var MIB = function (dir) {
             for (var FileName in Table) {
                 ModuleName = this.CharBuffer.ModuleName[FileName];
                 this.SymbolBuffer[ModuleName] = [];
-                for (var r = 0; r < Table[FileName].length; r++) {
-                    for (var c = 0; c < Table[FileName][r].length; c++) {
-                        var symbol = Table[FileName][r][c];
+                var foundTheEnd = false;
+                var lastGoodDeclaration = [ 'none' ];
+                var file = Table[FileName];
+                for (var r = 0; r < file.length; r++) {
+                    var row = file[r];
+                    for (var c = 0; c < row.length; c++) {
+                        var symbol = row[c];
+                        var addSymbol = true;
                         switch (symbol) {
+                            case 'END':
+                                foundTheEnd = true;
+                                break;
+                            case '::=':
+                                foundTheEnd = false;
+                                lastGoodDeclaration = row;
+                                break;
                             default:
-                                if (symbol.indexOf('--') != 0) {//REMOVE COMMENTS
+                                if (symbol.indexOf('--') == 0) {//REMOVE COMMENTS
                                     //console.log(ModuleName, symbol);
-                                    this.SymbolBuffer[ModuleName].push(symbol);
+                                    addSymbol = false;
+                                } else {
+                                    foundTheEnd = false;
                                 }
                         }
+                        if (addSymbol) {
+                            this.SymbolBuffer[ModuleName].push(symbol);
+                        }
                     }
                 }
+                if (!foundTheEnd) {
+                    // Warn that the contents are malformed
+                    console.warn(
+                        '[%s]: Incorrect formatting: no END statement found - last good declaration "%s" (line %s)',
+                        ModuleName, lastGoodDeclaration.join(' '), lastGoodDeclaration.line
+                    );
+                }
 
             }
             this.Compile();
@@ -359,7 +386,7 @@ var MIB = function (dir) {
                                         //BUILD OBJECT FROM MACRO TYPE NOTATION
                                         var MARCO = this[Symbols[r]];
                                         if (!MARCO) {
-                                            //HACK IF MARCO IS NOT FOUND 
+                                            //HACK IF MARCO IS NOT FOUND
                                             //MARCO = {};
                                             //return;
                                         }
@@ -401,7 +428,7 @@ var MIB = function (dir) {
                                                         val = val.replace("{", "").replace("}", "").split(",");
                                                     }
                                                 }
-                                               
+
                                                 switch (key) {
                                                     case 'SYNTAX':
                                                         switch (val) {
@@ -727,6 +754,11 @@ var MIB = function (dir) {
             }
         }
     });
+
+    // Complete buffer setup before returning to caller.
+    initializeBuffer(newMIB.CharBuffer);
+
+    return newMIB;
 };
 
 module.exports = exports = MIB;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "net-snmp",
-  "version": "3.9.1",
+  "version": "3.9.3",
   "description": "JavaScript implementation of the Simple Network Management Protocol (SNMP)",
   "main": "index.js",
   "directories": {