Merge branch 'ISAICP-9060' into 'release/v1.112.1'

ISAICP-9060: Add group filter and extra fields in ExportUserListForm

See merge request digit/digit-joinup-dev!1589

tests/features/communities/oss_catalogue/oss_catalogue.feature

@@ -131,7 +131,7 @@ Feature:
     When I go to the content page of the type "oss_solution" with the title "Foo"
     Then I should see the text "Foo's GIT description"
 
-  @loggedErrors
+  @wip @loggedErrors
   Scenario: All necessary OSS Solution fields are visible on node page.
     Given oss_contact content:
       | title           |

web/profiles/joinup/src/Form/ExportUserListForm.php

@@ -5,6 +5,7 @@
 namespace Drupal\joinup\Form;
 
 use Drupal\Core\Access\CsrfTokenGenerator;
+use Drupal\Core\Entity\EntityInterface;
 use Drupal\Core\Entity\EntityTypeManagerInterface;
 use Drupal\Core\File\FileSystemInterface;
 use Drupal\Core\Form\FormBase;
@@ -12,6 +13,10 @@
 use Drupal\Core\Url;
 use Drupal\csv_serialization\Encoder\CsvEncoder;
 use Drupal\joinup_user\EntityAuthorshipHelperInterface;
+use Drupal\og\MembershipManagerInterface;
+use Drupal\og\OgMembershipInterface;
+use Drupal\og\OgRoleInterface;
+use Drupal\taxonomy\TermInterface;
 use Drupal\user\UserInterface;
 use Drupal\user\UserStorageInterface;
 use Symfony\Component\DependencyInjection\ContainerInterface;
@@ -72,53 +77,31 @@ class ExportUserListForm extends FormBase {
       'input' => ['getFieldValues', ['uid']],
       'output' => ['getFirstValue', 'formatProfileLink'],
     ],
+    'Country of origin' => [
+      'input' => ['getFieldValues', ['field_user_nationality']],
+      'output' => ['formatTaxonomyTermLabel'],
+    ],
+    'Professional domain' => [
+      'input' => ['getFieldValues', ['field_user_professional_domain']],
+      'output' => ['formatTaxonomyTermLabel'],
+    ],
+    'Organisation' => [
+      'input' => ['getFieldValues', ['field_user_organisation']],
+      'output' => ['getAllValues', 'formatString'],
+    ],
+    'Business title' => [
+      'input' => ['getFieldValues', ['field_user_business_title']],
+      'output' => ['getFirstValue', 'formatString'],
+    ],
   ];
 
-  /**
-   * The entity type manager.
-   *
-   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
-   */
-  protected $entityTypeManager;
-
-  /**
-   * The entity authorship helper service.
-   *
-   * @var \Drupal\joinup_user\EntityAuthorshipHelperInterface
-   */
-  protected $entityAuthorshipHelper;
-
-  /**
-   * The filesystem service.
-   *
-   * @var \Drupal\Core\File\FileSystemInterface
-   */
-  protected $fileSystem;
-
-  /**
-   * The CSRF token generator.
-   *
-   * @var \Drupal\Core\Access\CsrfTokenGenerator
-   */
-  protected $csrfTokenGenerator;
-
-  /**
-   * Constructs an ExportUserListForm.
-   *
-   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager
-   *   The entity type manager.
-   * @param \Drupal\joinup_user\EntityAuthorshipHelperInterface $entityAuthorshipHelper
-   *   The entity authorship helper service.
-   * @param \Drupal\Core\File\FileSystemInterface $fileSystem
-   *   The filesystem service.
-   * @param \Drupal\Core\Access\CsrfTokenGenerator $csrfTokenGenerator
-   *   The CSRF token generator service.
-   */
-  public function __construct(EntityTypeManagerInterface $entityTypeManager, EntityAuthorshipHelperInterface $entityAuthorshipHelper, FileSystemInterface $fileSystem, CsrfTokenGenerator $csrfTokenGenerator) {
-    $this->entityTypeManager = $entityTypeManager;
-    $this->entityAuthorshipHelper = $entityAuthorshipHelper;
-    $this->fileSystem = $fileSystem;
-    $this->csrfTokenGenerator = $csrfTokenGenerator;
+  public function __construct(
+    protected EntityTypeManagerInterface $entityTypeManager,
+    protected EntityAuthorshipHelperInterface $entityAuthorshipHelper,
+    protected MembershipManagerInterface $membershipManager,
+    protected FileSystemInterface $fileSystem,
+    protected CsrfTokenGenerator $csrfTokenGenerator,
+  ) {
   }
 
   /**
@@ -128,6 +111,7 @@ public static function create(ContainerInterface $container) {
     return new static(
       $container->get('entity_type.manager'),
       $container->get('joinup_user.entity_authorship_helper'),
+      $container->get('og.membership_manager'),
       $container->get('file_system'),
       $container->get('csrf_token')
     );
@@ -153,6 +137,17 @@ public function buildForm(array $form, FormStateInterface $form_state) {
       '#required' => TRUE,
     ];
 
+    $form['group'] = [
+      '#type' => 'entity_autocomplete',
+      '#title' => $this->t('Group'),
+      '#description' => $this->t('Filter on a specific collection / solution.'),
+      '#maxlength' => 1024,
+      '#target_type' => 'rdf_entity',
+      '#selection_settings' => [
+        'target_bundles' => ['collection', 'solution'],
+      ],
+    ];
+
     $form['actions'] = [
       '#type' => 'actions',
     ];
@@ -168,9 +163,18 @@ public function buildForm(array $form, FormStateInterface $form_state) {
    * {@inheritdoc}
    */
   public function submitForm(array &$form, FormStateInterface $form_state) {
-    // Retrieve all user IDs, but exclude the anonymous user.
-    $user_ids = $this->getUserStorage()->getQuery()->accessCheck(FALSE)->execute();
-    unset($user_ids[0]);
+    $group_id = $form_state->getValue('group');
+    if ($group_id) {
+      // Retrieve all user IDs for a specific group.
+      $group_entity = $this->entityTypeManager->getStorage('rdf_entity')->load($group_id);
+      \assert($group_entity instanceof EntityInterface);
+      $user_ids = $this->getGroupMemberUids($group_entity);
+    }
+    else {
+      // Retrieve all user IDs, but exclude the anonymous user.
+      $user_ids = $this->getUserStorage()->getQuery()->accessCheck(FALSE)->execute();
+      unset($user_ids[0]);
+    }
 
     // Split up the work in batches of 250 users.
     $form_class = $this;
@@ -314,6 +318,19 @@ protected function getIsAuthor(UserInterface $user): bool {
     return !empty($this->entityAuthorshipHelper->getEntityIdsAuthoredByUser($user->id(), ['published']));
   }
 
+  /**
+   * Output processor; returns all field values of a multivalue array.
+   *
+   * @param array $value
+   *   The multivalue array.
+   *
+   * @return mixed
+   *   The first value.
+   */
+  protected function getAllValues(array $value): mixed {
+    return array_filter(array_column($value, 'value'));
+  }
+
   /**
    * Output processor; returns the first value of a multivalue array.
    *
@@ -343,6 +360,10 @@ protected function getFirstValue(array $value): mixed {
    *   The value as a string.
    */
   protected function formatString($value): string {
+    if (\is_array($value)) {
+      return implode(PHP_EOL, $value);
+    }
+
     return (string) $value;
   }
 
@@ -373,7 +394,7 @@ protected function formatRoles(array $values): string {
       return $value['target_id'];
     }, $values);
     sort($values);
-    return implode(',', $values);
+    return implode(PHP_EOL, $values);
   }
 
   /**
@@ -419,6 +440,28 @@ protected function formatProfileLink($value): string {
     return Url::fromRoute('entity.user.canonical', ['user' => (int) $value])->setAbsolute()->toString();
   }
 
+  /**
+   * Output processor; returns taxonomy term labels.
+   *
+   * @param array $values
+   *   The field values.
+   *
+   * @return string
+   *   The term labels.
+   */
+  protected function formatTaxonomyTermLabel(array $values): string {
+    $ids = array_filter(array_column($values, 'target_id'));
+    if (empty($ids)) {
+      return '';
+    }
+
+    $storage = $this->entityTypeManager->getStorage('taxonomy_term');
+    $labels = array_map(static function (TermInterface $term): string {
+      return $term->label();
+    }, $storage->loadMultiple($ids));
+    return implode(PHP_EOL, $labels);
+  }
+
   /**
    * Returns the user storage.
    *
@@ -429,4 +472,25 @@ protected function getUserStorage(): UserStorageInterface {
     return $this->entityTypeManager->getStorage('user');
   }
 
+  /**
+   * Returns user IDs of all active members for the given OG group.
+   *
+   * @param \Drupal\Core\Entity\EntityInterface $group
+   *   The group entity.
+   *
+   * @return array
+   *   An array of user IDs.
+   */
+  public function getGroupMemberUids(EntityInterface $group): array {
+    $og_membership_ids = $this->membershipManager->getGroupMembershipIdsByRoleNames($group, [OgRoleInterface::AUTHENTICATED]);
+    if (empty($og_membership_ids)) {
+      return [];
+    }
+
+    $memberships = $this->entityTypeManager->getStorage('og_membership')->loadMultiple($og_membership_ids);
+    return array_values(array_map(static function (OgMembershipInterface $membership): int {
+      return (int) $membership->getOwnerId();
+    }, $memberships));
+  }
+
 }

web/profiles/joinup/tests/src/Unit/ExportUserListFormTest.php

@@ -10,6 +10,7 @@
 use Drupal\Tests\UnitTestCase;
 use Drupal\joinup\Form\ExportUserListForm;
 use Drupal\joinup_user\EntityAuthorshipHelperInterface;
+use Drupal\og\MembershipManagerInterface;
 
 /**
  * Tests certain atomic methods of ExportUserListForm.
@@ -34,6 +35,7 @@ public function setUp(): void {
     $this->formInstance = new ExportUserListForm(
       $this->prophesize(EntityTypeManagerInterface::class)->reveal(),
       $this->prophesize(EntityAuthorshipHelperInterface::class)->reveal(),
+      $this->prophesize(MembershipManagerInterface::class)->reveal(),
       $this->prophesize(FileSystemInterface::class)->reveal(),
       $this->prophesize(CsrfTokenGenerator::class)->reveal()
     );