deprecated in 1.25, has been removed.
* (T60993) action=query list=filearchive, list=alldeletedrevisions and
prop=deletedrevisions no longer require the 'deletedhistory' user right.
+* In the response to queries that use 'prop=imageinfo', entries for
+ non-existing files (indicated by the 'filemissing' field) now omit the
+ following fields, since they are meaningless in this context:
+ 'timestamp', 'userhidden', 'user', 'userid', 'anon', 'size', 'width',
+ 'height', 'pagecount', 'duration', 'commenthidden', 'parsedcomment',
+ 'comment', 'thumburl', 'thumbwidth', 'thumbheight', 'thumbmime',
+ 'thumberror', 'url', 'sha1', 'metadata', 'extmetadata', 'commonmetadata',
+ 'mime', 'mediadtype', 'bitdepth'.
+ Clients that process these fields should first check if 'filemissing' is
+ set. Fields that are supported even if the file is missing include:
+ 'canonicaltitle', ''archivename' (deleted files only), 'descriptionurl',
+ 'descriptionshorturl'.
=== Action API internal changes in 1.34 ===
* The exception thrown in ApiModuleManager::getModule has been changed
namespace MediaWiki\Rest\BasicAccess;
-use User;
use MediaWiki\Permissions\PermissionManager;
use MediaWiki\Rest\Handler;
use MediaWiki\Rest\RequestInterface;
+use MediaWiki\User\UserIdentity;
/**
- * A factory for MWBasicRequestAuthorizer which passes through a User object
+ * A factory for MWBasicRequestAuthorizer which passes through a UserIdentity.
*
* @internal
*/
class MWBasicAuthorizer extends BasicAuthorizerBase {
- /** @var User */
+ /** @var UserIdentity */
private $user;
/** @var PermissionManager */
private $permissionManager;
- public function __construct( User $user, PermissionManager $permissionManager ) {
+ public function __construct( UserIdentity $user, PermissionManager $permissionManager ) {
$this->user = $user;
$this->permissionManager = $permissionManager;
}
namespace MediaWiki\Rest\BasicAccess;
-use User;
+use MediaWiki\User\UserIdentity;
use MediaWiki\Permissions\PermissionManager;
use MediaWiki\Rest\Handler;
use MediaWiki\Rest\RequestInterface;
* @internal
*/
class MWBasicRequestAuthorizer extends BasicRequestAuthorizer {
- /** @var User */
+ /** @var UserIdentity */
private $user;
/** @var PermissionManager */
private $permissionManager;
public function __construct( RequestInterface $request, Handler $handler,
- User $user, PermissionManager $permissionManager
+ UserIdentity $user, PermissionManager $permissionManager
) {
parent::__construct( $request, $handler );
$this->user = $user;
$services->getPermissionManager() );
// @phan-suppress-next-line PhanAccessMethodInternal
- $restValidator = new Validator( $objectFactory, $request, RequestContext::getMain()->getUser() );
+ $restValidator = new Validator( $objectFactory,
+ $services->getPermissionManager(),
+ $request,
+ RequestContext::getMain()->getUser()
+ );
global $IP;
$router = new Router(
namespace MediaWiki\Rest\Validator;
use InvalidArgumentException;
+use MediaWiki\Permissions\PermissionManager;
use MediaWiki\Rest\RequestInterface;
+use MediaWiki\User\UserIdentity;
use Psr\Http\Message\UploadedFileInterface;
-use User;
use Wikimedia\ParamValidator\Callbacks;
use Wikimedia\ParamValidator\ValidationException;
class ParamValidatorCallbacks implements Callbacks {
+ /** @var PermissionManager */
+ private $permissionManager;
+
/** @var RequestInterface */
private $request;
- /** @var User */
+ /** @var UserIdentity */
private $user;
- public function __construct( RequestInterface $request, User $user ) {
+ public function __construct(
+ PermissionManager $permissionManager,
+ RequestInterface $request,
+ UserIdentity $user
+ ) {
+ $this->permissionManager = $permissionManager;
$this->request = $request;
$this->user = $user;
}
}
public function useHighLimits( array $options ) {
- return $this->user->isAllowed( 'apihighlimits' );
+ return $this->permissionManager->userHasRight( $this->user, 'apihighlimits' );
}
}
namespace MediaWiki\Rest\Validator;
+use MediaWiki\Permissions\PermissionManager;
use MediaWiki\Rest\Handler;
use MediaWiki\Rest\HttpException;
use MediaWiki\Rest\RequestInterface;
-use User;
+use MediaWiki\User\UserIdentity;
use Wikimedia\ObjectFactory;
use Wikimedia\ParamValidator\ParamValidator;
use Wikimedia\ParamValidator\TypeDef\BooleanDef;
private $paramValidator;
/**
- * @internal
* @param ObjectFactory $objectFactory
+ * @param PermissionManager $permissionManager
* @param RequestInterface $request
- * @param User $user
+ * @param UserIdentity $user
+ * @internal
*/
public function __construct(
- ObjectFactory $objectFactory, RequestInterface $request, User $user
+ ObjectFactory $objectFactory,
+ PermissionManager $permissionManager,
+ RequestInterface $request,
+ UserIdentity $user
) {
$this->paramValidator = new ParamValidator(
- new ParamValidatorCallbacks( $request, $user ),
+ new ParamValidatorCallbacks( $permissionManager, $request, $user ),
$objectFactory,
[
'typeDefs' => self::$typeDefs,
$vals = [
ApiResult::META_TYPE => 'assoc',
];
+
+ // Some information will be unavailable if the file does not exist. T221812
+ $exists = $file->exists();
+
// Timestamp is shown even if the file is revdelete'd in interface
// so do same here.
- if ( isset( $prop['timestamp'] ) ) {
+ if ( isset( $prop['timestamp'] ) && $exists ) {
$vals['timestamp'] = wfTimestamp( TS_ISO_8601, $file->getTimestamp() );
}
$user = isset( $prop['user'] );
$userid = isset( $prop['userid'] );
- if ( $user || $userid ) {
+ if ( ( $user || $userid ) && $exists ) {
if ( $file->isDeleted( File::DELETED_USER ) ) {
$vals['userhidden'] = true;
$anyHidden = true;
// This is shown even if the file is revdelete'd in interface
// so do same here.
- if ( isset( $prop['size'] ) || isset( $prop['dimensions'] ) ) {
+ if ( ( isset( $prop['size'] ) || isset( $prop['dimensions'] ) ) && $exists ) {
$vals['size'] = (int)$file->getSize();
$vals['width'] = (int)$file->getWidth();
$vals['height'] = (int)$file->getHeight();
$pcomment = isset( $prop['parsedcomment'] );
$comment = isset( $prop['comment'] );
- if ( $pcomment || $comment ) {
+ if ( ( $pcomment || $comment ) && $exists ) {
if ( $file->isDeleted( File::DELETED_COMMENT ) ) {
$vals['commenthidden'] = true;
$anyHidden = true;
}
if ( $url ) {
- if ( $file->exists() ) {
+ if ( $exists ) {
if ( !is_null( $thumbParams ) ) {
$mto = $file->transform( $thumbParams );
self::$transformCount++;
}
}
$vals['url'] = wfExpandUrl( $file->getFullUrl(), PROTO_CURRENT );
- } else {
- $vals['filemissing'] = true;
}
$vals['descriptionurl'] = wfExpandUrl( $file->getDescriptionUrl(), PROTO_CURRENT );
}
}
- if ( $sha1 ) {
+ if ( !$exists ) {
+ $vals['filemissing'] = true;
+ }
+
+ if ( $sha1 && $exists ) {
$vals['sha1'] = Wikimedia\base_convert( $file->getSha1(), 36, 16, 40 );
}
- if ( $meta ) {
+ if ( $meta && $exists ) {
Wikimedia\suppressWarnings();
$metadata = unserialize( $file->getMetadata() );
Wikimedia\restoreWarnings();
}
$vals['metadata'] = $metadata ? static::processMetaData( $metadata, $result ) : null;
}
- if ( $commonmeta ) {
+ if ( $commonmeta && $exists ) {
$metaArray = $file->getCommonMetaArray();
$vals['commonmetadata'] = $metaArray ? static::processMetaData( $metaArray, $result ) : [];
}
- if ( $extmetadata ) {
+ if ( $extmetadata && $exists ) {
// Note, this should return an array where all the keys
// start with a letter, and all the values are strings.
// Thus there should be no issue with format=xml.
$vals['extmetadata'] = $extmetaArray;
}
- if ( $mime ) {
+ if ( $mime && $exists ) {
$vals['mime'] = $file->getMimeType();
}
- if ( $mediatype ) {
+ if ( $mediatype && $exists ) {
$vals['mediatype'] = $file->getMediaType();
}
$vals['archivename'] = $file->getArchiveName();
}
- if ( $bitdepth ) {
+ if ( $bitdepth && $exists ) {
$vals['bitdepth'] = $file->getBitDepth();
}
* Get the URL of the image description page. May return false if it is
* unknown or not applicable.
*
- * @return string
+ * @return string|bool
*/
function getDescriptionUrl() {
if ( $this->repo ) {
* This covers fields that are sometimes not cached.
*/
protected function loadExtraFromDB() {
+ if ( !$this->title ) {
+ return; // Avoid hard failure when the file does not exist. T221812
+ }
+
$fname = static::class . '::' . __FUNCTION__;
# Unconditionally set loaded=true, we don't want the accessors constantly rechecking
function getUser( $type = 'text' ) {
$this->load();
- if ( $type === 'object' ) {
- return $this->user;
- } elseif ( $type === 'text' ) {
- return $this->user->getName();
- } elseif ( $type === 'id' ) {
- return $this->user->getId();
+ if ( !$this->user ) {
+ // If the file does not exist, $this->user will be null, see T221812.
+ // Note: 'Unknown user' this is a reserved user name.
+ if ( $type === 'object' ) {
+ return User::newFromName( 'Unknown user', false );
+ } elseif ( $type === 'text' ) {
+ return 'Unknown user';
+ } elseif ( $type === 'id' ) {
+ return 0;
+ }
+ } else {
+ if ( $type === 'object' ) {
+ return $this->user;
+ } elseif ( $type === 'text' ) {
+ return $this->user->getName();
+ } elseif ( $type === 'id' ) {
+ return $this->user->getId();
+ }
}
throw new MWException( "Unknown type '$type'." );
* @since 1.27
*/
public function getDescriptionShortUrl() {
+ if ( !$this->title ) {
+ return null; // Avoid hard failure when the file does not exist. T221812
+ }
+
$pageId = $this->title->getArticleID();
- if ( $pageId !== null ) {
+ if ( $pageId ) {
$url = $this->repo->makeUrl( [ 'curid' => $pageId ] );
if ( $url !== false ) {
return $url;
* @return OldLocalFile[]
*/
function getHistory( $limit = null, $start = null, $end = null, $inc = true ) {
+ if ( !$this->exists() ) {
+ return []; // Avoid hard failure when the file does not exist. T221812
+ }
+
$dbr = $this->repo->getReplicaDB();
$oldFileQuery = OldLocalFile::getQueryInfo();
* 0 return line for current version
* 1 query for old versions, return first one
* 2, ... return next old version from above query
- * @return bool
+ * @return stdClass|bool
*/
public function nextHistoryLine() {
+ if ( !$this->exists() ) {
+ return false; // Avoid hard failure when the file does not exist. T221812
+ }
+
# Polymorphic function name to distinguish foreign and local fetches
$fname = static::class . '::' . __FUNCTION__;
/**
* Get the URL of the file description page.
- * @return string
+ * @return string|bool
*/
function getDescriptionUrl() {
+ if ( !$this->title ) {
+ return false; // Avoid hard failure when the file does not exist. T221812
+ }
+
return $this->title->getLocalURL();
}
* @return string|false
*/
function getDescriptionText( Language $lang = null ) {
+ if ( !$this->title ) {
+ return false; // Avoid hard failure when the file does not exist. T221812
+ }
+
$store = MediaWikiServices::getInstance()->getRevisionStore();
$revision = $store->getRevisionByTitle( $this->title, 0, Revision::READ_NORMAL );
if ( !$revision ) {
* @return bool|string
*/
public function getDescriptionTouched() {
+ if ( !$this->exists() ) {
+ return false; // Avoid hard failure when the file does not exist. T221812
+ }
+
// The DB lookup might return false, e.g. if the file was just deleted, or the shared DB repo
// itself gets it from elsewhere. To avoid repeating the DB lookups in such a case, we
// need to differentiate between null (uninitialized) and false (failed to load).
*/
private function determineKeyClassForStats( $key ) {
$parts = explode( ':', $key, 3 );
-
- return $parts[1] ?? $parts[0]; // sanity
+ // Sanity fallback in case the key was not made by makeKey.
+ // Replace dots because they are special in StatsD (T232907)
+ return strtr( $parts[1] ?? $parts[0], '.', '_' );
}
/**
$conn = Database::factory( $type, $info );
$conn->clearFlag( DBO_TRX ); // auto-commit mode
$this->conns[$shardIndex] = $conn;
+ // Automatically create the objectcache table for sqlite as needed
+ if ( $conn->getType() === 'sqlite' ) {
+ $this->initSqliteDatabase( $conn );
+ }
}
$conn = $this->conns[$shardIndex];
} else {
$attribs = $lb->getServerAttributes( $lb->getWriterIndex() );
$flags = $attribs[Database::ATTR_DB_LEVEL_LOCKING] ? 0 : $lb::CONN_TRX_AUTOCOMMIT;
$conn = $lb->getMaintenanceConnectionRef( $index, [], false, $flags );
- // Automatically create the objectcache table for sqlite as needed
- if ( $conn->getType() === 'sqlite' ) {
- $this->initSqliteDatabase( $conn );
- }
}
$this->logger->debug( sprintf( "Connection %s will be used for SqlBagOStuff", $conn ) );
AdminSettings.php \
.svn \
*/.git/* \
+ */README.md \
{{EXCLUDE_PATTERNS}}
EXCLUDE_SYMBOLS =
EXAMPLE_PATH =
$this->addOption( 'output',
'Path to write doc to',
false, true );
- $this->addOption( 'no-extensions',
- 'Ignore extensions' );
+ $this->addOption( 'extensions',
+ 'Process the extensions/ directory as well (ignored if --file is used)' );
+ $this->addOption( 'skins',
+ 'Process the skins/ directory as well (ignored if --file is used)' );
}
public function getDbType() {
$this->template = $IP . '/maintenance/Doxyfile';
$this->excludes = [
- 'vendor',
- 'node_modules',
- 'resources/lib',
'images',
+ 'node_modules',
+ 'resources',
'static',
'tests',
- 'includes/libs/Message/README.md',
- 'includes/libs/objectcache/README.md',
- 'includes/libs/ParamValidator/README.md',
- 'maintenance/benchmarks/README.md',
- 'resources/src/mediawiki.ui/styleguide.md',
+ 'vendor',
];
$this->excludePatterns = [];
- if ( $this->hasOption( 'no-extensions' ) ) {
- $this->excludePatterns[] = 'extensions';
- $this->excludePatterns[] = 'skins';
+ if ( $this->input === '' ) {
+ // If no explicit --file filter is set, we're indexing all of $IP,
+ // but any extension or skin submodules should be excluded by default.
+ if ( !$this->hasOption( 'extensions' ) ) {
+ $this->excludePatterns[] = 'extensions';
+ }
+ if ( !$this->hasOption( 'skins' ) ) {
+ $this->excludePatterns[] = 'skins';
+ }
}
$this->doDot = shell_exec( 'which dot' );
namespace MediaWiki\Tests\Rest\BasicAccess;
use GuzzleHttp\Psr7\Uri;
-use MediaWiki\MediaWikiServices;
+use MediaWiki\Permissions\PermissionManager;
use MediaWiki\Rest\BasicAccess\MWBasicAuthorizer;
use MediaWiki\Rest\Handler;
use MediaWiki\Rest\RequestData;
class MWBasicRequestAuthorizerTest extends MediaWikiTestCase {
private function createRouter( $userRights, $request ) {
$user = User::newFromName( 'Test user' );
- // Don't allow the rights to everybody so that user rights kick in.
- $this->mergeMwGlobalArrayValue( 'wgGroupPermissions', [ '*' => $userRights ] );
- $this->overrideUserPermissions(
- $user,
- array_keys( array_filter( $userRights ), function ( $value ) {
- return $value === true;
- } )
- );
-
- global $IP;
-
$objectFactory = new ObjectFactory(
$this->getMockForAbstractClass( ContainerInterface::class )
);
+ $permissionManager = $this->createMock( PermissionManager::class );
+ // Don't allow the rights to everybody so that user rights kick in.
+ $permissionManager->method( 'isEveryoneAllowed' )->willReturn( false );
+ $permissionManager->method( 'userHasRight' )
+ ->will( $this->returnCallback( function ( $user, $action ) use ( $userRights ) {
+ return isset( $userRights[$action] ) && $userRights[$action];
+ } ) );
+
+ global $IP;
return new Router(
[ "$IP/tests/phpunit/unit/includes/Rest/testRoutes.json" ],
'/rest',
new \EmptyBagOStuff(),
new ResponseFactory( [] ),
- new MWBasicAuthorizer( $user, MediaWikiServices::getInstance()->getPermissionManager() ),
+ new MWBasicAuthorizer( $user, $permissionManager ),
$objectFactory,
- new Validator( $objectFactory, $request, $user )
+ new Validator( $objectFactory, $permissionManager, $request, $user )
);
}
use EmptyBagOStuff;
use GuzzleHttp\Psr7\Uri;
use GuzzleHttp\Psr7\Stream;
+use MediaWiki\Permissions\PermissionManager;
use MediaWiki\Rest\BasicAccess\StaticBasicAuthorizer;
use MediaWiki\Rest\Handler;
use MediaWiki\Rest\EntryPoint;
$objectFactory = new ObjectFactory(
$this->getMockForAbstractClass( ContainerInterface::class )
);
+ $permissionManager = $this->createMock( PermissionManager::class );
return new Router(
[ "$IP/tests/phpunit/unit/includes/Rest/testRoutes.json" ],
new ResponseFactory( [] ),
new StaticBasicAuthorizer(),
$objectFactory,
- new Validator( $objectFactory, $request, new User )
+ new Validator( $objectFactory, $permissionManager, $request, new User )
);
}
'wfLocalFile() returns LocalFile for valid Titles'
);
}
+
+ /**
+ * @covers File::getUser
+ */
+ public function testGetUserForNonExistingFile() {
+ $this->assertSame( 'Unknown user', $this->file_hl0->getUser() );
+ $this->assertSame( 0, $this->file_hl0->getUser( 'id' ) );
+ }
+
+ /**
+ * @covers File::getUser
+ */
+ public function testDescriptionShortUrlForNonExistingFile() {
+ $this->assertNull( $this->file_hl0->getDescriptionShortUrl() );
+ }
+
+ /**
+ * @covers File::getUser
+ */
+ public function testDescriptionTextForNonExistingFile() {
+ $this->assertFalse( $this->file_hl0->getDescriptionText() );
+ }
}
[ 'domain:page:5', 'page' ],
[ 'domain:main-key', 'main-key' ],
[ 'domain:page:history', 'page' ],
+ // Regression test for T232907
+ [ 'domain:foo-bar-1.2:abc:v2', 'foo-bar-1_2' ],
[ 'missingdomainkey', 'missingdomainkey' ]
];
}
use EmptyBagOStuff;
use GuzzleHttp\Psr7\Uri;
+use MediaWiki\Permissions\PermissionManager;
use MediaWiki\Rest\BasicAccess\StaticBasicAuthorizer;
use MediaWiki\Rest\RequestData;
use MediaWiki\Rest\ResponseFactory;
$objectFactory = new ObjectFactory(
$this->getMockForAbstractClass( ContainerInterface::class )
);
-
+ $permissionManager = $this->createMock( PermissionManager::class );
$request = new RequestData( $requestInfo );
$router = new Router(
[ __DIR__ . '/../testRoutes.json' ],
new ResponseFactory( [] ),
new StaticBasicAuthorizer(),
$objectFactory,
- new Validator( $objectFactory, $request, new User )
+ new Validator( $objectFactory, $permissionManager, $request, new User )
);
$response = $router->execute( $request );
if ( isset( $responseInfo['statusCode'] ) ) {
namespace MediaWiki\Tests\Rest;
use GuzzleHttp\Psr7\Uri;
+use MediaWiki\Permissions\PermissionManager;
use MediaWiki\Rest\BasicAccess\StaticBasicAuthorizer;
use MediaWiki\Rest\Handler;
use MediaWiki\Rest\HttpException;
$objectFactory = new ObjectFactory(
$this->getMockForAbstractClass( ContainerInterface::class )
);
+ $permissionManager = $this->createMock( PermissionManager::class );
return new Router(
[ __DIR__ . '/testRoutes.json' ],
[],
new ResponseFactory( [] ),
new StaticBasicAuthorizer( $authError ),
$objectFactory,
- new Validator( $objectFactory, $request, new User )
+ new Validator( $objectFactory, $permissionManager, $request, new User )
);
}
dépôts / lhc / web / wiklou.git / commitdiff