Feature: New plugin/event param type: "System Menu", pre-populated with various xyOps internal system list items.

Author: jhuckaby

docs/plugins.md

@@ -1068,6 +1068,46 @@ Finally, you can define groups of items in the menu by including an object with
 }
 ```
 
+### System Menu
+
+A "system menu" is a dynamically populated menu, similar to a [Bucket Menu](#bucket-menu), but the menu items are pulled from xyOps itself.  This is useful when a Plugin needs the user to select an existing xyOps object, such as an event, category, server, server group, plugin, user, role, web hook or monitor.
+
+When you add your parameter and select the "System Menu" field type, you will need to select the internal xyOps list to use for the menu.  The menu is populated automatically from the current system data, and xyOps adds a `(None)` item at the top so no item is selected by default.
+
+When the user selects an item, the selected item's ID is stored in [Job.params](data.md#job-params) and passed to the Plugin.  For example, if you define a parameter with ID `custom_event`, point it at the Events system list, and the user selects an event with ID `emp6dulft42zjevn8`, the Plugin would receive this:
+
+```json
+{
+	"custom_event": "emp6dulft42zjevn8"
+}
+```
+
+Most system menus store the selected item's normal `id` property.  The Users menu is a special case, and stores the selected user's `username`.
+
+The following system lists are available:
+
+| List | Stored Value |
+|------|--------------|
+| Alerts | Alert ID |
+| Algorithms | Target algorithm ID |
+| Buckets | Bucket ID |
+| Categories | Category ID |
+| Channels | Channel ID |
+| Events | Event ID |
+| Groups | Server group ID |
+| Monitors | Monitor ID |
+| Plugins | Plugin ID |
+| Roles | Role ID |
+| Servers | Server ID |
+| Tags | Tag ID |
+| Targets | Server group ID or server ID |
+| Users | Username |
+| Web Hooks | Web Hook ID |
+
+The "Targets" menu is a combined list which includes both server groups and individual servers, arranged into menu sections.  This is handy for Plugin parameters that should accept either kind of job target.  The Algorithms menu contains the built-in event target selection algorithms, such as Random.
+
+API Keys and Secrets are intentionally not offered as system menu sources.
+
 ### Checkbox
 
 A checkbox is displayed with a label, and the "checked" state is stored as a Boolean parameter value (`true` or `false`).
@@ -1342,4 +1382,3 @@ To use a pre-existing Docker image such as `ubuntu`, you can set the launch comm
 ## Plugin Marketplace
 
 xyOps has an integrated Plugin Marketplace, so you can expand the app's feature set by leveraging Plugins published both by PixlCore (the makers of xyOps), as well as the developer community.  For more on this, please see the [Marketplace Guide](marketplace.md).
-

htdocs/js/pages/Base.class.js

@@ -2660,6 +2660,11 @@ Page.Base = class Base extends Page {
 					else html += self.getNiceBucket(param.bucket_id);
 				break;
 
+				case 'system':
+					html += '<i class="link mdi mdi-' + elem_icon + '" onClick="$P().copyPluginParamValue(this)" title="Copy to Clipboard">&nbsp;</i>';
+					html += '<span class="data_value">' + encode_entities( elem_value.toString() || '(None)' ) + '</span>';
+				break;
+				
 				case 'toolset':
 					if (!param.data) param.data = {};
 					if (!param.data.tools) param.data.tools = [];

htdocs/js/pages/PageUtils.class.js

@@ -2669,6 +2669,11 @@ Page.PageUtils = class PageUtils extends Page.Base {
 					}
 				break;
 
+				case 'system':
+					elem_value = (param.id in params) ? params[param.id] : '';
+					html += self.getFormMenuSingle({ id: elem_id, value: elem_value, options: self.getSystemMenuItems(param.list_id), disabled: elem_dis, title: param.title });
+				break;
+				
 				case 'toolset':
 					var data = param.data || { tools: [] };
 					if (!data.tools) data.tools = [];
@@ -3719,6 +3724,11 @@ Page.PageUtils = class PageUtils extends Page.Base {
 					else html += self.getNiceBucket( param.bucket_id );
 				break;
 
+				case 'system':
+					html += '<i class="mdi mdi-' + elem_icon + '">&nbsp;</i>';
+					html += strip_html( elem_value.toString() || '(None)' );
+				break;
+				
 				case 'toolset':
 					html += '<i class="mdi mdi-' + elem_icon + '">&nbsp;</i>';
 					var tool = find_object( param.data.tools, { id: elem_value } );
@@ -4529,6 +4539,10 @@ Page.PageUtils = class PageUtils extends Page.Base {
 					pairs.push([ self.getNiceBucket(param.bucket_id) ]);
 				break;
 
+				case 'system':
+					pairs.push([ self.getNiceSystemList(param.list_id) ]);
+				break;
+				
 				case 'toolset':
 					if (param.data && param.data.tools && param.data.tools.length) pairs.push([ commify(param.data.tools.length) + " tools in set" ]);
 					else pairs.push([ "(No tools in set)" ]);
@@ -4582,7 +4596,7 @@ Page.PageUtils = class PageUtils extends Page.Base {
 		var old_param = param;
 
 		// prepare control type menu
-		var ctypes = (this.controlTypes || ['checkbox', 'code', 'json', 'hidden', 'select', 'bucket', 'text', 'textarea']).map (function(key) { 
+		var ctypes = (this.controlTypes || ['checkbox', 'code', 'json', 'hidden', 'select', 'bucket', 'system', 'text', 'textarea']).map (function(key) { 
 			return { 
 				id: key, 
 				title: config.ui.control_type_labels[key],
@@ -4735,6 +4749,7 @@ Page.PageUtils = class PageUtils extends Page.Base {
 			caption: 'Enter JSON data describing the toolset.  [Learn More](#Docs/plugins/toolset)'
 		});
 
+		// bucket menu
 		html += this.getFormRow({
 			id: 'd_epa_bucket_id',
 			label: 'Storage Bucket:',
@@ -4760,6 +4775,20 @@ Page.PageUtils = class PageUtils extends Page.Base {
 			caption: 'Optionally enter a `dot.delimited.path` to the array within the bucket data record.  If omitted, the array should be at the top-level of the bucket data.'
 		});
 
+		// system menu
+		html += this.getFormRow({
+			id: 'd_epa_list_id',
+			label: 'System Menu:',
+			content: this.getFormMenuSingle({
+				id: 'fe_epa_list_id',
+				title: 'Select System List',
+				options: this.getSystemListMenuItems(),
+				value: param.list_id || '',
+				default_icon: ''
+			}),
+			caption: 'Select an internal list of items to populate the system menu.  No item will be selected by default.  [Learn More](#Docs/plugins/system-menu)'
+		});
+		
 		// caption
 		html += this.getFormRow({
 			label: 'Caption:',
@@ -4869,6 +4898,11 @@ Page.PageUtils = class PageUtils extends Page.Base {
 					delete param.required;
 				break;
 
+				case 'system':
+					param.list_id = $('#fe_epa_list_id').val();
+					delete param.required;
+				break;
+				
 				case 'hidden':
 					param.value = $('#fe_epa_value_hidden').val();
 					delete param.required;
@@ -4904,12 +4938,13 @@ Page.PageUtils = class PageUtils extends Page.Base {
 		} ); // Dialog.confirm
 
 		var change_param_type = function(new_type) {
-			$('#d_epa_value_text, #d_epa_value_textarea, #d_epa_value_code, #d_epa_value_json, #d_epa_value_checkbox, #d_epa_value_select, #d_epa_value_hidden, #d_epa_value_toolset, #d_epa_bucket_id, #d_epa_bucket_path').hide();
+			$('#d_epa_value_text, #d_epa_value_textarea, #d_epa_value_code, #d_epa_value_json, #d_epa_value_checkbox, #d_epa_value_select, #d_epa_value_hidden, #d_epa_value_toolset, #d_epa_bucket_id, #d_epa_bucket_path, #d_epa_list_id').hide();
 			$('#d_epa_value_' + new_type).show();
 			$('#d_epa_required').toggle( !!new_type.match(/^(text|textarea|code)$/) );
 			$('#d_epa_text_variant').toggle( !!new_type.match(/^(text)$/) );
 			$('#d_epa_locked').toggle( !new_type.match(/^(toolset)$/) );
 			$('#d_epa_bucket_id, #d_epa_bucket_path').toggle( !!new_type.match(/^(bucket)$/) );
+			$('#d_epa_list_id').toggle( !!new_type.match(/^(system)$/) );
 			Dialog.autoResize();
 		}; // change_action_type
 
@@ -4921,7 +4956,7 @@ Page.PageUtils = class PageUtils extends Page.Base {
 
 		if (idx == -1) $('#fe_epa_id').focus();
 
-		SingleSelect.init( $('#fe_epa_type, #fe_epa_text_variant, #fe_epa_bucket_id') );
+		SingleSelect.init( $('#fe_epa_type, #fe_epa_text_variant, #fe_epa_bucket_id, #fe_epa_list_id') );
 		Dialog.autoResize();
 	}
 
@@ -4951,6 +4986,94 @@ Page.PageUtils = class PageUtils extends Page.Base {
 		});
 	}
 
+	getNiceSystemList(list_id) {
+		// get formatted list title with icon
+		var item = find_object( this.getSystemListMenuItems(), { id: list_id } );
+		if (!item) return '(None)';
+		
+		var html = '<span class="nowrap" title="' + encode_attrib_entities(item.title) + '">';
+		var icon = '<i class="mdi mdi-' + item.icon + '"></i>';
+		
+		html += icon + item.title;
+		html += '</span>';
+		
+		return html;
+	}
+	
+	getSystemListMenuItems() {
+		// get menu of all lists (excluding a few)
+		var items = config.ui.list_list.filter( function(item) {
+			return !item.id.match(/^(api_keys|secrets)$/);
+		} );
+		
+		items = items.concat([
+			{
+				"id": "servers",
+				"title": "Servers",
+				"icon": "router-network"
+			},
+			{
+				"id": "groups",
+				"title": "Groups",
+				"icon": "server-network"
+			},
+			{
+				"id": "targets",
+				"title": "Targets",
+				"icon": "lan"
+			},
+			{
+				"id": "algos",
+				"title": "Algorithms",
+				"icon": "dice-5-outline"
+			}
+		]);
+		
+		sort_by( items, 'title' );
+		return items;
+	}
+	
+	getSystemMenuItems(list_id) {
+		// get items for menu given list id
+		var items = [];
+		var list_def = find_object( config.ui.list_list, { id: list_id } );
+		
+		switch (list_id) {
+			case 'events':
+				items = this.getCategorizedEvents();
+			break;
+			
+			case 'servers':
+				items = this.getCategorizedServers(true);
+			break;
+			
+			case 'targets':
+				items = [].concat(
+					this.buildOptGroup(app.groups, "Groups:", 'server-network'),
+					this.buildServerOptGroup("Servers:", 'router-network')
+				);
+			break;
+			
+			case 'algos':
+				items = config.ui.event_target_algo_menu;
+			break;
+			
+			case 'users':
+				items = app.users.map( function(user) { return { id: user.username, title: user.full_name, icon: user.icon || 'account' }; } );
+			break;
+			
+			default: 
+				if (list_def && app[list_id]) {
+					items = app[list_id].map( function(item) { return { id: item.id, title: item.title, icon: list_def.icon }; } );
+				}
+				else items = app[list_id] || []; 
+			break;
+		}
+		
+		items.unshift({ "id": "", "title": "(None)" });
+		return items;
+	}
+	
 	deleteParam(idx) {
 		// delete selected param
 		this.params.splice( idx, 1 );
@@ -5179,6 +5302,11 @@ Page.PageUtils = class PageUtils extends Page.Base {
 					}
 				break;
 
+				case 'system':
+					elem_value = (param.id in params) ? params[param.id] : '';
+					html += self.getFormMenuSingle({ id: elem_id, value: elem_value, options: self.getSystemMenuItems(param.list_id), disabled: elem_dis, title: param.title });
+				break;
+				
 			} // switch type
 
 			if (param.caption) html += '<div class="info_caption">' + inline_marked( strip_html(param.caption) ) + '</div>';

internal/ui.json

@@ -1042,6 +1042,7 @@
 		"checkbox": "Checkbox",
 		"select": "Menu",
 		"bucket": "Bucket Menu",
+		"system": "System Menu",
 		"hidden": "Hidden",
 		"toolset": "Toolset"
 	},
@@ -1054,6 +1055,7 @@
 		"checkbox": "checkbox-marked-outline",
 		"select": "form-dropdown",
 		"bucket": "pail-outline",
+		"system": "list-box-outline",
 		"hidden": "eye-off-outline",
 		"toolset": "tools"
 	},