Skip to content

Add OJS 3.5 support and a configurable article count #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
edersotto wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add OJS 3.5 support and a configurable article count #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
283 changes: 145 additions & 138 deletions MostReadBlockPlugin.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
<?php

/**
* @file plugins/blocks/mostRead/MostReadBlockPlugin.inc.php
* @file plugins/blocks/mostRead/MostReadBlockPlugin.php
*
* Copyright (c) 2014-2024 Simon Fraser University
* Copyright (c) 2003-2024 John Willinsky
* Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
*
* @class MostReadBlockPlugin
*
* @ingroup plugins_blocks_mostRead
*
* @brief Class for "Most Read" block plugin
Expand All @@ -16,65 +17,67 @@
namespace APP\plugins\blocks\mostRead;

use APP\core\Application;
use APP\core\Services;
use APP\i18n\AppLocale;
use APP\facades\Repo;
use APP\template\TemplateManager;
use Illuminate\Support\Collection;
use PKP\cache\CacheManager;
use Illuminate\Support\Facades\Cache;
use PKP\core\JSONMessage;
use PKP\linkAction\LinkAction;
use PKP\facades\Locale;
use PKP\linkAction\LinkAction;
use PKP\linkAction\request\AjaxModal;
use PKP\plugins\BlockPlugin;
use PKP\submission\PKPSubmission;

class MostReadBlockPlugin extends BlockPlugin {

/**
* Install default settings on journal creation.
* @return string
*/
function getContextSpecificPluginSettingsFile() {
return $this->getPluginPath() . '/settings.xml';
}

/**
* Get the display name of this plugin.
* @return String
*/
function getDisplayName() {
return __('plugins.blocks.mostRead.displayName');
}

/**
* Get a description of the plugin.
*/
function getDescription() {
return __('plugins.blocks.mostRead.description');
}


/**
* @copydoc Plugin::getActions()
*/
function getActions($request, $actionArgs) {
$router = $request->getRouter();
import('lib.pkp.classes.linkAction.request.AjaxModal');
return array_merge(
$this->getEnabled()?array(
new LinkAction(
'settings',
new AjaxModal(
$router->url($request, null, null, 'manage', null, array_merge($actionArgs, array('verb' => 'settings'))),
$this->getDisplayName()
),
__('manager.plugins.settings'),
null
),
):array(),
parent::getActions($request, $actionArgs)
);
}
class MostReadBlockPlugin extends BlockPlugin
{
/** Cache lifetime in seconds (1 day). */
private const CACHE_TTL = 60 * 60 * 24;

/**
* Install default settings on journal creation.
*/
public function getContextSpecificPluginSettingsFile()
{
return $this->getPluginPath() . '/settings.xml';
}

/**
* Get the display name of this plugin.
*/
public function getDisplayName()
{
return __('plugins.blocks.mostRead.displayName');
}

/**
* Get a description of the plugin.
*/
public function getDescription()
{
return __('plugins.blocks.mostRead.description');
}

/**
* @copydoc Plugin::getActions()
*/
public function getActions($request, $actionArgs)
{
$router = $request->getRouter();
return array_merge(
$this->getEnabled() ? [
new LinkAction(
'settings',
new AjaxModal(
$router->url($request, null, null, 'manage', null, array_merge($actionArgs, ['verb' => 'settings'])),
$this->getDisplayName()
),
__('manager.plugins.settings'),
null
),
] : [],
parent::getActions($request, $actionArgs)
);
}

/**
* @copydoc Plugin::manage()
Expand Down Expand Up @@ -103,95 +106,99 @@ public function manage($args, $request)
return parent::manage($args, $request);
}

/**
* @copydoc BlockPlugin::getContents
*/
function getContents($templateMgr, $request = null)
{
$context = $request->getContext();
if (!$context) return '';

$cacheManager = CacheManager::getManager();
$cache = $cacheManager->getCache($context->getId(), 'mostread' , array($this, 'getMostReadCache'));

$daysToStale = 1;
$cachedMetrics = false;

if (time() - $cache->getCacheTime() > 60 * 60 * 24 * $daysToStale) {
$cachedMetrics = $cache->getContents();
$cache->flush();
}

$metrics = $cache->getContents();

if (!$metrics && $cachedMetrics) {
$metrics = $cachedMetrics;
$cache->setEntireCache($cachedMetrics);
} elseif (!$metrics) {
$cache->flush();
}

$mostReadBlockTitleSetting = json_decode(
$this->getSetting($context->getId(), 'mostReadBlockTitle'),
true
) ?: null;

$locale = AppLocale::getLocale();
$mostReadBlockTitle = $mostReadBlockTitleSetting[$locale] ?? null;
$templateMgr->assign('blockTitle', $mostReadBlockTitle);

$mostRead = [];
foreach($metrics as $metric){
$submission = Repo::submission()->get($metric['submissionId']);
if(isset($submission) && $submission?->getCurrentPublication()->getData('status') === PKPSubmission::STATUS_PUBLISHED)
{
$mostRead[] = [
'url' => Application::get()->getRequest()->url($context?->getPath(), 'article', 'view', [$submission->getBestId()]),
'metric' => $metric['metric'],
'title' => $submission?->getCurrentPublication()->getLocalizedFullTitle($locale, 'html')
];
}
}

$templateMgr->assign('mostRead', $mostRead);
return parent::getContents($templateMgr, $request);
}

/**
* Set cache
* @param $cache object
*/

function getMostReadCache($cache): array
{
$mostReadDays = (int) $this->getSetting($cache->context, 'mostReadDays');
if (empty($mostReadDays)){
$mostReadDays = 7;
}
$dayString = "-" . $mostReadDays . " days";

$mostRead = Services::get('publicationStats')->getTotals([
/**
* @copydoc BlockPlugin::getContents()
*/
public function getContents($templateMgr, $request = null)
{
$context = $request?->getContext();
if (!$context) {
return '';
}

$contextId = $context->getId();

$metrics = Cache::remember(
$this->getCacheKey($contextId),
self::CACHE_TTL,
fn () => $this->loadMostRead($contextId)
);

$locale = Locale::getLocale();

$mostReadBlockTitle = (array) json_decode($this->getSetting($contextId, 'mostReadBlockTitle') ?? '');
$blockTitle = $mostReadBlockTitle[$locale] ?? '';
$templateMgr->assign('blockTitle', $blockTitle);

$mostRead = [];
foreach ($metrics as $metric) {
$submission = Repo::submission()->get($metric['submissionId']);
if (!$submission) {
continue;
}
$publication = $submission->getCurrentPublication();
if (!$publication || (int) $publication->getData('status') !== PKPSubmission::STATUS_PUBLISHED) {
continue;
}
$mostRead[] = [
'url' => $request->url($context->getPath(), 'article', 'view', [$submission->getBestId()]),
'metric' => $metric['metric'],
'title' => $publication->getLocalizedFullTitle($locale, 'html'),
];
}

$templateMgr->assign('mostRead', $mostRead);
return parent::getContents($templateMgr, $request);
}

/**
* Build the cache key for a given context.
*/
public function getCacheKey(int $contextId): string
{
return "plugins.blocks.mostRead.{$contextId}";
}

/**
* Clear the cached metrics for a given context.
*/
public function clearCache(int $contextId): void
{
Cache::forget($this->getCacheKey($contextId));
}

/**
* Query the most read submissions for a context.
*
* @return array<int, array{submissionId: int, metric: int}>
*/
public function loadMostRead(int $contextId): array
{
$mostReadDays = (int) $this->getSetting($contextId, 'mostReadDays');
if (empty($mostReadDays)) {
$mostReadDays = 7;
}
$dayString = '-' . $mostReadDays . ' days';

$mostReadCount = (int) $this->getSetting($contextId, 'mostReadCount');
if ($mostReadCount < 1) {
$mostReadCount = 5;
}

$mostRead = app()->get('publicationStats')->getTotals([
'dateStart' => date('Y-m-d', strtotime($dayString)),
'contextIds' => [$cache->context],
'count' => 5,
'assocTypes' => [Application::ASSOC_TYPE_SUBMISSION_FILE],
'contextIds' => [$contextId],
'count' => $mostReadCount,
'assocTypes' => [Application::ASSOC_TYPE_SUBMISSION_FILE],
]);

$results = (new Collection($mostRead))
->map(function($result) {
$submission = Repo::submission()->get($result->submission_id);
return [
'submissionId' => $result->submission_id,
'metric' => $result->metric
];
})
->filter(function($result) {
return $result['submissionId'] && $result['metric'];
})
return (new Collection($mostRead))
->map(fn ($result) => [
'submissionId' => $result->submission_id,
'metric' => $result->metric,
])
->filter(fn ($result) => $result['submissionId'] && $result['metric'])
->values()
->toArray();

$cache->setEntireCache($results);
return $results;
}
}
?>
Loading