View source
<?php
namespace Drupal\commerce_generate\Plugin\DevelGenerate;
use Drupal\Core\Datetime\DateFormatterInterface;
use Drupal\Core\Entity\EntityStorageInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Language\LanguageInterface;
use Drupal\Core\Language\LanguageManagerInterface;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Drupal\Core\Routing\UrlGeneratorInterface;
use Drupal\devel_generate\DevelGenerateBase;
use Drush\Utils\StringUtils;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Field\FieldStorageDefinitionInterface;
use Drupal\commerce_price\Price;
use Drupal\commerce_bulk\BulkVariationsCreatorInterface;
use Drupal\Core\Session\UserSession;
class GenerateProducts extends DevelGenerateBase implements ContainerFactoryPluginInterface {
protected $storeStorage;
protected $productStorage;
protected $productTypeStorage;
protected $languageManager;
protected $urlGenerator;
protected $dateFormatter;
protected $creator;
protected $drushBatch;
public function __construct(array $configuration, $plugin_id, array $plugin_definition, EntityStorageInterface $store_storage, EntityStorageInterface $product_storage, EntityStorageInterface $product_type_storage, LanguageManagerInterface $language_manager, UrlGeneratorInterface $url_generator, DateFormatterInterface $date_formatter, BulkVariationsCreatorInterface $variations_creator) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
$this->storeStorage = $store_storage;
$this->productStorage = $product_storage;
$this->productTypeStorage = $product_type_storage;
$this->languageManager = $language_manager;
$this->urlGenerator = $url_generator;
$this->dateFormatter = $date_formatter;
$this->creator = $variations_creator;
}
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
$entity_manager = $container
->get('entity_type.manager');
return new static($configuration, $plugin_id, $plugin_definition, $entity_manager
->getStorage('commerce_store'), $entity_manager
->getStorage('commerce_product'), $entity_manager
->getStorage('commerce_product_type'), $container
->get('language_manager'), $container
->get('url_generator'), $container
->get('date.formatter'), $container
->get('commerce_bulk.variations_creator'));
}
public function settingsForm(array $form, FormStateInterface $form_state) {
$stores = $this->storeStorage
->loadMultiple();
if (empty($stores)) {
$create_url = $this->urlGenerator
->generateFromRoute('entity.commerce_store.add_page');
$this
->setMessage($this
->t('You do not have any stores to which generated products could be assigned. <a href=":create-type">Go create a new store</a>', [
':create-type' => $create_url,
]), 'error', FALSE);
return;
}
$types = $this->productTypeStorage
->loadMultiple();
if (empty($types)) {
$create_url = $this->urlGenerator
->generateFromRoute('entity.commerce_product_type.add_form');
$this
->setMessage($this
->t('You do not have any product types that can be generated. <a href=":create-type">Go create a new product type</a>', [
':create-type' => $create_url,
]), 'error', FALSE);
return;
}
$options = [];
foreach ($stores as $store) {
$options[$store
->id()] = [
'type' => [
'#markup' => $store
->label(),
],
'store_type' => [
'#markup' => $store
->bundle(),
],
];
}
$header = [
'type' => $this
->t('Assign products to stores'),
'store_type' => [
'data' => $this
->t('Machine name'),
'class' => [
RESPONSIVE_PRIORITY_MEDIUM,
],
],
];
$form['stores'] = [
'#prefix' => $this
->t('<h6>Select at least one of the stores below:</h6>'),
'#type' => 'tableselect',
'#header' => $header,
'#options' => $options,
];
$options = [];
foreach ($types as $type) {
$options[$type
->id()] = [
'type' => [
'#markup' => $type
->label(),
],
'variation_type' => [
'#markup' => $type
->getVariationTypeId(),
],
];
}
$header = [
'type' => $this
->t('Product type'),
'variation_type' => [
'data' => $this
->t('Machine name'),
'class' => [
RESPONSIVE_PRIORITY_MEDIUM,
],
],
];
$form['product_types'] = [
'#prefix' => $this
->t('<h6>Select at least one of the product types below:</h6>'),
'#type' => 'tableselect',
'#header' => $header,
'#options' => $options,
];
$form['kill'] = [
'#type' => 'checkbox',
'#title' => $this
->t('<strong>Delete ALL (<mark>sic!</mark>) products</strong> in the selected stores or of the selected product types before generating new ones. As an example you may delete all products belonging to a particular store by selecting this store (without product types) and setting the number of products to generate to 0 and then pressing the <strong>Generate</strong> button. By the way, the internal name of this checkbox is <strong>"kill"</strong> so, be careful when considering which products to delete. <mark>You are warned.</mark>'),
'#default_value' => $this
->getSetting('kill'),
];
$form['num'] = [
'#type' => 'number',
'#title' => $this
->t('The total number of products to generate.'),
'#default_value' => $this
->getSetting('num'),
'#required' => TRUE,
'#step' => 1,
'#min' => 0,
];
$form['max_nb_skus'] = [
'#type' => 'number',
'#title' => $this
->t('The maximum number of variations to generate per product.'),
'#description' => $this
->t('Leave empty to generate all possible variations.'),
'#default_value' => $this
->getSetting('max_nb_skus'),
'#required' => FALSE,
'#step' => 1,
'#min' => 2,
];
$form['shuffle_variations'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Shuffle variation combinations.'),
'#default_value' => $this
->getSetting('shuffle_variations'),
'#description' => $this
->t('Tick this checkbox if you want to randomize the order of the generated variations.'),
];
$form['batch'] = [
'#type' => 'number',
'#title' => $this
->t('The treshold for batch.'),
'#description' => $this
->t("The number of products at which to start a batch products' generating process instead of doing this in one go. Environments where the module works may differ, the structure of product types may differ even more. So, adjust the treshold for your needs, depending on capacity of the server and products you are going to generate."),
'#default_value' => $this
->getSetting('batch'),
'#required' => TRUE,
'#step' => 1,
'#min' => 2,
];
$form['title_prefix'] = [
'#type' => 'textfield',
'#title' => $this
->t('The title prefix'),
'#description' => $this
->t('The word to prepend to a randomly generated product title.'),
'#default_value' => $this
->getSetting('title_prefix'),
'#required' => TRUE,
];
$form['title_length'] = [
'#type' => 'number',
'#title' => $this
->t('Maximum number of words in titles'),
'#description' => $this
->t('Leave empty for no randomly generated words in title. Useful if you want generate one particular product for further use in production. Note that each product variation title will be prefixed with a product title so, use the title prefix field above to assign desirable title for a product and therefore title prefix for all its variations.'),
'#default_value' => $this
->getSetting('title_length'),
'#step' => 1,
'#min' => 1,
'#max' => 25,
];
$form['price_min'] = [
'#type' => 'number',
'#title' => $this
->t('The minimum of the randomly generated price.'),
'#default_value' => $this
->getSetting('price_min'),
'#step' => '0.01',
'#min' => '0.01',
];
$form['price_max'] = [
'#type' => 'number',
'#title' => $this
->t('The maximum of the randomly generated price.'),
'#default_value' => $this
->getSetting('price_max'),
'#step' => '0.01',
'#min' => '0.01',
];
$form['list_price_min'] = [
'#type' => 'number',
'#title' => $this
->t('The minimum of the randomly generated list price. Leave empty for no list price.'),
'#default_value' => $this
->getSetting('price_min'),
'#step' => '0.01',
'#min' => '0',
];
$form['list_price_max'] = [
'#type' => 'number',
'#title' => $this
->t('The maximum of the randomly generated list price. Leave empty for no list price.'),
'#default_value' => $this
->getSetting('price_max'),
'#step' => '0.01',
'#min' => '0',
];
$form['price_per_variation'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Set random price per variation instead of per product basis.'),
'#default_value' => $this
->getSetting('price_per_variation'),
];
$form['price_number'] = [
'#type' => 'value',
'#value' => '1.00',
];
$form['owner'] = [
'#type' => 'commerce_entity_select',
'#title' => t('Product owner'),
'#target_type' => 'user',
'#description' => $this
->t('The user to assign as owner for generated products. Leave empty for randomly selected users.'),
];
$options = [
1 => $this
->t('Now'),
];
foreach ([
3600,
86400,
604800,
2592000,
31536000,
] as $interval) {
$options[$interval] = $this->dateFormatter
->formatInterval($interval, 1) . ' ' . $this
->t('ago');
}
$form['time_range'] = [
'#type' => 'select',
'#title' => $this
->t('How far back in time should the products be dated?'),
'#description' => $this
->t('Product creation dates will be distributed randomly from the current time, back to the selected time.'),
'#options' => $options,
'#default_value' => 3600,
];
$options = [];
$languages = $this->languageManager
->getLanguages(LanguageInterface::STATE_ALL);
foreach ($languages as $langcode => $language) {
$options[$langcode] = $language
->getName();
}
$form['add_language'] = [
'#type' => 'select',
'#title' => $this
->t('Set language on products'),
'#multiple' => TRUE,
'#description' => $this
->t('Requires locale.module'),
'#options' => $options,
'#default_value' => [
$this->languageManager
->getDefaultLanguage()
->getId(),
],
];
$form['#redirect'] = FALSE;
return $form;
}
public function settingsFormValidate(array $form, FormStateInterface $form_state) {
if ($form_state
->getValue('kill') && !$form_state
->getValue('num')) {
return;
}
if (!array_filter($form_state
->getValue('stores'))) {
$form_state
->setErrorByName('stores', $this
->t('Please select at least one store!'));
}
if (!array_filter($form_state
->getValue('product_types'))) {
$form_state
->setErrorByName('product_types', $this
->t('Please select at least one product type!'));
}
}
protected function generateElements(array $values) {
if ($values['batch'] > $values['num']) {
$this
->generateProducts($values);
}
else {
$this
->batchGenerateProducts($values);
}
}
private function generateProducts($values) {
$values['product_types'] = array_filter((array) $values['product_types']);
$values['stores'] = array_filter((array) $values['stores']);
if (!empty($values['kill']) && ($values['product_types'] || $values['stores'])) {
$this
->productKill($values);
}
if ($values['product_types'] && $values['num']) {
$this
->prepareGenerateProduct($values);
$start = time();
for ($i = 1; $i <= $values['num']; $i++) {
$this
->generateSaveProduct($values);
if (method_exists($this, 'isDrush8') && $this
->isDrush8() && function_exists('drush_log') && $this
->isDrush8() && $i % drush_get_option('feedback', 1000) == 0) {
$now = time();
\Drupal::logger(dt('Completed @feedback products (@rate products/min)', [
'@feedback' => drush_get_option('feedback', 1000),
'@rate' => drush_get_option('feedback', 1000) * 60 / ($now - $start),
]), 'ok');
$start = $now;
}
}
$this
->setMessage($this
->formatPlural($values['num'], '1 product created.', 'Finished creating @count products'));
}
}
private function getRandomPrice(&$values, $list = '') {
$min = $values["{$list}price_min"];
$max = $values["{$list}price_max"];
$min = bccomp($min, $max) === -1 ? $min : $max;
$max = bccomp($max, $min) === 1 ? $max : $min;
if (bccomp($min, $max) === -1) {
$min_decimals = explode('.', $min);
$min_decimals = isset($min_decimals[1]) ? $min_decimals[1] + 0 : 1;
$max_decimals = explode('.', $max);
$max_decimals = isset($max_decimals[1]) ? $max_decimals[1] + 0 : 99;
$decimals = rand($min_decimals ?: 1, $max_decimals ?: 99);
$decimals = $decimals < 10 ? rand(0, 1) . $decimals : $decimals;
$number = $values['price_number'] = rand($min, $max) . '.' . $decimals;
}
else {
$number = $values['price_number'] = bcadd($max, 0);
}
return is_numeric($number) && $number > 0 ? $number : '1.11';
}
protected function productKill($values) {
$products = $in_stores = $in_product_types = [];
if ($values['stores']) {
$products = $in_stores = (array) $this->productStorage
->loadByProperties([
'stores' => $values['stores'],
]);
}
if ($values['product_types']) {
$products = $in_product_types = (array) $this->productStorage
->loadByProperties([
'type' => $values['product_types'],
]);
}
if ($in_stores && $in_product_types) {
$products = array_intersect_key($in_stores, $in_product_types);
}
if ($count = count($products)) {
$this->productStorage
->delete($products);
$this
->setMessage($this
->t('Deleted %count products.', [
'%count' => $count,
]));
}
else {
$this
->setMessage($this
->t('Nothing to delete, skipped.'));
}
}
private function batchGenerateProducts($values) {
if (!$this->drushBatch) {
$operations[] = [
'commerce_generate_operation',
[
$this,
'batchPrepareProduct',
$values,
],
];
}
if ($values['kill']) {
$operations[] = [
'commerce_generate_operation',
[
$this,
'batchProductKill',
$values,
],
];
}
for ($num = 0; $num < $values['num']; $num++) {
$operations[] = [
'commerce_generate_operation',
[
$this,
'batchGenerateSaveProduct',
$values,
],
];
}
$batch = [
'title' => $this
->t('Generating Products'),
'operations' => $operations,
'finished' => 'commerce_generate_batch_finished',
];
batch_set($batch);
if ($this->drushBatch) {
drush_backend_batch_process();
}
}
public function batchPrepareProduct($vars, &$context) {
if ($this->drushBatch) {
$this
->prepareGenerateProduct($vars);
}
else {
$context['results'] = $vars;
$context['results']['num'] = 0;
$this
->prepareGenerateProduct($context['results']);
}
}
public function batchGenerateSaveProduct($vars, &$context) {
if ($this->drushBatch) {
$this
->generateSaveProduct($vars);
}
else {
$this
->generateSaveProduct($context['results']);
$context['results']['num']++;
}
}
public function batchProductKill($vars, &$context) {
if ($this->drushBatch) {
$this
->productKill($vars);
}
else {
$this
->productKill($context['results']);
}
}
protected function prepareGenerateProduct(&$results) {
if ($results['owner']) {
$users = [
$results['owner'],
];
}
else {
$users = $this
->getUsers();
}
$results['users'] = $users;
}
protected function generateSaveProduct(&$results) {
if (!isset($results['time_range'])) {
$results['time_range'] = 0;
}
$users = $results['users'];
$title = empty($results['title_length']) ? '' : ' ' . $this
->getRandom()
->sentences(mt_rand(1, $results['title_length']), TRUE);
$store = $this->storeStorage
->load(array_rand(array_filter($results['stores'])));
$code = $store
->getDefaultCurrencyCode();
$values = [
'price' => new Price($this
->getRandomPrice($results), $code),
];
if ($list_price = !empty($results['list_price_min']) && !empty($results['list_price_max'])) {
$values['list_price'] = new Price($this
->getRandomPrice($results, 'list_'), $code);
}
$product_type = array_rand(array_filter($results['product_types']));
$uid = $users[array_rand($users)] ?: $users[array_rand($users)];
$product = $this->productStorage
->create([
'type' => $product_type,
'title' => "{$results['title_prefix']}{$title}",
'uid' => $uid,
'created' => REQUEST_TIME - mt_rand(0, $results['time_range']),
'langcode' => $this
->getLangcode($results),
]);
$product->commerce_generate = $results;
$all = [
'shuffle_variations' => $results['shuffle_variations'],
'max_nb_skus' => $results['max_nb_skus'],
];
$variations = $this->creator
->createAllProductVariations($product, $values, $all);
foreach ($variations as $variation) {
$this
->populateFields($variation);
if ($results['price_per_variation']) {
$variation
->setPrice(new Price($this
->getRandomPrice($results), $code));
if ($list_price) {
$variation
->setListPrice(new Price($this
->getRandomPrice($results, 'list_'), $code));
}
}
}
$this
->populateFields($product);
$product
->get('body')
->setvalue($this
->getRandom()
->paragraphs(2));
$product
->setStores([
$store,
]);
$product
->setVariations($variations);
$product
->save();
}
public static function populateFields(EntityInterface $entity) {
$instances = \Drupal::entityTypeManager()
->getStorage('field_config')
->loadByProperties([
'entity_type' => $entity
->getEntityType()
->id(),
'bundle' => $entity
->bundle(),
]);
if ($skips = function_exists('drush_get_option') ? drush_get_option('skip-fields', '') : @$_REQUEST['skip-fields']) {
foreach (explode(',', $skips) as $skip) {
unset($instances[$skip]);
}
}
foreach ($instances as $instance) {
$field_storage = $instance
->getFieldStorageDefinition();
$field_name = $field_storage
->getName();
$type = $field_storage
->getSetting('target_type');
if ($type == 'commerce_product_attribute_value' || $field_name == 'stores' || $field_name == 'variations' || $field_name == 'body') {
continue;
}
$max = $cardinality = $field_storage
->getCardinality();
if ($cardinality == FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED) {
$max = rand(1, 3);
}
$entity->{$field_name}
->generateSampleItems($max);
}
}
protected function getLangcode($results) {
if (!empty($results['add_language'])) {
$langcodes = $results['add_language'];
$langcode = $langcodes[array_rand($langcodes)];
}
elseif (!empty($results['languages']['add_language'])) {
$langcodes = $results['languages']['add_language'];
$langcode = $langcodes[array_rand($langcodes)];
}
else {
$langcode = $this->languageManager
->getDefaultLanguage()
->getId();
}
return $langcode;
}
protected function getUsers() {
$users = [];
$result = \Drupal::database()
->queryRange("SELECT uid FROM {users}", 0, 50);
foreach ($result as $record) {
$users[] = $record->uid;
}
return $users;
}
public function validateDrushParams($args, $options = []) {
$switcher = \Drupal::service('account_switcher');
$switcher
->switchTo(new UserSession([
'uid' => 1,
'roles' => [
'authenticated',
'administrator',
],
]));
$stores = $product_types = [];
foreach ($this->storeStorage
->loadMultiple() as $store) {
$stores[] = $store
->id();
}
foreach ($this->productTypeStorage
->loadMultiple() as $type) {
$product_types[] = $type
->id();
}
$switcher
->switchBack();
if (empty($stores)) {
throw new \Exception(dt('You do not have any stores to which generated products could be assigned. '));
}
if (empty($product_types)) {
throw new \Exception(dt('You do not have any product types which could be created. '));
}
$values = [];
$default_settings = $this
->getDefaultSettings();
$values['num'] = array_shift($args);
if (method_exists($this, 'isDrush8') && $this
->isDrush8()) {
$keys = [
'stores',
'product-types',
'kill',
'batch',
'title-prefix',
'title-length',
'price-min',
'price-max',
'price-per-variation',
'owner',
'languages',
];
foreach ($keys as $index => $key) {
if (!drush_get_option($key)) {
unset($keys[$index]);
}
else {
$keys[$index] = str_replace('-', '_', $key);
if ($keys[$index] == 'kill') {
$values['kill'] = TRUE;
unset($keys[$index]);
}
elseif ($keys[$index] == 'price_per_variation') {
$values['price_per_variation'] = TRUE;
unset($keys[$index]);
}
}
}
$values += array_combine($keys, $args);
if (!empty($values['stores'])) {
$values['stores'] = StringUtils::csvToArray($values['stores']);
}
if (!empty($values['product_types'])) {
$values['product_types'] = StringUtils::csvToArray($values['product_types']);
}
if (!empty($values['languages'])) {
$values['languages'] = StringUtils::csvToArray($values['languages']);
}
$values += $default_settings;
}
else {
if (!empty($options['stores'])) {
$values['stores'] = StringUtils::csvToArray($options['stores']);
}
if (!empty($options['product_types'])) {
$values['product_types'] = StringUtils::csvToArray($options['product_types']);
}
if (!empty($options['languages'])) {
$values['languages'] = StringUtils::csvToArray($options['languages']);
}
$values += $options;
$values += $default_settings;
}
if (!empty($values['languages'])) {
$values['languages']['add_language'] = array_intersect($values['languages'], array_keys($this->languageManager
->getLanguages(LanguageInterface::STATE_ALL)));
}
if (!empty($values['stores'])) {
$selected_stores = array_values(array_intersect($values['stores'], $stores));
if ($selected_stores != $values['stores']) {
throw new \Exception(dt('One or more stores have been entered that don\'t exist on this site'));
}
}
elseif (!$values['kill'] && $values['num'] > 0) {
$values['stores'] = $stores;
}
if (!empty($values['product_types'])) {
$selected_product_types = array_values(array_intersect($values['product_types'], $product_types));
if ($selected_product_types != $values['product_types']) {
throw new \Exception(dt('One or more product types have been entered that don\'t exist on this site'));
}
}
elseif ($values['num'] > 0) {
$values['product_types'] = $product_types;
}
if (!empty($values['stores'])) {
$values['stores'] = array_combine($values['stores'], $values['stores']);
}
if (!empty($values['product_types'])) {
$values['product_types'] = array_combine($values['product_types'], $values['product_types']);
}
$values['price_number'] = '1.23';
if ($values['num'] > 0 && $values['batch'] > 1 && $values['num'] >= $values['batch']) {
$this->drushBatch = TRUE;
$this
->prepareGenerateProduct($values);
}
return $values;
}
}
