1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843 |
- <?php
- /**
- * OpenStack Swift based file backend.
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License along
- * with this program; if not, write to the Free Software Foundation, Inc.,
- * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- * http://www.gnu.org/copyleft/gpl.html
- *
- * @file
- * @ingroup FileBackend
- * @author Russ Nelson
- */
- use Wikimedia\AtEase\AtEase;
- /**
- * @brief Class for an OpenStack Swift (or Ceph RGW) based file backend.
- *
- * StatusValue messages should avoid mentioning the Swift account name.
- * Likewise, error suppression should be used to avoid path disclosure.
- *
- * @ingroup FileBackend
- * @since 1.19
- */
- class SwiftFileBackend extends FileBackendStore {
- /** @var MultiHttpClient */
- protected $http;
- /** @var int TTL in seconds */
- protected $authTTL;
- /** @var string Authentication base URL (without version) */
- protected $swiftAuthUrl;
- /** @var string Override of storage base URL */
- protected $swiftStorageUrl;
- /** @var string Swift user (account:user) to authenticate as */
- protected $swiftUser;
- /** @var string Secret key for user */
- protected $swiftKey;
- /** @var string Shared secret value for making temp URLs */
- protected $swiftTempUrlKey;
- /** @var string S3 access key (RADOS Gateway) */
- protected $rgwS3AccessKey;
- /** @var string S3 authentication key (RADOS Gateway) */
- protected $rgwS3SecretKey;
- /** @var array Additional users (account:user) with read permissions on public containers */
- protected $readUsers;
- /** @var array Additional users (account:user) with write permissions on public containers */
- protected $writeUsers;
- /** @var array Additional users (account:user) with read permissions on private containers */
- protected $secureReadUsers;
- /** @var array Additional users (account:user) with write permissions on private containers */
- protected $secureWriteUsers;
- /** @var BagOStuff */
- protected $srvCache;
- /** @var MapCacheLRU Container stat cache */
- protected $containerStatCache;
- /** @var array */
- protected $authCreds;
- /** @var int UNIX timestamp */
- protected $authSessionTimestamp = 0;
- /** @var int UNIX timestamp */
- protected $authErrorTimestamp = null;
- /** @var bool Whether the server is an Ceph RGW */
- protected $isRGW = false;
- /**
- * @see FileBackendStore::__construct()
- * @param array $config Params include:
- * - swiftAuthUrl : Swift authentication server URL
- * - swiftUser : Swift user used by MediaWiki (account:username)
- * - swiftKey : Swift authentication key for the above user
- * - swiftAuthTTL : Swift authentication TTL (seconds)
- * - swiftTempUrlKey : Swift "X-Account-Meta-Temp-URL-Key" value on the account.
- * Do not set this until it has been set in the backend.
- * - swiftStorageUrl : Swift storage URL (overrides that of the authentication response).
- * This is useful to set if a TLS proxy is in use.
- * - shardViaHashLevels : Map of container names to sharding config with:
- * - base : base of hash characters, 16 or 36
- * - levels : the number of hash levels (and digits)
- * - repeat : hash subdirectories are prefixed with all the
- * parent hash directory names (e.g. "a/ab/abc")
- * - cacheAuthInfo : Whether to cache authentication tokens in APC, etc.
- * If those are not available, then the main cache will be used.
- * This is probably insecure in shared hosting environments.
- * - rgwS3AccessKey : Rados Gateway S3 "access key" value on the account.
- * Do not set this until it has been set in the backend.
- * This is used for generating expiring pre-authenticated URLs.
- * Only use this when using rgw and to work around
- * http://tracker.newdream.net/issues/3454.
- * - rgwS3SecretKey : Rados Gateway S3 "secret key" value on the account.
- * Do not set this until it has been set in the backend.
- * This is used for generating expiring pre-authenticated URLs.
- * Only use this when using rgw and to work around
- * http://tracker.newdream.net/issues/3454.
- * - readUsers : Swift users with read access to public containers (account:username)
- * - writeUsers : Swift users with write access to public containers (account:username)
- * - secureReadUsers : Swift users with read access to private containers (account:username)
- * - secureWriteUsers : Swift users with write access to private containers (account:username)
- */
- public function __construct( array $config ) {
- parent::__construct( $config );
- // Required settings
- $this->swiftAuthUrl = $config['swiftAuthUrl'];
- $this->swiftUser = $config['swiftUser'];
- $this->swiftKey = $config['swiftKey'];
- // Optional settings
- $this->authTTL = $config['swiftAuthTTL'] ?? 15 * 60; // some sane number
- $this->swiftTempUrlKey = $config['swiftTempUrlKey'] ?? '';
- $this->swiftStorageUrl = $config['swiftStorageUrl'] ?? null;
- $this->shardViaHashLevels = $config['shardViaHashLevels'] ?? '';
- $this->rgwS3AccessKey = $config['rgwS3AccessKey'] ?? '';
- $this->rgwS3SecretKey = $config['rgwS3SecretKey'] ?? '';
- // HTTP helper client
- $this->http = new MultiHttpClient( [] );
- // Cache container information to mask latency
- if ( isset( $config['wanCache'] ) && $config['wanCache'] instanceof WANObjectCache ) {
- $this->memCache = $config['wanCache'];
- }
- // Process cache for container info
- $this->containerStatCache = new MapCacheLRU( 300 );
- // Cache auth token information to avoid RTTs
- if ( !empty( $config['cacheAuthInfo'] ) && isset( $config['srvCache'] ) ) {
- $this->srvCache = $config['srvCache'];
- } else {
- $this->srvCache = new EmptyBagOStuff();
- }
- $this->readUsers = $config['readUsers'] ?? [];
- $this->writeUsers = $config['writeUsers'] ?? [];
- $this->secureReadUsers = $config['secureReadUsers'] ?? [];
- $this->secureWriteUsers = $config['secureWriteUsers'] ?? [];
- }
- public function getFeatures() {
- return (
- self::ATTR_UNICODE_PATHS |
- self::ATTR_HEADERS |
- self::ATTR_METADATA
- );
- }
- protected function resolveContainerPath( $container, $relStoragePath ) {
- if ( !mb_check_encoding( $relStoragePath, 'UTF-8' ) ) {
- return null; // not UTF-8, makes it hard to use CF and the swift HTTP API
- } elseif ( strlen( rawurlencode( $relStoragePath ) ) > 1024 ) {
- return null; // too long for Swift
- }
- return $relStoragePath;
- }
- public function isPathUsableInternal( $storagePath ) {
- list( $container, $rel ) = $this->resolveStoragePathReal( $storagePath );
- if ( $rel === null ) {
- return false; // invalid
- }
- return is_array( $this->getContainerStat( $container ) );
- }
- /**
- * Filter/normalize a header map to only include mutable "content-"/"x-content-" headers
- *
- * Mutable headers can be changed via HTTP POST even if the file content is the same
- *
- * @see https://docs.openstack.org/api-ref/object-store
- * @param string[] $headers Map of (header => value) for a swift object
- * @return string[] Map of (header => value) for Content-* headers mutable via POST
- */
- protected function extractMutableContentHeaders( array $headers ) {
- $contentHeaders = [];
- // Normalize casing, and strip out illegal headers
- foreach ( $headers as $name => $value ) {
- $name = strtolower( $name );
- if ( !preg_match( '/^(x-)?content-(?!length$)/', $name ) ) {
- // Only allow content-* and x-content-* headers (but not content-length)
- continue;
- } elseif ( $name === 'content-type' && !strlen( $value ) ) {
- // This header can be set to a value but not unset for sanity
- continue;
- }
- $contentHeaders[$name] = $value;
- }
- // By default, Swift has annoyingly low maximum header value limits
- if ( isset( $contentHeaders['content-disposition'] ) ) {
- $disposition = '';
- // @note: assume FileBackend::makeContentDisposition() already used
- foreach ( explode( ';', $contentHeaders['content-disposition'] ) as $part ) {
- $part = trim( $part );
- $new = ( $disposition === '' ) ? $part : "{$disposition};{$part}";
- if ( strlen( $new ) <= 255 ) {
- $disposition = $new;
- } else {
- break; // too long; sigh
- }
- }
- $contentHeaders['content-disposition'] = $disposition;
- }
- return $contentHeaders;
- }
- /**
- * @see https://docs.openstack.org/api-ref/object-store
- * @param string[] $headers Map of (header => value) for a swift object
- * @return string[] Map of (metadata header name => metadata value)
- */
- protected function extractMetadataHeaders( array $headers ) {
- $metadataHeaders = [];
- foreach ( $headers as $name => $value ) {
- $name = strtolower( $name );
- if ( strpos( $name, 'x-object-meta-' ) === 0 ) {
- $metadataHeaders[$name] = $value;
- }
- }
- return $metadataHeaders;
- }
- /**
- * @see https://docs.openstack.org/api-ref/object-store
- * @param string[] $headers Map of (header => value) for a swift object
- * @return string[] Map of (metadata key name => metadata value)
- */
- protected function getMetadataFromHeaders( array $headers ) {
- $prefixLen = strlen( 'x-object-meta-' );
- $metadata = [];
- foreach ( $this->extractMetadataHeaders( $headers ) as $name => $value ) {
- $metadata[substr( $name, $prefixLen )] = $value;
- }
- return $metadata;
- }
- protected function doCreateInternal( array $params ) {
- $status = $this->newStatus();
- list( $dstCont, $dstRel ) = $this->resolveStoragePathReal( $params['dst'] );
- if ( $dstRel === null ) {
- $status->fatal( 'backend-fail-invalidpath', $params['dst'] );
- return $status;
- }
- // Headers that are not strictly a function of the file content
- $mutableHeaders = $this->extractMutableContentHeaders( $params['headers'] ?? [] );
- // Make sure that the "content-type" header is set to something sensible
- $mutableHeaders['content-type'] = $mutableHeaders['content-type']
- ?? $this->getContentType( $params['dst'], $params['content'], null );
- $reqs = [ [
- 'method' => 'PUT',
- 'url' => [ $dstCont, $dstRel ],
- 'headers' => array_merge(
- $mutableHeaders,
- [
- 'etag' => md5( $params['content'] ),
- 'content-length' => strlen( $params['content'] ),
- 'x-object-meta-sha1base36' =>
- Wikimedia\base_convert( sha1( $params['content'] ), 16, 36, 31 )
- ]
- ),
- 'body' => $params['content']
- ] ];
- $method = __METHOD__;
- $handler = function ( array $request, StatusValue $status ) use ( $method, $params ) {
- list( $rcode, $rdesc, $rhdrs, $rbody, $rerr ) = $request['response'];
- if ( $rcode === 201 || $rcode === 202 ) {
- // good
- } elseif ( $rcode === 412 ) {
- $status->fatal( 'backend-fail-contenttype', $params['dst'] );
- } else {
- $this->onError( $status, $method, $params, $rerr, $rcode, $rdesc );
- }
- return SwiftFileOpHandle::CONTINUE_IF_OK;
- };
- $opHandle = new SwiftFileOpHandle( $this, $handler, $reqs );
- if ( !empty( $params['async'] ) ) { // deferred
- $status->value = $opHandle;
- } else { // actually write the object in Swift
- $status->merge( current( $this->executeOpHandlesInternal( [ $opHandle ] ) ) );
- }
- return $status;
- }
- protected function doStoreInternal( array $params ) {
- $status = $this->newStatus();
- list( $dstCont, $dstRel ) = $this->resolveStoragePathReal( $params['dst'] );
- if ( $dstRel === null ) {
- $status->fatal( 'backend-fail-invalidpath', $params['dst'] );
- return $status;
- }
- // Open a handle to the source file so that it can be streamed. The size and hash
- // will be computed using the handle. In the off chance that the source file changes
- // during this operation, the PUT will fail due to an ETag mismatch and be aborted.
- AtEase::suppressWarnings();
- $srcHandle = fopen( $params['src'], 'rb' );
- AtEase::restoreWarnings();
- if ( $srcHandle === false ) { // source doesn't exist?
- $status->fatal( 'backend-fail-notexists', $params['src'] );
- return $status;
- }
- // Compute the MD5 and SHA-1 hashes in one pass
- $srcSize = fstat( $srcHandle )['size'];
- $md5Context = hash_init( 'md5' );
- $sha1Context = hash_init( 'sha1' );
- $hashDigestSize = 0;
- while ( !feof( $srcHandle ) ) {
- $buffer = (string)fread( $srcHandle, 131072 ); // 128 KiB
- hash_update( $md5Context, $buffer );
- hash_update( $sha1Context, $buffer );
- $hashDigestSize += strlen( $buffer );
- }
- // Reset the handle back to the beginning so that it can be streamed
- rewind( $srcHandle );
- if ( $hashDigestSize !== $srcSize ) {
- $status->fatal( 'backend-fail-hash', $params['src'] );
- return $status;
- }
- // Headers that are not strictly a function of the file content
- $mutableHeaders = $this->extractMutableContentHeaders( $params['headers'] ?? [] );
- // Make sure that the "content-type" header is set to something sensible
- $mutableHeaders['content-type'] = $mutableHeaders['content-type']
- ?? $this->getContentType( $params['dst'], null, $params['src'] );
- $reqs = [ [
- 'method' => 'PUT',
- 'url' => [ $dstCont, $dstRel ],
- 'headers' => array_merge(
- $mutableHeaders,
- [
- 'content-length' => $srcSize,
- 'etag' => hash_final( $md5Context ),
- 'x-object-meta-sha1base36' =>
- Wikimedia\base_convert( hash_final( $sha1Context ), 16, 36, 31 )
- ]
- ),
- 'body' => $srcHandle // resource
- ] ];
- $method = __METHOD__;
- $handler = function ( array $request, StatusValue $status ) use ( $method, $params ) {
- list( $rcode, $rdesc, $rhdrs, $rbody, $rerr ) = $request['response'];
- if ( $rcode === 201 || $rcode === 202 ) {
- // good
- } elseif ( $rcode === 412 ) {
- $status->fatal( 'backend-fail-contenttype', $params['dst'] );
- } else {
- $this->onError( $status, $method, $params, $rerr, $rcode, $rdesc );
- }
- return SwiftFileOpHandle::CONTINUE_IF_OK;
- };
- $opHandle = new SwiftFileOpHandle( $this, $handler, $reqs );
- $opHandle->resourcesToClose[] = $srcHandle;
- if ( !empty( $params['async'] ) ) { // deferred
- $status->value = $opHandle;
- } else { // actually write the object in Swift
- $status->merge( current( $this->executeOpHandlesInternal( [ $opHandle ] ) ) );
- }
- return $status;
- }
- protected function doCopyInternal( array $params ) {
- $status = $this->newStatus();
- list( $srcCont, $srcRel ) = $this->resolveStoragePathReal( $params['src'] );
- if ( $srcRel === null ) {
- $status->fatal( 'backend-fail-invalidpath', $params['src'] );
- return $status;
- }
- list( $dstCont, $dstRel ) = $this->resolveStoragePathReal( $params['dst'] );
- if ( $dstRel === null ) {
- $status->fatal( 'backend-fail-invalidpath', $params['dst'] );
- return $status;
- }
- $reqs = [ [
- 'method' => 'PUT',
- 'url' => [ $dstCont, $dstRel ],
- 'headers' => array_merge(
- $this->extractMutableContentHeaders( $params['headers'] ?? [] ),
- [
- 'x-copy-from' => '/' . rawurlencode( $srcCont ) . '/' .
- str_replace( "%2F", "/", rawurlencode( $srcRel ) )
- ]
- )
- ] ];
- $method = __METHOD__;
- $handler = function ( array $request, StatusValue $status ) use ( $method, $params ) {
- list( $rcode, $rdesc, $rhdrs, $rbody, $rerr ) = $request['response'];
- if ( $rcode === 201 ) {
- // good
- } elseif ( $rcode === 404 ) {
- if ( empty( $params['ignoreMissingSource'] ) ) {
- $status->fatal( 'backend-fail-copy', $params['src'], $params['dst'] );
- }
- } else {
- $this->onError( $status, $method, $params, $rerr, $rcode, $rdesc );
- }
- return SwiftFileOpHandle::CONTINUE_IF_OK;
- };
- $opHandle = new SwiftFileOpHandle( $this, $handler, $reqs );
- if ( !empty( $params['async'] ) ) { // deferred
- $status->value = $opHandle;
- } else { // actually write the object in Swift
- $status->merge( current( $this->executeOpHandlesInternal( [ $opHandle ] ) ) );
- }
- return $status;
- }
- protected function doMoveInternal( array $params ) {
- $status = $this->newStatus();
- list( $srcCont, $srcRel ) = $this->resolveStoragePathReal( $params['src'] );
- if ( $srcRel === null ) {
- $status->fatal( 'backend-fail-invalidpath', $params['src'] );
- return $status;
- }
- list( $dstCont, $dstRel ) = $this->resolveStoragePathReal( $params['dst'] );
- if ( $dstRel === null ) {
- $status->fatal( 'backend-fail-invalidpath', $params['dst'] );
- return $status;
- }
- $reqs = [ [
- 'method' => 'PUT',
- 'url' => [ $dstCont, $dstRel ],
- 'headers' => array_merge(
- $this->extractMutableContentHeaders( $params['headers'] ?? [] ),
- [
- 'x-copy-from' => '/' . rawurlencode( $srcCont ) . '/' .
- str_replace( "%2F", "/", rawurlencode( $srcRel ) )
- ]
- )
- ] ];
- if ( "{$srcCont}/{$srcRel}" !== "{$dstCont}/{$dstRel}" ) {
- $reqs[] = [
- 'method' => 'DELETE',
- 'url' => [ $srcCont, $srcRel ],
- 'headers' => []
- ];
- }
- $method = __METHOD__;
- $handler = function ( array $request, StatusValue $status ) use ( $method, $params ) {
- list( $rcode, $rdesc, $rhdrs, $rbody, $rerr ) = $request['response'];
- if ( $request['method'] === 'PUT' && $rcode === 201 ) {
- // good
- } elseif ( $request['method'] === 'DELETE' && $rcode === 204 ) {
- // good
- } elseif ( $rcode === 404 ) {
- if ( empty( $params['ignoreMissingSource'] ) ) {
- $status->fatal( 'backend-fail-move', $params['src'], $params['dst'] );
- } else {
- // Leave Status as OK but skip the DELETE request
- return SwiftFileOpHandle::CONTINUE_NO;
- }
- } else {
- $this->onError( $status, $method, $params, $rerr, $rcode, $rdesc );
- }
- return SwiftFileOpHandle::CONTINUE_IF_OK;
- };
- $opHandle = new SwiftFileOpHandle( $this, $handler, $reqs );
- if ( !empty( $params['async'] ) ) { // deferred
- $status->value = $opHandle;
- } else { // actually move the object in Swift
- $status->merge( current( $this->executeOpHandlesInternal( [ $opHandle ] ) ) );
- }
- return $status;
- }
- protected function doDeleteInternal( array $params ) {
- $status = $this->newStatus();
- list( $srcCont, $srcRel ) = $this->resolveStoragePathReal( $params['src'] );
- if ( $srcRel === null ) {
- $status->fatal( 'backend-fail-invalidpath', $params['src'] );
- return $status;
- }
- $reqs = [ [
- 'method' => 'DELETE',
- 'url' => [ $srcCont, $srcRel ],
- 'headers' => []
- ] ];
- $method = __METHOD__;
- $handler = function ( array $request, StatusValue $status ) use ( $method, $params ) {
- list( $rcode, $rdesc, $rhdrs, $rbody, $rerr ) = $request['response'];
- if ( $rcode === 204 ) {
- // good
- } elseif ( $rcode === 404 ) {
- if ( empty( $params['ignoreMissingSource'] ) ) {
- $status->fatal( 'backend-fail-delete', $params['src'] );
- }
- } else {
- $this->onError( $status, $method, $params, $rerr, $rcode, $rdesc );
- }
- return SwiftFileOpHandle::CONTINUE_IF_OK;
- };
- $opHandle = new SwiftFileOpHandle( $this, $handler, $reqs );
- if ( !empty( $params['async'] ) ) { // deferred
- $status->value = $opHandle;
- } else { // actually delete the object in Swift
- $status->merge( current( $this->executeOpHandlesInternal( [ $opHandle ] ) ) );
- }
- return $status;
- }
- protected function doDescribeInternal( array $params ) {
- $status = $this->newStatus();
- list( $srcCont, $srcRel ) = $this->resolveStoragePathReal( $params['src'] );
- if ( $srcRel === null ) {
- $status->fatal( 'backend-fail-invalidpath', $params['src'] );
- return $status;
- }
- // Fetch the old object headers/metadata...this should be in stat cache by now
- $stat = $this->getFileStat( [ 'src' => $params['src'], 'latest' => 1 ] );
- if ( $stat && !isset( $stat['xattr'] ) ) { // older cache entry
- $stat = $this->doGetFileStat( [ 'src' => $params['src'], 'latest' => 1 ] );
- }
- if ( !$stat ) {
- $status->fatal( 'backend-fail-describe', $params['src'] );
- return $status;
- }
- // Swift object POST clears any prior headers, so merge the new and old headers here.
- // Also, during, POST, libcurl adds "Content-Type: application/x-www-form-urlencoded"
- // if "Content-Type" is not set, which would clobber the header value for the object.
- $oldMetadataHeaders = [];
- foreach ( $stat['xattr']['metadata'] as $name => $value ) {
- $oldMetadataHeaders["x-object-meta-$name"] = $value;
- }
- $newContentHeaders = $this->extractMutableContentHeaders( $params['headers'] ?? [] );
- $oldContentHeaders = $stat['xattr']['headers'];
- $reqs = [ [
- 'method' => 'POST',
- 'url' => [ $srcCont, $srcRel ],
- 'headers' => $oldMetadataHeaders + $newContentHeaders + $oldContentHeaders
- ] ];
- $method = __METHOD__;
- $handler = function ( array $request, StatusValue $status ) use ( $method, $params ) {
- list( $rcode, $rdesc, $rhdrs, $rbody, $rerr ) = $request['response'];
- if ( $rcode === 202 ) {
- // good
- } elseif ( $rcode === 404 ) {
- $status->fatal( 'backend-fail-describe', $params['src'] );
- } else {
- $this->onError( $status, $method, $params, $rerr, $rcode, $rdesc );
- }
- };
- $opHandle = new SwiftFileOpHandle( $this, $handler, $reqs );
- if ( !empty( $params['async'] ) ) { // deferred
- $status->value = $opHandle;
- } else { // actually change the object in Swift
- $status->merge( current( $this->executeOpHandlesInternal( [ $opHandle ] ) ) );
- }
- return $status;
- }
- protected function doPrepareInternal( $fullCont, $dir, array $params ) {
- $status = $this->newStatus();
- // (a) Check if container already exists
- $stat = $this->getContainerStat( $fullCont );
- if ( is_array( $stat ) ) {
- return $status; // already there
- } elseif ( $stat === self::$RES_ERROR ) {
- $status->fatal( 'backend-fail-internal', $this->name );
- $this->logger->error( __METHOD__ . ': cannot get container stat' );
- return $status;
- }
- // (b) Create container as needed with proper ACLs
- if ( $stat === false ) {
- $params['op'] = 'prepare';
- $status->merge( $this->createContainer( $fullCont, $params ) );
- }
- return $status;
- }
- protected function doSecureInternal( $fullCont, $dir, array $params ) {
- $status = $this->newStatus();
- if ( empty( $params['noAccess'] ) ) {
- return $status; // nothing to do
- }
- $stat = $this->getContainerStat( $fullCont );
- if ( is_array( $stat ) ) {
- $readUsers = array_merge( $this->secureReadUsers, [ $this->swiftUser ] );
- $writeUsers = array_merge( $this->secureWriteUsers, [ $this->swiftUser ] );
- // Make container private to end-users...
- $status->merge( $this->setContainerAccess(
- $fullCont,
- $readUsers,
- $writeUsers
- ) );
- } elseif ( $stat === false ) {
- $status->fatal( 'backend-fail-usable', $params['dir'] );
- } else {
- $status->fatal( 'backend-fail-internal', $this->name );
- $this->logger->error( __METHOD__ . ': cannot get container stat' );
- }
- return $status;
- }
- protected function doPublishInternal( $fullCont, $dir, array $params ) {
- $status = $this->newStatus();
- $stat = $this->getContainerStat( $fullCont );
- if ( is_array( $stat ) ) {
- $readUsers = array_merge( $this->readUsers, [ $this->swiftUser, '.r:*' ] );
- $writeUsers = array_merge( $this->writeUsers, [ $this->swiftUser ] );
- // Make container public to end-users...
- $status->merge( $this->setContainerAccess(
- $fullCont,
- $readUsers,
- $writeUsers
- ) );
- } elseif ( $stat === false ) {
- $status->fatal( 'backend-fail-usable', $params['dir'] );
- } else {
- $status->fatal( 'backend-fail-internal', $this->name );
- $this->logger->error( __METHOD__ . ': cannot get container stat' );
- }
- return $status;
- }
- protected function doCleanInternal( $fullCont, $dir, array $params ) {
- $status = $this->newStatus();
- // Only containers themselves can be removed, all else is virtual
- if ( $dir != '' ) {
- return $status; // nothing to do
- }
- // (a) Check the container
- $stat = $this->getContainerStat( $fullCont, true );
- if ( $stat === false ) {
- return $status; // ok, nothing to do
- } elseif ( !is_array( $stat ) ) {
- $status->fatal( 'backend-fail-internal', $this->name );
- $this->logger->error( __METHOD__ . ': cannot get container stat' );
- return $status;
- }
- // (b) Delete the container if empty
- if ( $stat['count'] == 0 ) {
- $params['op'] = 'clean';
- $status->merge( $this->deleteContainer( $fullCont, $params ) );
- }
- return $status;
- }
- protected function doGetFileStat( array $params ) {
- $params = [ 'srcs' => [ $params['src'] ], 'concurrency' => 1 ] + $params;
- unset( $params['src'] );
- $stats = $this->doGetFileStatMulti( $params );
- return reset( $stats );
- }
- /**
- * Convert dates like "Tue, 03 Jan 2012 22:01:04 GMT"/"2013-05-11T07:37:27.678360Z".
- * Dates might also come in like "2013-05-11T07:37:27.678360" from Swift listings,
- * missing the timezone suffix (though Ceph RGW does not appear to have this bug).
- *
- * @param string $ts
- * @param int $format Output format (TS_* constant)
- * @return string
- * @throws FileBackendError
- */
- protected function convertSwiftDate( $ts, $format = TS_MW ) {
- try {
- $timestamp = new MWTimestamp( $ts );
- return $timestamp->getTimestamp( $format );
- } catch ( Exception $e ) {
- throw new FileBackendError( $e->getMessage() );
- }
- }
- /**
- * Fill in any missing object metadata and save it to Swift
- *
- * @param array $objHdrs Object response headers
- * @param string $path Storage path to object
- * @return array New headers
- */
- protected function addMissingHashMetadata( array $objHdrs, $path ) {
- if ( isset( $objHdrs['x-object-meta-sha1base36'] ) ) {
- return $objHdrs; // nothing to do
- }
- /** @noinspection PhpUnusedLocalVariableInspection */
- $ps = $this->scopedProfileSection( __METHOD__ . "-{$this->name}" );
- $this->logger->error( __METHOD__ . ": {path} was not stored with SHA-1 metadata.",
- [ 'path' => $path ] );
- $objHdrs['x-object-meta-sha1base36'] = false;
- $auth = $this->getAuthentication();
- if ( !$auth ) {
- return $objHdrs; // failed
- }
- // Find prior custom HTTP headers
- $postHeaders = $this->extractMutableContentHeaders( $objHdrs );
- // Find prior metadata headers
- $postHeaders += $this->extractMetadataHeaders( $objHdrs );
- $status = $this->newStatus();
- /** @noinspection PhpUnusedLocalVariableInspection */
- $scopeLockS = $this->getScopedFileLocks( [ $path ], LockManager::LOCK_UW, $status );
- if ( $status->isOK() ) {
- $tmpFile = $this->getLocalCopy( [ 'src' => $path, 'latest' => 1 ] );
- if ( $tmpFile ) {
- $hash = $tmpFile->getSha1Base36();
- if ( $hash !== false ) {
- $objHdrs['x-object-meta-sha1base36'] = $hash;
- // Merge new SHA1 header into the old ones
- $postHeaders['x-object-meta-sha1base36'] = $hash;
- list( $srcCont, $srcRel ) = $this->resolveStoragePathReal( $path );
- list( $rcode ) = $this->http->run( [
- 'method' => 'POST',
- 'url' => $this->storageUrl( $auth, $srcCont, $srcRel ),
- 'headers' => $this->authTokenHeaders( $auth ) + $postHeaders
- ] );
- if ( $rcode >= 200 && $rcode <= 299 ) {
- $this->deleteFileCache( $path );
- return $objHdrs; // success
- }
- }
- }
- }
- $this->logger->error( __METHOD__ . ': unable to set SHA-1 metadata for {path}',
- [ 'path' => $path ] );
- return $objHdrs; // failed
- }
- protected function doGetFileContentsMulti( array $params ) {
- $auth = $this->getAuthentication();
- $ep = array_diff_key( $params, [ 'srcs' => 1 ] ); // for error logging
- // Blindly create tmp files and stream to them, catching any exception
- // if the file does not exist. Do not waste time doing file stats here.
- $reqs = []; // (path => op)
- // Initial dummy values to preserve path order
- $contents = array_fill_keys( $params['srcs'], self::$RES_ERROR );
- foreach ( $params['srcs'] as $path ) { // each path in this concurrent batch
- list( $srcCont, $srcRel ) = $this->resolveStoragePathReal( $path );
- if ( $srcRel === null || !$auth ) {
- continue; // invalid storage path or auth error
- }
- // Create a new temporary memory file...
- $handle = fopen( 'php://temp', 'wb' );
- if ( $handle ) {
- $reqs[$path] = [
- 'method' => 'GET',
- 'url' => $this->storageUrl( $auth, $srcCont, $srcRel ),
- 'headers' => $this->authTokenHeaders( $auth )
- + $this->headersFromParams( $params ),
- 'stream' => $handle,
- ];
- }
- }
- $opts = [ 'maxConnsPerHost' => $params['concurrency'] ];
- $reqs = $this->http->runMulti( $reqs, $opts );
- foreach ( $reqs as $path => $op ) {
- list( $rcode, $rdesc, $rhdrs, $rbody, $rerr ) = $op['response'];
- if ( $rcode >= 200 && $rcode <= 299 ) {
- rewind( $op['stream'] ); // start from the beginning
- $content = (string)stream_get_contents( $op['stream'] );
- $size = strlen( $content );
- // Make sure that stream finished
- if ( $size === (int)$rhdrs['content-length'] ) {
- $contents[$path] = $content;
- } else {
- $contents[$path] = self::$RES_ERROR;
- $rerr = "Got {$size}/{$rhdrs['content-length']} bytes";
- $this->onError( null, __METHOD__,
- [ 'src' => $path ] + $ep, $rerr, $rcode, $rdesc );
- }
- } elseif ( $rcode === 404 ) {
- $contents[$path] = self::$RES_ABSENT;
- } else {
- $contents[$path] = self::$RES_ERROR;
- $this->onError( null, __METHOD__,
- [ 'src' => $path ] + $ep, $rerr, $rcode, $rdesc );
- }
- fclose( $op['stream'] ); // close open handle
- }
- return $contents;
- }
- protected function doDirectoryExists( $fullCont, $dir, array $params ) {
- $prefix = ( $dir == '' ) ? null : "{$dir}/";
- $status = $this->objectListing( $fullCont, 'names', 1, null, $prefix );
- if ( $status->isOK() ) {
- return ( count( $status->value ) ) > 0;
- }
- return self::$RES_ERROR;
- }
- /**
- * @see FileBackendStore::getDirectoryListInternal()
- * @param string $fullCont
- * @param string $dir
- * @param array $params
- * @return SwiftFileBackendDirList
- */
- public function getDirectoryListInternal( $fullCont, $dir, array $params ) {
- return new SwiftFileBackendDirList( $this, $fullCont, $dir, $params );
- }
- /**
- * @see FileBackendStore::getFileListInternal()
- * @param string $fullCont
- * @param string $dir
- * @param array $params
- * @return SwiftFileBackendFileList
- */
- public function getFileListInternal( $fullCont, $dir, array $params ) {
- return new SwiftFileBackendFileList( $this, $fullCont, $dir, $params );
- }
- /**
- * Do not call this function outside of SwiftFileBackendFileList
- *
- * @param string $fullCont Resolved container name
- * @param string $dir Resolved storage directory with no trailing slash
- * @param string|null &$after Resolved container relative path to list items after
- * @param int $limit Max number of items to list
- * @param array $params Parameters for getDirectoryList()
- * @return array List of container relative resolved paths of directories directly under $dir
- * @throws FileBackendError
- */
- public function getDirListPageInternal( $fullCont, $dir, &$after, $limit, array $params ) {
- $dirs = [];
- if ( $after === INF ) {
- return $dirs; // nothing more
- }
- /** @noinspection PhpUnusedLocalVariableInspection */
- $ps = $this->scopedProfileSection( __METHOD__ . "-{$this->name}" );
- $prefix = ( $dir == '' ) ? null : "{$dir}/";
- // Non-recursive: only list dirs right under $dir
- if ( !empty( $params['topOnly'] ) ) {
- $status = $this->objectListing( $fullCont, 'names', $limit, $after, $prefix, '/' );
- if ( !$status->isOK() ) {
- throw new FileBackendError( "Iterator page I/O error." );
- }
- $objects = $status->value;
- // @phan-suppress-next-line PhanTypeSuspiciousNonTraversableForeach
- foreach ( $objects as $object ) { // files and directories
- if ( substr( $object, -1 ) === '/' ) {
- $dirs[] = $object; // directories end in '/'
- }
- }
- } else {
- // Recursive: list all dirs under $dir and its subdirs
- $getParentDir = function ( $path ) {
- return ( strpos( $path, '/' ) !== false ) ? dirname( $path ) : false;
- };
- // Get directory from last item of prior page
- $lastDir = $getParentDir( $after ); // must be first page
- $status = $this->objectListing( $fullCont, 'names', $limit, $after, $prefix );
- if ( !$status->isOK() ) {
- throw new FileBackendError( "Iterator page I/O error." );
- }
- $objects = $status->value;
- // @phan-suppress-next-line PhanTypeSuspiciousNonTraversableForeach
- foreach ( $objects as $object ) { // files
- $objectDir = $getParentDir( $object ); // directory of object
- if ( $objectDir !== false && $objectDir !== $dir ) {
- // Swift stores paths in UTF-8, using binary sorting.
- // See function "create_container_table" in common/db.py.
- // If a directory is not "greater" than the last one,
- // then it was already listed by the calling iterator.
- if ( strcmp( $objectDir, $lastDir ) > 0 ) {
- $pDir = $objectDir;
- do { // add dir and all its parent dirs
- $dirs[] = "{$pDir}/";
- $pDir = $getParentDir( $pDir );
- } while ( $pDir !== false // sanity
- && strcmp( $pDir, $lastDir ) > 0 // not done already
- && strlen( $pDir ) > strlen( $dir ) // within $dir
- );
- }
- $lastDir = $objectDir;
- }
- }
- }
- // Page on the unfiltered directory listing (what is returned may be filtered)
- if ( count( $objects ) < $limit ) {
- $after = INF; // avoid a second RTT
- } else {
- $after = end( $objects ); // update last item
- }
- return $dirs;
- }
- /**
- * Do not call this function outside of SwiftFileBackendFileList
- *
- * @param string $fullCont Resolved container name
- * @param string $dir Resolved storage directory with no trailing slash
- * @param string|null &$after Resolved container relative path of file to list items after
- * @param int $limit Max number of items to list
- * @param array $params Parameters for getDirectoryList()
- * @return array List of resolved container relative paths of files under $dir
- * @throws FileBackendError
- */
- public function getFileListPageInternal( $fullCont, $dir, &$after, $limit, array $params ) {
- $files = []; // list of (path, stat array or null) entries
- if ( $after === INF ) {
- return $files; // nothing more
- }
- /** @noinspection PhpUnusedLocalVariableInspection */
- $ps = $this->scopedProfileSection( __METHOD__ . "-{$this->name}" );
- $prefix = ( $dir == '' ) ? null : "{$dir}/";
- // $objects will contain a list of unfiltered names or stdClass items
- // Non-recursive: only list files right under $dir
- if ( !empty( $params['topOnly'] ) ) {
- if ( !empty( $params['adviseStat'] ) ) {
- $status = $this->objectListing( $fullCont, 'info', $limit, $after, $prefix, '/' );
- } else {
- $status = $this->objectListing( $fullCont, 'names', $limit, $after, $prefix, '/' );
- }
- } else {
- // Recursive: list all files under $dir and its subdirs
- if ( !empty( $params['adviseStat'] ) ) {
- $status = $this->objectListing( $fullCont, 'info', $limit, $after, $prefix );
- } else {
- $status = $this->objectListing( $fullCont, 'names', $limit, $after, $prefix );
- }
- }
- // Reformat this list into a list of (name, stat array or null) entries
- if ( !$status->isOK() ) {
- throw new FileBackendError( "Iterator page I/O error." );
- }
- $objects = $status->value;
- $files = $this->buildFileObjectListing( $objects );
- // Page on the unfiltered object listing (what is returned may be filtered)
- if ( count( $objects ) < $limit ) {
- $after = INF; // avoid a second RTT
- } else {
- $after = end( $objects ); // update last item
- $after = is_object( $after ) ? $after->name : $after;
- }
- return $files;
- }
- /**
- * Build a list of file objects, filtering out any directories
- * and extracting any stat info if provided in $objects
- *
- * @param stdClass[]|string[] $objects List of stdClass items or object names
- * @return array List of (names,stat array or null) entries
- */
- private function buildFileObjectListing( array $objects ) {
- $names = [];
- foreach ( $objects as $object ) {
- if ( is_object( $object ) ) {
- if ( isset( $object->subdir ) || !isset( $object->name ) ) {
- continue; // virtual directory entry; ignore
- }
- $stat = [
- // Convert various random Swift dates to TS_MW
- 'mtime' => $this->convertSwiftDate( $object->last_modified, TS_MW ),
- 'size' => (int)$object->bytes,
- 'sha1' => null,
- // Note: manifiest ETags are not an MD5 of the file
- 'md5' => ctype_xdigit( $object->hash ) ? $object->hash : null,
- 'latest' => false // eventually consistent
- ];
- $names[] = [ $object->name, $stat ];
- } elseif ( substr( $object, -1 ) !== '/' ) {
- // Omit directories, which end in '/' in listings
- $names[] = [ $object, null ];
- }
- }
- return $names;
- }
- /**
- * Do not call this function outside of SwiftFileBackendFileList
- *
- * @param string $path Storage path
- * @param array $val Stat value
- */
- public function loadListingStatInternal( $path, array $val ) {
- $this->cheapCache->setField( $path, 'stat', $val );
- }
- protected function doGetFileXAttributes( array $params ) {
- $stat = $this->getFileStat( $params );
- // Stat entries filled by file listings don't include metadata/headers
- if ( is_array( $stat ) && !isset( $stat['xattr'] ) ) {
- $this->clearCache( [ $params['src'] ] );
- $stat = $this->getFileStat( $params );
- }
- if ( is_array( $stat ) ) {
- return $stat['xattr'];
- }
- return ( $stat === self::$RES_ERROR ) ? self::$RES_ERROR : self::$RES_ABSENT;
- }
- protected function doGetFileSha1base36( array $params ) {
- // Avoid using stat entries from file listings, which never include the SHA-1 hash.
- // Also, recompute the hash if it's not part of the metadata headers for some reason.
- $params['requireSHA1'] = true;
- $stat = $this->getFileStat( $params );
- if ( is_array( $stat ) ) {
- return $stat['sha1'];
- }
- return ( $stat === self::$RES_ERROR ) ? self::$RES_ERROR : self::$RES_ABSENT;
- }
- protected function doStreamFile( array $params ) {
- $status = $this->newStatus();
- $flags = !empty( $params['headless'] ) ? HTTPFileStreamer::STREAM_HEADLESS : 0;
- list( $srcCont, $srcRel ) = $this->resolveStoragePathReal( $params['src'] );
- if ( $srcRel === null ) {
- HTTPFileStreamer::send404Message( $params['src'], $flags );
- $status->fatal( 'backend-fail-invalidpath', $params['src'] );
- return $status;
- }
- $auth = $this->getAuthentication();
- if ( !$auth || !is_array( $this->getContainerStat( $srcCont ) ) ) {
- HTTPFileStreamer::send404Message( $params['src'], $flags );
- $status->fatal( 'backend-fail-stream', $params['src'] );
- return $status;
- }
- // If "headers" is set, we only want to send them if the file is there.
- // Do not bother checking if the file exists if headers are not set though.
- if ( $params['headers'] && !$this->fileExists( $params ) ) {
- HTTPFileStreamer::send404Message( $params['src'], $flags );
- $status->fatal( 'backend-fail-stream', $params['src'] );
- return $status;
- }
- // Send the requested additional headers
- foreach ( $params['headers'] as $header ) {
- header( $header ); // aways send
- }
- if ( empty( $params['allowOB'] ) ) {
- // Cancel output buffering and gzipping if set
- ( $this->obResetFunc )();
- }
- $handle = fopen( 'php://output', 'wb' );
- list( $rcode, $rdesc, $rhdrs, $rbody, $rerr ) = $this->http->run( [
- 'method' => 'GET',
- 'url' => $this->storageUrl( $auth, $srcCont, $srcRel ),
- 'headers' => $this->authTokenHeaders( $auth )
- + $this->headersFromParams( $params ) + $params['options'],
- 'stream' => $handle,
- 'flags' => [ 'relayResponseHeaders' => empty( $params['headless'] ) ]
- ] );
- if ( $rcode >= 200 && $rcode <= 299 ) {
- // good
- } elseif ( $rcode === 404 ) {
- $status->fatal( 'backend-fail-stream', $params['src'] );
- // Per T43113, nasty things can happen if bad cache entries get
- // stuck in cache. It's also possible that this error can come up
- // with simple race conditions. Clear out the stat cache to be safe.
- $this->clearCache( [ $params['src'] ] );
- $this->deleteFileCache( $params['src'] );
- } else {
- $this->onError( $status, __METHOD__, $params, $rerr, $rcode, $rdesc );
- }
- return $status;
- }
- protected function doGetLocalCopyMulti( array $params ) {
- $auth = $this->getAuthentication();
- $ep = array_diff_key( $params, [ 'srcs' => 1 ] ); // for error logging
- // Blindly create tmp files and stream to them, catching any exception
- // if the file does not exist. Do not waste time doing file stats here.
- $reqs = []; // (path => op)
- // Initial dummy values to preserve path order
- $tmpFiles = array_fill_keys( $params['srcs'], self::$RES_ERROR );
- foreach ( $params['srcs'] as $path ) { // each path in this concurrent batch
- list( $srcCont, $srcRel ) = $this->resolveStoragePathReal( $path );
- if ( $srcRel === null || !$auth ) {
- continue; // invalid storage path or auth error
- }
- // Get source file extension
- $ext = FileBackend::extensionFromPath( $path );
- // Create a new temporary file...
- $tmpFile = $this->tmpFileFactory->newTempFSFile( 'localcopy_', $ext );
- $handle = $tmpFile ? fopen( $tmpFile->getPath(), 'wb' ) : false;
- if ( $handle ) {
- $reqs[$path] = [
- 'method' => 'GET',
- 'url' => $this->storageUrl( $auth, $srcCont, $srcRel ),
- 'headers' => $this->authTokenHeaders( $auth )
- + $this->headersFromParams( $params ),
- 'stream' => $handle,
- ];
- $tmpFiles[$path] = $tmpFile;
- }
- }
- // Ceph RADOS Gateway is in use (strong consistency) or X-Newest will be used
- $latest = ( $this->isRGW || !empty( $params['latest'] ) );
- $opts = [ 'maxConnsPerHost' => $params['concurrency'] ];
- $reqs = $this->http->runMulti( $reqs, $opts );
- foreach ( $reqs as $path => $op ) {
- list( $rcode, $rdesc, $rhdrs, $rbody, $rerr ) = $op['response'];
- fclose( $op['stream'] ); // close open handle
- if ( $rcode >= 200 && $rcode <= 299 ) {
- /** @var TempFSFile $tmpFile */
- $tmpFile = $tmpFiles[$path];
- // Make sure that the stream finished and fully wrote to disk
- $size = $tmpFile->getSize();
- if ( $size !== (int)$rhdrs['content-length'] ) {
- $tmpFiles[$path] = self::$RES_ERROR;
- $rerr = "Got {$size}/{$rhdrs['content-length']} bytes";
- $this->onError( null, __METHOD__,
- [ 'src' => $path ] + $ep, $rerr, $rcode, $rdesc );
- }
- // Set the file stat process cache in passing
- $stat = $this->getStatFromHeaders( $rhdrs );
- $stat['latest'] = $latest;
- $this->cheapCache->setField( $path, 'stat', $stat );
- } elseif ( $rcode === 404 ) {
- $tmpFiles[$path] = self::$RES_ABSENT;
- $this->cheapCache->setField(
- $path,
- 'stat',
- $latest ? self::$ABSENT_LATEST : self::$ABSENT_NORMAL
- );
- } else {
- $tmpFiles[$path] = self::$RES_ERROR;
- $this->onError( null, __METHOD__,
- [ 'src' => $path ] + $ep, $rerr, $rcode, $rdesc );
- }
- }
- return $tmpFiles;
- }
- public function getFileHttpUrl( array $params ) {
- if ( $this->swiftTempUrlKey != '' ||
- ( $this->rgwS3AccessKey != '' && $this->rgwS3SecretKey != '' )
- ) {
- list( $srcCont, $srcRel ) = $this->resolveStoragePathReal( $params['src'] );
- if ( $srcRel === null ) {
- return self::TEMPURL_ERROR; // invalid path
- }
- $auth = $this->getAuthentication();
- if ( !$auth ) {
- return self::TEMPURL_ERROR;
- }
- $ttl = $params['ttl'] ?? 86400;
- $expires = time() + $ttl;
- if ( $this->swiftTempUrlKey != '' ) {
- $url = $this->storageUrl( $auth, $srcCont, $srcRel );
- // Swift wants the signature based on the unencoded object name
- $contPath = parse_url( $this->storageUrl( $auth, $srcCont ), PHP_URL_PATH );
- $signature = hash_hmac( 'sha1',
- "GET\n{$expires}\n{$contPath}/{$srcRel}",
- $this->swiftTempUrlKey
- );
- return "{$url}?temp_url_sig={$signature}&temp_url_expires={$expires}";
- } else { // give S3 API URL for rgw
- // Path for signature starts with the bucket
- $spath = '/' . rawurlencode( $srcCont ) . '/' .
- str_replace( '%2F', '/', rawurlencode( $srcRel ) );
- // Calculate the hash
- $signature = base64_encode( hash_hmac(
- 'sha1',
- "GET\n\n\n{$expires}\n{$spath}",
- $this->rgwS3SecretKey,
- true // raw
- ) );
- // See https://s3.amazonaws.com/doc/s3-developer-guide/RESTAuthentication.html.
- // Note: adding a newline for empty CanonicalizedAmzHeaders does not work.
- // Note: S3 API is the rgw default; remove the /swift/ URL bit.
- return str_replace( '/swift/v1', '', $this->storageUrl( $auth ) . $spath ) .
- '?' .
- http_build_query( [
- 'Signature' => $signature,
- 'Expires' => $expires,
- 'AWSAccessKeyId' => $this->rgwS3AccessKey
- ] );
- }
- }
- return self::TEMPURL_ERROR;
- }
- protected function directoriesAreVirtual() {
- return true;
- }
- /**
- * Get headers to send to Swift when reading a file based
- * on a FileBackend params array, e.g. that of getLocalCopy().
- * $params is currently only checked for a 'latest' flag.
- *
- * @param array $params
- * @return array
- */
- protected function headersFromParams( array $params ) {
- $hdrs = [];
- if ( !empty( $params['latest'] ) ) {
- $hdrs['x-newest'] = 'true';
- }
- return $hdrs;
- }
- protected function doExecuteOpHandlesInternal( array $fileOpHandles ) {
- /** @var SwiftFileOpHandle[] $fileOpHandles */
- '@phan-var SwiftFileOpHandle[] $fileOpHandles';
- /** @var StatusValue[] $statuses */
- $statuses = [];
- $auth = $this->getAuthentication();
- if ( !$auth ) {
- foreach ( $fileOpHandles as $index => $fileOpHandle ) {
- $statuses[$index] = $this->newStatus( 'backend-fail-connect', $this->name );
- }
- return $statuses;
- }
- // Split the HTTP requests into stages that can be done concurrently
- $httpReqsByStage = []; // map of (stage => index => HTTP request)
- foreach ( $fileOpHandles as $index => $fileOpHandle ) {
- $reqs = $fileOpHandle->httpOp;
- // Convert the 'url' parameter to an actual URL using $auth
- foreach ( $reqs as $stage => &$req ) {
- list( $container, $relPath ) = $req['url'];
- $req['url'] = $this->storageUrl( $auth, $container, $relPath );
- $req['headers'] = $req['headers'] ?? [];
- $req['headers'] = $this->authTokenHeaders( $auth ) + $req['headers'];
- $httpReqsByStage[$stage][$index] = $req;
- }
- $statuses[$index] = $this->newStatus();
- }
- // Run all requests for the first stage, then the next, and so on
- $reqCount = count( $httpReqsByStage );
- for ( $stage = 0; $stage < $reqCount; ++$stage ) {
- $httpReqs = $this->http->runMulti( $httpReqsByStage[$stage] );
- foreach ( $httpReqs as $index => $httpReq ) {
- /** @var SwiftFileOpHandle $fileOpHandle */
- $fileOpHandle = $fileOpHandles[$index];
- // Run the callback for each request of this operation
- $status = $statuses[$index];
- ( $fileOpHandle->callback )( $httpReq, $status );
- // On failure, abort all remaining requests for this operation. This is used
- // in "move" operations to abort the DELETE request if the PUT request fails.
- if (
- !$status->isOK() ||
- $fileOpHandle->state === $fileOpHandle::CONTINUE_NO
- ) {
- $stages = count( $fileOpHandle->httpOp );
- for ( $s = ( $stage + 1 ); $s < $stages; ++$s ) {
- unset( $httpReqsByStage[$s][$index] );
- }
- }
- }
- }
- return $statuses;
- }
- /**
- * Set read/write permissions for a Swift container.
- *
- * @see http://docs.openstack.org/developer/swift/misc.html#acls
- *
- * In general, we don't allow listings to end-users. It's not useful, isn't well-defined
- * (lists are truncated to 10000 item with no way to page), and is just a performance risk.
- *
- * @param string $container Resolved Swift container
- * @param array $readUsers List of the possible criteria for a request to have
- * access to read a container. Each item is one of the following formats:
- * - account:user : Grants access if the request is by the given user
- * - ".r:<regex>" : Grants access if the request is from a referrer host that
- * matches the expression and the request is not for a listing.
- * Setting this to '*' effectively makes a container public.
- * -".rlistings:<regex>" : Grants access if the request is from a referrer host that
- * matches the expression and the request is for a listing.
- * @param array $writeUsers A list of the possible criteria for a request to have
- * access to write to a container. Each item is of the following format:
- * - account:user : Grants access if the request is by the given user
- * @return StatusValue
- */
- protected function setContainerAccess( $container, array $readUsers, array $writeUsers ) {
- $status = $this->newStatus();
- $auth = $this->getAuthentication();
- if ( !$auth ) {
- $status->fatal( 'backend-fail-connect', $this->name );
- return $status;
- }
- list( $rcode, $rdesc, $rhdrs, $rbody, $rerr ) = $this->http->run( [
- 'method' => 'POST',
- 'url' => $this->storageUrl( $auth, $container ),
- 'headers' => $this->authTokenHeaders( $auth ) + [
- 'x-container-read' => implode( ',', $readUsers ),
- 'x-container-write' => implode( ',', $writeUsers )
- ]
- ] );
- if ( $rcode != 204 && $rcode !== 202 ) {
- $status->fatal( 'backend-fail-internal', $this->name );
- $this->logger->error( __METHOD__ . ': unexpected rcode value ({rcode})',
- [ 'rcode' => $rcode ] );
- }
- return $status;
- }
- /**
- * Get a Swift container stat array, possibly from process cache.
- * Use $reCache if the file count or byte count is needed.
- *
- * @param string $container Container name
- * @param bool $bypassCache Bypass all caches and load from Swift
- * @return array|bool|null False on 404, null on failure
- */
- protected function getContainerStat( $container, $bypassCache = false ) {
- /** @noinspection PhpUnusedLocalVariableInspection */
- $ps = $this->scopedProfileSection( __METHOD__ . "-{$this->name}" );
- if ( $bypassCache ) { // purge cache
- $this->containerStatCache->clear( $container );
- } elseif ( !$this->containerStatCache->hasField( $container, 'stat' ) ) {
- $this->primeContainerCache( [ $container ] ); // check persistent cache
- }
- if ( !$this->containerStatCache->hasField( $container, 'stat' ) ) {
- $auth = $this->getAuthentication();
- if ( !$auth ) {
- return self::$RES_ERROR;
- }
- list( $rcode, $rdesc, $rhdrs, $rbody, $rerr ) = $this->http->run( [
- 'method' => 'HEAD',
- 'url' => $this->storageUrl( $auth, $container ),
- 'headers' => $this->authTokenHeaders( $auth )
- ] );
- if ( $rcode === 204 ) {
- $stat = [
- 'count' => $rhdrs['x-container-object-count'],
- 'bytes' => $rhdrs['x-container-bytes-used']
- ];
- if ( $bypassCache ) {
- return $stat;
- } else {
- $this->containerStatCache->setField( $container, 'stat', $stat ); // cache it
- $this->setContainerCache( $container, $stat ); // update persistent cache
- }
- } elseif ( $rcode === 404 ) {
- return self::$RES_ABSENT;
- } else {
- $this->onError( null, __METHOD__,
- [ 'cont' => $container ], $rerr, $rcode, $rdesc );
- return self::$RES_ERROR;
- }
- }
- return $this->containerStatCache->getField( $container, 'stat' );
- }
- /**
- * Create a Swift container
- *
- * @param string $container Container name
- * @param array $params
- * @return StatusValue
- */
- protected function createContainer( $container, array $params ) {
- $status = $this->newStatus();
- $auth = $this->getAuthentication();
- if ( !$auth ) {
- $status->fatal( 'backend-fail-connect', $this->name );
- return $status;
- }
- // @see SwiftFileBackend::setContainerAccess()
- if ( empty( $params['noAccess'] ) ) {
- // public
- $readUsers = array_merge( $this->readUsers, [ '.r:*', $this->swiftUser ] );
- $writeUsers = array_merge( $this->writeUsers, [ $this->swiftUser ] );
- } else {
- // private
- $readUsers = array_merge( $this->secureReadUsers, [ $this->swiftUser ] );
- $writeUsers = array_merge( $this->secureWriteUsers, [ $this->swiftUser ] );
- }
- list( $rcode, $rdesc, $rhdrs, $rbody, $rerr ) = $this->http->run( [
- 'method' => 'PUT',
- 'url' => $this->storageUrl( $auth, $container ),
- 'headers' => $this->authTokenHeaders( $auth ) + [
- 'x-container-read' => implode( ',', $readUsers ),
- 'x-container-write' => implode( ',', $writeUsers )
- ]
- ] );
- if ( $rcode === 201 ) { // new
- // good
- } elseif ( $rcode === 202 ) { // already there
- // this shouldn't really happen, but is OK
- } else {
- $this->onError( $status, __METHOD__, $params, $rerr, $rcode, $rdesc );
- }
- return $status;
- }
- /**
- * Delete a Swift container
- *
- * @param string $container Container name
- * @param array $params
- * @return StatusValue
- */
- protected function deleteContainer( $container, array $params ) {
- $status = $this->newStatus();
- $auth = $this->getAuthentication();
- if ( !$auth ) {
- $status->fatal( 'backend-fail-connect', $this->name );
- return $status;
- }
- list( $rcode, $rdesc, $rhdrs, $rbody, $rerr ) = $this->http->run( [
- 'method' => 'DELETE',
- 'url' => $this->storageUrl( $auth, $container ),
- 'headers' => $this->authTokenHeaders( $auth )
- ] );
- if ( $rcode >= 200 && $rcode <= 299 ) { // deleted
- $this->containerStatCache->clear( $container ); // purge
- } elseif ( $rcode === 404 ) { // not there
- // this shouldn't really happen, but is OK
- } elseif ( $rcode === 409 ) { // not empty
- $this->onError( $status, __METHOD__, $params, $rerr, $rcode, $rdesc ); // race?
- } else {
- $this->onError( $status, __METHOD__, $params, $rerr, $rcode, $rdesc );
- }
- return $status;
- }
- /**
- * Get a list of objects under a container.
- * Either just the names or a list of stdClass objects with details can be returned.
- *
- * @param string $fullCont
- * @param string $type ('info' for a list of object detail maps, 'names' for names only)
- * @param int $limit
- * @param string|null $after
- * @param string|null $prefix
- * @param string|null $delim
- * @return StatusValue With the list as value
- */
- private function objectListing(
- $fullCont, $type, $limit, $after = null, $prefix = null, $delim = null
- ) {
- $status = $this->newStatus();
- $auth = $this->getAuthentication();
- if ( !$auth ) {
- $status->fatal( 'backend-fail-connect', $this->name );
- return $status;
- }
- $query = [ 'limit' => $limit ];
- if ( $type === 'info' ) {
- $query['format'] = 'json';
- }
- if ( $after !== null ) {
- $query['marker'] = $after;
- }
- if ( $prefix !== null ) {
- $query['prefix'] = $prefix;
- }
- if ( $delim !== null ) {
- $query['delimiter'] = $delim;
- }
- list( $rcode, $rdesc, $rhdrs, $rbody, $rerr ) = $this->http->run( [
- 'method' => 'GET',
- 'url' => $this->storageUrl( $auth, $fullCont ),
- 'query' => $query,
- 'headers' => $this->authTokenHeaders( $auth )
- ] );
- $params = [ 'cont' => $fullCont, 'prefix' => $prefix, 'delim' => $delim ];
- if ( $rcode === 200 ) { // good
- if ( $type === 'info' ) {
- $status->value = FormatJson::decode( trim( $rbody ) );
- } else {
- $status->value = explode( "\n", trim( $rbody ) );
- }
- } elseif ( $rcode === 204 ) {
- $status->value = []; // empty container
- } elseif ( $rcode === 404 ) {
- $status->value = []; // no container
- } else {
- $this->onError( $status, __METHOD__, $params, $rerr, $rcode, $rdesc );
- }
- return $status;
- }
- protected function doPrimeContainerCache( array $containerInfo ) {
- foreach ( $containerInfo as $container => $info ) {
- $this->containerStatCache->setField( $container, 'stat', $info );
- }
- }
- protected function doGetFileStatMulti( array $params ) {
- $stats = [];
- $auth = $this->getAuthentication();
- $reqs = []; // (path => op)
- // (a) Check the containers of the paths...
- foreach ( $params['srcs'] as $path ) {
- list( $srcCont, $srcRel ) = $this->resolveStoragePathReal( $path );
- if ( $srcRel === null || !$auth ) {
- $stats[$path] = self::$RES_ERROR;
- continue; // invalid storage path or auth error
- }
- $cstat = $this->getContainerStat( $srcCont );
- if ( $cstat === self::$RES_ABSENT ) {
- $stats[$path] = self::$RES_ABSENT;
- continue; // ok, nothing to do
- } elseif ( !is_array( $cstat ) ) {
- $stats[$path] = self::$RES_ERROR;
- continue;
- }
- $reqs[$path] = [
- 'method' => 'HEAD',
- 'url' => $this->storageUrl( $auth, $srcCont, $srcRel ),
- 'headers' => $this->authTokenHeaders( $auth ) + $this->headersFromParams( $params )
- ];
- }
- // (b) Check the files themselves...
- $opts = [ 'maxConnsPerHost' => $params['concurrency'] ];
- $reqs = $this->http->runMulti( $reqs, $opts );
- foreach ( $reqs as $path => $op ) {
- list( $rcode, $rdesc, $rhdrs, $rbody, $rerr ) = $op['response'];
- if ( $rcode === 200 || $rcode === 204 ) {
- // Update the object if it is missing some headers
- if ( !empty( $params['requireSHA1'] ) ) {
- $rhdrs = $this->addMissingHashMetadata( $rhdrs, $path );
- }
- // Load the stat array from the headers
- $stat = $this->getStatFromHeaders( $rhdrs );
- if ( $this->isRGW ) {
- $stat['latest'] = true; // strong consistency
- }
- } elseif ( $rcode === 404 ) {
- $stat = self::$RES_ABSENT;
- } else {
- $stat = self::$RES_ERROR;
- $this->onError( null, __METHOD__, $params, $rerr, $rcode, $rdesc );
- }
- $stats[$path] = $stat;
- }
- return $stats;
- }
- /**
- * @param array $rhdrs
- * @return array
- */
- protected function getStatFromHeaders( array $rhdrs ) {
- // Fetch all of the custom metadata headers
- $metadata = $this->getMetadataFromHeaders( $rhdrs );
- // Fetch all of the custom raw HTTP headers
- $headers = $this->extractMutableContentHeaders( $rhdrs );
- return [
- // Convert various random Swift dates to TS_MW
- 'mtime' => $this->convertSwiftDate( $rhdrs['last-modified'], TS_MW ),
- // Empty objects actually return no content-length header in Ceph
- 'size' => isset( $rhdrs['content-length'] ) ? (int)$rhdrs['content-length'] : 0,
- 'sha1' => $metadata['sha1base36'] ?? null,
- // Note: manifiest ETags are not an MD5 of the file
- 'md5' => ctype_xdigit( $rhdrs['etag'] ) ? $rhdrs['etag'] : null,
- 'xattr' => [ 'metadata' => $metadata, 'headers' => $headers ]
- ];
- }
- /**
- * @return array|null Credential map
- */
- protected function getAuthentication() {
- if ( $this->authErrorTimestamp !== null ) {
- if ( ( time() - $this->authErrorTimestamp ) < 60 ) {
- return null; // failed last attempt; don't bother
- } else { // actually retry this time
- $this->authErrorTimestamp = null;
- }
- }
- // Session keys expire after a while, so we renew them periodically
- $reAuth = ( ( time() - $this->authSessionTimestamp ) > $this->authTTL );
- // Authenticate with proxy and get a session key...
- if ( !$this->authCreds || $reAuth ) {
- $this->authSessionTimestamp = 0;
- $cacheKey = $this->getCredsCacheKey( $this->swiftUser );
- $creds = $this->srvCache->get( $cacheKey ); // credentials
- // Try to use the credential cache
- if ( isset( $creds['auth_token'] ) && isset( $creds['storage_url'] ) ) {
- $this->authCreds = $creds;
- // Skew the timestamp for worst case to avoid using stale credentials
- $this->authSessionTimestamp = time() - ceil( $this->authTTL / 2 );
- } else { // cache miss
- list( $rcode, $rdesc, $rhdrs, $rbody, $rerr ) = $this->http->run( [
- 'method' => 'GET',
- 'url' => "{$this->swiftAuthUrl}/v1.0",
- 'headers' => [
- 'x-auth-user' => $this->swiftUser,
- 'x-auth-key' => $this->swiftKey
- ]
- ] );
- if ( $rcode >= 200 && $rcode <= 299 ) { // OK
- $this->authCreds = [
- 'auth_token' => $rhdrs['x-auth-token'],
- 'storage_url' => $this->swiftStorageUrl ?? $rhdrs['x-storage-url']
- ];
- $this->srvCache->set( $cacheKey, $this->authCreds, ceil( $this->authTTL / 2 ) );
- $this->authSessionTimestamp = time();
- } elseif ( $rcode === 401 ) {
- $this->onError( null, __METHOD__, [], "Authentication failed.", $rcode );
- $this->authErrorTimestamp = time();
- return null;
- } else {
- $this->onError( null, __METHOD__, [], "HTTP return code: $rcode", $rcode );
- $this->authErrorTimestamp = time();
- return null;
- }
- }
- // Ceph RGW does not use <account> in URLs (OpenStack Swift uses "/v1/<account>")
- if ( substr( $this->authCreds['storage_url'], -3 ) === '/v1' ) {
- $this->isRGW = true; // take advantage of strong consistency in Ceph
- }
- }
- return $this->authCreds;
- }
- /**
- * @param array $creds From getAuthentication()
- * @param string|null $container
- * @param string|null $object
- * @return string
- */
- protected function storageUrl( array $creds, $container = null, $object = null ) {
- $parts = [ $creds['storage_url'] ];
- if ( strlen( $container ) ) {
- $parts[] = rawurlencode( $container );
- }
- if ( strlen( $object ) ) {
- $parts[] = str_replace( "%2F", "/", rawurlencode( $object ) );
- }
- return implode( '/', $parts );
- }
- /**
- * @param array $creds From getAuthentication()
- * @return array
- */
- protected function authTokenHeaders( array $creds ) {
- return [ 'x-auth-token' => $creds['auth_token'] ];
- }
- /**
- * Get the cache key for a container
- *
- * @param string $username
- * @return string
- */
- private function getCredsCacheKey( $username ) {
- return 'swiftcredentials:' . md5( $username . ':' . $this->swiftAuthUrl );
- }
- /**
- * Log an unexpected exception for this backend.
- * This also sets the StatusValue object to have a fatal error.
- *
- * @param StatusValue|null $status
- * @param string $func
- * @param array $params
- * @param string $err Error string
- * @param int $code HTTP status
- * @param string $desc HTTP StatusValue description
- */
- public function onError( $status, $func, array $params, $err = '', $code = 0, $desc = '' ) {
- if ( $status instanceof StatusValue ) {
- $status->fatal( 'backend-fail-internal', $this->name );
- }
- if ( $code == 401 ) { // possibly a stale token
- $this->srvCache->delete( $this->getCredsCacheKey( $this->swiftUser ) );
- }
- $msg = "HTTP {code} ({desc}) in '{func}' (given '{req_params}')";
- $msgParams = [
- 'code' => $code,
- 'desc' => $desc,
- 'func' => $func,
- 'req_params' => FormatJson::encode( $params ),
- ];
- if ( $err ) {
- $msg .= ': {err}';
- $msgParams['err'] = $err;
- }
- $this->logger->error( $msg, $msgParams );
- }
- }
|