AuthPlugin.inc.php

<?php
 
define('AUTH_PLUGIN_CATEGORY', 'auth');
import('lib.pkp.classes.plugins.Plugin');
 
abstract class AuthPlugin extends Plugin {
 
   var $settings;
 
   var $authId;
 
   function __construct($settings = array(), $authId = null) {
      parent::__construct();
      $this->settings = $settings;
      $this->authId = $authId;
   }
 
 
   //
   // General Plugin Functions
   //
   function getSettingsTemplate() {
      return $this->getTemplateResource('settings.tpl');
   }
 
 
   //
   // Wrapper Functions
   //
   function doGetUserInfo($user) {
      if (isset($this->settings['syncProfiles'])) {
         return $this->getUserInfo($user);
      }
      return false;
   }
 
   function doSetUserInfo($user) {
      if (isset($this->settings['syncProfiles'])) {
         return $this->setUserInfo($user);
      }
      return false;
   }
 
   function doSetUserPassword($username, $password) {
      if (isset($this->settings['syncPasswords'])) {
         return $this->setUserPassword($username, $password);
      }
      return false;
   }
 
   function doCreateUser($user) {
      if (isset($this->settings['createUsers'])) {
         return $this->createUser($user);
      }
      return false;
   }
 
 
   //
   // Core Plugin Functions
   // (Must be implemented by every authentication plugin)
   //
   abstract function getInstance($settings, $authId);
 
   abstract function authenticate($username, $password);
 
 
   //
   // Optional Plugin Functions
   // (Required for extended functionality but not for authentication-only plugins)
   //
   function userExists($username) {
      return false;
   }
 
   function getUserInfo($user) {
      return false;
   }
 
   function setUserInfo($user) {
      return false;
   }
 
   function setUserPassword($username, $password) {
      return false;
   }
 
   function createUser($user) {
      return false;
   }
 
   function deleteUser($username) {
      return false;
   }
 
   function isSitePlugin() {
      return true;
   }
}