pre 2.5.0, Stable Release Candidate

Author: t3chguy

INSTALL

@@ -1,13 +1,13 @@
 1.  To Install, extract this archive and copy the folder
-	`sql_global_addressbooks` into roundcube/plugins/
+	`sql_global_addressbooks` into `%roundcube/plugins/`
 
-2.  Choose one of the SQL Scripts from ./SQL/, dependant on your Mail System
+2.  Choose one of the SQL Scripts from `./SQL/`, dependant on your Mail System
 	and whether or not you wish to have Alias Support, [%name%+alias.sql]
 	or you would like just to have the primary emails, [%name%.sql]
 	and run it on your MySQL/MariaDB Server as root, for example from PHPMyAdmin
 
-3.  And then add `sql_global_addressbooks` to your roundcube/config/config.inc.php
-	$config['plugins'] = array(..., 'sql_global_addressbooks');
+3.  And then add `sql_global_addressbooks` to your `roundcube/config/config.inc.php`
+	`$config['plugins'] = array(..., 'sql_global_addressbooks');`
 
-4.  Rename roundcube/plugins/sql_global_addressbooks/config.inc.php.dist to
-	config.inc.php and fill in the configuration file.
+4.  Rename `%roundcube/plugins/sql_global_addressbooks/config.inc.php.dist` to
+	`config.inc.php` and fill in the configuration file.

sql_global_addressbooks/config.inc.php.dist

@@ -13,29 +13,27 @@ NULL for disable or a string as the name of the `Domain Book`.
 	e.g:                             = 'Domain Address Book'; */
 	$config['_sql_domainbook_name']  = 'Domain Address Book';
 
-
 /*
 Default for both rules is Everything/Everyone is whitelisted and nothing Blacklisted.
 READ Allowed is the list of domains (or *) which can see this Address Book. */
 //	$config['_sql_db_read_allowed']  = array('*');
 /*
 READ Hidden is the list of domains which cannot see this Address Book. */
-//	$config['_sql_db_read_hidden']   = array('');
+//	$config['_sql_db_read_hidden']   = array();
 
 
 
 
 /*
 The `Global Book` is an Address Book which will contain all the members of the Database View
 Configure as NULL for disable or a string as the name of the `Global Book`.
-	e.g:                             = 'Global Book'; */
-//	$config['_sql_globalbook_name']  = NULL;
+	e.g:                             = 'Global Address Book'; */
+//	$config['_sql_globalbook_name']  = 'Global Address Book';
 
 /*
 Should the Global Address Book be grouped? */
 //	$config['_sql_globalbook_gp']    = true;
 
-
 /*
 Default for both rule sets is Everything/Everyone is whitelisted and nothing Blacklisted.
 READ Allowed is the list of domains (or *) which can see this Address Book. */
@@ -60,7 +58,7 @@ The definition can also support multiple books, the definition goes like:
   array(array('Support Book', 'webdevguru.co.uk', 'support.co.uk'), array(...))
 Multidimensional Array, of no limit, first sub-element is the Specified Name of the Support Book.
 The rest of the elements are the Domains that should be within that Support Book.
-	e.g:                             = array( array('Support Book',
+	e.g:                             = array( array('Support Contacts',
 	                                                'webdevguru.co.uk',
 	                                                'support.site.com') ); */
 //	$config['_sql_supportbook_list'] = array();

sql_global_addressbooks/sql_global_addressbooks.php

@@ -4,16 +4,26 @@
 /**
  * Specialised Global Addressbook Contacts Class!
  *
+ * Roundcube Plugin to create an Address Book from list of users in the SQL View.
+ * Currently Natively Supporting:
+ *  + iRedMail [Aliases Supported]
+ *
  * @author Michael Daniel Telatynski <[email protected]>
+ * @copyright 2015 Web Development Guru
+ * @license http://bit.ly/16ABH2R
+ * @license MIT
+ *
+ * @version 2.5.0
  */
 class sql_global_addressbooks extends rcube_plugin {
 
 	public $task = 'mail|addressbook';
 
 	public function init() {
 		$this->add_hook('addressbooks_list', array($this, 'address_sources'));
-		$this->add_hook('addressbook_get', array($this, 'get_address_book'));
+		$this->add_hook('addressbook_get',   array($this, 'get_address_book'));
 		$this->load_config();
+
 		$rcmail = rcmail::get_instance();
 		$config = $rcmail->config;
 		$domain = $rcmail->user->get_username('domain');
@@ -56,7 +66,7 @@ private function touchbook($id, $name, $groups=false) {
 	private function wlbl($id, $domain) {
 		$rc = rcmail::get_instance();
 		$cf = $rc->config->get('_sql_' . $id . '_read_allowed', array('*'));
-		$fc = $rc->config->get('_sql_' . $id . '_read_hidden', array());
+		$fc = $rc->config->get('_sql_' . $id . '_read_hidden',  array());
 
 		if (in_array($domain, $fc)) { return false; }
 		if ($cf === array('*') || in_array($domain, $cf)) { return true; }
@@ -107,11 +117,11 @@ public function address_sources($p) {
 
 	public function get_address_book($p) {
 
-		if (in_array($p['id'], self::ac(rcmail::get_instance()->config->get('_sql_supportbook', array()), 0))) {
-			$p['instance'] = new sql_global_backend($p['id']);
-		} elseif ($p['id'] === 'global') {
+		if ($p['id'] === 'global') {
 			$p['instance'] = new sql_global_backend('global');
 			$p['instance']->groups = rcmail::get_instance()->config->get('_sql_globalbook_gp', true);
+		} elseif (in_array($p['id'], self::ac(rcmail::get_instance()->config->get('_sql_supportbook', array()), 0))) {
+			$p['instance'] = new sql_global_backend($p['id']);
 		} elseif ($p['id'] === 'domain') { $p['instance'] = new sql_global_backend('domain'); }
 
 		return $p;

sql_global_addressbooks/sql_global_backend.php

@@ -1,9 +1,14 @@
 <?php
 
 /**
- * Specialised Global Addressbook Contacts Backend Class!
+ * Specialised Global Addressbook Contacts Class Backend!
  *
  * @author Michael Daniel Telatynski <[email protected]>
+ * @copyright 2015 Web Development Guru
+ * @license http://bit.ly/16ABH2R
+ * @license MIT
+ *
+ * @version 2.5.0
  */
 class sql_global_backend extends rcube_addressbook {
 
@@ -177,17 +182,6 @@ public function search($fields, $value, $strict=false, $select=true, $nocount=fa
                 }
         	}
 
-        	/*foreach ($required as $col) {
-	            $and_where[] = $db->quote_identifier($col).' <> '.$db->quote('');
-	        }*/
-			if (!empty($where)) {
-	            // use AND operator for advanced searches
-	            //$where =
-	        }
-	        /*if (!empty($and_where)) {
-	            $where = ($where ? "($where) AND " : '') . join(' AND ', $and_where);
-	        }*/
-
 	        if (!empty($where)) {
 	            $this->set_search_set(join(is_array($value) ? ' AND ' : ' OR ', $where));
 	            /*if ($select) {

sql_global_addressbooks/tests/sql_global_addressbooks.php

@@ -1,11 +1,11 @@
 <?php
 
-class ExampleAddressbook_Plugin extends PHPUnit_Framework_TestCase
+class sql_global_addressbooks_Plugin extends PHPUnit_Framework_TestCase
 {
 
     function setUp()
     {
-        include_once dirname(__FILE__) . '/../webdevguru_contacts.php';
+        include_once dirname(__FILE__) . '/../sql_global_backend.php';
     }
 
     /**
@@ -14,9 +14,9 @@ function setUp()
     function test_constructor()
     {
         $rcube  = rcube::get_instance();
-        $plugin = new example_addressbook($rcube->api);
+        $plugin = new sql_global_addressbooks($rcube->api);
 
-        $this->assertInstanceOf('example_addressbook', $plugin);
+        $this->assertInstanceOf('sql_global_addressbooks', $plugin);
         $this->assertInstanceOf('rcube_plugin', $plugin);
     }
 }