The following PR will make this package compatibile with Composer version 2.

• Added .gitignore
• Track package dependencies via commited composer.locl
• Update Plugin adding missing PluginInterface methods
• Add missing constructor argument to src/Netresearch/Composer/Patches/Downloader/Composer.php

A major version bump is required here, due to the changes in src/Netresearch/Composer/Patches/Downloader/Composer.phpas the package can no longer be compatibile with both composer 1 and 2 simultaneously.

Consumers of this package can still require either version 1 or 2 as no pulic interfaces have changes.

{
    "require": {
        "netresearch/composer-patches-plugin": "^1.0 || ^2.0"
    }
}

For those wanting to use these changes now following instructions here: https://github.com/netresearch/composer-patches-plugin/pull/36#issuecomment-732773402

I added a patch with a wrong url, and I updated the url, but it is never updated when updateing composer. "drupal/drupal": { "7.35": [ { "title": "Fixes the ckeditor version not found 1 problem.", "url": "./patches/locale_throwing_notice_1.patch" } ] }

Hi,

I really like your Composer patch plug-in and would like to use it for my Magento projects. I created the following composer.json.

{
    "name": "shopbase-magento/patches",
    "version": "0.1.0",
    "type": "patches",
    "require": {
        "netresearch/composer-patches-plugin": "~1.0"
    },
    "extra": {
        "patches": {
            "magento/core":  {
                "1.9.1.0": {
                    "SUPEE-1533_EE_1.12_v1.patch": {
                        "title": "SUPEE-1533 - Addresses two potential remote code execution exploits. - Added Oct 3, 2014",
                        "url": "http://shopbase.nl/patches/SUPEE-1533_EE_1.12_v1.patch"
                    },
                    "SUPEE-5345_CE_1.7.0.2_v1.patch": {
                        "title": "SUPEE-5344 - Addresses a potential remote code execution exploit. - Added Feb 9, 2015",
                        "url": "http://shopbase.nl/patches/SUPEE-5345_CE_1.7.0.2_v1.patch"
                    }
                }
            }
        }
    }
}

But I get an error when running. This is probably because Magento (1) is not fully supporting composer. I'm therefor using the 'magento-hackathon/magento-composer-installer' module.

Error:

[Netresearch\Composer\Patches\PatchCommandException]                         
  Patch SUPEE-1533_EE_1.12_v1.patch would fail!                                
  Error executing command "patch -f -p1 --no-backup-if-mismatch -r - --dry-ru  
  n":                                                                          
  can't find file to patch at input line 8                                     
  Perhaps you used the wrong -p or --strip option?                             
  The text leading up to this was:                                             
  --------------------------                                                   
  |SUPEE-1533 | EE_1.12 | v1 | _ | n/a | SUPEE-1533_EE_1.12_v1.patch           
  |                                                                            
  |__PATCHFILE_FOLLOWS__                                                       
  |diff --git app/code/core/Mage/Adminhtml/Block/Dashboard/Graph.php app/code  
  /core/Mage/Adminhtml/Block/Dashboard/Graph.php                               
  |index c698108..6e256bb 100644                                               
  |--- app/code/core/Mage/Adminhtml/Block/Dashboard/Graph.php                  
  |+++ app/code/core/Mage/Adminhtml/Block/Dashboard/Graph.php                  
  --------------------------                                                   
  No file to patch.  Skipping patch.                                           
  1 out of 1 hunk ignored                                                      
  can't find file to patch at input line 21                                    
  Perhaps you used the wrong -p or --strip option?                             
  The text leading up to this was:                                             
  --------------------------                                                   
  |diff --git app/code/core/Mage/Adminhtml/controllers/DashboardController.ph  
  p app/code/core/Mage/Adminhtml/controllers/DashboardController.php           
  |index eebb471..f9cb8d2 100644                                               
  |--- app/code/core/Mage/Adminhtml/controllers/DashboardController.php        
  |+++ app/code/core/Mage/Adminhtml/controllers/DashboardController.php        
  --------------------------                                                   
  No file to patch.  Skipping patch.                                           
  1 out of 1 hunk ignored

I hope you can help with this. I really would like to use your module.

Best regards, Otto Smittenaar

When you've got a patch set and you add a new patch, composer update will try to patch all the set, instead of skipping those already applied, thus failing in the process.

A workaround for this would be to have a new package every time you add patches to the project but that's quite inconvenient.

Thanks for sharing your work!

I have been looking into your plugin in an attempt to use Composer for managing Drupal projects but I am having trouble deciphering how it is supposed to work.

Do you have a publicly available example of the plugin in action?

I'm using a repo with patches contained inside pulled in via this patching plugin for composer:

https://github.com/zVPS/laravel-patches/blob/v4.2.22/composer.json

When installing via composer and a custom directory e.g /vendor-install via COMPOSER_VENDOR_DIR= I get an error as the patches need to be relative to the project root.

This pull request adds the functionality to check for vendor/ paths and translate to COMPOSER_VENDOR_DIR if specified.

We define our patches using relative paths to local files for url:

https://github.com/art-institute-of-chicago/data-hub-foundation/blob/adbbb46b2e439c157dc581119aa2085fe0dd8a6c/composer.json

This was working great until recently. Our deployments broke because we upgraded one of our servers from Composer 2.2.9 to Composer 2.3.4. We started seeing this error:

In RemoteFilesystem.php line 124:

  [TypeError]
  Composer\Util\RemoteFilesystem::getContents(): Argument #1 ($originUrl) must be of type string, null given, called in /path/to/vendor/netresearch/composer-patches-plugin/src/Netresearch/Composer/Patches/Downloader/Composer.php on line 57


Exception trace:
  at phar:///usr/local/bin/composer/src/Composer/Util/RemoteFilesystem.php:124
 Composer\Util\RemoteFilesystem->getContents() at /path/to/vendor/netresearch/composer-patches-plugin/src/Netresearch/Composer/Patches/Downloader/Composer.php:57
 Netresearch\Composer\Patches\Downloader\Composer->getContents() at /path/to/vendor/netresearch/composer-patches-plugin/src/Netresearch/Composer/Patches/Patch.php:124
 Netresearch\Composer\Patches\Patch->read() at /path/to/vendor/netresearch/composer-patches-plugin/src/Netresearch/Composer/Patches/Patch.php:74

 <snip>

We traced the problem to this commit in the Composer codebase:

https://github.com/composer/composer/commit/6da38f83a0d5acc71793f337b525fa2faff9468e

I figure that checking if $originUrl is null and if so doing file_get_contents($url) is the path of least resistance.

Installation of this package under Windows fails with this error:

Maintaining patches
'which' is not recognized as an internal or external command,
operable program or batch file.

  [Netresearch\Composer\Patches\Exception]
  Cannot find the 'patch' executable command - use your o/s package manager like 'sudo yum install patch'

There is an alternative to which in PowerShell: Get-Command. To get the path to a program this command could be used: (Get-Command patch).Source.

Though, patch does not exist under Windows so that could be an issue as well. A OS independent implementation could be used, for example xdiff_file_patch.

We need the option to throw on patch application errors for our CI pipeline. #31

Also, this fixes the issue where the patcher downloads the patch list over and over for each single installed package.

I've never seen this problem before, but for some reason, this patch: https://www.drupal.org/files/issues/contact_storage-default_redirect-2629630-2.patch gets applied everytime composer install is run, even if's already been applied.

Here's my composer.json file: https://github.com/phototech/sailvenice/blob/develop/composer.json

If you run composer install the first time, it applies the patch like it's supposed to, if you run composer install again, it will again apply the patch (which causes a PHP syntax error). :(

I'm not sure what's cuasing the problem with this patch specifically, but the only work around I've found is to delete the web/modules/contrib/contact_storage completely and then run composer install again. :(

I'm using Version 1.2.0. I have a package that I'm applying 2 patches to. I also have a process that every time I update my code, I do a composer install. This has proven to be problematic. For reference, this is my package in composer.json... Note for simplicity sake I'm only putting part of the package def in here.

     {
        "type": "package",
        "package": {
            "name": "promet/martincounty-patches",
            "version": "1.3.0",
            "type": "patches",
            "require": {
                "drupal/google_analytics": "7.2.1",
                "netresearch/composer-patches-plugin": "~1.0"
            },
            "extra": {
                "patches": {
                    "drupal/google_analytics": {
                        "7.2.1": [
                            {
                                "title": "Fixing issue with Undefined Index: Value in googleanalytics_page_alter() Line 217",
                                "url": "https://www.drupal.org/files/issues/googleanalytics-2392371-10.patch"
                            },
                            {
                                "title": "Allow Altering of Information sent to GA",
                                "url": "https://www.drupal.org/files/issues/google_analytics-allow_alter_of_page_url_sent_to_ga-2571429-1.patch"
                            }
                        ]
                    }
                }
            }

Since this package was updated, I've run composer install 6 times. The second patch adds one line. That line has been duplicated 6 times:

This is the -vvv output when debugging:

Downloading https://www.drupal.org/files/issues/google_analytics-allow_alter_of_page_url_sent_to_ga-2571429-1.patch
  Testing patch 3944b0c7b9b7eec411804a2247aeae143a51541d on drupal/google_analytics: Fixing issue with Undefined Index: Value in googleanalytics_page_alter() Line 217
  Testing patch a557a69a763f247ffa3a2321340032b9d92fec6e on drupal/google_analytics: Allow Altering of Information sent to GA
  Applying patch a557a69a763f247ffa3a2321340032b9d92fec6e to drupal/google_analytics: Allow Altering of Information sent to GA

I think there is a problem in testing the patch...

with composer 2.x version netresearch/composer-patches-plugin throws below error:

[TypeError]
Composer\Json\JsonFile::__construct(): Argument #2 ($httpDownloader) must be of type ?Composer\Util\HttpDownloader, Composer\Util\RemoteFilesystem given, called in /my-project/vendor/netresearch/composer-patches-plugin/src/N
etresearch/Composer/Patches/Downloader/Composer.php on line 74

What is the recommended composer version to use netresearch/composer-patches-plugin?

I used composer-patches-plugin to apply some patches to a package (local patch files) and that worked as expected. Thanks so far!

My patches got merged into the package and i don't need them anymore. So i increased the packages version number, patch-package version number, removed the required patches ran composer update (deleted the .patch files too). I finally checked in the composer.lock file to make all changes fixed for deployment.

Today i wanted to update a remote installation - i merged the project source which contains the composer.lock file. When i run composer install, i get the following error:

The "patches/{package}/4b4636293ac6d46e171eaae8e64ae50ce2cd0b29.patch" file could not be downloaded: failed to open stream: No such file or directory

But the patch is not required anymore - so why does composer-patches-plugin need the .patch file?

As a workaround i can delete the local package and run composer install - this will work as expected.

The "problem" seems to be caused by the contents of "installed.json" which contained the patch-file URLs, which did not exist anymore because they are not required in the version defined in composer.lock.

So, what is the "correct" way? Simply keep the patch files in the vcs?

IMO this is not very intuitive nor logical, it may be better to store a copy of the applied patches in some local cache directory (package directory or vendor/composer or even as string value inside installed.json). That way it would be more stable and patch files could be altered as well (i guess changing a patch could also be a problem).

I think it could be good to have an example of how to use patches in local files as it could be confusing at first.

For example, in my case, I have added a new package in composer.json like:

"repositories": [
        {
            "type": "package",
            "package": {
                "type": "metapackage",
                "name": "vendor/package-patches",
                "version": "1.0.0",
                "require": {
                    "netresearch/composer-patches-plugin": "~1.0"
                },
                "extra": {
                    "patches": {
                        "zohocrm/php-sdk":     [
                            {
                                    "title": "Corregir warning 'Array and string offset access...' en el logger.",
                                    "url": "parches/fixzohologgerwarning.patch"
                            }
                        ]
                    }
                }
            }
        }
    ],
   "require": {
        ....
        "php-64bit": ">=7.3.0",
        "zohocrm/php-sdk": "^1.1",
        "vendor/package-patches": "~1.0"
    },

I have also added a new folder at the same level as the composer.json called "parches" and add a patch file fixzohologgerwarning.patch like:

# This patch file was generated by NetBeans IDE
# It uses platform neutral UTF-8 encoding and \n newlines.
--- a/src/com/zoho/crm/library/exception/Logger.php
+++ b/src/com/zoho/crm/library/exception/Logger.php
@@ -6,7 +6,7 @@
 	{
 		set_include_path(ZCRMConfigUtil::getConfigValue('applicationLogFilePath'));
 		$path=get_include_path();
-		if($path{strlen($path)-1}!='\/')
+		if($path[strlen($path)-1]!='\/')
 		{
 			$path=$path."/";
 		}

Note that the patch will be called with the option -p1 (remove the first slash) and in the directory of the library.

Then run the commands to update the dependency and to install patches:

composer update vendor/package-patches
composer install