RELEASE-NOTES-1.38

= MediaWiki 1.38 =

== MediaWiki 1.38.0-PRERELEASE ==

THIS IS NOT A RELEASE YET

MediaWiki 1.38 is an alpha-quality development branch, and is not recommended
for use in production.

== Upgrading notes for 1.38 ==
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.29.

Some specific notes for MediaWiki 1.38 upgrades are below:
* …

For notes on 1.36.x and older releases, see HISTORY.

=== Configuration changes for system administrators in 1.38 ===
* Deprecate $wgAjaxUploadDestCheck, act as always-true
* …

==== New configuration ====
* $wgBrowserFormatDetection – This setting allows overriding browsers' automatic
  detection and handling of formats. It's initially used to prevent auto-linking
  of possible telephone numbers in wiki pages' output in Safari on iOS; this can
  be re-enabled if you wish, or locally extended for other browsers' quirks.
* $wgGroupInheritsPermissions – This setting allows inheriting permissions, both
  granted and revoked, from another group.
* $wgForeignApiRepos – ForeignAPIRepo now has a apiMetadataExpiry option
  to control how long file metadata is cached. Additionally the default changed
  from 1 hour to 4 hours.
* …

==== Changed configuration ====
* $wgMaxImageArea - This setting may now be set to false to disable size
  checking before scaling. Extensions can still override its value by
  using the BitmapHandlerCheckImageArea hook.
* …

==== Removed configuration ====
* $wgShellLocale - This setting has been removed as it was a flawed solution
  to the problem of locale dependence, MediaWiki will now always set a locale
  of C.UTF-8 or C and works around the remaining problems of the C locale by
  not using escapeshellarg. This follows the direction of PHP 8.0, which sets
  a locale of C by default instead of respecting LC_CTYPE.
* $wgLoggedOutMaxAge - Experiment removed, originally added in 1.35. (T293848)
* $wgIncludejQueryMigrate - Deprecated in 1.36. We only support jQuery v3.
* $wgUseCategoryBrowser - This experimental feature has been removed. If you
  still need to use this feature, please see [[mw:Extension:CategoryExplorer]].
* …

=== New user-facing features in 1.38 ===
* …

=== New developer features in 1.38 ===
* Added a deleteUserEmail maintenance script - This file enables the deletion
  of a given user's associated email address. It can be helpful for
  privacy-preserving operations.
* Description array for constructing HTMLForm now can use 'disable-if' to
  disable fields on condition easily, supported expressions are the same
  as 'hide-if'.
* …

=== External library changes in 1.38 ===

==== New external libraries ====
* symfony/yaml was promoted from development-only.
* …

===== New development-only external libraries =====
* …

==== Changed external libraries ====
* Updated OOUI from v0.42.0 to v0.43.0.
* Updated WVUI from v0.3.0 to v0.3.5
* Upgraded Vue from 2.6.11 to 3.2.23
* Updated composer/semver from 3.2.5 to 3.2.6.
* Updated guzzlehttp/guzzle from 7.2.0 to 7.4.0.
* Updated pear/mail_mime from 1.10.9 to 1.10.11.
* Updated pear/net_smtp from 1.9.2 to 1.10.0.
* Updated psr/log from 1.1.3 to 1.1.4.
* Updated wikimedia/assert from 0.5.0 to 0.5.1.
* Updated wikimedia/cdb from 1.4.1 to 2.0.0.
* Updated wikimedia/minify from 2.2.4 to 2.2.6.
* Updated wikimedia/parsoid from v0.14.0-a14 to v0.15.0-a1.
* Updated wikimedia/purtle from 1.0.7 to 1.0.8.
* Updated wikimedia/shellbox from 2.0.0 to 3.0.0.
* Updated wikimedia/wrappedstring from 3.2.0 to 4.0.1.
* …

===== Changed development-only external libraries =====
* Updated composer/semver from 3.5.4 to 3.5.5.
* Updated composer/spdx-licenses from 1.5.4 to 1.5.5.
* Updated doctrine/dbal for PHP < 7.3 from 2.10.4 to 2.13.6.
* Updated doctrine/dbal for PHP >= 7.3 from 3.0.0 to 3.1.5.
* …

==== Removed external libraries ====
* jquery.jStorage, deprecated since MW 1.28; use "mediawiki.storage" instead.
* …

=== Bug fixes in 1.38 ===
* …

=== Action API changes in 1.38 ===
* New `variant` parameter for all API actions, for specifying language variant
  (akin to the existing `variant` parameter for index.php). Task T117549.
* …

=== Action API internal changes in 1.38 ===
* …

=== Languages updated in 1.38 ===
MediaWiki supports over 400 languages. Many localisations are updated regularly.
Below only new and removed languages are listed, as well as changes to languages
because of Phabricator reports.

* (T292166) Updated namespace names for the Lombard language.
* (T299201) Changed the autonym of the Angika language to अंगिका
* (T298309) Changed the autonym of the Abkhaz language to аԥсшәа
* (T291899) Added language support for Xiang Chinese (hsn).
* (T292612) Added language support for S'gaw Karen (ksw).
* (T293656) Added language support for Farefare (gur).
* (T294729) Added language support for Pa'O (blk).
* (T296286) Added language support for Skolt Sámi (sms).
* (T296612) Added language support for Makhuwa (vmw).
* (T296707) Added language support for Ga (gaa).
* (T297073) Added language support for Nanai (gld).
* (T297074) Added language support for Nawdm (nmz).
* (T298075) Added language support for Northern Thai (nod).
* (T298182) Added language support for Cape Verdean Creole (kea).
* (T298385) Added language support for Nheengatu (yrl).
* (T299329) Added language support for Fon (fon).

=== Breaking changes in 1.38 ===
* (T291008) The IP class, deprecated since 1.35 in favor of the IPUtils library,
  has been removed. The IP related regexes which were also deprecated in favor
  of the IPUtils library were also removed, IPUtils::RE_* should be used
  instead.
* (T293043) The MediaWikiIntegrationTestCase class alias 'MediaWikiTestCase' has
  been removed.
* LinkCache::singleton(), deprecated since 1.28, has been removed.
* RepoGroup::singleton(), ::destroySingletons() and setSingleton(), all
  deprecated since 1.34, have been removed.
* The following methods from FileDeleteForm were removed:
  - ::__construct (the class is no longer newable)
  - ::execute()
  - ::haveDeletableFile()
  Use FileDeleteAction instead.
* MessageCache::singleton(), deprecated since 1.34, has been removed.
* LockManagerGroup::singleton() and ::destroySingletons(), both deprecated since
  1.34, have been removed.
* FileBackendGroup::singleton() and ::destroySingletons(), both deprecated since
  1.35, have been removed.
* TemplateParser used to support disabling the cache with a boolean parameter
  in its constructor. This was deprecated in 1.35 and has now been removed.
* The ArticleUndeleteLogEntry hook, deprecated in 1.37, was removed.
* The BeforeResetNotificationTimestamp hook, deprecated in 1.37, was removed.
* The global function mimeTypeMatch() has been removed without a deprecation
  process.
* The following JavaScript mw.config keys have been removed:
  - $wgCookiePrefix
  - $wgCookieDomain
  - $wgCookiePath
  - $wgCookieExpiration
  Use mw.cookie from the mediawiki.cookie module instead.
* The signature of PageUpdater::markAsRevert method was changed. It has never
  been used outside of MediaWiki core.
* If you want to use interwiki titles with HTMLTitleTextField, you now need
  to pass 'interwiki' => true. In 1.37, the default behavior was to let
  interwiki title through by default, logging a deprecation warning.
* The `UndeleteForm::undelete` hook, deprecated in 1.37, was removed.
* BagOStuff::setDebug(), deprecated since 1.36, has been removed.
* The `jquery.mw-jump` ResourceLoader module was removed.
* The `wgForeignUploadTargets` and `wgEnableUploads` configuration values were
  removed from mw.config. They had previously been documented as being included
  for internal use by the mediawiki.ForeignUpload module.
*The `&$hasHistory` parameter to WikiPage::getAutoDeleteReason() and
  ContentHandler::getAutoDeleteReason() was hard-deprecated with no replacement.
* Several Skin methods, which have emitted deprecation warnings since 1.36, have
  been removed. These include:
  - Skin::privacyLink()
  - Skin::aboutLink()
  - Skin::disclaimerLink()
    For these, instead use Skin::footerLink() to alter footer links.
  - Skin::getLogo()
    For this, use ResourceLoaderSkinModule::getAvailableLogos() instead.
  - Skin::getIndicatorsHTML()
    For this, use Skin::getIndicatorsData() instead.
  - Skin::subPageSubtitle()
    For this, use Skin::prepareSubtitle() instead.
  - Skin::makeVariablesScript()
    For this, use ResourceLoader::makeInlineScript() instead.
  - Skin::getAllowedSkins()
  - Skin::getSkinNames()
    For these, use SkinFactory::getAllowedSkins() or ::getInstalledSkins().
  - Skin::makeUrl()
  - Skin::getSearchLink()
  - Skin::mainPageLink()
* Parser::getUser and ::mUser, as well as ParserOptions::getUser, deprecated
  since 1.37, has been removed.
* Parser::$mStripState, deprecated in 1.35, has been made private.  Use
  Parser::getStripState() instead.
* The following deprecated features in blocks were removed:
  - DatabaseBlock constructor 'byText' property with blocker's name, use 'by'
    property with UserIdentity value instead.
  - DatabaseBlock constructor 'by' property with blocker's ID, use 'by' property
    with UserIdentity value instead.
  - DatabaseBlock::isWhitelistedFromAutoblocks, use ::isExemptedFromAutoblocks.
  - DatabaseBlock::setBlocker now only accepts UserIdentity.
  - AbstractBlock::getTargetAndType and ::getTarget, use ::getTargetName,
    ::getTargetUserIdentity and ::getType instead
* The following functions, emitting deprecations since 1.37, have been removed:
  - Title::isWatchable()
  - WatchAction::doWatchOrUnwatch(), WatchAction::doWatch(),
    WatchAction::doUnwatch(), WatchAction::getWatchToken()
  - User::isWatched(), User::isTempWatched(), User::addWatch(),
    User::removeWatch()
* ParserOptions::setTidy() that had no effect and was deprecated since 1.35
  has been removed.
* The constant ApiBase::PARAM_VALUE_LINKS, deprecated since 1.35 has been
  removed.
* UserLoadOptions, UserSaveOptions and UserResetAllOptions hooks, deprecated
  since 1.37, were removed.
* The experimental FileJournal system has been removed without deprecation. This
  includes the FileJournal abstract class, its implementation classes
  DBFileJournal and NullFileJournal, various minor getters and setters, and
  the option for the wiki configuration $wgFileBackends.
* The return values for each `bind` function in checkboxHack.js has been changed
  from an object to a function. In addition, the `unbind` function has been
  removed. A deprecation process was assumed unnecessary as there were no known
  usages.
* File::getUser, ::getImageSize, ArchivedFile::getRawDescription, ::getUser,
  ::getRawUser and ::getRawDescription, deprecated since 1.37, has been removed.
* ShellboxHttpClient class has been removed without deprecation. It was an
  internal class used by ShellboxClientFactory.
* The following hard deprecated User methods have been removed:
  - ::resetIdByNameCache,
  - ::getStubThreshold,
  - ::matchEditTokenNoSuffix,
  - ::changeableByGroup,
  - ::changeableGroups,
  - ::isAllowUsertalk,
  - ::getRights
  - ::isAllowUsertalk
  - ::isIP,
  - ::isIPRange,
  - ::isValidUserName,
  - ::isUsableName,
  - ::isCreatableName,
  - ::getCanonicalName,
  - ::addAutopromoteOnceGroups,
  - ::getDefaultOptions,
  - ::getDefaultOption,
  - ::getOptions,
  - ::getBoolOption,
  - ::getIntOption,
  - ::setOption
  - ::listOptionKinds
  - ::getOptionKinds,
  - ::resetOptions,
  - ::getEffectiveGroups,
  - ::getAutomaticGroups,
  - ::getFormerGroups
  - ::isLoggedIn
  - ::getFirstEditTimestamp
  - ::getLatestEditTimestamp
* Http::$httpEngine, deprecated since 1.34, has been removed. The only available
  HTTP engine is now Guzzle. CurlHttpRequest and PhpHttpRequest classes were
  removed.
* Parser option enableLimitReport was deprecated. The report is now generated
  post-parse and can be included by providing 'includeDebugInfo' option
  to ParserOutput::getText. Thus, ParserOptions::enableLimitReport and
  ::getEnableLimitReport methods were deprecated.
* Ajax action that was deprecated in 1.27 now has been removed.
* The following methods have been removed from IDatabase without deprecation
  as they were completely unused:
  - ::preCommitCallbacksPending()
  - ::pendingWriteRowsAffected()
  - ::getServerUptime()
  - ::maxListLen()
* The following deprecated methods have been removed from IDatabase:
  - ::aggregateValue() soft-deprecated since 1.33
  - ::getTopologyRootMaster() since 1.37
  - ::masterPosWait() since 1.37
  - ::dataSeek() soft-deprecated since 1.37
  - ::numFields() soft-deprecated since 1.37
  - ::fieldName() soft-deprecated since 1.37
  - ::onTransactionIdle() soft-deprecated since 1.32
  - ::getMasterPos() since 1.37
* DatabaseMysqlBase::fieldType() and DatabasePostgres::fieldType(), deprecated
  since 1.37, have been removed.
* ResultWrapper::getInternalResult(), soft-deprecated since 1.37 and
  ResultWrapper::unwrap(), deprecated since 1.37, have been removed.
* Language::AS_AUTONYMS, deprecated since 1.34, has been removed. You can use
  the LanguageNameUtils::AUTONYMS constant instead.
* Several Language class variables deprecated in 1.35 have been removed; they
  are each replaced by a constant, as listed after the arrow:
  - ::$mWeekdayMsgs → WEEKDAY_MESSAGES
  - ::$mWeekdayAbbrevMsg → WEEKDAY_ABBREVIATED_MESSAGES
  - ::$mMonthGenMsgs → MONTH_GENITIVE_MESSAGES
  - ::$mIranianCalendarMonthMsgs → IRANIAN_CALENDAR_MONTHS_MESSAGES
  - ::$mHebrewCalendarMonthMsgs → HEBREW_CALENDAR_MONTHS_MESSAGES
  - ::$mHebrewCalendarMonthGenMsgs → HEBREW_CALENDAR_MONTH_GENITIVE_MESSAGES
  - ::$mHijriCalendarMonthMsgs → HIJRI_CALENDAR_MONTH_MESSAGES
* wfIncrStats, deprecated since 1.36, has been removed.
* Profiler::profileIn and ::profileOut, deprecated in 1.33, has been removed.
* SelectQueryBuilder::straightJoin() was renamed to straightJoinOption().
* The "groupLoadsByDB" option to LBFactoryMulti has been removed. Consider
  using "groupLoadsBySection" instead.
* …

=== Deprecations in 1.38 ===
* The MWGrants class is deprecated in favor of the new GrantsInfo and
  GrantsLocalization services.
* The global functions wfReadOnly() and wfReadOnlyReason() have been
  deprecated in favor of the ReadOnlyMode service.
* PageProps::getInstance() has been deprecated. Use
  MediaWikiServices::getPageProps() instead.
* User::setOption(), deprecated since 1.35, now emits deprecation warnings.
* Linker::formatComment(), ::formatLinksInComment(), ::commentBlock() and
  revComment() were deprecated. Use the new CommentFormatter service.
* Several Skin methods have been deprecated.
  - Skin::setSearchPageTitle(), Skin::getSearchPageTitle(). For these,
    use SpecialPage::newSearchPage() or associated user preference instead.
  - Skin::getSkinStylePath now triggers deprecation warnings. Direct string path
  should be used instead.
  - SkinTemplate::getPersonalToolsList(), deprecated since 1.35, now emits
  deprecation warnings.
* Usage of several template data keys in QuickTemplate are now deprecated:
  - searchaction, poweredbyico, copyrightico
* DatabaseBlock::purgeExpired(), deprecated since 1.36, now emits
  deprecation warnings.
* The following methods from the User class now trigger deprecation warnings:
   - ::blockedBy
   - ::getBlockId
* Content::getParserOutput and AbstractContent::fillParserOutput
  was hard-deprecated, use ContentRenderer::getParserOutput instead.
  Extensions defining a content model should
  override ContentHandler::fillParserOutput.
* Title::newFromIDs and TitleFactory::newFromIDs have been hard deprecated.
  Use a PageSelectQueryBuilder from a PageStore instead.
* Content::getRedirectChain() and Content::getUltimateRedirectTarget() have
  been deprecated with no replacement because support for $wgMaxRedirect
  will be removed completely. See T296430 for more information.
* WikiPage::getRedirectTarget() has been deprecated. Use the equivalent
  RedirectLookup::getRedirectTarget() instead.
* Article::doDelete() was deprecated. Use WikiPage::doDeleteArticleReal if
  you only need to delete the article. If you also need things to happen
  with OutputPage, you may want to check the hooks in DeleteAction instead.
* Instantiating the MessageContent class now emits deprecation notices.
* Message::content() now triggers deprecation warnings.
* The following methods from the ParserOutput class now emit deprecation
  warnings:
   - ::hideNewSection()      - use ::setHideNewSection()
   - ::preventClickjacking() - use ::{get,set}PreventClickjacking()
   - ::getProperty()         - use ::getPageProperty()
   - ::setProperty()         - use ::setPageProperty()
   - ::unsetProperty()       - use ::unsetPageProperties()
   - ::getProperties()       - use ::getPageProperties()
   - ::getCategoryLinks()    - use ::getCategoryNames()
   - ::setCategoryLinks()    - use ::setCategories()
   - ::addTrackingCategory() - use Parser::addTrackingCategory()
                               or TrackingCategories::addTrackingCategory()
   - ::addWarning()          - use ::addWarningMsg()
   - ::hasDynamicContent()   - use ::hasReducedExpiry()
* The following methods from the ParserOutput class were deprecated:
   - ::getFlag() - use ::getOutputFlag()
   - ::setFlag() - use ::setOutputFlag()
   - ::getAllFlags() - this method is now marked @internal
* The following methods were deprecated; use ::setPreventClickjacking(..)
  instead:
   - OutputPage::preventClickjacking()
   - OutputPage::allowClickjacking()
   - ImageHistoryList::preventClickjacking()
   - ImageHistoryPseudoPager::preventClickjacking()
   - ContribsPager::preventClickjacking()
* Collation::singleton() and ::factory() now trigger deprecation warnings.
* The following methods in MWNamespace, all deprecated since 1.34, now emit
  deprecation warnings:
  - isTalk()
  - exists()
  - subjectEquals()
  - getCanonicalNamespaces()
  - getCanonicalName()
  - getCanonicalIndex()
  - getValidNamespaces()
  - isContent()
  - hasSubpages()
  - getContentNamespaces()
* Return values in the parameter $pageLang of the hook PageContentLanguage
  with other types than a Language object, deprecated since 1.33, now emmits
  deprecation warnings.
* All external access to ParserOutput and CacheTime classes properties will now
  emit deprecation warnings. Use getters and setters instead.
* The custom jQuery event `watchpage.mw` emitted on #ca-watch and #ca-unwatch is
  now deprecated in favour of the new `wikipage.watchlistChange` hook.
* The global function wfLogProfilingData() has been deprecated without a
  replacement. The logic has been moved to the MediaWiki class.
* The PageArchive class has had several methods deprecated. The replacements
  are as follows:
   - Use UndeletePage instead of ::undeleteAsUser(), ::getFileStatus() and
     ::getRevisionStatus().
   - Use the respective methods of the new ArchivedRevisionLookup service
     instead of ::listRevisions, ::getRevisionRecordByTimestamp,
     ::getArchivedRevisionRecord, ::getPreviousRevisionRecord and
     ::getLastRevisionId.
   - Use ArchivedRevisionLookup::hasArchivedRevisions instead of ::isDeleted.
* The `mediawiki.pager.tablePager` module was deprecated in favor of the more
generic `mediawiki.pager.styles`.
* wfGetCache() and wfGetMainCache(), both deprecated since 1.32, now emit
  deprecation warnings.
* LinkCache::addGoodLinkObj() has been hard deprecated.
* ApiStashEdit::parseAndStash has been hard deprecated.
* Content::prepareSave was hard-deprecated, now emits deprecation warnings.
  Use ContentHandler::validateSave instead.
* The hooks LinksUpdateAfterInsert and LinksUpdateConstructed were deprecated.
* Access to all public properties in LinksUpdate was deprecated.
* The global function wfWikiID(), deprecated since 1.35, now emits
  deprecation warnings.
* AbstractBlock::getBy() now takes a wikiId as a parameter and emits
  deprecation warnings in case of cross-wiki accesses.
* The `button` parameter for `bindUpdateAriaExpandedOnInput` and
  `updateAriaExpanded` in checkboxHack.js have been deprecated.
  `bindToggleOnSpaceEnter` has also been deprecated in favor of
  `bindToggleOnEnter`.
* The HTMLForm methods getPreText, setPreText, addPreText, getPostText,
  setPostText, addPostText, getHeaderText, setHeaderText, addHeaderText,
  getFooterText, setFooterText and addFooterText have been renamed to
  getPreHtml, setPreHtml, addPreHtml, getPostHtml, setPostHtml, addPostHtml,
  getHeaderHtml, setHeaderHtml, addHeaderHtml, getFooterHtml, setFooterHtml
  and addFooterHtml respectively.
* The FormSpecialPage methods preText and postText have been renamed to
  preHtml and postHtml respectively.
* …

=== Other changes in 1.38 ===
* The following things were changed in the file deletion form:
   - The name and ID of the submit button are now `wpConfirmB`, not
      `mw-filedelete-submit`
   - The ID of the form is now `deleteconfirm`, not `mw-img-deleteconfirm`
   - The `mw-filedelete-editreasons` class was replaced with
     `mw-delete-editreasons`
  The goal of these changes is to make the HTML more similar to that of
  normal page deletion.
* ParserOptions created with ::newFrom* or ::newCanonical are now identical.
* MediaWiki initialization order have been changed to load vendor autoload
  earlier. This means that extensions that are installed via composer and
  execute code upon autoloading can not depend on any MediaWiki classes,
  constants or globals in that code.
* …

== Compatibility ==

MediaWiki 1.38 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.