TranslateSandbox.php

Go to the documentation of this file.

<?php
class TranslateSandbox {
    public static function addUser( $name, $email, $password ) {
        $user = User::newFromName( $name, 'creatable' );
        if ( !$user instanceof User ) {
            throw new MWException( "Invalid user name" );
        }

        $user->setEmail( $email );
        $user->setPassword( $password );
        $status = $user->addToDatabase();

        if ( !$status->isOK() ) {
            throw new MWException( $status->getWikiText() );
        }

        // Need to have an id first
        $user->addGroup( 'translate-sandboxed' );
        $user->clearInstanceCache( 'name' );

        return $user;
    }

    public static function deleteUser( User $user ) {
        $uid = $user->getId();

        if ( !self::isSandboxed( $user ) ) {
            throw new MWException( "Not a sandboxed user" );
        }

        $dbw = wfGetDB( DB_MASTER );
        $dbw->delete( 'user', array( 'user_id' => $uid ), __METHOD__ );
        $dbw->delete( 'user_groups', array( 'ug_user' => $uid ), __METHOD__ );

        $user->clearInstanceCache( 'defaults' );
        // @todo why the bunny is this private?!
        // $user->clearSharedCache();
        global $wgMemc;
        $wgMemc->delete( wfMemcKey( 'user', 'id', $uid ) );
    }

    public static function getUsers() {
        $dbw = wfGetDB( DB_MASTER );
        $tables = array( 'user', 'user_groups' );
        $fields = User::selectFields();
        $conds = array(
            'ug_group' => 'translate-sandboxed',
            'ug_user = user_id',
        );

        $res = $dbw->select( $tables, $fields, $conds, __METHOD__ );

        return UserArray::newFromResult( $res );
    }

    public static function promoteUser( User $user ) {
        global $wgTranslateSandboxPromotedGroup;

        if ( !self::isSandboxed( $user ) ) {
            throw new MWException( "Not a sandboxed user" );
        }

        $user->removeGroup( 'translate-sandboxed' );
        if ( $wgTranslateSandboxPromotedGroup ) {
            $user->addGroup( $wgTranslateSandboxPromotedGroup );
        }
    }

    public static function sendReminder( User $sender, User $target, $subject, $body ) {
        global $wgNoReplyAddress;

        if ( !self::isSandboxed( $user ) ) {
            throw new MWException( "Not a sandboxed user" );
        }

        $params = array(
            'user' => $target->getId(),
            'to' => $target->getEmail(),
            'from' => $sender->getEmail(),
            'replyto' => $wgNoReplyAddress,
            'subj' => $subject,
            'body' => $body,
        );

        TranslateSandboxReminderJob::newJob( $params )->insert();
    }

    public static function isSandboxed( User $user ) {
        if ( in_array( 'translate-sandboxed', $user->getGroups(), true ) ) {
            return true;
        }

        return false;
    }

    public static function enforcePermissions( User $user, array &$rights ) {
        global $wgTranslateUseSandbox;

        if ( !$wgTranslateUseSandbox ) {
            return true;
        }

        if ( !self::isSandboxed( $user ) ) {
            return true;
        }

        $rights = array( 'read', 'translate-sandboxaction', 'readapi', 'writeapi', 'editmyoptions' );

        // Do not let other hooks add more actions
        return false;
    }

    public static function onGetPreferences( $user, &$preferences ) {
        $preferences['translate-sandbox'] = $preferences['translate-sandbox-reminders'] =
            array( 'type' => 'api' );

        return true;
    }

    public static function onApiCheckCanExecute( ApiBase $module, User $user, &$message ) {
        $whitelist = array(
            // Obviously this is needed to get out of the sandbox
            'ApiTranslationStash',
            // Used by UniversalLanguageSelector for example
            'ApiOptions'
        );

        if ( TranslateSandbox::isSandboxed( $user ) ) {
            $class = get_class( $module );
            if ( $module->isWriteMode() && !in_array( $class, $whitelist, true ) ) {
                $message = 'writerequired';
                return false;
            }
        }

        return true;
    }
}