updated core to 7.72
This commit is contained in:
@@ -198,6 +198,25 @@ Drupal.ajax = function (base, element, element_settings) {
|
||||
type: 'POST'
|
||||
};
|
||||
|
||||
// For multipart forms (e.g., file uploads), jQuery Form targets the form
|
||||
// submission to an iframe instead of using an XHR object. The initial "src"
|
||||
// of the iframe, prior to the form submission, is set to options.iframeSrc.
|
||||
// "about:blank" is the semantically correct, standards-compliant, way to
|
||||
// initialize a blank iframe; however, some old IE versions (possibly only 6)
|
||||
// incorrectly report a mixed content warning when iframes with an
|
||||
// "about:blank" src are added to a parent document with an https:// origin.
|
||||
// jQuery Form works around this by defaulting to "javascript:false" instead,
|
||||
// but that breaks on Chrome 83, so here we force the semantically correct
|
||||
// behavior for all browsers except old IE.
|
||||
// @see https://www.drupal.org/project/drupal/issues/3143016
|
||||
// @see https://github.com/jquery-form/form/blob/df9cb101b9c9c085c8d75ad980c7ff1cf62063a1/jquery.form.js#L68
|
||||
// @see https://bugs.chromium.org/p/chromium/issues/detail?id=1084874
|
||||
// @see https://html.spec.whatwg.org/multipage/browsers.html#creating-browsing-contexts
|
||||
// @see https://developer.mozilla.org/en-US/docs/Web/Security/Same-origin_policy
|
||||
if (navigator.userAgent.indexOf("MSIE") === -1) {
|
||||
ajax.options.iframeSrc = 'about:blank';
|
||||
}
|
||||
|
||||
// Bind the ajaxSubmit function to the element event.
|
||||
$(ajax.element).bind(element_settings.event, function (event) {
|
||||
if (!Drupal.settings.urlIsAjaxTrusted[ajax.url] && !Drupal.urlIsLocal(ajax.url)) {
|
||||
|
||||
@@ -0,0 +1,4 @@
|
||||
/vendor/
|
||||
/phpunit.xml
|
||||
/.composer.lock
|
||||
|
||||
@@ -0,0 +1,20 @@
|
||||
language: php
|
||||
|
||||
sudo: false
|
||||
|
||||
php:
|
||||
- '5.3'
|
||||
- '5.4'
|
||||
- '5.5'
|
||||
- '5.6'
|
||||
- '7.0'
|
||||
- '7.1'
|
||||
|
||||
before_install:
|
||||
- phpenv config-rm xdebug.ini
|
||||
- composer self-update
|
||||
|
||||
install:
|
||||
- composer install
|
||||
|
||||
script: phpunit
|
||||
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2016 Denis Brumann
|
||||
|
||||
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.
|
||||
@@ -0,0 +1,61 @@
|
||||
Polyfill unserialize [](https://travis-ci.org/dbrumann/polyfill-unserialize)
|
||||
===
|
||||
|
||||
Backports unserialize options introduced in PHP 7.0 to older PHP versions.
|
||||
This was originally designed as a Proof of Concept for Symfony Issue [#21090](https://github.com/symfony/symfony/pull/21090).
|
||||
|
||||
You can use this package in projects that rely on PHP versions older than PHP 7.0.
|
||||
In case you are using PHP 7.0+ the original `unserialize()` will be used instead.
|
||||
|
||||
From the [documentation](https://secure.php.net/manual/en/function.unserialize.php):
|
||||
|
||||
> Warning: Do not pass untrusted user input to unserialize(). Unserialization can
|
||||
> result in code being loaded and executed due to object instantiation
|
||||
> and autoloading, and a malicious user may be able to exploit this.
|
||||
|
||||
This warning holds true even when `allowed_classes` is used.
|
||||
|
||||
Requirements
|
||||
------------
|
||||
|
||||
- PHP 5.3+
|
||||
|
||||
Installation
|
||||
------------
|
||||
|
||||
You can install this package via composer:
|
||||
|
||||
```
|
||||
composer require brumann/polyfill-unserialize "^1.0"
|
||||
```
|
||||
|
||||
Known Issues
|
||||
------------
|
||||
|
||||
There is a mismatch in behavior when `allowed_classes` in `$options` is not
|
||||
of the correct type (array or boolean). PHP 7.1 will issue a warning, whereas
|
||||
PHP 7.0 will not. I opted to copy the behavior of the former.
|
||||
|
||||
Tests
|
||||
-----
|
||||
|
||||
You can run the test suite using PHPUnit. It is intentionally not bundled as
|
||||
dev dependency to make sure this package has the lowest restrictions on the
|
||||
implementing system as possible.
|
||||
|
||||
Please read the [PHPUnit Manual](https://phpunit.de/manual/current/en/installation.html)
|
||||
for information how to install it on your system.
|
||||
|
||||
You can run the test suite as follows:
|
||||
|
||||
```
|
||||
phpunit -c phpunit.xml.dist tests/
|
||||
```
|
||||
|
||||
Contributing
|
||||
------------
|
||||
|
||||
This package is considered feature complete. As such I will likely not update it
|
||||
unless there are security issues.
|
||||
|
||||
Should you find any bugs or have questions, feel free to submit an Issue or a Pull Request.
|
||||
@@ -0,0 +1,26 @@
|
||||
{
|
||||
"name": "brumann/polyfill-unserialize",
|
||||
"description": "Backports unserialize options introduced in PHP 7.0 to older PHP versions.",
|
||||
"type": "library",
|
||||
"license": "MIT",
|
||||
"authors": [
|
||||
{
|
||||
"name": "Denis Brumann",
|
||||
"email": "denis.brumann@sensiolabs.de"
|
||||
}
|
||||
],
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
"Brumann\\Polyfill\\": "src/"
|
||||
}
|
||||
},
|
||||
"autoload-dev": {
|
||||
"psr-4": {
|
||||
"Tests\\Brumann\\Polyfill\\": "tests/"
|
||||
}
|
||||
},
|
||||
"minimum-stability": "stable",
|
||||
"require": {
|
||||
"php": "^5.3|^7.0"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,25 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
|
||||
<phpunit
|
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xsi:noNamespaceSchemaLocation="http://schema.phpunit.de/4.1/phpunit.xsd"
|
||||
backupGlobals="false"
|
||||
colors="true"
|
||||
bootstrap="vendor/autoload.php"
|
||||
>
|
||||
<php>
|
||||
<ini name="error_reporting" value="-1" />
|
||||
</php>
|
||||
|
||||
<testsuites>
|
||||
<testsuite name="Brumann\Polyfill Test Suite">
|
||||
<directory>./tests/</directory>
|
||||
</testsuite>
|
||||
</testsuites>
|
||||
|
||||
<filter>
|
||||
<whitelist>
|
||||
<directory>./src/</directory>
|
||||
</whitelist>
|
||||
</filter>
|
||||
</phpunit>
|
||||
@@ -0,0 +1,58 @@
|
||||
<?php
|
||||
|
||||
namespace Brumann\Polyfill;
|
||||
|
||||
final class Unserialize
|
||||
{
|
||||
/**
|
||||
* @see https://secure.php.net/manual/en/function.unserialize.php
|
||||
*
|
||||
* @param string $serialized Serialized data
|
||||
* @param array $options Associative array containing options
|
||||
*
|
||||
* @return mixed
|
||||
*/
|
||||
public static function unserialize($serialized, array $options = array())
|
||||
{
|
||||
if (PHP_VERSION_ID >= 70000) {
|
||||
return \unserialize($serialized, $options);
|
||||
}
|
||||
if (!array_key_exists('allowed_classes', $options)) {
|
||||
$options['allowed_classes'] = true;
|
||||
}
|
||||
$allowedClasses = $options['allowed_classes'];
|
||||
if (true === $allowedClasses) {
|
||||
return \unserialize($serialized);
|
||||
}
|
||||
if (false === $allowedClasses) {
|
||||
$allowedClasses = array();
|
||||
}
|
||||
if (!is_array($allowedClasses)) {
|
||||
trigger_error(
|
||||
'unserialize(): allowed_classes option should be array or boolean',
|
||||
E_USER_WARNING
|
||||
);
|
||||
$allowedClasses = array();
|
||||
}
|
||||
|
||||
$sanitizedSerialized = preg_replace_callback(
|
||||
'/(^|;)O:\d+:"([^"]*)":(\d+):{/',
|
||||
function ($match) use ($allowedClasses) {
|
||||
list($completeMatch, $leftBorder, $className, $objectSize) = $match;
|
||||
if (in_array($className, $allowedClasses)) {
|
||||
return $completeMatch;
|
||||
} else {
|
||||
return sprintf(
|
||||
'%sO:22:"__PHP_Incomplete_Class":%d:{s:27:"__PHP_Incomplete_Class_Name";%s',
|
||||
$leftBorder,
|
||||
$objectSize + 1, // size of object + 1 for added string
|
||||
\serialize($className)
|
||||
);
|
||||
}
|
||||
},
|
||||
$serialized
|
||||
);
|
||||
|
||||
return \unserialize($sanitizedSerialized);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,251 @@
|
||||
/**
|
||||
* For jQuery versions less than 3.5.0, this replaces the jQuery.htmlPrefilter()
|
||||
* function with one that fixes these security vulnerabilities while also
|
||||
* retaining the pre-3.5.0 behavior where it's safe to do so.
|
||||
* - https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-11022
|
||||
* - https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-11023
|
||||
*
|
||||
* Additionally, for jQuery versions that do not have a jQuery.htmlPrefilter()
|
||||
* function (1.x prior to 1.12 and 2.x prior to 2.2), this adds it, and
|
||||
* extends the functions that need to call it to do so.
|
||||
*
|
||||
* Drupal core's jQuery version is 1.4.4, but jQuery Update can provide a
|
||||
* different version, so this covers all versions between 1.4.4 and 3.4.1.
|
||||
* The GitHub links in the code comments below link to jQuery 1.5 code, because
|
||||
* 1.4.4 isn't on GitHub, but the referenced code didn't change from 1.4.4 to
|
||||
* 1.5.
|
||||
*/
|
||||
|
||||
(function (jQuery) {
|
||||
|
||||
// Parts of this backport differ by jQuery version.
|
||||
var versionParts = jQuery.fn.jquery.split('.');
|
||||
var majorVersion = parseInt(versionParts[0]);
|
||||
var minorVersion = parseInt(versionParts[1]);
|
||||
|
||||
// No backport is needed if we're already on jQuery 3.5 or higher.
|
||||
if ( (majorVersion > 3) || (majorVersion === 3 && minorVersion >= 5) ) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Prior to jQuery 3.5, jQuery converted XHTML-style self-closing tags to
|
||||
// their XML equivalent: e.g., "<div />" to "<div></div>". This is
|
||||
// problematic for several reasons, including that it's vulnerable to XSS
|
||||
// attacks. However, since this was jQuery's behavior for many years, many
|
||||
// Drupal modules and jQuery plugins may be relying on it. Therefore, we
|
||||
// preserve that behavior, but for a limited set of tags only, that we believe
|
||||
// to not be vulnerable. This is the set of HTML tags that satisfy all of the
|
||||
// following conditions:
|
||||
// - In DOMPurify's list of HTML tags. If an HTML tag isn't safe enough to
|
||||
// appear in that list, then we don't want to mess with it here either.
|
||||
// @see https://github.com/cure53/DOMPurify/blob/2.0.11/dist/purify.js#L128
|
||||
// - A normal element (not a void, template, text, or foreign element).
|
||||
// @see https://html.spec.whatwg.org/multipage/syntax.html#elements-2
|
||||
// - An element that is still defined by the current HTML specification
|
||||
// (not a deprecated element), because we do not want to rely on how
|
||||
// browsers parse deprecated elements.
|
||||
// @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element
|
||||
// - Not 'html', 'head', or 'body', because this pseudo-XHTML expansion is
|
||||
// designed for fragments, not entire documents.
|
||||
// - Not 'colgroup', because due to an idiosyncrasy of jQuery's original
|
||||
// regular expression, it didn't match on colgroup, and we don't want to
|
||||
// introduce a behavior change for that.
|
||||
var selfClosingTagsToReplace = [
|
||||
'a', 'abbr', 'address', 'article', 'aside', 'audio', 'b', 'bdi', 'bdo',
|
||||
'blockquote', 'button', 'canvas', 'caption', 'cite', 'code', 'data',
|
||||
'datalist', 'dd', 'del', 'details', 'dfn', 'div', 'dl', 'dt', 'em',
|
||||
'fieldset', 'figcaption', 'figure', 'footer', 'form', 'h1', 'h2', 'h3',
|
||||
'h4', 'h5', 'h6', 'header', 'hgroup', 'i', 'ins', 'kbd', 'label', 'legend',
|
||||
'li', 'main', 'map', 'mark', 'menu', 'meter', 'nav', 'ol', 'optgroup',
|
||||
'option', 'output', 'p', 'picture', 'pre', 'progress', 'q', 'rp', 'rt',
|
||||
'ruby', 's', 'samp', 'section', 'select', 'small', 'source', 'span',
|
||||
'strong', 'sub', 'summary', 'sup', 'table', 'tbody', 'td', 'tfoot', 'th',
|
||||
'thead', 'time', 'tr', 'u', 'ul', 'var', 'video'
|
||||
];
|
||||
|
||||
// Define regular expressions for <TAG/> and <TAG ATTRIBUTES/>. Doing this as
|
||||
// two expressions makes it easier to target <a/> without also targeting
|
||||
// every tag that starts with "a".
|
||||
var xhtmlRegExpGroup = '(' + selfClosingTagsToReplace.join('|') + ')';
|
||||
var whitespace = '[\\x20\\t\\r\\n\\f]';
|
||||
var rxhtmlTagWithoutSpaceOrAttributes = new RegExp('<' + xhtmlRegExpGroup + '\\/>', 'gi');
|
||||
var rxhtmlTagWithSpaceAndMaybeAttributes = new RegExp('<' + xhtmlRegExpGroup + '(' + whitespace + '[^>]*)\\/>', 'gi');
|
||||
|
||||
// jQuery 3.5 also fixed a vulnerability for when </select> appears within
|
||||
// an <option> or <optgroup>, but it did that in local code that we can't
|
||||
// backport directly. Instead, we filter such cases out. To do so, we need to
|
||||
// determine when jQuery would otherwise invoke the vulnerable code, which it
|
||||
// uses this regular expression to determine. The regular expression changed
|
||||
// for version 3.0.0 and changed again for 3.4.0.
|
||||
// @see https://github.com/jquery/jquery/blob/1.5/jquery.js#L4958
|
||||
// @see https://github.com/jquery/jquery/blob/3.0.0/dist/jquery.js#L4584
|
||||
// @see https://github.com/jquery/jquery/blob/3.4.0/dist/jquery.js#L4712
|
||||
var rtagName;
|
||||
if (majorVersion < 3) {
|
||||
rtagName = /<([\w:]+)/;
|
||||
}
|
||||
else if (minorVersion < 4) {
|
||||
rtagName = /<([a-z][^\/\0>\x20\t\r\n\f]+)/i;
|
||||
}
|
||||
else {
|
||||
rtagName = /<([a-z][^\/\0>\x20\t\r\n\f]*)/i;
|
||||
}
|
||||
|
||||
// The regular expression that jQuery uses to determine which self-closing
|
||||
// tags to expand to open and close tags. This is vulnerable, because it
|
||||
// matches all tag names except the few excluded ones. We only use this
|
||||
// expression for determining vulnerability. The expression changed for
|
||||
// version 3, but we only need to check for vulnerability in versions 1 and 2,
|
||||
// so we use the expression from those versions.
|
||||
// @see https://github.com/jquery/jquery/blob/1.5/jquery.js#L4957
|
||||
var rxhtmlTag = /<(?!area|br|col|embed|hr|img|input|link|meta|param)(([\w:]+)[^>]*)\/>/gi;
|
||||
|
||||
jQuery.extend({
|
||||
htmlPrefilter: function (html) {
|
||||
// This is how jQuery determines the first tag in the HTML.
|
||||
// @see https://github.com/jquery/jquery/blob/1.5/jquery.js#L5521
|
||||
var tag = ( rtagName.exec( html ) || [ "", "" ] )[ 1 ].toLowerCase();
|
||||
|
||||
// It is not valid HTML for <option> or <optgroup> to have <select> as
|
||||
// either a descendant or sibling, and attempts to inject one can cause
|
||||
// XSS on jQuery versions before 3.5. Since this is invalid HTML and a
|
||||
// possible XSS attack, reject the entire string.
|
||||
// @see https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-11023
|
||||
if ((tag === 'option' || tag === 'optgroup') && html.match(/<\/?select/i)) {
|
||||
html = '';
|
||||
}
|
||||
|
||||
// Retain jQuery's prior to 3.5 conversion of pseudo-XHTML, but for only
|
||||
// the tags in the `selfClosingTagsToReplace` list defined above.
|
||||
// @see https://github.com/jquery/jquery/blob/1.5/jquery.js#L5518
|
||||
// @see https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-11022
|
||||
html = html.replace(rxhtmlTagWithoutSpaceOrAttributes, "<$1></$1>");
|
||||
html = html.replace(rxhtmlTagWithSpaceAndMaybeAttributes, "<$1$2></$1>");
|
||||
|
||||
// Prior to jQuery 1.12 and 2.2, this function gets called (via code later
|
||||
// in this file) in addition to, rather than instead of, the unsafe
|
||||
// expansion of self-closing tags (including ones not in the list above).
|
||||
// We can't prevent that unsafe expansion from running, so instead we
|
||||
// check to make sure that it doesn't affect the DOM returned by the
|
||||
// browser's parsing logic. If it does affect it, then it's vulnerable to
|
||||
// XSS, so we reject the entire string.
|
||||
if ( (majorVersion === 1 && minorVersion < 12) || (majorVersion === 2 && minorVersion < 2) ) {
|
||||
var htmlRisky = html.replace(rxhtmlTag, "<$1></$2>");
|
||||
if (htmlRisky !== html) {
|
||||
// Even though htmlRisky and html are different strings, they might
|
||||
// represent the same HTML structure once parsed, in which case,
|
||||
// htmlRisky is actually safe. We can ask the browser to parse both
|
||||
// to find out, but the browser can't parse table fragments (e.g., a
|
||||
// root-level "<td>"), so we need to wrap them. We just need this
|
||||
// technique to work on all supported browsers; we don't need to
|
||||
// copy from the specific jQuery version we're using.
|
||||
// @see https://github.com/jquery/jquery/blob/3.5.1/dist/jquery.js#L4939
|
||||
var wrapMap = {
|
||||
thead: [ 1, "<table>", "</table>" ],
|
||||
col: [ 2, "<table><colgroup>", "</colgroup></table>" ],
|
||||
tr: [ 2, "<table><tbody>", "</tbody></table>" ],
|
||||
td: [ 3, "<table><tbody><tr>", "</tr></tbody></table>" ],
|
||||
};
|
||||
wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead;
|
||||
wrapMap.th = wrapMap.td;
|
||||
|
||||
// Function to wrap HTML into something that a browser can parse.
|
||||
// @see https://github.com/jquery/jquery/blob/3.5.1/dist/jquery.js#L5032
|
||||
var getWrappedHtml = function (html) {
|
||||
var wrap = wrapMap[tag];
|
||||
if (wrap) {
|
||||
html = wrap[1] + html + wrap[2];
|
||||
}
|
||||
return html;
|
||||
};
|
||||
|
||||
// Function to return canonical HTML after parsing it. This parses
|
||||
// only; it doesn't execute scripts.
|
||||
// @see https://github.com/jquery/jquery-migrate/blob/3.3.0/src/jquery/manipulation.js#L5
|
||||
var getParsedHtml = function (html) {
|
||||
var doc = window.document.implementation.createHTMLDocument( "" );
|
||||
doc.body.innerHTML = html;
|
||||
return doc.body ? doc.body.innerHTML : '';
|
||||
};
|
||||
|
||||
// If the browser couldn't parse either one successfully, or if
|
||||
// htmlRisky parses differently than html, then html is vulnerable,
|
||||
// so reject it.
|
||||
var htmlParsed = getParsedHtml(getWrappedHtml(html));
|
||||
var htmlRiskyParsed = getParsedHtml(getWrappedHtml(htmlRisky));
|
||||
if (htmlRiskyParsed === '' || htmlParsed === '' || (htmlRiskyParsed !== htmlParsed)) {
|
||||
html = '';
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return html;
|
||||
}
|
||||
});
|
||||
|
||||
// Prior to jQuery 1.12 and 2.2, jQuery.clean(), jQuery.buildFragment(), and
|
||||
// jQuery.fn.html() did not call jQuery.htmlPrefilter(), so we add that.
|
||||
if ( (majorVersion === 1 && minorVersion < 12) || (majorVersion === 2 && minorVersion < 2) ) {
|
||||
// Filter the HTML coming into jQuery.fn.html().
|
||||
var fnOriginalHtml = jQuery.fn.html;
|
||||
jQuery.fn.extend({
|
||||
// @see https://github.com/jquery/jquery/blob/1.5/jquery.js#L5147
|
||||
html: function (value) {
|
||||
if (typeof value === "string") {
|
||||
value = jQuery.htmlPrefilter(value);
|
||||
}
|
||||
// .html() can be called as a setter (with an argument) or as a getter
|
||||
// (without an argument), so invoke fnOriginalHtml() the same way that
|
||||
// we were invoked.
|
||||
return fnOriginalHtml.apply(this, arguments.length ? [value] : []);
|
||||
}
|
||||
});
|
||||
|
||||
// The regular expression that jQuery uses to determine if a string is HTML.
|
||||
// Used by both clean() and buildFragment().
|
||||
// @see https://github.com/jquery/jquery/blob/1.5/jquery.js#L4960
|
||||
var rhtml = /<|&#?\w+;/;
|
||||
|
||||
// Filter HTML coming into:
|
||||
// - jQuery.clean() for versions prior to 1.9.
|
||||
// - jQuery.buildFragment() for 1.9 and above.
|
||||
//
|
||||
// The looping constructs in the two functions might be essentially
|
||||
// identical, but they're each expressed here in the way that most closely
|
||||
// matches their original expression in jQuery, so that we filter all of
|
||||
// the items and only the items that jQuery will treat as HTML strings.
|
||||
if (majorVersion === 1 && minorVersion < 9) {
|
||||
var originalClean = jQuery.clean;
|
||||
jQuery.extend({
|
||||
// @see https://github.com/jquery/jquery/blob/1.5/jquery.js#L5493
|
||||
'clean': function (elems, context, fragment, scripts) {
|
||||
for ( var i = 0, elem; (elem = elems[i]) != null; i++ ) {
|
||||
if ( typeof elem === "string" && rhtml.test( elem ) ) {
|
||||
elems[i] = elem = jQuery.htmlPrefilter(elem);
|
||||
}
|
||||
}
|
||||
return originalClean.call(this, elems, context, fragment, scripts);
|
||||
}
|
||||
});
|
||||
}
|
||||
else {
|
||||
var originalBuildFragment = jQuery.buildFragment;
|
||||
jQuery.extend({
|
||||
// @see https://github.com/jquery/jquery/blob/1.9.0/jquery.js#L6419
|
||||
'buildFragment': function (elems, context, scripts, selection) {
|
||||
var l = elems.length;
|
||||
for ( var i = 0; i < l; i++ ) {
|
||||
var elem = elems[i];
|
||||
if (elem || elem === 0) {
|
||||
if ( jQuery.type( elem ) !== "object" && rhtml.test( elem ) ) {
|
||||
elems[i] = elem = jQuery.htmlPrefilter(elem);
|
||||
}
|
||||
}
|
||||
}
|
||||
return originalBuildFragment.call(this, elems, context, scripts, selection);
|
||||
}
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
})(jQuery);
|
||||
@@ -1,5 +1,6 @@
|
||||
[](https://scrutinizer-ci.com/g/TYPO3/phar-stream-wrapper/?branch=v2)
|
||||
[](https://travis-ci.org/TYPO3/phar-stream-wrapper)
|
||||
[](https://ci.appveyor.com/project/ohader/phar-stream-wrapper)
|
||||
|
||||
# PHP Phar Stream Wrapper
|
||||
|
||||
@@ -21,9 +22,11 @@ and has been addressed concerning the specific attack vector and for this generi
|
||||
`PharStreamWrapper` in TYPO3 versions 7.6.30 LTS, 8.7.17 LTS and 9.3.1 on 12th
|
||||
July 2018.
|
||||
|
||||
* https://typo3.org/security/advisory/typo3-core-sa-2018-002/
|
||||
* https://blog.secarma.co.uk/labs/near-phar-dangerous-unserialization-wherever-you-are
|
||||
* https://youtu.be/GePBmsNJw6Y
|
||||
* https://typo3.org/security/advisory/typo3-psa-2018-001/
|
||||
* https://typo3.org/security/advisory/typo3-psa-2019-007/
|
||||
* https://typo3.org/security/advisory/typo3-psa-2019-008/
|
||||
|
||||
## License
|
||||
|
||||
@@ -63,7 +66,7 @@ adjusted to according requirements.
|
||||
|
||||
```
|
||||
$behavior = new \TYPO3\PharStreamWrapper\Behavior();
|
||||
Manager::initialize(
|
||||
\TYPO3\PharStreamWrapper\Manager::initialize(
|
||||
$behavior->withAssertion(new PharExtensionInterceptor())
|
||||
);
|
||||
|
||||
@@ -90,7 +93,7 @@ if (in_array('phar', stream_get_wrappers())) {
|
||||
+ `COMMAND_UNLINK`
|
||||
+ `COMMAND_URL_STAT`
|
||||
|
||||
## Interceptor
|
||||
## Interceptors
|
||||
|
||||
The following interceptor is shipped with the package and ready to use in order
|
||||
to block any Phar invocation of files not having a `.phar` suffix. Besides that
|
||||
@@ -137,9 +140,72 @@ class PharExtensionInterceptor implements Assertable
|
||||
}
|
||||
```
|
||||
|
||||
### ConjunctionInterceptor
|
||||
|
||||
This interceptor combines multiple interceptors implementing `Assertable`.
|
||||
It succeeds when all nested interceptors succeed as well (logical `AND`).
|
||||
|
||||
```
|
||||
$behavior = new \TYPO3\PharStreamWrapper\Behavior();
|
||||
\TYPO3\PharStreamWrapper\Manager::initialize(
|
||||
$behavior->withAssertion(new ConjunctionInterceptor(array(
|
||||
new PharExtensionInterceptor(),
|
||||
new PharMetaDataInterceptor()
|
||||
)))
|
||||
);
|
||||
```
|
||||
|
||||
### PharExtensionInterceptor
|
||||
|
||||
This (basic) interceptor just checks whether the invoked Phar archive has
|
||||
an according `.phar` file extension. Resolving symbolic links as well as
|
||||
Phar internal alias resolving are considered as well.
|
||||
|
||||
```
|
||||
$behavior = new \TYPO3\PharStreamWrapper\Behavior();
|
||||
\TYPO3\PharStreamWrapper\Manager::initialize(
|
||||
$behavior->withAssertion(new PharExtensionInterceptor())
|
||||
);
|
||||
```
|
||||
|
||||
### PharMetaDataInterceptor
|
||||
|
||||
This interceptor is actually checking serialized Phar meta-data against
|
||||
PHP objects and would consider a Phar archive malicious in case not only
|
||||
scalar values are found. A custom low-level `Phar\Reader` is used in order to
|
||||
avoid using PHP's `Phar` object which would trigger the initial vulnerability.
|
||||
|
||||
```
|
||||
$behavior = new \TYPO3\PharStreamWrapper\Behavior();
|
||||
\TYPO3\PharStreamWrapper\Manager::initialize(
|
||||
$behavior->withAssertion(new PharMetaDataInterceptor())
|
||||
);
|
||||
```
|
||||
|
||||
## Reader
|
||||
|
||||
* `Phar\Reader::__construct(string $fileName)`: Creates low-level reader for Phar archive
|
||||
* `Phar\Reader::resolveContainer(): Phar\Container`: Resolves model representing Phar archive
|
||||
* `Phar\Container::getStub(): Phar\Stub`: Resolves (plain PHP) stub section of Phar archive
|
||||
* `Phar\Container::getManifest(): Phar\Manifest`: Resolves parsed Phar archive manifest as
|
||||
documented at http://php.net/manual/en/phar.fileformat.manifestfile.php
|
||||
* `Phar\Stub::getMappedAlias(): string`: Resolves internal Phar archive alias defined in stub
|
||||
using `Phar::mapPhar('alias.phar')` - actually the plain PHP source is analyzed here
|
||||
* `Phar\Manifest::getAlias(): string` - Resolves internal Phar archive alias defined in manifest
|
||||
using `Phar::setAlias('alias.phar')`
|
||||
* `Phar\Manifest::getMetaData(): string`: Resolves serialized Phar archive meta-data
|
||||
* `Phar\Manifest::deserializeMetaData(): mixed`: Resolves deserialized Phar archive meta-data
|
||||
containing only scalar values - in case an object is determined, an according
|
||||
`Phar\DeserializationException` will be thrown
|
||||
|
||||
```
|
||||
$reader = new Phar\Reader('example.phar');
|
||||
var_dump($reader->resolveContainer()->getManifest()->deserializeMetaData());
|
||||
```
|
||||
|
||||
## Helper
|
||||
|
||||
* `Helper::determineBaseFile(string $path)`: Determines base file that can be
|
||||
* `Helper::determineBaseFile(string $path): string`: Determines base file that can be
|
||||
accessed using the regular file system. For instance the following path
|
||||
`phar:///home/user/bundle.phar/content.txt` would be resolved to
|
||||
`/home/user/bundle.phar`.
|
||||
|
||||
@@ -6,11 +6,17 @@
|
||||
"homepage": "https://typo3.org/",
|
||||
"keywords": ["php", "phar", "stream-wrapper", "security"],
|
||||
"require": {
|
||||
"php": "^5.3.3|^7.0"
|
||||
"php": "^5.3.3|^7.0",
|
||||
"ext-json": "*",
|
||||
"brumann/polyfill-unserialize": "^1.0"
|
||||
},
|
||||
"require-dev": {
|
||||
"ext-xdebug": "*",
|
||||
"phpunit/phpunit": "^4.8.36"
|
||||
},
|
||||
"suggest": {
|
||||
"ext-fileinfo": "For PHP builtin file type guessing, otherwise uses internal processing"
|
||||
},
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
"TYPO3\\PharStreamWrapper\\": "src/"
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
<?php
|
||||
namespace TYPO3\PharStreamWrapper;
|
||||
|
||||
/*
|
||||
* This file is part of the TYPO3 project.
|
||||
*
|
||||
* It is free software; you can redistribute it and/or modify it under the terms
|
||||
* of the MIT License (MIT). For the full copyright and license information,
|
||||
* please read the LICENSE file that was distributed with this source code.
|
||||
*
|
||||
* The TYPO3 project - inspiring people to share!
|
||||
*/
|
||||
|
||||
use TYPO3\PharStreamWrapper\Resolver\PharInvocation;
|
||||
|
||||
interface Collectable
|
||||
{
|
||||
/**
|
||||
* @param PharInvocation $invocation
|
||||
* @return bool
|
||||
*/
|
||||
public function has(PharInvocation $invocation);
|
||||
|
||||
/**
|
||||
* @param PharInvocation $invocation
|
||||
* @param null $flags
|
||||
* @return bool
|
||||
*/
|
||||
public function collect(PharInvocation $invocation, $flags = null);
|
||||
|
||||
/**
|
||||
* @param callable $callback
|
||||
* @param bool $reverse
|
||||
* @return null|PharInvocation
|
||||
*/
|
||||
public function findByCallback($callback, $reverse = false);
|
||||
}
|
||||
@@ -11,6 +11,13 @@ namespace TYPO3\PharStreamWrapper;
|
||||
* The TYPO3 project - inspiring people to share!
|
||||
*/
|
||||
|
||||
/**
|
||||
* Helper provides low-level tools on file name resolving. However it does not
|
||||
* (and should not) maintain any runtime state information. In order to resolve
|
||||
* Phar archive paths according resolvers have to be used.
|
||||
*
|
||||
* @see \TYPO3\PharStreamWrapper\Resolvable::resolve()
|
||||
*/
|
||||
class Helper
|
||||
{
|
||||
/*
|
||||
@@ -45,7 +52,7 @@ class Helper
|
||||
|
||||
while (count($parts)) {
|
||||
$currentPath = implode('/', $parts);
|
||||
if (@is_file($currentPath)) {
|
||||
if (@is_file($currentPath) && realpath($currentPath) !== false) {
|
||||
return $currentPath;
|
||||
}
|
||||
array_pop($parts);
|
||||
@@ -54,6 +61,15 @@ class Helper
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $path
|
||||
* @return bool
|
||||
*/
|
||||
public static function hasPharPrefix($path)
|
||||
{
|
||||
return stripos($path, 'phar://') === 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $path
|
||||
* @return string
|
||||
@@ -61,7 +77,7 @@ class Helper
|
||||
public static function removePharPrefix($path)
|
||||
{
|
||||
$path = trim($path);
|
||||
if (stripos($path, 'phar://') !== 0) {
|
||||
if (!static::hasPharPrefix($path)) {
|
||||
return $path;
|
||||
}
|
||||
return substr($path, 7);
|
||||
@@ -77,7 +93,7 @@ class Helper
|
||||
public static function normalizePath($path)
|
||||
{
|
||||
return rtrim(
|
||||
static::getCanonicalPath(
|
||||
static::normalizeWindowsPath(
|
||||
static::removePharPrefix($path)
|
||||
),
|
||||
'/'
|
||||
@@ -90,7 +106,7 @@ class Helper
|
||||
* @param string $path File path to process
|
||||
* @return string
|
||||
*/
|
||||
private static function normalizeWindowsPath($path)
|
||||
public static function normalizeWindowsPath($path)
|
||||
{
|
||||
return str_replace('\\', '/', $path);
|
||||
}
|
||||
|
||||
@@ -0,0 +1,88 @@
|
||||
<?php
|
||||
namespace TYPO3\PharStreamWrapper\Interceptor;
|
||||
|
||||
/*
|
||||
* This file is part of the TYPO3 project.
|
||||
*
|
||||
* It is free software; you can redistribute it and/or modify it under the terms
|
||||
* of the MIT License (MIT). For the full copyright and license information,
|
||||
* please read the LICENSE file that was distributed with this source code.
|
||||
*
|
||||
* The TYPO3 project - inspiring people to share!
|
||||
*/
|
||||
|
||||
use TYPO3\PharStreamWrapper\Assertable;
|
||||
use TYPO3\PharStreamWrapper\Exception;
|
||||
|
||||
class ConjunctionInterceptor implements Assertable
|
||||
{
|
||||
/**
|
||||
* @var Assertable[]
|
||||
*/
|
||||
private $assertions;
|
||||
|
||||
public function __construct(array $assertions)
|
||||
{
|
||||
$this->assertAssertions($assertions);
|
||||
$this->assertions = $assertions;
|
||||
}
|
||||
|
||||
/**
|
||||
* Executes assertions based on all contained assertions.
|
||||
*
|
||||
* @param string $path
|
||||
* @param string $command
|
||||
* @return bool
|
||||
* @throws Exception
|
||||
*/
|
||||
public function assert($path, $command)
|
||||
{
|
||||
if ($this->invokeAssertions($path, $command)) {
|
||||
return true;
|
||||
}
|
||||
throw new Exception(
|
||||
sprintf(
|
||||
'Assertion failed in "%s"',
|
||||
$path
|
||||
),
|
||||
1539625084
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param Assertable[] $assertions
|
||||
*/
|
||||
private function assertAssertions(array $assertions)
|
||||
{
|
||||
foreach ($assertions as $assertion) {
|
||||
if (!$assertion instanceof Assertable) {
|
||||
throw new \InvalidArgumentException(
|
||||
sprintf(
|
||||
'Instance %s must implement Assertable',
|
||||
get_class($assertion)
|
||||
),
|
||||
1539624719
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $path
|
||||
* @param string $command
|
||||
* @return bool
|
||||
*/
|
||||
private function invokeAssertions($path, $command)
|
||||
{
|
||||
try {
|
||||
foreach ($this->assertions as $assertion) {
|
||||
if (!$assertion->assert($path, $command)) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
} catch (Exception $exception) {
|
||||
return false;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
}
|
||||
@@ -12,8 +12,8 @@ namespace TYPO3\PharStreamWrapper\Interceptor;
|
||||
*/
|
||||
|
||||
use TYPO3\PharStreamWrapper\Assertable;
|
||||
use TYPO3\PharStreamWrapper\Helper;
|
||||
use TYPO3\PharStreamWrapper\Exception;
|
||||
use TYPO3\PharStreamWrapper\Manager;
|
||||
|
||||
class PharExtensionInterceptor implements Assertable
|
||||
{
|
||||
@@ -45,11 +45,11 @@ class PharExtensionInterceptor implements Assertable
|
||||
*/
|
||||
private function baseFileContainsPharExtension($path)
|
||||
{
|
||||
$baseFile = Helper::determineBaseFile($path);
|
||||
if ($baseFile === null) {
|
||||
$invocation = Manager::instance()->resolve($path);
|
||||
if ($invocation === null) {
|
||||
return false;
|
||||
}
|
||||
$fileExtension = pathinfo($baseFile, PATHINFO_EXTENSION);
|
||||
$fileExtension = pathinfo($invocation->getBaseName(), PATHINFO_EXTENSION);
|
||||
return strtolower($fileExtension) === 'phar';
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,73 @@
|
||||
<?php
|
||||
namespace TYPO3\PharStreamWrapper\Interceptor;
|
||||
|
||||
/*
|
||||
* This file is part of the TYPO3 project.
|
||||
*
|
||||
* It is free software; you can redistribute it and/or modify it under the terms
|
||||
* of the MIT License (MIT). For the full copyright and license information,
|
||||
* please read the LICENSE file that was distributed with this source code.
|
||||
*
|
||||
* The TYPO3 project - inspiring people to share!
|
||||
*/
|
||||
|
||||
use TYPO3\PharStreamWrapper\Assertable;
|
||||
use TYPO3\PharStreamWrapper\Exception;
|
||||
use TYPO3\PharStreamWrapper\Manager;
|
||||
use TYPO3\PharStreamWrapper\Phar\DeserializationException;
|
||||
use TYPO3\PharStreamWrapper\Phar\Reader;
|
||||
|
||||
/**
|
||||
* @internal Experimental implementation of checking against serialized objects in Phar meta-data
|
||||
* @internal This functionality has not been 100% pentested...
|
||||
*/
|
||||
class PharMetaDataInterceptor implements Assertable
|
||||
{
|
||||
/**
|
||||
* Determines whether the according Phar archive contains
|
||||
* (potential insecure) serialized objects.
|
||||
*
|
||||
* @param string $path
|
||||
* @param string $command
|
||||
* @return bool
|
||||
* @throws Exception
|
||||
*/
|
||||
public function assert($path, $command)
|
||||
{
|
||||
if ($this->baseFileDoesNotHaveMetaDataIssues($path)) {
|
||||
return true;
|
||||
}
|
||||
throw new Exception(
|
||||
sprintf(
|
||||
'Problematic meta-data in "%s"',
|
||||
$path
|
||||
),
|
||||
1539632368
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $path
|
||||
* @return bool
|
||||
*/
|
||||
private function baseFileDoesNotHaveMetaDataIssues($path)
|
||||
{
|
||||
$invocation = Manager::instance()->resolve($path);
|
||||
if ($invocation === null) {
|
||||
return false;
|
||||
}
|
||||
// directly return in case invocation was checked before
|
||||
if ($invocation->getVariable(__CLASS__) === true) {
|
||||
return true;
|
||||
}
|
||||
// otherwise analyze meta-data
|
||||
try {
|
||||
$reader = new Reader($invocation->getBaseName());
|
||||
$reader->resolveContainer()->getManifest()->deserializeMetaData();
|
||||
$invocation->setVariable(__CLASS__, true);
|
||||
} catch (DeserializationException $exception) {
|
||||
return false;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
}
|
||||
@@ -11,7 +11,11 @@ namespace TYPO3\PharStreamWrapper;
|
||||
* The TYPO3 project - inspiring people to share!
|
||||
*/
|
||||
|
||||
class Manager implements Assertable
|
||||
use TYPO3\PharStreamWrapper\Resolver\PharInvocation;
|
||||
use TYPO3\PharStreamWrapper\Resolver\PharInvocationCollection;
|
||||
use TYPO3\PharStreamWrapper\Resolver\PharInvocationResolver;
|
||||
|
||||
class Manager
|
||||
{
|
||||
/**
|
||||
* @var self
|
||||
@@ -23,14 +27,29 @@ class Manager implements Assertable
|
||||
*/
|
||||
private $behavior;
|
||||
|
||||
/**
|
||||
* @var Resolvable
|
||||
*/
|
||||
private $resolver;
|
||||
|
||||
/**
|
||||
* @var Collectable
|
||||
*/
|
||||
private $collection;
|
||||
|
||||
/**
|
||||
* @param Behavior $behaviour
|
||||
* @param Resolvable $resolver
|
||||
* @param Collectable $collection
|
||||
* @return self
|
||||
*/
|
||||
public static function initialize(Behavior $behaviour)
|
||||
{
|
||||
public static function initialize(
|
||||
Behavior $behaviour,
|
||||
Resolvable $resolver = null,
|
||||
Collectable $collection = null
|
||||
) {
|
||||
if (self::$instance === null) {
|
||||
self::$instance = new self($behaviour);
|
||||
self::$instance = new self($behaviour, $resolver, $collection);
|
||||
return self::$instance;
|
||||
}
|
||||
throw new \LogicException(
|
||||
@@ -67,9 +86,22 @@ class Manager implements Assertable
|
||||
|
||||
/**
|
||||
* @param Behavior $behaviour
|
||||
* @param Resolvable $resolver
|
||||
* @param Collectable $collection
|
||||
*/
|
||||
private function __construct(Behavior $behaviour)
|
||||
{
|
||||
private function __construct(
|
||||
Behavior $behaviour,
|
||||
Resolvable $resolver = null,
|
||||
Collectable $collection = null
|
||||
) {
|
||||
if ($collection === null) {
|
||||
$collection = new PharInvocationCollection();
|
||||
}
|
||||
if ($resolver === null) {
|
||||
$resolver = new PharInvocationResolver();
|
||||
}
|
||||
$this->collection = $collection;
|
||||
$this->resolver = $resolver;
|
||||
$this->behavior = $behaviour;
|
||||
}
|
||||
|
||||
@@ -82,4 +114,22 @@ class Manager implements Assertable
|
||||
{
|
||||
return $this->behavior->assert($path, $command);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $path
|
||||
* @param null|int $flags
|
||||
* @return null|PharInvocation
|
||||
*/
|
||||
public function resolve($path, $flags = null)
|
||||
{
|
||||
return $this->resolver->resolve($path, $flags);
|
||||
}
|
||||
|
||||
/**
|
||||
* @return Collectable
|
||||
*/
|
||||
public function getCollection()
|
||||
{
|
||||
return $this->collection;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,59 @@
|
||||
<?php
|
||||
namespace TYPO3\PharStreamWrapper\Phar;
|
||||
|
||||
/*
|
||||
* This file is part of the TYPO3 project.
|
||||
*
|
||||
* It is free software; you can redistribute it and/or modify it under the terms
|
||||
* of the MIT License (MIT). For the full copyright and license information,
|
||||
* please read the LICENSE file that was distributed with this source code.
|
||||
*
|
||||
* The TYPO3 project - inspiring people to share!
|
||||
*/
|
||||
|
||||
class Container
|
||||
{
|
||||
/**
|
||||
* @var Stub
|
||||
*/
|
||||
private $stub;
|
||||
|
||||
/**
|
||||
* @var Manifest
|
||||
*/
|
||||
private $manifest;
|
||||
|
||||
/**
|
||||
* @param Stub $stub
|
||||
* @param Manifest $manifest
|
||||
*/
|
||||
public function __construct(Stub $stub, Manifest $manifest)
|
||||
{
|
||||
$this->stub = $stub;
|
||||
$this->manifest = $manifest;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return Stub
|
||||
*/
|
||||
public function getStub()
|
||||
{
|
||||
return $this->stub;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return Manifest
|
||||
*/
|
||||
public function getManifest()
|
||||
{
|
||||
return $this->manifest;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string
|
||||
*/
|
||||
public function getAlias()
|
||||
{
|
||||
return $this->manifest->getAlias() ?: $this->stub->getMappedAlias();
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,18 @@
|
||||
<?php
|
||||
namespace TYPO3\PharStreamWrapper\Phar;
|
||||
|
||||
/*
|
||||
* This file is part of the TYPO3 project.
|
||||
*
|
||||
* It is free software; you can redistribute it and/or modify it under the terms
|
||||
* of the MIT License (MIT). For the full copyright and license information,
|
||||
* please read the LICENSE file that was distributed with this source code.
|
||||
*
|
||||
* The TYPO3 project - inspiring people to share!
|
||||
*/
|
||||
|
||||
use TYPO3\PharStreamWrapper\Exception;
|
||||
|
||||
class DeserializationException extends Exception
|
||||
{
|
||||
}
|
||||
@@ -0,0 +1,176 @@
|
||||
<?php
|
||||
namespace TYPO3\PharStreamWrapper\Phar;
|
||||
|
||||
/*
|
||||
* This file is part of the TYPO3 project.
|
||||
*
|
||||
* It is free software; you can redistribute it and/or modify it under the terms
|
||||
* of the MIT License (MIT). For the full copyright and license information,
|
||||
* please read the LICENSE file that was distributed with this source code.
|
||||
*
|
||||
* The TYPO3 project - inspiring people to share!
|
||||
*/
|
||||
|
||||
use Brumann\Polyfill\Unserialize;
|
||||
|
||||
class Manifest
|
||||
{
|
||||
/**
|
||||
* @param string $content
|
||||
* @return self
|
||||
* @see http://php.net/manual/en/phar.fileformat.phar.php
|
||||
*/
|
||||
public static function fromContent($content)
|
||||
{
|
||||
$target = new static();
|
||||
$target->manifestLength = Reader::resolveFourByteLittleEndian($content, 0);
|
||||
$target->amountOfFiles = Reader::resolveFourByteLittleEndian($content, 4);
|
||||
$target->flags = Reader::resolveFourByteLittleEndian($content, 10);
|
||||
$target->aliasLength = Reader::resolveFourByteLittleEndian($content, 14);
|
||||
$target->alias = substr($content, 18, $target->aliasLength);
|
||||
$target->metaDataLength = Reader::resolveFourByteLittleEndian($content, 18 + $target->aliasLength);
|
||||
$target->metaData = substr($content, 22 + $target->aliasLength, $target->metaDataLength);
|
||||
|
||||
$apiVersionNibbles = Reader::resolveTwoByteBigEndian($content, 8);
|
||||
$target->apiVersion = implode('.', array(
|
||||
($apiVersionNibbles & 0xf000) >> 12,
|
||||
($apiVersionNibbles & 0x0f00) >> 8,
|
||||
($apiVersionNibbles & 0x00f0) >> 4,
|
||||
));
|
||||
|
||||
return $target;
|
||||
}
|
||||
|
||||
/**
|
||||
* @var int
|
||||
*/
|
||||
private $manifestLength;
|
||||
|
||||
/**
|
||||
* @var int
|
||||
*/
|
||||
private $amountOfFiles;
|
||||
|
||||
/**
|
||||
* @var string
|
||||
*/
|
||||
private $apiVersion;
|
||||
|
||||
/**
|
||||
* @var int
|
||||
*/
|
||||
private $flags;
|
||||
|
||||
/**
|
||||
* @var int
|
||||
*/
|
||||
private $aliasLength;
|
||||
|
||||
/**
|
||||
* @var string
|
||||
*/
|
||||
private $alias;
|
||||
|
||||
/**
|
||||
* @var int
|
||||
*/
|
||||
private $metaDataLength;
|
||||
|
||||
/**
|
||||
* @var string
|
||||
*/
|
||||
private $metaData;
|
||||
|
||||
/**
|
||||
* Avoid direct instantiation.
|
||||
*/
|
||||
private function __construct()
|
||||
{
|
||||
}
|
||||
|
||||
/**
|
||||
* @return int
|
||||
*/
|
||||
public function getManifestLength()
|
||||
{
|
||||
return $this->manifestLength;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return int
|
||||
*/
|
||||
public function getAmountOfFiles()
|
||||
{
|
||||
return $this->amountOfFiles;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string
|
||||
*/
|
||||
public function getApiVersion()
|
||||
{
|
||||
return $this->apiVersion;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return int
|
||||
*/
|
||||
public function getFlags()
|
||||
{
|
||||
return $this->flags;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return int
|
||||
*/
|
||||
public function getAliasLength()
|
||||
{
|
||||
return $this->aliasLength;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string
|
||||
*/
|
||||
public function getAlias()
|
||||
{
|
||||
return $this->alias;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return int
|
||||
*/
|
||||
public function getMetaDataLength()
|
||||
{
|
||||
return $this->metaDataLength;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string
|
||||
*/
|
||||
public function getMetaData()
|
||||
{
|
||||
return $this->metaData;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return mixed|null
|
||||
*/
|
||||
public function deserializeMetaData()
|
||||
{
|
||||
if (empty($this->metaData)) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$result = Unserialize::unserialize($this->metaData, array('allowed_classes' => false));
|
||||
|
||||
$serialized = json_encode($result);
|
||||
if (strpos($serialized, '__PHP_Incomplete_Class_Name') !== false) {
|
||||
throw new DeserializationException(
|
||||
'Meta-data contains serialized object',
|
||||
1539623382
|
||||
);
|
||||
}
|
||||
|
||||
return $result;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,254 @@
|
||||
<?php
|
||||
namespace TYPO3\PharStreamWrapper\Phar;
|
||||
|
||||
/*
|
||||
* This file is part of the TYPO3 project.
|
||||
*
|
||||
* It is free software; you can redistribute it and/or modify it under the terms
|
||||
* of the MIT License (MIT). For the full copyright and license information,
|
||||
* please read the LICENSE file that was distributed with this source code.
|
||||
*
|
||||
* The TYPO3 project - inspiring people to share!
|
||||
*/
|
||||
|
||||
class Reader
|
||||
{
|
||||
/**
|
||||
* @var string
|
||||
*/
|
||||
private $fileName;
|
||||
|
||||
/**
|
||||
* Mime-type in order to use zlib, bzip2 or no compression.
|
||||
* In case ext-fileinfo is not present only the relevant types
|
||||
* 'application/x-gzip' and 'application/x-bzip2' are assigned
|
||||
* to this class property.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
private $fileType;
|
||||
|
||||
/**
|
||||
* @param string $fileName
|
||||
*/
|
||||
public function __construct($fileName)
|
||||
{
|
||||
if (strpos($fileName, '://') !== false) {
|
||||
throw new ReaderException(
|
||||
'File name must not contain stream prefix',
|
||||
1539623708
|
||||
);
|
||||
}
|
||||
|
||||
$this->fileName = $fileName;
|
||||
$this->fileType = $this->determineFileType();
|
||||
}
|
||||
|
||||
/**
|
||||
* @return Container
|
||||
*/
|
||||
public function resolveContainer()
|
||||
{
|
||||
$data = $this->extractData($this->resolveStream() . $this->fileName);
|
||||
|
||||
if ($data['stubContent'] === null) {
|
||||
throw new ReaderException(
|
||||
'Cannot resolve stub',
|
||||
1547807881
|
||||
);
|
||||
}
|
||||
if ($data['manifestContent'] === null || $data['manifestLength'] === null) {
|
||||
throw new ReaderException(
|
||||
'Cannot resolve manifest',
|
||||
1547807882
|
||||
);
|
||||
}
|
||||
if (strlen($data['manifestContent']) < $data['manifestLength']) {
|
||||
throw new ReaderException(
|
||||
sprintf(
|
||||
'Exected manifest length %d, got %d',
|
||||
strlen($data['manifestContent']),
|
||||
$data['manifestLength']
|
||||
),
|
||||
1547807883
|
||||
);
|
||||
}
|
||||
|
||||
return new Container(
|
||||
Stub::fromContent($data['stubContent']),
|
||||
Manifest::fromContent($data['manifestContent'])
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $fileName e.g. '/path/file.phar' or 'compress.zlib:///path/file.phar'
|
||||
* @return array
|
||||
*/
|
||||
private function extractData($fileName)
|
||||
{
|
||||
$stubContent = null;
|
||||
$manifestContent = null;
|
||||
$manifestLength = null;
|
||||
|
||||
$resource = fopen($fileName, 'r');
|
||||
if (!is_resource($resource)) {
|
||||
throw new ReaderException(
|
||||
sprintf('Resource %s could not be opened', $fileName),
|
||||
1547902055
|
||||
);
|
||||
}
|
||||
|
||||
while (!feof($resource)) {
|
||||
$line = fgets($resource);
|
||||
// stop reading file when manifest can be extracted
|
||||
if ($manifestLength !== null && $manifestContent !== null && strlen($manifestContent) >= $manifestLength) {
|
||||
break;
|
||||
}
|
||||
|
||||
$manifestPosition = strpos($line, '__HALT_COMPILER();');
|
||||
|
||||
// first line contains start of manifest
|
||||
if ($stubContent === null && $manifestContent === null && $manifestPosition !== false) {
|
||||
$stubContent = substr($line, 0, $manifestPosition - 1);
|
||||
$manifestContent = preg_replace('#^.*__HALT_COMPILER\(\);(?>[ \n]\?>(?>\r\n|\n)?)?#', '', $line);
|
||||
$manifestLength = $this->resolveManifestLength($manifestContent);
|
||||
// line contains start of stub
|
||||
} elseif ($stubContent === null) {
|
||||
$stubContent = $line;
|
||||
// line contains start of manifest
|
||||
} elseif ($manifestContent === null && $manifestPosition !== false) {
|
||||
$manifestContent = preg_replace('#^.*__HALT_COMPILER\(\);(?>[ \n]\?>(?>\r\n|\n)?)?#', '', $line);
|
||||
$manifestLength = $this->resolveManifestLength($manifestContent);
|
||||
// manifest has been started (thus is cannot be stub anymore), add content
|
||||
} elseif ($manifestContent !== null) {
|
||||
$manifestContent .= $line;
|
||||
$manifestLength = $this->resolveManifestLength($manifestContent);
|
||||
// stub has been started (thus cannot be manifest here, yet), add content
|
||||
} elseif ($stubContent !== null) {
|
||||
$stubContent .= $line;
|
||||
}
|
||||
}
|
||||
fclose($resource);
|
||||
|
||||
return array(
|
||||
'stubContent' => $stubContent,
|
||||
'manifestContent' => $manifestContent,
|
||||
'manifestLength' => $manifestLength,
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Resolves stream in order to handle compressed Phar archives.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
private function resolveStream()
|
||||
{
|
||||
if ($this->fileType === 'application/x-gzip' || $this->fileType === 'application/gzip') {
|
||||
return 'compress.zlib://';
|
||||
} elseif ($this->fileType === 'application/x-bzip2') {
|
||||
return 'compress.bzip2://';
|
||||
}
|
||||
return '';
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string
|
||||
*/
|
||||
private function determineFileType()
|
||||
{
|
||||
if (class_exists('\\finfo')) {
|
||||
$fileInfo = new \finfo();
|
||||
return $fileInfo->file($this->fileName, FILEINFO_MIME_TYPE);
|
||||
}
|
||||
return $this->determineFileTypeByHeader();
|
||||
}
|
||||
|
||||
/**
|
||||
* In case ext-fileinfo is not present only the relevant types
|
||||
* 'application/x-gzip' and 'application/x-bzip2' are resolved.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
private function determineFileTypeByHeader()
|
||||
{
|
||||
$resource = fopen($this->fileName, 'r');
|
||||
if (!is_resource($resource)) {
|
||||
throw new ReaderException(
|
||||
sprintf('Resource %s could not be opened', $this->fileName),
|
||||
1557753055
|
||||
);
|
||||
}
|
||||
$header = fgets($resource, 4);
|
||||
fclose($resource);
|
||||
$mimeType = '';
|
||||
if (strpos($header, "\x42\x5a\x68") === 0) {
|
||||
$mimeType = 'application/x-bzip2';
|
||||
} elseif (strpos($header, "\x1f\x8b") === 0) {
|
||||
$mimeType = 'application/x-gzip';
|
||||
}
|
||||
return $mimeType;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $content
|
||||
* @return int|null
|
||||
*/
|
||||
private function resolveManifestLength($content)
|
||||
{
|
||||
if (strlen($content) < 4) {
|
||||
return null;
|
||||
}
|
||||
return static::resolveFourByteLittleEndian($content, 0);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $content
|
||||
* @param int $start
|
||||
* @return int
|
||||
*/
|
||||
public static function resolveFourByteLittleEndian($content, $start)
|
||||
{
|
||||
$payload = substr($content, $start, 4);
|
||||
if (!is_string($payload)) {
|
||||
throw new ReaderException(
|
||||
sprintf('Cannot resolve value at offset %d', $start),
|
||||
1539614260
|
||||
);
|
||||
}
|
||||
|
||||
$value = unpack('V', $payload);
|
||||
if (!isset($value[1])) {
|
||||
throw new ReaderException(
|
||||
sprintf('Cannot resolve value at offset %d', $start),
|
||||
1539614261
|
||||
);
|
||||
}
|
||||
return $value[1];
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $content
|
||||
* @param int $start
|
||||
* @return int
|
||||
*/
|
||||
public static function resolveTwoByteBigEndian($content, $start)
|
||||
{
|
||||
$payload = substr($content, $start, 2);
|
||||
if (!is_string($payload)) {
|
||||
throw new ReaderException(
|
||||
sprintf('Cannot resolve value at offset %d', $start),
|
||||
1539614263
|
||||
);
|
||||
}
|
||||
|
||||
$value = unpack('n', $payload);
|
||||
if (!isset($value[1])) {
|
||||
throw new ReaderException(
|
||||
sprintf('Cannot resolve value at offset %d', $start),
|
||||
1539614264
|
||||
);
|
||||
}
|
||||
return $value[1];
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,18 @@
|
||||
<?php
|
||||
namespace TYPO3\PharStreamWrapper\Phar;
|
||||
|
||||
/*
|
||||
* This file is part of the TYPO3 project.
|
||||
*
|
||||
* It is free software; you can redistribute it and/or modify it under the terms
|
||||
* of the MIT License (MIT). For the full copyright and license information,
|
||||
* please read the LICENSE file that was distributed with this source code.
|
||||
*
|
||||
* The TYPO3 project - inspiring people to share!
|
||||
*/
|
||||
|
||||
use TYPO3\PharStreamWrapper\Exception;
|
||||
|
||||
class ReaderException extends Exception
|
||||
{
|
||||
}
|
||||
@@ -0,0 +1,65 @@
|
||||
<?php
|
||||
namespace TYPO3\PharStreamWrapper\Phar;
|
||||
|
||||
/*
|
||||
* This file is part of the TYPO3 project.
|
||||
*
|
||||
* It is free software; you can redistribute it and/or modify it under the terms
|
||||
* of the MIT License (MIT). For the full copyright and license information,
|
||||
* please read the LICENSE file that was distributed with this source code.
|
||||
*
|
||||
* The TYPO3 project - inspiring people to share!
|
||||
*/
|
||||
|
||||
/**
|
||||
* @internal Experimental implementation of Phar archive internals
|
||||
*/
|
||||
class Stub
|
||||
{
|
||||
/**
|
||||
* @param string $content
|
||||
* @return self
|
||||
*/
|
||||
public static function fromContent($content)
|
||||
{
|
||||
$target = new static();
|
||||
$target->content = $content;
|
||||
|
||||
if (
|
||||
stripos($content, 'Phar::mapPhar(') !== false
|
||||
&& preg_match('#Phar\:\:mapPhar\(([^)]+)\)#', $content, $matches)
|
||||
) {
|
||||
// remove spaces, single & double quotes
|
||||
// @todo `'my' . 'alias' . '.phar'` is not evaluated here
|
||||
$target->mappedAlias = trim($matches[1], ' \'"');
|
||||
}
|
||||
|
||||
return $target;
|
||||
}
|
||||
|
||||
/**
|
||||
* @var string
|
||||
*/
|
||||
private $content;
|
||||
|
||||
/**
|
||||
* @var string
|
||||
*/
|
||||
private $mappedAlias = '';
|
||||
|
||||
/**
|
||||
* @return string
|
||||
*/
|
||||
public function getContent()
|
||||
{
|
||||
return $this->content;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string
|
||||
*/
|
||||
public function getMappedAlias()
|
||||
{
|
||||
return $this->mappedAlias;
|
||||
}
|
||||
}
|
||||
@@ -11,6 +11,8 @@ namespace TYPO3\PharStreamWrapper;
|
||||
* The TYPO3 project - inspiring people to share!
|
||||
*/
|
||||
|
||||
use TYPO3\PharStreamWrapper\Resolver\PharInvocation;
|
||||
|
||||
class PharStreamWrapper
|
||||
{
|
||||
/**
|
||||
@@ -29,6 +31,11 @@ class PharStreamWrapper
|
||||
*/
|
||||
protected $internalResource;
|
||||
|
||||
/**
|
||||
* @var PharInvocation
|
||||
*/
|
||||
protected $invocation;
|
||||
|
||||
/**
|
||||
* @return bool
|
||||
*/
|
||||
@@ -409,7 +416,8 @@ class PharStreamWrapper
|
||||
*/
|
||||
protected function assert($path, $command)
|
||||
{
|
||||
if ($this->resolveAssertable()->assert($path, $command) === true) {
|
||||
if (Manager::instance()->assert($path, $command) === true) {
|
||||
$this->collectInvocation($path);
|
||||
return;
|
||||
}
|
||||
|
||||
@@ -424,7 +432,33 @@ class PharStreamWrapper
|
||||
}
|
||||
|
||||
/**
|
||||
* @return Assertable
|
||||
* @param string $path
|
||||
*/
|
||||
protected function collectInvocation($path)
|
||||
{
|
||||
if (isset($this->invocation)) {
|
||||
return;
|
||||
}
|
||||
|
||||
$manager = Manager::instance();
|
||||
$this->invocation = $manager->resolve($path);
|
||||
if ($this->invocation === null) {
|
||||
throw new Exception(
|
||||
'Expected invocation could not be resolved',
|
||||
1556389591
|
||||
);
|
||||
}
|
||||
// confirm, previous interceptor(s) validated invocation
|
||||
$this->invocation->confirm();
|
||||
$collection = $manager->getCollection();
|
||||
if (!$collection->has($this->invocation)) {
|
||||
$collection->collect($this->invocation);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @return Manager|Assertable
|
||||
* @deprecated Use Manager::instance() directly
|
||||
*/
|
||||
protected function resolveAssertable()
|
||||
{
|
||||
@@ -442,7 +476,7 @@ class PharStreamWrapper
|
||||
{
|
||||
$arguments = func_get_args();
|
||||
array_shift($arguments);
|
||||
$silentExecution = $functionName{0} === '@';
|
||||
$silentExecution = $functionName[0] === '@';
|
||||
$functionName = ltrim($functionName, '@');
|
||||
$this->restoreInternalSteamWrapper();
|
||||
|
||||
|
||||
@@ -0,0 +1,24 @@
|
||||
<?php
|
||||
namespace TYPO3\PharStreamWrapper;
|
||||
|
||||
/*
|
||||
* This file is part of the TYPO3 project.
|
||||
*
|
||||
* It is free software; you can redistribute it and/or modify it under the terms
|
||||
* of the MIT License (MIT). For the full copyright and license information,
|
||||
* please read the LICENSE file that was distributed with this source code.
|
||||
*
|
||||
* The TYPO3 project - inspiring people to share!
|
||||
*/
|
||||
|
||||
use TYPO3\PharStreamWrapper\Resolver\PharInvocation;
|
||||
|
||||
interface Resolvable
|
||||
{
|
||||
/**
|
||||
* @param string $path
|
||||
* @param null|int $flags
|
||||
* @return null|PharInvocation
|
||||
*/
|
||||
public function resolve($path, $flags = null);
|
||||
}
|
||||
@@ -0,0 +1,125 @@
|
||||
<?php
|
||||
namespace TYPO3\PharStreamWrapper\Resolver;
|
||||
|
||||
/*
|
||||
* This file is part of the TYPO3 project.
|
||||
*
|
||||
* It is free software; you can redistribute it and/or modify it under the terms
|
||||
* of the MIT License (MIT). For the full copyright and license information,
|
||||
* please read the LICENSE file that was distributed with this source code.
|
||||
*
|
||||
* The TYPO3 project - inspiring people to share!
|
||||
*/
|
||||
|
||||
use TYPO3\PharStreamWrapper\Exception;
|
||||
|
||||
class PharInvocation
|
||||
{
|
||||
/**
|
||||
* @var string
|
||||
*/
|
||||
private $baseName;
|
||||
|
||||
/**
|
||||
* @var string
|
||||
*/
|
||||
private $alias;
|
||||
|
||||
/**
|
||||
* @var bool
|
||||
* @see \TYPO3\PharStreamWrapper\PharStreamWrapper::collectInvocation()
|
||||
*/
|
||||
private $confirmed = false;
|
||||
|
||||
/**
|
||||
* Arbitrary variables to be used by interceptors as registry
|
||||
* (e.g. in order to avoid duplicate processing and assertions)
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
private $variables;
|
||||
|
||||
/**
|
||||
* @param string $baseName
|
||||
* @param string $alias
|
||||
*/
|
||||
public function __construct($baseName, $alias = '')
|
||||
{
|
||||
if ($baseName === '') {
|
||||
throw new Exception(
|
||||
'Base-name cannot be empty',
|
||||
1551283689
|
||||
);
|
||||
}
|
||||
$this->baseName = $baseName;
|
||||
$this->alias = $alias;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string
|
||||
*/
|
||||
public function __toString()
|
||||
{
|
||||
return $this->baseName;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string
|
||||
*/
|
||||
public function getBaseName()
|
||||
{
|
||||
return $this->baseName;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return null|string
|
||||
*/
|
||||
public function getAlias()
|
||||
{
|
||||
return $this->alias;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return bool
|
||||
*/
|
||||
public function isConfirmed()
|
||||
{
|
||||
return $this->confirmed;
|
||||
}
|
||||
|
||||
public function confirm()
|
||||
{
|
||||
$this->confirmed = true;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $name
|
||||
* @return mixed|null
|
||||
*/
|
||||
public function getVariable($name)
|
||||
{
|
||||
if (!isset($this->variables[$name])) {
|
||||
return null;
|
||||
}
|
||||
return $this->variables[$name];
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $name
|
||||
* @param mixed $value
|
||||
*/
|
||||
public function setVariable($name, $value)
|
||||
{
|
||||
$this->variables[$name] = $value;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param PharInvocation $other
|
||||
* @return bool
|
||||
*/
|
||||
public function equals(PharInvocation $other)
|
||||
{
|
||||
return $other->baseName === $this->baseName
|
||||
&& $other->alias === $this->alias;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,156 @@
|
||||
<?php
|
||||
namespace TYPO3\PharStreamWrapper\Resolver;
|
||||
|
||||
/*
|
||||
* This file is part of the TYPO3 project.
|
||||
*
|
||||
* It is free software; you can redistribute it and/or modify it under the terms
|
||||
* of the MIT License (MIT). For the full copyright and license information,
|
||||
* please read the LICENSE file that was distributed with this source code.
|
||||
*
|
||||
* The TYPO3 project - inspiring people to share!
|
||||
*/
|
||||
|
||||
use TYPO3\PharStreamWrapper\Collectable;
|
||||
|
||||
class PharInvocationCollection implements Collectable
|
||||
{
|
||||
const UNIQUE_INVOCATION = 1;
|
||||
const UNIQUE_BASE_NAME = 2;
|
||||
const DUPLICATE_ALIAS_WARNING = 32;
|
||||
|
||||
/**
|
||||
* @var PharInvocation[]
|
||||
*/
|
||||
private $invocations = array();
|
||||
|
||||
/**
|
||||
* @param PharInvocation $invocation
|
||||
* @return bool
|
||||
*/
|
||||
public function has(PharInvocation $invocation)
|
||||
{
|
||||
return in_array($invocation, $this->invocations, true);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param PharInvocation $invocation
|
||||
* @param null|int $flags
|
||||
* @return bool
|
||||
*/
|
||||
public function collect(PharInvocation $invocation, $flags = null)
|
||||
{
|
||||
if ($flags === null) {
|
||||
$flags = static::UNIQUE_INVOCATION | static::DUPLICATE_ALIAS_WARNING;
|
||||
}
|
||||
if ($invocation->getBaseName() === ''
|
||||
|| $invocation->getAlias() === ''
|
||||
|| !$this->assertUniqueBaseName($invocation, $flags)
|
||||
|| !$this->assertUniqueInvocation($invocation, $flags)
|
||||
) {
|
||||
return false;
|
||||
}
|
||||
if ($flags & static::DUPLICATE_ALIAS_WARNING) {
|
||||
$this->triggerDuplicateAliasWarning($invocation);
|
||||
}
|
||||
|
||||
$this->invocations[] = $invocation;
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param callable $callback
|
||||
* @param bool $reverse
|
||||
* @return null|PharInvocation
|
||||
*/
|
||||
public function findByCallback($callback, $reverse = false)
|
||||
{
|
||||
foreach ($this->getInvocations($reverse) as $invocation) {
|
||||
if (call_user_func($callback, $invocation) === true) {
|
||||
return $invocation;
|
||||
}
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Asserts that base-name is unique. This disallows having multiple invocations for
|
||||
* same base-name but having different alias names.
|
||||
*
|
||||
* @param PharInvocation $invocation
|
||||
* @param int $flags
|
||||
* @return bool
|
||||
*/
|
||||
private function assertUniqueBaseName(PharInvocation $invocation, $flags)
|
||||
{
|
||||
if (!($flags & static::UNIQUE_BASE_NAME)) {
|
||||
return true;
|
||||
}
|
||||
return $this->findByCallback(
|
||||
function (PharInvocation $candidate) use ($invocation) {
|
||||
return $candidate->getBaseName() === $invocation->getBaseName();
|
||||
}
|
||||
) === null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Asserts that combination of base-name and alias is unique. This allows having multiple
|
||||
* invocations for same base-name but having different alias names (for whatever reason).
|
||||
*
|
||||
* @param PharInvocation $invocation
|
||||
* @param int $flags
|
||||
* @return bool
|
||||
*/
|
||||
private function assertUniqueInvocation(PharInvocation $invocation, $flags)
|
||||
{
|
||||
if (!($flags & static::UNIQUE_INVOCATION)) {
|
||||
return true;
|
||||
}
|
||||
return $this->findByCallback(
|
||||
function (PharInvocation $candidate) use ($invocation) {
|
||||
return $candidate->equals($invocation);
|
||||
}
|
||||
) === null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Triggers warning for invocations with same alias and same confirmation state.
|
||||
*
|
||||
* @param PharInvocation $invocation
|
||||
* @see \TYPO3\PharStreamWrapper\PharStreamWrapper::collectInvocation()
|
||||
*/
|
||||
private function triggerDuplicateAliasWarning(PharInvocation $invocation)
|
||||
{
|
||||
$sameAliasInvocation = $this->findByCallback(
|
||||
function (PharInvocation $candidate) use ($invocation) {
|
||||
return $candidate->isConfirmed() === $invocation->isConfirmed()
|
||||
&& $candidate->getAlias() === $invocation->getAlias();
|
||||
},
|
||||
true
|
||||
);
|
||||
if ($sameAliasInvocation === null) {
|
||||
return;
|
||||
}
|
||||
trigger_error(
|
||||
sprintf(
|
||||
'Alias %s cannot be used by %s, already used by %s',
|
||||
$invocation->getAlias(),
|
||||
$invocation->getBaseName(),
|
||||
$sameAliasInvocation->getBaseName()
|
||||
),
|
||||
E_USER_WARNING
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param bool $reverse
|
||||
* @return PharInvocation[]
|
||||
*/
|
||||
private function getInvocations($reverse = false)
|
||||
{
|
||||
if ($reverse) {
|
||||
return array_reverse($this->invocations);
|
||||
}
|
||||
return $this->invocations;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,249 @@
|
||||
<?php
|
||||
namespace TYPO3\PharStreamWrapper\Resolver;
|
||||
|
||||
/*
|
||||
* This file is part of the TYPO3 project.
|
||||
*
|
||||
* It is free software; you can redistribute it and/or modify it under the terms
|
||||
* of the MIT License (MIT). For the full copyright and license information,
|
||||
* please read the LICENSE file that was distributed with this source code.
|
||||
*
|
||||
* The TYPO3 project - inspiring people to share!
|
||||
*/
|
||||
|
||||
use TYPO3\PharStreamWrapper\Helper;
|
||||
use TYPO3\PharStreamWrapper\Manager;
|
||||
use TYPO3\PharStreamWrapper\Phar\Reader;
|
||||
use TYPO3\PharStreamWrapper\Phar\ReaderException;
|
||||
use TYPO3\PharStreamWrapper\Resolvable;
|
||||
|
||||
class PharInvocationResolver implements Resolvable
|
||||
{
|
||||
const RESOLVE_REALPATH = 1;
|
||||
const RESOLVE_ALIAS = 2;
|
||||
const ASSERT_INTERNAL_INVOCATION = 32;
|
||||
|
||||
/**
|
||||
* @var string[]
|
||||
*/
|
||||
private $invocationFunctionNames = array(
|
||||
'include',
|
||||
'include_once',
|
||||
'require',
|
||||
'require_once'
|
||||
);
|
||||
|
||||
/**
|
||||
* Contains resolved base names in order to reduce file IO.
|
||||
*
|
||||
* @var string[]
|
||||
*/
|
||||
private $baseNames = array();
|
||||
|
||||
/**
|
||||
* Resolves PharInvocation value object (baseName and optional alias).
|
||||
*
|
||||
* Phar aliases are intended to be used only inside Phar archives, however
|
||||
* PharStreamWrapper needs this information exposed outside of Phar as well
|
||||
* It is possible that same alias is used for different $baseName values.
|
||||
* That's why PharInvocationCollection behaves like a stack when resolving
|
||||
* base-name for a given alias. On the other hand it is not possible that
|
||||
* one $baseName is referring to multiple aliases.
|
||||
* @see https://secure.php.net/manual/en/phar.setalias.php
|
||||
* @see https://secure.php.net/manual/en/phar.mapphar.php
|
||||
*
|
||||
* @param string $path
|
||||
* @param int|null $flags
|
||||
* @return null|PharInvocation
|
||||
*/
|
||||
public function resolve($path, $flags = null)
|
||||
{
|
||||
$hasPharPrefix = Helper::hasPharPrefix($path);
|
||||
if ($flags === null) {
|
||||
$flags = static::RESOLVE_REALPATH | static::RESOLVE_ALIAS;
|
||||
}
|
||||
|
||||
if ($hasPharPrefix && $flags & static::RESOLVE_ALIAS) {
|
||||
$invocation = $this->findByAlias($path);
|
||||
if ($invocation !== null) {
|
||||
return $invocation;
|
||||
}
|
||||
}
|
||||
|
||||
$baseName = $this->resolveBaseName($path, $flags);
|
||||
if ($baseName === null) {
|
||||
return null;
|
||||
}
|
||||
|
||||
if ($flags & static::RESOLVE_REALPATH) {
|
||||
$baseName = $this->baseNames[$baseName];
|
||||
}
|
||||
|
||||
return $this->retrieveInvocation($baseName, $flags);
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves PharInvocation, either existing in collection or created on demand
|
||||
* with resolving a potential alias name used in the according Phar archive.
|
||||
*
|
||||
* @param string $baseName
|
||||
* @param int $flags
|
||||
* @return PharInvocation
|
||||
*/
|
||||
private function retrieveInvocation($baseName, $flags)
|
||||
{
|
||||
$invocation = $this->findByBaseName($baseName);
|
||||
if ($invocation !== null) {
|
||||
return $invocation;
|
||||
}
|
||||
|
||||
if ($flags & static::RESOLVE_ALIAS) {
|
||||
$reader = new Reader($baseName);
|
||||
$alias = $reader->resolveContainer()->getAlias();
|
||||
} else {
|
||||
$alias = '';
|
||||
}
|
||||
// add unconfirmed(!) new invocation to collection
|
||||
$invocation = new PharInvocation($baseName, $alias);
|
||||
Manager::instance()->getCollection()->collect($invocation);
|
||||
return $invocation;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $path
|
||||
* @param int $flags
|
||||
* @return null|string
|
||||
*/
|
||||
private function resolveBaseName($path, $flags)
|
||||
{
|
||||
$baseName = $this->findInBaseNames($path);
|
||||
if ($baseName !== null) {
|
||||
return $baseName;
|
||||
}
|
||||
|
||||
$baseName = Helper::determineBaseFile($path);
|
||||
if ($baseName !== null) {
|
||||
$this->addBaseName($baseName);
|
||||
return $baseName;
|
||||
}
|
||||
|
||||
$possibleAlias = $this->resolvePossibleAlias($path);
|
||||
if (!($flags & static::RESOLVE_ALIAS) || $possibleAlias === null) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$trace = debug_backtrace();
|
||||
foreach ($trace as $item) {
|
||||
if (!isset($item['function']) || !isset($item['args'][0])
|
||||
|| !in_array($item['function'], $this->invocationFunctionNames, true)) {
|
||||
continue;
|
||||
}
|
||||
$currentPath = $item['args'][0];
|
||||
if (Helper::hasPharPrefix($currentPath)) {
|
||||
continue;
|
||||
}
|
||||
$currentBaseName = Helper::determineBaseFile($currentPath);
|
||||
if ($currentBaseName === null) {
|
||||
continue;
|
||||
}
|
||||
// ensure the possible alias name (how we have been called initially) matches
|
||||
// the resolved alias name that was retrieved by the current possible base name
|
||||
try {
|
||||
$reader = new Reader($currentBaseName);
|
||||
$currentAlias = $reader->resolveContainer()->getAlias();
|
||||
} catch (ReaderException $exception) {
|
||||
// most probably that was not a Phar file
|
||||
continue;
|
||||
}
|
||||
if (empty($currentAlias) || $currentAlias !== $possibleAlias) {
|
||||
continue;
|
||||
}
|
||||
$this->addBaseName($currentBaseName);
|
||||
return $currentBaseName;
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $path
|
||||
* @return null|string
|
||||
*/
|
||||
private function resolvePossibleAlias($path)
|
||||
{
|
||||
$normalizedPath = Helper::normalizePath($path);
|
||||
return strstr($normalizedPath, '/', true) ?: null;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $baseName
|
||||
* @return null|PharInvocation
|
||||
*/
|
||||
private function findByBaseName($baseName)
|
||||
{
|
||||
return Manager::instance()->getCollection()->findByCallback(
|
||||
function (PharInvocation $candidate) use ($baseName) {
|
||||
return $candidate->getBaseName() === $baseName;
|
||||
},
|
||||
true
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $path
|
||||
* @return null|string
|
||||
*/
|
||||
private function findInBaseNames($path)
|
||||
{
|
||||
// return directly if the resolved base name was submitted
|
||||
if (in_array($path, $this->baseNames, true)) {
|
||||
return $path;
|
||||
}
|
||||
|
||||
$parts = explode('/', Helper::normalizePath($path));
|
||||
|
||||
while (count($parts)) {
|
||||
$currentPath = implode('/', $parts);
|
||||
if (isset($this->baseNames[$currentPath])) {
|
||||
return $currentPath;
|
||||
}
|
||||
array_pop($parts);
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $baseName
|
||||
*/
|
||||
private function addBaseName($baseName)
|
||||
{
|
||||
if (isset($this->baseNames[$baseName])) {
|
||||
return;
|
||||
}
|
||||
$this->baseNames[$baseName] = Helper::normalizeWindowsPath(
|
||||
realpath($baseName)
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Finds confirmed(!) invocations by alias.
|
||||
*
|
||||
* @param string $path
|
||||
* @return null|PharInvocation
|
||||
* @see \TYPO3\PharStreamWrapper\PharStreamWrapper::collectInvocation()
|
||||
*/
|
||||
private function findByAlias($path)
|
||||
{
|
||||
$possibleAlias = $this->resolvePossibleAlias($path);
|
||||
if ($possibleAlias === null) {
|
||||
return null;
|
||||
}
|
||||
return Manager::instance()->getCollection()->findByCallback(
|
||||
function (PharInvocation $candidate) use ($possibleAlias) {
|
||||
return $candidate->isConfirmed() && $candidate->getAlias() === $possibleAlias;
|
||||
},
|
||||
true
|
||||
);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user