plugins: Support Multi-instance Services

Support ability to register multiple instances of the same backend
osTicket · Jul 1, 2022 · 0b93b48 · 0b93b48
1 parent a2e78bf
commit 0b93b48
Show file tree

Hide file tree

Showing 6 changed files with 57 additions and 30 deletions.
diff --git a/include/class.auth.php b/include/class.auth.php
@@ -146,7 +146,7 @@ function attemptAutoRegister() {
         );
         if ($bk->supportsInteractiveAuthentication())
             // User can only be authenticated against this backend
-            $defaults['backend'] = $bk::$id;
+            $defaults['backend'] = $bk->getBkId();
         if ($this_form->isValid(function($f) { return !$f->isVisibleToUsers(); })
                 && ($U = User::fromVars($this_form->getClean()))
                 && ($acct = ClientAccount::createForUser($U, $defaults))
@@ -177,7 +177,7 @@ function attemptAutoRegister() {
 abstract class AuthenticationBackend extends ServiceRegistry {
     static $name;
     static $id;
-
+    protected  $config;
 
     static function register($class) {
         if (is_string($class) && class_exists($class))
@@ -187,7 +187,7 @@ static function register($class) {
                 || !($class instanceof AuthenticationBackend))
             return false;
 
-        static::$registry[$class->getId()] = $class;
+        static::$registry[$class->getBkId()] = $class;
     }
 
     static function allRegistered() {
@@ -330,11 +330,11 @@ static function getSearchDirectories() {
         $backends = array();
         foreach (StaffAuthenticationBackend::allRegistered() as $bk)
             if ($bk instanceof AuthDirectorySearch)
-                $backends[$bk::$id] = $bk;
+                $backends[$bk->getBkId()] = $bk;
 
         foreach (UserAuthenticationBackend::allRegistered() as $bk)
             if ($bk instanceof AuthDirectorySearch)
-                $backends[$bk::$id] = $bk;
+                $backends[$bk->getBkId()] = $bk;
 
         return array_unique($backends);
     }
@@ -570,7 +570,7 @@ function login($staff, $bk) {
         }
 
         // Tag the authkey.
-        $authkey = $bk->getId().':'.$authkey;
+        $authkey = $bk->getBkId().':'.$authkey;
         // Now set session crap and lets roll baby!
         $authsession = &$_SESSION['_auth']['staff'];
         $authsession = array(); //clear.
@@ -677,7 +677,8 @@ function renderExternalLink() {
                 $this->getServiceName());
         ?>
         <a class="external-sign-in" title="<?php echo $service; ?>"
-                href="login.php?do=ext&amp;bk=<?php echo urlencode(static::$id); ?>">
+                href="login.php?do=ext&amp;bk=<?php echo
+                urlencode($this->getBkId()); ?>">
 <?php if (static::$sign_in_image_url) { ?>
         <img class="sign-in-image" src="<?php echo static::$sign_in_image_url;
             ?>" alt="<?php echo $service; ?>"/>
@@ -695,15 +696,17 @@ function renderExternalLink() {
     }
 
     function triggerAuth() {
+        $_SESSION['ext:bk:id'] = $this->getBkId();
+        // For legacy plugins prior to v1.17
         $_SESSION['ext:bk:class'] = get_class($this);
     }
 }
 Signal::connect('api', function($dispatcher) {
     $dispatcher->append(
         url('^/auth/ext$', function() {
-            if ($class = $_SESSION['ext:bk:class']) {
-                $bk = StaffAuthenticationBackend::getBackend($class::$id)
-                    ?: UserAuthenticationBackend::getBackend($class::$id);
+            if ($id = $_SESSION['ext:bk:id']) {
+                $bk = StaffAuthenticationBackend::getBackend($id)
+                    ?: UserAuthenticationBackend::getBackend($id);
                 if ($bk instanceof ExternalAuthentication)
                     $bk->triggerAuth();
             }
@@ -751,7 +754,7 @@ function login($user, $bk) {
         global $ost;
 
         if (!$user || !$bk
-                || !$bk::$id //Must have ID
+                || !$bk->getBkId() //Must have ID
                 || !($authkey = $bk->getAuthKey($user)))
             return false;
 
@@ -796,7 +799,7 @@ function setAuthKey($user, $bk, $key=false) {
         $authkey = $key ?: $bk->getAuthKey($user);
 
         //Tag the authkey.
-        $authkey = $bk::$id.':'.$authkey;
+        $authkey = $bk->getBkId().':'.$authkey;
 
         //Set the session goodies
         $authsession = &$_SESSION['_auth']['user'];
@@ -882,10 +885,11 @@ function renderExternalLink() {
 
         ?>
         <a class="external-sign-in" title="<?php echo $service; ?>"
-                href="login.php?do=ext&amp;bk=<?php echo urlencode(static::$id); ?>">
+                href="login.php?do=ext&amp;bk=<?php echo
+                urlencode($this->getBkId()); ?>">
 <?php if (static::$sign_in_image_url) { ?>
         <img class="sign-in-image" src="<?php echo static::$sign_in_image_url;
-            ?>" alt="<?php $service; ?>"/>
+            ?>" alt="<?php echo $service; ?>"/>
 <?php } else { ?>
             <div class="external-auth-box">
             <span class="external-auth-icon">
@@ -900,6 +904,8 @@ function renderExternalLink() {
     }
 
     function triggerAuth() {
+        $_SESSION['ext:bk:id'] = $this->getBkId();
+        // Legacy for plugins prior to v1.17
         $_SESSION['ext:bk:class'] = get_class($this);
     }
 }

diff --git a/include/class.plugin.php b/include/class.plugin.php
@@ -45,6 +45,10 @@ function getInfo() {
         return array_merge($this->config, $this->defaults ?? []);
     }
 
+    function getInstance() {
+        return $this->instance;
+    }
+
     function get($key, $default=null) {
         if (isset($this->config[$key]))
             return $this->config[$key];

diff --git a/include/class.util.php b/include/class.util.php
@@ -316,12 +316,29 @@ static function getVarScope() {
 abstract class  ServiceRegistry {
     static protected $registry = array();
 
+    public function __isset($property) {
+        return isset($this->$property);
+    }
+
     function getId() {
-         if (isset($this->config)
-                 && is_a($this->config, 'PluginConfig'))
-              return $this->config->getId();
+        return static::$id;
+    }
+
+    /*
+     *  getBkId
+     *
+     *  Get service id used to register the service. Plugins adds a tag
+     *  making it possible to register multiple instances of the same
+     *  plugin.
+     *
+     */
+    function getBkId() {
+        $id = $this->getId();
+        if (isset($this->config)
+                && is_a($this->config, 'PluginConfig'))
+            $id =sprintf('%s.%s', $id, $this->config->getId());
 
-         return static::$id;
+        return $id;
     }
 
     function getName() {

diff --git a/include/client/register.inc.php b/include/client/register.inc.php
@@ -7,7 +7,7 @@
 if (isset($user) && $user instanceof ClientCreateRequest) {
     $bk = $user->getBackend();
     $info = array_merge($info, array(
-        'backend' => $bk::$id,
+        'backend' => $bk->getBkId(),
         'username' => $user->getUsername(),
     ));
 }
@@ -61,7 +61,7 @@
         <input type="hidden" name="backend" value="<?php echo $info['backend']; ?>"/>
         <input type="hidden" name="username" value="<?php echo $info['username']; ?>"/>
 <?php foreach (UserAuthenticationBackend::allRegistered() as $bk) {
-    if ($bk::$id == $info['backend']) {
+    if ($bk->getBkId() == $info['backend']) {
         echo $bk->getName();
         break;
     }

diff --git a/include/staff/templates/user-register.tmpl.php b/include/staff/templates/user-register.tmpl.php
@@ -55,8 +55,8 @@
                 <option value="">&mdash; <?php echo __('Use any available backend'); ?> &mdash;</option>
             <?php foreach (UserAuthenticationBackend::allRegistered() as $ab) {
                 if (!$ab->supportsInteractiveAuthentication()) continue; ?>
-                <option value="<?php echo $ab::$id; ?>" <?php
-                    if ($info['backend'] == $ab::$id)
+                <option value="<?php echo $ab->getBkId(); ?>" <?php
+                    if ($info['backend'] == $ab->getBkId())
                         echo 'selected="selected"'; ?>><?php
                     echo $ab->getName(); ?></option>
             <?php } ?>

diff --git a/include/upgrader/streams/core/c37e1656-e2b4e5cb.task.php b/include/upgrader/streams/core/c37e1656-e2b4e5cb.task.php
@@ -33,35 +33,35 @@ function run($time) {
         $ost->plugins->bootstrap();
         // Staff auth backends
         foreach (StaffAuthenticationBackend::allRegistered() as $p) {
-            if ($p::$id && $p->getId() == $p::$id)
+            if ($p::$id && $p->getBkId() == $p::$id)
                 continue;
             Staff::objects()
                 ->filter(['backend' => $p::$id])
-                ->update(['backend' => $p->getId()]);
+                ->update(['backend' => $p->getBkId()]);
         }
         // User auth backends
         foreach (UserAuthenticationBackend::allRegistered() as $p) {
-            if ($p::$id && $p->getId() == $p::$id)
+            if ($p::$id && $p->getBkId() == $p::$id)
                 continue;
             UserAccount::objects()
                 ->filter(['backend' => $p::$id])
-                ->update(['backend' => $p->getId()]);
+                ->update(['backend' => $p->getBkId()]);
         }
         // 2fa backends
         foreach (Staff2FABackend::allRegistered() as $p) {
-            if ($p::$id && $p->getId() == $p::$id)
+            if ($p::$id && $p->getBkId() == $p::$id)
                 continue;
             ConfigItems::objects()
                 ->filter(['default_2fa' => $p::$id])
-                ->update(['default_2fa' => $p->getId()]);
+                ->update(['default_2fa' => $p->getBkId()]);
         }
         // Password Policies
         $config = $ost->getConfig();
         foreach (PasswordPolicy::allActivePolicies() as $p) {
             if ($config->get('agent_passwd_policy') == $p::$id)
-                $config->set('agent_passwd_policy', $p->getId());
+                $config->set('agent_passwd_policy', $p->getBkId());
             if ($config->get('client_passwd_policy') == $p::$id)
-                $config->set('client_passwd_policy', $p->getId());
+                $config->set('client_passwd_policy', $p->getBkId());
         }
     }
 }