From 12f6c2acb29cbea6f41d1152eb27affa358c196f Mon Sep 17 00:00:00 2001
From: Christoph Burschka
Date: Tue, 30 Oct 2012 15:28:52 +0100
Subject: Refactor to a general, flexible and extensible architecture.

---
 classes/JabberAuth.php             | 91 -----------------------------------
 classes/JabberAuthPhpBB.php        | 38 ---------------
 config.php                         |  4 --
 config.sample.php                  | 25 ++++++++++
 core/JabberAuth.php                | 97 ++++++++++++++++++++++++++++++++++++++
 main.php                           | 27 +++++++----
 phpbb-bridge/noweb_user.php        | 17 -------
 phpbb-bridge/phpbb_bootstrap.php   | 40 ----------------
 plugins/phpbb3/JabberAuthPhpBB.php | 38 +++++++++++++++
 plugins/phpbb3/noweb_user.php      | 17 +++++++
 plugins/phpbb3/phpbb_bootstrap.php | 40 ++++++++++++++++
 11 files changed, 234 insertions(+), 200 deletions(-)
 delete mode 100644 classes/JabberAuth.php
 delete mode 100644 classes/JabberAuthPhpBB.php
 delete mode 100644 config.php
 create mode 100644 config.sample.php
 create mode 100644 core/JabberAuth.php
 delete mode 100644 phpbb-bridge/noweb_user.php
 delete mode 100644 phpbb-bridge/phpbb_bootstrap.php
 create mode 100644 plugins/phpbb3/JabberAuthPhpBB.php
 create mode 100644 plugins/phpbb3/noweb_user.php
 create mode 100644 plugins/phpbb3/phpbb_bootstrap.php

diff --git a/classes/JabberAuth.php b/classes/JabberAuth.php
deleted file mode 100644
index 69bb858..0000000
--- a/classes/JabberAuth.php
+++ /dev/null
@@ -1,91 +0,0 @@
-<?php
-// Arancaytar, October 2012
-// This is a general PHP implementation of the ejabberd auth protocol.
-
-abstract class JabberAuth {
-  var $running;
-
-  abstract function isuser($username, $server);
-  abstract function auth($username, $server, $password);
-  abstract function setpass($username, $server, $password);
-  abstract function tryregister($username, $server, $password);
-  abstract function removeuser($username, $server);
-
-  function init() {
-    $this->stdin = fopen('php://stdin', 'r');
-    $this->stdout = fopen('php://stdout', 'w');
-    $this->logfile = fopen($this->logpath . 'activity-' . date('Y-m-d') . '.log', 'a');
-    $this->log('Starting...');
-    $this->running = TRUE;
-  }
-
-  function stop() {
-    $this->log("Stopping...");
-    $this->running = FALSE;
-  }
-
-  function run() {
-    while ($this->running) {
-      $data = $this->read();
-      if ($data) {
-        $result = $this->execute($data);
-        $this->write((int)$result);
-      }
-    }
-    $this->log("Stopped");
-  }
-
-  function read() {
-    $input = fread($this->stdin, 2);
-    if (!$input) {
-      return $this->stop();
-    }
-
-    $input = unpack('n', $input);
-    $length = $input[1];
-    if($length > 0) {
-      $this->log("Reading $length bytes...");
-      $data = fread($this->stdin, $length);
-      return $data;
-    }
-  }
-
-  function write($data) {
-    $this->log("OUT: $data");
-    fwrite($this->stdout, pack("nn", 2, $data));
-  }
-
-  function log($data) {
-    fwrite($this->logfile, sprintf("%s [%d] - %s\n", date('Y-m-d H:i:s'), getmypid(), $data));
-  }
-
-  function execute($data) {
-    $args = explode(':', $data);
-    $command = array_shift($args);
-    // Only log the username for security.
-    $this->log("Executing $command on {$args[0]}");
-
-    switch ($command) {
-      case 'isuser':
-        list($username, $server) = $args;
-        return $this->isuser($username, $server);
-      case 'auth':
-        list($username, $server, $password) = $args;
-        return $this->auth($username, $server, $password);
-      case 'setpass':
-        list($username, $server, $password) = $args;
-        return $this->setpass($username, $server, $password);
-      case 'tryregister':
-        list($username, $server, $password) = $args;
-        return $this->tryregister($username, $server, $password);
-      case 'removeuser':
-        list($username, $server) = $args;
-        return $this->removeuser($username, $server);
-      case 'removeuser3':
-        list($username, $server, $password) = $args;
-        return $this->auth($username, $server, $password) && $this->removeuser($username, $password);
-      default:
-        $this->stop();
-    }
-  }
-}
diff --git a/classes/JabberAuthPhpBB.php b/classes/JabberAuthPhpBB.php
deleted file mode 100644
index e60cbae..0000000
--- a/classes/JabberAuthPhpBB.php
+++ /dev/null
@@ -1,38 +0,0 @@
-<?php
-
-class JabberAuthPhpBB extends JabberAuth {
-  var $auth;
-  var $db;
-  
-  function __construct($auth, $db, $logpath) {
-    $this->logpath = $logpath;
-    parent::init();
-    $this->auth = $auth;
-    $this->db = $db;
-  }
-
-  function isuser($username, $server) {
-    $username_clean = utf8_clean_string($username);
-    $row = $this->db->sql_fetchrow($this->db->sql_query('SELECT username FROM ' . USERS_TABLE . ' WHERE username_clean = ' . "'" . $this->db->sql_escape($username_clean) . "'" . ';'));
-    return !empty($row);
-  }
-
-  function auth($username, $server, $password) {
-    $result = $this->auth->login($username, $password);
-    return $result['status'] == LOGIN_SUCCESS;
-  }
-  
-  // The following functions are disabled. This script will not change the phpBB user database.
-  
-  function setpass($username, $server, $password) {
-    return FALSE;
-  }
-
-  function tryregister($username, $server, $password) {
-    return FALSE;
-  }
-
-  function removeuser($username, $server) {
-    return FALSE;
-  }
-}
diff --git a/config.php b/config.php
deleted file mode 100644
index dd5f8f1..0000000
--- a/config.php
+++ /dev/null
@@ -1,4 +0,0 @@
-<?php
-
-$phpbb_root_path = '/home/arancaytar/development/phpbb3/phpBB/';
-$log_path = __DIR__ . '/logs/';
\ No newline at end of file
diff --git a/config.sample.php b/config.sample.php
new file mode 100644
index 0000000..0f1b9fa
--- /dev/null
+++ b/config.sample.php
@@ -0,0 +1,25 @@
+<?php
+
+/* copy this file to config.php */
+
+$config['plugin'] = 'phpbb3';
+$config['log_path'] = __DIR__ . '/logs/';
+
+$config['phpbb3'] = array(
+  'root_path' => '' /* path to your phpBB3 installation */,
+);
+
+$config['phpbb4'] = array(
+  'root_path' => '' /* path to your phpBB4 installation */,
+);
+
+$config['drupal7'] = array(
+  'root_path' => '' /* path to your Drupal 7 installation */,
+  'site' => 'default' /* site directory */,
+);
+
+$config['drupal8'] = array(
+  'root_path' => '' /* path to your Drupal 7 installation */,
+  'site' => 'default' /* site directory */,
+);
+
diff --git a/core/JabberAuth.php b/core/JabberAuth.php
new file mode 100644
index 0000000..3e9d4df
--- /dev/null
+++ b/core/JabberAuth.php
@@ -0,0 +1,97 @@
+<?php
+// Arancaytar, October 2012
+// This is a general PHP implementation of the ejabberd auth protocol.
+
+abstract class JabberAuth {
+  var $running;
+
+  abstract function isuser($username, $server);
+  abstract function auth($username, $server, $password);
+  abstract function setpass($username, $server, $password);
+  abstract function tryregister($username, $server, $password);
+  abstract function removeuser($username, $server);
+
+  function init() {
+    global $config;
+    $this->stdin = fopen('php://stdin', 'r');
+    $this->stdout = fopen('php://stdout', 'w');
+    if (!empty($config['log_path']) && is_dir($config['log_path']) && is_writable($config['log_path'])) {
+      $this->logfile = fopen($config['log_path'] . 'activity-' . date('Y-m-d') . '.log', 'a');
+    }
+    else {
+      $this->logfile = fopen('php://stderr', 'w');
+    }
+    $this->log('Starting...');
+    $this->running = TRUE;
+  }
+
+  function stop() {
+    $this->log("Stopping...");
+    $this->running = FALSE;
+  }
+
+  function run() {
+    while ($this->running) {
+      $data = $this->read();
+      if ($data) {
+        $result = $this->execute($data);
+        $this->write((int)$result);
+      }
+    }
+    $this->log("Stopped");
+  }
+
+  function read() {
+    $input = fread($this->stdin, 2);
+    if (!$input) {
+      return $this->stop();
+    }
+
+    $input = unpack('n', $input);
+    $length = $input[1];
+    if($length > 0) {
+      $this->log("Reading $length bytes...");
+      $data = fread($this->stdin, $length);
+      return $data;
+    }
+  }
+
+  function write($data) {
+    $this->log("OUT: $data");
+    fwrite($this->stdout, pack("nn", 2, $data));
+  }
+
+  function log($data) {
+    fwrite($this->logfile, sprintf("%s [%d] - %s\n", date('Y-m-d H:i:s'), getmypid(), $data));
+  }
+
+  function execute($data) {
+    $args = explode(':', $data);
+    $command = array_shift($args);
+    // Only log the username for security.
+    $this->log("Executing $command on {$args[0]}");
+
+    switch ($command) {
+      case 'isuser':
+        list($username, $server) = $args;
+        return $this->isuser($username, $server);
+      case 'auth':
+        list($username, $server, $password) = $args;
+        return $this->auth($username, $server, $password);
+      case 'setpass':
+        list($username, $server, $password) = $args;
+        return $this->setpass($username, $server, $password);
+      case 'tryregister':
+        list($username, $server, $password) = $args;
+        return $this->tryregister($username, $server, $password);
+      case 'removeuser':
+        list($username, $server) = $args;
+        return $this->removeuser($username, $server);
+      case 'removeuser3':
+        list($username, $server, $password) = $args;
+        return $this->auth($username, $server, $password) && $this->removeuser($username, $password);
+      default:
+        $this->stop();
+    }
+  }
+}
diff --git a/main.php b/main.php
index fee0f33..2388e8f 100644
--- a/main.php
+++ b/main.php
@@ -2,15 +2,22 @@
 <?php
 // by Aran, October 2012
 
-// Bootstrap the phpBB system.
-define('ROOT', __DIR__);
-require_once __DIR__ . '/config.php';
-require_once __DIR__ . '/phpbb-bridge/phpbb_bootstrap.php';
 
-// Load the classes.
-require_once __DIR__ . '/classes/JabberAuth.php';
-require_once __DIR__ . '/classes/JabberAuthPhpBB.php';
+define('ROOT', __DIR__ . '/');
+require_once ROOT . 'config.php';
+$err = fopen('php://stderr', 'w');
 
-// Launch the script.
-$main = new JabberAuthPhpBB($auth, $db, $log_path);
-$main->run();
+if (!empty($config['plugin']) && !empty($config[$config['plugin']])) {
+  $plugin_file = 'plugins/' . $config['plugin'] . '/' . $config['plugin'] . '.module';
+  if (file_exists(ROOT . $plugin_file)) {
+    require_once ROOT . $plugin_file;
+    $function = $config['plugin'] . '_init';
+    $function($config[$config['plugin']])->run();
+  }
+  else {
+    fwrite($err, "Plugin <{$plugin_file}> not found.\n");
+  }
+}
+else {
+  fwrite($err, 'Incomplete configuration: $config[\'plugin\'] must be set to <name>, and $config[<name>] populated.' . "\n");
+}
diff --git a/phpbb-bridge/noweb_user.php b/phpbb-bridge/noweb_user.php
deleted file mode 100644
index 3291222..0000000
--- a/phpbb-bridge/noweb_user.php
+++ /dev/null
@@ -1,17 +0,0 @@
-<?php
-
-class noweb_user {
-  var $session_id = '';
-  var $browser = 'N/A';
-  var $forwarded_for = '127.0.0.1';
-  var $ip = '127.0.0.1';
-
-  function session_create() {
-    // do absolutely nothing. however, unless we tell the auth module the session
-    // was successfully created, it won't pass back a success.
-    return TRUE;
-  }
-  
-  function setup() {
-  }
-}
diff --git a/phpbb-bridge/phpbb_bootstrap.php b/phpbb-bridge/phpbb_bootstrap.php
deleted file mode 100644
index 4ede950..0000000
--- a/phpbb-bridge/phpbb_bootstrap.php
+++ /dev/null
@@ -1,40 +0,0 @@
-<?php
-define('IN_PHPBB', TRUE);
-$phpEx = 'php';
-
-require($phpbb_root_path . 'includes/startup.' . $phpEx);
-
-if (file_exists($phpbb_root_path . 'config.' . $phpEx))
-{
-	require($phpbb_root_path . 'config.' . $phpEx);
-}
-
-if (!defined('PHPBB_INSTALLED'))
-{
-  file_put_contents('php://stderr', "phpBB needs to be installed first.\n");
-	exit;
-}
-
-// Include files
-require(__DIR__ . '/noweb_user.php');
-require($phpbb_root_path . 'includes/acm/acm_' . $acm_type . '.' . $phpEx);
-require($phpbb_root_path . 'includes/cache.' . $phpEx);
-require($phpbb_root_path . 'includes/auth.' . $phpEx);
-require($phpbb_root_path . 'includes/functions.' . $phpEx);
-require($phpbb_root_path . 'includes/functions_content.' . $phpEx);
-
-require($phpbb_root_path . 'includes/constants.' . $phpEx);
-require($phpbb_root_path . 'includes/db/' . $dbms . '.' . $phpEx);
-require($phpbb_root_path . 'includes/utf/utf_tools.' . $phpEx);
-
-// Instantiate some basic classes
-$user		= new noweb_user();
-$auth		= new auth();
-$db			= new $sql_db();
-$cache		= new cache();
-
-// Connect to DB
-$db->sql_connect($dbhost, $dbuser, $dbpasswd, $dbname, $dbport, false, defined('PHPBB_DB_NEW_LINK') ? PHPBB_DB_NEW_LINK : false);
-// We do not need this any longer, unset for safety purposes
-unset($dbpasswd);
-$config = $cache->obtain_config();
diff --git a/plugins/phpbb3/JabberAuthPhpBB.php b/plugins/phpbb3/JabberAuthPhpBB.php
new file mode 100644
index 0000000..e60cbae
--- /dev/null
+++ b/plugins/phpbb3/JabberAuthPhpBB.php
@@ -0,0 +1,38 @@
+<?php
+
+class JabberAuthPhpBB extends JabberAuth {
+  var $auth;
+  var $db;
+  
+  function __construct($auth, $db, $logpath) {
+    $this->logpath = $logpath;
+    parent::init();
+    $this->auth = $auth;
+    $this->db = $db;
+  }
+
+  function isuser($username, $server) {
+    $username_clean = utf8_clean_string($username);
+    $row = $this->db->sql_fetchrow($this->db->sql_query('SELECT username FROM ' . USERS_TABLE . ' WHERE username_clean = ' . "'" . $this->db->sql_escape($username_clean) . "'" . ';'));
+    return !empty($row);
+  }
+
+  function auth($username, $server, $password) {
+    $result = $this->auth->login($username, $password);
+    return $result['status'] == LOGIN_SUCCESS;
+  }
+  
+  // The following functions are disabled. This script will not change the phpBB user database.
+  
+  function setpass($username, $server, $password) {
+    return FALSE;
+  }
+
+  function tryregister($username, $server, $password) {
+    return FALSE;
+  }
+
+  function removeuser($username, $server) {
+    return FALSE;
+  }
+}
diff --git a/plugins/phpbb3/noweb_user.php b/plugins/phpbb3/noweb_user.php
new file mode 100644
index 0000000..3291222
--- /dev/null
+++ b/plugins/phpbb3/noweb_user.php
@@ -0,0 +1,17 @@
+<?php
+
+class noweb_user {
+  var $session_id = '';
+  var $browser = 'N/A';
+  var $forwarded_for = '127.0.0.1';
+  var $ip = '127.0.0.1';
+
+  function session_create() {
+    // do absolutely nothing. however, unless we tell the auth module the session
+    // was successfully created, it won't pass back a success.
+    return TRUE;
+  }
+  
+  function setup() {
+  }
+}
diff --git a/plugins/phpbb3/phpbb_bootstrap.php b/plugins/phpbb3/phpbb_bootstrap.php
new file mode 100644
index 0000000..4ede950
--- /dev/null
+++ b/plugins/phpbb3/phpbb_bootstrap.php
@@ -0,0 +1,40 @@
+<?php
+define('IN_PHPBB', TRUE);
+$phpEx = 'php';
+
+require($phpbb_root_path . 'includes/startup.' . $phpEx);
+
+if (file_exists($phpbb_root_path . 'config.' . $phpEx))
+{
+	require($phpbb_root_path . 'config.' . $phpEx);
+}
+
+if (!defined('PHPBB_INSTALLED'))
+{
+  file_put_contents('php://stderr', "phpBB needs to be installed first.\n");
+	exit;
+}
+
+// Include files
+require(__DIR__ . '/noweb_user.php');
+require($phpbb_root_path . 'includes/acm/acm_' . $acm_type . '.' . $phpEx);
+require($phpbb_root_path . 'includes/cache.' . $phpEx);
+require($phpbb_root_path . 'includes/auth.' . $phpEx);
+require($phpbb_root_path . 'includes/functions.' . $phpEx);
+require($phpbb_root_path . 'includes/functions_content.' . $phpEx);
+
+require($phpbb_root_path . 'includes/constants.' . $phpEx);
+require($phpbb_root_path . 'includes/db/' . $dbms . '.' . $phpEx);
+require($phpbb_root_path . 'includes/utf/utf_tools.' . $phpEx);
+
+// Instantiate some basic classes
+$user		= new noweb_user();
+$auth		= new auth();
+$db			= new $sql_db();
+$cache		= new cache();
+
+// Connect to DB
+$db->sql_connect($dbhost, $dbuser, $dbpasswd, $dbname, $dbport, false, defined('PHPBB_DB_NEW_LINK') ? PHPBB_DB_NEW_LINK : false);
+// We do not need this any longer, unset for safety purposes
+unset($dbpasswd);
+$config = $cache->obtain_config();
-- 
cgit v1.1