<?php
// $Revision: 1.1.2.17 $
// ------------------------------------------------------------------------- //
//  XooNIps - Neuroinformatics Base Platform System                          //
//  Copyright (C) 2005-2008 RIKEN, Japan All rights reserved.                //
//  http://xoonips.sourceforge.jp/                                           //
// ------------------------------------------------------------------------- //
//  This program is free software; you can redistribute it and/or modify     //
//  it under the terms of the GNU General Public License as published by     //
//  the Free Software Foundation; either version 2 of the License, or        //
//  (at your option) any later version.                                      //
//                                                                           //
//  You may not change or alter any portion of this comment or credits       //
//  of supporting developers from this source code or any supporting         //
//  source code which is considered copyrighted (c) material of the          //
//  original comment or credit authors.                                      //
//                                                                           //
//  This program 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 General Public License for more details.                             //
//                                                                           //
//  You should have received a copy of the GNU General Public License        //
//  along with this program; if not, write to the Free Software              //
//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA //
// ------------------------------------------------------------------------- //
if ( ! defined( 'XOOPS_ROOT_PATH' ) ) {
  exit();
}

/**
 * XooNIps Group Handler class
 */
class XooNIpsGroupHandler {
  var $_xg_handler;
  var $_xgl_handler;

  function XooNIpsGroupHandler() {
    $this->_xg_handler =& xoonips_getormhandler( 'xoonips', 'groups' );
    $this->_xgl_handler =& xoonips_getormhandler( 'xoonips', 'groups_users_link' );
  }

  /**
   * check group existance
   *
   * @access public
   * @param string $gname group name
   * @param int $except_gid ignoring group id
   * @return bool true if group exists
   */
  function existsGroup( $gname, $except_gid = null ) {
    $criteria = new CriteriaCompo( new Criteria( 'gid', GID_DEFAULT, '!=' ) );
    if ( ! is_null( $except_gid ) ) {
      $criteria->add( new Criteria( 'gid', $except_gid, '!=' ) );
    }
    $criteria->add( new Criteria( 'gname', $gname ) );
    $cnt = $this->_xg_handler->getCount( $criteria );
    return( $cnt != 0 );
  }

  /**
   * check user is group member
   *
   * @access public
   * @param int $uid user id
   * @param int $gid group id
   * @return bool true if user is group member
   */
  function isGroupMember( $uid, $gid ) {
    $criteria = new CriteriaCompo();
    $criteria->add( new Criteria( 'uid', $uid ) );
    $criteria->add( new Criteria( 'gid', $gid ) );
    $cnt = $this->_xgl_handler->getCount( $criteria );
    return( $cnt == 0 ) ? false : true;
  }

  /**
   * check user is group admin
   *
   * @access public
   * @param int $uid user id
   * @param int $gid group id
   * @return bool true if user is group admin
   */
  function isGroupAdmin( $uid, $gid = null ) {
    $criteria = new CriteriaCompo();
    $criteria->add( new Criteria( 'uid', $uid ) );
    $criteria->add( new Criteria( 'is_admin', 1 ) );
    if ( is_null( $gid ) ) {
      $criteria->add( new Criteria( 'gid', GID_DEFAULT, '!=' ) );
    } else {
      $criteria->add( new Criteria( 'gid', $gid ) );
    }
    $cnt = $this->_xgl_handler->getCount( $criteria );
    return( $cnt == 0 ) ? false : true;
  }

  /**
   * get group ids
   *
   * @access public
   * @param int $uid user id if null to get all group ids
   * @param bool $is_admin_only true if limit to user is administrator only
   * @return array subscribed group ids
   */
  function getGroupIds( $uid = null, $is_admin_only = false ) {
    if ( ! is_null( $uid ) ) {
      $criteria = new CriteriaCompo( new Criteria( 'gid', GID_DEFAULT, '!=', 'xgl' ) );
      $criteria->add( new Criteria( 'uid', $uid, '=', 'xgl' ) );
      if ( $is_admin_only ) {
        $criteria->add( new Criteria( 'is_admin', 1, '=', 'xgl' ) );
      }
      $join = new XooNIpsJoinCriteria( 'xoonips_groups_users_link', 'gid', 'gid', 'INNER', 'xgl' );
      $xg_objs =& $this->_xg_handler->getObjects( $criteria, false, 'xgl.gid', true, $join );
    } else {
      $criteria = new CriteriaCompo( new Criteria( 'gid', GID_DEFAULT, '!=' ) );
      $xg_objs =& $this->_xg_handler->getObjects( $criteria, false, 'gid' );
    }
    $gids = array();
    foreach ( $xg_objs as $xg_obj ) {
      $gids[] = $xg_obj->get( 'gid' );
    }
    return $gids;
  }

  /**
   * get group joined user ids
   *
   * @access public
   * @param int $gid group id
   * @param bool $is_admin_only true if limit to user is administrator only
   * @retrun array user ids
   */
  function getUserIds( $gid, $is_admin_only = false ) {
    $criteria = new CriteriaCompo( new Criteria( 'gid', GID_DEFAULT, '!=' ) );
    $criteria->add( new Criteria( 'gid', $gid ) );
    if ( $is_admin_only ) {
      $criteria->add( new Criteria( 'is_admin', 1 ) );
    }
    $join = new XooNIpsJoinCriteria( 'users', 'uid', 'uid', 'INNER', 'u' );
    $criteria->setSort( 'u.uname' );
    $criteria->setOrder( 'ASC' );
    $xgl_objs =& $this->_xgl_handler->getObjects( $criteria, false, 'u.uid', false, $join );
    $uids = array();
    foreach ( $xgl_objs as $xgl_obj ) {
      $uids[] = $xgl_obj->get( 'uid' );
    }
    return $uids;
  }

  /**
   * get group root index id
   *
   * @access public
   * @param int $gid
   * @return int index id
   */
  function getGroupRootIndexId( $gid ) {
    $obj =& $this->_xg_handler->get( $gid );
    if ( ! is_object( $obj ) ) {
      return false;
    }
    return $obj->get( 'group_index_id' );
  }

  /**
   * get group root index ids
   *
   * @access public
   * @param int $uid user id
   * @param bool $is_admin_only true if limit to user is administrator only
   * @retrun array index ids
   */
  function getGroupRootIndexIds( $uid = null, $is_admin_only = false ) {
    $criteria = new CriteriaCompo();
    $criteria->add( new Criteria( 'gid', GID_DEFAULT, '!=', 'xg' ) );
    if ( ! is_null( $uid ) ) {
      $criteria->add( new Criteria( 'uid', $uid ) );
      if ( $is_admin_only ) {
        $criteria->add( new Criteria( 'is_admin', 1 ) );
      }
    }
    $join = new XooNIpsJoinCriteria( 'xoonips_groups', 'gid', 'gid', 'INNER', 'xg' );
    $xgl_objs =& $this->_xgl_handler->getObjects( $criteria, false, 'xg.group_index_id AS gxid', false, $join );
    $gxids = array();
    foreach ( $xgl_objs as $xgl_obj ) {
      $gxids[] = $xgl_obj->getExtraVar( 'gxid' );
    }
    return $gxids;
  }

  /**
   * get group item ids
   *
   * @access public
   * @param int $gid group id
   * @param int $uid user id
   * @return array item ids
   */
  function getGroupItemIds( $gid, $uid = null ) {
    $index_item_link_handler =& xoonips_getormhandler( 'xoonips', 'index_item_link' );
    $join = new XooNIpsJoinCriteria( 'xoonips_index', 'index_id', 'index_id', 'INNER', 'idx' );
    $criteria = new CriteriaCompo( new Criteria( 'gid', $gid, '=', 'idx' ) );
    $join->cascade( new XooNIpsJoinCriteria( 'xoonips_item_basic', 'item_id', 'item_id', 'INNER', 'ib' ) );
    if ( ! is_null( $uid ) ) {
      $criteria->add( new Criteria( 'uid', $uid, '=', 'ib' ) );
    }
    $res =& $index_item_link_handler->open( $criteria, 'ib.item_id', true, $join );
    $iids = array();
    while ( $xil_obj =& $index_item_link_handler->getNext( $res ) ) {
      $iids[] = $xil_obj->get( 'item_id' );
    }
    $index_item_link_handler->close( $res );
    return $iids;
  }

  /**
   * get group object
   *
   * @access public
   * @param int $gid group id
   * @return object instance of XooNIpsOrmGroups
   */
  function &getGroupObject( $gid ) {
    return $this->_xg_handler->get( $gid );
  }

  /**
   * get group objects
   *
   * @access public
   * @param array $gids array of group ids
   * @return array object instance array of XooNIpsOrmGroups
   */
  function &getGroupObjects( $gids = null ) {
    $criteria = new CriteriaCompo( new Criteria( 'gid', GID_DEFAULT, '!=' ) );
    if ( ! is_null( $gids ) ) {
      $criteria->add( new Criteria( 'gid', '('.implode( ',', $gids ).')', 'IN' ) );
    }
    $criteria->setSort( 'gname' );
    $criteria->setOrder( 'ASC' );
    return $this->_xg_handler->getObjects( $criteria );
  }
}

?>
