summaryrefslogtreecommitdiffstats
path: root/lib/group
diff options
context:
space:
mode:
authorRobin Appelman <icewind@owncloud.com>2012-04-13 01:58:53 +0200
committerRobin Appelman <icewind@owncloud.com>2012-04-13 01:59:05 +0200
commit1d8fdf52d52f4a73cb0a59b5d2c3a088ae1e9247 (patch)
tree09eedd220c847d587639567219194b92d39fa2f2 /lib/group
parente9c1f8b4e650052eee33de6e1b4e29715e41cdf0 (diff)
downloadnextcloud-server-1d8fdf52d52f4a73cb0a59b5d2c3a088ae1e9247.tar.gz
nextcloud-server-1d8fdf52d52f4a73cb0a59b5d2c3a088ae1e9247.zip
allow multiply group backends
Diffstat (limited to 'lib/group')
-rw-r--r--lib/group/backend.php119
-rw-r--r--lib/group/database.php4
-rw-r--r--lib/group/dummy.php159
-rw-r--r--lib/group/example.php102
4 files changed, 315 insertions, 69 deletions
diff --git a/lib/group/backend.php b/lib/group/backend.php
index 43f94e7ea1a..b3fc06ac9a8 100644
--- a/lib/group/backend.php
+++ b/lib/group/backend.php
@@ -21,82 +21,65 @@
*
*/
+/**
+ * error code for functions not provided by the group backend
+ */
+define('OC_GROUP_BACKEND_NOT_IMPLEMENTED', -501);
+/**
+ * actions that user backends can define
+ */
+define('OC_GROUP_BACKEND_CREATE_GROUP', 0x00000001);
+define('OC_GROUP_BACKEND_DELETE_GROUP', 0x00000010);
+define('OC_GROUP_BACKEND_IN_GROUP', 0x00000100);
+define('OC_GROUP_BACKEND_ADD_TO_GROUP', 0x00001000);
+define('OC_GROUP_BACKEND_REMOVE_FROM_GOUP', 0x00010000);
+define('OC_GROUP_BACKEND_GET_USER_GROUPS', 0x00100000);
+define('OC_GROUP_BACKEND_GET_USERS', 0x01000000);
+define('OC_GROUP_BACKEND_GET_GROUPS', 0x10000000);
/**
* Abstract base class for user management
*/
abstract class OC_Group_Backend {
+ protected $possibleActions = array(
+ OC_GROUP_BACKEND_CREATE_GROUP => 'createGroup',
+ OC_GROUP_BACKEND_DELETE_GROUP => 'deleteGroup',
+ OC_GROUP_BACKEND_IN_GROUP => 'inGroup',
+ OC_GROUP_BACKEND_ADD_TO_GROUP => 'addToGroup',
+ OC_GROUP_BACKEND_REMOVE_FROM_GOUP => 'removeFromGroup',
+ OC_GROUP_BACKEND_GET_USER_GROUPS => 'getUserGroups',
+ OC_GROUP_BACKEND_GET_USERS => 'usersInGroup',
+ OC_GROUP_BACKEND_GET_GROUPS => 'getGroups'
+ );
+
/**
- * @brief Try to create a new group
- * @param $gid The name of the group to create
- * @returns true/false
- *
- * Trys to create a new group. If the group name already exists, false will
- * be returned.
- */
- public static function createGroup($gid){}
-
- /**
- * @brief delete a group
- * @param $gid gid of the group to delete
- * @returns true/false
- *
- * Deletes a group and removes it from the group_user-table
- */
- public static function removeGroup($gid){}
-
- /**
- * @brief is user in group?
- * @param $uid uid of the user
- * @param $gid gid of the group
- * @returns true/false
- *
- * Checks whether the user is member of a group or not.
- */
- public static function inGroup($uid, $gid){}
-
- /**
- * @brief Add a user to a group
- * @param $uid Name of the user to add to group
- * @param $gid Name of the group in which add the user
- * @returns true/false
- *
- * Adds a user to a group.
- */
- public static function addToGroup($uid, $gid){}
-
- /**
- * @brief Removes a user from a group
- * @param $uid Name of the user to remove from group
- * @param $gid Name of the group from which remove the user
- * @returns true/false
- *
- * removes the user from a group.
- */
- public static function removeFromGroup($uid,$gid){}
-
- /**
- * @brief Get all groups a user belongs to
- * @param $uid Name of the user
- * @returns array with group names
- *
- * This function fetches all groups a user belongs to. It does not check
- * if the user exists at all.
- */
- public static function getUserGroups($uid){}
+ * @brief Get all supported actions
+ * @returns bitwise-or'ed actions
+ *
+ * Returns the supported actions as int to be
+ * compared with OC_USER_BACKEND_CREATE_USER etc.
+ */
+ public function getSupportedActions(){
+ $actions = 0;
+ foreach($this->possibleActions AS $action => $methodName){
+ if(method_exists($this, $methodName)) {
+ $actions |= $action;
+ }
+ }
- /**
- * @brief get a list of all groups
- * @returns array with group names
- *
- * Returns a list with all groups
- */
- public static function getGroups(){}
+ return $actions;
+ }
/**
- * @brief get a list of all users in a group
- * @returns array with user ids
- */
- public static function usersInGroup($gid){}
+ * @brief Check if backend implements actions
+ * @param $actions bitwise-or'ed actions
+ * @returns boolean
+ *
+ * Returns the supported actions as int to be
+ * compared with OC_GROUP_BACKEND_CREATE_GROUP etc.
+ */
+ public function implementsActions($actions){
+ return (bool)($this->getSupportedActions() & $actions);
+ }
}
diff --git a/lib/group/database.php b/lib/group/database.php
index 1afd4b5fe4c..d401acf43b3 100644
--- a/lib/group/database.php
+++ b/lib/group/database.php
@@ -117,8 +117,10 @@ class OC_Group_Database extends OC_Group_Backend {
if( !self::inGroup( $uid, $gid )){
$query = OC_DB::prepare( "INSERT INTO `*PREFIX*group_user` ( `uid`, `gid` ) VALUES( ?, ? )" );
$result = $query->execute( array( $uid, $gid ));
+ return true;
+ }else{
+ return false;
}
- return true;
}
/**
diff --git a/lib/group/dummy.php b/lib/group/dummy.php
new file mode 100644
index 00000000000..5220237ecbf
--- /dev/null
+++ b/lib/group/dummy.php
@@ -0,0 +1,159 @@
+<?php
+
+/**
+* ownCloud
+*
+* @author Frank Karlitschek
+* @copyright 2010 Frank Karlitschek karlitschek@kde.org
+*
+* This library is free software; you can redistribute it and/or
+* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
+* License as published by the Free Software Foundation; either
+* version 3 of the License, or any later version.
+*
+* This library is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU AFFERO GENERAL PUBLIC LICENSE for more details.
+*
+* You should have received a copy of the GNU Affero General Public
+* License along with this library. If not, see <http://www.gnu.org/licenses/>.
+*
+*/
+
+/**
+ * dummy group backend, does not keep state, only for testing use
+ */
+class OC_Group_Dummy extends OC_Group_Backend {
+ private $groups=array();
+ /**
+ * @brief Try to create a new group
+ * @param $gid The name of the group to create
+ * @returns true/false
+ *
+ * Trys to create a new group. If the group name already exists, false will
+ * be returned.
+ */
+ public function createGroup($gid){
+ if(!isset($this->groups[$gid])){
+ $this->groups[$gid]=array();
+ return true;
+ }else{
+ return false;
+ }
+ }
+
+ /**
+ * @brief delete a group
+ * @param $gid gid of the group to delete
+ * @returns true/false
+ *
+ * Deletes a group and removes it from the group_user-table
+ */
+ public function deleteGroup($gid){
+ if(isset($this->groups[$gid])){
+ unset($this->groups[$gid]);
+ return true;
+ }else{
+ return false;
+ }
+ }
+
+ /**
+ * @brief is user in group?
+ * @param $uid uid of the user
+ * @param $gid gid of the group
+ * @returns true/false
+ *
+ * Checks whether the user is member of a group or not.
+ */
+ public function inGroup($uid, $gid){
+ if(isset($this->groups[$gid])){
+ return (array_search($uid,$this->groups[$gid])!==false);
+ }else{
+ return false;
+ }
+ }
+
+ /**
+ * @brief Add a user to a group
+ * @param $uid Name of the user to add to group
+ * @param $gid Name of the group in which add the user
+ * @returns true/false
+ *
+ * Adds a user to a group.
+ */
+ public function addToGroup($uid, $gid){
+ if(isset($this->groups[$gid])){
+ if(array_search($uid,$this->groups[$gid])===false){
+ $this->groups[$gid][]=$uid;
+ return true;
+ }else{
+ return false;
+ }
+ }else{
+ return false;
+ }
+ }
+
+ /**
+ * @brief Removes a user from a group
+ * @param $uid NameUSER of the user to remove from group
+ * @param $gid Name of the group from which remove the user
+ * @returns true/false
+ *
+ * removes the user from a group.
+ */
+ public function removeFromGroup($uid,$gid){
+ if(isset($this->groups[$gid])){
+ if(($index=array_search($uid,$this->groups[$gid]))!==false){
+ unset($this->groups[$gid][$index]);
+ }else{
+ return false;
+ }
+ }else{
+ return false;
+ }
+ }
+
+ /**
+ * @brief Get all groups a user belongs to
+ * @param $uid Name of the user
+ * @returns array with group names
+ *
+ * This function fetches all groups a user belongs to. It does not check
+ * if the user exists at all.
+ */
+ public function getUserGroups($uid){
+ $groups=array();
+ foreach($this->groups as $group=>$user){
+ if($this->inGroup($uid,$group)){
+ $groups[]=$group;
+ }
+ }
+ return $groups;
+ }
+
+ /**
+ * @brief get a list of all groups
+ * @returns array with group names
+ *
+ * Returns a list with all groups
+ */
+ public function getGroups(){
+ return array_keys($this->groups);
+ }
+
+ /**
+ * @brief get a list of all users in a group
+ * @returns array with user ids
+ */
+ public function usersInGroup($gid){
+ if(isset($this->groups[$gid])){
+ return $this->groups[$gid];
+ }else{
+ return array();
+ }
+ }
+
+}
diff --git a/lib/group/example.php b/lib/group/example.php
new file mode 100644
index 00000000000..a88159f91be
--- /dev/null
+++ b/lib/group/example.php
@@ -0,0 +1,102 @@
+<?php
+
+/**
+* ownCloud
+*
+* @author Frank Karlitschek
+* @copyright 2010 Frank Karlitschek karlitschek@kde.org
+*
+* This library is free software; you can redistribute it and/or
+* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
+* License as published by the Free Software Foundation; either
+* version 3 of the License, or any later version.
+*
+* This library is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU AFFERO GENERAL PUBLIC LICENSE for more details.
+*
+* You should have received a copy of the GNU Affero General Public
+* License along with this library. If not, see <http://www.gnu.org/licenses/>.
+*
+*/
+
+/**
+ * abstract reference class for group management
+ * this class should only be used as a reference for method signatures and their descriptions
+ */
+abstract class OC_Group_Example {
+ /**
+ * @brief Try to create a new group
+ * @param $gid The name of the group to create
+ * @returns true/false
+ *
+ * Trys to create a new group. If the group name already exists, false will
+ * be returned.
+ */
+ public static function createGroup($gid){}
+
+ /**
+ * @brief delete a group
+ * @param $gid gid of the group to delete
+ * @returns true/false
+ *
+ * Deletes a group and removes it from the group_user-table
+ */
+ public static function deleteGroup($gid){}
+
+ /**
+ * @brief is user in group?
+ * @param $uid uid of the user
+ * @param $gid gid of the group
+ * @returns true/false
+ *
+ * Checks whether the user is member of a group or not.
+ */
+ public static function inGroup($uid, $gid){}
+
+ /**
+ * @brief Add a user to a group
+ * @param $uid Name of the user to add to group
+ * @param $gid Name of the group in which add the user
+ * @returns true/false
+ *
+ * Adds a user to a group.
+ */
+ public static function addToGroup($uid, $gid){}
+
+ /**
+ * @brief Removes a user from a group
+ * @param $uid NameUSER of the user to remove from group
+ * @param $gid Name of the group from which remove the user
+ * @returns true/false
+ *
+ * removes the user from a group.
+ */
+ public static function removeFromGroup($uid,$gid){}
+
+ /**
+ * @brief Get all groups a user belongs to
+ * @param $uid Name of the user
+ * @returns array with group names
+ *
+ * This function fetches all groups a user belongs to. It does not check
+ * if the user exists at all.
+ */
+ public static function getUserGroups($uid){}
+
+ /**
+ * @brief get a list of all groups
+ * @returns array with group names
+ *
+ * Returns a list with all groups
+ */
+ public static function getGroups(){}
+
+ /**
+ * @brief get a list of all users in a group
+ * @returns array with user ids
+ */
+ public static function usersInGroup($gid){}
+
+}