wiki.techinc.nl/RELEASE-NOTES-1.37

619 lines
29 KiB
Text
Raw Normal View History

= MediaWiki 1.37 =
== MediaWiki 1.37.0-PRERELEASE ==
THIS IS NOT A RELEASE YET
MediaWiki 1.37 is an alpha-quality development branch, and is not recommended
for use in production.
== Upgrading notes for 1.37 ==
Don't forget to always back up your database before upgrading!
See the file UPGRADE for more detailed per-version upgrade instructions from the
oldest supported upgrading version, MediaWiki 1.27.
Some specific notes for MediaWiki 1.37 upgrades are below:
* …
For notes on 1.36.x and older releases, see HISTORY.
=== Configuration changes for system administrators in 1.37 ===
* …
==== New configuration ====
* …
==== Changed configuration ====
* $wgContentHandlerTextFallback - This setting, which defines how to
react if a plain text version of a non-text Content object is
requested using ContentHandler::getContentText(), is deprecated.
* $wgShellboxUrl is deprecated, use $wgShellboxUrls as a mapping of
service => URL instead.
* …
==== Removed configuration ====
* $wgLegacyJavaScriptGlobals, deprecated in 1.36.
* $wgShowDBErrorBacktrace, deprecated and non-functional since 1.32.
* $wgShowSQLErrors, deprecated and non-functional since 1.32.
=== New user-facing features in 1.37 ===
* (T161934) MediaWiki now supports JPEG2000 files, to a limited extent.
* Media files uploaded server side using the importImages.php maintenance
script now have the "mw-server-side-upload" change tag.
* …
=== New developer features in 1.37 ===
* …
=== External library changes in 1.37 ===
* …
==== New external libraries ====
* Added whatwg-fetch 3.6.2.
* Added wikimedia/normalized-exception 1.0.1.
* …
===== New development-only external libraries =====
* …
==== Changed external libraries ====
* Updated OOjs from v5.0.0 to v6.0.0
* Updated WVUI from v0.1.0 to v0.2.0
* Updated psr/container from v1.0.0 to v1.1.1.
* Updated wikimedia/minify from v2.2.2 to v2.2.3.
* Updated wikimedia/object-factory from v3.0.0 to v3.0.2.
* Updated wikimedia/parsoid from v0.13.0-a20 to v0.14.0-a1.
* …
===== Changed development-only external libraries =====
* …
==== Removed external libraries ====
* The pimple/pimple development-only library has been removed.
* …
=== Bug fixes in 1.37 ===
* …
=== Action API changes in 1.37 ===
* …
=== Action API internal changes in 1.37 ===
* …
=== Languages updated in 1.37 ===
MediaWiki supports over 350 languages. Many localisations are updated regularly.
Below only new and removed languages are listed, as well as changes to languages
because of Phabricator reports.
* (T280435) LRM and RLM characters were removed from names of languages with
parentheses in Names.php
* (T283422) Add namespace name translations and change the autonym of
the Kinyarwanda language to "Ikinyarwanda".
* (T283423) Change the autonym of the Lombard language from "lumbaart"
to "lombard".
* (T279619) Added language support for Dagbani (dag).
* (T282085) Added language support for Malay in Arabic (Jawi) script (ms-arab).
* (T283053) Added language support for Ojibwe (ojb).
* (T283480) Added language support for Wallisian (wls, Fakaʻuvea).
* (T284002) Added language support for Paiwan (pwn).
* (T284044) Added language support for Carpathian Romani (rmc).
* (T286460) Added language support for Gun (guw, Gungbe).
=== Breaking changes in 1.37 ===
* The Revision class, hard deprecated in 1.35, was removed entirely. As
part of this, the following hooks that included a Revision object
were removed:
- ArticleRevisionUndeleted - use RevisionUndeleted
- ArticleRollbackComplete - use RollbackComplete
- DiffRevisionTools - use DiffTools
- DiffViewHeader - use DifferenceEngineViewHeader
- HistoryRevisionTools - use HistoryTools
- NewRevisionFromEditComplete - use RevisionFromEditComplete
- PageContentInsertComplete - use PageSaveComplete
- PageContentSaveComplete - use PageSaveComplete
- ParserFetchTemplate - use BeforeParserFetchTemplateRevisionRecord
- RevisionInsertComplete - use RevisionRecordInserted
- TitleMoveComplete - use PageMoveComplete
- TitleMoveCompleting - use PageMoveCompleting
- UndeleteShowRevision - no replacement
- UserRetrieveNewTalks - no replacement
and the following methods and variables have been removed
- Article::$mRevision
- Article::getRevisionFetched()
- ContribsPager::tryToCreateValidRevision()
- EditPage::$mBaseRevision
- EditPage::getBaseRevision()
- LinksUpdate::getRevision()
- LinksUpdate::setRevision()
- PageArchive::getArchivedRevision()
- PageArchive::getPreviousRevision()
- PageArchive::getRevision()
- Parser::$mRevisionObject
- Parser::fetchCurrentRevisionOfTitle()
- Parser::getRevisionObject()
- Parser::statelessFetchRevision()
- ParserOptions::getCurrentRevisionCallback()
- ParserOptions::setCurrentRevisionCallback()
- Title::countAuthorsBetween()
- Title::getFirstRevision()
- User::getNewMessageLinks()
- User::getNewMessageRevisionId()
- User::setNewtalk()
- WikiPage::getOldestRevision()
- WikiPage::getRevision()
- WikiPage::getUndoContent()
- WikiPage::updateIfNewerOn()
and the following methods no longer accept Revision objects as parameters:
- CategoryMembershipChange::__construct()
- ContentHandler::getUndoContent()
- DerivedPageDataUpdater::prepareUpdate()
- DifferenceEngine::getRevisionHeader()
- Linker::buildRollbackLink()
- Linker::generateRollback()
- Linker::getRevDeleteLink()
- Linker::getRollbackEditCount()
- Linker::revComment()
- Linker::revUserLink()
- Linker::revUserTools()
- WikiPage::doDeleteUpdates()
- WikiPage::doEditUpdates()
- WikiPage::hasDifferencesOutsideMainSlot()
- WikiPage::onArticleEdit()
- WikiPage::prepareContentForEdit()
- WikiPage::updateRevisionOn()
The following methods return arrays that formerly included a 'revision'
key that would emit deprecation warnings when accessed and return a
Revision object. The Revision object has been removed from the arrays,
and the 'revision-record' key should be used to get the relevant
RevisionRecord instead:
- PageUpdater::doCreate()
- PageUpdater::doModify()
- Parser::statelessFetchTemplate()
- WikiPage::doEditContent()
The ParserOptions `templateCallback` option is a callback that is called
in Parser::fetchTemplateAndTitle() and should return an array - the
'revision' key to that array used to be a Revision object and was used if
no 'revision-record' was returned - it is now ignored.
* Previously, the classes RevisionTestModifyableContent and
RevisionTestModifyableContentHandler were loaded for use in tests, but
were only used within the tests for the since-removed Revision class. This
content and content handler class were removed without deprecation.
* WANObjectCache::HOLDOFF_NONE, deprecated since 1.35, was removed.
Use HOLDOFF_TTL_NONE instead.
* LocalFile::recordUpload2(), deprecated since 1.35, was removed.
* The following methods and fields in the Language class, deprecated since
1.35, have been removed:
- classFromCode()
- clearCaches()
- convertTitle()
- findVariantLink()
- mConverter
- updateConversionTable()
* The following methods in the Parser class have been removed after having
been deprecated in 1.35:
- fetchTemplate()
- Title()
* (T273354) When an edit is prevented by an 'EditFilterMergedContent' hook
handler without changing the status, the edit form will now be displayed.
* User::clearNotification() which had been deprecated in 1.35 has been removed.
Use WatchlistManager::clearTitleUserNotification() instead.
* User::getNewtalk() which had been deprecated in 1.35 has been removed. Use
TalkPageNotificationManager::userHasNewMessages() instead.
* Autopromote class, deprecated since 1.35, was removed. Use
UserGroupManager instead.
* The following classes, hard-deprecated since 1.36, have been removed:
CachedAction, SpecialCachedPage, CacheHelper, ICacheHelper.
* The hooks BeforeHttpsRedirect, CanIPUseHTTPS and UserRequiresHTTPS, deprecated
in 1.35, were removed.
* The TitleArrayFromResult hook, deprecated in 1.36, was removed.
* The deprecated "es6-promise" alias ResourceLoader module has been removed. Use
"es6-polyfills" directly intead.
* The deprecated "mediawiki.legacy.protect" ResourceLoader module, deprecated
since 1.36, has been removed. Use "mediawiki.action.protect" instead.
* AuthenticationProvider interface doesn't extend LoggerAwareInterface.
So AuthenticationProvider can't be typehinted as LoggerAwareInterface.
* User::getGrantName(), hard deprecated since 1.36, has been removed.
Use MWGrants::grantName instead.
* SessionProvider class doesn't extend LoggerAwareInterface.
So SessionProvider can't be typehinted as LoggerAwareInterface.
* The following ApiBase methods, deprecated since 1.35, have been removed:
- ApiBase::explodeMultiValue
- ApiBase::parseMultiValue
- ApiBase::validateLimit
- ApiBase::validateTimestamp
* User::idCacheByName public static field was removed without deprecation.
instead of using it, get a UserIdentity by name from UserIdentityLookup.
* IDatabase::upsert() and IDatabase::replace() only accept a single unique key.
Previously, a warning was issued if there were multiple unique keys provided.
* The MediaWiki:Autoblock_whitelist block exemption control was moved in 1.36 to
MediaWiki:Block-autoblock-exemptionlist. The backward-compatibility of reading
the old MediaWiki:Autoblock_whitelist page has now been dropped.
* The following overridable methods in File hierarchy has changed signatures:
- File::deleteFile - now accepts UserIdentity instead of User
- File::getDescription - now accepts Authority instead of User
- File::userCan - now accepts Authority instead of User
- LocalFile::deleteOldFile - now accepts UserIdentity instead of User
* The following global methods, each deprecated since 1.36, have been removed:
- wfAppendToArrayIfNotDefault
- wfAcceptToPrefs
- wfConfiguredReadOnlyReason
- wfDebugMem
- wfGetPrecompiledData
- wfNegotiateType
* The following deprecated methods of Title class have been removed:
- nameOf, deprecated in 1.36
- getPreviousRevisionID, deprecated in 1.34
- getNextRevisionID, deprecated in 1.34
- getEarliestRevTime, deprecated in 1.35
* UploadBase::stashFile, deprecated since 1.28, was removed.
* wfGetRusage(), deprecated since 1.35, has been removed.
* The following CLI options were removed from tests/phpunit.php:
- use-filebackend
- use-jobqueue
- use-bagostuff
The following options (inherited from Maintenance) were also removed:
- conf
- dbuser
- dbpass
- dbdefaultgroup
- globals
- memory-limit
- profiler
- server
The following options were changed to environment variables:
- wiki => PHPUNIT_WIKI
- use-normal-tables => PHPUNIT_USE_NORMAL_TABLES
- use-filebackend => PHPUNIT_USE_FILEBACKEND
- use-bagostuff => PHPUNIT_USE_BAGOSTUFF
- use-jobqueue => PHPUNIT_USE_JOBQUEUE
This is so that we can use the default PHPUnit entry point (T90875).
* The PHPUNIT_REUSE_DB / --reuse-db option was removed from the phpunit.php
runner. It had been broken for at least three years already. The original use
case was speeding up tests on Oracle, but Oracle support was dropped several
releases ago.
* EntryPoint::getTextFormatters() was made private without a deprecation period;
it had no known external callers.
* DatabaseBlock::chooseBlock, deprecated since 1.35, was removed.
* SpecialPageFactory::getRestrictedPages, deprecated since 1.36, was removed.
* SpecialBlock::validateTarget, deprecated since 1.36, was removed.
* The PatchFileLocation trait was removed without deprecation.
* ActorMigrationBase::getExistingActorId and ::getNewActorId, hard deprecated
since 1.36, were removed.
* Hook handlers implementing MediaWikiServicesHook are prohibited from having
services injected. This is because by definition, this hook runs before the
service container is fully initialized.
Use the unserialized form of image metadata internally Image metadata is usually a serialized string representing an array. Passing the string around internally and having everything unserialize it is an awkward convention. Also, many image handlers were reading the file twice: once for getMetadata() and again for getImageSize(). Often getMetadata() would actually read the width and height and then throw it away. So, in filerepo: * Add File::getMetadataItem(), which promises to allow partial loading of metadata per my proposal on T275268 in a future commit. * Add File::getMetadataArray(), which returns the unserialized array. Some file handlers were returning non-serializable strings from getMetadata(), so I gave them a legacy array form ['_error' => ...] * Changed MWFileProps to return the array form of metadata. * Deprecate the weird File::getImageSize(). It was apparently not called by anything, but was overridden by UnregisteredLocalFile. * Wrap serialize/unserialize with File::getMetadataForDb() and File::loadMetadataFromDb() in preparation for T275268. In MediaHandler: * Merged MediaHandler::getImageSize() and MediaHandler::getMetadata() into getSizeAndMetadata(). Deprecated the old methods. * Instead of isMetadataValid() we now have isFileMetadataValid(), which only gets a File object, so it can decide what data it needs to load. * Simplified getPageDimensions() by having it return false for non-paged media. It was not called in that case, but was implemented anyway. In specific handlers: * Rename DjVuHandler::getUnserializedMetadata() and extractTreesFromMetadata() for clarity. "Metadata" in these function names meant an XML string. * Updated DjVuImage::getImageSize() to provide image sizes in the new style. * In ExifBitmapHandler, getRotationForExif() now takes just the Orientation tag, rather than a serialized string. Also renamed for clarity. * In GIFMetadataExtractor, return the width, height and bits per channel instead of throwing them away. There was some conflation in decodeBPP() which I picked apart. Refer to GIF89a section 18. * In JpegMetadataExtractor, process the SOF0/SOF2 segment to extract bits per channel, width, height and components (channel count). This is essentially a port of PHP's getimagesize(), so should be bugwards compatible. * In PNGMetadataExtractor, return the width and height, which were previously assigned to unused local variables. I verified the implementation by referring to the specification. * In SvgHandler, retain the version validation from unpackMetadata(), but rename the function since it now takes an array as input. In tests: * In ExifBitmapTest, refactored some tests by using a provider. * In GIFHandlerTest and PNGHandlerTest, I removed the tests in which getMetadata() returns null, since it doesn't make sense when ported to getMetadataArray(). I added tests for empty arrays instead. * In tests, I retained serialization of input data since I figure it's useful to confirm that existing database rows will continue to be read correctly. I removed serialization of expected values, replacing them with plain data. * In tests, I replaced access to private class constants like BROKEN_FILE with string literals, since stability is essential. If the class constant changes, the test should fail. Elsewhere: * In maintenance/refreshImageMetadata.php, I removed the check for shrinking image metadata, since it's not easy to implement and is not future compatible. Image metadata is expected to shrink in future. Bug: T275268 Change-Id: I039785d5b6439d71dcc21dcb972177dba5c3a67d
2021-05-19 00:24:32 +00:00
* The protected property LocalFile::$metadata was removed without deprecation.
* WatchedItem::getUser, hard deprecated since 1.36, has been removed.
* AuthManager::singleton, hard deprecated since 1.36, has been removed.
* The AugmentPageProps class was removed without deprecation. It had no known
uses.
* Html::infobox, deprecated since 1.36, was removed.
* ParserOptions::__construct() now requires that the first parameter is a
UserIdentity object - passing `null` used to fallback to the global
$wgUser but was deprecated since 1.36.
* ParserOptions::newCanonical() no longer supports the first parameter being
null (or omitted entirely), which would fallback to the global $wgUser but
was deprecated since 1.35.
* The SkinTemplatePreventOtherActiveTabs hook, deprecated in 1.35, was removed
entirely.
* The SkinTemplateTabAction hook, deprecated in 1.35, was removed entirely.
* The SkinTemplateBuildNavUrlsNav_urlsAfterPermalink hook, deprecated in 1.35,
was removed entirely.
* The following methods of RevisionStore class, formerly hard deprecated,
were removed:
- ::newMutableRevisionFromArray,
- ::loadRevisionFromPageId,
- ::loadRevisionFromTitle,
- ::loadRevisionFromTimestamp,
- ::listRevisionSizes
* LogEntry::getPerformer, deprecated since 1.36, was removed along with methods
in subclasses: DatabaseLogEntry, ManualLogEntry, RCDatabaseLogEntry.
* Skin::getRelevantUser now returns an instance of UserIdentity, not necessarily
a User object. There is no known usages in MediaWiki ecosystem that were not
satisfied with UserIdentity.
* Direct construction of MergeHistory class, deprecated since 1.35, is no longer
supported. Use MergeHistoryFactory instead. MergeHistory::checkPermissions,
deprecated since 1.36, was removed.
* Skin::generateDebugHTML(), deprecated since 1.35, was removed. Call
MWDebug::getHTMLDebugLog() directly.
* The ApiTestCase class no longer interacts with the global $wgUser.
Previously, the global variable was set at the start of each test, and in
ApiTestCase::doApiRequest() if a performer was specified $wgUser was
updated to match, and if no performer was specified $wgUser was used
instead. Now, $wgUser is not updated, and if no performer is specified
the reusable TestUser object for the sysop is relied on. Extensions
or skins that rely on the global $wgUser variable (which has been
deprecated since 1.35) should instead retrieve the acting user from the
relevant context source.
* SkinTemplate::makeArticleUrlDetails, deprecated since 1.35, was removed.
* Skin::makeNSUrl, deprecated since 1.35, was removed.
* Skin::getRevisionId(), deprecated since 1.34, was removed. Use
OutputPage::getRevisionId() instead.
* Skin::isRevisionCurrent(), deprecated since 1.34, was removed. Use
OutputPage::isRevisionCurrent() instead.
* AbstractBlock::parseTarget(), deprecated since 1.36, was removed.
* ArticleEditUpdates hook, deprecated since 1.35, was removed.
* @stable to extend class CentralIdLookup has following changes:
- Protected ::checkAudience method now returns Authority instead of User.
- A number of it's @stable to override methods now accept Authority instead
of User as $audience parameter.
- A number of methods now accept UserIdentity instead of User parameter.
- ::localUserFromCentralId method now returns UserIdentity and not necessarily
a User object.
All extensions that extend this class or use this method were updated to be
ready to the new behavior.
DBMS-specific ResultWrapper subclasses Cleanup after the switch of Database::query() to return ResultWrapper instead of resource. * Soft-deprecate the IResultWrapper accessors in IDatabase. * Move relevant DBMS-specific functionality to ResultWrapper subclasses. The deprecated methods in IResultWrapper become short and simple. ResultWrapper is now abstract (b/c break). * Move the implementation of fieldName(), numFields() and one of the fieldInfo() implementations to the ResultWrapper subclass in order to avoid ResultWrapper::unwrap() calls. * Make Database::doQuery() return a ResultWrapper subclass instead of underlying result data, so that the Database parent class does not need to be aware of wrapper construction. * Hard-deprecate ResultWrapper::unwrap(), DatabaseMysqlBase::fieldType(), DatabasePostgres::fieldType(). * Fix the inefficient seeking method in SQLite. * Make FakeResultWrapper extend ResultWrapper with an implementation similar to the SQLite one. This is possible because ResultWrapper does not depend on IDatabase anymore. * Resolve fixme in DatabasePostgres: from studying the source, neither pg_fetch_object() nor pg_num_rows() can set an error retrievable with pg_last_error(). Removed unnecessary warning suppression. * ResultWrapperTest didn't make sense as a unit test anymore, so I adapted it as an integration test against the current DBMS. This change also means that ResultWrapper::key() always gives the correct offset, even if Iterator methods are not being used. Bug: T286694 Change-Id: I935835316c0bd7d3d061bd8fde9c9ce99ce756ec
2021-07-15 00:46:59 +00:00
* ResultWrapper is now abstract. It cannot be directly constructed (T286694).
* The SecondaryDataUpdates hook, deprecated in 1.32, was removed entirely.
* Content::getDeletionUpdates(), was removed. Use
ContentHandler::getDeletionUpdates() instead.
* …
=== Deprecations in 1.37 ===
* JobQueue::getWiki, deprecated in 1.33, now emits deprecation warnings.
* In AbstractBlock, the getTargetAndType() and getTarget() methods are
hard deprecated. Instead use getTargetName() and getTargetUserIdentity()
together with getType().
* Deprecated passing UserIdentity to
WatchlistManager::clearAllUserNotifications() and
WatchlistManager::clearTitleUserNotifications(). Pass Authority instead.
* Deprecated passing LinkTarget to
WatchlistManager::clearTitleUserNotifications() and
WatchlistManager::getTitleNotificationTimestamp(). Pass PageIdentity instead.
* Deprecated User::isWatched(), User::isTempWatched(), User::addWatch(), and
User::removeWatch(). Use corresponding methods in WatchlistManager instead.
* Deprecated WatchAction::doWatchOrUnwatch(). Use WatchlistManager::setWatch()
instead.
* Deprecated WatchAction::doWatch() and WatchAction::doUnwatch(). Use
WatchlistManager::addWatch() or WatchlistManager::removeWatch(), instead.
* WatchAction::getWatchToken is hard deprecated. Instead use
CsrfTokenSet::getToken
* The getTitle() and setTitle() methods in Parser have been deprecated.
Use getPage() and setPage() instead.
* Title::isWatchable() has been deprecated. Use WatchlistManager::isWatchable()
instead.
* The 'getMasterDB()' methods for LocalRepo (and so ForeignDBRepo), JobQueueDB,
ForeignDBViaLBRepo, and DBFileJournal have been deprecated in favour of a new
method, getPrimaryDB().
* wfIncrStats(), deprecated in 1.36, now emits deprecation warnings.
* wfCanIPUseHTTPS() is now deprecated, and always returns true.
* The UserLoadFromDatabase hook has been deprecated. It had no known uses.
* AbstractAuthenticationProvider ::setLogger(), ::setManager(), ::setConfig(),
::setHookContainer() were soft deprecated. Use ::init() to inject
dependencies or override ::postInitSetup() to do any custom
post-initialization configuration.
* The following methods in ApiPageSet have been deprecated:
- getTitles(), use getTargets() instead.
- getGoodTitles(), use getGoodPages() instead.
- getMissingTitles(), use getMissingPages() instead.
- getGoodAndMissingTitles(), use getGoodAndMissingPages() instead.
- getRedirectTitles(), use getRedirectTargets() instead.
- getSpecialTitles(), use getSpecialPages() instead.
* The following functions from the User class, deprecated in 1.35, now emit
deprecation warnings:
- getOptions
- isIP
- isUsableName
- isCreatableName
- getCanonicalName
* The following methods in User were deprecated:
- ::idFromName - use UserIdentityLookup::getUserIdentityByName instead.
- ::resetIdByNameCache - in tests, reset service container. No replacement
needed in production code.
* Use of ActorMigration for any table except revision, deprecated in 1.34, now
emits deprecation warnings. Instead of getInsertValues(), use
ActorNormalization::acquireActorId(). Instead of getWhere() and getJoin(),
do your own join on the actor table.
* DatabasePostgres::remappedTableName() and its dependent constructor parameter
'keywordTableMap' are deprecated. Reserved identifiers that are used as table
names should be quoted where necessary.
* LinkCache::singleton(), deprecated since 1.28, now emits deprecation warnings.
* MessageCache::singleton(), deprecated since 1.34, now emits deprecation
warnings.
* LockManagerGroup::singleton() and ::destroySingletons(), deprecated since
1.34, now emit deprecation warnings.
* HtmlFileCacheUpdate::newFromTitles() is now deprecated and emitting warnings.
Use newFromPages() instead.
* SessionProvider ::setLogger(), ::setManager(), ::setConfig(),
::setHookContainer() were soft deprecated. Use ::init() to inject
dependencies or override ::postInitSetup() to do any custom
post-initialization configuration.
* User->isLoggedIn(), deprecated since 1.36, now emits deprecation warnings. Use
the method it wraps, User->isRegistered(), instead.
* FileBackendGroup::singleton() and ::destroySingletons(), deprecated since
1.35, now emit deprecation warnings.
* The first parameter of User::getBlock should now be an integer using the
Authority::FOR_XXX constants. Providing a boolean is deprecated.
* ApiBase::addBlockInfoToStatus() is deprecated for use by extensions. It is now
marked as @internal and may be deleted in the future.
It should not be necessary to call this method, Authority should be providing
all relevant information via a PermissionStatus object.
* JobQueueGroup::singleton was deprecated - use
MediaWikiServices::getJobQueueGroup instead.
* JobQueueGroup::destroySingletons was deprecated. JobQueueGroups are now
automatically destroyed after tests.
* SessionProvider ::setLogger(), ::setManager(), ::setConfig(),
::setHookContainer() were hard deprecated. Use ::init() to inject
dependencies or override ::postInitSetup() to do any custom
post-initialization configuration.
* ContentHandler::getContentText() is now soft deprecated.
Use Content::getText() instead.
* MediaWiki\User\UserNamePrefixSearch::search() previously accepted as
its first parameter either the string 'public' or a UserIdentity object,
to filter results for. It now expects an Authority object instead of
UserIdentity, and providing just a UserIdentity is hard deprecated.
* wfLocalFile(), deprecated since 1.34, now emits deprecation warnings.
* wfFindFile(), deprecated since 1.34, now emits deprecation warnings.
* User::getRights(), deprecated since 1.34, now emits deprecation warnings.
* User::changeableGroups and ::changeableByGroup were hard deprecated, use
corresponding methods in UserGroupManager instead.
* User::incEditCount() was deprecated in favor of the new method
UserEditTracker::incrementUserEditCount().
* RepoGroup::singleton(), ::destroySingleton() and ::setSingleton(),
deprecated since 1.34, now emit deprecation warnings.
* AbstractAuthenticationProvider ::setLogger(), ::setManager(), ::setConfig(),
::setHookContainer() were hard deprecated. Use ::init() to inject
dependencies or override ::postInitSetup() to do any custom
post-initialization configuration.
* RecentChange::getPerformer(), hard-deprecated since 1.37,
use getPerformerIdentity() instead.
* ContentHandler::cleanupHandlersCache(), deprecated since 1.35, now emits
deprecation warnings.
* File::getUser method was hard deprecated, along with overrides in LocalFile
and ForeignApiFile in favor of ::getUploader.
* SpecialBlock::checkUnblockSelf(), deprecated in 1.36, now emits deprecation
warnings.
* (T284179) The mediawiki.viewport ResourceLoader module is deprecated. You can
now just use MutationObserver or InterSectionObserver directly, which are
widely available in all supported JavaScript browsers.
* The following constructor options of DatabaseBlock class,
hard deprecated since 1.37:
- 'byText' property with blocker's name,
use 'by' property with UserIdentity value instead.
- 'by' property with blocker's ID,
use 'by' property with UserIdentity value instead.
* The BeforeResetNotificationTimestamp hook was deprecated.
* ArchivedFile::getUser, ::getRawUser, ::getRawUserText were deprecated in
favor of ::getUploader. ::getRawDescription was deprecated in favor of
::getDescription with RAW audience parameter.
* When calling LocalFile::newFromRow() or LocalFile::loadFromRow(), passing
extra fields not requested by ::getQueryInfo() is hard deprecated. This is
to warn callers that deprefixing and automatic assignment of such fields will
not be done in a future version.
* JobSpecification::getTitle was deprecated without providing a replacement.
It wasn't used and job given the purpose of JobSpecification class it's
not needed.
Use the unserialized form of image metadata internally Image metadata is usually a serialized string representing an array. Passing the string around internally and having everything unserialize it is an awkward convention. Also, many image handlers were reading the file twice: once for getMetadata() and again for getImageSize(). Often getMetadata() would actually read the width and height and then throw it away. So, in filerepo: * Add File::getMetadataItem(), which promises to allow partial loading of metadata per my proposal on T275268 in a future commit. * Add File::getMetadataArray(), which returns the unserialized array. Some file handlers were returning non-serializable strings from getMetadata(), so I gave them a legacy array form ['_error' => ...] * Changed MWFileProps to return the array form of metadata. * Deprecate the weird File::getImageSize(). It was apparently not called by anything, but was overridden by UnregisteredLocalFile. * Wrap serialize/unserialize with File::getMetadataForDb() and File::loadMetadataFromDb() in preparation for T275268. In MediaHandler: * Merged MediaHandler::getImageSize() and MediaHandler::getMetadata() into getSizeAndMetadata(). Deprecated the old methods. * Instead of isMetadataValid() we now have isFileMetadataValid(), which only gets a File object, so it can decide what data it needs to load. * Simplified getPageDimensions() by having it return false for non-paged media. It was not called in that case, but was implemented anyway. In specific handlers: * Rename DjVuHandler::getUnserializedMetadata() and extractTreesFromMetadata() for clarity. "Metadata" in these function names meant an XML string. * Updated DjVuImage::getImageSize() to provide image sizes in the new style. * In ExifBitmapHandler, getRotationForExif() now takes just the Orientation tag, rather than a serialized string. Also renamed for clarity. * In GIFMetadataExtractor, return the width, height and bits per channel instead of throwing them away. There was some conflation in decodeBPP() which I picked apart. Refer to GIF89a section 18. * In JpegMetadataExtractor, process the SOF0/SOF2 segment to extract bits per channel, width, height and components (channel count). This is essentially a port of PHP's getimagesize(), so should be bugwards compatible. * In PNGMetadataExtractor, return the width and height, which were previously assigned to unused local variables. I verified the implementation by referring to the specification. * In SvgHandler, retain the version validation from unpackMetadata(), but rename the function since it now takes an array as input. In tests: * In ExifBitmapTest, refactored some tests by using a provider. * In GIFHandlerTest and PNGHandlerTest, I removed the tests in which getMetadata() returns null, since it doesn't make sense when ported to getMetadataArray(). I added tests for empty arrays instead. * In tests, I retained serialization of input data since I figure it's useful to confirm that existing database rows will continue to be read correctly. I removed serialization of expected values, replacing them with plain data. * In tests, I replaced access to private class constants like BROKEN_FILE with string literals, since stability is essential. If the class constant changes, the test should fail. Elsewhere: * In maintenance/refreshImageMetadata.php, I removed the check for shrinking image metadata, since it's not easy to implement and is not future compatible. Image metadata is expected to shrink in future. Bug: T275268 Change-Id: I039785d5b6439d71dcc21dcb972177dba5c3a67d
2021-05-19 00:24:32 +00:00
* The protected method File::getImageSize() is deprecated.
* MediaHandler::getImageSize(), ::getMetadata() and ::isMetadataValid were
deprecated and should no longer be overridden. Instead, subclasses should
override getSizeAndMetadata().
* Deprecated File::getMetadata(). Instead use ::getMetadataArray(),
::getMetadataItem() and ::getMetadataItems().
* Message::title was deprecated, use Message::page instead.
* BaseTemplate::getAfterPortlet, BaseTemplate::renderAfterPortlet and the
BaseTemplateAfterPortlet hook, which were deprecated in 1.35,
now emit deprecation warnings.
* LocalFile::getHistory hook is deprecated.
* Calling WikiPage::prepareContentForEdit() without a UserIdentity is now
deprecated.
* User::getEditTokenObject, ::getEditToken, ::matchEditToken were deprecated.
Use CsrfTokenRepository, which is available via IContextSource, instead.
::matchEditTokenNoSuffix was deprecated without replacement.
It was introduced to be able to provide custom error message if the token
was submitted, but ending slashes were stripped by some ASCII mangling proxy.
Use matchToken instead, such proxies are much less common now and there's
not much benefit in customising the error message.
* ContentHandler::getForTitle(), deprecated since 1.35, now emits
deprecation warnings.
* User::listOptionKinds(), deprecated since 1.35, now emits deprecation
warnings.
* WikiPage::doEditContent(), deprecated since 1.32, now emits deprecation
warnings.
* CentralIdLookup::factory and ::factoryNonLocal were deprecated, obtain an
instance from MediaWikiServices instead.
* BotPassword::invalidateAllPasswordsForCentralId() was deprecated.
* BotPassword::removeAllPasswordsForCentralId() was deprecated.
* The Title class members: $mTextform, $mUrlform, $mDbkeyform, $mNamespace,
$mInterwiki, and $mFragment have been deprecated to not be used directly.
Instead, their corresponding accessor methods should be used.
DBMS-specific ResultWrapper subclasses Cleanup after the switch of Database::query() to return ResultWrapper instead of resource. * Soft-deprecate the IResultWrapper accessors in IDatabase. * Move relevant DBMS-specific functionality to ResultWrapper subclasses. The deprecated methods in IResultWrapper become short and simple. ResultWrapper is now abstract (b/c break). * Move the implementation of fieldName(), numFields() and one of the fieldInfo() implementations to the ResultWrapper subclass in order to avoid ResultWrapper::unwrap() calls. * Make Database::doQuery() return a ResultWrapper subclass instead of underlying result data, so that the Database parent class does not need to be aware of wrapper construction. * Hard-deprecate ResultWrapper::unwrap(), DatabaseMysqlBase::fieldType(), DatabasePostgres::fieldType(). * Fix the inefficient seeking method in SQLite. * Make FakeResultWrapper extend ResultWrapper with an implementation similar to the SQLite one. This is possible because ResultWrapper does not depend on IDatabase anymore. * Resolve fixme in DatabasePostgres: from studying the source, neither pg_fetch_object() nor pg_num_rows() can set an error retrievable with pg_last_error(). Removed unnecessary warning suppression. * ResultWrapperTest didn't make sense as a unit test anymore, so I adapted it as an integration test against the current DBMS. This change also means that ResultWrapper::key() always gives the correct offset, even if Iterator methods are not being used. Bug: T286694 Change-Id: I935835316c0bd7d3d061bd8fde9c9ce99ce756ec
2021-07-15 00:46:59 +00:00
* IDatabase::fetchObject(), ::fetchRow(), ::numRows(), ::numFields(),
::fieldName(), ::freeResult() and ::dataSeek() are deprecated. Use the
corresponding methods in IResultWrapper instead.
* ResultWrapper::unwrap(), DatabaseMysqlBase::fieldType() and
DatabasePostgres::fieldType() are hard-deprecated.
* Subclasses implementing Database::doQuery() should return either boolean or
an IResultWrapper. To do otherwise is hard-deprecated.
* User::getOptionKinds() and ::resetOptions(), both deprecated since 1.35,
now emit deprecation warnings.
* wfGetLB(), deprecated since 1.27, now emits deprecation warnings.
* The following hooks were deprecated:
- UserLoadOptions: use LoadUserOptions instead.
- UserSaveOptions: use SaveUserOptions instead.
- UserResetAllOptions: no replacement was provided, the hook is not used.
* …
=== Other changes in 1.37 ===
* WatchlistManager::addWatch and WatchlistManager::addWatchIgnoringRights(),
which replace User::addWatch(), now call the WatchArticle and
WatchArticleComplete hooks.
* WatchlistManager::removeWatch and
WatchlistManager::removeWatchIgnoringRights(), which replace
User::removeWatch(), now call the UnwatchArticle and UnwatchArticleComplete
hooks.
* The overridable postInitSetup() method was added to the
AbstractAuthenticationProvider class. A provider can override postInitSetup()
to do any custom post-initialization configuration.
* The overridable postInitSetup() method was added to the SessionProvider
class. A provider can override postInitSetup() to do any custom
post-initialization configuration.
* The protected getConfig() method was added to the SessionProvider class.
Use SessionProvider::getConfig to get a config.
* The DBAccessBase class is deprecated. Classes that used to extend it
should get a load balancer (factory) injected in the constructor instead.
* ActorNormalization::acquireActorId now requires IDatabase parameter.
Not providing one emitted deprecation warnings since 1.36.
* Anti-lock constants ALF_PRELOAD_LINK, ALF_NO_BLOCK_LOCK, ALF_NO_LINK_LOCK
and ALF_PRELOAD_EXISTENCE have been removed. They're unused since 1.25.
* CSS class 'mw-htmlform-field-autoinfuse' used by some forms has been
renamed to 'mw-htmlform-autoinfuse'. (T278036)
Improvements to user preferences fetching/saving == Status quo == When saving user preferences, we want to lock the rows to avoid accidentally overriding a concurrent options update. So usually what extensions do is: $value = $mngr->getOption( 'option', ..., READ_LOCKING ); if ( $value !== 'new_value' ) { $mngr->setOption( 'option', 'new_value' ); $mngr->saveOptions() } Previously for extra caution we've ignored all caches in options manager if >= READ_LOCKING flags were passed. This resulted in re-reading all the options multiple times. At worst, 3 times: 1. If READ_NORMAL read was made for update - that's once, 2. On setOption, one more read, forcefully from primary 3. On saveOptions, one more read from primary, non-locking, to figure out which option keys need to be deleted. Also, READ_LOCKING was not used where it clearly had to be used, for example right before the update. This was trying to fix any kind of error on part of the manager clients, unsuccessfully so. == New approach == 1. Cache modified user options separately from originals and merge them on demand. This means when refetching originals with LOCKING we don't wipe out all modifications made to the cache with setOption. Extra bonus - we no longer need to load all options to set an option. 2. Split the originals cache into 2 layers - one for stuff that comes from DB directly, and one with applied normalizations and whatever hooks modify. This let's us avoid refetching DB options after we save them, but still let's the hooks execute on newly set options after they're saved. 3. Cache options with all query flags. This is a bit controversial, but ideally LOCKING flags will be applied on options fetch right before they are saved. We have to re-read options with LOCKING in saveOptions to avoid races, but if the caller did 'getOption( ..., LOCKING), setOption(), save()' we will not need to re-select with LOCKING again. Bug: T280220 Change-Id: Ibed2789f5260b725fd806b4470631aa30d814ce6
2021-06-11 18:48:19 +00:00
* User::newFromRow does not accept pre-loaded user preferences under
$data['user_properties'] anymore. This optimization was not used.
* The following methods in MWNamespace, all deprecated since 1.34, now emit
deprecation warnings:
- isMovable()
- subjectEquals()
- hasTalkNamespace()
- wantSignatures()
- isWatchable()
- hasGenderDistinction()
- getRestrictionLevels()
- getCategoryLinkType()
* LogFormatter::styleRestricedElement has been deprecated in favor of
LogFormatter::styleRestrictedElement
* …
== Compatibility ==
MediaWiki 1.37 requires PHP 7.3.19 or later and the following PHP extensions:
* ctype
* dom
* fileinfo
* iconv
* intl
* json
* mbstring
* xml
MySQL/MariaDB is the recommended DBMS. PostgreSQL or SQLite can also be used,
but support for them is somewhat less mature.
The supported versions are:
* MySQL 5.5.8 or later
* PostgreSQL 9.4 or later
* SQLite 3.8.0 or later
== Online documentation ==
Documentation for both end-users and site administrators is available on
MediaWiki.org, and is covered under the GNU Free Documentation License (except
for pages that explicitly state that their contents are in the public domain):
https://www.mediawiki.org/wiki/Special:MyLanguage/Documentation
== Mailing list ==
A mailing list is available for MediaWiki user support and discussion:
https://lists.wikimedia.org/mailman/listinfo/mediawiki-l
A low-traffic announcements-only list is also available:
https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce
It's highly recommended that you sign up for one of these lists if you're
going to run a public MediaWiki, so you can be notified of security fixes.
== IRC help ==
There's usually someone online in #mediawiki on irc.libera.chat.