From 8bdff8362c1631cb4de400b3feace218e31e5a38 Mon Sep 17 00:00:00 2001 From: brandonkelly Date: Sat, 7 Dec 2024 13:12:06 -0800 Subject: [PATCH] Copy plugin handle/package name actions Resolves #16281 --- CHANGELOG-WIP.md | 3 + src/templates/_includes/disclosuremenu.twig | 1 + src/templates/settings/plugins/index.twig | 131 +++++++++--- src/translations/en/app.php | 4 + src/web/CpScreenResponseFormatter.php | 2 +- src/web/assets/cp/dist/cp.js | 2 +- src/web/assets/cp/dist/cp.js.map | 2 +- src/web/assets/cp/dist/css/cp.css | 2 +- src/web/assets/cp/dist/css/cp.css.map | 2 +- src/web/assets/cp/src/css/_cp.scss | 17 +- src/web/assets/cp/src/js/CP.js | 54 ++--- src/web/assets/garnish/dist/garnish.js | 2 +- src/web/assets/garnish/dist/garnish.js.map | 2 +- src/web/assets/garnish/src/DisclosureMenu.js | 4 + src/web/assets/plugins/PluginsAsset.php | 4 + src/web/assets/plugins/dist/PluginManager.js | 2 +- .../assets/plugins/dist/PluginManager.js.map | 2 +- src/web/assets/plugins/src/PluginManager.js | 188 ++++++++++-------- src/web/assets/updates/UpdatesAsset.php | 4 + src/web/assets/updates/src/UpdatesUtility.js | 56 +++++- 20 files changed, 320 insertions(+), 164 deletions(-) diff --git a/CHANGELOG-WIP.md b/CHANGELOG-WIP.md index 15f787288b9..60cdee39031 100644 --- a/CHANGELOG-WIP.md +++ b/CHANGELOG-WIP.md @@ -12,6 +12,7 @@ - Improved the accessibility of control panel icons. ([#16128](https://github.com/craftcms/cms/pull/16128)) - Improved the accessibility of Selectize inputs. ([#16110](https://github.com/craftcms/cms/pull/16110)) - Improved the accessibility of the image rotation control within the Image Editor. ([#16218](https://github.com/craftcms/cms/pull/16218)) +- Improved the accessibility of action menus on the Plugins index page. ### Administration - Added the “Show the ‘URL Suffix’ field” setting to Link fields. ([#15813](https://github.com/craftcms/cms/discussions/15813)) @@ -21,6 +22,8 @@ - Added the “GraphQL Mode” Link field setting. ([#16237](https://github.com/craftcms/cms/pull/16237)) - Added the “Field” entry condition rule, which replaces “Matrix field”, includes a “has a value” operator. ([#16270](https://github.com/craftcms/cms/discussions/16270)) - Section condition rules now have a “has a value” operator. ([#16270](https://github.com/craftcms/cms/discussions/16270)) +- Added “Copy plugin handle” and “Copy package name” options to plugins’ action menus on the Plugins index page. ([#16281](https://github.com/craftcms/cms/discussions/16281)) +- The Updates utility now shows an action menu for each plugin, with “Copy plugin handle” and “Copy package name” options. ([#16281](https://github.com/craftcms/cms/discussions/16281)) - The Queue Manager utility now shows jobs’ class names. ([#16228](https://github.com/craftcms/cms/pull/16228)) - Improved the wording of field instance action labels. ([#16261](https://github.com/craftcms/cms/discussions/16261)) - Improved the error output for nested elements when they can’t be resaved via `resave` commands. diff --git a/src/templates/_includes/disclosuremenu.twig b/src/templates/_includes/disclosuremenu.twig index 3d436fa1ad6..2ba8d4e851c 100644 --- a/src/templates/_includes/disclosuremenu.twig +++ b/src/templates/_includes/disclosuremenu.twig @@ -38,6 +38,7 @@ sel: selected, error: item.destructive ?? false, formsubmit: item.action ?? false, + disabled: item.disabled ?? false, }|filter|keys, href: type == 'button' ? null : url(item.url), data: { diff --git a/src/templates/settings/plugins/index.twig b/src/templates/settings/plugins/index.twig index 6e52ebd1501..f1cc1219e4c 100644 --- a/src/templates/settings/plugins/index.twig +++ b/src/templates/settings/plugins/index.twig @@ -26,7 +26,84 @@ {% for handle, config in info %} {% set pluginStoreUrl = url('plugin-store/' ~ handle) %} {% set forceDisabled = disabledPlugins == '*' or handle in disabledPlugins %} - + + {% set actionItems = [ + { + icon: 'clipboard', + label: 'Copy plugin handle', + attributes: { + data: { + action: 'copy-plugin-handle', + }, + }, + }, + { + icon: 'clipboard', + label: 'Copy package name', + attributes: { + data: { + action: 'copy-package-name', + }, + }, + }, + {type: 'hr'}, + ] %} + {% if not config.isInstalled %} + {% set actionItems = actionItems|push( + { + icon: 'plus', + label: 'Install'|t('app'), + action: 'plugins/install-plugin', + params: {pluginHandle: handle}, + disabled: forceDisabled + }, + { + icon: 'minus', + label: 'Remove'|t('app'), + action: 'pluginstore/remove', + params: {packageName: config.packageName}, + destructive: true, + }, + ) %} + {% else %} + {% if config.isEnabled %} + {% set actionItems = actionItems|push( + { + icon: 'circle-dashed', + label: 'Disable'|t('app'), + action: 'plugins/disable-plugin', + params: {pluginHandle: handle}, + }, + { + icon: 'xmark', + label: 'Uninstall'|t('app'), + action: 'plugins/uninstall-plugin', + params: {pluginHandle: handle}, + destructive: true, + confirm: 'Are you sure you want to uninstall {plugin}? You will lose all of its associated data.'|t('app', { + plugin: config.name, + }), + } + ) %} + {% else %} + {% set actionItems = actionItems|push({ + icon: 'circle', + label: 'Enable'|t('app'), + action: 'plugins/enable-plugin', + params: {pluginHandle: handle}, + disabled: forceDisabled, + }) %} + {% endif %} + {% endif %} + + {% tag 'tr' with { + id: "plugin-#{handle}", + data: { + name: config.name, + handle: handle, + 'package-name': config.packageName, + }, + } %}
@@ -139,39 +216,35 @@ {{ "Installed"|t('app') }} {% elseif config.isInstalled %} {{ "Disabled"|t('app') }} + {% if forceDisabled %} + + {{ '{plugin} is disabled by the {setting} config setting.'|t({ + plugin: config.name, + setting: 'disabledPlugins', + }) }} + + {% endif %} {% else %} {{ "Not installed"|t('app') }} + {% if forceDisabled %} + + {{ '{plugin} can’t be installed due to the {setting} config setting.'|t({ + plugin: config.name, + setting: 'disabledPlugins', + }) }} + + {% endif %} {% endif %} - -
- {{ hiddenInput('pluginHandle', handle) }} - {{ csrfInput() }} - -
- -
-
+ + {{ disclosureMenu(actionItems, { + buttonAttributes: { + class: ['action-btn', 'hairline'], + hiddenLabel: 'Actions'|t('app'), + }, + }) }} - + {% endtag %} {% endfor %} diff --git a/src/translations/en/app.php b/src/translations/en/app.php index d586c182922..24b841ef599 100644 --- a/src/translations/en/app.php +++ b/src/translations/en/app.php @@ -348,7 +348,9 @@ 'Copy URL' => 'Copy URL', 'Copy activation URL…' => 'Copy activation URL…', 'Copy impersonation URL…' => 'Copy impersonation URL…', + 'Copy package name' => 'Copy package name', 'Copy password reset URL…' => 'Copy password reset URL…', + 'Copy plugin handle' => 'Copy plugin handle', 'Copy reference tag' => 'Copy reference tag', 'Copy the URL' => 'Copy the URL', 'Copy the activation URL' => 'Copy the activation URL', @@ -1142,6 +1144,7 @@ 'Our site is temporarily unavailable. Please try again later.' => 'Our site is temporarily unavailable. Please try again later.', 'Overview' => 'Overview', 'PHP Info' => 'PHP Info', + 'Package Name' => 'Package Name', 'Page Not Found' => 'Page Not Found', 'Page not found.' => 'Page not found.', 'Pagination' => 'Pagination', @@ -1180,6 +1183,7 @@ 'Please fix the following in your {file} file before proceeding:' => 'Please fix the following in your {file} file before proceeding:', 'Please set a valid volume for storing the user photos in user settings page first.' => 'Please set a valid volume for storing the user photos in user settings page first.', 'Please talk to your host/IT department about upgrading your server.' => 'Please talk to your host/IT department about upgrading your server.', + 'Plugin Handle' => 'Plugin Handle', 'Plugin Installer' => 'Plugin Installer', 'Plugin Store' => 'Plugin Store', 'Plugin Uninstaller' => 'Plugin Uninstaller', diff --git a/src/web/CpScreenResponseFormatter.php b/src/web/CpScreenResponseFormatter.php index 1c5b6ab65a3..c764d2d530c 100644 --- a/src/web/CpScreenResponseFormatter.php +++ b/src/web/CpScreenResponseFormatter.php @@ -179,7 +179,7 @@ private function _formatTemplate(YiiResponse $response, CpScreenResponseBehavior 'hiddenLabel' => Craft::t('app', 'Actions'), 'buttonAttributes' => [ 'id' => 'action-btn', - 'class' => ['action-btn', 'hairline-dark'], + 'class' => ['action-btn', 'hairline-dark', 'm'], 'title' => Craft::t('app', 'Actions'), ], ]), diff --git a/src/web/assets/cp/dist/cp.js b/src/web/assets/cp/dist/cp.js index e3cb50fe533..4ef271f6c7a 100644 --- a/src/web/assets/cp/dist/cp.js +++ b/src/web/assets/cp/dist/cp.js @@ -1,3 +1,3 @@ /*! For license information please see cp.js.LICENSE.txt */ -(function(){var __webpack_modules__={463:function(){Craft.Accordion=Garnish.Base.extend({$trigger:null,targetSelector:null,_$target:null,init:function(t){var e=this;this.$trigger=$(t),this.$trigger.data("accordion")&&(console.warn("Double-instantiating an accordion trigger on an element"),this.$trigger.data("accordion").destroy()),this.$trigger.data("accordion",this),this.targetSelector=this.$trigger.attr("aria-controls")?"#".concat(this.$trigger.attr("aria-controls")):null,this.targetSelector&&(this._$target=$(this.targetSelector)),this.addListener(this.$trigger,"click","onTriggerClick"),this.addListener(this.$trigger,"keypress",(function(t){var n=t.keyCode;n!==Garnish.SPACE_KEY&&n!==Garnish.RETURN_KEY||(t.preventDefault(),e.onTriggerClick())}))},onTriggerClick:function(){"true"===this.$trigger.attr("aria-expanded")?this.hideTarget(this._$target):this.showTarget(this._$target)},showTarget:function(t){var e=this;if(t&&t.length){this.showTarget._currentHeight=t.height(),t.removeClass("hidden"),this.$trigger.removeClass("collapsed").addClass("expanded").attr("aria-expanded","true");for(var n=0;n=this.settings.maxItems)){var e=$(t).appendTo(this.$tbody),n=e.find(".delete");this.settings.sortable&&this.sorter.addItems(e),this.$deleteBtns=this.$deleteBtns.add(n),this.addListener(n,"click","handleDeleteBtnClick"),this.totalItems++,this.updateUI()}},reorderItems:function(){var t=this;if(this.settings.sortable){for(var e=[],n=0;n=this.settings.maxItems?$(this.settings.newItemBtnSelector).addClass("hidden"):$(this.settings.newItemBtnSelector).removeClass("hidden"))}},{defaults:{tableSelector:null,noItemsSelector:null,newItemBtnSelector:null,idAttribute:"data-id",nameAttribute:"data-name",sortable:!1,allowDeleteAll:!0,minItems:0,maxItems:null,reorderAction:null,deleteAction:null,reorderSuccessMessage:Craft.t("app","New order saved."),reorderFailMessage:Craft.t("app","Couldn’t save new order."),confirmDeleteMessage:Craft.t("app","Are you sure you want to delete “{name}”?"),deleteSuccessMessage:Craft.t("app","“{name}” deleted."),deleteFailMessage:Craft.t("app","Couldn’t delete “{name}”."),onReorderItems:$.noop,onDeleteItem:$.noop}})},6872:function(){Craft.AssetImageEditor=Garnish.Modal.extend({$body:null,$footer:null,$imageTools:null,$buttons:null,$cancelBtn:null,$replaceBtn:null,$saveBtn:null,$focalPointBtn:null,$editorContainer:null,$straighten:null,$croppingCanvas:null,$spinner:null,$constraintContainer:null,$constraintRadioInputs:null,$customConstraints:null,canvas:null,image:null,viewport:null,focalPoint:null,focalPointInnerCircle:null,focalPointOuterCircle:null,focalPointPickedIndicator:null,grid:null,croppingCanvas:null,clipper:null,croppingRectangle:null,cropperHandles:null,cropperGrid:null,croppingShade:null,imageStraightenAngle:0,viewportRotation:0,originalWidth:0,originalHeight:0,imageVerticeCoords:null,zoomRatio:1,animationInProgress:!1,currentView:"",assetId:null,cacheBust:null,draggingCropper:!1,scalingCropper:!1,handleClicked:!1,draggingFocal:!1,focalPickedUp:!1,focalClicked:!1,cropperClicked:!1,previousMouseX:0,previousMouseY:0,shiftKeyHeld:!1,editorHeight:0,editorWidth:0,cropperState:!1,scaleFactor:1,flipData:{},focalPointState:!1,maxImageSize:null,lastLoadedDimensions:null,imageIsLoading:!1,mouseMoveEvent:null,croppingConstraint:!1,constraintOrientation:"landscape",showingCustomConstraint:!1,saving:!1,renderImage:null,renderCropper:null,_queue:null,init:function(t,e){var n=this;this._queue=new Craft.Queue,this.cacheBust=Date.now(),this.setSettings(e,Craft.AssetImageEditor.defaults),null===this.settings.allowDegreeFractions&&(this.settings.allowDegreeFractions=Craft.isImagick),Garnish.prefersReducedMotion()&&(this.settings.animationDuration=1),this.assetId=t,this.flipData={x:0,y:0},this.$container=$('
').appendTo(Garnish.$bod),this.$body=$('
').appendTo(this.$container),this.$footer=$('
').appendTo(this.$container),this.base(this.$container,this.settings),this.$buttons=$('
').appendTo(this.$footer),this.$cancelBtn=$("
\n");var l=function(n){function i(){return function(t,e){if(!(t instanceof e))throw new TypeError("Cannot call a class as a function")}(this,i),function(e,n,i){return n=s(n),function(e,n){if(n&&("object"===t(n)||"function"==typeof n))return n;if(void 0!==n)throw new TypeError("Derived constructors may only return object or undefined");return function(t){if(void 0===t)throw new ReferenceError("this hasn't been initialised - super() hasn't been called");return t}(e)}(e,r()?Reflect.construct(n,i||[],s(e).constructor):n.apply(e,i))}(this,i,arguments)}var l,c,h;return function(t,e){if("function"!=typeof e&&null!==e)throw new TypeError("Super expression must either be null or a function");t.prototype=Object.create(e&&e.prototype,{constructor:{value:t,writable:!0,configurable:!0}}),Object.defineProperty(t,"prototype",{writable:!1}),e&&a(t,e)}(i,n),l=i,h=[{key:"observedAttributes",get:function(){return["visible"]}}],(c=[{key:"connectedCallback",value:function(){this.root=this;var t=o.content.cloneNode(!0);this.root.append(t),"true"===this.visible&&this.wrapper.classList.remove("hidden"),this.initialized=!0}},{key:"visible",get:function(){return this.getAttribute("visible")},set:function(t){this.setAttribute("visible",t)}},{key:"messageWrapper",get:function(){return this.querySelector(".message")}},{key:"wrapper",get:function(){return this.querySelector(".wrapper")}},{key:"attributeChangedCallback",value:function(t,e,n){if(this.initialized)return"visible"===t.toLowerCase()?"true"===n?this.show():this.hide():void 0}},{key:"disconnectedCallback",value:function(){}},{key:"show",value:function(){this.wrapper.classList.remove("hidden"),this.dispatchEvent(new CustomEvent("show"))}},{key:"hide",value:function(){this.wrapper.classList.add("hidden"),this.dispatchEvent(new CustomEvent("hide"))}},{key:"focus",value:function(){this.wrapper.focus()}}])&&e(l.prototype,c),h&&e(l,h),Object.defineProperty(l,"prototype",{writable:!1}),i}(i(HTMLElement));customElements.define("craft-spinner",l)},691:function(){function t(e){return t="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(t){return typeof t}:function(t){return t&&"function"==typeof Symbol&&t.constructor===Symbol&&t!==Symbol.prototype?"symbol":typeof t},t(e)}function e(t,e){return function(t){if(Array.isArray(t))return t}(t)||function(t,e){var n=null==t?null:"undefined"!=typeof Symbol&&t[Symbol.iterator]||t["@@iterator"];if(null!=n){var i,r,a,s,o=[],l=!0,c=!1;try{if(a=(n=n.call(t)).next,0===e){if(Object(n)!==n)return;l=!1}else for(;!(l=(i=a.call(n)).done)&&(o.push(i.value),o.length!==e);l=!0);}catch(t){c=!0,r=t}finally{try{if(!l&&null!=n.return&&(s=n.return(),Object(s)!==s))return}finally{if(c)throw r}}return o}}(t,e)||r(t,e)||function(){throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}()}function n(){"use strict";n=function(){return i};var e,i={},r=Object.prototype,a=r.hasOwnProperty,s=Object.defineProperty||function(t,e,n){t[e]=n.value},o="function"==typeof Symbol?Symbol:{},l=o.iterator||"@@iterator",c=o.asyncIterator||"@@asyncIterator",h=o.toStringTag||"@@toStringTag";function u(t,e,n){return Object.defineProperty(t,e,{value:n,enumerable:!0,configurable:!0,writable:!0}),t[e]}try{u({},"")}catch(e){u=function(t,e,n){return t[e]=n}}function d(t,e,n,i){var r=e&&e.prototype instanceof y?e:y,a=Object.create(r.prototype),o=new P(i||[]);return s(a,"_invoke",{value:E(t,n,o)}),a}function f(t,e,n){try{return{type:"normal",arg:t.call(e,n)}}catch(t){return{type:"throw",arg:t}}}i.wrap=d;var p="suspendedStart",g="suspendedYield",m="executing",v="completed",b={};function y(){}function C(){}function $(){}var w={};u(w,l,(function(){return this}));var _=Object.getPrototypeOf,S=_&&_(_(M([])));S&&S!==r&&a.call(S,l)&&(w=S);var x=$.prototype=y.prototype=Object.create(w);function I(t){["next","throw","return"].forEach((function(e){u(t,e,(function(t){return this._invoke(e,t)}))}))}function T(e,n){function i(r,s,o,l){var c=f(e[r],e,s);if("throw"!==c.type){var h=c.arg,u=h.value;return u&&"object"==t(u)&&a.call(u,"__await")?n.resolve(u.__await).then((function(t){i("next",t,o,l)}),(function(t){i("throw",t,o,l)})):n.resolve(u).then((function(t){h.value=t,o(h)}),(function(t){return i("throw",t,o,l)}))}l(c.arg)}var r;s(this,"_invoke",{value:function(t,e){function a(){return new n((function(n,r){i(t,e,n,r)}))}return r=r?r.then(a,a):a()}})}function E(t,n,i){var r=p;return function(a,s){if(r===m)throw new Error("Generator is already running");if(r===v){if("throw"===a)throw s;return{value:e,done:!0}}for(i.method=a,i.arg=s;;){var o=i.delegate;if(o){var l=k(o,i);if(l){if(l===b)continue;return l}}if("next"===i.method)i.sent=i._sent=i.arg;else if("throw"===i.method){if(r===p)throw r=v,i.arg;i.dispatchException(i.arg)}else"return"===i.method&&i.abrupt("return",i.arg);r=m;var c=f(t,n,i);if("normal"===c.type){if(r=i.done?v:g,c.arg===b)continue;return{value:c.arg,done:i.done}}"throw"===c.type&&(r=v,i.method="throw",i.arg=c.arg)}}}function k(t,n){var i=n.method,r=t.iterator[i];if(r===e)return n.delegate=null,"throw"===i&&t.iterator.return&&(n.method="return",n.arg=e,k(t,n),"throw"===n.method)||"return"!==i&&(n.method="throw",n.arg=new TypeError("The iterator does not provide a '"+i+"' method")),b;var a=f(r,t.iterator,n.arg);if("throw"===a.type)return n.method="throw",n.arg=a.arg,n.delegate=null,b;var s=a.arg;return s?s.done?(n[t.resultName]=s.value,n.next=t.nextLoc,"return"!==n.method&&(n.method="next",n.arg=e),n.delegate=null,b):s:(n.method="throw",n.arg=new TypeError("iterator result is not an object"),n.delegate=null,b)}function L(t){var e={tryLoc:t[0]};1 in t&&(e.catchLoc=t[1]),2 in t&&(e.finallyLoc=t[2],e.afterLoc=t[3]),this.tryEntries.push(e)}function A(t){var e=t.completion||{};e.type="normal",delete e.arg,t.completion=e}function P(t){this.tryEntries=[{tryLoc:"root"}],t.forEach(L,this),this.reset(!0)}function M(n){if(n||""===n){var i=n[l];if(i)return i.call(n);if("function"==typeof n.next)return n;if(!isNaN(n.length)){var r=-1,s=function t(){for(;++r=0;--r){var s=this.tryEntries[r],o=s.completion;if("root"===s.tryLoc)return i("end");if(s.tryLoc<=this.prev){var l=a.call(s,"catchLoc"),c=a.call(s,"finallyLoc");if(l&&c){if(this.prev=0;--n){var i=this.tryEntries[n];if(i.tryLoc<=this.prev&&a.call(i,"finallyLoc")&&this.prev=0;--e){var n=this.tryEntries[e];if(n.finallyLoc===t)return this.complete(n.completion,n.afterLoc),A(n),b}},catch:function(t){for(var e=this.tryEntries.length-1;e>=0;--e){var n=this.tryEntries[e];if(n.tryLoc===t){var i=n.completion;if("throw"===i.type){var r=i.arg;A(n)}return r}}throw new Error("illegal catch attempt")},delegateYield:function(t,n,i){return this.delegate={iterator:M(t),resultName:n,nextLoc:i},"next"===this.method&&(this.arg=e),b}},i}function i(t){return function(t){if(Array.isArray(t))return a(t)}(t)||function(t){if("undefined"!=typeof Symbol&&null!=t[Symbol.iterator]||null!=t["@@iterator"])return Array.from(t)}(t)||r(t)||function(){throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}()}function r(t,e){if(t){if("string"==typeof t)return a(t,e);var n=Object.prototype.toString.call(t).slice(8,-1);return"Object"===n&&t.constructor&&(n=t.constructor.name),"Map"===n||"Set"===n?Array.from(t):"Arguments"===n||/^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)?a(t,e):void 0}}function a(t,e){(null==e||e>t.length)&&(e=t.length);for(var n=0,i=new Array(e);n').appendTo(Garnish.$bod);this.$sidebar=$('
').appendTo(i).attr({role:"navigation","aria-label":Craft.t("app","Source")}),this.$sourcesContainer=$('
').appendTo(this.$sidebar),this.$sourceSettingsContainer=$('
').appendTo(i),this.$footer=$('
').appendTo(i),this.$footerBtnContainer=$('
').appendTo(this.$footer),this.$cancelBtn=$("