RightsLogFormatter.php

Go to the documentation of this file.

<?php
class RightsLogFormatter extends LogFormatter {
    protected function makePageLink( Title $title = null, $parameters = [], $html = null ) {
        global $wgContLang, $wgUserrightsInterwikiDelimiter;

        if ( !$this->plaintext ) {
            $text = $wgContLang->ucfirst( $title->getDBkey() );
            $parts = explode( $wgUserrightsInterwikiDelimiter, $text, 2 );

            if ( count( $parts ) === 2 ) {
                $titleLink = WikiMap::foreignUserLink(
                    $parts[1],
                    $parts[0],
                    htmlspecialchars(
                        strtr( $parts[0], '_', ' ' ) .
                        $wgUserrightsInterwikiDelimiter .
                        $parts[1]
                    )
                );

                if ( $titleLink !== false ) {
                    return $titleLink;
                }
            }
        }

        return parent::makePageLink( $title, $parameters, $title ? $title->getText() : null );
    }

    protected function getMessageKey() {
        $key = parent::getMessageKey();
        $params = $this->getMessageParameters();
        if ( !isset( $params[3] ) && !isset( $params[4] ) ) {
            // Messages: logentry-rights-rights-legacy
            $key .= '-legacy';
        }

        return $key;
    }

    protected function getMessageParameters() {
        $params = parent::getMessageParameters();

        // Really old entries
        if ( !isset( $params[3] ) && !isset( $params[4] ) ) {
            return $params;
        }

        $oldGroups = $this->makeGroupArray( $params[3] );
        $newGroups = $this->makeGroupArray( $params[4] );

        $userName = $this->entry->getTarget()->getText();
        if ( !$this->plaintext && count( $oldGroups ) ) {
            foreach ( $oldGroups as &$group ) {
                $group = User::getGroupMember( $group, $userName );
            }
        }
        if ( !$this->plaintext && count( $newGroups ) ) {
            foreach ( $newGroups as &$group ) {
                $group = User::getGroupMember( $group, $userName );
            }
        }

        $lang = $this->context->getLanguage();
        if ( count( $oldGroups ) ) {
            $params[3] = $lang->listToText( $oldGroups );
        } else {
            $params[3] = $this->msg( 'rightsnone' )->text();
        }
        if ( count( $newGroups ) ) {
            // Array_values is used here because of T44211
            // see use of array_unique in UserrightsPage::doSaveUserGroups on $newGroups.
            $params[4] = $lang->listToText( array_values( $newGroups ) );
        } else {
            $params[4] = $this->msg( 'rightsnone' )->text();
        }

        $params[5] = $userName;

        return $params;
    }

    protected function getParametersForApi() {
        $entry = $this->entry;
        $params = $entry->getParameters();

        static $map = [
            '4:array:oldgroups',
            '5:array:newgroups',
            '4::oldgroups' => '4:array:oldgroups',
            '5::newgroups' => '5:array:newgroups',
        ];
        foreach ( $map as $index => $key ) {
            if ( isset( $params[$index] ) ) {
                $params[$key] = $params[$index];
                unset( $params[$index] );
            }
        }

        // Really old entries does not have log params
        if ( isset( $params['4:array:oldgroups'] ) ) {
            $params['4:array:oldgroups'] = $this->makeGroupArray( $params['4:array:oldgroups'] );
        }
        if ( isset( $params['5:array:newgroups'] ) ) {
            $params['5:array:newgroups'] = $this->makeGroupArray( $params['5:array:newgroups'] );
        }

        return $params;
    }

    public function formatParametersForApi() {
        $ret = parent::formatParametersForApi();
        if ( isset( $ret['oldgroups'] ) ) {
            ApiResult::setIndexedTagName( $ret['oldgroups'], 'g' );
        }
        if ( isset( $ret['newgroups'] ) ) {
            ApiResult::setIndexedTagName( $ret['newgroups'], 'g' );
        }
        return $ret;
    }

    private function makeGroupArray( $group ) {
        // Migrate old group params from string to array
        if ( $group === '' ) {
            $group = [];
        } elseif ( is_string( $group ) ) {
            $group = array_map( 'trim', explode( ',', $group ) );
        }
        return $group;
    }
}