View Counter — OJS plugin

⬇️ Install package: OJS 3.5 · OJS 3.4 — or browse all Releases.

A generic plugin for Open Journal Systems (OJS) that displays each article's abstract views and downloads (sum of galleys) on the article summary lists and on the article landing page — discreetly, as icons with a tooltip near the title.

Maintained by OJSBR. Rewritten and adapted from an original OJS 3.3 access/downloads counter by STI-FFLCH/USP and ABCD/USP. See the full Credits & authorship section below.

Compatibility & branches

OJS version	Branch	Plugin release
OJS 3.5.x	stable-3_5_0 (default)	1.3.0.3
OJS 3.4.x	stable-3_4_0	1.1.1.3

Pick the branch matching your OJS version. Each branch is installable as-is.

Installation

1. Download the release for your OJS version (or clone the matching branch).
2. Install via Settings → Website → Plugins → Upload A New Plugin, or extract the folder into plugins/generic/ so you get plugins/generic/viewcounter/.
3. Enable View counter under the Generic plugins list.

Configuration

Go to Settings → Website → Plugins → View counter → Settings:

• Show in summary (article lists)
• Show on the article landing page

Both are enabled by default and take effect on the next page load (no cache to clear).

How it works

• No core template is replaced. The badge is injected through the content hooks Templates::Issue::Issue::Article (summary lists: issue TOC, journal home, search results) and Templates::Article::Main (article landing page), so core fixes to the templates keep reaching your site.
• A small stylesheet and script (css/viewcounter.css, js/viewcounter.js) move the badge next to the title when the theme uses the default markup (.obj_article_summary .title / h1.page_title). If the markup differs, the badge simply stays where the hook printed it.
• Counts come from the statistics service (publicationStats) and are cached per submission for 24 hours (Cache::remember). On list pages the cache is primed in bulk with a single grouped query per metric type, so an issue TOC with 30 articles does not run 60 aggregation queries.
• Themes that copied the old templates can keep using {viewcounterStats submission=$article}; the Smarty function is still registered.

Tests

• PHPUnit (tests/*Test.php, on PKP\tests\PKPTestCase): the badge markup and its accessible labels, one grouped query per metric for a list and the 24-hour cache afterwards, submissions without metrics, the site level without settings, no constant that only exists outside PKP's strict mode, the plugin classes against the installed PKP, the 38 translations and the template. From the installation root:

  lib/pkp/lib/vendor/bin/phpunit --configuration lib/pkp/tests/phpunit.xml --no-coverage "$PWD/plugins/generic/viewcounter/tests"

• Cypress (cypress/tests/functional/Viewcounter.cy.js, run by pkp-github-actions on every push): enables the plugin, checks the badge inside the titles of the current issue and of an article page (it fails with the hook off), and saves each place on its own, putting the setting back.

• Verified on OJS 3.5.0.3 and 3.4.0.10.

Tests are kept in the repository and are not part of the release package.

Credits & authorship

• Maintained by OJSBR — rewrite and adaptation to OJS 3.4/3.5.
• Original work: OJS 3.3 access/downloads counter by STI-FFLCH/USP (Seção Técnica de Informática da FFLCH/USP) and ABCD/USP (Agência de Bibliotecas e Coleções Digitais da USP). See the FFLCH open-source repositories at https://github.com/fflch.
• Distributed under the GNU GPL v3, consistent with the original licensing.

AI use

Generative AI (Claude, by Anthropic) was used to write and run tests, improve the code and bring it in line with PKP standards. Every change is reviewed and tested by OJSBR, which is responsible for the published releases.

Contributing

Issues and pull requests are welcome. Please target the branch matching the OJS version you are working against.

License

Distributed under the GNU GPL v3. See LICENSE and docs/COPYING.

---

🇧🇷 Português

Plugin genérico para o Open Journal Systems (OJS) que mostra a quantidade de visualizações do resumo e de downloads (soma das galés) de cada artigo, nas listas de resumo e na página do artigo — de forma discreta, com ícones e tooltip próximos ao título.

Mantido pela OJSBR. Reescrito e adaptado a partir de um contador de acessos/downloads original do OJS 3.3 da STI-FFLCH/USP e do ABCD/USP. Veja a seção Créditos e autoria abaixo.

Compatibilidade e branches

Versão do OJS	Branch	Release do plugin
OJS 3.5.x	stable-3_5_0 (padrão)	1.3.0.3
OJS 3.4.x	stable-3_4_0	1.1.1.3

Instalação

Instale em Configurações → Website → Plugins → Enviar um novo plugin, ou extraia a pasta em plugins/generic/ (ficando plugins/generic/viewcounter/). Depois ative o Contador de visualizações na lista de plugins Genéricos.

Configuração

Em Configurações → Website → Plugins → Contador de visualizações → Configurações, escolha exibir no resumo (listas) e/ou na página do artigo (padrão: ambos ativos). A mudança vale no próximo carregamento de página, sem limpar cache algum.

Como funciona

• Nenhum template do núcleo é substituído. O selo é injetado pelos hooks de conteúdo Templates::Issue::Issue::Article (listas: sumário da edição, capa da revista, busca) e Templates::Article::Main (página do artigo); as correções do núcleo continuam chegando.
• Um CSS e um JS pequenos (css/viewcounter.css, js/viewcounter.js) movem o selo para junto do título quando o tema usa a marcação padrão. Se a marcação for outra, o selo fica onde o hook o imprimiu.
• As contagens vêm do serviço de estatísticas e ficam em cache por 24 horas, por submissão. Nas listas o cache é preenchido em lote, com uma única consulta agrupada por tipo de métrica.

Testes

PHPUnit em tests/ (sobre PKP\tests\PKPTestCase) e Cypress em cypress/tests/functional/ (rodado pelo pkp-github-actions a cada push), com os comandos da seção em inglês. A suíte cobre o selo e seus rótulos acessíveis, uma consulta agrupada por métrica nas listas e o cache de 24 horas, submissões sem métricas, o nível do site sem configurações, as classes contra o PKP instalado, as 38 traduções e o template; o Cypress confere o selo nos títulos do fascículo atual e de um artigo e o salvamento de cada lugar. Verificado no OJS 3.5.0.3 e 3.4.0.10.

Os testes ficam no repositório e não fazem parte do pacote da release.

Créditos e autoria

• Mantido pela OJSBR — reescrita e adaptação para OJS 3.4/3.5.
• Trabalho original: contador de acessos/downloads do OJS 3.3 da STI-FFLCH/USP (Seção Técnica de Informática da FFLCH/USP) e do ABCD/USP (Agência de Bibliotecas e Coleções Digitais da USP). Repositórios abertos da FFLCH: https://github.com/fflch.
• Distribuído sob a GNU GPL v3, coerente com o licenciamento original.

Uso de IA

Foi usada IA generativa (Claude, da Anthropic) para escrever e rodar testes, melhorar o código e alinhá-lo aos padrões da PKP. Toda mudança é revisada e testada pela OJSBR, que responde pelas releases publicadas.

Licença

Distribuído sob a GNU GPL v3. Veja LICENSE e docs/COPYING.