UHF-9962 recommendations algorithm

conf/cmi/block.block.hdbt_subtheme_aipoweredrecommendations.yml

@@ -0,0 +1,40 @@
+uuid: 6ab1786a-6f04-44a4-afe2-b7c9829fd000
+langcode: en
+status: false
+dependencies:
+  module:
+    - helfi_annif
+    - language
+    - node
+  theme:
+    - hdbt_subtheme
+id: hdbt_subtheme_aipoweredrecommendations
+theme: hdbt_subtheme
+region: after_content
+weight: -12
+provider: null
+plugin: helfi_recommendations
+settings:
+  id: helfi_recommendations
+  label: 'AI powered recommendations'
+  label_display: visible
+  provider: helfi_annif
+  context_mapping:
+    node: '@node.node_route_context:node'
+visibility:
+  language:
+    id: language
+    negate: false
+    context_mapping:
+      language: '@language.current_language_context:language_interface'
+    langcodes:
+      fi: fi
+      sv: sv
+      en: en
+  'entity_bundle:node':
+    id: 'entity_bundle:node'
+    negate: false
+    context_mapping:
+      node: '@node.node_route_context:node'
+    bundles:
+      news_item: news_item

public/modules/custom/helfi_annif/config/install/block.block.hdbt_subtheme_aipoweredrecommendations.yml

@@ -0,0 +1,40 @@
+uuid: 6ab1786a-6f04-44a4-afe2-b7c9829fd000
+langcode: en
+status: true
+dependencies:
+  module:
+    - helfi_annif
+    - language
+    - node
+  theme:
+    - hdbt_subtheme
+id: hdbt_subtheme_aipoweredrecommendations
+theme: hdbt_subtheme
+region: after_content
+weight: -12
+provider: null
+plugin: helfi_recommendations
+settings:
+  id: helfi_recommendations
+  label: 'AI powered recommendations'
+  label_display: visible
+  provider: helfi_annif
+  context_mapping:
+    node: '@node.node_route_context:node'
+visibility:
+  language:
+    id: language
+    negate: false
+    context_mapping:
+      language: '@language.current_language_context:language_interface'
+    langcodes:
+      fi: fi
+      sv: sv
+      en: en
+  'entity_bundle:node':
+    id: 'entity_bundle:node'
+    negate: false
+    context_mapping:
+      node: '@node.node_route_context:node'
+    bundles:
+      news_item: news_item

public/modules/custom/helfi_annif/helfi_annif.module

@@ -12,6 +12,20 @@ use Drupal\Core\Entity\EntityTypeInterface;
 use Drupal\helfi_annif\KeywordManager;
 use Drupal\helfi_annif\TextConverter\Document;
 
+/**
+ * Implements hook_theme().
+ */
+function helfi_annif_theme() : array {
+  return [
+    'recommendations_block' => [
+      'variables' => [
+        'rows' => NULL,
+      ],
+      'template' => 'recommendations-block',
+    ],
+  ];
+}
+
 /**
  * Implements hook_entity_insert().
  */

public/modules/custom/helfi_annif/helfi_annif.services.yml

@@ -3,6 +3,10 @@ services:
     autowire: true
     autoconfigure: true
 
+  logger.channel.helfi_annif:
+    parent: logger.channel_base
+    arguments: ['helfi_annif']
+
   Drupal\helfi_annif\KeywordManager: ~
 
   Drupal\helfi_annif\RecommendationManager: ~

public/modules/custom/helfi_annif/src/KeywordManager.php

@@ -127,7 +127,8 @@ public function processEntity(EntityInterface $entity, bool $overwriteExisting =
       return;
     }
 
-    $this->saveKeywords($entity, $this->keywordGenerator->suggest($entity));
+    $keywords = $this->keywordGenerator->suggest($entity) ?? [];
+    $this->saveKeywords($entity, $keywords);
   }
 
   /**

public/modules/custom/helfi_annif/src/Plugin/Block/RecommendationsBlock.php

@@ -6,25 +6,105 @@
 
 use Drupal\Core\Block\Attribute\Block;
 use Drupal\Core\Block\BlockBase;
+use Drupal\Core\Cache\Cache;
+use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
+use Drupal\Core\Plugin\Context\EntityContextDefinition;
+use Drupal\Core\Plugin\ContextAwarePluginInterface;
+use Drupal\Core\Session\AccountInterface;
 use Drupal\Core\StringTranslation\TranslatableMarkup;
+use Drupal\helfi_annif\RecommendationManager;
+use Psr\Log\LoggerInterface;
+use Symfony\Component\DependencyInjection\ContainerInterface;
 
 /**
  * Provides 'AI powered recommendations'.
  */
 #[Block(
   id: "helfi_recommendations",
   admin_label: new TranslatableMarkup("AI powered recommendations"),
+  context_definitions: [
+    'node' => new EntityContextDefinition(
+      data_type: 'node',
+      label: new TranslatableMarkup('Node'),
+      required: TRUE,
+    ),
+  ]
 )]
-class RecommendationsBlock extends BlockBase {
+final class RecommendationsBlock extends BlockBase implements ContainerFactoryPluginInterface, ContextAwarePluginInterface {
+
+  public function __construct(
+    array $configuration,
+    $plugin_id,
+    $plugin_definition,
+    private readonly RecommendationManager $recommendationManager,
+    private readonly AccountInterface $currentUser,
+    private readonly LoggerInterface $logger,
+  ) {
+    parent::__construct($configuration, $plugin_id, $plugin_definition);
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) : static {
+    return new static($configuration, $plugin_id, $plugin_definition,
+      $container->get(RecommendationManager::class),
+      $container->get('current_user'),
+      $container->get('logger.channel.helfi_annif'),
+    );
+  }
 
   /**
    * {@inheritdoc}
    */
   public function build() : array {
-    // @todo UHF-9962.
-    return [
-      '#markup' => $this->t('Hello, World!'),
+    $node = $this->getContextValue('node');
+
+    // @todo #UHF-9964 Lisätään suosittelulohkon piilotustoiminto.
+    $response = [
+      '#theme' => 'recommendations_block',
+      '#title' => $this->t('You might be interested in'),
     ];
+
+    $recommendations = $this->recommendationManager->getRecommendations($node);
+    if (!$recommendations) {
+      return $this->handleNoRecommendations($response);
+    }
+
+    $response['#rows'] = $recommendations;
+    return $response;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getCacheContexts(): array {
+    return Cache::mergeContexts(parent::getCacheContexts(), ['languages:language_content']);
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getCacheTags(): array {
+    return Cache::mergeTags(parent::getCacheTags(), $this->getContextValue('node')->getCacheTags());
+  }
+
+  /**
+   * Return response when recommendations are not yet calculated.
+   *
+   * @param array $response
+   *   Render array.
+   *
+   * @return array
+   *   Render array.
+   */
+  private function handleNoRecommendations(array $response): array {
+    if ($this->currentUser->isAnonymous()) {
+      return [];
+    }
+
+    $response['#no_results_message'] = $this->t('Calculating recommendations');
+    return $response;
   }
 
 }

public/modules/custom/helfi_annif/src/RecommendationManager.php

@@ -4,10 +4,90 @@
 
 namespace Drupal\helfi_annif;
 
+use Drupal\Core\Database\Connection;
+use Drupal\Core\Entity\EntityInterface;
+use Drupal\Core\Entity\EntityTypeManagerInterface;
+use Psr\Log\LoggerAwareInterface;
+use Psr\Log\LoggerAwareTrait;
+
 /**
  * The recommendation manager.
- *
- * @todo UHF-9962.
  */
-class RecommendationManager {
+class RecommendationManager implements LoggerAwareInterface {
+
+  use LoggerAwareTrait;
+
+  /**
+   * The constructor.
+   *
+   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityManager
+   *   The entity type manager.
+   * @param \Drupal\Core\Database\Connection $connection
+   *   The connection.
+   */
+  public function __construct(
+    private readonly EntityTypeManagerInterface $entityManager,
+    private readonly Connection $connection,
+  ) {
+  }
+
+  /**
+   * Get recommendations for a node.
+   *
+   * @param \Drupal\Core\Entity\EntityInterface $node
+   *   The node.
+   *
+   * @return array
+   *   Array of recommendations.
+   */
+  public function getRecommendations(EntityInterface $node): array {
+    // @todo #UHF-9964 exclude unwanted keywords and entities and refactor.
+    $query = "
+      select
+         n.nid,
+         count(n.nid) as relevancy
+      from node as n
+      left join node__field_annif_keywords as annif on n.nid = annif.entity_id
+      where annif.field_annif_keywords_target_id in
+         (select
+          field_annif_keywords_target_id
+          from node__field_annif_keywords
+          where entity_id = :nid and
+          langcode = :langcode)
+      and n.langcode = :langcode
+      and annif.langcode = :langcode
+      and n.nid != :nid
+      group by n.nid
+      order by relevancy DESC
+      limit 3;
+    ";
+
+    $response = [];
+    try {
+      $results = $this->connection->query($query, [':nid' => $node->id(), ':langcode' => $node->language()->getId()])->fetchAll();
+    }
+    catch (\Exception $e) {
+      $this->logger->error($e->getMessage());
+      return $response;
+    }
+
+    if (!$results || !is_array($results)) {
+      return $response;
+    }
+
+    $nids = array_column($results, 'nid');
+
+    try {
+      $response = $this->entityManager
+        ->getStorage($node->getEntityTypeId())
+        ->loadMultiple($nids);
+    }
+    catch (\Exception $e) {
+      $this->logger->error($e->getMessage());
+      return [];
+    }
+
+    return $response;
+  }
+
 }

public/modules/custom/helfi_annif/templates/recommendations-block.html.twig

@@ -0,0 +1,31 @@
+{% for row in rows %}
+  {# Created date and modified date #}
+  {% set published_at = row.published_at.value  %}
+  {% if published_at is not empty %}
+    {% set html_published_at  %}
+      <time datetime="{{ published_at|format_date('custom', 'Y-m-d') ~ 'T' ~ published_at|format_date('custom', 'H:i') }}" class="news-listing__datetime news-listing__datetime--published" {{ alternative_language ? create_attribute(({ 'lang': lang_attributes.fallback_lang, 'dir': lang_attributes.fallback_dir })) }}>
+        <span class="visually-hidden">{{ 'Published'|t({}, {'context': 'The helper text before the node published timestamp'}) }}</span>
+        {{ published_at|format_date('publication_date_format') }}
+      </time>
+    {% endset %}
+  {% else %}
+    {% set html_published_at = '-' %}
+  {% endif %}
+
+  {% set card_url = url('entity.node.canonical', {'node': row.id})['#markup'] %}
+
+  {% embed '@hdbt/component/card.twig' with {
+    card_modifier_class: 'news-listing__item',
+    card_title_level: 'h3',
+    card_title: row.title.value,
+    card_url: card_url,
+    card_metas: [
+      {
+        icon: 'clock',
+        label: 'Published'|t({}, {'context': 'Label for news card published time'}),
+        content: html_published_at
+      },
+    ],
+  } %}
+  {% endembed %}
+{% endfor %}

public/themes/custom/hdbt_subtheme/templates/block/block--helfi-annif.html.twig

@@ -0,0 +1,14 @@
+{% block paragraph %}
+  {% embed "@hdbt/misc/component.twig" with
+    {
+      component_classes: [ 'component--recommendations' ],
+      component_title: 'You might be interested in'|t({}, {'context': 'Front page recommendations block title'}),
+      use_component_title_lang_fallback: alternative_language ?? false,
+      component_content_class: 'recommendations',
+    }
+  %}
+    {% block component_content %}
+      {{ content }}
+    {% endblock component_content %}
+  {% endembed %}
+{% endblock paragraph %}

public/themes/custom/hdbt_subtheme/templates/block/block--helfi-recommendationsssss.html.twig

@@ -0,0 +1,7 @@
+<ul class="news-listing news-listing--latest-tiny-teasers">
+  {% for row in content.rows %}
+    <li class="news-listing__item">
+      {{- row.content -}}
+    </li>
+  {% endfor %}
+</ul>