Signin/out button

Matthias_Salchner · June 8, 2017, 10:02am

Hi,

we are using OJS 2.x and i made a plugin which changes the layout of the webiste to
our needs. I also added now an “lougout” button, but I only want to display it if
a user is logged in otherwise there should be a login button.

Is there a posibility to this with javascript. Which elements can i check?

Thanks.

Best regards,
Matthias

ctgraham · June 8, 2017, 10:41am

If you have made an OJS plugin, you have access to the full PHP framework. Is there a reason you want to perform the check in Javascript instead of simply using a PHP call?

Matthias_Salchner · June 8, 2017, 11:20am

No there is no need for me to use JavaScript i can also do it with PHP, is the PHP framework documented?

ctgraham · June 8, 2017, 12:57pm

The version 2.4.8’s API documentation (via doxygen) is available here:
https://pkp.sfu.ca/ojs/doxygen/stable/html/index.html
The function you want is:
https://pkp.sfu.ca/ojs/doxygen/stable/html/classValidation.html#a916567ab2e4a2851dc0a8d33e002882d

For an example in PHP of checking whether a user is logged in, see:

github.com

pkp/pkp-lib/blob/ojs-stable-2_4_8/classes/template/PKPTemplateManager.inc.php#L192


		$this->register_function('url', array(&$this, 'smartyUrl'));
		// ajax load into a div
		$this->register_function('load_url_in_div', array(&$this, 'smartyLoadUrlInDiv'));

		if (!defined('SESSION_DISABLE_INIT')) {
			/**
			 * Kludge to make sure no code that tries to connect to
			 * the database is executed (e.g., when loading
			 * installer pages).
			 */
			$this->assign('isUserLoggedIn', Validation::isLoggedIn());

			$application =& PKPApplication::getApplication();
			$currentVersion =& $application->getCurrentVersion();
			$this->assign('currentVersionString', $currentVersion->getVersionString());

			$this->assign('itemsPerPage', Config::getVar('interface', 'items_per_page'));
			$this->assign('numPageLinks', Config::getVar('interface', 'page_links'));
		}

		$this->initialized = false;

which drives the template conditional here:

github.com

pkp/ojs/blob/ojs-stable-2_4_8/plugins/blocks/user/block.tpl#L16


* Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
*
* Common site sidebar menu -- user tools.
*
*}
<div class="block" id="sidebarUser">
	{if !$implicitAuth || $implicitAuth === $smarty.const.IMPLICIT_AUTH_OPTIONAL}
		<span class="blockTitle">{translate key="navigation.user"}</span>
	{/if}

	{if $isUserLoggedIn}
		{translate key="plugins.block.user.loggedInAs"}<br />
		<strong>{$loggedInUsername|escape}</strong>
		<ul>
			{if $hasOtherJournals}
				<li><a href="{url journal="index" page="user"}">{translate key="plugins.block.user.myJournals"}</a></li>
			{/if}
			<li><a href="{url page="user" op="profile"}">{translate key="plugins.block.user.myProfile"}</a></li>
			<li><a href="{url page="login" op="signOut"}">{translate key="plugins.block.user.logout"}</a></li>
			{if $userSession->getSessionVar('signedInAs')}
				<li><a href="{url page="login" op="signOutAsUser"}">{translate key="plugins.block.user.signOutAsUser"}</a></li>

Matthias_Salchner · June 8, 2017, 2:47pm

Okay, thanks for your answer. Is there a method to check if i am logged in my alternate header too?
There i can’t use PHP i have only the possibility use javascript and i want to place a login button in header.

Thanks in advance.

ctgraham · June 8, 2017, 7:13pm

If your alternate header is using the PKPTemplateManager for display (it probably is), the Smarty variable $isUserLoggedIn will be available to you.

Matthias_Salchner · June 9, 2017, 8:25am

I receive an “Uncaught ReferenceError: $isUserLoggedIn is not defined”, if I use this variable. How can i check if my header is using this PKPTTemplateManger.

ctgraham · June 9, 2017, 12:23pm

Typically, some code will instanciate a PKPTemplateManager:

github.com

pkp/ojs/blob/ojs-stable-2_4_8/pages/article/ArticleHandler.inc.php#L112


					$request
				);
			} else {
				return $this->download(
					array($galley->getArticleId(), $galley->getId()),
					$request
				);
			}
		}

		$templateMgr =& TemplateManager::getManager($request);
		$templateMgr->addJavaScript('js/relatedItems.js');
		$templateMgr->addJavaScript('js/inlinePdf.js');
		$templateMgr->addJavaScript('js/pdfobject.js');

		if (!$galley) {
			// Get the subscription status if displaying the abstract;
			// if access is open, we can display links to the full text.
			import('classes.issue.IssueAction');

			// The issue may not exist, if this is an editorial user

Then display a particular template using the PKPTemplateManager object:

github.com

pkp/ojs/blob/ojs-stable-2_4_8/pages/article/ArticleHandler.inc.php#L226


			'query' => 'search.allFields',
			'authors' => 'search.author',
			'title' => 'article.title',
			'abstract' => 'search.abstract',
			'indexTerms' => 'search.indexTerms',
			'galleyFullText' => 'search.fullText'
		));
		// consider public identifiers
		$pubIdPlugins =& PluginRegistry::loadCategory('pubIds', true);
		$templateMgr->assign('pubIdPlugins', $pubIdPlugins);
		$templateMgr->display('article/article.tpl');
	}

	/**
	 * Article interstitial page before PDF is shown
	 * @param $args array
	 * @param $request Request
	 * @param $galley ArticleGalley
	 */
	function viewPDFInterstitial($args, &$request, $galley = null) {
		$articleId = isset($args[0]) ? $args[0] : 0;

This template will include other templates, (for example, a common header):

github.com

pkp/ojs/blob/ojs-stable-2_4_8/templates/article/article.tpl#L16


* Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
*
* Article View.
*}
{strip}
{if $galley}
	{assign var=pubObject value=$galley}
{else}
	{assign var=pubObject value=$article}
{/if}
{include file="article/header.tpl"}
{/strip}

{if $galley}
	{if $galley->isHTMLGalley()}
		{$galley->getHTMLContents()}
	{elseif $galley->isPdfGalley()}
		{include file="article/pdfViewer.tpl"}
	{/if}
{else}
	<div id="topBar">

Can you share you code to show how your header is being referenced?