From 5352c9512bd25fad97222849d5350f8bdb0fccb1 Mon Sep 17 00:00:00 2001 From: Brian Canini <canini.16@osu.edu> Date: Wed, 14 Aug 2019 10:21:56 -0400 Subject: [PATCH] new module - rebuild_cache_access: This module provides a new permission: rebuild cache access. Every role with this permission set will have a nice and big "Rebuild Cache" admin toolbar button. Clicking this button simply fires drupal_flush_all_caches() --- composer.json | 1 + composer.lock | 49 ++- vendor/composer/autoload_classmap.php | 2 + vendor/composer/autoload_static.php | 2 + vendor/composer/installed.json | 49 +++ web/modules/rebuild_cache_access/LICENSE.txt | 339 ++++++++++++++++++ web/modules/rebuild_cache_access/README.md | 17 + .../css/rebuild-cache-access.toolbar.css | 38 ++ .../rebuild_cache_access/icons/recycle.svg | 3 + .../rebuild_cache_access.info.yml | 15 + .../rebuild_cache_access.libraries.yml | 5 + .../rebuild_cache_access.module | 46 +++ .../rebuild_cache_access.permissions.yml | 2 + .../rebuild_cache_access.routing.yml | 9 + .../RebuildCacheAccessController.php | 53 +++ .../src/ToolbarHandler.php | 98 +++++ .../tests/src/Functional/ToolbarTest.php | 66 ++++ 17 files changed, 793 insertions(+), 1 deletion(-) create mode 100644 web/modules/rebuild_cache_access/LICENSE.txt create mode 100644 web/modules/rebuild_cache_access/README.md create mode 100644 web/modules/rebuild_cache_access/css/rebuild-cache-access.toolbar.css create mode 100644 web/modules/rebuild_cache_access/icons/recycle.svg create mode 100644 web/modules/rebuild_cache_access/rebuild_cache_access.info.yml create mode 100644 web/modules/rebuild_cache_access/rebuild_cache_access.libraries.yml create mode 100644 web/modules/rebuild_cache_access/rebuild_cache_access.module create mode 100644 web/modules/rebuild_cache_access/rebuild_cache_access.permissions.yml create mode 100644 web/modules/rebuild_cache_access/rebuild_cache_access.routing.yml create mode 100644 web/modules/rebuild_cache_access/src/Controller/RebuildCacheAccessController.php create mode 100644 web/modules/rebuild_cache_access/src/ToolbarHandler.php create mode 100644 web/modules/rebuild_cache_access/tests/src/Functional/ToolbarTest.php diff --git a/composer.json b/composer.json index 6744661d41..a3beb42004 100644 --- a/composer.json +++ b/composer.json @@ -152,6 +152,7 @@ "drupal/paragraphs": "1.6", "drupal/pathauto": "1.0", "drupal/realname": "^1.0@RC", + "drupal/rebuild_cache_access": "^1.4", "drupal/recaptcha": "^2.4", "drupal/redirect": "^1.3", "drupal/redis": "1.0", diff --git a/composer.lock b/composer.lock index 82e47ddba1..82f3c24b1f 100644 --- a/composer.lock +++ b/composer.lock @@ -4,7 +4,7 @@ "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies", "This file is @generated automatically" ], - "content-hash": "17eeff467ad7e469cf72b3edf5b29978", + "content-hash": "5056e5a2711a189970d0b393b769b6a8", "packages": [ { "name": "alchemy/zippy", @@ -6511,6 +6511,53 @@ "issues": "https://www.drupal.org/project/issues/realname" } }, + { + "name": "drupal/rebuild_cache_access", + "version": "1.4.0", + "source": { + "type": "git", + "url": "https://git.drupalcode.org/project/rebuild_cache_access.git", + "reference": "8.x-1.4" + }, + "dist": { + "type": "zip", + "url": "https://ftp.drupal.org/files/projects/rebuild_cache_access-8.x-1.4.zip", + "reference": "8.x-1.4", + "shasum": "31766f60f6f7dfeb29001f4532d457cfb6cbb3dd" + }, + "require": { + "drupal/core": "*" + }, + "type": "drupal-module", + "extra": { + "branch-alias": { + "dev-1.x": "1.x-dev" + }, + "drupal": { + "version": "8.x-1.4", + "datestamp": "1523998080", + "security-coverage": { + "status": "covered", + "message": "Covered by Drupal's security advisory policy" + } + } + }, + "notification-url": "https://packages.drupal.org/8/downloads", + "license": [ + "GPL-2.0-or-later" + ], + "authors": [ + { + "name": "leymannx", + "homepage": "https://www.drupal.org/user/2482808" + } + ], + "description": "Provide a Rebuild Cache admin toolbar button accessible to every role with the corresponding permission set.", + "homepage": "https://www.drupal.org/project/rebuild_cache_access", + "support": { + "source": "https://git.drupalcode.org/project/rebuild_cache_access" + } + }, { "name": "drupal/recaptcha", "version": "2.4.0", diff --git a/vendor/composer/autoload_classmap.php b/vendor/composer/autoload_classmap.php index 58182d5d45..0866de11b1 100644 --- a/vendor/composer/autoload_classmap.php +++ b/vendor/composer/autoload_classmap.php @@ -2201,6 +2201,8 @@ 'Drupal\\Core\\Language\\LanguageManager' => $baseDir . '/web/core/lib/Drupal/Core/Language/LanguageManager.php', 'Drupal\\Core\\Language\\LanguageManagerInterface' => $baseDir . '/web/core/lib/Drupal/Core/Language/LanguageManagerInterface.php', 'Drupal\\Core\\Layout\\Annotation\\Layout' => $baseDir . '/web/core/lib/Drupal/Core/Layout/Annotation/Layout.php', + 'Drupal\\Core\\Layout\\Icon\\IconBuilderInterface' => $baseDir . '/web/core/lib/Drupal/Core/Layout/Icon/IconBuilderInterface.php', + 'Drupal\\Core\\Layout\\Icon\\SvgIconBuilder' => $baseDir . '/web/core/lib/Drupal/Core/Layout/Icon/SvgIconBuilder.php', 'Drupal\\Core\\Layout\\LayoutDefault' => $baseDir . '/web/core/lib/Drupal/Core/Layout/LayoutDefault.php', 'Drupal\\Core\\Layout\\LayoutDefinition' => $baseDir . '/web/core/lib/Drupal/Core/Layout/LayoutDefinition.php', 'Drupal\\Core\\Layout\\LayoutInterface' => $baseDir . '/web/core/lib/Drupal/Core/Layout/LayoutInterface.php', diff --git a/vendor/composer/autoload_static.php b/vendor/composer/autoload_static.php index 831410e988..8e61c95c20 100644 --- a/vendor/composer/autoload_static.php +++ b/vendor/composer/autoload_static.php @@ -2847,6 +2847,8 @@ class ComposerStaticInit5c689ffcd54b9e495ed983fdce09b530 'Drupal\\Core\\Language\\LanguageManager' => __DIR__ . '/../..' . '/web/core/lib/Drupal/Core/Language/LanguageManager.php', 'Drupal\\Core\\Language\\LanguageManagerInterface' => __DIR__ . '/../..' . '/web/core/lib/Drupal/Core/Language/LanguageManagerInterface.php', 'Drupal\\Core\\Layout\\Annotation\\Layout' => __DIR__ . '/../..' . '/web/core/lib/Drupal/Core/Layout/Annotation/Layout.php', + 'Drupal\\Core\\Layout\\Icon\\IconBuilderInterface' => __DIR__ . '/../..' . '/web/core/lib/Drupal/Core/Layout/Icon/IconBuilderInterface.php', + 'Drupal\\Core\\Layout\\Icon\\SvgIconBuilder' => __DIR__ . '/../..' . '/web/core/lib/Drupal/Core/Layout/Icon/SvgIconBuilder.php', 'Drupal\\Core\\Layout\\LayoutDefault' => __DIR__ . '/../..' . '/web/core/lib/Drupal/Core/Layout/LayoutDefault.php', 'Drupal\\Core\\Layout\\LayoutDefinition' => __DIR__ . '/../..' . '/web/core/lib/Drupal/Core/Layout/LayoutDefinition.php', 'Drupal\\Core\\Layout\\LayoutInterface' => __DIR__ . '/../..' . '/web/core/lib/Drupal/Core/Layout/LayoutInterface.php', diff --git a/vendor/composer/installed.json b/vendor/composer/installed.json index 6e89ad29b0..6c658fe890 100644 --- a/vendor/composer/installed.json +++ b/vendor/composer/installed.json @@ -6712,6 +6712,55 @@ "issues": "https://www.drupal.org/project/issues/realname" } }, + { + "name": "drupal/rebuild_cache_access", + "version": "1.4.0", + "version_normalized": "1.4.0.0", + "source": { + "type": "git", + "url": "https://git.drupalcode.org/project/rebuild_cache_access.git", + "reference": "8.x-1.4" + }, + "dist": { + "type": "zip", + "url": "https://ftp.drupal.org/files/projects/rebuild_cache_access-8.x-1.4.zip", + "reference": "8.x-1.4", + "shasum": "31766f60f6f7dfeb29001f4532d457cfb6cbb3dd" + }, + "require": { + "drupal/core": "*" + }, + "type": "drupal-module", + "extra": { + "branch-alias": { + "dev-1.x": "1.x-dev" + }, + "drupal": { + "version": "8.x-1.4", + "datestamp": "1523998080", + "security-coverage": { + "status": "covered", + "message": "Covered by Drupal's security advisory policy" + } + } + }, + "installation-source": "dist", + "notification-url": "https://packages.drupal.org/8/downloads", + "license": [ + "GPL-2.0-or-later" + ], + "authors": [ + { + "name": "leymannx", + "homepage": "https://www.drupal.org/user/2482808" + } + ], + "description": "Provide a Rebuild Cache admin toolbar button accessible to every role with the corresponding permission set.", + "homepage": "https://www.drupal.org/project/rebuild_cache_access", + "support": { + "source": "https://git.drupalcode.org/project/rebuild_cache_access" + } + }, { "name": "drupal/recaptcha", "version": "2.4.0", diff --git a/web/modules/rebuild_cache_access/LICENSE.txt b/web/modules/rebuild_cache_access/LICENSE.txt new file mode 100644 index 0000000000..d159169d10 --- /dev/null +++ b/web/modules/rebuild_cache_access/LICENSE.txt @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + <signature of Ty Coon>, 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. diff --git a/web/modules/rebuild_cache_access/README.md b/web/modules/rebuild_cache_access/README.md new file mode 100644 index 0000000000..a902bd502a --- /dev/null +++ b/web/modules/rebuild_cache_access/README.md @@ -0,0 +1,17 @@ +# Rebuild Cache Access + +https://www.drupal.org/project/rebuild_cache_access + +This module provides a new permission: `rebuild cache access`. Every role with +this permission set will have a nice and big Rebuild Cache admin toolbar button. +Clicking this button simply fires [`drupal_flush_all_caches()`][1]. That's all. + +Note: Normally it should be sufficient that all relevant caches are flushed +automatically when changes to content are made. Nevertheless in real world it +sometimes may be necessary to have other roles than the ones with `administer +site configuration` permission being able to rebuild the caches. + +![Rebuild cache toolbar button screenshot][2] + +[1]: https://api.drupal.org/api/drupal/core%21includes%21common.inc/function/drupal_flush_all_caches/8.5.x +[2]: https://www.drupal.org/files/project-images/drupal_rebuild_cache_access.png diff --git a/web/modules/rebuild_cache_access/css/rebuild-cache-access.toolbar.css b/web/modules/rebuild_cache_access/css/rebuild-cache-access.toolbar.css new file mode 100644 index 0000000000..a288590fec --- /dev/null +++ b/web/modules/rebuild_cache_access/css/rebuild-cache-access.toolbar.css @@ -0,0 +1,38 @@ +/** + * @file + * Styling for rebuild-cache-access toolbar module. + */ + +.toolbar .toolbar-tray-vertical .edit-rebuild-cache-access-toolbar { + text-align: right; /* LTR */ + padding: 1em; +} +[dir="rtl"] .toolbar .toolbar-tray-vertical .edit-rebuild-cache-access-toolbar { + text-align: left; +} + +.toolbar .toolbar-tray-horizontal .edit-rebuild-cache-access-toolbar { + float: right; /* LTR */ +} +[dir="rtl"] .toolbar .toolbar-tray-horizontal .edit-rebuild-cache-access-toolbar { + float: left; +} + +.toolbar .toolbar-tray-horizontal .toolbar-menu { + float: left; /* LTR */ +} +[dir="rtl"] .toolbar .toolbar-tray-horizontal .toolbar-menu { + float: right; +} + +.toolbar .toolbar-bar .toolbar-icon-rebuild-cache-access:before { + background-image: url(../icons/recycle.svg); +} +.toolbar-bar .toolbar-icon-rebuild-cache-access:active:before, +.toolbar-bar .toolbar-icon-rebuild-cache-access.is-active:before { + background-image: url(../icons/recycle.svg); +} + +.toolbar-horizontal .toolbar-horizontal-item-hidden { + display: none; +} diff --git a/web/modules/rebuild_cache_access/icons/recycle.svg b/web/modules/rebuild_cache_access/icons/recycle.svg new file mode 100644 index 0000000000..e61f619c86 --- /dev/null +++ b/web/modules/rebuild_cache_access/icons/recycle.svg @@ -0,0 +1,3 @@ +<svg xmlns="http://www.w3.org/2000/svg" width="625" height="625"> + <path fill="#bebebe" d="M10 207l38 30-36 69c-18 32 13 63 33 74 19 11 50 12 78 12l51-83 38 21-66-123-135 1m6 169l82 152c17 21 48 26 80 25h87V410l-165-1c-26 2-59-4-85-32M533 97l-45 19-43-65c-19-31-61-19-80-7s-34 38-48 62l48 85-37 23 140 2 65-119zM382 20l-173-2c-26 4-46 29-61 58l-42 76 126 70 81-143c11-23 32-50 69-58m8 586l5-48 78-6c37-2 46-44 45-67-1-22-16-48-31-72l-97.16.925-3-43-69 122 73 114m140-94l85-150c9-25-3-54-21-81l-46-74-122 76 86 140c15 21 28 52 17 89z"/> +</svg> diff --git a/web/modules/rebuild_cache_access/rebuild_cache_access.info.yml b/web/modules/rebuild_cache_access/rebuild_cache_access.info.yml new file mode 100644 index 0000000000..376cba5252 --- /dev/null +++ b/web/modules/rebuild_cache_access/rebuild_cache_access.info.yml @@ -0,0 +1,15 @@ +name: Rebuild Cache Access +description: Provide a Rebuild Cache admin toolbar button accessible to every role with the corresponding permission set. +package: Utility + +type: module +# core: 8.x + +dependencies: + - drupal:toolbar + +# Information added by Drupal.org packaging script on 2018-04-17 +version: '8.x-1.4' +core: '8.x' +project: 'rebuild_cache_access' +datestamp: 1523998084 diff --git a/web/modules/rebuild_cache_access/rebuild_cache_access.libraries.yml b/web/modules/rebuild_cache_access/rebuild_cache_access.libraries.yml new file mode 100644 index 0000000000..8e2f556102 --- /dev/null +++ b/web/modules/rebuild_cache_access/rebuild_cache_access.libraries.yml @@ -0,0 +1,5 @@ +rebuild-cache-access-toolbar: + version: VERSION + css: + component: + css/rebuild-cache-access.toolbar.css: {} diff --git a/web/modules/rebuild_cache_access/rebuild_cache_access.module b/web/modules/rebuild_cache_access/rebuild_cache_access.module new file mode 100644 index 0000000000..e35a566097 --- /dev/null +++ b/web/modules/rebuild_cache_access/rebuild_cache_access.module @@ -0,0 +1,46 @@ +<?php + +/** + * @file + * This module adds a 'Rebuild Cache' permission and button to the toolbar. + */ + +use Drupal\rebuild_cache_access\ToolbarHandler; + +/** + * Implements hook_toolbar(). + */ +function rebuild_cache_access_toolbar() { + + return \Drupal::service('class_resolver') + ->getInstanceFromDefinition(ToolbarHandler::class) + ->toolbar(); +} + +/** + * Implements hook_help(). + */ +function rebuild_cache_access_help($route_name, \Drupal\Core\Routing\RouteMatchInterface $route_match) { + + switch ($route_name) { + case 'help.page.rebuild_cache_access': + + $text = file_get_contents(dirname(__FILE__) . "/README.md"); + + if (!\Drupal::moduleHandler()->moduleExists('markdown')) { + return '<pre>' . $text . '</pre>'; + } + else { + // Use the Markdown filter to render the README. + $filter_manager = \Drupal::service('plugin.manager.filter'); + $settings = \Drupal::configFactory() + ->get('markdown.settings') + ->getRawData(); + $config = ['settings' => $settings]; + $filter = $filter_manager->createInstance('markdown', $config); + return $filter->process($text, 'en'); + } + } + + return NULL; +} diff --git a/web/modules/rebuild_cache_access/rebuild_cache_access.permissions.yml b/web/modules/rebuild_cache_access/rebuild_cache_access.permissions.yml new file mode 100644 index 0000000000..206dfdfd42 --- /dev/null +++ b/web/modules/rebuild_cache_access/rebuild_cache_access.permissions.yml @@ -0,0 +1,2 @@ +rebuild cache access: + title: 'Rebuild Cache' diff --git a/web/modules/rebuild_cache_access/rebuild_cache_access.routing.yml b/web/modules/rebuild_cache_access/rebuild_cache_access.routing.yml new file mode 100644 index 0000000000..b2b9a1fa0b --- /dev/null +++ b/web/modules/rebuild_cache_access/rebuild_cache_access.routing.yml @@ -0,0 +1,9 @@ +rebuild_cache_access.rebuild_cache: + path: '/rebuild-cache-access/rebuild-cache' + defaults: + _controller: '\Drupal\rebuild_cache_access\Controller\RebuildCacheAccessController::rebuildCache' + _title: 'Rebuild cache' + options: + _admin_route: TRUE + requirements: + _permission: 'rebuild cache access' diff --git a/web/modules/rebuild_cache_access/src/Controller/RebuildCacheAccessController.php b/web/modules/rebuild_cache_access/src/Controller/RebuildCacheAccessController.php new file mode 100644 index 0000000000..fb0d9e32fc --- /dev/null +++ b/web/modules/rebuild_cache_access/src/Controller/RebuildCacheAccessController.php @@ -0,0 +1,53 @@ +<?php + +namespace Drupal\rebuild_cache_access\Controller; + +use Drupal\Core\Controller\ControllerBase; +use Symfony\Component\DependencyInjection\ContainerInterface; +use Symfony\Component\HttpFoundation\RequestStack; +use Symfony\Component\HttpFoundation\RedirectResponse; + +/** + * Returns responses for rebuild_cache_access module routes. + */ +class RebuildCacheAccessController extends ControllerBase { + + /** + * {@inheritdoc} + */ + public function __construct(RequestStack $request_stack) { + $this->requestStack = $request_stack; + } + + /** + * {@inheritdoc} + */ + public static function create(ContainerInterface $container) { + return new static( + $container->get('request_stack') + ); + } + + /** + * Reload the previous page. + */ + public function reloadPage() { + $request = $this->requestStack->getCurrentRequest(); + if ($request->server->get('HTTP_REFERER')) { + return $request->server->get('HTTP_REFERER'); + } + else { + return '/'; + } + } + + /** + * Rebuild all caches, then redirects to the previous page. + */ + public function rebuildCache() { + drupal_flush_all_caches(); + drupal_set_message($this->t('All caches cleared.')); + return new RedirectResponse($this->reloadPage()); + } + +} diff --git a/web/modules/rebuild_cache_access/src/ToolbarHandler.php b/web/modules/rebuild_cache_access/src/ToolbarHandler.php new file mode 100644 index 0000000000..550bfc6cf3 --- /dev/null +++ b/web/modules/rebuild_cache_access/src/ToolbarHandler.php @@ -0,0 +1,98 @@ +<?php + +namespace Drupal\rebuild_cache_access; + +use Drupal\Core\Config\ConfigFactoryInterface; +use Drupal\Core\DependencyInjection\ContainerInjectionInterface; +use Drupal\Core\Menu\MenuLinkTreeInterface; +use Drupal\Core\Session\AccountProxyInterface; +use Drupal\Core\StringTranslation\StringTranslationTrait; +use Drupal\Core\Url; +use Symfony\Component\DependencyInjection\ContainerInterface; + +/** + * Toolbar integration handler. + */ +class ToolbarHandler implements ContainerInjectionInterface { + + use StringTranslationTrait; + + /** + * The menu link tree service. + * + * @var \Drupal\Core\Menu\MenuLinkTreeInterface + */ + protected $menuLinkTree; + + /** + * The current user. + * + * @var \Drupal\Core\Session\AccountProxyInterface + */ + protected $account; + + /** + * ToolbarHandler constructor. + * + * @param \Drupal\Core\Menu\MenuLinkTreeInterface $menu_link_tree + * The menu link tree service. + * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory + * The config factory. + * @param \Drupal\Core\Session\AccountProxyInterface $account + * The current user. + */ + public function __construct(MenuLinkTreeInterface $menu_link_tree, ConfigFactoryInterface $config_factory, AccountProxyInterface $account) { + $this->menuLinkTree = $menu_link_tree; + $this->account = $account; + } + + /** + * {@inheritdoc} + */ + public static function create(ContainerInterface $container) { + return new static( + $container->get('toolbar.menu_tree'), + $container->get('config.factory'), + $container->get('current_user') + ); + } + + /** + * Hook bridge. + * + * @return array + * The devel toolbar items render array. + * + * @see hook_toolbar() + */ + public function toolbar() { + + $items['rebuild_cache_access'] = [ + '#cache' => [ + 'contexts' => ['user.permissions'], + ], + ]; + + if ($this->account->hasPermission('rebuild cache access')) { + $items['rebuild_cache_access'] += [ + '#type' => 'toolbar_item', + '#weight' => 999, + 'tab' => [ + '#type' => 'link', + '#title' => $this->t('Rebuild Cache'), + '#url' => Url::fromRoute('rebuild_cache_access.rebuild_cache'), + '#attributes' => [ + 'title' => $this->t('Rebuild Cache Access'), + 'class' => ['toolbar-icon', 'toolbar-icon-rebuild-cache-access'], + ], + ], + '#attached' => [ + 'library' => 'rebuild_cache_access/rebuild-cache-access-toolbar', + ], + ]; + } + + return $items; + } + +} diff --git a/web/modules/rebuild_cache_access/tests/src/Functional/ToolbarTest.php b/web/modules/rebuild_cache_access/tests/src/Functional/ToolbarTest.php new file mode 100644 index 0000000000..9896beffe6 --- /dev/null +++ b/web/modules/rebuild_cache_access/tests/src/Functional/ToolbarTest.php @@ -0,0 +1,66 @@ +<?php + +namespace Drupal\Tests\rebuild_cache_access\Functional; + +use Drupal\Tests\BrowserTestBase; + +/** + * Tests rebuild_cache_access toolbar functionality. + * + * @group rebuild_cache_access + */ +class ToolbarTest extends BrowserTestBase { + + /** + * {@inheritdoc} + */ + public static $modules = ['toolbar', 'rebuild_cache_access']; + + /** + * Tests that the necessary route works. + */ + public function testRoute() { + + // First, a user without rebuild cache permission should not be allowed + // to access the route. + $this->drupalGet('rebuild-cache-access/rebuild-cache'); + $this->assertSession()->statusCodeEquals(403); + + // Second, a user with rebuild cache permission should be allowed + // to access the route. + $account = $this->drupalCreateUser(['rebuild cache access']); + $this->drupalLogin($account); + + $this->drupalGet('rebuild-cache-access/rebuild-cache'); + $this->assertSession()->statusCodeEquals(200); + } + + /** + * Tests that the toolbar button works. + */ + public function testButton() { + + // First, a user without rebuild cache permission should not see the button. + $editor = $this->drupalCreateUser([ + 'access toolbar', + ]); + $this->drupalLogin($editor); + + $this->drupalGet(''); + $this->assertSession()->pageTextNotContains('Rebuild Cache'); + + // Second, a user with rebuild cache permission should see the button. + $developer = $this->drupalCreateUser([ + 'access toolbar', + 'rebuild cache access', + ]); + $this->drupalLogin($developer); + + $this->drupalGet(''); + $this->assertSession()->pageTextContains('Rebuild Cache'); + + // Click the button. + $this->clickLink('Rebuild Cache'); + $this->assertSession()->pageTextContains('All caches cleared.'); + } +} -- GitLab