Error about ThemePlugin.inc.php

gardbeat · December 26, 2016, 2:45pm

Hi. When I access the control panel, I access all sections except the system modules, since I get the following error, I have accessed the code and I do not find the error, can someone tell me what happens? Thank you.

Fatal error: Cannot redeclare class ThemePlugin in /home/revis457/public_html/web/lib/pkp/classes/plugins/ThemePlugin.inc.php on line 709

<?php

/**

@file classes/plugins/ThemePlugin.inc.php

Copyright (c) 2014-2016 Simon Fraser University Library

Copyright (c) 2003-2016 John Willinsky

Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.

@class ThemePlugin

@ingroup plugins

@brief Abstract class for theme plugins
*/

import(‘lib.pkp.classes.plugins.LazyLoadPlugin’);

define(‘LESS_FILENAME_SUFFIX’, ‘.less’);
define(‘THEME_OPTION_PREFIX’, ‘themeOption_’);

abstract class ThemePlugin extends LazyLoadPlugin {
/**

Collection of styles

@see self::_registerStyles

@var $styles array
*/
public $styles = array();

/**

Collection of scripts

@see self::_registerScripts

@var $scripts array
*/
public $scripts = array();

/**

Theme-specific options

@var $options array;
*/
public $options = array();

/**

Parent theme (optional)

@var $parent ThemePlugin
*/
public $parent;

/**

Stored reference to option values

A null value indicates that no lookup has occured. If no options are set,

the lookup will assign an empty array.

@var $optionValues null|array;
*/
private $_optionValues = null;

/**

Constructor
*/
function __construct() {
parent::__construct();
}

/**

@copydoc Plugin::register
*/
function register($category, $path) {
if (!parent::register($category, $path)) return false;

  // Don't perform any futher operations if theme is not currently active
  if (!$this->isActive()) {
  	return true;
  }

  // Themes must initialize their functionality after all theme plugins
  // have been loaded in order to make use of parent/child theme
  // relationships
  HookRegistry::register('PluginRegistry::categoryLoaded::themes', array($this, 'themeRegistered'));
  HookRegistry::register('PluginRegistry::categoryLoaded::themes', array($this, 'initAfter'));

  // Save any theme options displayed on the appearance and site settings
  // forms
  HookRegistry::register('appearanceform::execute', array($this, 'saveOptionsForm'));
  HookRegistry::register('appearanceform::readuservars', array($this, 'readOptionsFormUserVars'));
  HookRegistry::register('sitesetupform::execute', array($this, 'saveOptionsForm'));
  HookRegistry::register('sitesetupform::readuservars', array($this, 'readOptionsFormUserVars'));

  return true;

}

/**

Fire the init() method when a theme is registered

@param $themes array List of all loaded themes

@return null
*/
public function themeRegistered($themes) {

  // Don't fully initialize the theme until OJS is installed, so that
  // there are no requests to the database before it exists
  if (defined('SESSION_DISABLE_INIT')) {
  	return;
  }

  $this->init();

}

/**

The primary method themes should use to add styles, scripts and fonts,

or register hooks. This method is only fired for the currently active

theme.

@return null
*/
public abstract function init();

/**

Perform actions after the theme has been initialized

Registers templates, styles and scripts that have been added by the

theme or any parent themes
*/
public function initAfter() {
$this->_registerTemplates();
$this->_registerStyles();
$this->_registerScripts();
}

/**

Determine whether or not this plugin is currently active

This only returns true if the theme is currently the selected theme

in a given context. Use self::getEnabled() if you want to know if the

theme is available for use on the site.

@return boolean
*/
public function isActive() {
if (defined(‘SESSION_DISABLE_INIT’)) return false;
$request = $this->getRequest();
$context = $request->getContext();
if (is_a($context, ‘Context’)) {
$activeTheme = $context->getSetting(‘themePluginPath’);
} else {
$site = $request->getSite();
$activeTheme = $site->getSetting(‘themePluginPath’);
}

  return $activeTheme == basename($this->getPluginPath());

}

/**
Add a stylesheet to load with this theme

Style paths with a .less extension will be compiled and redirected to

the compiled file.

@param $name string A name for this stylesheet

@param $style string The stylesheet. Should be a path relative to the

theme directory or, if the inline argument is included, style data to

be output.

@param $args array Optional arguments hash. Supported args:

‘context’: Whether to load this on the frontend or backend.
 default: `frontend`
‘priority’: Controls order in which styles are printed

‘addLess’: Additional LESS files to process before compiling. Array

‘addLessVariables’: A string containing additional LESS variables to
 parse before compiling. Example: "@bg:#000;"
inline bool Whether the $style value should be output directly as
 style data.
*/
public function addStyle($name, $style, $args = array()) {

  // Pass a file path for LESS files
  if (substr($style, (strlen(LESS_FILENAME_SUFFIX) * -1)) === LESS_FILENAME_SUFFIX) {
  	$args['style'] = $this->_getBaseDir($style);

  // Pass a URL for other files
  } elseif (empty($args['inline'])) {
  	if (isset($args['baseUrl'])) {
  		$args['style'] = $args['baseUrl'] . $style;
  	} else {
  		$args['style'] = $this->_getBaseUrl($style);
  	}

  // Leave inlined styles alone
  } else {
  	$args['style'] = $style;
  }

  // Generate file paths for any additional LESS files to compile with
  // this style
  if (isset($args['addLess'])) {
  	foreach ($args['addLess'] as &$file) {
  		$file = $this->_getBaseDir($file);
  	}
  }

  $this->styles[$name] = $args;

}

/**

Modify the params of an existing stylesheet

@param $name string The name of the stylesheet to modify

@param $args array Parameters to modify.

@see self::addStyle()

@return null
*/
public function modifyStyle($name, $args = array()) {

  $style = &$this->getStyle($name);

  if (empty($style)) {
  	return;
  }

  if (isset($args['addLess'])) {
  	foreach ($args['addLess'] as &$file) {
  		$file = $this->_getBaseDir($file);
  	}
  }

  if (isset($args['style']) && !isset($args['inline'])) {
  	$args['style'] = substr($args['style'], (strlen(LESS_FILENAME_SUFFIX) * -1)) == LESS_FILENAME_SUFFIX ? $this->_getBaseDir($args['style']) : $this->_getBaseUrl($args['style']);
  }

  $style = array_merge($style, $args);

}

/**

Get a style from this theme or any parent theme

@param $name string The name of the style to retrieve

@return array|null Reference to the style or null if not found
*/
public function &getStyle($name) {

  // Search this theme
  if (isset($this->styles[$name])) {
  	$style = &$this->styles[$name];
  	return $style;
  }

  // If no parent theme, no style was found
  if (!isset($this->parent)) {
  	$style = null;
  	return $style;
  }

  return $this->parent->getStyle($name);

}

/**
Add a script to load with this theme

@param $name string A name for this script

@param $script string The script to be included. Should be path relative

to the theme or, if the inline argument is included, script data to

be output.

@param $args array Optional arguments hash. Supported args:

context string Whether to load this on the frontend or backend.
 default: frontend
priority int Controls order in which scripts are printed
 default: STYLE_SEQUENCE_NORMAL
inline bool Whether the $script value should be output directly as
 script data. Used to pass backend data to the scripts.
*/
public function addScript($name, $script, $args = array()) {

  if (!empty($args['inline'])) {
  	$args['script'] = $script;
  } elseif (isset($args['baseUrl'])) {
  	$args['script'] = $args['baseUrl'] . $script;
  } else {
  	$args['script'] = $this->_getBaseUrl($script);
  }

  $this->scripts[$name] = $args;

}

/**

Modify the params of an existing script

@param $name string The name of the script to modify

@param $args array Parameters to modify.

@see self::addScript()

@return null
*/
public function modifyScript($name, $args = array()) {

  $script = &$this->getScript($name);

  if (empty($script)) {
  	return;
  }

  if (isset($args['path'])) {
  	$args['path'] = $this->_getBaseUrl($args['path']);
  }

  $script = array_merge( $script, $args );

}

/**

Get a script from this theme or any parent theme

@param $name string The name of the script to retrieve

@return array|null Reference to the script or null if not found
*/
public function &getScript($name) {

  // Search this theme
  if (isset($this->scripts[$name])) {
  	$style = &$this->scripts[$name];
  	return $style;
  }

  // If no parent theme, no script was found
  if (!isset($this->parent)) {
  	return;
  }

  return $this->parent->getScript($name);

}

/**

Add a theme option

Theme options are added programmatically to the Settings > Website >

Appearance form when this theme is activated. Common options are

colour and typography selectors.

@param $name string Unique name for this setting

@param $type string A pre-registered type of setting. Supported values:

text|colour|select. Default: text

@param $args array Optional parameters defining this setting. Some setting

types may accept or require additional arguments.

label string Locale key for a label for this field.

description string Locale key for a description for this field.

default mixed A default value. Default: ‘’
*/
public function addOption($name, $type, $args = array()) {

  if (!empty($this->options[$name])) {
  	return;
  }

  $this->options[$name] = array_merge(
  	array('type' => $type),
  	$args
  );

}

/**

Get the value of an option or default if the option is not set

@param $name The name of the option value to retrieve

@return mixed The value of the option. Will return a default if set in

the option config.
*/
public function getOption($name) {

  // Retrieve option values if they haven't been loaded yet
  if (is_null($this->_optionValues)) {
  	$pluginSettingsDAO = DAORegistry::getDAO('PluginSettingsDAO');
  	$context = Request::getContext();
  	$contextId = $context ? $context->getId() : 0;
  	$this->_optionValues = $pluginSettingsDAO->getPluginSettings($contextId, $this->getName());
  }

  if (isset($this->_optionValues[$name])) {
  	return $this->_optionValues[$name];
  }

  // Return a default if no value is set
  $option = $this->getOptionConfig($name);
  return $option && isset($option['default']) ? $option['default'] : null;

}

/**

Get an option’s configuration settings

This retrives option settings for any option attached to this theme or

any parent theme.

@param $name The name of the option config to retrieve

@return false|array The config array for this option. Or false if no

config is found.
*/
public function getOptionConfig($name) {

  if (isset($this->options[$name])) {
  	return $this->options[$name];
  }

  return $this->parent ? $this->parent->getOptionConfig($name) : false;

}

/**

Get all options’ configuration settings.

This retrieves a single array containing options settings for this

theme and any parent themes.

@return array
*/
public function getOptionsConfig() {

  if (!$this->parent) {
  	return $this->options;
  }

  return array_merge(
  	$this->parent->getOptionsConfig(),
  	$this->options
  );

}

/**

Get all option values

This retrieves a single array containing option values for this theme

and any parent themes.

@return array
*/
public function getOptionValues() {

  $pluginSettingsDAO = DAORegistry::getDAO('PluginSettingsDAO');

  $context = Request::getContext();
  $contextId = empty($context) ? 0 : $context->getId();
  $values = $pluginSettingsDAO->getPluginSettings($contextId, $this->getName());

  if (!$this->parent) {
  	return $values;
  }

  return array_merge(
  	$this->parent->getOptionValues(),
  	$values
  );

}

/**

Sanitize and save a theme option

@param $name string A unique id for the option to save

@param $value mixed The new value to save

@param $contextId int Optional context id. Defaults to the current

context
*/
public function saveOption($name, $value, $contextId = null) {

  $option = !empty($this->options[$name]) ? $this->options[$name] : null;

  if (is_null($option)) {
  	return $this->parent ? $this->parent->saveOption($name, $value, $contextId) : false;
  }

  $type = '';
  switch ($option['type']) {
  	case 'text' :
  	case 'select' :
  	case 'colour' :
  		$type = 'text';
  		break;
  }

  if (is_null($contextId)) {
  	$context = Request::getContext();
  	$contextId = $context->getId();
  }

  $this->updateSetting($contextId, $name, $value, $type);

  // Clear the template cache so that new settings can take effect
  $templateMgr = TemplateManager::getManager($this->getRequest());
  $templateMgr->clearTemplateCache();
  $templateMgr->clearCssCache();

}

/**

Save options in any form

This helper function allows you to save theme options attached to any

form by hooking into the form’s execute function.

@see Form::execute()

@param $hookName string

@param $args array Arguments passed via the hook

form Form The form object from which option values can be retrieved.

request Request
*/
public function saveOptionsForm($hookName, $args) {

  $form = $args[0];

  $options = $this->getOptionsConfig();

  // Ensure theme options from the site-wide settings form are applied
  // to the site-wide context
  if ($hookName == 'sitesetupform::execute') {
  	$contextId = 0;
  }

  foreach ($options as $optionName => $optionArgs) {
  	$value = $form->getData(THEME_OPTION_PREFIX . $optionName);
  	if ($value === null) {
  		continue;
  	}
  	if (isset($contextId)) {
  		$this->saveOption($optionName, $value, $contextId);
  	} else {
  		$this->saveOption($optionName, $value);
  	}
  }

}

/**

Retrieve user-entered values for options from any form

This helper function allows you to hook into any form to add theme option

values to the form’s user input data.

@see Form::readUserVar()

@param $hookName string

@param $args array Arguments passed via the hook

form Form The form object from which option values can be retrieved.

vars Array Key/value store of the user vars read by the form
*/
public function readOptionsFormUserVars($hookName, $args) {

  $form = $args[0];

  $options = $this->getOptionsConfig();

  foreach ($options as $optionName => $optionArgs) {
  	$fullOptionName = THEME_OPTION_PREFIX . $optionName;
  	$form->setData($fullOptionName, Request::getUserVar($fullOptionName));
  }

}

/**

Set a parent theme for this theme

@param $parent string Key in the plugin registry for the parent theme

@return null
*/
public function setParent($parent) {
$parent = PluginRegistry::getPlugin(‘themes’, $parent);

  if (!is_a($parent, 'ThemePlugin')) {
  	return;
  }

  $this->parent = $parent;
  $this->parent->init();

}

/**

Register directories to search for template files

@return null
*/
private function _registerTemplates() {

  // Register parent theme template directory
  if (isset($this->parent) && is_a($this->parent, 'ThemePlugin')) {
  	$this->parent->_registerTemplates();
  }

  // Register this theme's template directory
  $request = $this->getRequest();
  $templateManager = TemplateManager::getManager($request);
  array_unshift(
  	$templateManager->template_dir,
  	$this->_getBaseDir('templates')
  );

}

/**

Register stylesheets and font assets

Passes styles defined by the theme to the template manager for handling.

@return null
*/
private function _registerStyles() {

  if (isset($this->parent)) {
  	$this->parent->_registerStyles();
  }

  $request = $this->getRequest();
  $dispatcher = $request->getDispatcher();
  $templateManager = TemplateManager::getManager($request);

  foreach($this->styles as $name => $data) {

  	if (empty($data['style'])) {
  		continue;
  	}

  	// Compile LESS files
  	if ($dispatcher && substr($data['style'], (strlen(LESS_FILENAME_SUFFIX) * -1)) == LESS_FILENAME_SUFFIX) {
  		$styles = $dispatcher->url(
  			$request,
  			ROUTE_COMPONENT,
  			null,
  			'page.PageHandler',
  			'css',
  			null,
  			array(
  				'name' => $name,
  			)
  		);
  	} else {
  		$styles = $data['style'];
  	}

  	unset($data['style']);

  	$templateManager->addStylesheet($name, $styles, $data);
  }

}

/**

Register script assets

Passes scripts defined by the theme to the template manager for handling.

@return null
*/
public function _registerScripts() {

  if (isset($this->parent)) {
  	$this->parent->_registerScripts();
  }

  $request = $this->getRequest();
  $templateManager = TemplateManager::getManager($request);

  foreach($this->scripts as $name => $data) {
  	$script = $data['script'];
  	unset($data['script']);
  	$templateManager->addJavaScript($name, $script, $data);
  }

}

/**

Get the base URL to be used for file paths

A base URL for loading LESS/CSS/JS files in elements. It will

also be set to the @baseUrl variable before LESS files are compiloed so

that images and fonts can be located.

@param $path string An optional path to append to the base

@return string
*/
public function _getBaseUrl($path = ‘’) {
$request = $this->getRequest();
$path = empty($path) ? ‘’ : DIRECTORY_SEPARATOR . $path;
return $request->getBaseUrl() . DIRECTORY_SEPARATOR . $this->getPluginPath() . $path;
}

/**

Get the base path to be used for file references

@param $path string An optional path to append to the base

@return string
*/
public function _getBaseDir($path = ‘’) {
$path = empty($path) ? ‘’ : DIRECTORY_SEPARATOR . $path;
return Core::getBaseDir() . DIRECTORY_SEPARATOR . $this->getPluginPath() . $path;
}

/**

Check if the passed colour is dark

This is a utility function to determine the darkness of a hex colour. This

is designed to be used in theme colour options, so that text can be

adjusted to ensure it’s readable on light or dark backgrounds. You can

specify the brightness threshold by passing in a $limit value. Higher

values are brighter.

Based on: http://stackoverflow.com/a/8468448/1723499

@since 0.1
*/
function isColourDark( $colour, $limit = 130 ) {
$colour = str_replace( ‘#’, ‘’, $colour );
$r = hexdec( substr( $colour, 0, 2 ) );
$g = hexdec( substr( $colour, 2, 2 ) );
$b = hexdec( substr( $colour, 4, 2 ) );
$contrast = sqrt(
$r * $r * .241 +
$g * $g * .691 +
$b * $b * .068
);
return $contrast < $limit;
}
}

?>

asmecher · December 30, 2016, 6:06pm

Hi @gardbeat,

Do you have two files in your installation called ThemePlugin.inc.php? I suspect you’ve mixed code from two different versions of OJS somehow.

Regards,
Alec Smecher
Public Knowledge Project Team

gardbeat · December 30, 2016, 7:29pm

Hello @asmecher, how could I check that I have the duplicate file as you tell me?

asmecher · December 30, 2016, 7:32pm

Hi @gardbeat,

In my Linux/Unix environment, I would run…

cd /path/to/ojs
find . -name ThemePlugin.inc.php

Regards,
Alec Smecher
Public Knowledge Project Team

gardbeat · December 30, 2016, 7:48pm

Hello @asmecher.

And if I do not have console mode, how could I look for it?

asmecher · December 30, 2016, 8:00pm

Hi @gardbeat,

Without knowing anything about your host, I’m afraid I have no idea.

Regards,
Alec Smecher
Public Knowledge Project Team

gardbeat · December 31, 2016, 8:29pm

Hi @asmecher.

The hosting I use is based on CPanel. I’m waiting if I have to clarify some more.

asmecher · January 2, 2017, 1:47am

Hi @gardbeat,

There may not be an easy way to find files by name on CPanel without browsing for them. The two most likely locations for ThemePlugin.inc.php are in lib/pkp/classes/plugins and classes/plugins.

Regards,
Alec Smecher
Public Knowledge Project Team

gardbeat · January 2, 2017, 11:23am

Hello @asmecher

I found the same file on both paths that you indicate. What should I do?

asmecher · January 2, 2017, 5:23pm

Hi @gardbeat,

It sounds like you’ve mixed code from 2 versions of OJS together. How did you upgrade your code?

Regards,
Alec Smecher
Public Knowledge Project Team

gardbeat · January 2, 2017, 5:29pm

Hi, @asmecher.

Thinking of doing an update to OJS version 3, which I then went back again, can that be why?

asmecher · January 2, 2017, 8:56pm

Hi @gardbeat,

However you do this, it’s important not to mix the two codebases together. Have a look at the “full package” upgrade instructions in docs/README for information on changing codebases without mixing.

Regards,
Alec Smecher
Public Knowledge Project Team

gardbeat · January 2, 2017, 9:11pm

Hi @asmecher.

I’m reading the readme that you tell me, but I do not see, how can I solve the error line that indicates the php that I attached above.

Tell you that the web works correctly, except when I access the section of plugins inside the control panel (which is only when I get the error). For the rest, I can work normally within the web.

P.D. I do not want to upgrade to version 3, I want to stay with version 2.x

asmecher · January 4, 2017, 7:23pm

Hi @gardbeat,

The PHP error is occurring because you have mixed OJS 2.x and OJS 3.x code into the same directory structure. The area of the documentation that I recommended above describes how to change what code you’re using without mixing two codebases together. If you follow those instructions with a clean copy of the OJS 2.x code, it’ll allow you to remove the mixed code you’re currently using.

Regards,
Alec Smecher
Public Knowledge Project Team

gardbeat · January 4, 2017, 10:05pm

Hi @asmecher,

Sorry to be so heavy, but can you point me to what line it appears? I honestly do not see it, it will be because of my low level of English. I’m waiting.

asmecher · January 4, 2017, 10:19pm

Hi @gardbeat,

Ah, my apologies! You’ll want to look in docs/UPGRADE, not docs/README. See e.g.:

github.com

pkp/ojs/blob/ojs-stable-2_4_8/docs/UPGRADE#L70..L91


the migration process can take hours. 
  

Obtaining the latest OJS code
-----------------------------

The OJS source code is available in three forms: as a complete stand-alone 
package, from read-only github access, and as patches against older releases 
of OJS.

1. Full Package

If you have not made local code modifications to the system, upgrade by 
downloading the complete package for the latest release of OJS:

    - Download and decompress the package from the OJS web site
    - Move or copy the following files and directories from your current OJS
      installation:
        - config.inc.php
        - public/
        - Your uploaded files directory ("files_dir" in config.inc.php), if it

Regards,
Alec Smecher
Public Knowledge Project Team

gardbeat · January 4, 2017, 10:36pm

@asmecher, I do not understand, if the webpage works and almost the whole control panel, why do I have to install the complete package as if I started the web from scratch?

In addition, I want to indicate that when I retreated the version, I made it through the hosting through a backup that I had created with the previous version.

asmecher · January 4, 2017, 10:49pm

Hi @gardbeat,

It’s because your installation contains both elements of OJS 2.x and 3.x, mixed together in the same directories. We’ve established that ThemePlugin.inc.php is an example of this, but there are almost certainly others. The way to comprehensively resolve this is what I’ve described. Cleaning it up manually will be time-consuming and uncertain.

Regards,
Alec Smecher
Public Knowledge Project Team

gardbeat · January 6, 2017, 3:17pm

Hello @asmecher

I have proven by following your explanations, re-copying the files you told me. Indicating when the user requested me, clvae and name of the DB and when I give him to save, the error that gives me is the same with which I start this post:

Fatal error: Cannot redeclare class ThemePlugin in /home/revis457/public_html/web/lib/pkp/classes/plugins/ThemePlugin.inc.php on line 709

Therefore the error is not solved by loading the previous copy, since after reloading it, the error continues, what can it be then?

The error only appears on the screen when I access this section within the administrator control panel:

If you want I give you access to the web so that you see the error first hand. I’m waiting

asmecher · January 6, 2017, 3:38pm

Hi @gardbeat,

Do you still have ThemePlugin.inc.php in both places? If so, then you’re still mixing code from two versions. Following the instructions should’ve resolved that.

Regards,
Alec Smecher
Public Knowledge Project Team