Elgg / Elgg

mod/groups/classes/Elgg/Groups/Upgrades/GroupIconTransfer.php

<?php

namespace Elgg\Groups\Upgrades;

use Elgg\Upgrade\Batch;
use Elgg\Upgrade\Result;

/**
 * Moves group icons owned by user to directory owned by the groups itself.
 *
 * BEFORE: /dataroot/<bucket>/<owner_guid>/groups/<group_guid><size>.jpg
 * AFTER:  /dataroot/<bucket>/<group_guid>/icons/icon/<size>.jpg
 */
class GroupIconTransfer implements Batch {

	public function getVersion() {
		return 2016101900;
	}

	public function needsIncrementOffset() {
		return true;
	}

	/**
	 * {@inheritdoc}
	 */
	public function shouldBeSkipped() {
		$groups = elgg_get_entities([
			'types' => 'group',
			'metadata_names' => 'icontime',
		]);

		if (empty($groups)) {
			return true;
		}

		$group = array_pop($groups);

		$sizes = elgg_get_icon_sizes('group', $group->getSubtype());

		$dataroot = elgg_get_config('dataroot');
		$dir = (new \Elgg\EntityDirLocator($group->owner_guid))->getPath();
		$prefix = 'groups/';

		// Check whether there are icons that are still saved under the
		// group's owner instead of the group itself.
		foreach ($sizes as $size => $opts) {
			if ($size == 'original') {
				$filename = "{$group->guid}.jpg";
			} else {
				$filename = "{$group->guid}{$size}.jpg";
			}
			$filestorename = "{$dataroot}{$dir}{$prefix}{$filename}";
			if (file_exists($filestorename)) {
				// A group icon was found meaning that the upgrade is needed.
				return false;
			}
		}

		return true;
	}

	/**
	 * {@inheritdoc}
	 */
	public function countItems() {
		return elgg_get_entities([

The expression return elgg_get_entities(array('types' => 'group', 'count' => true)) also could return the type ElggEntity[]|false which is incompatible with the return type mandated by Elgg\Upgrade\Batch::countItems() of integer.

			'types' => 'group',
			'count' => true,
		]);
	}

	/**
	 * {@inheritdoc}
	 */
	public function run(Result $result, $offset) {

		$groups = elgg_get_entities([
			'types' => 'group',
			'offset' => $offset,
			'limit' => 10,
		]);

		foreach ($groups as $group) {
			$result = $this->transferIcons($group, $result);
		}

		return $result;
	}

	/**
	 * Transfer group icons to new filestore location
	 * Before 3.0, group icons where owned by the group owner
	 * and located in /groups/<guid><size>.jpg
	 * relative to group owner's filestore directory
	 * In 3.0, we are moving these to default filestore location
	 * relative to group's filestore directory
	 *
	 * @param \ElggGroup $group  Group entity
	 * @param Result     $result Upgrade result
	 * @return Result
	 */
	public function transferIcons(\ElggGroup $group, Result $result) {

		$sizes = elgg_get_icon_sizes('group', $group->getSubtype());

		$dataroot = elgg_get_config('dataroot');
		$dir = (new \Elgg\EntityDirLocator($group->owner_guid))->getPath();
		$prefix = 'groups/';

		foreach ($sizes as $size => $opts) {
			if ($size == 'original') {
				$filename = "{$group->guid}.jpg";
			} else {
				$filename = "{$group->guid}{$size}.jpg";
			}
			$filestorename = "{$dataroot}{$dir}{$prefix}{$filename}";
			if (!file_exists($filestorename)) {
				// nothing to move
				continue;
			}

			$icon = $group->getIcon($size);

			// before transferring the file, we need to make sure
			// the directory structure of the new filestore location exists
			$icon->open('write');
			$icon->close();

			if (!rename($filestorename, $icon->getFilenameOnFilestore())) {
				$result->addError("
					Failed to transfer file from '$filestorename'
					to {$icon->getFilenameOnFilestore()}
				");
				$error = true;
			}
		}

		if ($error) {
			$result->addFailures();
		} else {
			$result->addSuccesses();
		}

		return $result;
	}

}