owncloud/core

<?php
/**
 * @author Jörn Friedrich Dreyer <jfd@butonic.de>
 * @author Vincent Petry <pvince81@owncloud.com>
 *
 * @copyright Copyright (c) 2018, ownCloud GmbH
 * @license AGPL-3.0
 *
 * This code is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License, version 3,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License, version 3,
 * along with this program.  If not, see <http://www.gnu.org/licenses/>
 *
 */
namespace OC\Repair;

use OC\Files\Node\File;
use OC\NotSquareException;
use OC\User\NoUserException;
use OCP\Files\Folder;
use OCP\Files\IRootFolder;
use OCP\IDBConnection;
use OCP\IL10N;
use OCP\ILogger;
use OCP\IUserManager;
use OCP\Migration\IOutput;
use OCP\Migration\IRepairStep;
use OCP\IUser;
use OC\Avatar;
use OCP\IConfig;
use OCP\IAvatarManager;
use OCP\Files\NotFoundException;

/**
 * Move avatars outside of their homes to the new location
 *
 * @package OC\Repair
 */
class MoveAvatarOutsideHome implements IRepairStep {
    /** @var \OCP\IConfig */
    protected $config;

    /** @var IDBConnection */
    private $connection;

    /** @var IUserManager */
    private $userManager;

    /** @var IAvatarManager */
    private $avatarManager;

    /** @var IRootFolder */
    private $rootFolder;

    /** @var \OCP\ILogger */
    private $logger;

    /** @var \OCP\IL10N */
    private $l;

    /**
     * @param IConfig $config config
     * @param IDBConnection $connection database connection
     * @param IUserManager $userManager user manager
     * @param IAvatarManager $avatarManager
     * @param IRootFolder $rootFolder
     * @param IL10N $l10n
     * @param ILogger $logger
     */
    public function __construct(
        IConfig $config,
        IDBConnection $connection,
        IUserManager $userManager,
        IAvatarManager $avatarManager,
        IRootFolder $rootFolder,
        IL10N $l10n,
        ILogger $logger
    ) {
        $this->config = $config;
        $this->connection = $connection;
        $this->userManager = $userManager;
        $this->avatarManager = $avatarManager;
        $this->rootFolder = $rootFolder;
        $this->l = $l10n;
        $this->logger = $logger;
    }

    /**
     * @return string
     */
    public function getName() {
        return 'Move user avatars outside the homes to the new location';
    }

    /**
     * Move avatars outside of their homes
     *
     * @param IOutput $out
     * @param IUser $user
     */
    private function moveAvatars(IOutput $out, IUser $user) {
        $userId = $user->getUID();

        try {
            \OC\Files\Filesystem::initMountPoints($userId);

            /** @var File $oldAvatarFile */
            $oldAvatarFile = null;

            // call get instead of getUserFolder to avoid needless skeleton copy
            /** @var Folder $oldAvatarFolder */
            $oldAvatarFolder = $this->rootFolder->get('/' . $userId . '/avatars/');
            '@phan-var \OCP\Files\Folder $oldAvatarFolder';
            try {
                $oldAvatarFile = $oldAvatarFolder->get('/avatar.jpg');
            } catch (NotFoundException $e) {
                $oldAvatarFile = $oldAvatarFolder->get('/avatar.png');
            }
            '@phan-var \OC\Files\Node\File $oldAvatarFile';
            $newAvatarStorage = $this->rootFolder->get('/avatars/')->getStorage();
            $avatar = new Avatar($newAvatarStorage, $this->l, $user, $this->logger);
            $avatar->set($oldAvatarFile->getContent());
            $oldAvatarFile->delete();
        } catch (NoUserException $e) {
            $this->logger->warning("Skipping avatar move for $userId: User does not exist.", ['app' => __METHOD__]);
        } catch (NotFoundException $e) {
            // not all users have a home, ignore
            $this->logger->debug("Skipping avatar move for $userId: User has no home or avatar folder.", ['app' => __METHOD__]);
        } catch (NotSquareException $e) {
            $this->logger->warning("Skipping avatar move for $userId: avatar image {$oldAvatarFile->getPath()} for user $userId is not square.", ['app' => __METHOD__]);
        } catch (\Exception $e) {
            $this->logger->logException($e, ['app' => __METHOD__, 'message' => "Skipping avatar move for $userId"]);
        }

        \OC_Util::tearDownFS();
    }

    /**
     * @param IOutput $output
     */
    public function run(IOutput $output) {
        $ocVersionFromBeforeUpdate = $this->config->getSystemValue('version', '0.0.0');
        $avatarMigrationStatus = $this->config->getAppValue('core', 'avatar_migration_completed', 'false');
        if (($avatarMigrationStatus === 'false') &&
            \version_compare($ocVersionFromBeforeUpdate, '9.2.0.2', '<')) {
            $function = function (IUser $user) use ($output) {
                $this->moveAvatars($output, $user);
                $output->advance();
            };

            $output->startProgress($this->userManager->countSeenUsers());

            $this->userManager->callForSeenUsers($function);

            //Set this if repair step is executed
            $this->config->setAppValue('core', 'avatar_migration_completed', 'true');

            $output->finishProgress();
        } else {
            $output->info("No action required");
        }
    }
}