Skip to content

Additional SNMP library output formatting options #21502

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
eskyuu wants to merge 16 commits into
base: master
Choose a base branch
from
+447 −47
Draft

Additional SNMP library output formatting options #21502

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
4049a94
Add functions to control more SNMP library output options
eskyuu Mar 19, 2026
e7840bb
Remove allow_underscores from php_snmp_object
eskyuu Mar 19, 2026
42a4511
Update test output
eskyuu Mar 23, 2026
570308b
Add option to set numeric index
eskyuu Mar 25, 2026
bcb2e23
Fix missing item from stuct
eskyuu Mar 25, 2026
ee3e676
Fix for tests
eskyuu Mar 25, 2026
881d768
Fix tests for real this time
eskyuu Mar 25, 2026
069ff87
Use single command with ENUM to set various options
eskyuu Mar 27, 2026
c01aff8
Add missing breaks to switch statements
eskyuu Mar 27, 2026
177fd23
Fix the snmp_set_string_output_format function name
eskyuu Mar 27, 2026
697835e
Add the missing SNMP object options
eskyuu Mar 27, 2026
f82b399
Add missing properties to snmp.stub.php
eskyuu Mar 27, 2026
d3958f6
Fix up for dontprint_units -> dont_print_units
eskyuu Mar 27, 2026
4cfdeb3
Added missing numeric_index property and fix test data
eskyuu Mar 27, 2026
ced1410
Fix test output
eskyuu Mar 27, 2026
05b7d79
Save and restore libsnmp environment between requests
eskyuu Mar 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions ext/snmp/php_snmp.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,13 @@ typedef struct _php_snmp_object {
int valueretrieval;
int quick_print;
int enum_print;
int numeric_index;
int numeric_timeticks;
int extended_index;
int dont_print_units;
int escape_quotes;
int print_hex_text;
int string_output_format;
int oid_output_format;
int snmp_errno;
int oid_increasing_check;
Expand Down
212 changes: 195 additions & 17 deletions ext/snmp/snmp.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,11 @@ typedef struct snmp_session php_snmp_session;
} \
}

static php_snmp_object saved_snmp_settings;
static int saved_mib_allow_underscores;
static int saved_mib_comment_term;
static int saved_mib_replace;

ZEND_DECLARE_MODULE_GLOBALS(snmp)
static PHP_GINIT_FUNCTION(snmp);

Expand Down Expand Up @@ -1224,6 +1229,44 @@ static ZEND_ATTRIBUTE_NONNULL_ARGS(2) bool snmp_session_set_security(struct snmp
}
/* }}} */

/*
* Save the snmplib state into the given php_snmp_object
*/
static void save_snmplib_output_options(php_snmp_object *snmp_object)
{
// Booleans
snmp_object->quick_print = netsnmp_ds_get_boolean(NETSNMP_DS_LIBRARY_ID, NETSNMP_DS_LIB_QUICK_PRINT);
snmp_object->enum_print = netsnmp_ds_get_boolean(NETSNMP_DS_LIBRARY_ID, NETSNMP_DS_LIB_PRINT_NUMERIC_ENUM);
snmp_object->numeric_index = netsnmp_ds_get_boolean(NETSNMP_DS_LIBRARY_ID, NETSNMP_DS_LIB_DONT_BREAKDOWN_OIDS);
snmp_object->numeric_timeticks = netsnmp_ds_get_boolean(NETSNMP_DS_LIBRARY_ID, NETSNMP_DS_LIB_NUMERIC_TIMETICKS);
snmp_object->extended_index = netsnmp_ds_get_boolean(NETSNMP_DS_LIBRARY_ID, NETSNMP_DS_LIB_EXTENDED_INDEX);
snmp_object->dont_print_units = netsnmp_ds_get_boolean(NETSNMP_DS_LIBRARY_ID, NETSNMP_DS_LIB_DONT_PRINT_UNITS);
snmp_object->escape_quotes = netsnmp_ds_get_boolean(NETSNMP_DS_LIBRARY_ID, NETSNMP_DS_LIB_ESCAPE_QUOTES);
snmp_object->print_hex_text = netsnmp_ds_get_boolean(NETSNMP_DS_LIBRARY_ID, NETSNMP_DS_LIB_PRINT_HEX_TEXT);
// Integers
snmp_object->string_output_format = netsnmp_ds_get_int(NETSNMP_DS_LIBRARY_ID, NETSNMP_DS_LIB_STRING_OUTPUT_FORMAT);
snmp_object->oid_output_format = netsnmp_ds_get_int(NETSNMP_DS_LIBRARY_ID, NETSNMP_DS_LIB_OID_OUTPUT_FORMAT);
}

/*
* Set the snmplib output options using the given php_snmp_object
*/
static void set_snmplib_output_options(php_snmp_object *snmp_object)
{
// Booleans
netsnmp_ds_set_boolean(NETSNMP_DS_LIBRARY_ID, NETSNMP_DS_LIB_QUICK_PRINT, snmp_object->quick_print);
netsnmp_ds_set_boolean(NETSNMP_DS_LIBRARY_ID, NETSNMP_DS_LIB_PRINT_NUMERIC_ENUM, snmp_object->enum_print);
netsnmp_ds_set_boolean(NETSNMP_DS_LIBRARY_ID, NETSNMP_DS_LIB_DONT_BREAKDOWN_OIDS, snmp_object->numeric_index);
netsnmp_ds_set_boolean(NETSNMP_DS_LIBRARY_ID, NETSNMP_DS_LIB_NUMERIC_TIMETICKS, snmp_object->numeric_timeticks);
netsnmp_ds_set_boolean(NETSNMP_DS_LIBRARY_ID, NETSNMP_DS_LIB_EXTENDED_INDEX, snmp_object->extended_index);
netsnmp_ds_set_boolean(NETSNMP_DS_LIBRARY_ID, NETSNMP_DS_LIB_DONT_PRINT_UNITS, snmp_object->dont_print_units);
netsnmp_ds_set_boolean(NETSNMP_DS_LIBRARY_ID, NETSNMP_DS_LIB_ESCAPE_QUOTES, snmp_object->escape_quotes);
netsnmp_ds_set_boolean(NETSNMP_DS_LIBRARY_ID, NETSNMP_DS_LIB_PRINT_HEX_TEXT, snmp_object->print_hex_text);
// Integers
netsnmp_ds_set_int(NETSNMP_DS_LIBRARY_ID, NETSNMP_DS_LIB_STRING_OUTPUT_FORMAT, snmp_object->string_output_format);
netsnmp_ds_set_int(NETSNMP_DS_LIBRARY_ID, NETSNMP_DS_LIB_OID_OUTPUT_FORMAT, snmp_object->oid_output_format);
}

/* {{{ php_snmp
*
* Generic SNMP handler for all versions.
Expand Down Expand Up @@ -1393,12 +1436,10 @@ static void php_snmp(INTERNAL_FUNCTION_PARAMETERS, int st, int version)
}
objid_query.oid_increasing_check = snmp_object->oid_increasing_check;
objid_query.valueretrieval = snmp_object->valueretrieval;
glob_snmp_object.enum_print = netsnmp_ds_get_boolean(NETSNMP_DS_LIBRARY_ID, NETSNMP_DS_LIB_PRINT_NUMERIC_ENUM);
netsnmp_ds_set_boolean(NETSNMP_DS_LIBRARY_ID, NETSNMP_DS_LIB_PRINT_NUMERIC_ENUM, snmp_object->enum_print);
glob_snmp_object.quick_print = netsnmp_ds_get_boolean(NETSNMP_DS_LIBRARY_ID, NETSNMP_DS_LIB_QUICK_PRINT);
netsnmp_ds_set_boolean(NETSNMP_DS_LIBRARY_ID, NETSNMP_DS_LIB_QUICK_PRINT, snmp_object->quick_print);
glob_snmp_object.oid_output_format = netsnmp_ds_get_int(NETSNMP_DS_LIBRARY_ID, NETSNMP_DS_LIB_OID_OUTPUT_FORMAT);
netsnmp_ds_set_int(NETSNMP_DS_LIBRARY_ID, NETSNMP_DS_LIB_OID_OUTPUT_FORMAT, snmp_object->oid_output_format);

// Save the global snmplib output options and set the options to those defined by the object instance
save_snmplib_output_options(&glob_snmp_object);
set_snmplib_output_options(snmp_object);
}

if (objid_query.max_repetitions < 0) {
Expand All @@ -1412,9 +1453,8 @@ static void php_snmp(INTERNAL_FUNCTION_PARAMETERS, int st, int version)
if (session_less_mode) {
snmp_session_free(&session);
} else {
netsnmp_ds_set_boolean(NETSNMP_DS_LIBRARY_ID, NETSNMP_DS_LIB_PRINT_NUMERIC_ENUM, glob_snmp_object.enum_print);
netsnmp_ds_set_boolean(NETSNMP_DS_LIBRARY_ID, NETSNMP_DS_LIB_QUICK_PRINT, glob_snmp_object.quick_print);
netsnmp_ds_set_int(NETSNMP_DS_LIBRARY_ID, NETSNMP_DS_LIB_OID_OUTPUT_FORMAT, glob_snmp_object.oid_output_format);
// Restore the snmplib output options back to the global state
set_snmplib_output_options(&glob_snmp_object);
}
}
/* }}} */
Expand Down Expand Up @@ -1493,6 +1533,78 @@ PHP_FUNCTION(snmp_set_enum_print)
}
/* }}} */

/* {{{ Set walk option. */
PHP_FUNCTION(snmp_set_mib_option)
{
zend_long a1, a2;

if (zend_parse_parameters(ZEND_NUM_ARGS(), "lb", &a1, &a2) == FAILURE) {
RETURN_THROWS();
}

switch (a1) {
case NETSNMP_DS_LIB_MIB_PARSE_LABEL:
case NETSNMP_DS_LIB_MIB_COMMENT_TERM:
case NETSNMP_DS_LIB_MIB_REPLACE:
netsnmp_ds_set_int(NETSNMP_DS_LIBRARY_ID, a1, (int) a2);
break;
default:
zend_argument_value_error(1, "must be an SNMP_MIB_* constant");
RETURN_THROWS();
}
}
/* }}} */

/* {{{ Set the string output format. */
PHP_FUNCTION(snmp_set_string_output_format)
{
zend_long a1;

if (zend_parse_parameters(ZEND_NUM_ARGS(), "l", &a1) == FAILURE) {
RETURN_THROWS();
}

switch (a1) {
case NETSNMP_STRING_OUTPUT_GUESS:
case NETSNMP_STRING_OUTPUT_ASCII:
case NETSNMP_STRING_OUTPUT_HEX:
netsnmp_ds_set_int(NETSNMP_DS_LIBRARY_ID, NETSNMP_DS_LIB_STRING_OUTPUT_FORMAT, a1);
break;
default:
zend_argument_value_error(1, "must be an SNMP_STRING_OUTPUT_* constant");
RETURN_THROWS();
}
}
/* }}} */

/* {{{ Set output format option. */
PHP_FUNCTION(snmp_set_output_option)
{
zend_long a1, a2;

if (zend_parse_parameters(ZEND_NUM_ARGS(), "lb", &a1, &a2) == FAILURE) {
RETURN_THROWS();
}

switch (a1) {
case NETSNMP_DS_LIB_DONT_BREAKDOWN_OIDS:
case NETSNMP_DS_LIB_PRINT_NUMERIC_ENUM:
case NETSNMP_DS_LIB_ESCAPE_QUOTES:
case NETSNMP_DS_LIB_QUICK_PRINT:
case NETSNMP_DS_LIB_NUMERIC_TIMETICKS:
case NETSNMP_DS_LIB_PRINT_HEX_TEXT:
case NETSNMP_DS_LIB_DONT_PRINT_UNITS:
case NETSNMP_DS_LIB_PRINT_BARE_VALUE:
case NETSNMP_DS_LIB_EXTENDED_INDEX:
netsnmp_ds_set_int(NETSNMP_DS_LIBRARY_ID, a1, (int) a2);
break;
default:
zend_argument_value_error(1, "must be an SNMP_OUTPUT_* constant");
RETURN_THROWS();
}
}
/* }}} */

/* {{{ Set the OID output format. */
PHP_FUNCTION(snmp_set_oid_output_format)
{
Expand Down Expand Up @@ -1673,9 +1785,7 @@ PHP_METHOD(SNMP, __construct)
}
snmp_object->max_oids = 0;
snmp_object->valueretrieval = SNMP_G(valueretrieval);
snmp_object->enum_print = netsnmp_ds_get_boolean(NETSNMP_DS_LIBRARY_ID, NETSNMP_DS_LIB_PRINT_NUMERIC_ENUM);
snmp_object->oid_output_format = netsnmp_ds_get_int(NETSNMP_DS_LIBRARY_ID, NETSNMP_DS_LIB_OID_OUTPUT_FORMAT);
snmp_object->quick_print = netsnmp_ds_get_boolean(NETSNMP_DS_LIBRARY_ID, NETSNMP_DS_LIB_QUICK_PRINT);
save_snmplib_output_options(snmp_object);
snmp_object->oid_increasing_check = true;
snmp_object->exceptions_enabled = 0;
}
Expand Down Expand Up @@ -1988,6 +2098,12 @@ static int php_snmp_read_max_oids(php_snmp_object *snmp_object, zval *retval)
PHP_SNMP_BOOL_PROPERTY_READER_FUNCTION(oid_increasing_check)
PHP_SNMP_BOOL_PROPERTY_READER_FUNCTION(quick_print)
PHP_SNMP_BOOL_PROPERTY_READER_FUNCTION(enum_print)
PHP_SNMP_BOOL_PROPERTY_READER_FUNCTION(numeric_index)
PHP_SNMP_BOOL_PROPERTY_READER_FUNCTION(numeric_timeticks)
PHP_SNMP_BOOL_PROPERTY_READER_FUNCTION(extended_index)
PHP_SNMP_BOOL_PROPERTY_READER_FUNCTION(dont_print_units)
PHP_SNMP_BOOL_PROPERTY_READER_FUNCTION(escape_quotes)
PHP_SNMP_BOOL_PROPERTY_READER_FUNCTION(print_hex_text)

#define PHP_SNMP_LONG_PROPERTY_READER_FUNCTION(name) \
static int php_snmp_read_##name(php_snmp_object *snmp_object, zval *retval) \
Expand All @@ -1997,6 +2113,7 @@ PHP_SNMP_BOOL_PROPERTY_READER_FUNCTION(enum_print)
}

PHP_SNMP_LONG_PROPERTY_READER_FUNCTION(valueretrieval)
PHP_SNMP_LONG_PROPERTY_READER_FUNCTION(string_output_format)
PHP_SNMP_LONG_PROPERTY_READER_FUNCTION(oid_output_format)
PHP_SNMP_LONG_PROPERTY_READER_FUNCTION(exceptions_enabled)

Expand Down Expand Up @@ -2051,9 +2168,33 @@ static int php_snmp_write_##name(php_snmp_object *snmp_object, zval *newval) \
return SUCCESS; \
}

PHP_SNMP_BOOL_PROPERTY_WRITER_FUNCTION(oid_increasing_check)
PHP_SNMP_BOOL_PROPERTY_WRITER_FUNCTION(quick_print)
PHP_SNMP_BOOL_PROPERTY_WRITER_FUNCTION(enum_print)
PHP_SNMP_BOOL_PROPERTY_WRITER_FUNCTION(oid_increasing_check)
PHP_SNMP_BOOL_PROPERTY_WRITER_FUNCTION(numeric_index)
PHP_SNMP_BOOL_PROPERTY_WRITER_FUNCTION(numeric_timeticks)
PHP_SNMP_BOOL_PROPERTY_WRITER_FUNCTION(extended_index)
PHP_SNMP_BOOL_PROPERTY_WRITER_FUNCTION(dont_print_units)
PHP_SNMP_BOOL_PROPERTY_WRITER_FUNCTION(escape_quotes)
PHP_SNMP_BOOL_PROPERTY_WRITER_FUNCTION(print_hex_text)

/* {{{ */
static int php_snmp_write_string_output_format(php_snmp_object *snmp_object, zval *newval)
{
zend_long lval = zval_get_long(newval);

switch(lval) {
case NETSNMP_STRING_OUTPUT_GUESS:
case NETSNMP_STRING_OUTPUT_ASCII:
case NETSNMP_STRING_OUTPUT_HEX:
snmp_object->oid_output_format = lval;
return SUCCESS;
default:
zend_value_error("SNMP string output print format must be an SNMP_STRING_OUTPUT_* constant");
return FAILURE;
}
}
/* }}} */

/* {{{ */
static int php_snmp_write_oid_output_format(php_snmp_object *snmp_object, zval *newval)
Expand Down Expand Up @@ -2102,11 +2243,18 @@ static void free_php_snmp_properties(zval *el) /* {{{ */
const php_snmp_prop_handler php_snmp_property_entries[] = {
PHP_SNMP_READONLY_PROPERTY_ENTRY_RECORD(info),
PHP_SNMP_PROPERTY_ENTRY_RECORD(max_oids),
PHP_SNMP_PROPERTY_ENTRY_RECORD(valueretrieval),
PHP_SNMP_PROPERTY_ENTRY_RECORD(oid_increasing_check),
PHP_SNMP_PROPERTY_ENTRY_RECORD(quick_print),
PHP_SNMP_PROPERTY_ENTRY_RECORD(enum_print),
PHP_SNMP_PROPERTY_ENTRY_RECORD(numeric_index),
PHP_SNMP_PROPERTY_ENTRY_RECORD(numeric_timeticks),
PHP_SNMP_PROPERTY_ENTRY_RECORD(extended_index),
PHP_SNMP_PROPERTY_ENTRY_RECORD(dont_print_units),
PHP_SNMP_PROPERTY_ENTRY_RECORD(escape_quotes),
PHP_SNMP_PROPERTY_ENTRY_RECORD(print_hex_text),
PHP_SNMP_PROPERTY_ENTRY_RECORD(valueretrieval),
PHP_SNMP_PROPERTY_ENTRY_RECORD(string_output_format),
PHP_SNMP_PROPERTY_ENTRY_RECORD(oid_output_format),
PHP_SNMP_PROPERTY_ENTRY_RECORD(oid_increasing_check),
PHP_SNMP_PROPERTY_ENTRY_RECORD(exceptions_enabled),
{ NULL, 0, NULL, NULL}
};
Expand Down Expand Up @@ -2173,6 +2321,36 @@ PHP_MSHUTDOWN_FUNCTION(snmp)
}
/* }}} */

/* {{{ PHP_INIT_FUNCTION */
static PHP_RINIT_FUNCTION(snmp)
{
// Save the output options
save_snmplib_output_options(&saved_snmp_settings);

// Save the MIB options
saved_mib_allow_underscores = netsnmp_ds_get_int(NETSNMP_DS_LIBRARY_ID, NETSNMP_DS_LIB_MIB_PARSE_LABEL);
saved_mib_comment_term = netsnmp_ds_get_int(NETSNMP_DS_LIBRARY_ID, NETSNMP_DS_LIB_MIB_COMMENT_TERM);
saved_mib_replace = netsnmp_ds_get_int(NETSNMP_DS_LIBRARY_ID, NETSNMP_DS_LIB_MIB_REPLACE);

return SUCCESS;
}
/* }}} */

/* {{{ PHP_RSHUTDOWN_FUNCTION */
static PHP_RSHUTDOWN_FUNCTION(snmp)
{
// Restore the output options
set_snmplib_output_options(&saved_snmp_settings);

// Restore MIB options
netsnmp_ds_set_int(NETSNMP_DS_LIBRARY_ID, NETSNMP_DS_LIB_MIB_PARSE_LABEL, saved_mib_allow_underscores);
netsnmp_ds_set_int(NETSNMP_DS_LIBRARY_ID, NETSNMP_DS_LIB_MIB_COMMENT_TERM, saved_mib_comment_term);
netsnmp_ds_set_int(NETSNMP_DS_LIBRARY_ID, NETSNMP_DS_LIB_MIB_REPLACE, saved_mib_replace);

return SUCCESS;
}
/* }}} */

/* {{{ PHP_MINFO_FUNCTION */
PHP_MINFO_FUNCTION(snmp)
{
Expand All @@ -2199,8 +2377,8 @@ zend_module_entry snmp_module_entry = {
ext_functions,
PHP_MINIT(snmp),
PHP_MSHUTDOWN(snmp),
NULL,
NULL,
PHP_RINIT(snmp),
PHP_RSHUTDOWN(snmp),
PHP_MINFO(snmp),
PHP_SNMP_VERSION,
PHP_MODULE_GLOBALS(snmp),
Expand Down
Loading
Loading