/**
* The object types supported by this module.
*/
- const USER = 'kolabInetOrgPerson';
- const GROUP = 'kolabGroupOfNames';
+ const USER = 'undefined';
+ const GROUP = 'undefined';
/** Define types of return values. */
const RESULT_SINGLE = 1;
$db = new $class($params);
return $db;
}
- throw new Horde_Kolab_Server_Exception('Server type definition "' . $class . '" missing.');
+ throw new Horde_Kolab_Server_Exception(
+ 'Server type definition "' . $class . '" missing.');
}
/**
$server_params = array();
}
} else {
- throw new Horde_Kolab_Server_Exception('The configuration for the Kolab server driver is missing!');
+ throw new Horde_Kolab_Server_Exception(
+ 'The configuration for the Kolab server driver is missing!');
}
if (!empty($params)) {
try {
$uid = $tmp_server->uidForIdOrMail($params['user']);
} catch (Horde_Kolab_Server_Exception $e) {
- throw new Horde_Kolab_Server_Exception(sprintf(_("Failed identifying the UID of the Kolab user %s. Error was: %s"),
- $params['user'],
- $e->getMessage()));
+ throw new Horde_Kolab_Server_Exception(
+ sprintf(_("Failed identifying the UID of the Kolab user %s. Error was: %s"),
+ $params['user'],
+ $e->getMessage()));
}
if ($uid === false) {
- throw new Horde_Kolab_Server_MissingObjectException(sprintf(_("Failed identifying the UID of the Kolab user %s."),
- $params['user']));
+ throw new Horde_Kolab_Server_MissingObjectException(
+ sprintf(_("Failed identifying the UID of the Kolab user %s."),
+ $params['user']));
}
$params['uid'] = $uid;
}
public function &add($info)
{
if (!isset($info['type'])) {
- throw new Horde_Kolab_Server_Exception('The type of a new object must be specified!');
+ throw new Horde_Kolab_Server_Exception(
+ 'The type of a new object must be specified!');
}
$uid = $this->generateUid($info['type'], $info);
$object = &Horde_Kolab_Server_Object::factory($info['type'], $uid, $this);
if ($object->exists()) {
- throw new Horde_Kolab_Server_Exception(sprintf(_("The object with the uid \"%s\" does already exist!"),
- $uid));
+ throw new Horde_Kolab_Server_Exception(
+ sprintf(_("The object with the uid \"%s\" does already exist!"),
+ $uid));
}
$object->save($info);
return $object;
}
/**
- * Identify the UID for the first object found with the given ID.
- *
- * @param string $id Search for objects with this ID.
- * @param int $restrict A Horde_Kolab_Server::RESULT_* result restriction.
- *
- * @return mixed The UID or false if there was no result.
- *
- * @throws Horde_Kolab_Server_Exception
- */
- public function uidForId($id,
- $restrict = Horde_Kolab_Server::RESULT_SINGLE)
- {
- $criteria = array('AND' => array(array('field' => 'uid',
- 'op' => '=',
- 'test' => $id),
- ),
- );
- return $this->uidForSearch($criteria, $restrict);
- }
-
- /**
- * Identify the UID for the first user found with the given mail.
- *
- * @param string $mail Search for users with this mail address.
- * @param int $restrict A Horde_Kolab_Server::RESULT_* result restriction.
- *
- * @return mixed The UID or false if there was no result.
- *
- * @throws Horde_Kolab_Server_Exception
- */
- public function uidForMail($mail,
- $restrict = Horde_Kolab_Server::RESULT_SINGLE)
- {
- $criteria = array('AND' => array(array('field' => 'mail',
- 'op' => '=',
- 'test' => $mail),
- ),
- );
- return $this->uidForSearch($criteria, $restrict);
- }
-
- /**
- * Identify the UID for the first object found with the given alias.
- *
- * @param string $mail Search for objects with this mail alias.
- * @param int $restrict A Horde_Kolab_Server::RESULT_* result restriction.
- *
- * @return mixed The UID or false if there was no result.
- *
- * @throws Horde_Kolab_Server_Exception
- */
- public function uidForAlias($mail,
- $restrict = Horde_Kolab_Server::RESULT_SINGLE)
- {
- $criteria = array('AND' => array(array('field' => 'alias',
- 'op' => '=',
- 'test' => $mail),
- ),
- );
- return $this->uidForSearch($criteria, $restrict);
- }
-
- /**
- * Identify the UID for the first object found with the given ID or mail.
- *
- * @param string $id Search for objects with this uid/mail.
- *
- * @return string|boolean The UID or false if there was no result.
- *
- * @throws Horde_Kolab_Server_Exception
- */
- public function uidForIdOrMail($id)
- {
- $criteria = array('OR' =>
- array(
- array('field' => 'uid',
- 'op' => '=',
- 'test' => $id),
- array('field' => 'mail',
- 'op' => '=',
- 'test' => $id),
- ),
- );
- return $this->uidForSearch($criteria);
- }
-
- /**
- * Identify the UID for the first object found with the given mail
- * address or alias.
- *
- * @param string $mail Search for objects with this mail address
- * or alias.
- *
- * @return string|boolean The UID or false if there was no result.
- *
- * @throws Horde_Kolab_Server_Exception
- */
- public function uidForMailOrAlias($mail)
- {
- $criteria = array('OR' =>
- array(
- array('field' => 'alias',
- 'op' => '=',
- 'test' => $mail),
- array('field' => 'mail',
- 'op' => '=',
- 'test' => $mail),
- )
- );
- return $this->uidForSearch($criteria);
- }
-
- /**
- * Identify the UID for the first object found with the given ID,
- * mail or alias.
- *
- * @param string $id Search for objects with this ID/mail/alias.
- *
- * @return string|boolean The UID or false if there was no result.
- *
- * @throws Horde_Kolab_Server_Exception
- */
- public function uidForIdOrMailOrAlias($id)
- {
- $criteria = array('OR' =>
- array(
- array('field' => 'alias',
- 'op' => '=',
- 'test' => $id),
- array('field' => 'mail',
- 'op' => '=',
- 'test' => $id),
- array('field' => 'uid',
- 'op' => '=',
- 'test' => $id),
- ),
- );
- return $this->uidForSearch($criteria);
- }
-
- /**
- * Identify the primary mail attribute for the first object found
- * with the given ID or mail.
- *
- * @param string $id Search for objects with this ID/mail.
- *
- * @return mixed The mail address or false if there was no result.
- *
- * @throws Horde_Kolab_Server_Exception
- */
- public function mailForIdOrMail($id)
- {
- $criteria = array('AND' =>
- array(
- array('field' => 'objectClass',
- 'op' => '=',
- 'test' => Horde_Kolab_Server::USER),
- array('OR' =>
- array(
- array('field' => 'uid',
- 'op' => '=',
- 'test' => $id),
- array('field' => 'mail',
- 'op' => '=',
- 'test' => $id),
- ),
- ),
- ),
- );
-
- $data = $this->attrsForSearch($criteria, array('mail'),
- self::RESULT_STRICT);
- if (!empty($data)) {
- return $data['mail'][0];
- } else {
- return false;
- }
- }
-
- /**
- * Returns a list of allowed email addresses for the given user.
- *
- * @param string $id Search for objects with this ID/mail.
- *
- * @return array An array of allowed mail addresses.
- *
- * @throws Horde_Kolab_Server_Exception
- */
- public function addrsForIdOrMail($id)
- {
- $criteria = array('AND' =>
- array(
- array('field' => 'objectClass',
- 'op' => '=',
- 'test' => Horde_Kolab_Server::USER),
- array('OR' =>
- array(
- array('field' => 'uid',
- 'op' => '=',
- 'test' => $id),
- array('field' => 'mail',
- 'op' => '=',
- 'test' => $id),
- ),
- ),
- ),
- );
-
- $result = $this->attrsForSearch($criteria, array('mail', 'alias'),
- self::RESULT_STRICT);
- if (isset($result['alias'])) {
- $addrs = array_merge((array) $result['mail'], (array) $result['alias']);
- } else {
- $addrs = $result['mail'];
- }
-
- if (empty($result)) {
- return array();
- }
- $criteria = array('AND' =>
- array(
- array('field' => 'objectClass',
- 'op' => '=',
- 'test' => Horde_Kolab_Server::USER),
- array('field' => 'kolabDelegate',
- 'op' => '=',
- 'test' => $result['mail'][0]),
- ),
- );
-
- $result = $this->attrsForSearch($criteria, array('mail', 'alias'),
- self::RESULT_MANY);
- if (!empty($result)) {
- foreach ($result as $adr) {
- if (isset($adr['mail'])) {
- $addrs = array_merge((array) $addrs, (array) $adr['mail']);
- }
- if (isset($adr['alias'])) {
- $addrs = array_merge((array) $addrs, (array) $adr['alias']);
- }
- }
- }
-
- $addrs = array_map('strtolower', $addrs);
-
- return $addrs;
- }
-
- /**
- * Identify the GID for the first group found with the given mail.
- *
- * @param string $mail Search for groups with this mail address.
- * @param int $restrict A Horde_Kolab_Server::RESULT_* result restriction.
- *
- * @return mixed The GID or false if there was no result.
- *
- * @throws Horde_Kolab_Server_Exception
- */
- public function gidForMail($mail,
- $restrict = Horde_Kolab_Server::RESULT_SINGLE)
- {
- $criteria = array('AND' => array(array('field' => 'mail',
- 'op' => '=',
- 'test' => $mail),
- ),
- );
- return $this->gidForSearch($criteria, $restrict);
- }
-
- /**
- * Is the given UID member of the group with the given mail address?
- *
- * @param string $uid UID of the user.
- * @param string $mail Search the group with this mail address.
- *
- * @return boolean True in case the user is in the group, false otherwise.
- *
- * @throws Horde_Kolab_Server_Exception
- */
- public function memberOfGroupAddress($uid, $mail)
- {
- $criteria = array('AND' =>
- array(
- array('field' => 'mail',
- 'op' => '=',
- 'test' => $mail),
- array('field' => 'member',
- 'op' => '=',
- 'test' => $uid),
- ),
- );
-
- $result = $this->gidForSearch($criteria,
- self::RESULT_SINGLE);
- return !empty($result);
- }
-
- /**
- * Get the groups for this object.
- *
- * @param string $uid The UID of the object to fetch.
- *
- * @return array An array of group ids.
- *
- * @throws Horde_Kolab_Server_Exception
- */
- public function getGroups($uid)
- {
- $criteria = array('AND' =>
- array(
- array('field' => 'member',
- 'op' => '=',
- 'test' => $uid),
- ),
- );
-
- $result = $this->gidForSearch($criteria, self::RESULT_MANY);
- if (empty($result)) {
- return array();
- }
- return $result;
- }
-
- /**
* Generate a hash representation for a list of objects.
*
* @param string $type The type of the objects to be listed
}
/**
+ * Capture undefined calls.
+ *
+ * @param string $method The name of the called method.
+ * @param array $args Arguments of the call.
+ *
+ * @return NULL.
+ *
+ * @throws Horde_Kolab_Server_Exception
+ */
+ public function __call($method, $args)
+ {
+ throw new Horde_Kolab_Server_Exception(
+ sprintf("The server type \"%s\" does not support method \"%s\"!",
+ get_class($this), $method));
+ }
+
+ /**
* Stub for reading object data.
*
* @param string $uid The object to retrieve.
{
/**
+ * The object types supported by this server type.
+ */
+ const USER = 'kolabInetOrgPerson';
+ const GROUP = 'kolabGroupOfNames';
+
+ /**
* LDAP connection handle.
*
* @var Net_LDAP2
$result = Horde_Kolab_Server_Object::loadClass($type);
$vars = get_class_vars($type);
- $filter = $vars['filter'];
+ $filter = call_user_func(array($type, 'getFilter'));
$sort = $vars['sort_by'];
if (isset($params['sort'])) {
{
$users = array('field' => 'objectClass',
'op' => '=',
- 'test' => Horde_Kolab_Server::USER);
+ 'test' => self::USER);
if (!empty($criteria)) {
$criteria = array('AND' => array($users, $criteria));
} else {
{
$groups = array('field' => 'objectClass',
'op' => '=',
- 'test' => Horde_Kolab_Server::GROUP);
+ 'test' => self::GROUP);
if (!empty($criteria)) {
$criteria = array('AND' => array($groups, $criteria));
} else {
$result = $this->search($filter, $params, $this->_base_dn);
return $this->dnFromResult($result, $restrict);
}
+
+ /**
+ * Identify the UID for the first object found with the given ID.
+ *
+ * @param string $id Search for objects with this ID.
+ * @param int $restrict A Horde_Kolab_Server::RESULT_* result restriction.
+ *
+ * @return mixed The UID or false if there was no result.
+ *
+ * @throws Horde_Kolab_Server_Exception
+ */
+ public function uidForId($id,
+ $restrict = Horde_Kolab_Server::RESULT_SINGLE)
+ {
+ $criteria = array('AND' => array(array('field' => 'uid',
+ 'op' => '=',
+ 'test' => $id),
+ ),
+ );
+ return $this->uidForSearch($criteria, $restrict);
+ }
+
+ /**
+ * Identify the UID for the first user found with the given mail.
+ *
+ * @param string $mail Search for users with this mail address.
+ * @param int $restrict A Horde_Kolab_Server::RESULT_* result restriction.
+ *
+ * @return mixed The UID or false if there was no result.
+ *
+ * @throws Horde_Kolab_Server_Exception
+ */
+ public function uidForMail($mail,
+ $restrict = Horde_Kolab_Server::RESULT_SINGLE)
+ {
+ $criteria = array('AND' => array(array('field' => 'mail',
+ 'op' => '=',
+ 'test' => $mail),
+ ),
+ );
+ return $this->uidForSearch($criteria, $restrict);
+ }
+
+ /**
+ * Identify the UID for the first object found with the given alias.
+ *
+ * @param string $mail Search for objects with this mail alias.
+ * @param int $restrict A Horde_Kolab_Server::RESULT_* result restriction.
+ *
+ * @return mixed The UID or false if there was no result.
+ *
+ * @throws Horde_Kolab_Server_Exception
+ */
+ public function uidForAlias($mail,
+ $restrict = Horde_Kolab_Server::RESULT_SINGLE)
+ {
+ $criteria = array('AND' => array(array('field' => 'alias',
+ 'op' => '=',
+ 'test' => $mail),
+ ),
+ );
+ return $this->uidForSearch($criteria, $restrict);
+ }
+
+ /**
+ * Identify the UID for the first object found with the given ID or mail.
+ *
+ * @param string $id Search for objects with this uid/mail.
+ *
+ * @return string|boolean The UID or false if there was no result.
+ *
+ * @throws Horde_Kolab_Server_Exception
+ */
+ public function uidForIdOrMail($id)
+ {
+ $criteria = array('OR' =>
+ array(
+ array('field' => 'uid',
+ 'op' => '=',
+ 'test' => $id),
+ array('field' => 'mail',
+ 'op' => '=',
+ 'test' => $id),
+ ),
+ );
+ return $this->uidForSearch($criteria);
+ }
+
+ /**
+ * Identify the UID for the first object found with the given mail
+ * address or alias.
+ *
+ * @param string $mail Search for objects with this mail address
+ * or alias.
+ *
+ * @return string|boolean The UID or false if there was no result.
+ *
+ * @throws Horde_Kolab_Server_Exception
+ */
+ public function uidForMailOrAlias($mail)
+ {
+ $criteria = array('OR' =>
+ array(
+ array('field' => 'alias',
+ 'op' => '=',
+ 'test' => $mail),
+ array('field' => 'mail',
+ 'op' => '=',
+ 'test' => $mail),
+ )
+ );
+ return $this->uidForSearch($criteria);
+ }
+
+ /**
+ * Identify the UID for the first object found with the given ID,
+ * mail or alias.
+ *
+ * @param string $id Search for objects with this ID/mail/alias.
+ *
+ * @return string|boolean The UID or false if there was no result.
+ *
+ * @throws Horde_Kolab_Server_Exception
+ */
+ public function uidForIdOrMailOrAlias($id)
+ {
+ $criteria = array('OR' =>
+ array(
+ array('field' => 'alias',
+ 'op' => '=',
+ 'test' => $id),
+ array('field' => 'mail',
+ 'op' => '=',
+ 'test' => $id),
+ array('field' => 'uid',
+ 'op' => '=',
+ 'test' => $id),
+ ),
+ );
+ return $this->uidForSearch($criteria);
+ }
+
+ /**
+ * Identify the primary mail attribute for the first object found
+ * with the given ID or mail.
+ *
+ * @param string $id Search for objects with this ID/mail.
+ *
+ * @return mixed The mail address or false if there was no result.
+ *
+ * @throws Horde_Kolab_Server_Exception
+ */
+ public function mailForIdOrMail($id)
+ {
+ $criteria = array('AND' =>
+ array(
+ array('field' => 'objectClass',
+ 'op' => '=',
+ 'test' => self::USER),
+ array('OR' =>
+ array(
+ array('field' => 'uid',
+ 'op' => '=',
+ 'test' => $id),
+ array('field' => 'mail',
+ 'op' => '=',
+ 'test' => $id),
+ ),
+ ),
+ ),
+ );
+
+ $data = $this->attrsForSearch($criteria, array('mail'),
+ self::RESULT_STRICT);
+ if (!empty($data)) {
+ return $data['mail'][0];
+ } else {
+ return false;
+ }
+ }
+
+ /**
+ * Returns a list of allowed email addresses for the given user.
+ *
+ * @param string $id Search for objects with this ID/mail.
+ *
+ * @return array An array of allowed mail addresses.
+ *
+ * @throws Horde_Kolab_Server_Exception
+ */
+ public function addrsForIdOrMail($id)
+ {
+ $criteria = array('AND' =>
+ array(
+ array('field' => 'objectClass',
+ 'op' => '=',
+ 'test' => self::USER),
+ array('OR' =>
+ array(
+ array('field' => 'uid',
+ 'op' => '=',
+ 'test' => $id),
+ array('field' => 'mail',
+ 'op' => '=',
+ 'test' => $id),
+ ),
+ ),
+ ),
+ );
+
+ $result = $this->attrsForSearch($criteria, array('mail', 'alias'),
+ self::RESULT_STRICT);
+ if (isset($result['alias'])) {
+ $addrs = array_merge((array) $result['mail'], (array) $result['alias']);
+ } else {
+ $addrs = $result['mail'];
+ }
+
+ if (empty($result)) {
+ return array();
+ }
+ $criteria = array('AND' =>
+ array(
+ array('field' => 'objectClass',
+ 'op' => '=',
+ 'test' => self::USER),
+ array('field' => 'kolabDelegate',
+ 'op' => '=',
+ 'test' => $result['mail'][0]),
+ ),
+ );
+
+ $result = $this->attrsForSearch($criteria, array('mail', 'alias'),
+ self::RESULT_MANY);
+ if (!empty($result)) {
+ foreach ($result as $adr) {
+ if (isset($adr['mail'])) {
+ $addrs = array_merge((array) $addrs, (array) $adr['mail']);
+ }
+ if (isset($adr['alias'])) {
+ $addrs = array_merge((array) $addrs, (array) $adr['alias']);
+ }
+ }
+ }
+
+ $addrs = array_map('strtolower', $addrs);
+
+ return $addrs;
+ }
+
+ /**
+ * Identify the GID for the first group found with the given mail.
+ *
+ * @param string $mail Search for groups with this mail address.
+ * @param int $restrict A Horde_Kolab_Server::RESULT_* result restriction.
+ *
+ * @return mixed The GID or false if there was no result.
+ *
+ * @throws Horde_Kolab_Server_Exception
+ */
+ public function gidForMail($mail,
+ $restrict = Horde_Kolab_Server::RESULT_SINGLE)
+ {
+ $criteria = array('AND' => array(array('field' => 'mail',
+ 'op' => '=',
+ 'test' => $mail),
+ ),
+ );
+ return $this->gidForSearch($criteria, $restrict);
+ }
+
+ /**
+ * Is the given UID member of the group with the given mail address?
+ *
+ * @param string $uid UID of the user.
+ * @param string $mail Search the group with this mail address.
+ *
+ * @return boolean True in case the user is in the group, false otherwise.
+ *
+ * @throws Horde_Kolab_Server_Exception
+ */
+ public function memberOfGroupAddress($uid, $mail)
+ {
+ $criteria = array('AND' =>
+ array(
+ array('field' => 'mail',
+ 'op' => '=',
+ 'test' => $mail),
+ array('field' => 'member',
+ 'op' => '=',
+ 'test' => $uid),
+ ),
+ );
+
+ $result = $this->gidForSearch($criteria,
+ self::RESULT_SINGLE);
+ return !empty($result);
+ }
+
+ /**
+ * Get the groups for this object.
+ *
+ * @param string $uid The UID of the object to fetch.
+ *
+ * @return array An array of group ids.
+ *
+ * @throws Horde_Kolab_Server_Exception
+ */
+ public function getGroups($uid)
+ {
+ $criteria = array('AND' =>
+ array(
+ array('field' => 'member',
+ 'op' => '=',
+ 'test' => $uid),
+ ),
+ );
+
+ $result = $this->gidForSearch($criteria, self::RESULT_MANY);
+ if (empty($result)) {
+ return array();
+ }
+ return $result;
+ }
}
projects / horde.git / commitdiff