initial commit

Author: Willem Wigman

CONTRIBUTING.md

@@ -0,0 +1,64 @@
+# Contributing to IntegerNet_GlobalCustomLayout
+We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
+
+- Reporting a bug
+- Discussing the current state of the code
+- Submitting a fix
+- Proposing new features
+- Becoming a maintainer
+
+## We Develop with Github
+We use github to host code, to track issues and feature requests, as well as accept pull requests.
+
+## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
+Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests:
+
+1. Fork the repo and create your branch from `master`.
+2. If you've added code that should be tested, add tests.
+3. If you've changed APIs, update the documentation.
+4. Ensure the test suite passes.
+5. Make sure your code lints.
+6. Issue that pull request!
+
+## Any contributions you make will be under the MIT Software License
+In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.
+
+## Report bugs using Github's [issues](https://github.com/integer-net/magento2-global-custom-layout/issues)
+We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/integer-net/magento2-global-custom-layout/issues/new); it's that easy!
+
+## Write bug reports with detail, background, and sample code
+[This is an example](http://stackoverflow.com/q/12488905/180626) of a bug report I wrote, and I think it's not a bad model. Here's [another example from Craig Hockenberry](http://www.openradar.me/11905408), an app developer whom I greatly respect.
+
+**Great Bug Reports** tend to have:
+
+- A quick summary and/or background
+- Steps to reproduce
+  - Be specific!
+  - Give sample code if you can. [My stackoverflow question](http://stackoverflow.com/q/12488905/180626) includes sample code that *anyone* with a base R setup can run to reproduce what I was seeing
+- What you expected would happen
+- What actually happens
+- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
+
+People *love* thorough bug reports. I'm not even kidding.
+
+## Pull Requests
+
+- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - Check the code style with ``$ composer check-style`` and fix it with ``$ composer fix-style``.
+
+- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
+
+- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
+
+- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
+
+- **Create feature branches** - Don't ask us to pull from your master branch.
+
+- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
+
+- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
+
+## License
+By contributing, you agree that your contributions will be licensed under its MIT License.
+
+## References
+This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md) with additions from [ThePhpLeague Template](https://github.com/thephpleague/skeleton)

LICENSE.md

@@ -0,0 +1,7 @@
+Copyright 2020 integer_net GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,73 @@
+# Integer_Net GlobalCustomLayout
+
+[![Software License][ico-license]](LICENSE.md)
+
+Allows you to add global layout update files to be selected from admin, by using `0` instead of a `category_id` / `sku` / `url_path`.
+
+Compatible with Magento 2.3.4 and higher, since **cms-page/product/category specific layouts** where introduced in this version.
+
+## Purpose
+
+In Magento 2.3.4, [xml layout updates were removed from the Magento Admin](https://devdocs.magento.com/guides/v2.3/release-notes/release-notes-2-3-4-open-source.html#highlights), for security reasons.
+Previously this textfield allowed you to add XML Layout updates to any given Category, Product or CMS Page.
+After the update, this textfield is no longer available, but you can select custom layout updates which are defined in xml layout files in the filesystem.
+ 
+After uploading/deploying _selectable layout files_ onto your project's filesystem, these layouts can be selected from the admin under the **Design** section.
+The field is called **Custom Layout Update**.
+
+## Usage:
+
+Replace identifiers in selectable layouts with a 0 (zero).
+Add layout file to themes/modules using:
+ - catalog_category_view_selectable_0_<Layout Update Name>.xml for Categories
+ - catalog_product_view_selectable_0_<Layout Update Name>.xml for Products
+ - cms_page_view_selectable_0_<Layout Update Name>.xml for Cms pages
+ 
+These files can go anywhere where you'd normally put layout files. For example:
+`app/design/frontend/[Theme_Vendor]/[Theme_Name]/Magento_Theme/layout/catalog_category_view_0_customchanges.xml`
+
+You can now select the layout update at _any_ given Category/Product/Page, under **Custom layout update** field of **Design**.
+
+More info on default behaviour of selectable layouts: 
+[Magento DevDocs: Create cms-page/product/category-specific layouts](https://devdocs.magento.com/guides/v2.3/frontend-dev-guide/layouts/xml-manage.html#create-cms-pageproductcategory-specific-layouts)
+
+## Installation
+
+1. Install via composer
+    ```
+    composer require integer-net/magento2-global-custom-layout
+    ```
+2. Enable module
+    ```
+    bin/magento setup:upgrade
+    ```
+## Configuration
+
+Zero configuration needed.
+
+## Contributing
+
+Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
+
+## Known issues
+
+1. Does not work with the homepage (cms_index_index). But hey, it doesn't in the default Magento implementation either.
+
+## Security
+
+If you discover any security related issues, please email ww@integer-net.de instead of using the issue tracker.
+
+## Credits
+
+- [Willem Wigman][link-author]
+- [All Contributors][link-contributors]
+
+## License
+
+The MIT License (MIT). Please see [License File](LICENSE.txt) for more information.
+
+[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
+
+[link-packagist]: https://packagist.org/packages/integer-net/magento2-global-custom-layout
+[link-author]: https://github.com/wigman
+[link-contributors]: ../../contributors

composer.json

@@ -0,0 +1,38 @@
+{
+    "name": "integer-net/magento2-global-custom-layout",
+    "description": "Module for Magento 2 that allows you to add global layout update files to be selected from admin, by using '0' instead of an entity_id",
+    "authors": [
+        {
+            "name": "Willem Wigman",
+            "email": "ww@integer-net.de"
+        }
+    ],
+    "require": {
+        "magento/framework": ">=102.0.4",
+        "magento/module-catalog": ">=103.0.4",
+        "magento/module-cms": ">=103.0.4",
+        "php": ">=7.1.0"
+    },
+    "type": "magento2-module",
+    "license": [
+        "MIT"
+    ],
+    "autoload": {
+        "files": [
+            "src/registration.php"
+        ],
+        "psr-4": {
+            "IntegerNet\\GlobalCustomLayout\\": "src/"
+        }
+    },
+    "repositories": [
+        {
+            "type": "composer",
+            "url": "https://repo.magento.com/"
+        }
+    ],
+    "require-dev": {
+        "magento/magento-coding-standard": "@dev"
+    }
+}
+

src/Plugin/CategoryLayoutPlugin.php

@@ -0,0 +1,167 @@
+<?php
+declare(strict_types=1);
+
+namespace IntegerNet\GlobalCustomLayout\Plugin;
+
+use Magento\Catalog\Api\Data\CategoryInterface;
+use Magento\Catalog\Model\Category;
+use Magento\Catalog\Model\Category\Attribute\LayoutUpdateManager;
+use Magento\Framework\App\Area;
+use Magento\Framework\DataObject;
+use Magento\Framework\View\Design\Theme\FlyweightFactory;
+use Magento\Framework\View\DesignInterface;
+use Magento\Framework\View\Model\Layout\Merge as LayoutProcessor;
+use Magento\Framework\View\Model\Layout\MergeFactory as LayoutProcessorFactory;
+
+class CategoryLayoutPlugin
+{
+
+    /**
+     * @var FlyweightFactory
+     */
+    private $themeFactory;
+
+    /**
+     * @var DesignInterface
+     */
+    private $design;
+
+    /**
+     * @var LayoutProcessorFactory
+     */
+    private $layoutProcessorFactory;
+
+    /**
+     * @var LayoutProcessor|null
+     */
+    private $layoutProcessor;
+
+    /**
+     * @param FlyweightFactory $themeFactory
+     * @param DesignInterface $design
+     * @param LayoutProcessorFactory $layoutProcessorFactory
+     */
+    public function __construct(
+        FlyweightFactory $themeFactory,
+        DesignInterface $design,
+        LayoutProcessorFactory $layoutProcessorFactory
+    )
+    {
+        $this->themeFactory = $themeFactory;
+        $this->design = $design;
+        $this->layoutProcessorFactory = $layoutProcessorFactory;
+    }
+
+    /**
+     * Get the processor instance.
+     *
+     * @return LayoutProcessor
+     *
+     * Unchanged private method copied over from @var LayoutUpdateManager
+     */
+    private function getLayoutProcessor(): LayoutProcessor
+    {
+        if (!$this->layoutProcessor) {
+            $this->layoutProcessor = $this->layoutProcessorFactory->create(
+                [
+                    'theme' => $this->themeFactory->create(
+                        $this->design->getConfigurationDesignTheme(Area::AREA_FRONTEND)
+                    )
+                ]
+            );
+            $this->themeFactory = null;
+            $this->design = null;
+        }
+
+        return $this->layoutProcessor;
+    }
+
+    /**
+     * Fetch list of available global files/handles for the category.
+     *
+     * @param LayoutUpdateManager $subject
+     * @param array $result
+     * @param CategoryInterface $category
+     * @return array
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     */
+    public function afterFetchAvailableFiles(
+        LayoutUpdateManager $subject,
+        array $result,
+        CategoryInterface $category
+    ): array
+    {
+        if (!$category->getId()) {
+            return $result;
+        }
+
+        $handles = $this->getLayoutProcessor()->getAvailableHandles();
+
+        return array_merge($result, array_filter(
+            array_map(
+                function (string $handle) use ($category) : ?string {
+                    preg_match(
+                        '/^catalog\_category\_view\_selectable\_0\_([a-z0-9]+)/i',
+                        $handle,
+                        $selectable
+                    );
+                    if (!empty($selectable[1])) {
+                        return $selectable[1];
+                    }
+
+                    return null;
+                },
+                $handles
+            )
+        ));
+    }
+
+    /**
+     * Extract selected global custom layout settings.
+     *
+     * If no update is selected none will apply.
+     *
+     * @param LayoutUpdateManager $subject
+     * @param $result
+     * @param CategoryInterface $category
+     * @param DataObject $intoSettings
+     * @return void
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     */
+    public function afterExtractCustomSettings(
+        LayoutUpdateManager $subject,
+        $result,
+        CategoryInterface $category,
+        DataObject $intoSettings
+    ): void
+    {
+        if ($category->getId() && $value = $this->extractAttributeValue($category)) {
+            $handles = $intoSettings->getPageLayoutHandles() ?? [];
+            $handles = array_merge_recursive(
+                $handles,
+                ['selectable_0' => $value]
+            );
+            $intoSettings->setPageLayoutHandles($handles);
+        }
+    }
+
+    /**
+     * Extract custom layout attribute value.
+     *
+     * @param CategoryInterface $category
+     * @return mixed
+     *
+     * Unchanged private method copied over from @var LayoutUpdateManager
+     */
+    private function extractAttributeValue(CategoryInterface $category)
+    {
+        if ($category instanceof Category && !$category->hasData(CategoryInterface::CUSTOM_ATTRIBUTES)) {
+            return $category->getData('custom_layout_update_file');
+        }
+        if ($attr = $category->getCustomAttribute('custom_layout_update_file')) {
+            return $attr->getValue();
+        }
+
+        return null;
+    }
+}