Seeding::populateMetadata() - Code Metrics - Inspection of "Merge pull request #11162 from hypeJunction/seedin..." - Elgg/Elgg - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 5c1b24...3c7f00 )

by Ismayil
created 2017-08-15 15:24 UTC
Seeding::populateMetadata() C

↳ Parent: Seeding
Complexity

Conditions	17
Paths	32
Size

Total Lines	74
Code Lines	52
Duplication

Lines	10
Ratio	13.51 %
Importance

Changes
Metric	Value
cc	17
eloc	52
nc	32
nop	3
dl	10
loc	74
rs	5.3488
c	0
b	0
f	0
How to fix Long Method Complexity

<?php
/**
 *
 */

namespace Elgg\Database\Seeds;

use ElggEntity;
use ElggGroup;
use ElggObject;
use ElggUser;
use Exception;
use Faker\Factory;

/**
 * Seeding trait
 * Can be used to easily create new random users, groups and objects in the database
 *
 * @access private
 */
trait Seeding {

	/**
	 * @var int Max number of items to be created by the seed
	 */
	protected $limit = 20;

	/**
	 * @var \Faker\Generator
	 */
	protected $faker;

	/**
	 * Returns an instance of faker
	 *
	 * @param string $locale Locale
	 *
	 * @return \Faker\Generator
	 */
	public function faker($locale = 'en_US') {
		if (!isset($this->faker)) {
			$this->faker = Factory::create($locale);
		}

		return $this->faker;
	}

	/**
	 * Get site domain
	 * @return string
	 */
	public function getDomain() {
		return elgg_get_site_entity()->getDomain();
	}

	/**
	 * Get valid domain for emails
	 * @return string
	 */
	public function getEmailDomain() {
		$email = elgg_get_site_entity()->email;
		if (!$email) {
			$email = "noreply@{$this->getDomain()}";
		}

		list(, $domain) = explode('@', $email);

		if (sizeof(explode('.', $domain)) <= 1) {
			$domain = 'example.net';
		}

		return $domain;
	}

	/**
	 * Create a new faker user
	 *
	 * @param array $attributes User entity attributes
	 * @param array $metadata   User entity metadata
	 *
	 * @return ElggUser
	 */
	public function createUser(array $attributes = [], array $metadata = []) {

		$create = function () use ($attributes, $metadata) {
			$metadata['__faker'] = true;

			if (empty($attributes['password'])) {
				$attributes['password'] = generate_random_cleartext_password();
			}

			if (empty($attributes['username'])) {
				$attributes['name'] = $this->faker()->name;
			}

			if (empty($attributes['username'])) {
				$attributes['username'] = $this->getRandomUsername($attributes['name']);
			}

			if (empty($attributes['email'])) {
				$attributes['email'] = "{$attributes['username']}@{$this->getEmailDomain()}";
			}

			$user = false;

			try {
				$guid = register_user($attributes['username'], $attributes['password'], $attributes['name'], $attributes['email']);
				$user = get_entity($guid);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
				/* @var $user ElggUser */

				if (!$user) {
					throw new Exception("Unable to create new user with attributes: " . print_r($attributes, true));
				}

				if (isset($attributes['admin'])) {
					if ($attributes['admin']) {
						$user->makeAdmin();
					} else {
						$user->removeAdmin();
					}
				}

				if (isset($attributes['banned'])) {
					if ($attributes['banned']) {
						$user->ban('Banned by seeder');
					} else {
						$user->unban('Unbanned by seeder');

					}
				}

				elgg_set_user_validation_status($guid, $this->faker()->boolean(), 'seeder');
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

				$user->setNotificationSetting('email', false);
				$user->setNotificationSetting('site', true);

				$profile_fields = (array) elgg_get_config('profile_fields');

				$user = $this->populateMetadata($user, $profile_fields, $metadata);

				$user->save();

				$this->log("Created new user $user->name [guid: $user->guid]");

				return $user;
			} catch (\RegistrationException $e) {
				if ($user && $user->guid) {
					$user->delete();
				}

				$attr_log = print_r($attributes, true);
				$this->log("User creation failed with message {$e->getMessage()} [attributes: $attr_log]");

				return false;
			}
		};

		$ia = elgg_set_ignore_access(true);

		$user = false;
		while (!$user instanceof \ElggUser) {
			$user = $create();
		}

		elgg_set_ignore_access($ia);

		return $user;

	}

	/**
	 * Create a new faker group
	 *
	 * @param array $attributes Group entity attributes
	 * @param array $metadata   Group entity metadata
	 *
	 * @return ElggGroup
	 */
	public function createGroup(array $attributes = [], array $metadata = []) {

		$create = function () use ($attributes, $metadata) {
			$metadata['__faker'] = true;

			if (empty($attributes['access_id'])) {
				$attributes['access_id'] = ACCESS_PUBLIC;
			}

			if (empty($metadata['content_access_mode'])) {
				$metadata['content_access_mode'] = ElggGroup::CONTENT_ACCESS_MODE_UNRESTRICTED;
			}

			if (empty($metadata['membership'])) {
				$metadata['membership'] = ACCESS_PUBLIC;
			}

			if (empty($attributes['name'])) {
				$attributes['name'] = $this->faker()->sentence();
			}

			if (empty($attributes['description'])) {

				$attributes['description'] = $this->faker()->text($this->faker()->numberBetween(500, 1000));
			}

			if (empty($attributes['owner_guid'])) {
				$user = $this->getRandomUser();
				if (!$user) {
					$user = $this->createUser();
				}

				$attributes['owner_guid'] = $user->guid;
			}

			if (empty($attributes['container_guid'])) {
				$attributes['container_guid'] = $attributes['owner_guid'];
			}

			$owner = get_entity($attributes['owner_guid']);
			if (!$owner) {
				return false;
			}

			$container = get_entity($attributes['container_guid']);
			if (!$container) {
				return false;
			}

			$tool_options = elgg_get_config('group_tool_options');
			if ($tool_options) {
				foreach ($tool_options as $group_option) {
					$option_toggle_name = $group_option->name . "_enable";
					$option_default = $group_option->default_on ? 'yes' : 'no';
					$metadata[$option_toggle_name] = $option_default;
				}
			}

			if ($this->faker()->boolean(20)) {
				$metadata['featured_group'] = 'yes';
			}

			$group = new ElggGroup();
			foreach ($attributes as $name => $value) {
				$group->$name = $value;
			}

			$profile_fields = (array) elgg_get_config('group');
			$group = $this->populateMetadata($group, $profile_fields, $metadata);

			$group->save();

			if ($group->access_id == ACCESS_PRIVATE) {
				$group->access_id = $group->group_acl;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
				$group->save();
			}

			$group->join(get_entity($attributes['owner_guid']));

			elgg_create_river_item([
				'view' => 'river/group/create',
				'action_type' => 'create',
				'subject_guid' => $owner->guid,
				'object_guid' => $group->guid,
				'target_guid' => $container->guid,
			]);

			$this->log("Created new group $group->name [guid: $group->guid]");

			return $group;
		};

		$ia = elgg_set_ignore_access(true);

		$group = false;
		while (!$group instanceof \ElggGroup) {
			$group = $create();
		}

		elgg_set_ignore_access($ia);

		return $group;
	}

	/**
	 * Create a new faker object
	 *
	 * @param array $attributes Object entity attributes
	 * @param array $metadata   Object entity metadata
	 *
	 * @return ElggObject
	 */
	public function createObject(array $attributes = [], array $metadata = []) {

		$create = function () use ($attributes, $metadata) {
			$metadata['__faker'] = true;

			if (empty($attributes['title'])) {
				$attributes['title'] = $this->faker()->sentence();
			}

			if (empty($attributes['description'])) {

				$attributes['description'] = $this->faker()->text($this->faker()->numberBetween(500, 1000));
			}

			if (empty($attributes['container_guid'])) {
				if ($this->faker()->boolean()) {
					$container = $this->getRandomGroup();
					if (!$container) {
						$container = $this->createGroup();
					}
				} else {
					$container = $this->getRandomUser();
					if (!$container) {
						$container = $this->createUser();
					}
				}

				$attributes['container_guid'] = $container->guid;
			}

			if (empty($attributes['subtype'])) {
				$attributes['subtype'] = strtolower($this->faker()->word);
			}

			if (empty($metadata['tags'])) {
				$metadata['tags'] = $this->faker()->words(10);
			}

			if (empty($attributes['owner_guid'])) {
				if ($container instanceof ElggGroup) {
					$members = elgg_get_entities_from_relationship([
						'types' => 'user',
						'relationship' => 'member',
						'relationship_guid' => $container->guid,
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
						'inverse_relationship' => true,
						'limit' => 1,
						'metadata_names' => '__faker',
						'order_by' => 'RAND()',
					]);
					$owner = array_shift($members);
				} else {
					$owner = $container;
				}

				$attributes['owner_guid'] = $owner->guid;
			}

			$owner = get_entity($attributes['owner_guid']);
			if (!$owner) {
				return false;
			}

			$container = get_entity($attributes['container_guid']);
			if (!$container) {
				return false;
			}

			if (empty($attributes['access_id'])) {
				//$attributes['access_id'] = $this->getRandomAccessId($owner, $container);
				$attributes['access_id'] = ACCESS_PUBLIC;
			}

			$class = get_subtype_class('object', $attributes['subtype']);
			if ($class && class_exists($class)) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
				$object = new $class();
			} else {
				$object = new ElggObject();
			}
			foreach ($attributes as $name => $value) {
				$object->$name = $value;
			}

			$object = $this->populateMetadata($object, [], $metadata);

			$object->save();

			$type_str = elgg_echo("item:object:{$object->getSubtype()}");

			$this->log("Created new item in $type_str $object->title [guid: $object->guid]");

			return $object;
		};

		$ia = elgg_set_ignore_access(true);

		$object = false;
		while (!$object instanceof \ElggObject) {
			$object = $create();
		}

		elgg_set_ignore_access($ia);

		return $object;

	}

	/**
	 * Returns random fake user
	 *
	 * @param int[] $exclude GUIDs to exclude
	 *
	 * @return ElggUser|false
	 */
	public function getRandomUser(array $exclude = []) {


		$exclude[] = 0;
		$exclude_in = implode(',', array_map(function ($e) {
			return (int) $e;
		}, $exclude));

		$users = elgg_get_entities_from_metadata([
			'types' => 'user',
			'metadata_names' => ['__faker'],
			'limit' => 1,
			'wheres' => [
				"e.guid NOT IN ($exclude_in)",
			],
			'order_by' => 'RAND()',
		]);

		return $users ? $users[0] : false;
	}

	/**
	 * Returns random fake group
	 *
	 * @param int[] $exclude GUIDs to exclude
	 *
	 * @return ElggGroup|false
	 */
	public function getRandomGroup(array $exclude = []) {


		$exclude[] = 0;
		$exclude_in = implode(',', array_map(function ($e) {
			return (int) $e;
		}, $exclude));

		$groups = elgg_get_entities_from_metadata([
			'types' => 'group',
			'metadata_names' => ['__faker'],
			'limit' => 1,
			'wheres' => [
				"e.guid NOT IN ($exclude_in)",
			],
			'order_by' => 'RAND()',
		]);

		return $groups ? $groups[0] : false;
	}

	/**
	 * Get random access id
	 *
	 * @param ElggUser   $user      User
	 * @param ElggEntity $container Container
	 *
	 * @return int
	 */
	public function getRandomAccessId(\ElggUser $user = null, ElggEntity $container = null) {

		$params = [
			'container_guid' => $container->guid,
		];

		$access_array = get_write_access_array($user->guid, null, null, $params);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

		$access_key = array_rand($access_array, 1);

		return $access_array[$access_key];
	}

	/**
	 * Generates a unique available and valid username
	 *
	 * @param string $base_name Display name, email or other prefix to use as basis
	 *
	 * @return string
	 */
	public function getRandomUsername($base_name = 'user') {

		$available = false;

		$base_name = iconv('UTF-8', 'ASCII//TRANSLIT', $base_name);
		$blacklist = '/[\x{0080}-\x{009f}\x{00a0}\x{2000}-\x{200f}\x{2028}-\x{202f}\x{3000}\x{e000}-\x{f8ff}]/u';
		$blacklist2 = [
			' ',
			'\'',
			'/',
			'\\',
			'"',
			'*',
			'&',
			'?',
			'#',
			'%',
			'^',
			'(',
			')',
			'{',
			'}',
			'[',
			']',
			'~',
			'?',
			'<',
			'>',
			';',
			'|',
			'¬',
			'`',
			'@',
			'-',
			'+',
			'='
		];

		$base_name = preg_replace($blacklist, '', $base_name);
		$base_name = str_replace($blacklist2, '', $base_name);
		$base_name = str_replace('.', '_', $base_name);

		$ia = elgg_set_ignore_access(true);

		$ha = access_get_show_hidden_status();
		access_show_hidden_entities(true);

		$minlength = elgg_get_config('minusername') ? : 4;
		if ($base_name) {
			$fill = $minlength - strlen($base_name);
		} else {
			$fill = 8;
		}

		$separator = '';

		if ($fill > 0) {
			$suffix = (new ElggCrypto())->getRandomString($fill);
			$base_name = "$base_name$separator$suffix";
		}

		$iterator = 0;
		while (!$available) {
			if ($iterator > 0) {
				$base_name = "$base_name$separator$iterator";
			}
			$user = get_user_by_username($base_name);
			$available = !$user;
			try {
				if ($available) {
					validate_username($base_name);
				}
			} catch (\Exception $e) {
				if ($iterator >= 10) {
					// too many failed attempts
					$base_name = (new ElggCrypto())->getRandomString(8);
				}
			}

			$iterator++;
		}

		access_show_hidden_entities($ha);
		elgg_set_ignore_access($ia);

		return strtolower($base_name);
	}

	/**
	 * Set random metadata
	 *
	 * @param ElggEntity $entity   Entity
	 * @param array      $fields   An array of profile fields in $name => $input_type format
	 * @param array      $metadata Other metadata $name => $value pairs to set
	 *
	 * @return ElggEntity
	 */
	public function populateMetadata(ElggEntity $entity, array $fields = [], array $metadata = []) {

		foreach ($fields as $name => $type) {
			if (isset($metadata[$name])) {
				continue;
			}

			switch ($name) {
				case 'phone' :
				case 'mobile' :
					$metadata[$name] = $this->faker()->phoneNumber;
					break;

				default :
					switch ($type) {
						case 'plaintext' :
						case 'longtext' :
							$metadata[$name] = $this->faker()->text($this->faker()->numberBetween(500, 1000));
							break;

						case 'text' :
							$metadata[$name] = $this->faker()->sentence;
							break;

						case 'tags' :
							$metadata[$name] = $this->faker()->words(10);
							break;

						case 'url' :
							$metadata[$name] = $this->faker()->url;

						case 'email' :
							$metadata[$name] = $this->faker()->email;
							break;

						case 'number' :
							$metadata[$name] = $this->faker()->randomNumber();
							break;

						case 'date' :
							$metadata[$name] = $this->faker()->unixTime;
							break;

						case 'password' :
							$metadata[$name] = generate_random_cleartext_password();
							break;

						case 'location' :

							$metadata[$name] = $this->faker()->address;
							$metadata['geo:lat'] = $this->faker()->latitude;
							$metadata['geo:long'] = $this->faker()->longitude;
							break;

						case 'email' :

							$metadata[$name] = $this->faker()->address;
							$metadata['geo:lat'] = $this->faker()->latitude;
							$metadata['geo:long'] = $this->faker()->longitude;
							break;

						default :
							$metadata[$name] = '';
							break;
					}

					break;
			}
		}

		foreach ($metadata as $key => $value) {
			$entity->$key = $value;
		}

		return $entity;
	}

	/**
	 * Create an icon for an entity
	 *
	 * @param ElggEntity $entity Entity
	 *
	 * @return bool
	 */
	public function createIcon(ElggEntity $entity) {

		$icon_url = $this->faker()->imageURL();

		$file_contents = file_get_contents($icon_url);

		$tmp = new \ElggFile();
		$tmp->owner_guid = $entity->guid;
		$tmp->setFilename("tmp/icon_src.jpg");
		$tmp->open('write');
		$tmp->write($file_contents);
		$tmp->close();

		$result = $entity->saveIconFromElggFile($tmp);

		$tmp->delete();

		if ($result && $entity instanceof ElggUser) {

			elgg_create_river_item([
				'view' => 'river/user/default/profileiconupdate',
				'action_type' => 'update',
				'subject_guid' => $entity->guid,
				'object_guid' => $entity->guid,
			]);
		}

		return $result;
	}

	/**
	 * Create comments/replies
	 *
	 * @param ElggEntity $entity Entity to comment on
	 * @param int        $limit  Number of comments to create
	 *
	 * @return int Number of generated comments
	 */
	public function createComments(ElggEntity $entity, $limit = null) {

		$ia = elgg_set_ignore_access(true);

		$tries = 0;
		$success = 0;

		if (!$limit) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
			$limit = $this->faker()->numberBetween(1, 20);
		}

		while ($tries < $limit) {
			$comment = new \ElggComment();
			$comment->subtype = $entity->getSubtype() == 'discussion' ? 'discussion_reply' : 'comment';
			$comment->owner_guid = $this->getRandomUser()->guid ? : $entity->owner_guid;
			$comment->container_guid = $entity->guid;
			$comment->description = $this->faker()->paragraph;

			$tries++;
			if ($comment->save()) {
				$success++;
			}
		}

		elgg_set_ignore_access($ia);

		return $success;

	}

	/**
	 * Create likes
	 *
	 * @param ElggEntity $entity Entity to like
	 * @param int        $limit  Number of likes to create
	 *
	 * @return int
	 */
	public function createLikes(ElggEntity $entity, $limit = null) {

		$ia = elgg_set_ignore_access(true);

		$success = 0;

		if (!$limit) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
			$limit = $this->faker()->numberBetween(1, 20);
		}

		while ($success < $limit) {
			if ($entity->annotate('likes', true, $entity->access_id, $this->getRandomUser()->guid)) {
				$success++;
			}
		}

		elgg_set_ignore_access($ia);

		return $success;
	}

	/**
	 * Log a message
	 *
	 * @param string $msg   Message to log
	 * @param string $level Message level
	 *                      Note that 'ERROR' will terminate further code execution
	 *
	 * @return void
	 */
	public function log($msg, $level = 'NOTICE') {
		elgg_log($msg, $level);
	}

}
1			<?php
2			/**
3			*
4			*/
5
6			namespace Elgg\Database\Seeds;
7
8			use ElggEntity;
9			use ElggGroup;
10			use ElggObject;
11			use ElggUser;
12			use Exception;
13			use Faker\Factory;
14
15			/**
16			* Seeding trait
17			* Can be used to easily create new random users, groups and objects in the database
18			*
19			* @access private
20			*/
21			trait Seeding {
22
23			/**
24			* @var int Max number of items to be created by the seed
25			*/
26			protected $limit = 20;
27
28			/**
29			* @var \Faker\Generator
30			*/
31			protected $faker;
32
33			/**
34			* Returns an instance of faker
35			*
36			* @param string $locale Locale
37			*
38			* @return \Faker\Generator
39			*/
40			public function faker($locale = 'en_US') {
Elgg / Elgg

Push — master ( 5c1b24...3c7f00 )

Seeding::populateMetadata() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Available Fixes

Duplication Side-by-Side

Filter issues like
