first commit

plugins/generic/recommendBySimilarity/RecommendBySimilarityPlugin.php

@@ -0,0 +1,139 @@
+<?php
+
+/**
+ * @file plugins/generic/recommendBySimilarity/RecommendBySimilarityPlugin.php
+ *
+ * Copyright (c) 2014-2022 Simon Fraser University
+ * Copyright (c) 2003-2022 John Willinsky
+ * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
+ *
+ * @class RecommendBySimilarityPlugin
+ *
+ * @brief Plugin to recommend similar articles.
+ */
+
+namespace APP\plugins\generic\recommendBySimilarity;
+
+use APP\core\Application;
+use APP\facades\Repo;
+use APP\handler\Handler;
+use APP\search\ArticleSearch;
+use APP\submission\Collector;
+use APP\submission\Submission;
+use APP\template\TemplateManager;
+use PKP\plugins\GenericPlugin;
+use PKP\plugins\Hook;
+
+class RecommendBySimilarityPlugin extends GenericPlugin
+{
+    private const DEFAULT_RECOMMENDATION_COUNT = 10;
+    private const MAX_SEARCH_KEYWORDS = 20;
+
+    /**
+     * @copydoc Plugin::register()
+     *
+     * @param null|mixed $mainContextId
+     */
+    public function register($category, $path, $mainContextId = null): bool
+    {
+        if (!parent::register($category, $path, $mainContextId)) {
+            return false;
+        }
+
+        if (!Application::isUnderMaintenance() && $this->getEnabled($mainContextId)) {
+            Hook::add('Templates::Article::Footer::PageFooter', function (string $hookName, array $params): bool {
+                $smarty = & $params[1];
+                $output = & $params[2];
+                $output .= $this->buildTemplate($smarty);
+                return Hook::CONTINUE;
+            });
+        }
+        return true;
+    }
+
+    /**
+     * Builds the template with the recommended submissions or null if the linked submission has no keywords
+     *
+     * @see templates/article/footer.tpl
+     */
+    private function buildTemplate($smarty): ?string
+    {
+        $templateManager = TemplateManager::getManager($smarty);
+        $submissionId = $templateManager->getTemplateVars('article')->getId();
+
+        // If there's no keywords, quit
+        if (!strlen($searchPhrase = implode(' ', (new ArticleSearch())->getSimilarityTerms($submissionId)))) {
+            return null;
+        }
+
+        $request = Application::get()->getRequest();
+        $router = $request->getRouter();
+        $context = $router->getContext($request);
+
+        $rangeInfo = Handler::getRangeInfo($request, 'articlesBySimilarity');
+        $rangeInfo->setCount(static::DEFAULT_RECOMMENDATION_COUNT);
+
+        // Prepares the collector to retrieve similar submissions
+        $collector = Repo::submission()
+            ->getCollector()
+            ->excludeIds([$submissionId])
+            ->filterByContextIds([$context->getId()])
+            ->filterByStatus([Submission::STATUS_PUBLISHED])
+            ->searchPhrase($searchPhrase, static::MAX_SEARCH_KEYWORDS);
+
+        $offset = ($rangeInfo->getPage() - 1) * $rangeInfo->getCount();
+        $submissionCount = $collector->getCount();
+
+        $submissions = $collector
+            ->limit($rangeInfo->getCount())
+            ->offset($offset)
+            ->orderBy(Collector::ORDERBY_SEARCH_RANKING)
+            ->getMany();
+
+        // Load the linked issues
+        $issues = Repo::issue()->getCollector()
+            ->filterByContextIds([$context->getId()])
+            ->filterByIssueIds(
+                $submissions->map(fn (Submission $submission) => $submission->getCurrentPublication()->getData('issueId'))
+                    ->unique()
+                    ->toArray()
+            )
+            ->getMany();
+
+        $nextPage = $rangeInfo->getPage() * $rangeInfo->getCount() < $submissionCount
+            ? $request->url(path: $submissionId, params: ['articlesBySimilarityPage' => $rangeInfo->getPage() + 1])
+            : null;
+        $previousPage = $rangeInfo->getPage() > 1
+            ? $request->url(path: $submissionId, params: ['articlesBySimilarityPage' => $rangeInfo->getPage() - 1])
+            : null;
+
+        $templateManager->assign('articlesBySimilarity', (object) [
+            'submissions' => $submissions,
+            'query' => $searchPhrase,
+            'issues' => $issues,
+            'start' => $offset + 1,
+            'end' => $offset + $submissions->count(),
+            'total' => $submissionCount,
+            'nextUrl' => $nextPage,
+            'previousUrl' => $previousPage
+        ]);
+
+        return $templateManager->fetch($this->getTemplateResource('articleFooter.tpl'));
+    }
+
+    /**
+     * @copydoc Plugin::getDisplayName()
+     */
+    public function getDisplayName(): string
+    {
+        return __('plugins.generic.recommendBySimilarity.displayName');
+    }
+
+    /**
+     * @copydoc Plugin::getDescription()
+     */
+    public function getDescription(): string
+    {
+        return __('plugins.generic.recommendBySimilarity.description');
+    }
+}