Fire POST_FILE_DOWNLOAD event for metadata fetched by ComposerRepository.

main
Phéna Proxima 3 years ago
parent de112c519e
commit df0a2cdd0a

@ -38,32 +38,41 @@ class PostFileDownloadEvent extends Event
private $url; private $url;
/** /**
* @var \Composer\Package\PackageInterface * @var mixed
*/ */
private $package; private $context;
/**
* @var string
*/
private $type;
/** /**
* Constructor. * Constructor.
* *
* @param string $name The event name * @param string $name The event name
* @param string $fileName The file name * @param string|null $fileName The file name
* @param string|null $checksum The checksum * @param string|null $checksum The checksum
* @param string $url The processed url * @param string $url The processed url
* @param PackageInterface $package The package. * @param mixed $context Additional context for the download.
* @param string $type The type (package or metadata).
*/ */
public function __construct($name, $fileName, $checksum, $url, PackageInterface $package) public function __construct($name, $fileName, $checksum, $url, $context = null, $type = 'package')
{ {
parent::__construct($name); parent::__construct($name);
$this->fileName = $fileName; $this->fileName = $fileName;
$this->checksum = $checksum; $this->checksum = $checksum;
$this->url = $url; $this->url = $url;
$this->package = $package; $this->context = $context;
$this->type = $type;
} }
/** /**
* Retrieves the target file name location. * Retrieves the target file name location.
* *
* @return string * If this download is of type metadata, null is returned.
*
* @return string|null
*/ */
public function getFileName() public function getFileName()
{ {
@ -90,13 +99,39 @@ class PostFileDownloadEvent extends Event
return $this->url; return $this->url;
} }
/**
* Returns the context of this download, if any.
*
* If this download is of type package, the package object is returned. If
* this download is of type metadata, the HTTP response is returned.
*
* @return mixed
*/
public function getContext()
{
return $this->context;
}
/** /**
* Get the package. * Get the package.
* *
* @return \Composer\Package\PackageInterface The package. * If this download is of type metadata, null is returned.
*
* @return \Composer\Package\PackageInterface|null The package.
*/ */
public function getPackage() public function getPackage()
{ {
return $this->package; $context = $this->getContext();
return $context instanceof PackageInterface ? $context : null;
}
/**
* Returns the type of this download (package, metadata).
*
* @return string
*/
public function getType()
{
return $this->type;
} }
} }

@ -22,6 +22,7 @@ use Composer\Json\JsonFile;
use Composer\Cache; use Composer\Cache;
use Composer\Config; use Composer\Config;
use Composer\IO\IOInterface; use Composer\IO\IOInterface;
use Composer\Plugin\PostFileDownloadEvent;
use Composer\Semver\CompilingMatcher; use Composer\Semver\CompilingMatcher;
use Composer\Util\HttpDownloader; use Composer\Util\HttpDownloader;
use Composer\Util\Loop; use Composer\Util\Loop;
@ -1110,6 +1111,11 @@ class ComposerRepository extends ArrayRepository implements ConfigurableReposito
throw new RepositorySecurityException('The contents of '.$filename.' do not match its signature. This could indicate a man-in-the-middle attack or e.g. antivirus software corrupting files. Try running composer again and report this if you think it is a mistake.'); throw new RepositorySecurityException('The contents of '.$filename.' do not match its signature. This could indicate a man-in-the-middle attack or e.g. antivirus software corrupting files. Try running composer again and report this if you think it is a mistake.');
} }
if ($this->eventDispatcher) {
$postFileDownloadEvent = new PostFileDownloadEvent(PluginEvents::POST_FILE_DOWNLOAD, null, $sha256, $filename, $response, 'metadata');
$this->eventDispatcher->dispatch($postFileDownloadEvent->getName(), $postFileDownloadEvent);
}
$data = $response->decodeJson(); $data = $response->decodeJson();
HttpDownloader::outputWarnings($this->io, $this->url, $data); HttpDownloader::outputWarnings($this->io, $this->url, $data);
@ -1188,6 +1194,11 @@ class ComposerRepository extends ArrayRepository implements ConfigurableReposito
return true; return true;
} }
if ($this->eventDispatcher) {
$postFileDownloadEvent = new PostFileDownloadEvent(PluginEvents::POST_FILE_DOWNLOAD, null, null, $filename, $response, 'metadata');
$this->eventDispatcher->dispatch($postFileDownloadEvent->getName(), $postFileDownloadEvent);
}
$data = $response->decodeJson(); $data = $response->decodeJson();
HttpDownloader::outputWarnings($this->io, $this->url, $data); HttpDownloader::outputWarnings($this->io, $this->url, $data);
@ -1258,9 +1269,10 @@ class ComposerRepository extends ArrayRepository implements ConfigurableReposito
$url = $this->url; $url = $this->url;
$cache = $this->cache; $cache = $this->cache;
$degradedMode = &$this->degradedMode; $degradedMode = &$this->degradedMode;
$eventDispatcher = $this->eventDispatcher;
$repo = $this; $repo = $this;
$accept = function ($response) use ($io, $url, $filename, $cache, $cacheKey, $repo) { $accept = function ($response) use ($io, $url, $filename, $cache, $cacheKey, $eventDispatcher, $repo) {
// package not found is acceptable for a v2 protocol repository // package not found is acceptable for a v2 protocol repository
if ($response->getStatusCode() === 404) { if ($response->getStatusCode() === 404) {
$repo->packagesNotFoundCache[$filename] = true; $repo->packagesNotFoundCache[$filename] = true;
@ -1275,6 +1287,11 @@ class ComposerRepository extends ArrayRepository implements ConfigurableReposito
return true; return true;
} }
if ($eventDispatcher) {
$postFileDownloadEvent = new PostFileDownloadEvent(PluginEvents::POST_FILE_DOWNLOAD, null, null, $url, $response, 'metadata');
$eventDispatcher->dispatch($postFileDownloadEvent->getName(), $postFileDownloadEvent);
}
$data = $response->decodeJson(); $data = $response->decodeJson();
HttpDownloader::outputWarnings($io, $url, $data); HttpDownloader::outputWarnings($io, $url, $data);

Loading…
Cancel
Save