member._pike

Go to the documentation of this file.

/* Copyright (C) 2000-2004  Thomas Bopp, Thorsten Hampel, Ludger Merkens
 *
 *  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.
 *
 *  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
 * 
 * $Id: member.pike,v 1.1 2008/03/31 13:39:57 exodusd Exp $
 */
#include <assert.h>
#include <macros.h>
#include <database.h>
#include <exception.h>
class member {
public:



 

 void require_save(string|void a, string|void b) { _Persistence->require_save(a,b); }

 array aoGroups;


/**
 * Initialize the member variables. This is only the array of groups.
 *  
 */
private:
 void init_member()
{
    aoGroups = ({ });
}

public:

/**
 * The function is called when the object is deleted and it
 * calls each group then and removes the member from the group.
 *  
 */
protected:
 void 
delete_object()
{
    array groups = copy_value(aoGroups);
    if ( arrayp(groups) ) {
   object grp;
   foreach(groups, grp) {
   }
    }
}

public:

/**
 * Get an array of groups of this member.
 *  
 * @return the groups of the user
 * @see set_groups
 */
final array
get_groups()
{
    aoGroups -= ({ 0 });
    
    return copy_value(aoGroups);
}

/**
 * Set the groups for this user. Only trusted objects are able to call this
 * function. In fact I am not sure if this is used at all.
 *  
 * @param grps - list of groups of the user
 * @see query_groups
 */
final void
set_groups(array grps)
{
    if ( !_SECURITY->trust(CALLER) )
   THROW("Unauthorized call to set_groups()", E_ACCESS);
    aoGroups = copy_value(grps);
    require_save(STORE_GROUP);
}

/**
 * join_group() should not be called - instead call group->add_member() !
 * Invalid calls are checked. The add_member() function will call this
 * one automatically.
 *  
 * @param grp - the group to join
 * @see leave_group
 */
bool
join_group(object grp)
{
    ASSERTINFO(IS_PROXY(grp),"Group is not a proxy !");
    ASSERTINFO(_SECURITY->valid_group(CALLER) && grp->get_object() == CALLER,
          "Invalid calling object in join_group()");

    aoGroups += ({ grp });
    require_save(STORE_GROUP);
    return true;
}

/**
 * This function is called to remove a group from the list of groups.
 * It should not be called directly. Instead the group has to be called to
 * remove one of its members. Invalid calls are checked and thrown.
 *  
 * @param grp - the group to leave
 * @return successfully or not
 * @see join_group
 */
bool leave_group(object grp)
{
    ASSERTINFO(IS_PROXY(grp),"Group is not a proxy !");
    ASSERTINFO(_SECURITY->valid_group(CALLER) && grp->get_object() == CALLER,
          "Invalid calling object in join_group(): "+
          master()->describe_object(CALLER));
    aoGroups -= ({ grp });
    require_save(STORE_GROUP);
    return true;
}


};