Plugins re-installation after an upgrade

dung · May 19, 2021, 10:53pm

Hello there,

I have a quick question but I cannot find it anywhere in the forum. Do I have to re-install (download) plugins after a successful upgrade?

I have successfully upgraded from OJS 3.1.2-4 to 3.2.1-4. But the some plugins seems to be missing, because of this I can not know for certain if plugins should have been downloaded by the upgrade script and if not what the best way to resolve it?

Thank you and best regards,

Dung.

israel.cefrin · May 20, 2021, 2:19am

Hi @dung

Short answer: yes.
You do need upgrade or reinstall plugins after OJS upgrade.
The reason is that plugins have different versions that are compatible with OJS different versions. It applies to block plugin and themes.

If you upgrade using git you can upgrade your plugins by plugin gallery. If you can’t see the option to upgrade your plugins, you will need to clone/download them from their original repo and follow the instructions to create a correct tarball (name folder) and upload them using the Install plugin feature.

Best,
Israel Cefrin
PKP Team

dung · May 20, 2021, 3:47am

Hello @israel.cefrin

First of all thank you for a quick response. I have 2 follow up questions:

what is “block plugin” interested to learn the terminology. Most of the plugins I have been working with are in /var/www/html/ojs-3.2.1-4/plugins/themes and /var/www/html/ojs-3.2.1-4/plugins/generic ?
I did not upgrade using git. I downloaded the new version and ran script - “php tools/upgrade.php upgrade” linux command line. So can I just download the plugin tar file and extract it into /var/www/html/ojs-3.2.1-4/plugins/generic ?

Best regards,

Dung.

marc · May 20, 2021, 10:04am

If you get the official tarball from the pkp website, and you uncompress it “over” your existing 3.1.2 (overwriting your existing files), most of your plugins will be updated to the ones included in the release.

To make it clear:

The tarball release don’t include all the plugins, only the ones maintained by PKP.
This plugins where updated in the date of the release, so you will find some of them will need to be updated (because since the release till now, new versions appear).

If you make a git installation, you get the last release of each plugin, in the moment you install/upgrade.

So, if you do a tarball upgrade, you can unzip and then manually update the plugins or… use this jewel @ctgraham released yesterday:

gist.github.com

https://gist.github.com/ctgraham/d21f4153dd95928c740b533a70b3ad94

pkp-plugin-cli.md

# PKP plugin shim for CLI usage

## Background
Problem: how do we interact with the [PKP Plugin Gallery](https://docs.pkp.sfu.ca/learning-ojs/en/settings-website#plugin-gallery) outside of the UI?  The correct way to approach this is to abstract the [plugin gallery operations](https://github.com/pkp/pkp-lib/blob/9f48cbe60d4471a23ffd8a1a46eb1a7e0986c027/controllers/grid/plugins/PluginGalleryGridHandler.inc.php#L271-L341) into a service class which would be reusable across the UI and the CLI, but we're not there yet.  Instead, let's cheat.

## CLI tool
https://github.com/pkp/pkp-lib/compare/stable-3_1_2...ulsdevteam:pluginGalleryCLI?expand=1

This provides a new utility with just one option:
```

This file has been truncated. show original

Cheers,
m.

dung · May 20, 2021, 2:12pm

Good Morning @marc

This Plugin shim looks like a great automation, I will try it out and report back. Thank you for your time. I appreciate the explanation.

Best,

Dung.

israel.cefrin · May 20, 2021, 2:49pm

Hi @dung

what is “block plugin” interested to learn the terminology.

A block plugin is usually all those when enabled will be present some information in the sidebar, i.e.: twitter, mostRead, etc…

Regarding your second question, I think @marc has addressed it.

Best,
Israel Cefrin
PKP Team

dung · May 20, 2021, 6:11pm

Hello @israel.cefrin

Thank you for the explanation, and yes I am working on @marc 's suggestion then report the result.

Regards,

Dung.

dung · May 20, 2021, 8:06pm

Hello @marc ,

I got this error “Could not open input file: lib/pkp/tools/pluginGallery.php” after running command “sudo -u apache php lib/pkp/tools/pluginGallery.php help” - Where should I find pluginGallery.php script? Thank you so much for your time.

Best regards,

Dung.

ctgraham · May 20, 2021, 8:28pm

Hi, @dung . The pluginGallery.php script is not yet incorporated in the distributed package of OJS, but you can download a copy here before it is formally packaged there:

github.com

ulsdevteam/pkp-lib/blob/8e7d9e5c5fd37bceb621fe65abd51371c0348f8f/tools/pluginGallery.php

<?php

/**
 * @file tools/pluginGalleryTool.php
 *
 * Copyright (c) 2014-2019 Simon Fraser University
 * Copyright (c) 2003-2019 John Willinsky
 * Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
 *
 * @class PluginGalleryTool
 * @ingroup tools
 *
 * @brief CLI tool for installing a plugin version descriptor.
 */

define('RUNNING_UPGRADE', 1);

require(dirname(dirname(dirname(dirname(__FILE__)))) . '/tools/bootstrap.inc.php');

import('lib.pkp.classes.plugins.PluginGalleryDAO');

This file has been truncated. show original

dung · May 20, 2021, 9:57pm

Hello @ctgraham ,

So I :

downloaded the above mentioned script (pkp-lib/pluginGallery.php at 8e7d9e5c5fd37bceb621fe65abd51371c0348f8f · ulsdevteam/pkp-lib · GitHub), created it as pluginGallery.php under /var/www/html/ojs-3.2.1-4/lib/pkp/tools/pluginGallery.php dir
And created a second script pluginInstall.sh ( Install the latest version of all missing plugins - A PKP plugin shim for the CLI · GitHub) inside /var/www/html/ojs-3.2.1-4/pluginInstall.sh dir
Then ran ./pluginInstall.sh

I got some (one) errors as seen below:

Install plugin version tool
Usage: lib/pkp/tools/installPluginVersion.php path/to/version.xml
plugins/importexport/portico
PHP Parse error: syntax error, unexpected ‘)’ in /var/www/html/ojs-3.2.1-4/plugins/importexport/portico/PorticoExportPlugin.inc.php on line 155
plugins/generic/ror

Install plugin version tool
Usage: lib/pkp/tools/installPluginVersion.php path/to/version.xml
plugins/generic/browseBySection
PHP Parse error: syntax error, unexpected ‘)’ in /var/www/html/ojs-3.2.1-4/plugins/importexport/portico/PorticoExportPlugin.inc.php on line 155
plugins/reports/scieloSubmissionsReport
PHP Parse error: syntax error, unexpected ‘)’ in /var/www/html/ojs-3.2.1-4/plugins/importexport/portico/PorticoExportPlugin.inc.php on line 155

I am not sure what to do, can you point me.

Regards,

Dung.

dung · May 20, 2021, 10:07pm

Hi again @ctgraham ,

for the second method " Or, upgrade all plugins: " A PKP plugin shim for the CLI · GitHub

I got the same error:

Thank you for your time.

Dung.

ctgraham · May 21, 2021, 3:11pm

The Portico plugin reports that it is compatible with OJS 3.2, but it is only compatible with OJS 3.2 and PHP 7.3. You can remove the files under “plugins/importexport/portico”, or you can upgrade to PHP 7.3.

dung · May 21, 2021, 4:58pm

Thank you @ctgraham ,

Automated script went without error following your instruction, can I please ask you one last question. I read “Background” here A PKP plugin shim for the CLI · GitHub - but I still do not entirely understand what the script does to all plugins.

Best regards,

Dung.

dung · May 22, 2021, 1:36pm

Hi @ctgraham ,

The reason I asked previous question was because even the plugins re-installation script successfully ran, but our OJS still has missed out 2 plugins OpenAIRE and SWORD (Some of the plugins were added and reinstalled as expected). I re-ran the script second time and same result, these 2 plugins were there before the upgrade so we expect that they will be reinstalled by the script.

Or should I manually reinstall these 2 plugins?

Thank you for your time.

Dung.

ctgraham · May 23, 2021, 2:48pm

The script pluginGallery.php looks at the Plugin Gallery for your version of OJS, and lists the latest version of each plugin marked as compatible with that version.

The first bash script under " Install the latest version of all missing plugins" selects only those plugins marked with the status of “noInstalledVersion” (not installed) and then:

clears the existing plugin folder (if any)
downloads the latest version to /tmp
extracts the download from /tmp to the plugin folder
runs the plugin installation script

Similarly, the bash script for “upgrade all plugins” selects only those plugins marked with the status of “installedVersionOlder” (update is available) and then:

clears the existing plugin folder
downloads the latest version to /tmp
extracts the download from /tmp to the plugin folder
runs the software upgrade script

In my testing, I found that some of the permissions in the tar files weren’t suitable for my hosting default (dedicated apache user with mod_php under RHEL, where apache cannot write to the php files). Specifically, the tar files were packaged with permissions for the user, but not for the group or world. As a result, when I untar’d the plugin as myself, and then ran the install/upgrade as apache, the apache user could not read the new plugin files. I had to change the permissions to allow apache to read the plugin files.

This may be the case with your missed plugins, but will depend on numerous factors specific to your server environment.

dung · May 25, 2021, 5:49pm

Hello @marc ,

How do we find out what plugins are maintained by PKP for example SWORD and OPENAIRE plugins?

Thank you!

Dung.

dung · May 25, 2021, 7:44pm

Hello again @marc ,

I found out that SWORD created by PKP and OPENAIRE created by The Federation of Finnish Learned Societies (https://tsv.fi) with funding provided by the Deutsche Forschungsgemeinschaft and Freie Universität Berlin/CeDiS.

This explained why @ctgraham 's script upgraded/installed SWORD but did not upgraded/installed OPENAIRE.

I got all the answers I need to understand about plugins. Please close this ticket and thank you everyone has helped me with this.

Best regards,

Dung.

marc · May 25, 2021, 8:37pm

This is the list that I suspect Clinton’s script gets:
http://pkp.sfu.ca/ojs/xml/plugins.xml

Happy you found the authorship information by your own.

Cheers,
m.