Todo List

Member DBSiteStore::__construct (ILoadBalancer $dbLoadBalancer)

inject some kind of connection manager that is aware of the target wiki, instead of injecting a LoadBalancer.

Member Revision\RevisionStore::loadRevisionFromPageId (IDatabase $db, $pageid, $id=0)

remove when unused!

Member Revision\RevisionStore::loadRevisionFromTitle (IDatabase $db, $title, $id=0)

remove when unused!

Member Revision\RevisionStore::loadRevisionFromTimestamp (IDatabase $db, $title, $timestamp)

remove when unused!

Member Revision\RevisionStore::findSlotContentId (IDatabase $db, $revId, $role)

remove after MCR schema migration is complete.

Member Revision::getContentModel ()

drop this, with MCR, there no longer is a single model associated with a revision.

Member Revision::getContentFormat ()

drop this, the format is irrelevant to the revision!

Member RevisionItem::getRevisionLink ()

Essentially a copy of RevDelRevisionItem::getRevisionLink. That class should inherit from this one, and implement an appropriate interface instead of extending RevDelItem

Member RevisionItem::getDiffLink ()

Essentially a copy of RevDelRevisionItem::getDiffLink. That class should inherit from this one, and implement an appropriate interface instead of extending RevDelItem

Member RevisionItem::getHTML ()

Essentially a copy of RevDelRevisionItem::getHTML.

Member SearchEngine::getTextFromContent (Title $t, Content $c=null)

This isn't ideal, we'd really like to have content-specific handling here

Class SearchEngineDummy

FIXME: Dummy class should probably try something at least mildly useful, such as a LIKE search through titles.

File Setup.php

UGLY UGLY

Member Revision\RevisionStore::loadRevisionFromId (IDatabase $db, $id)

remove when unused! there seem to be no callers of Revision::loadFromId

Class SiteConfiguration

Give examples for, suffixes: $conf->suffixes = [ 'wiki' ]; localVHosts callbacks!

Class SkinTemplate

Needs some serious refactoring into functions that correspond to the computations individual esi snippets need. Most importantly no body parsing for most of those of course.

Member SkinTemplate::makeArticleUrlDetails ( $name, $urlaction='')

is this even used?

Class ChangesListSpecialPage

Way too many public functions, most of them should be protected

Member ChangesListSpecialPage::getExtraOptions ( $opts)

This should handle options returned by getDefaultOptions().

Not called by anything in this class (but is in subclasses), should be called by something… doHeader() maybe?

Member MediaWiki\Special\SpecialPageFactory::$coreList

Make this a const when we drop HHVM support (T192166). It can still be private in PHP 7.1.

Member ContribsPager::formatRow ( $row)

This would probably look a lot nicer in a table.

Member DeletedContribsPager::formatRow ( $row)

This would probably look a lot nicer in a table.

Member DeletedContribsPager::formatRevisionRow ( $row)

This would probably look a lot nicer in a table.

Class SpecialAllPages

Rewrite using IndexPager

Member SpecialBlock::getTargetAndType ( $par, WebRequest $request=null)

Should be in DatabaseBlock.php?

Member Sanitizer::escapeClass ( $class)

For extra validity, input should be validated UTF-8.

Member WikiPage::doRollback ( $fromP, $summary, $token, $bot, &$resultDetails, User $user, $tags=null)

Separate the business/permission stuff out from backend code

Remove $token parameter. Already verified by RollbackAction and ApiRollback.

Member CacheTime::isDifferentRevision ( $id)

We always return false if $this->getCacheRevisionId() is null; this prevents invalidating the whole parser cache when this change is deployed. Someday that should probably be changed.

Member CoreTagHooks::gallery ( $content, $attributes, $parser)

break Parser::renderImageGallery out here too.

Member Parser::setTransparentTagHook ( $tag, callable $callback)

better document or deprecate this

Class ParserCache

document

Member ParserOptions::$mUser

Track this for caching somehow without fragmenting the cache insanely

Member ParserOptions::$redirectTarget

Track this for caching somehow

Member ParserOutput::addTrackingCategory ( $msg, $title)

Migrate some code to TrackingCategories

Class Preprocessor_Hash

: Consider replacing descriptor arrays with objects of a new class. Benchmark and measure resulting memory impact.

Member Sanitizer::validateTagAttributes ( $attribs, $element)

Check for legal values where the DTD limits things.

Check for unique id attribute :P

Member Sanitizer::validateAttributes ( $attribs, $whitelist)

Check for legal values where the DTD limits things.

Check for unique id attribute :P

Member Sanitizer::mergeAttributes ( $a, $b)

implement merging for other attributes such as style

Member SpecialBlock::getSuggestedDurations (Language $lang=null, $includeOther=true)

FIXME: This uses a rather odd syntax for the options, should it be converted to the standard "**<duration>|<displayname>" format?

Class StripState

document, briefly.

Member MediaWiki\Permissions\PermissionManager::getPermissionErrors ( $action, User $user, LinkTarget $page, $rigor=self::RIGOR_SECURE, $ignoreErrors=[])

FIXME: This does not check throttles (User::pingLimiter()).

Member MediaWiki\Preferences\DefaultPreferencesFactory::profilePreferences (User $user, IContextSource $context, &$defaultPreferences, $canIPUseHTTPS)

Inject user Language instead of using context.

Member ExtensionProcessor::extractConfig1 (array $info)

In the future, this should be done via Config interfaces

Member ExtensionProcessor::extractConfig2 (array $info, $dir)

In the future, this should be done via Config interfaces

Namespace MediaWiki

Declare it as abstract after dropping HHVM

Member Revision\RevisionRenderer::combineSlotOutput (RenderedRevision $rrev, array $hints=[])

Use placement hints from SlotRoleHandlers instead of hard-coding the layout.

Member Revision\RevisionStore::__construct (ILoadBalancer $loadBalancer, SqlBlobStore $blobStore, WANObjectCache $cache, CommentStore $commentStore, NameTableStore $contentModelStore, NameTableStore $slotRoleStore, SlotRoleRegistry $slotRoleRegistry, $mcrMigrationStage, ActorMigration $actorMigration, $dbDomain=false)

$blobStore should be allowed to be any BlobStore!

Member Revision\RevisionStore::newNullRevision (IDatabase $dbw, Title $title, CommentStoreComment $comment, $minor, User $user)

Introduce newFromParentRevision(). newNullRevision can then be based on that (or go away).

Member Revision\RevisionStore::getRcIdIfUnpatrolled (RevisionRecord $rev)

This is overly specific, so move or kill this method.

Member Revision\RevisionStore::getRecentChange (RevisionRecord $rev, $flags=0)

move this somewhere else?

Member Language::convertHtml ( $text)

this should get integrated somewhere sane

Member User::saveSettings ()

Only rarely do all these fields need to be set!

Member UIDGenerator::singleton ()

move to MW-specific factory class and inject temp dir

Member WikiMap::getWikiName ( $wikiID)

We can give more info than just the wiki id!

Member WikiReference::getLocalUrl ( $page, $fragmentId=null)

FIXME: This may be generalized...

Member Xml::isWellFormed ( $text)

Error position reporting return

Member LanguageAr::normalize ( $s)

FIXME: This is language-specific for now only to avoid the negative performance impact of enabling it for all languages.

Member LanguageMl::normalize ( $s)

FIXME: This is language-specific for now only to avoid the negative performance impact of enabling it for all languages.

Member LanguageYue::segmentByWord ( $string)

FIXME: Only do this for Han characters...

Member LanguageZh_hans::segmentByWord ( $string)

FIXME: Only do this for Han characters...

Member Language::sprintfDate ( $format, $ts, DateTimeZone $zone=null, &$ttl='unused')

handling of "o" format character for Iranian, Hebrew, Hijri & Thai?

Member Language::formatNum ( $number, $nocommafy=false)

check if it's viable to use localeconv() for the decimal separator thing.

Member Language::translateBlockExpiry ( $str, User $user=null, $now=0)

Maybe translate block durations.

Member UploadBase::checkSvgScriptCallback ( $element, $attribs, $data=null)

Replace this with a whitelist filter!

File cdb.php

document

File deleteOrphanedRevisions.php

More efficient cleanup of text records

Class EraseArchivedFile

Maybe add some simple logging

Member BackupDumper::backupDb ()

Fixme: the –server parameter is currently not respected, as it doesn't seem terribly easy to ask the load balancer for a particular connection by name.

File dumpMessages.php

Make this more useful, right now just dumps content language

File mcc.php

document

File mwdocgen.php

document

Member PurgeChangedPages::pageableSortedRows (IResultWrapper $res, $column, $limit)

move this elsewhere

File rebuildrecentchanges.php

Document

File rebuildtextindex.php

document

Module TermColorer

Fixme: Make this more generic

File update.php

document

Class MediaWiki\Storage\DerivedPageDataUpdater

Define interfaces for the different use cases of DerivedPageDataUpdater, particularly providing access to post-PST content and ParserOutput to callbacks during revision creation, which currently use WikiPage::prepareContentForEdit, and allowing updates to be triggered on purge, import, and undeletion, which currently use WikiPage::doEditUpdates() and Content::getSecondaryDataUpdates().

Member SpecialBlock::parseExpiryInput ( $expiry)

strtotime() only accepts English strings. This means the expiry input can only be specified in English.

Member SpecialContributions::contributionsSub ( $userObj)

FIXME: Almost the same as getSubTitle in SpecialDeletedContributions.php. Could be combined.

Member SpecialLinkSearch::getMaxResults ()

FIXME This special page should not use LIMIT for paging

Member SpecialMergeHistory::merge ()

if all versions of page A are moved to B and then a user tries to do a reverse-merge via the "unmerge" log link, then page A will still be a redirect (as it was after the original merge), though it will have the old revisions back from before (as expected). The user may have to "undo" the redirect manually to finish the "unmerge". Maybe this should delete redirects at the target page of merges?

Member SpecialRevisionDelete::tryShowFile ( $archiveName)

Mostly copied from Special:Undelete. Refactor.

Member SpecialRevisionDelete::addUsageText ()

FIXME: Wikimedia-specific policy text

Member SpecialSearch::showGoogleSearch ( $term)

FIXME Maybe we should get rid of this raw html message at some future time SecurityCheck-XSS

Class SpecialUncategorizedImages

FIXME: Use an instance of UncategorizedPagesPage or something

Class SpecialUncategorizedPages

FIXME: Make $requestedNamespace selectable, unify all subclasses into one

Member SpecialUpload::rotationEnabled ()

What about non-BitmapHandler handled files?

Member SpecialUploadStash::outputFileHeaders ( $contentType, $size)

Unsure about encoding as binary; if we received from HTTP perhaps we should use that encoding, concatenated with semicolon to $contentType as it usually is.

File SpecialWhatLinksHere.php

Use some variant of Pager or something; the pagination here is lousy.

Member WikiPage::supportsSections ()

The skin should check this and not offer section functionality if sections are not supported.

The EditPage should check this and not offer section functionality if sections are not supported.

Member MediaWiki\Storage\DerivedPageDataUpdater::getRevision ()

This is currently used by PageUpdater::makeNewRevision() to construct an unsaved MutableRevisionRecord instance. Introduce something like an UnsavedRevisionFactory service for that purpose instead!

Member MediaWiki\Storage\SqlBlobStore::expandBlob ( $raw, $flags, $cacheKey=null)

make this private, there should be no need to use this method outside this class.

Member MediaWiki\Storage\SqlBlobStore::compressData (&$blob)

make this private, there should be no need to use this method outside this class.

Member MediaWiki\Storage\SqlBlobStore::decompressData ( $blob, array $blobFlags)

make this private, there should be no need to use this method outside this class.

Member MediaWikiTitleCodec::splitTitleString ( $text, $defaultNamespace=NS_MAIN)

this method is only exposed as a temporary measure to ease refactoring. It was copied with minimal changes from Title::secureAndSplit().

This method should be split up and an appropriate interface defined for use by the Title class.

Member NamespaceInfo::$canonicalNames

Make this const when HHVM support is dropped (T192166)

Member TitleFormatter::getNamespaceName ( $namespace, $text)

Move this to a separate interface

Member Title::getContentModel ( $flags=0)

Deprecate this in favor of SlotRecord::getModel()

Member Title::getUserPermissionsErrors ( $action, $user, $rigor=PermissionManager::RIGOR_SECURE, $ignoreErrors=[])

FIXME: This does not check throttles (User::pingLimiter()).

Member Title::getBrokenLinksFrom ()

check if needed (used only in SpecialBrokenRedirects.php, and should use redirect table in this case).

Member wfExpandIRI ( $url)

handle punycode domains too

Member $wgTextModelsToParse

On the long run, it would be nice to put categories etc into a separate structure, or at least parse only the contents of comments in the scripts.

Class DifferenceEngine

This class is huge and poorly defined. It should be split into a controller responsible for interpreting query parameters, retrieving data and checking permissions; and a HTML renderer.

Class DiffFormatter

document

Class TableDiffFormatter

document

Member EditPage::internalAttemptSave (&$result, $bot=false)

FIXME: This interface is TERRIBLE, but hard to get rid of due to various error display idiosyncrasies. There are also lots of cases where error metadata is set in the object and retrieved later instead of being returned, e.g. AS_CONTENT_TOO_BIG and AS_BLOCKED_PAGE_FOR_USER. All that stuff needs to be cleaned up some time.

Class UnregisteredLocalFile

Currently it doesn't really work in the repository role, there are lots of functions missing. It is used by the WebStore extension in the standalone role.

Member ForeignAPIRepo::httpGet ( $url, $timeout='default', $options=[], &$mtime=false)

Can this use HttpRequestFactory::get() but just pass the 'userAgent' option?

Member ForeignResourceManager::parseBasicYaml ( $input)

Just ship symfony/yaml.

Class FormOptions

This badly needs some examples and tests :) The usage in SpecialRecentchanges class is a good ersatz in the meantime.

Member wfExpandUrl ( $url, $defaultProto=PROTO_CURRENT)

this won't work with current-path-relative URLs like "subdir/foo.html", etc.

Member wfAssembleUrl ( $urlParts)

Need to integrate this into wfExpandUrl (see T34168)

Member wfRemoveDotSegments ( $urlPath)

Need to integrate this into wfExpandUrl (see T34168)

Member $wgExtraNamespaces

Add a note about maintenance/namespaceDupes.php

Member wfLogProfilingData ()

document

Move logic to MediaWiki.php

Member wfShowingResults ( $offset, $limit)

document

Member wfNegotiateType ( $cprefs, $sprefs)

FIXME: Doesn't handle params like 'text/plain; charset=UTF-8' XXX: generalize to negotiate other stuff

The function appears unused. Is it worth to keep?

Member wfGetDB ( $db, $groups=[], $wiki=false)

Replace calls to wfGetDB with calls to LoadBalancer::getConnection() on an injected instance of LoadBalancer.

Class HTMLSelectAndOtherField

FIXME: If made 'required', only the text field should be compulsory.

Class HTMLForm

Document 'section' / 'subsection' stuff

Member HTMLForm::setSubmitID ( $t)

FIXME: Integrity of $t is not validated

Member HTMLForm::setMessagePrefix ( $p)

Currently only used for the "<fieldset>" legend on forms with multiple sections; should be used elsewhere?

Member HTMLForm::displaySection ( $fields, $sectionName='', $fieldsetIDPrefix='', &$hasUserVisibleFields=false)

Document

Member Http::isValidURI ( $uri)

FIXME this is wildly inaccurate and fails to actually check most stuff

Member MWHttpRequest::setData (array $args)

overload the args param

Member MWHttpRequest::isValidURI ( $uri)

FIXME this is wildly inaccurate and fails to actually check most stuff

Class ChangeTagsLogItem

Abstract out a base class for this and RevDelLogItem, similar to the RevisionItem class but specifically for log items.

Member Cite::MAX_STORAGE_LENGTH

Find a way to retrieve this information from the DBAL

Class GadgetDefinitionValidator

maybe this should use a formal JSON schema validator or something

Class LocalisationUpdate\GitHubFetcher

Could use file hashes to 1) avoid fetching files with same hash as the source. 2) avoid fetching files which haven't changed since last check if we store them.

Member SpecialReplaceText::extractContext ( $text, $target, $use_regex=false)

The bolding needs to be fixed for regular expressions.

Member BaseBlacklist::getTypeFromTitle (Title $title)

building a regex for this is pretty overkill

Member HistoryPager::historyLine ( $row, $next, $notificationtimestamp=false, $dummy=false, $firstInList=false)

document some more, and maybe clean up the code (some params redundant?)

Member ApiUpload::handleStashException ( $e)

Internationalize the exceptions then get rid of this

Member MediaWiki\Block\AbstractBlock::getTargetAndType ()

FIXME: This should be an integral part of the block member variables

Member CategoryFinder::seed ( $articleIds, $categories, $mode='AND', $maxdepth=-1)

FIXME: $categories/$mode

Member EnhancedChangesList::makeCacheGroupingKey (RCCacheEntry $cacheEntry)

use rc_source to group, if set; fallback to rc_type

Class RecentChange

Deprecate access to mAttribs (direct or via getAttributes). Right now we're having to include both rc_comment and rc_comment_text/rc_comment_data so random crap works right.

Member ChangeTags::MAX_DELETE_USES

Use the job queue for tag deletion to avoid this restriction

Member WikiRevision::$isTemp

Unused?

Class SquidPurgeClient

Consider using MultiHttpClient.

Member CommentStore::$stage

Deprecate and remove once extensions seem unlikely to need to use it for migration anymore.

Member Content::getTextForSearchIndex ()

Test that this actually works

Make sure this also works with LuceneSearch / WikiSearch

Member Content::getWikitextForTransclusion ()

Allow native handling, bypassing wikitext representation, like for includable special pages.

Allow transclusion into other content models than Wikitext!

Used in WikiPage and MessageCache to get message text. Not so nice. What should we use instead?!

Member ContentHandler::createDifferenceEngine (IContextSource $context, $old=0, $new=0, $rcid=0, $refreshCache=false, $unhide=false)

This is page-level functionality so it should not belong to ContentHandler. Move it to a better place once one exists (e.g. PageTypeHandler).

Member ContentHandler::getAutoDeleteReason (Title $title, &$hasHistory)

&$hasHistory is extremely ugly, it's here because WikiPage::getAutoDeleteReason() and Article::generateReason() have it / want it.

Member ContentHandler::getFieldsForSearchIndex (SearchEngine $engine)

Expose title, redirect, namespace, text, source_text, text_bytes field mappings here. (see T142670 and T143409)

Class JavaScriptContentHandler

Create a ScriptContentHandler base class, do highlighting stuff there?

Member MWLBFactory::getLBFactoryClass (array $config)

instead of this, use a ServiceContainer for managing the different implementations.

Member $wgHashedUploadDirectory

Deprecate the setting and ultimately remove it from Core.

Member $wgFooterIcons

Reformat documentation.

Member OutputPage::disallowUserJs ()

this should be given a more accurate name

Member ExifBitmapHandler::getRotationForExif ( $data)

FIXME: Orientation can include flipping as well; see if this is an issue!

Member GIFHandler::getImageArea ( $image)

Add unit tests

Member IPTC::timeHelper ( $date, $time, $charset)

Potentially this should also capture the timezone offset.

Member MediaHandler::formatMetadata ( $image, $context=false)

FIXME: This interface is not very flexible.

Member TransformationalImageHandler::getClientScalingThumbnailImage ( $image, $scalerParams)

FIXME: No rotation support

Member MergeHistory::merge (User $user, $reason='')

if all versions of page A are moved to B and then a user tries to do a reverse-merge via the "unmerge" log link, then page A will still be a redirect (as it was after the original merge), though it will have the old revisions back from before (as expected). The user may have to "undo" the redirect manually to finish the "unmerge". Maybe this should delete redirects at the source page of merges?

Member MovePage::moveToInternal (User $user, &$nt, $reason='', $createRedirect=true, array $changeTags=[])

This was basically directly moved from Title, it should be split into smaller functions

Class MediaWiki\Navigation\PrevNextNavigationRenderer

Use LinkTarget instead of Title

Member MediaWiki\OutputHandler::findUriExtension ()

As of 2018, this actually runs after autoloader in Setup.php, so WebRequest seems like a good place for this.

Class OutputPage

FIXME: Another class handles sending the whole page to the client.

document

Member OutputPage::$mScripts

We should split JS / CSS.

Member Exif::__construct ( $file, $byteOrder='')

FIXME: The following are broke: SubjectArea. Need to test the more obscure tags. DigitalZoomRatio = 0/0 is rejected. need to determine if that's valid. Possibly should treat 0/0 = 0. need to read exif spec on that.

Member OutputPage::parse ( $text, $linestart=true, $interface=false, $language=null)

The output is wrapped in a

Class Article

Move and rewrite code to an Action class

Member Article::$mContentObject

MCR: Remove in 1.33

Member Article::fetchContentObject ()

When is this null?

Member Article::getRobotPolicy ( $action, ParserOutput $pOutput=null)

actions other than 'view'

Member Article::confirmDelete ( $reason)

Move to another file?

Member ImagePage::makeMetadataTable ( $metadata)

FIXME: Bad interface, see note on MediaHandler::formatMetadata().

Member MediaWiki\Page\MovePageFactory::$constructorOptions

Make this a const when we drop HHVM support (T192166)

Member PageArchive::listFiles ()

Does this belong in Image for fuller encapsulation?

Member WikiPage::getActionOverrides ()

Move this UI stuff somewhere else

Member WikiPage::insertOn ( $dbw, $pageId=null)

Factor out into a PageStore service, to be used by PageUpdater.

Member WikiPage::updateRevisionOn ( $dbw, $revision, $lastRevision=null, $lastRevIsRedirect=null)

Factor out into a PageStore service, or move into PageUpdater.

Member MimeAnalyzer::getMediaType ( $path=null, $mime=null)

analyse file if need be

look at multiple extension, separately and together.

Member PostgresUpdater::getCoreUpdateList ()

FIXME: Postgres should use sequential updates like Mysql, Sqlite and everybody else.

Class Message

• test, can we have tests?
• this documentation needs to be extended

Member Message::isBlank ()

FIXME: Merge with isDisabled()?

Member Cookie::validateCookieDomain ( $domain, $originDomain=null)

fixme fails to detect 3-letter top-level domains

fixme fails to detect 2-letter top-level domains for single-domain use (probably not a big problem in practice, but there are test cases)

Member TempFSFile::getUsableTempDirectory ()

Is there any useful way to test this? Would it be useful to make this non-static on TempFSFileFactory?

Member Wikimedia\Http\HttpAcceptParser::parseWeights ( $rawHeader)

If additional type parameters are present, ignore them cleanly. At present, they often confuse the result.

Member MultiHttpClient::runMultiHttp (array $reqs, array $opts=[])

Remove dependency on MediaWikiServices: use a separate HTTP client library or copy code from PhpHttpRequest

Class HttpStatus

document

Member DBLockManager::getLocksOnServer ( $lockSrv, array $pathsByType)

change this code to work in one batch

File IEContentAnalyzer.php

Define the exact license of this file.

Member MimeAnalyzer::isRecognizableExtension ( $extension)

Be more accurate when using fancy MIME detector plugins; right now this is the bare minimum getimagesize() list.

Member MimeAnalyzer::doGuessMimeType ( $file, $ext)

Remove $ext param

Member Cite::DEFAULT_GROUP

document

Member Wikimedia\Rdbms\DatabasePostgres::nativeInsertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[], $selectJoinConds=[])

FIXME: Implement this a little better (separate select/insert)?

Class SwiftVirtualRESTService

caching support (APC/memcached)

Member MediaWiki\Linker\LinkRenderer::normalizeTarget (LinkTarget $target)

move the code from Linker actually here

Class Linker

turn this into a legacy interface for HtmlPageLinkRenderer and similar services.

Member Linker::makeMediaLinkFile (LinkTarget $title, $file, $html='')

Handle invalid or missing images better.

Member Linker::formatLinksInComment ( $comment, $title=null, $local=false, $wikiId=null)

FIXME: Doesn't handle sub-links as in image thumb texts like the main parser

Class LinkFilter

implement the filter. Currently these are just some functions to help maintenance/cleanupSpam.php remove links to a single specified domain. The next thing is to implement functions for checking a given page against a big list of domains.

Member LinkFilter::makeRegex ( $filterEntry, $protocol)

This doesn't match the rest of the functionality here.

Member LogPage::getTitleLink ( $type, $lang, $title, &$params)

Document

Class BitmapMetadataHandler

Other image formats.

Member BitmapMetadataHandler::Tiff ( $filename)

Add XMP support, so this function actually makes sense to put here.