Bug 5531 - Add runtime environment check to plug-ins
Add runtime environment check to plug-ins
Status: NEW
Product: OJS
Classification: Unclassified
Component: Plug-ins
3.0
PC Linux
: P3 normal
Assigned To: PKP Support
Depends on:
Blocks:
  Show dependency treegraph
 
Reported: 2010-06-28 14:23 PDT by jerico
Modified: 2013-05-29 16:22 PDT (History)
2 users (show)

See Also:
Version Reported In: 2.3.2
Also Affects: OCS 2.3.4, OHS 2.3.2, OMP 1.0


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description jerico 2010-06-28 14:23:46 PDT
An automatic runtime environment definition and validation has been implemented for filters (see the Filter class, search for runtime). We should do the same for plug-ins. The advantages are:
- dependencies on installation requirements are well documented within the plug-in
- dependencies can be checked while installing/enabling the plug-in and meaningful error messages can be produced when the runtime environment is not sufficient
- we can avoid loading plug-ins which have unmet dependencies and issue a meaningful error message

Implementation notes:
- The version.xml file can be used to document runtime dependencies, they can be retrieved from there and saved in the plugin-settings table during installation (see FilterDAO for the Filter-specific persistence layer of runtime requirements)
- The RuntimeEnvironment class has been implemented in a way that it can also be used to very easily check dependencies for plug-ins.
Comment 1 jerico 2010-06-28 14:24:42 PDT
And of course this can be done in a backwards compatible way by assuming "no runtime requirements" if the corresponding settings are absent.
Comment 2 jerico 2010-08-24 18:24:49 PDT
deferring